Search In: Doc:Documentation: Altium Designer
Altium DesignerAltium 365Altium MCAD CoDesignerAltium On-Prem Enterprise ServerAltium CircuitMakerAltium CircuitStudioCompany DashboardAltium Infrastructure Server
Ver: Version: 20
2120.220.120.019.119.018.118.017.117.016.116.015.1
Close
Search Search on Documentation
Documentation Altium Designer Documentation ... PCB Query Functions Membership Checks

IsNamedPolygon

Created: September 13, 2015 | Updated: August 20, 2021 | Applies to versions: 15.1, 16.0, 16.1, 17.0, 17.1, 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2
Now reading version 20. For the latest, read: IsNamedPolygon for version 21

Parent page: PCB Query Functions - Membership Checks

Summary

Returns the specified polygon pour.

Syntax

IsNamedPolygon(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

IsNamedPolygon('Power3V3')
IsNamedPolygon('Power3V3') = True
IsNamedPolygon('Power3V3') = 'True'
Returns the polygon pour object whose Name property is Power3V3.

Not IsNamedPolygon('Power3V3')
IsNamedPolygon('Power3V3') = False
IsNamedPolygon('Power3V3') = 'False'
Returns all objects except the polygon pour object whose Name property is Power3V3.

Tips

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

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.