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

IsSquarePadShapeOnLayer

Created: October 31, 2018 | Updated: March 06, 2024 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2
Now reading version 1.1. For the latest, read: IsSquarePadShapeOnLayer 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 - 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 Layers & Colors tab of the View Configuration panel.

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.