Search In: Doc:Documentation: Altium Designer
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 16.1
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 Attribute Checks

IsSquarePadShapeOnLayer

Created: September 11, 2015 | Updated: August 10, 2021 | Applies to versions: 15.1, 16.0, 16.1, 17.0 and 17.1
Now reading version 16.1. For the latest, read: IsSquarePadShapeOnLayer for version 21

Parent page: PCB Query Functions - Attribute Checks

Summary

Returns all pad objects with a square pad shape on the specified layer. An square pad shape is formed from a Rounded Rectangle pad shape, when the X-Size and Y-Size properties are set to be equal.

Syntax

IsSquarePadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer, as it appears on the Board Layers And Colors tab of the View Configurations dialog.

Example Usage

IsSquarePadShapeOnLayer('Top Layer')
IsSquarePadShapeOnLayer('Top Layer') = True
IsSquarePadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a square pad shape on the Top Layer.

Not IsSquarePadShapeOnLayer('Bottom Layer')
IsSquarePadShapeOnLayer('Bottom Layer') = False
IsSquarePadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a square pad shape on the Bottom Layer.

Tips

  1. The single quote characters (') at the start and end of Layer are mandatory.
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.