Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 2.0
43.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... PCB Query Functions Membership Checks

InNamedPolygon

Created: September 13, 2015 | Updated: August 20, 2021 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2
Now reading version 2.0. For the latest, read: InNamedPolygon for version 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all primitive objects that are children of the specified polygon pour.

Syntax

InNamedPolygon(PolygonName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing polygon pours, by name, is presented.

Example Usage

InNamedPolygon('Power3V3')
InNamedPolygon('Power3V3') = True
InNamedPolygon('Power3V3') = 'True'
Returns all primitive objects that are children of the polygon pour whose Name property is Power3V3.

Not InNamedPolygon('Power3V3')
InNamedPolygon('Power3V3') = False
InNamedPolygon('Power3V3') = 'False'
Returns all objects except primitive objects that are children of the polygon pour whose Name property is Power3V3.

Tips

  1. The single quote characters (') at the start and end of the PolygonName string are mandatory.
  2. The parent polygon pour object is also returned.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.