PCB Layout Query Functions in Altium Designer

Summary

Returns all child primitive objects associated with components in the design.

Syntax

IsComponentPrimitive : Boolean/Boolean_String

Example Usage

IsComponentPrimitive
IsComponentPrimitive = True
IsComponentPrimitive = 'True'
Returns all child primitives of component objects.

Not IsComponentPrimitive
IsComponentPrimitive = False
IsComponentPrimitive = 'False'
Returns all objects except child primitives of component objects.

Summary

Returns all child primitive objects associated with currently selected components in the design.

Syntax

IsComponentSelected : Boolean/Boolean_String

Example Usage

IsComponentSelected
IsComponentSelected = True
IsComponentSelected = 'True'
Returns all child primitives of currently selected component objects.

Not IsComponentSelected
IsComponentSelected = False
IsComponentSelected = 'False'
Returns all objects except child primitives of currently selected component objects.

Summary

Returns components that are of a DIP nature. At least one (and typically all) of the pads of such a component are of a through-hole nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

IsDIP : Boolean/Boolean_String

Example Usage

IsDIP
IsDIP = True
IsDIP = 'True'
Returns all DIP components.

Not IsDIP
IsDIP = False
IsDIP = 'False'
Returns all objects except DIP components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns components that are of an Edge Connector nature. All of the pads of such a component are of a surface-mount nature, and these are located on both sides of the PCB. All of the pads reside in either the same row or the same column, the number of pads on either side of the PCB is less than three times the number of pads on the opposite side of the PCB, and the total number of pads is at least 4.

Syntax

IsEdgeConnector : Boolean/Boolean_String

Example Usage

IsEdgeConnector
IsEdgeConnector = True
IsEdgeConnector = 'True'
Returns all Edge Connector components.

Not IsEdgeConnector
IsEdgeConnector = False
IsEdgeConnector = 'False'
Returns all objects except Edge Connector components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all net objects whose Net property is not set to No Net.

Syntax

IsElectrical : Boolean/Boolean_String

Example Usage

IsElectrical
IsElectrical = True
IsElectrical = 'True'
Returns all net objects whose Net property is not set to No Net.

Not IsElectrical
IsElectrical = False
IsElectrical = 'False'
Returns all objects except net objects whose Net property is not set to No Net.

Summary

Returns all free design objects. An object is free if it is not a component (or its associated primitives and 3D body(ies)), or if it is not a net object. In addition, a net object is considered to be free if its Net property is set to No Net.

Syntax

IsFree : Boolean/Boolean_String

Example Usage

IsFree
IsFree = True
IsFree = 'True'
Returns all free design objects.

Not IsFree
IsFree = False
IsFree = 'False'
Returns all objects except free design objects.

Summary

Returns component objects whose Component Type property is Graphical. These components do not have electrical properties, are not synchronized (you must manually place them in both editors), and are not included in the BOM. An example is a company logo.

Syntax

IsGraphicalComponent : Boolean/Boolean_String

Example Usage

IsGraphicalComponent
IsGraphicalComponent = True
IsGraphicalComponent = 'True'
Returns all component objects whose Component Type property is set to Graphical.

Not IsGraphicalComponent
IsGraphicalComponent = False
IsGraphicalComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Graphical.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns horizontal tracks, i.e. those tracks whose Y1 and Y2 properties are identical.

Syntax

IsHorizontal : Boolean/Boolean_String

Example Usage

IsHorizontal
IsHorizontal = True
IsHorizontal = 'True'
Returns all horizontal tracks.

Not IsHorizontal
IsHorizontal = False
IsHorizontal = 'False'
Returns all objects except horizontal tracks.

Summary

Returns component objects whose Component Type property is Jumper. These components are used to include wire links in a PCB design, for example on a single-sided PCB that cannot be fully routed on one layer. For this component type the component footprint and pins are synchronized between the schematic and PCB but the net assignments are not, and the component is included in the BOM. As well as selecting this option at the component level, both of the pads in the component must have their JumperID set to the same non-zero value. Jumper-type components do not need to be wired on the schematic, they only need to be included on the schematic if they are required in the BOM. If they are not required in the BOM they can be placed directly in the PCB, where the Component Type is set, the JumperIDs are set, and the Nets manually assigned for the pads.

Syntax

IsJumperComponent : Boolean/Boolean_String

Example Usage

IsJumperComponent
IsJumperComponent = True
IsJumperComponent = 'True'
Returns all component objects whose Component Type property is set to Jumper.

Not IsJumperComponent
IsJumperComponent = False
IsJumperComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Jumper.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Syntax

IsKeepOut : Boolean/Boolean_String

Example Usage

IsKeepOut
IsKeepOut = True
IsKeepOut = 'True'
Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Not IsKeepOut
IsKeepOut = False
IsKeepOut = 'False'
Returns all objects except Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Summary

Returns components that are of a Surface Mount LCC nature. Such a component contains 2 rows of pads (which each contain at least 4 pads), and 2 columns of pads (which each contain at least 4 pads), and all of the pads are of a surface-mount nature.

Syntax

IsLCC : Boolean/Boolean_String

Example Usage

IsLCC
IsLCC = True
IsLCC = 'True'
Returns all LCC components.

Not IsLCC
IsLCC = False
IsLCC = 'False'
Returns all objects except LCC components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns pad and via objects that are linked to any Pad Via Library (*.PvLib), that is, those whose Library property makes reference to such a library.

Syntax

IsLinkedToAnyPadViaLibrary : Boolean/Boolean_String

Example Usage

IsLinkedToAnyPadViaLibrary
IsLinkedToAnyPadViaLibrary = True
IsLinkedToAnyPadViaLibrary = 'True'
Returns all pad and via objects that are linked to any Pad Via Library.

Not IsLinkedToAnyPadViaLibrary
IsLinkedToAnyPadViaLibrary = False
IsLinkedToAnyPadViaLibrary = 'False'
Returns all objects except pad and via objects that are linked to any Pad Via Library.

Summary

Returns pad and via objects that are linked to the Pad Via Library (*.PvLib) specified as part of the Query, that is, those whose Library property makes reference to such a library.

Syntax

IsLinkedToPadViaLibrary(PadViaLibraryName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaLibrary('ExamplePVLib.PvLib')
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = True
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'True'
Returns all pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Not IsLinkedToPadViaLibrary('ExamplePVLib.PvLib')
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = False
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'False'
Returns all objects except pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Note

• The single quote characters (') at the start and end of the PadViaLibraryName string are mandatory.

Summary

Returns pad or via objects that are using the Pad or Via template specified as part of the Query, that is, those whose Template property makes reference to such a template.

Syntax

IsLinkedToPadViaTemplate(TemplateName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaTemplate('c152hn127')
IsLinkedToPadViaTemplate('c152hn127') = True
IsLinkedToPadViaTemplate('c152hn127') = 'True'
Returns all pad objects that use the pad template c152hn127.

Not IsLinkedToPadViaTemplate('v127h71')
IsLinkedToPadViaTemplate('v127h71') = False
IsLinkedToPadViaTemplate('v127h71') = 'False'
Returns all objects except via objects that use the via template v127h71.

Note

• The single quote characters (') at the start and end of the TemplateName string are mandatory.

Summary

Returns component objects whose Component Type property is Mechanical. These components do not have electrical properties, are not synchronized (you must manually place them in both editors), and are included in the BOM. An example is a heatsink.

Syntax

IsMechanicalComponent : Boolean/Boolean_String

Example Usage

IsMechanicalComponent
IsMechanicalComponent = True
IsMechanicalComponent = 'True'
Returns all component objects whose Component Type property is set to Mechanical.

Not IsMechanicalComponent
IsMechanicalComponent = False
IsMechanicalComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Mechanical.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

Syntax

IsNetSelected : Boolean/Boolean_String

Example Usage

IsNetSelected
IsNetSelected = True
IsNetSelected = 'True'
Returns all net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

Not IsNetSelected
IsNetSelected = False
IsNetSelected = 'False'
Returns all objects except net-aware objects (arcs, fills, pads, polygon pours, solid regions, tracks, and vias) whose Net property corresponds to the currently selected Net object(s).

Note

• The selected Net objects are not returned, nor are the child primitives of any polygon pour objects which are returned.

Summary

Returns component objects whose Component Type property is either Net Tie, or Net Tie (In BOM). These components are used to short two or more different nets together. They are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match). Net Tie (In BOM) type components are included in the BOM, while Net Tie type components are not. They differ from a Standard component in that connectivity created by copper within the footprint is not checked - it is this copper that allows the nets to be shorted.

Syntax

IsNetTieComponent : Boolean/Boolean_String

Example Usage

IsNetTieComponent
IsNetTieComponent = True
IsNetTieComponent = 'True'
Returns all component objects whose Component Type property is set to either Net Tie, or Net Tie (In BOM).

Not IsNetTieComponent
IsNetTieComponent = False
IsNetTieComponent = 'False'
Returns all objects except component objects whose Component Type property is set to either Net Tie, or Net Tie (In BOM).

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns component objects whose Component Type property is Standard (No BOM). These components possess standard electrical properties, are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match), and are not included in the BOM. An example is a testpoint component, that you wish to exclude from the BOM.

Syntax

IsNoBOMComponent : Boolean/Boolean_String

Example Usage

IsNoBOMComponent
IsNoBOMComponent = True
IsNoBOMComponent = 'True'
Returns all component objects whose Component Type property is set to Standard (No BOM).

Not IsNoBOMComponent
IsNoBOMComponent = False
IsNoBOMComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Standard (No BOM).

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns tracks of a diagonal nature (+/- 45 Degree angles), i.e. those tracks for which the absolute value of the difference between their Y1 and Y2 properties is equal to the absolute value of the difference between their X1 and X2 properties.

Syntax

IsOblique : Boolean/Boolean_String

Example Usage

IsOblique
IsOblique = True
IsOblique = 'True'
Returns all +/-45 Degree tracks.

Not IsOblique
IsOblique = False
IsOblique = 'False'
Returns all objects except +/-45 Degree tracks.

Summary

Returns -45 Degree angled tracks, i.e. those tracks for which the difference between their Y1 and Y2 properties is opposite in sign to, but otherwise equal to, the difference between their X1 and X2 properties.

Syntax

IsObliqueNegative : Boolean/Boolean_String

Example Usage

IsObliqueNegative
IsObliqueNegative = True
IsObliqueNegative = 'True'
Returns all -45 Degree tracks.

Not IsObliqueNegative
IsObliqueNegative = False
IsObliqueNegative = 'False'
Returns all objects except -45 Degree tracks.

Summary

Returns +45 Degree angled tracks, i.e. those tracks for which the difference between their Y1 and Y2 properties is equal (including in sign) to the difference between their X1 and X2 properties.

Syntax

IsObliquePositive : Boolean/Boolean_String

Example Usage

IsObliquePositive
IsObliquePositive = True
IsObliquePositive = 'True'
Returns all +45 Degree tracks.

Not IsObliquePositive
IsObliquePositive = False
IsObliquePositive = 'False'
Returns all objects except +45 Degree tracks.

Summary

Returns all pad objects with a chamfered rectangular pad shape on the specified layer.

Syntax

IsChamferedRectangularPadOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

IsChamferedRectangularPadOnLayer('Top Layer')
IsChamferedRectangularPadOnLayer('Top Layer') = True
IsChamferedRectangularPadOnLayer('Top Layer') = 'True'
Returns all pad objects with a chamfered rectangular pad shape on the Top Layer.

Not IsChamferedRectangularPadOnLayer('Bottom Layer')
IsChamferedRectangularPadOnLayer('Bottom Layer') = False
IsChamferedRectangularPadOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a chamfered rectangular pad shape on the Bottom Layer.

Note

The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns all pad objects with a chamfered rectangle pad shape.

Syntax

IsChamferedRectangulePad : Boolean/Boolean_String

Example Usage

IsChamferedRectangulePad
IsChamferedRectangulePad = True
IsChamferedRectangulePad = 'True'
Returns all pad objects with a chamfered rectangle pad shape.

Not IsChamferedRectangulePad
IsChamferedRectangulePad = False
IsChamferedRectangulePad = 'False'
Returns all objects except pad objects with a chamfered rectangle pad shape.

Summary

Returns all pad objects with an octagonal pad shape.

Syntax

IsOctagonalPad : Boolean/Boolean_String

Example Usage

IsOctagonalPad
IsOctagonalPad = True
IsOctagonalPad = 'True'
Returns all pad objects with an octagonal pad shape.

Not IsOctagonalPad
IsOctagonalPad = False
IsOctagonalPad = 'False'
Returns all objects except pad objects with an octagonal pad shape.

Summary

Returns all pad objects with an octagonal pad shape on the specified layer.

Syntax

IsOctagonalPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

IsOctagonalPadShapeOnLayer('Top Layer')
IsOctagonalPadShapeOnLayer('Top Layer') = True
IsOctagonalPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with an octagonal pad shape on the Top Layer.

Not IsOctagonalPadShapeOnLayer('Bottom Layer')
IsOctagonalPadShapeOnLayer('Bottom Layer') = False
IsOctagonalPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with an octagonal pad shape on the Bottom Layer.

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns all pad objects with an oval pad shape. An oval pad shape is formed from a Round pad shape, when the X-Size and Y-Size properties are set to be non-equal.

Syntax

IsOvalPad : Boolean/Boolean_String

Example Usage

IsOvalPad
IsOvalPad = True
IsOvalPad = 'True'
Returns all pad objects with an oval pad shape.

Not IsOvalPad
IsOvalPad = False
IsOvalPad = 'False'
Returns all objects except pad objects with an oval pad shape.

Summary

Returns all pad objects with an oval pad shape on the specified layer. An oval pad shape is formed from a Round pad shape when the X-Size and Y-Size properties are set to be non-equal.

Syntax

IsOvalPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

IsOvalPadShapeOnLayer('Top Layer')
IsOvalPadShapeOnLayer('Top Layer') = True
IsOvalPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with an oval pad shape on the Top Layer.

Not IsOvalPadShapeOnLayer('Bottom Layer')
IsOvalPadShapeOnLayer('Bottom Layer') = False
IsOvalPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with an oval pad shape on the Bottom Layer.

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns components that are of a PGA nature. Such a component contains at least 6 rows of pads and at least 6 columns of pads. The (absolute) difference between the number of rows of pads and the number of columns of pads, is less than 6. The total pad count is at least half of the product of the number of rows of pads and the number of columns of pads, and at least one (and typically all) of the pads are of a through-hole nature.

Syntax

IsPGA : Boolean/Boolean_String

Example Usage

IsPGA
IsPGA = True
IsPGA = 'True'
Returns all PGA components.

Not IsPGA
IsPGA = False
IsPGA = 'False'
Returns all objects except PGA components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all pad objects with a rectangular pad shape.

Syntax

IsRectangularPad : Boolean/Boolean_String

Example Usage

IsRectangularPad
IsRectangularPad = True
IsRectangularPad = 'True'
Returns all pad objects with a rectangular pad shape.

Not IsRectangularPad
IsRectangularPad = False
IsRectangularPad = 'False'
Returns all objects except pad objects with a rectangular pad shape.

Summary

Returns all pad objects with a rectangular pad shape on the specified layer.

Syntax

IsRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

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

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

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns all pad objects with a rounded rectangular pad shape.

Syntax

IsRoundedRectangularPad : Boolean/Boolean_String

Example Usage

IsRoundedRectangularPad
IsRoundedRectangularPad = True
IsRoundedRectangularPad = 'True'
Returns all pad objects with a rounded rectangular pad shape.

Not IsRoundedRectangularPad
IsRoundedRectangularPad = False
IsRoundedRectangularPad = 'False'
Returns all objects except pad objects with a rounded rectangular pad shape.

Summary

Returns all pad objects with a rounded rectangular pad shape on the specified layer.

Syntax

IsRoundedRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

IsRoundedRectangularPadShapeOnLayer('Top Layer')
IsRoundedRectangularPadShapeOnLayer('Top Layer') = True
IsRoundedRectangularPadShapeOnLayer('Top Layer') = 'True'
Returns all pad objects with a rounded rectangular pad shape on the Top Layer.

Not IsRoundedRectangularPadShapeOnLayer('Bottom Layer')
IsRoundedRectangularPadShapeOnLayer('Bottom Layer') = False
IsRoundedRectangularPadShapeOnLayer('Bottom Layer') = 'False'
Returns all objects except pad objects with a rounded rectangular pad shape on the Bottom Layer.

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns all pad objects with a round pad shape.

Syntax

IsRoundPad : Boolean/Boolean_String

Example Usage

IsRoundPad
IsRoundPad = True
IsRoundPad = 'True'
Returns all pad objects with a round pad shape.

Not IsRoundPad
IsRoundPad = False
IsRoundPad = 'False'
Returns all objects except pad objects with a round pad shape.

Summary

Returns all pad objects with a round pad shape on the specified layer.

Syntax

IsRoundPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Example Usage

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

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

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns all objects that are currently selected in the design workspace.

Syntax

IsSelected : Boolean/Boolean_String

Example Usage

IsSelected
IsSelected = True
IsSelected = 'True'
Returns all objects that are currently selected in the design workspace.

Not IsSelected
IsSelected = False
IsSelected = 'False'
Returns all objects except objects that are currently selected in the design workspace.

Summary

Returns components that are of a SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, at least one (and typically all) of these pads are of a through-hole nature.

Syntax

IsSIP : Boolean/Boolean_String

Example Usage

IsSIP
IsSIP = True
IsSIP = 'True'
Returns all SIP components.

Not IsSIP
IsSIP = False
IsSIP = 'False'
Returns all objects except SIP components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns components that are of a Surface Mount SIP nature. Such a component contains at least four pads, and all of its pads are located in either the same row or the same column. Additionally, all of these pads are of a surface-mount  nature.

Syntax

IsSMSIP : Boolean/Boolean_String

Example Usage

IsSMSIP
IsSMSIP = True
IsSMSIP = 'True'
Returns all SMSIP components.

Not IsSMSIP
IsSMSIP = False
IsSMSIP = 'False'
Returns all objects except SMSIP components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns components that are of an SMT nature. All of the pads of such a component are of a surface-mount nature.

Syntax

IsSMTComponent : Boolean/Boolean_String

Example Usage

IsSMTComponent
IsSMTComponent = True
IsSMTComponent = 'True'
Returns all SMT components.

Not IsSMTComponent
IsSMTComponent = False
IsSMTComponent = 'False'
Returns all objects except SMT components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all pad objects that are Surface Mount in nature, that is, those whose Hole Size property is set to 0.

Syntax

IsSMTPin : Boolean/Boolean_String

Example Usage

IsSMTPin
IsSMTPin = True
IsSMTPin = 'True'
Returns all surface mount pads.

Not IsSMTPin
IsSMTPin = False
IsSMTPin = 'False'
Returns all objects except surface mount pads.

Summary

Returns components that are of a Surface Mount DIP (SOIC) nature. All of the pads of such a component are of a surface-mount nature, and the total pad count is equal to the product of the number of rows of pads and the number of columns of pads. Such a component also has either exactly two rows of pads and at least three columns of pads, or else has exactly two columns of pads and at least three rows of pads.

Syntax

IsSOIC : Boolean/Boolean_String

Example Usage

IsSOIC
IsSOIC = True
IsSOIC = 'True'
Returns all SOIC components.

Not IsSOIC
IsSOIC = False
IsSOIC = 'False'
Returns all objects except SOIC components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all pad objects with a square pad shape. A 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

IsSquarePad : Boolean/Boolean_String

Example Usage

IsSquarePad
IsSquarePad = True
IsSquarePad = 'True'
Returns all pad objects with a square pad shape.

Not IsSquarePad
IsSquarePad = False
IsSquarePad = 'False'
Returns all objects except pad objects with a square pad shape.

Summary

Returns all pad objects with a square pad shape on the specified layer. A 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

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.

Note

• The single quote characters (') at the start and end of Layer are mandatory.

Summary

Returns component objects whose Component Type property is Standard. These components possess standard electrical properties, are always synchronized between the schematic and PCB (the footprint, pins/pads, and net assignments must all match), and are included in the BOM. An example is a standard electrical component, such as a resistor.

Syntax

IsStandardComponent : Boolean/Boolean_String

Example Usage

IsStandardComponent
IsStandardComponent = True
IsStandardComponent = 'True'
Returns all component objects whose Component Type property is set to Standard.

Not IsStandardComponent
IsStandardComponent = False
IsStandardComponent = 'False'
Returns all objects except component objects whose Component Type property is set to Standard.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all subnet jumper objects.

Syntax

IsSubnetJumper : Boolean/Boolean_String

Example Usage

IsSubnetJumper
IsSubnetJumper = True
IsSubnetJumper = 'True'
Returns all subnet jumper objects.

Not IsSubnetJumper
IsSubnetJumper = False
IsSubnetJumper = 'False'
Returns all objects except subnet jumper objects.

Summary

Returns components that are of a Thru-Hole nature. At least one (and typically all) of the pads of such a component are of a through-hole nature.

Syntax

IsThruComponent : Boolean/Boolean_String

Example Usage

IsThruComponent
IsThruComponent = True
IsThruComponent = 'True'
Returns all Thru-Hole components.

Not IsThruComponent
IsThruComponent = False
IsThruComponent = 'False'
Returns all objects except Thru-Hole components.

Note

• The associated child primitive objects are not returned by this Query.

Summary

Returns all pad objects that are Thru-Hole in nature, that is, those whose Hole Size property is set to a value other than 0.

Syntax

IsThruPin : Boolean/Boolean_String

Example Usage

IsThruPin
IsThruPin = True
IsThruPin = 'True'
Returns all Thru-Hole pads.

Not IsThruPin
IsThruPin = False
IsThruPin = 'False'
Returns all objects except Thru-Hole pads.

Summary

Returns all design objects placed manually by the user.

Syntax

IsUserRouted : Boolean/Boolean_String

Example Usage

IsUserRouted
IsUserRouted = True
IsUserRouted = 'True'
Returns all design objects placed manually by the user. All objects placed as a result of an Autorouting process are not returned.

Not IsUserRouted
IsUserRouted = False
IsUserRouted = 'False'
Returns all objects except design objects placed manually by the user.

Summary

Returns vertical tracks, i.e. those tracks whose X1 and X2 properties are identical.

Syntax

IsVertical : Boolean/Boolean_String

Example Usage

IsVertical
IsVertical = True
IsVertical = 'True'
Returns all vertical tracks.

Not IsVertical
IsVertical = False
IsVertical = 'False'
Returns all objects except vertical tracks.

Summary

Returns all arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

Syntax

IsWire : Boolean/Boolean_String

Example Usage

IsWire
IsWire = True
IsWire = 'True'
Returns all arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

Not IsWire
IsWire = False
IsWire = 'False'
Returns all objects except arc and track objects on the signal layers (Top Layer, Signal Layer 1-30, Bottom Layer) and Multi-Layer.

Summary

Returns tracks whose Manhattan Length complies with the Query.
The Manhattan Length of a track is determined by adding the absolute value of the difference between its X1 and X2 properties, to the absolute value of the difference between its Y1 and Y2 properties. The terminology is derived from Manhattan Island, in New York City, where the streets are laid out in a rectangular pattern.

Syntax

ManHat : Number

Example Usage

ManHat = 300
Returns all tracks whose Manhattan Length is equal to 300mil.

ManHat >= 500
Returns all tracks whose Manhattan Length is greater than, or equal to, 500mil.

ManHat > 400
Returns all tracks whose Manhattan Length is greater than 400mil.

ManHat Between 30 And 40
Returns all tracks whose Manhattan Length is greater than, or equal to, 30mil and less than, or equal to, 40mil.

ManHat <> 500
Returns all tracks whose Manhattan Length is is not equal to 500mil.

Summary

Returns Net objects where the total length of arcs and tracks in those nets complies with the Query.

Syntax

NetLength : Number

Example Usage

NetLength = 30000
Returns all Net objects where the total length of arcs and tracks in those nets is equal to 30000mil.

NetLength >= 15000
Returns all Net objects where the total length of arcs and tracks in those nets is greater than or equal to 15000mil.

NetLength <> 5500
Returns all Net objects where the total length of arcs and tracks in those nets is not equal to 5500mil.

Note

• The associated child objects of the complying Net objects are also returned.

Summary

Returns Net objects where the total number of pads in those nets complies with the Query.

Syntax

NetPinCount : Number

Example Usage

NetPinCount Between 12 And 30
Returns all Net objects where the total number of pads in those nets is greater than or equal to 12 and less than or equal to 30.

NetPinCount > 10
Returns all Net objects where the total number of pads in those nets is greater than 10.

Note

• The associated child objects of the complying Net objects are also returned.

Summary

Returns Net objects where the total number of vias in those nets complies with the Query.

Syntax

NetViaCount : Number

Example Usage

NetViaCount Between 8 And 20
Returns all Net objects where the total number of vias in those nets is greater than or equal to 8 and less than or equal to 20.

NetViaCount < 6
Returns all Net objects where the total number of vias in those nets is less than 6.

Note

• The associated child objects of the complying Net objects are also returned.

Summary

Returns component objects whose number of rows of pads complies with the Query.

Syntax

RowCount : Number

Example Usage

RowCount = 8
Returns all components that have exactly 8 rows of pads.

RowCount Between 6 And 10
Returns all components that have between 6 and 10 rows of pads (inclusive).

RowCount < 4
Returns all objects except components that have 4 rows of pads, or more.

Note

• The associated child objects of the complying component objects are also returned.

Summary

Returns all arc, fill, and track objects, on signal layers whose copper thickness complies with the Query.

Syntax

TraceCopperHeight : Number

Example Usage

TraceCopperHeight = 1.4
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 1.4mil.

TraceCopperHeight Between 1.1 And 1.5
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.1mil, and less than, or equal to, 1.5mil.

TraceCopperHeight >= 1.2
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.2mil.

TraceCopperHeight < 1.3
Returns all objects except arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.3mil.

TraceCopperHeight = 2.8 || (IsArc Or IsFill Or IsTrack && OnMultiLayer)
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 2.8mil, and all arc, fill and track objects on the Multi-Layer.

Note

• This function is an alias for the TraceHeight function.

Summary

Returns all arc, fill, and track objects, on signal layers whose copper thickness complies with the Query.

Syntax

TraceHeight : Number

Example Usage

TraceHeight = 1.4
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 1.4mil.

TraceHeight Between 1.1 And 1.5
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.1mil, and less than, or equal to, 1.5mil.

TraceHeight >= 1.2
Returns all arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.2mil.

TraceHeight < 1.3
Returns all objects except arc, fill, and track objects, on signal layers whose copper thickness is greater than, or equal to, 1.3mil.

TraceHeight = 2.8 || (IsArc Or IsFill Or IsTrack && OnMultiLayer)
Returns all arc, fill, and track objects, on signal layers whose copper thickness is equal to 2.8mil, and all arc, fill and track objects on the Multi-Layer.

Note

• This function is an alias for the TraceCopperHeight function.

Summary

Returns arc and track objects on signal layers, whose length complies with the Query.

Syntax

TraceLength : Number

Example Usage

TraceLength Between 400 And 1800
Returns all arc and track objects that have a length between 400mil and 1800mil (inclusive).

TraceLength > 300
Returns all arc and track objects that have a length that is greater than 300mil.

IsTrack AND OnTopLayer AND (AsMM(TraceLength) < 1)
Returns all track objects that are on the Top Layer and have a length less than 1mm.

Summary

Returns all arc objects whose Radius property complies with the Query.

Syntax

ArcRadius : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(ArcRadius) : Number – to specify a radius in mil.
• AsMM(ArcRadius) : Number – to specify a radius in mm.

Example Usage

ArcRadius = 300
Returns all arc objects that have a Radius property which is 300 current measurement units.

ArcRadius >= 15.24
Returns all arc objects that have a Radius property which is greater than, or equal to, 15.24 current measurement units.

AsMils(ArcRadius) > 500
Returns all arc objects that have a Radius property which is greater than 500mil.

AsMM(ArcRadius) Between 10.16 And 17.78
Returns all arc objects that have a Radius property which is greater than, or equal to, 10.16mm and less than, or equal to, 17.78mm.

ArcRadius <> 550
Returns all arc objects that have a Radius property which is not equal to 550 current measurement units.

AsMils(ArcRadius) <= 650
Returns all arc objects that have a Radius property which is less than, or equal to, 650mil.

AsMM(ArcRadius) < 11.43
Returns all arc objects that have a Radius property which is less than 11.43mm.

Note

The Radius property is only defined for arc objects.

Summary

Returns all arc objects whose Start Angle property complies with the Query.

Syntax

ArcStartAngle : Number

Example Usage

ArcStartAngle = 30.0
Returns all arc objects that have a Start Angle property which is 30.0 degrees.

ArcStartAngle > 60.0
Returns all arc objects that have a Start Angle property which is greater than 60.0 degrees.

ArcStartAngle Between 30.0 And 150.0
Returns all arc objects that have a Start Angle property which is greater than, or equal to, 30.0 degrees and less than, or equal to, 150.0 degrees.

ArcStartAngle <= 45.0
Returns all arc objects that have a Start Angle property which is less than, or equal to, 45.0 degrees.

ArcStartAngle Between 315 And 360 || ArcStartAngle Between 0 And 45
Returns all arc objects that have a Start Angle property which is between 315 degrees and 45 degrees.

Note

The Start Angle property is only defined for arc objects.

Summary

Returns all arc objects whose Stop Angle property complies with the Query.

Syntax

ArcStopAngle : Number

Example Usage

ArcStopAngle = 30.0
Returns all arc objects that have a Stop Angle property which is 30.0 degrees.

ArcStopAngle > 60.0
Returns all arc objects that have a Stop Angle property which is greater than 60.0 degrees.

ArcStopAngle Between 30.0 And 150.0
Returns all arc objects that have a Stop Angle property which is greater than, or equal to, 30.0 degrees and less than, or equal to, 150.0 degrees.

ArcStopAngle <= 45.0
Returns all arc objects that have a Stop Angle property which is less than, or equal to, 45.0 degrees.

ArcStopAngle Between 315 And 360 || ArcStopAngle Between 0 And 45
Returns all arc objects that have a Stop Angle property which is between 315 degrees and 45 degrees.

Note

The Stop Angle property is only defined for arc objects.

Summary

Returns all objects whose Area property complies with the Query.

Syntax

Area = Area_String
Area <> Area_String

Example Usage

Area = '29.4 sq.'
Returns all objects that have a Area property which is equal to 29.4 sq.mm.

Area <> '29.4 sq.'
Returns all objects that have a Area property which is not equal to 29.4 sq.mm.

Notes

• The Area property is only defined for component, fill, polygon and region objects.
• The child objects of object returned by the Query are not returned.
• The single quote characters (') at the start and end of Area_String are mandatory.

Summary

Returns all polygon pour objects whose Auto Assigned Name property complies with the Query.

Syntax

AutoAssignedName : Boolean_String

Boolean_String must be either 'True' or 'False'.

Example Usage

AutoAssignedName = 'True'
Returns all polygon pour objects whose Auto Assigned Name property is enabled.

AutoAssignedName = 'False'
Returns all polygon pour objects whose Auto Assigned Name property is disabled.

AutoAssignedName <> 'True'
Not (AutoAssignedName = 'True')
Returns all objects except polygon pour objects whose Auto Assigned Name property is enabled.

AutoAssignedName <> 'False'
Not (AutoAssignedName = 'False')
Returns all objects except polygon pour objects whose Auto Assigned Name property is disabled.

Notes

• The Auto Assigned Name property is only defined for polygon pour objects.
• When viewing the properties for a selected polygon pour on the Properties panel, the Auto Assigned Name property is called Auto Naming.

Summary

Returns all designator and comment objects (child text objects of component objects) whose Autoposition property complies with the Query.

Syntax

AutoPosition = AutoPosition_String
AutoPosition <> AutoPosition_String

AutoPosition_String must be one of the strings from the following list:

• 'Center'
• 'Center-Above'
• 'Center-Below'
• 'Left-Above'
• 'Left-Below'
• 'Left-Center'
• 'Manual'
• 'Right-Above'
• 'Right-Below'
• 'Right-Center'

Example Usage

AutoPosition = 'Center'
Returns all designator and comment objects whose Autoposition property is Center.

AutoPosition <> 'Manual'
Returns all objects except designator and comment objects whose Autoposition property is Manual.

Notes

• The single quote characters (') at the start and end of AutoPosition_String are mandatory.
• The Autoposition property is only defined for designator and comment objects.

Summary

Returns all text string objects whose BarCode Text Font Name property complies with the Query.

Syntax

BarCodeFontName = FontName_String
BarCodeFontName <> FontName_String

FontName_String must use one of the names of the available TrueType and OpenType (a superset of TrueType) fonts, found in the \Windows\Fonts folder.

Example Usage

BarCodeFontName = 'Arial'
Returns all text string objects whose BarCode Text Font Name property is Arial.

BarCodeFontName <> 'Batang'
Returns all objects except text string objects whose BarCode Text Font Name property is Batang.

Notes

• The single quote characters (') at the start and end of FontName_String are mandatory.
• The BarCode Text Font Name property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Text Font Name property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeFontName = 'Arial').

Summary

Returns all text string objects whose BarCode Full Height property complies with the Query.

Syntax

BarCodeFullHeight : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(BarCodeFullHeight) : Number – to specify a height in mil.
• AsMM(BarCodeFullHeight) : Number – to specify a height in mm.

Example Usage

BarCodeFullHeight = 300
Returns all text string objects that have a BarCode Full Height property which is equal to 300 current measurement units.

BarCodeFullHeight >= 5.08
Returns all text string objects that have a BarCode Full Height property which is greater than or equal to 5.08 current measurement units.

AsMils(BarCodeFullHeight) > 400
Returns all text string objects that have a BarCode Full Height property which is greater than 400mil.

AsMM(BarCodeFullHeight) Between 6.35 And 8.89
Returns all text string objects that have a BarCode Full Height property which is greater than or equal to 6.35mm and less than or equal to 8.89mm.

BarCodeFullHeight <> 550
Returns all text string objects that have a BarCode Full Height property which is not equal to 550 current measurement units.

AsMils(BarCodeFullHeight) <= 650
Returns all text string objects that have a BarCode Full Height property which is less than or equal to 650mil.

AsMM(BarCodeFullHeight) < 11.43
Returns all text string objects that have a BarCode Full Height property which is less than 11.43mm.

Notes

• The BarCode Full Height property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Full Height property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeFullHeight = 210).

Summary

Returns all text string objects whose BarCode Full Width property complies with the Query.

Syntax

BarCodeFullWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(BarCodeFullWidth) : Number – to specify a width in mil.
• AsMM(BarCodeFullWidth) : Number – to specify a width in mm.

Example Usage

BarCodeFullWidth = 1050
Returns all text string objects that have a BarCode Full Width property which is equal to 1050 current measurement units.

BarCodeFullWidth >= 500
Returns all text string objects that have a BarCode Full Width property which is greater than or equal to 500 current measurement units.

AsMils(BarCodeFullWidth) > 400
Returns all text string objects that have a BarCode Full Width property which is greater than 400mil.

AsMM(BarCodeFullWidth) Between 635 And 889
Returns all text string objects that have a BarCode Full Width property which is greater than or equal to 635mm and less than or equal to 889mm.

BarCodeFullWidth <> 550
Returns all text string objects that have a BarCode Full Width property which is not equal to 550 current measurement units.

AsMils(BarCodeFullWidth) <= 650
Returns all text string objects that have a BarCode Full Width property which is less than or equal to 650mil.

AsMM(BarCodeFullWidth) < 1143
Returns all text string objects that have a BarCode Full Width property which is less than 1143mm.

Notes

• The BarCode Full Width property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Full Width property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeFullWidth = 1050).

Summary

Returns all text string objects whose BarCode Inverted property complies with the Query.

Syntax

BarCodeInverted : Boolean_String

Example Usage

BarCodeInverted = 'True'
Returns all text string objects whose BarCode Inverted property is enabled.

BarCodeInverted = 'False'
Returns all text string objects whose BarCode Inverted property is disabled.

Notes

• The BarCode Inverted property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Inverted property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeInverted = 'True').

Summary

Returns all text string objects whose BarCode Min Width property complies with the Query.

Syntax

BarCodeMinWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(BarCodeMinWidth) : Number – to specify a width in mil.
• AsMM(BarCodeMinWidth) : Number – to specify a width in mm.

Example Usage

BarCodeMinWidth = 10
Returns all text string objects that have a BarCode Min Width property which is equal to 10 current measurement units.

BarCodeMinWidth >= 5
Returns all text string objects that have a BarCode Min Width property which is greater than or equal to 5 current measurement units.

AsMils(BarCodeMinWidth) > 4
Returns all text string objects that have a BarCode Min Width property which is greater than 4mil.

AsMM(BarCodeMinWidth) Between 6.35 And 8.89
Returns all text string objects that have a BarCode Min Width property which is greater than or equal to 6.35mm and less than or equal to 8.89mm.

BarCodeMinWidth <> 5.50
Returns all text string objects that have a BarCode Min Width property which is not equal to 5.50 current measurement units.

AsMils(BarCodeMinWidth) <= 6.50
Returns all text string objects that have a BarCode Min Width property which is less than or equal to 6.50mil.

AsMM(BarCodeMinWidth) < 6.43
Returns all text string objects that have a BarCode Min Width property which is less than 6.43mm.

Notes

• The BarCode Min Width property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Min Width property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeMinWidth = 6.25).

Summary

Returns all text string objects whose BarCode Render Mode property complies with the Query.

Syntax

BarCodeRenderMode = RenderMode_String
BarCodeRenderMode <> RenderMode_String

RenderMode_String must be one of the strings from the following list:

• 'By BarCode Full Width'
• 'By BarCode Min Width'

Example Usage

BarCodeRenderMode = 'By BarCode Full Width'
Returns all text string objects whose BarCode Render Mode property is By BarCode Full Width.

BarCodeRenderMode <> 'By BarCode Min Width'
Returns all objects except text string objects whose BarCode Render Mode property is By BarCode Min Width.

Notes

• The single quote characters (') at the start and end of RenderMode_String are mandatory.
• The BarCode Render Mode property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Render Mode property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeRenderMode = 'By BarCode Full Width').

Summary

Returns all text string objects whose BarCode Show Text property complies with the Query.

Syntax

BarCodeShowText : Boolean_String

Example Usage

BarCodeShowText = 'True'
Returns all text string objects whose BarCode Show Text property is enabled.

BarCodeShowText = 'False'
Returns all text string objects whose BarCode Show Text property is disabled.

Notes

• The BarCode Show Text property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Show Text property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeShowText = 'True').

Summary

Returns all text string objects whose BarCode Type property complies with the Query.

Syntax

BarCodeType = CodeType_String
BarCodeType <> CodeType_String

CodeType_String must be one of the strings from the following list:

• 'Code 39'
• 'Code 128'

Example Usage

BarCodeType = 'Code 39'
Returns all text string objects whose BarCode Type property is Code 39.

BarCodeType <> 'Code 128'
Returns all objects except text string objects whose BarCode Type property is Code 128.

Notes

• The single quote characters (') at the start and end of CodeType_String are mandatory.
• The BarCode Type property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Type property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeType = 'Code 39').

Summary

Returns all text string objects whose BarCode X Margin property complies with the Query.

Syntax

BarCodeXMargin : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(BarCodeXMargin) : Number – to specify a margin in mil.
• AsMM(BarCodeXMargin) : Number – to specify a margin in mm.

Example Usage

BarCodeXMargin = 20
Returns all text string objects that have a BarCode X Margin property which is equal to 20 current measurement units.

BarCodeXMargin >= 50
Returns all text string objects that have a BarCode X Margin property which is greater than or equal to 50 current measurement units.

AsMils(BarCodeXMargin) > 40
Returns all text string objects that have a BarCode X Margin property which is greater than 40mil.

AsMM(BarCodeXMargin) Between 0.5 And 0.89
Returns all text string objects that have a BarCode X Margin property which is greater than or equal to 0.5mm and less than or equal to 0.89mm.

BarCodeXMargin <> 20
Returns all text string objects that have a BarCode X Margin property which is not equal to 20 current measurement units.

AsMils(BarCodeXMargin) <= 15
Returns all text string objects that have a BarCode X Margin property which is less than or equal to 15mil.

AsMM(BarCodeXMargin) < 1.23
Returns all text string objects that have a BarCode X Margin property which is less than 1.23mm.

Notes

• The BarCode X Margin property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode X Margin property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeXMargin = 20).

Summary

Returns all text string objects whose BarCode Y Margin property complies with the Query.

Syntax

BarCodeYMargin : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(BarCodeYMargin) : Number – to specify a margin in mil.
• AsMM(BarCodeYMargin) : Number – to specify a margin in mm.

Example Usage

BarCodeYMargin = 20
Returns all text string objects that have a BarCode Y Margin property which is equal to 20 current measurement units.

BarCodeYMargin >= 50
Returns all text string objects that have a BarCode Y Margin property which is greater than or equal to 50 current measurement units.

AsMils(BarCodeYMargin) > 40
Returns all text string objects that have a BarCode Y Margin property which is greater than 40mil.

AsMM(BarCodeYMargin) Between 0.5 And 0.89
Returns all text string objects that have a BarCode Y Margin property which is greater than or equal to 0.5mm and less than or equal to 0.89mm.

BarCodeYMargin <> 20
Returns all text string objects that have a BarCode Y Margin property which is not equal to 20 current measurement units.

AsMils(BarCodeYMargin) <= 15
Returns all text string objects that have a BarCode Y Margin property which is less than or equal to 15mil.

AsMM(BarCodeYMargin) < 1.23
Returns all text string objects that have a BarCode Y Margin property which is less than 1.23mm.

Notes

• The BarCode Y Margin property is only defined for text string objects.
• Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Y Margin property complies with the Query. Should you wish to target solely text string objects that have been configured as barcode text, use an additional keyword prefix to target those objects. An example query expression would be IsBarCodeText And (BarCodeYMargin = 20).

Summary

Returns all 3D body objects whose Body 3-D Color property complies with the Query.

Syntax

BodyColor3D : Numeric_String
BodyColor3D : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the BodyColor3D keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Body 3-D Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Body 3-D Color Div 65536
• Green = Body 3-D Color Div 256 Mod 256
• Red = Body 3-D Color Mod 256

Example Usage

BodyColor3D = '0'
BodyColor3D <> '' && BodyColor3D = 0
Returns all 3D body objects whose Body 3-D Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

BodyColor3D = '16711680'
BodyColor3D > '' && BodyColor3D = 16711680
Returns all 3D body objects whose Body 3-D Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

BodyColor3D <> '16777215'
Returns all 3D body objects except those whose Body 3-D Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsComponentBody && BodyColor3D Div 65536 <= 192
Returns all 3D body objects whose Body 3-D Color property's Blue component has a value which is less than or equal to 192.

Note

The Body 3-D Color property is only defined for 3D body objects.

Summary

Returns all 3D body objects whose Body 3-D Color Opacity property complies with the Query.

Syntax

BodyColor3DOpacity : Numeric_String
BodyColor3DOpacity : Number

Example Usage

BodyColor3DOpacity = '1'
BodyColor3DOpacity = 1
Returns all 3D body objects whose Body 3-D Color Opacity property is 1.000.

BodyColor3DOpacity <> '0.5'
BodyColor3DOpacity <> 0.5
Returns all objects except 3D body objects whose Body 3-D Color Opacity property is 0.500.

Note

The Body 3-D Color Opacity property is only defined for 3D body objects.

Summary

Returns all 3D Body objects whose Override Color property complies with the Query.

Syntax

BodyColor3DOverride : Boolean_String

Boolean_String must be either 'True' or 'False'.

Example Usage

BodyColor3DOverride = 'True'
Returns all 3D Body objects whose Override Color property is enabled.

BodyColor3DOverride = 'False'
Returns all 3D Body objects whose Override Color property is disabled.

BodyColor3DOverride <> 'True'
Not (BodyColor3DOverride = 'True')
Returns all objects except 3D Body objects whose Override Color property is enabled.

BodyColor3DOverride <> 'False'
Not (BodyColor3DOverride = 'False')
Returns all objects except 3D Body objects whose Override Color property is disabled.

Note

The Override Color property is only defined for 3D Body objects.

Summary

Returns all 3D body objects whose Body Projection property complies with the Query.

Syntax

BodyProjection = BodyProjection_String
BodyProjection <> BodyProjection_String

BodyProjection_String must be one of the strings from the following list:

• 'Top Side'
• 'Bottom Side'

Example Usage

BodyProjection = 'Top Side'
Returns all 3D body objects whose Body Projection property is Top Side.

BodyProjection <> 'Bottom Side'
Returns all objects except 3D body objects whose Body Projection property is Bottom Side.

Notes

• The Body Projection property is only defined for 3D body objects.
• The single quote characters (') at the start and end of BodyProjection_String are mandatory.

Summary

Returns all via objects whose Capping Material property complies with the Query.

Syntax

CappingMaterial : String

Example Usage

CappingMaterial = 'Epoxy'
Returns all via objects whose Capping Material property is Epoxy.

CappingMaterial Like 'Epoxy*'
Returns all via objects that have a Capping Material whose associated string commences with Epoxy.

Notes

• The Capping Material property is only defined for via objects.
• The single quote characters (') at the start and end of String are mandatory.

Summary

Returns all via objects whose Capping Side property complies with the Query.

Syntax

CappingSide = CappingSide_String
CappingSide <> CappingSide_String

CappingSide_String must be one of the strings from the following list:

• 'Top'
• 'Bottom'
• 'Both'

Example Usage

CappingSide = 'Top'
Returns all via objects whose Capping Side property is Top.

CappingSide <> 'Both'
Returns all objects except via objects whose Capping Side property is Both.

CappingSide = 'Top' || CappingSide = 'Bottom'
IsVia && CappingSide <> 'Both'
Returns all objects except via objects whose Capping Side property is Both.

Notes

• The Capping Side property is only defined for via objects.
• The single quote characters (') at the start and end of CappingSide_String are mandatory.

Summary

Returns all region objects whose Cavity Height property complies with the Query.

Syntax

CavityHeight : Numeric_String

Example Usage

CavityHeight = '70'
Returns all region objects whose Cavity Height property is equal to 70.

CavityHeight Between '200' And '400'
Returns all region objects whose Cavity Height property is greater than or equal to 200 and less than or equal to 400.

CavityHeight >= '100'
Returns all region objects whose Cavity Height property is greater than or equal to 100.

CavityHeight <> '120'
Returns all objects except region objects whose Cavity Height property is equal to 120.

Note

The Cavity Height property is only defined for region objects, and is only meaningful for regions whose Kind property has been set to Cavity.

Summary

Returns all rectangle objects whose Chamfer/Fillet Size property complies with the Query.

Syntax

ChamferFilletSize : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(ChamferFilletSize) : Number – to specify a width in mil.
• AsMM(ChamferFilletSize) : Number – to specify a width in mm.

Example Usage

ChamferFilletSize = 20
Returns all rectangle objects that have an Chamfer/Fillet Size property which is 20 current measurement units.

ChamferFilletSize >= 1.27
Returns all rectangle objects that have an Chamfer/Fillet Size property which is greater than, or equal to, 1.27 current measurement units.

AsMils(ChamferFilletSize) Between 10 And 30
Returns all rectangle objects that have an Chamfer/Fillet Size property which is greater than, or equal to, 10mil and less than, or equal to, 30mil.

AsMM(ChamferFilletSize) < 1.016
Returns all rectangle objects that have an Chamfer/Fillet Size property which is less than 1.016mm.

Note

The Chamfer/Fillet Size property is only defined for rectangle objects, and is only meaningful for rectangles whose Corner Mode property has been set to Chamfer or Fillet.

Summary

Returns all component objects whose Channel Offset property complies with the Query.

Syntax

ChannelOffset : Numeric_String
ChannelOffset : Number

Example Usage

ChannelOffset = '2'
ChannelOffset <> '' && ChannelOffset = 2
Returns all component objects whose Channel Offset property is 2.

ChannelOffset > '' && ChannelOffset Between 3 And 5
Returns all component objects whose Channel Offset property is greater than, or equal to, 3 and less than, or equal to, 5.

IsComponent && ChannelOffset < 4
Returns all component objects whose Channel Offset property is less than 4.

ObjectKind = 'Component' && ChannelOffset >= 4
Returns all component objects whose Channel Offset property is greater than, or equal to, 4.

ChannelOffset <> '1'
Returns all objects except component objects whose Channel Offset property is 1.

IsComponent && ChannelOffset <> 1
Returns all component objects whose Channel Offset property is not equal to 1.

Notes

• The Channel Offset property is only defined for component objects.
• The child objects of component objects returned by the Query, are not returned.

Summary

Returns all class objects whose Class Type property complies with the Query.

Syntax

ClassType = ClassType_String
ClassType <> ClassType_String

ClassType_String must be one of the strings from the following list:

• 'Component Class'
• 'Design Channel'
• 'DiffPair Class'
• 'From To Class'
• 'Layer Class'
• 'Net Class'
• 'Pad Class'
• 'Polygon Class'
• 'Structure Class'
• 'xSignal Class'

Example Usage

ClassType = 'Component Class'
Returns all class objects whose Class Type property is Component Class.

ClassType <> 'Layer Class'
Returns all objects except class objects whose Class Type property is Layer Class.

Notes

• The Class Type property is only defined for class objects.
• The single quote characters (') at the start and end of ClassType_String are mandatory.

Summary

Returns all Net objects whose Color property complies with the Query.

Syntax

Color : Numeric_String
Color : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Color Div 65536
• Green = Color Div 256 Mod 256
• Red = Color Mod 256

Example Usage

Color = '0'
Color <> '' && Color = 0
Returns all Net objects whose Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Color = '16711680'
Color > '' && Color = 16711680
Returns all Net objects whose Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Color <> '16777215'
Returns all objects except Net objects whose Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

ObjectKind = 'Net' && Color <> 16777215
Returns all Net objects whose Color property is not 16777215.

IsNet && Color Div 65536 >= 96 && Color Div 256 Mod 256 Between 64 And 192 && Color Mod 256 <= 128
Returns all Net objects whose Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

IsNet && Color Div 65536 <= 192
Returns all Net objects whose Color property's Blue component has a value which is less than or equal to 192.

IsNet && Color Mod 256 Between 64 And 192
Returns all Net objects whose Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Notes

• The Color property is only defined for Net objects.
• The child objects of Net objects returned by the Query, are not returned.

Summary

Returns all component objects whose Component Comment property complies with the Query.

Syntax

Comment : String

Example Usage

Comment = '100nF'
Returns all components that have a Component Comment of 100nF.

Comment <> '100nF'
Returns all objects except component objects that have a Component Comment of 100nF.

Notes

• The Component Comment property is only defined for component objects.
• The child objects of components returned by the Query are not returned.

Summary

Returns all child objects of any component object whose Name property complies with the Query.

Syntax

Component : String

Example Usage

Component = 'C1'
Returns all child objects of any component that has a Name of C1.

Component Like 'C?*'
Returns all child objects of any component that has a Name starting with C, and which includes at least one additional character.

Component <> 'C1'
Returns all objects except the child objects of any component that has a Name of C1.

Component = 'Free'
Returns all objects except the child objects of component objects.

Note

The parent component objects of child objects returned by this Query, are not returned.

Summary

Returns all component objects whose Flipped On Layer property complies with the Query.

Syntax

ComponentFlippedOnLayer : Boolean_String

Example Usage

ComponentFlippedOnLayer = 'True'
Returns all component objects whose Flipped On Layer property is enabled.

ComponentFlippedOnLayer = 'False'
Returns all component objects whose Flipped On Layer property is disabled.

Note

The Flipped On Layer property is only defined for component objects.

Summary

Returns all component objects whose Lock Strings property complies with the Query.

Syntax

ComponentStringsLocked : Boolean_String

Example Usage

ComponentStringsLocked = 'True'
Returns all components whose Lock Strings property is enabled.

ComponentStringsLocked = 'False'
Returns all components whose Lock Strings property is disabled.

Note

The child objects of components returned by the Query are not returned.

Summary

Returns all component objects having a Component Type property that complies with the Query.

Syntax

ComponentType = ComponentType_String

ComponentType <> ComponentType_String

ComponentType_String must be one of the strings from the following list:

• 'Graphical'
• 'Jumper'
• 'Mechanical'
• 'Net Tie'
• 'Net Tie (In BOM)'
• 'Standard'
• 'Standard (No BOM)'

Example Usage

ComponentType = 'Graphical'
Returns all components whose Component Type is Graphical.

ComponentType <> 'Standard'
Returns all objects except components whose Component Type is Standard.

Notes

• The Component Type property is only defined for component objects.
• The child objects of components returned by the Query are not returned.
• The single quote characters (') at the start and end of ComponentType_String are mandatory.

Summary

Returns coordinate and original dimension objects whose Line Width (Coord/Dimen) property complies with the Query.

Syntax

CoordinateDimensionLineWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(CoordinateDimensionLineWidth) : Number – to specify a width in mil.
• AsMM(CoordinateDimensionLineWidth) : Number – to specify a width in mm.

Example Usage

CoordinateDimensionLineWidth = 10
Returns all coordinate and original dimension objects that have a Line Width (Coord/Dimen) property which is 10 current measurement units.

CoordinateDimensionLineWidth >= 0.2286
Returns all coordinate and original dimension objects that have a Line Width (Coord/Dimen) property which is greater than or equal to 0.2286 current measurement units.

AsMils(CoordinateDimensionLineWidth) Between 8 And 12
Returns all coordinate and original dimension objects that have a Line Width (Coord/Dimen) property which is greater than or equal to 8mil and less than or equal to 12mil.

AsMM(CoordinateDimensionLineWidth) < 0.2794
Returns all coordinate and original dimension objects that have a Line Width (Coord/Dimen) property which is less than 0.2794mm.

Notes

• The Line Width (Coord/Dimen) property is only defined for coordinate and dimension objects.
• The child objects of coordinate and original dimension objects returned by the Query are not returned.

Summary

Returns coordinate, center dimension, leader dimension, and original dimension objects whose Size (Coord/Dimen) property complies with the Query.

Syntax

CoordinateDimensionSize : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(CoordinateDimensionSize) : Number – to specify a size in mil.
• AsMM(CoordinateDimensionSize) : Number – to specify a size in mm.

Example Usage

CoordinateDimensionSize = 10
Returns all coordinate, center dimension, leader dimension, and original dimension objects that have a Size (Coord/Dimen) property which is 10 current measurement units.

CoordinateDimensionSize >= 0.2286
Returns all coordinate, center dimension, leader dimension, and original dimension objects that have a Size (Coord/Dimen) property which is greater than or equal to 0.2286 current measurement units.

AsMils(CoordinateDimensionSize) Between 8 And 12
Returns all coordinate, center dimension, leader dimension, and original dimension objects that have a Size (Coord/Dimen) property which is greater than or equal to 8mil and less than or equal to 12mil.

AsMM(CoordinateDimensionSize) < 0.2794
Returns all coordinate, center dimension, leader dimension, and original dimension objects that have a Size (Coord/Dimen) property which is less than 0.2794mm.

Notes

• The Size (Coord/Dimen) property is only defined for coordinate, center dimension, leader dimension, and original dimension objects.
• The child objects of coordinate, center dimension, leader dimension, and original dimension objects returned by the Query are not returned.

Summary

Returns all coordinate and original dimension objects whose Unit Style property complies with the Query.

Syntax

CoordinateDimensionUnitStyle = UnitStyle_String
CoordinateDimensionUnitStyle <> UnitStyle_String

UnitStyle_String must be one of the strings from the following list:

• 'Brackets'
• 'None'
• 'Normal'

Example Usage

CoordinateDimensionUnitStyle = 'Brackets'
Returns all coordinate and original dimension objects whose Unit Style property is Brackets.

CoordinateDimensionUnitStyle <> 'Normal'
Returns all objects except coordinate and original dimension objects whose Unit Style property is Normal.

Notes

• The Unit Style property is only defined for coordinate and original dimension objects.
• The single quote characters (') at the start and end of UnitStyle_String are mandatory.
• The child objects of coordinate and original dimension objects returned by the Query are not returned.

Summary

Returns all rectangle objects whose Corner Mode property complies with the Query.

Syntax

CornerMode = CornerMode_String
CornerMode <> CornerMode_String

CornerMode_String must be one of the strings from the following list:

• 'Rectangle'
• 'Chamfer'
• 'Fillet'

Example Usage

CornerMode = 'Rectangle'
Returns all rectangle objects whose Corner Mode property is Rectangle.

CornerMode <> 'Chamfer'
Returns all objects except rectangle objects whose Corner Mode property is Chamfer.

CornerMode = 'Chamfer' || CornerMode = 'Fillet'
Returns all objects except rectangle objects whose Corner Mode property is Rectangle.

Notes

• The Corner Mode property is only defined for rectangle objects.
• The single quote characters (') at the start and end of CornerMode_String are mandatory.

Summary

Returns all via objects whose Covering Material property complies with the Query.

Syntax

CoveringMaterial : String

Example Usage

CoveringMaterial = 'Epoxy'
Returns all via objects whose Covering Material property is Epoxy.

CoveringMaterial Like 'Epoxy*'
Returns all via objects that have a Covering Material whose associated string commences with Epoxy.

Notes

• The Covering Material property is only defined for via objects.
• The single quote characters (') at the start and end of String are mandatory.

Summary

Returns all via objects whose Covering Side property complies with the Query.

Syntax

CoveringSide = Covering_String
CoveringSide <> Covering_String

Covering_String must be one of the strings from the following list:

• 'Top'
• 'Bottom'
• 'Both'

Example Usage

CoveringSide = 'Top'
Returns all via objects whose Covering Side property is Top.

CoveringSide <> 'Both'
Returns all objects except via objects whose Covering Side property is Both.

CoveringSide = 'Top' || CoveringSide = 'Bottom'
IsVia && CoveringSide <> 'Both'
Returns all objects except via objects whose Covering Side property is Both.

Notes

• The Covering Side property is only defined for via objects.
• The single quote characters (') at the start and end of Covering_String are mandatory.

Summary

Returns all leader dimension objects whose Arrow Gap property complies with the Query.

Syntax

DimensionArrowGap : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionArrowGap) : Number – to specify a gap in mil.
• AsMM(DimensionArrowGap) : Number – to specify a gap in mm.

Example Usage

DimensionArrowGap = 10
Returns all leader dimension objects that have an Arrow Gap property which is 10 current measurement units.

DimensionArrowGap >= 0.2286
Returns all leader dimension objects that have an Arrow Gap property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionArrowGap) Between 8 And 12
Returns all leader dimension objects that have an Arrow Gap property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionArrowGap) < 0.2794
Returns all leader dimension objects that have an Arrow Gap property which is less than 0.2794mm.

Notes

• The Arrow Gap property is only defined for leader dimension objects.
• The child objects of leader dimension objects returned by the Query are not returned.

Summary

Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects whose Arrow Length property complies with the Query.

Syntax

DimensionArrowLength : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionArrowLength) : Number – to specify a length in mil.
• AsMM(DimensionArrowLength) : Number – to specify a length in mm.

Example Usage

DimensionArrowLength = 100
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects that have an Arrow Length property which is 100 current measurement units.

DimensionArrowLength >= 2.286
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects that have an Arrow Length property which is greater than, or equal to, 2.286 current measurement units.

AsMils(DimensionArrowLength) Between 80 And 120
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects that have an Arrow Length property which is greater than, or equal to, 80mil and less than, or equal to, 120mil.

AsMM(DimensionArrowLength) < 2.794
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects that have an Arrow Length property which is less than 2.794mm.

Notes

• The Arrow Length property is only defined for angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects.
• The child objects of angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Line Width property complies with the Query.

Syntax

DimensionArrowLineWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionArrowLineWidth) : Number – to specify a width in mil.
• AsMM(DimensionArrowLineWidth) : Number – to specify a width in mm.

Example Usage

DimensionArrowLineWidth = 10
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Line Width property which is 10 current measurement units.

DimensionArrowLineWidth >= 0.2286
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Line Width property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionArrowLineWidth) Between 8 And 12
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Line Width property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionArrowLineWidth) < 0.2794
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Line Width property which is less than 0.2794mm.

Notes

• The Arrow Line Width property is only defined for angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property complies with the Query.

Syntax

DimensionArrowPosition = ArrowPosition_String
DimensionArrowPosition <> ArrowPosition_String

ArrowPosition_String must be one of the strings from the following list:

• 'Inside'
• 'Outside'

Example Usage

DimensionArrowPosition = 'Inside'
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property is Inside.

DimensionArrowPosition <> 'Outside'
Returns all objects except angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property is Outside.

Notes

• The single quote characters (') at the start and end of ArrowPosition_String are mandatory.
• The Arrow Position property is only defined for angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Size property complies with the Query.

Syntax

DimensionArrowSize : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionArrowSize) : Number – to specify a size in mil.
• AsMM(DimensionArrowSize) : Number – to specify a size in mm.

Example Usage

DimensionArrowSize = 60
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Size property which is 60 current measurement units.

DimensionArrowSize >= 1.016
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Size property which is greater than, or equal to, 1.016 current measurement units.

AsMils(DimensionArrowSize) Between 50 And 70
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Size property which is greater than, or equal to, 50mil and less than, or equal to, 70mil.

AsMM(DimensionArrowSize) < 2.032
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Arrow Size property which is less than 2.032mm.

Notes

• The Arrow Size property is only defined for angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects whose Extension Line Width property complies with the Query.

Syntax

DimensionExtensionLineWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionExtensionLineWidth) : Number – to specify a width in mil.
• AsMM(DimensionExtensionLineWidth) : Number – to specify a width in mm.

Example Usage

DimensionExtensionLineWidth = 10
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Line Width property which is 10 current measurement units.

DimensionExtensionLineWidth >= 0.2286
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Line Width property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionExtensionLineWidth) Between 8 And 12
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Line Width property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionExtensionLineWidth) < 0.2794
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Line Width property which is less than 0.2794mm.

Notes

• The Extension Line Width property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects whose Extension Offset property complies with the Query.

Syntax

DimensionExtensionOffset : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionExtensionOffset) : Number – to specify an offset in mil.
• AsMM(DimensionExtensionOffset) : Number – to specify an offset in mm.

Example Usage

DimensionExtensionOffset = 10
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects that have an Extension Offset property which is 10 current measurement units.

DimensionExtensionOffset >= 0.2286
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects that have an Extension Offset property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionExtensionOffset) Between 8 And 12
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects that have an Extension Offset property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionExtensionOffset) < 0.2794
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects that have an Extension Offset property which is less than 0.2794mm.

Notes

• The Extension Offset property is only defined for angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects.
• The child objects of angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects whose Extension Pick Gap property complies with the Query.

Syntax

DimensionExtensionPickGap : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionExtensionPickGap) : Number – to specify a gap in mil.
• AsMM(DimensionExtensionPickGap) : Number – to specify a gap in mm.

Example Usage

DimensionExtensionPickGap = 10
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Pick Gap property which is 10 current measurement units.

DimensionExtensionPickGap >= 0.2286
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Pick Gap property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionExtensionPickGap) Between 8 And 12
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Pick Gap property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionExtensionPickGap) < 0.2794
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects that have an Extension Pick Gap property which is less than 0.2794mm.

Notes

• The Extension Pick Gap property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Font property complies with the Query.

Syntax

DimensionTextFont = Font_String
DimensionTextFont <> Font_String

Font_String must be one of the strings from the following list:

• 'Default'
• 'Serif'
• 'Sans Serif'

Example Usage

DimensionTextFont = 'Default'
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Font property is Default.

DimensionTextFont <> 'Serif'
Returns all objects except angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Font property is Serif.

Notes

• The single quote characters (') at the start and end of Font_String are mandatory.
• The Dimension Font property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property complies with the Query.

Syntax

DimensionTextFormat = TextFormat_String
DimensionTextFormat <> TextFormat_String

TextFormat_String must be 'None'.

Example Usage

DimensionTextFormat = 'None'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. no values and units are displayed).

DimensionTextFormat <> 'None'
Returns all objects except angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. will return those applicable dimension objects whose format is set to show the value only, the value and units, or the value and units (with the latter in brackets)).

Notes

• The single quote characters (') at the start and end of TextFormat_String are mandatory.
• The Dimension Format property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Gap property complies with the Query.

Syntax

DimensionTextGap : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionTextGap) : Number – to specify a gap in mil.
• AsMM(DimensionTextGap) : Number – to specify a gap in mm.

Example Usage

DimensionTextGap = 10
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Gap property which is 10 current measurement units.

DimensionTextGap >= 0.2286
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Gap property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(DimensionTextGap) Between 8 And 12
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Gap property which is greater than, or equal to, 8mil and less than, or equal to, 12mil.

AsMM(DimensionTextGap) < 0.2794
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Gap property which is less than 0.2794mm.

Notes

• The Dimension Text Gap property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Height property complies with the Query.

Syntax

DimensionTextHeight : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionTextHeight) : Number – to specify a height in mil.
• AsMM(DimensionTextHeight) : Number – to specify a height in mm.

Example Usage

DimensionTextHeight = 60
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Height property which is 60 current measurement units.

DimensionTextHeight >= 1.27
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Height property which is greater than, or equal to, 1.27 current measurement units.

AsMils(DimensionTextHeight) Between 40 And 80
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Height property which is greater than, or equal to, 40mil and less than, or equal to, 80mil.

AsMM(DimensionTextHeight) < 1.778
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Height property which is less than 1.778mm.

Notes

• The Dimension Text Height property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.
• For the original dimension, the value for the Dimension Text Height property follows the value for the dimension's Text Height property.

Summary

Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Line Width property complies with the Query.

Syntax

DimensionTextLineWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(DimensionTextLineWidth) : Number – to specify a width in mil.
• AsMM(DimensionTextLineWidth) : Number – to specify a width in mm.

Example Usage

DimensionTextLineWidth = 6
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Line Width property which is 6 current measurement units.

DimensionTextLineWidth >= 0.127
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Line Width property which is greater than, or equal to, 0.127 current measurement units.

AsMils(DimensionTextLineWidth) Between 4 And 8
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Line Width property which is greater than, or equal to, 4mil and less than, or equal to, 8mil.

AsMM(DimensionTextLineWidth) < 0.1778
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects that have an Dimension Text Line Width property which is less than 0.1778mm.

Notes

• The Dimension Text Line Width property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.
• For the original dimension, the value for the Dimension Text Line Width property follows the value for the dimension's Text Width property.

Summary

Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property complies with the Query.

Syntax

DimensionTextPosition = DimensionTextPosition_String
DimensionTextPosition <> DimensionTextPosition_String

DimensionTextPosition_String must be one of the strings from the following list:

• 'Aligned - Bottom'
• 'Aligned - Center'
• 'Aligned - Inside Left'
• 'Aligned - Inside Right'
• 'Aligned - Left'
• 'Aligned - Right'
• 'Aligned - Top'
• 'Automatic'
• 'Manual'
• 'Unidirectional'

Example Usage

DimensionTextPosition = 'Automatic'
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property is Automatic.

DimensionTextPosition <> 'Manual'
Returns all objects except angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property is Manual.

Notes

• The single quote characters (') at the start and end of DimensionTextPosition_String are mandatory.
• The Dimension Text Position property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property complies with the Query.

Syntax

DimensionTextPrecision : Numeric_String
DimensionTextPrecision : Number

Example Usage

DimensionTextPrecision = '2'
DimensionTextPrecision <> '' && DimensionTextPrecision = 2
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is 2.

DimensionTextPrecision > '' && DimensionTextPrecision Between 3 And 5
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is greater than, or equal to, 3 and less than, or equal to, 5.

IsDimension && DimensionTextPrecision < 4
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is less than 4.

DimensionTextPrecision <> '1'
Returns all objects except angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is 1.

IsDimension && DimensionTextPrecision <> 1
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is not equal to 1.

Notes

• The Dimension Precision property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Prefix property complies with the Query.

Syntax

DimensionTextPrefix : String

Example Usage

DimensionTextPrefix = 'ø'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Prefix property is ø.

Notes

• The Dimension Prefix property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Suffix property complies with the Query.

Syntax

DimensionTextSuffix : String

Example Usage

DimensionTextSuffix = '(+/- 0.5%)'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Suffix property is (+/- 0.5%).

Notes

• The Dimension Suffix property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property complies with the Query.

Syntax

DimensionTextUnit = DimensionUnit_String
DimensionTextUnit <> DimensionUnit_String

For angular dimension objects, DimensionUnit_String must be one of the strings from the following list:

• 'Degrees'
• 'Radians'

For baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects, DimensionUnit_String must be one of the strings from the following list:

• 'Automatic'
• 'Centimeters'
• 'Inches'
• 'Millimeters'
• 'Mils'

Example Usage

DimensionTextUnit = 'Radians'
Returns all angular dimension objects whose Dimension Unit property is Radians.

DimensionTextUnit <> 'Degrees'
Returns all objects except angular dimension objects whose Dimension Unit property is Degrees.

DimensionTextUnit = 'Mils'
Returns all baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property is Mils.

DimensionTextUnit <> 'Inches'
Returns all objects except baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property is Inches.

Notes

• The single quote characters (') at the start and end of DimensionUnit_String are mandatory.
• The Dimension Unit property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
• The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.

Summary

Returns all via objects whose Drill Pair property complies with the Query.

Syntax

DrillPair = 'Start Layer - Stop Layer'

Example Usage

DrillPair = 'Top Layer - Bottom Layer'
Returns all via objects whose Drill Pair property is Top Layer - Bottom Layer.

DrillPair <> 'Signal Layer 1 - Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property is Signal Layer 1 - Signal Layer 2.

IsVia && DrillPair <> 'Top Layer - Bottom Layer'
Returns all Via objects except those whose Drill Pair property is Top Layer - Bottom Layer.

Notes

• The single quote characters (') at the start and end of the string are mandatory.
• The Drill Pair property is only defined for via objects.

Summary

Returns all pad objects whose Drill Type property complies with the Query.

Syntax

DrillType = DrillType_String
DrillType <> DrillType_String

DrillType_String must be one of the strings from the following list:

• 'Drilled'
• 'Laser Drilled'
• 'Plasma Drilled'
• 'Punched'

Example Usage

DrillType = 'Drilled'
Returns all pad objects whose Drill Type property is Drilled.

DrillType <> 'Punched'
Returns all objects except pad objects whose Drill Type property is Punched.

DrillType = 'Laser Drilled' || DrillType = 'Plasma Drilled' || DrillType = 'Punched'
IsPad && DrillType <> 'Drilled'
Returns all pad objects whose Drill Type property is not Drilled.

Notes

• The Drill Type property is only defined for pad objects.
• The single quote characters (') at the start and end of DrillType_String are mandatory.

Summary

Returns all embedded board objects whose Col Count property complies with the Query.

Syntax

EmbeddedBoard_ColCount : Numeric_String
EmbeddedBoard_ColCount : Number

Example Usage

EmbeddedBoard_ColCount = '2'
EmbeddedBoard_ColCount = 2
Returns all embedded board objects whose Col Count property is 2.

EmbeddedBoard_ColCount <> '4'
EmbeddedBoard_ColCount <> 4
Returns all objects except embedded board objects whose Col Count property is 4.

Note

The Col Count property is only defined for embedded board objects.

Summary

Returns embedded board objects whose Column Spacing property complies with the Query.

Syntax

EmbeddedBoard_ColumnSpacing : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(EmbeddedBoard_ColumnSpacing) : Number – to specify a spacing in mil.
• AsMM(EmbeddedBoard_ColumnSpacing) : Number – to specify a spacing in mm.

Example Usage

EmbeddedBoard_ColumnSpacing = 1500
Returns all embedded board objects that have a Column Spacing property which is 1500 current measurement units.

EmbeddedBoard_ColumnSpacing >= 1000
Returns all embedded board objects that have a Column Spacing property which is greater than or equal to 1000 current measurement units.

AsMils(EmbeddedBoard_ColumnSpacing) Between 1000 And 1500
Returns all embedded board objects that have a Column Spacing property which is greater than or equal to 1000mil and less than or equal to 1500mil.

AsMM(EmbeddedBoard_ColumnSpacing) < 38.1
Returns all embedded board objects that have a Column Spacing property which is less than 38.1mm.

Note

The Column Spacing property is only defined for embedded board objects.

Summary

Returns all embedded board objects whose Embedded Document Name property complies with the Query.

Syntax

EmbeddedBoard_DocumentName : String

Example Usage

EmbeddedBoard_DocumentName = 'C:\Users\Public\Documents\Altium\Projects\Example_Design\Example_PCB.PcbDoc'
Returns all embedded board objects whose Embedded Document Name property is C:\Users\Public\Documents\Altium\Projects\Example_Design\Example_PCB.PcbDoc.

EmbeddedBoard_DocumentName Like '*Example_PCB.PcbDoc'
Returns all embedded board objects whose Embedded Document Name property ends in Example_PCB.PcbDoc.

Note

The Embedded Document Name property is only defined for embedded board objects.

Summary

Returns all embedded board objects whose Link To Embedded Board Origin property complies with the Query.

Syntax

EmbeddedBoard_OriginMode : Boolean_String

Example Usage

EmbeddedBoard_OriginMode = 'True'
Returns all embedded board objects whose Link To Embedded Board Origin property is enabled.

EmbeddedBoard_OriginMode = 'False'
Returns all embedded board objects whose Link To Embedded Board Origin property is disabled.

Note

The Link To Embedded Board Origin property is only defined for embedded board objects.

Summary

Returns all embedded board objects whose Row Count property complies with the Query.

Syntax

EmbeddedBoard_RowCount : Numeric_String
EmbeddedBoard_RowCount : Number

Example Usage

EmbeddedBoard_RowCount = '2'
EmbeddedBoard_RowCount = 2
Returns all embedded board objects whose Row Count property is 2.

EmbeddedBoard_RowCount <> '4'
EmbeddedBoard_RowCount <> 4
Returns all objects except embedded board objects whose Row Count property is 4.

Note

The Row Count property is only defined for embedded board objects.

Summary

Returns embedded board objects whose Row Spacing property complies with the Query.

Syntax

EmbeddedBoard_RowSpacing : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(EmbeddedBoard_RowSpacing) : Number – to specify a spacing in mil.
• AsMM(EmbeddedBoard_RowSpacing) : Number – to specify a spacing in mm.

Example Usage

EmbeddedBoard_RowSpacing = 2500
Returns all embedded board objects that have a Row Spacing property which is 2500 current measurement units.

EmbeddedBoard_RowSpacing >= 2000
Returns all embedded board objects that have a Row Spacing property which is greater than or equal to 2000 current measurement units.

AsMils(EmbeddedBoard_RowSpacing) Between 2500 And 3000
Returns all embedded board objects that have a Row Spacing property which is greater than or equal to 2500mil and less than or equal to 3000mil.

AsMM(EmbeddedBoard_RowSpacing) < 63.5
Returns all embedded board objects that have a Row Spacing property which is less than 63.5mm.

Note

The Row Spacing property is only defined for embedded board objects.

Summary

Returns all component objects whose Enable Part Swapping property complies with the Query.

Syntax

EnablePartSwapping : Boolean_String

Example Usage

EnablePartSwapping = 'True'
Returns all component objects whose Enable Part Swapping property is enabled.

EnablePartSwapping = 'False'
Returns all component objects whose Enable Part Swapping property is disabled.

Notes

• The Enable Part Swapping property is only defined for component objects.
• The child objects of components returned by the Query are not returned.

Summary

Returns all component objects whose Enable Pin Swapping property complies with the Query.

Syntax

EnablePinSwapping : Boolean_String

Example Usage

EnablePinSwapping = 'True'
Returns all component objects whose Enable Pin Swapping property is enabled.

EnablePinSwapping = 'False'
Returns all component objects whose Enable Pin Swapping property is disabled.

Notes

• The Enable Pin Swapping property is only defined for component objects.
• The child objects of components returned by the Query are not returned.

Summary

Returns all via objects whose Filling Material property complies with the Query.

Syntax

FillingMaterial : String

Example Usage

FillingMaterial = 'Epoxy'
Returns all via objects whose Filling Material property is Epoxy.

FillingMaterial Like 'Epoxy*'
Returns all via objects that have a Filling Material whose associated string commences with Epoxy.

Notes

• The Filling Material property is only defined for via objects.
• The single quote characters (') at the start and end of String are mandatory.

Summary

Returns all via objects whose Filling Side property complies with the Query.

Syntax

FillingSide = FillingSide_String
FillingSide <> FillingSide_String

FillingSide_String must be one of the strings from the following list:

• 'Top'
• 'Bottom'
• 'Both'

Example Usage

FillingSide = 'Top'
Returns all via objects whose Filling Side property is Top.

FillingSide <> 'Both'
Returns all objects except via objects whose Filling Side property is Both.

FillingSide = 'Top' || FillingSide = 'Bottom'
IsVia && FillingSide <> 'Both'
Returns all objects except via objects whose Filling Side property is Both.

Notes

• The Filling Side property is only defined for via objects.
• The single quote characters (') at the start and end of FillingSide_String are mandatory.

Summary

Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property complies with the Query.

Syntax

FontName = FontName_String
FontName <> FontName_String

FontName_String must use one of the names of the available TrueType and OpenType (a superset of TrueType) fonts, found in the \Windows\Fonts folder.

Example Usage

FontName = 'Arial'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property is Arial.

FontName <> 'Batang'
Returns all objects except coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property is Batang.

Notes

• The single quote characters (') at the start and end of FontName_String are mandatory.
• The TrueType Font Name property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.

Summary

Returns all component objects whose Footprint property complies with the Query.

Syntax

Footprint : String

Example Usage

Footprint = 'DIP14'
Returns all components that have a Footprint of DIP14.

Footprint Like 'DIP*'
Returns all components that have a Footprint whose associated string commences with DIP.

Notes

• The Footprint property is only defined for component objects.
• The child objects of components returned by the Query are not returned.

Summary

Returns all from-to objects whose From Pad property complies with the Query.

Syntax

FromToPad1 : PadName_String

PadName_String specifies the full Name that a pad has to match; this consists of an initial substring which specifies the Name property of the pad's parent component (i.e. the component's Designator), followed by a substring that specifies the pad's own Name property (i.e. the pad's Designator). The format will therefore be 'ParentComponentDesignator-PadDesignator'.

Example Usage

FromToPad1 = 'C14-2'
Returns all from-to objects whose From Pad property is C14-2.

Notes

• The single quote characters (') at the start and end of PadName_String are mandatory.
• The From Pad property is only defined for from-to objects.

Summary

Returns all from-to objects whose To Pad property complies with the Query.

Syntax

FromToPad2 : PadName_String

PadName_String specifies the full Name that a pad has to match; this consists of an initial substring which specifies the Name property of the pad's parent component (i.e. the component's Designator), followed by a substring that specifies the pad's own Name property (i.e. the pad's Designator). The format will therefore be 'ParentComponentDesignator-PadDesignator'.

Example Usage

FromToPad2 = 'U1-8'
Returns all from-to objects whose To Pad property is U1-8.

Notes

• The single quote characters (') at the start and end of PadName_String are mandatory.
• The To Pad property is only defined for from-to objects.

Summary

Returns all component objects whose Height property complies with the Query.

Syntax

H : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(H) : Number – to specify a height in mil.
• AsMM(H) : Number – to specify a height in mm.

Example Usage

H = 300
Returns all components that have a Height property which is equal to 300 current measurement units.

H >= 5.08
Returns all components that have a Height property which is greater than or equal to 5.08 current measurement units.

AsMils(H) > 400
Returns all components that have a Height property which is greater than 400mil.

AsMM(H) Between 6.35 And 8.89
Returns all components that have a Height property which is greater than or equal to 6.35mm and less than or equal to 8.89mm.

H <> 550
Returns all components that have a Height property which is not equal to 550 current measurement units.

AsMils(H) <= 650
Returns all components that have a Height property which is less than or equal to 650mil.

AsMM(H) < 11.43
Returns all components that have a Height property which is less than 11.43mm.

Notes

• The Height property is only defined for component objects.
• The child objects of components returned by the Query are not returned.
• This function is an alias for the Height function.

Summary

Returns all component objects whose Height property complies with the Query.

Syntax

Height : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(Height) : Number – to specify a height in mil.
• AsMM(Height) : Number – to specify a height in mm.

Example Usage

Height = 300
Returns all components that have a Height property which is equal to 300 current measurement units.

Height >= 5.08
Returns all components that have a Height property which is greater than or equal to 5.08 current measurement units.

AsMils(Height) > 400
Returns all components that have a Height property which is greater than 400mil.

AsMM(Height) Between 6.35 And 8.89
Returns all components that have a Height property which is greater than or equal to 6.35mm and less than or equal to 8.89mm.

Height <> 550
Returns all components that have a Height property which is not equal to 550 current measurement units.

AsMils(Height) <= 650
Returns all components that have a Height property which is less than or equal to 650mil.

AsMM(Height) < 11.43
Returns all components that have a Height property which is less than 11.43mm.

Notes

• The Height property is only defined for component objects.
• The child objects of components returned by the Query are not returned.
• This function is an alias for the H function.

Summary

Returns all component comment, component designator, and net objects whose Hide property complies with the Query.

Syntax

Hide : Boolean

Example Usage

Hide
Hide = True
Returns all component comment, component designator, and net objects whose Hide property is True.

Not Hide
Hide = False
Returns all objects except component comment, component designator, and net objects whose Hide property is False.

Note

The Hide property is only defined for component comment, component designator, and net objects.

Summary

Returns all component objects whose Hide Jumpers property complies with the Query.

Syntax

HideJumpers : Boolean_String

Example Usage

HideJumpers = 'True'
Returns all component objects whose Hide Jumpers property is enabled.

HideJumpers = 'False'
Returns all component objects whose Hide Jumpers property is disabled.

Notes

• The Hide Jumpers property is only defined for component objects.
• The child objects of components returned by the Query are not returned.

Summary

Returns all pad and via objects whose Hole Size property complies with the Query.

Syntax

Hole : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(Hole) : Number – to specify a hole size in mil.
• AsMM(Hole) : Number – to specify a hole size in mm.

Example Usage

Hole = 16
Returns all pad and via objects that have a Hole Size property which is 16 current measurement units.

Hole >= 0.508
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 0.508 current measurement units.

AsMils(Hole) Between 12 And 32
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 12mil and less than or equal to 32mil.

AsMM(Hole) < 1.016
Returns all pad and via objects that have a Hole Size property which is less than 1.016mm.

Notes

• The Hole Size property is only defined for pad and via objects.
• This function is an alias for the HoleDiameter and HoleSize functions.

Summary

Returns all pad and via objects whose Hole Size property complies with the Query.

Syntax

HoleDiameter : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(HoleDiameter) : Number – to specify a hole diameter in mil.
• AsMM(HoleDiameter) : Number – to specify a hole diameter in mm.

Example Usage

HoleDiameter = 16
Returns all pad and via objects that have a Hole Size property which is 16 current measurement units.

HoleDiameter >= 0.508
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 0.508 current measurement units.

AsMils(HoleDiameter) Between 12 And 32
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 12mil and less than or equal to 32mil.

AsMM(HoleDiameter) < 1.016
Returns all pad and via objects that have a Hole Size property which is less than 1.016mm.

Notes

• The Hole Size property is only defined for pad and via objects.
• This function is an alias for the HoleSize and Hole functions.

Summary

Returns all pad and via objects whose Hole Tolerance (-) property complies with the Query.

Syntax

HoleNegativeTolerance : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(HoleNegativeTolerance) : Number – to specify a tolerance in mil.
• AsMM(HoleNegativeTolerance) : Number – to specify a tolerance in mm.

Example Usage

HoleNegativeTolerance = 4
Returns all pad and via objects that have a Hole Tolerance (-) property which is equal to 4 current measurement units.

HoleNegativeTolerance >= 5.08
Returns all pad and via objects that have a Hole Tolerance (-) property which is greater than or equal to 5.08 current measurement units.

AsMils(HoleNegativeTolerance) > 4
Returns all pad and via objects that have a Hole Tolerance (-) property which is greater than 4mil.

AsMM(HoleNegativeTolerance) Between 0.102 And 0.105
Returns all pad and via objects that have a Hole Tolerance (-) property which is greater than or equal to 0.102mm and less than or equal to 0.105mm.

HoleNegativeTolerance <> 2
Returns all pad and via objects that have a Hole Tolerance (-) property which is not equal to 2 current measurement units.

AsMils(HoleNegativeTolerance) <= 1.4
Returns all pad and via objects that have a Hole Tolerance (-) property which is less than or equal to 1.4mil.

AsMM(HoleNegativeTolerance) < 0.05
Returns all pad and via objects that have a Hole Tolerance (-) property which is less than 0.05mm.

Note

The Hole Tolerance (-) property is only defined for pad and via objects.

Summary

Returns all pad and via objects whose Hole Tolerance (+) property complies with the Query.

Syntax

HolePositiveTolerance : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(HolePositiveTolerance) : Number – to specify a tolerance in mil.
• AsMM(HolePositiveTolerance) : Number – to specify a tolerance in mm.

Example Usage

HolePositiveTolerance = 4
Returns all pad and via objects that have a Hole Tolerance (+) property which is equal to 4 current measurement units.

HolePositiveTolerance >= 5.08
Returns all pad and via objects that have a Hole Tolerance (+) property which is greater than or equal to 5.08 current measurement units.

AsMils(HolePositiveTolerance) > 4
Returns all pad and via objects that have a Hole Tolerance (+) property which is greater than 4mil.

AsMM(HolePositiveTolerance) Between 0.102 And 0.105
Returns all pad and via objects that have a Hole Tolerance (+) property which is greater than or equal to 0.102mm and less than or equal to 0.105mm.

HolePositiveTolerance <> 2
Returns all pad and via objects that have a Hole Tolerance (+) property which is not equal to 2 current measurement units.

AsMils(HolePositiveTolerance) <= 1.4
Returns all pad and via objects that have a Hole Tolerance (+) property which is less than or equal to 1.4mil.

AsMM(HolePositiveTolerance) < 0.05
Returns all pad and via objects that have a Hole Tolerance (+) property which is less than 0.05mm.

Note

The Hole Tolerance (+) property is only defined for pad and via objects.

Summary

Returns all pad objects whose Hole Rotation property complies with the Query.

Syntax

HoleRotation : Numeric_String
HoleRotation : Number

Example Usage

HoleRotation = '30'
HoleRotation = 30
Returns all pad objects whose Hole Rotation property is 30.000.

HoleRotation <> '45'
HoleRotation <> 45
Returns all objects except pad objects whose Hole Rotation property is 45.000.

Note

The Hole Rotation property is only defined for pad objects.

Summary

Returns all pad and via objects whose Hole Size property complies with the Query.

Syntax

HoleSize : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(HoleSize) : Number – to specify a hole size in mil.
• AsMM(HoleSize) : Number – to specify a hole size in mm.

Example Usage

HoleSize = 16
Returns all pad and via objects that have a Hole Size property which is 16 current measurement units.

HoleSize >= 0.508
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 0.508 current measurement units.

AsMils(HoleSize) Between 12 And 32
Returns all pad and via objects that have a Hole Size property which is greater than or equal to 12mil and less than or equal to 32mil.

AsMM(HoleSize) < 1.016
Returns all pad and via objects that have a Hole Size property which is less than 1.016mm.

Notes

• The Hole Size property is only defined for pad and via objects.
• This function is an alias for the HoleDiameter and Hole functions.

Summary

Returns all pad objects whose Hole Type property complies with the Query.

Syntax

HoleType = HoleType_String
HoleType <> HoleType_String

HoleType_String must be one of the strings from the following list:

• 'Round'
• 'Slot'
• 'Square'

Example Usage

HoleType = 'Square'
Returns all pad objects whose Hole Type property is Square.

HoleType <> 'Slot'
Returns all objects except pad objects whose Hole Type property is Slot.

HoleType = 'Square' || HoleType = 'Slot'
IsPad && HoleType <> 'Round'
Returns all objects except pad objects whose Hole Type property is Round.

Notes

• The Hole Type property is only defined for pad objects.
• The single quote characters (') at the start and end of HoleType_String are mandatory.

Summary

Returns all 3D body objects whose Identifier property complies with the Query.

Syntax

Identifier : String

Example Usage

Identifier = 'RES0402'
Returns all 3D body objects whose Identifier property is RES0402.

Identifier Like 'RES0402*'
Returns all 3D body objects that have a Identifier whose associated string commences with RES0402.

Notes

• The Identifier property is only defined for 3D body objects.
• The single quote characters (') at the start and end of String are mandatory.

Summary

Returns all string objects whose Border Space Type property complies with the Query.

Syntax

InvertedBorderSpaceType = InvertedBorderSpaceType_String
InvertedBorderSpaceType <> InvertedBorderSpaceType_String

InvertedBorderSpaceType_String must be one of the strings from the following list:

• 'Border Margin'
• 'Text Offset'

Example Usage

InvertedBorderSpaceType = 'Border Margin'
Returns all string objects whose Border Space Type property is Border Margin.

InvertedBorderSpaceType <> 'Border Margin'
Returns all objects except string objects whose Border Space Type property is Border Margin.

IsTrueTypeText && InvertedBorderSpaceType <> 'Text Offset'
Returns all string objects whose Border Space Type property is not Text Offset.

Notes

• The Border Space Type property is only defined for string objects.
• The single quote characters (') at the start and end of InvertedBorderSpaceType_String are mandatory.

Summary

Returns all text string (comment, designator, free) objects whose Inverted Rectangle Height property complies with the Query.

Syntax

InvertedRectangleHeight : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(InvertedRectangleHeight) : Number – to specify a height in mil.
• AsMM(InvertedRectangleHeight) : Number – to specify a height in mm.

Example Usage

InvertedRectangleHeight = 30
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is equal to 30 current measurement units.

InvertedRectangleHeight >= 5.08
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is greater than or equal to 5.08 current measurement units.

AsMils(InvertedRectangleHeight) > 40
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is greater than 40mil.

AsMM(InvertedRectangleHeight) Between 6.35 And 8.89
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is greater than or equal to 6.35mm and less than or equal to 8.89mm.

InvertedRectangleHeight <> 55
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is not equal to 55 current measurement units.

AsMils(InvertedRectangleHeight) <= 65
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is less than or equal to 65mil.

AsMM(InvertedRectangleHeight) < 11.43
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Height property which is less than 11.43mm.

Note

The Inverted Rectangle Height property is only defined for text string (comment, designator, free) objects.

Summary

Returns all text string (comment, designator, free) objects whose Inverted Rectangle Width property complies with the Query.

Syntax

InvertedRectangleWidth : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(InvertedRectangleWidth) : Number – to specify a width in mil.
• AsMM(InvertedRectangleWidth) : Number – to specify a width in mm.

Example Usage

InvertedRectangleWidth = 300
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is equal to 300 current measurement units.

InvertedRectangleWidth >= 128
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is greater than or equal to 128 current measurement units.

AsMils(InvertedRectangleWidth) > 400
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is greater than 400mil.

AsMM(InvertedRectangleWidth) Between 6 And 8
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is greater than or equal to 6mm and less than or equal to 8mm.

InvertedRectangleWidth <> 550
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is not equal to 550 current measurement units.

AsMils(InvertedRectangleWidth) <= 650
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is less than or equal to 650mil.

AsMM(InvertedRectangleWidth) < 11.43
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is less than 11.43mm.

Note

The Inverted Rectangle Width property is only defined for text string (comment, designator, free) objects.

Summary

Returns all text string (comment, designator, free) objects whose Inverted Text Justification property complies with the Query.

Syntax

InvertedTextJustification = TextJustification_String
InvertedTextJustification <> TextJustification_String

TextJustification_String must be one of the strings from the following list:

• 'Center'
• 'Center-Above'
• 'Center-Below'
• 'Left-Above'
• 'Left-Below'
• 'Left-Center'
• 'Right-Above'
• 'Right-Below'
• 'Right-Center'

Example Usage

InvertedTextJustification = 'Center'
Returns all text string (comment, designator, free) objects whose Inverted Text Justification property is Center.

InvertedTextJustification <> 'Right-Below'
Returns all objects except text string (comment, designator, free) objects whose Inverted Text Justification property is Right-Below.

Notes

• The single quote characters (') at the start and end of TextJustification_String are mandatory.
• The Inverted Text Justification property is only defined for text string (comment, designator, free) objects.

Summary

Returns all via objects whose IPC 4761 Via Type property complies with the Query.

Syntax

IPC4761ViaType = IPC4761ViaType_String
IPC4761ViaType <> IPC4761ViaType_String

IPC4761ViaType_String must be one of the strings from the following list:

• 'None'
• 'Type 1a'
• 'Type 1b'
• 'Type 2a'
• 'Type 2b'
• 'Type 3a'
• 'Type 3b'
• 'Type 4a'
• 'Type 4b'
• 'Type 5'
• 'Type 6a'
• 'Type 6b'
• 'Type 7'

Example Usage

IPC4761ViaType = 'Type 1a'
Returns all via objects whose IPC 4761 Via Type property is Type 1a.

IPC4761ViaType <> 'Type 1b'
Returns all objects except via objects whose IPC 4761 Via Type property is Type 1b.

Notes

• The IPC 4761 Via Type property is only defined for via objects.
• The single quote characters (') at the start and end of IPC4761ViaType_String are mandatory.

Summary

Returns all pad and via objects that have been marked for use as Assembly Testpoints – having their Assembly Testpoint - Top and/or Assembly Testpoint - Bottom properties enabled.

Syntax

IsAssyTestpoint : Boolean

Example Usage

IsAssyTestpoint
IsAssyTestpoint = True
Returns all pad and via objects being used as Assembly Testpoints.

Not IsAssyTestpoint
IsAssyTestpoint = False
Returns all objects except pad and via objects being used as Assembly Testpoints.

Summary

Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property complies with the Query.

Syntax

IsBold : Boolean_String

Example Usage

IsBold = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is enabled.

IsBold = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is disabled.

Notes

• The Bold property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
• All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.

Summary

Returns all pad and via objects that have been marked for use as Fabrication Testpoints – having their Fabrication Testpoint - Top and/or Fabrication Testpoint - Bottom properties enabled.

Syntax

IsFabTestpoint : Boolean

Example Usage

IsFabTestpoint
IsFabTestpoint = True
Returns all pad and via objects being used as Fabrication Testpoints.

Not IsFabTestpoint
IsFabTestpoint = False
Returns all objects except pad and via objects being used as Fabrication Testpoints.

Summary

Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property complies with the Query.

Syntax

IsItalic : Boolean_String

Example Usage

IsItalic = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is enabled.

IsItalic = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is disabled.

Notes

• The Italic property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
• All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.

Summary

Returns all polygon pour objects whose IsModified property complies with the Query.

Syntax

IsModified : Boolean_String

Example Usage

IsModified = 'True'
Returns all polygon pour objects whose IsModified property is enabled.

IsModified = 'False'
Returns all polygon pour objects whose IsModified property is disabled.

Note

The IsModified property is only defined for polygon pour objects.

Summary

Returns all pad and via objects that have been marked for use as Testpoints, regardless of whether they are Assembly or Fabrication Testpoints – so having any of the following properties enabled:

• Assembly Testpoint - Top
• Assembly Testpoint - Bottom
• Fabrication Testpoint - Top
• Fabrication Testpoint - Bottom

Syntax

IsTestpoint : Boolean

Example Usage

IsTestpoint
IsTestpoint = True
Returns all pad and via objects being used as Testpoints.

Not IsTestpoint
IsTestpoint = False
Returns all objects except pad and via objects being used as Testpoints.

Summary

Returns all text string (comment, designator, free) objects whose Inverted property complies with the Query.

Syntax

IsTextInverted : Boolean_String

Example Usage

IsTextInverted = 'True'
Returns all text string (comment, designator, free) objects whose Inverted property is enabled.

IsTextInverted = 'False'
Returns all text string (comment, designator, free) objects whose Inverted property is disabled.

Note

The Inverted property is only defined for text string (comment, designator, free) objects.

Summary

Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Syntax

Keepout : Boolean

Example Usage

Keepout
Keepout = True
Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Not Keepout
Keepout = False
Returns all objects except Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.

Summary

Returns all keepout objects whose Keepout Restriction - Copper property complies with the Query.

Syntax

KeepoutRestrictionsCopper : Boolean_String

Example Usage

KeepoutRestrictionsCopper = 'True'
Returns all keepout objects whose Keepout Restriction - Copper property is enabled.

KeepoutRestrictionsCopper = 'False'
Returns all keepout objects whose Keepout Restriction - Copper property is disabled.

Notes

• The Keepout Restriction - Copper property is only defined for keepout objects (arcs, fills, solid regions, tracks).
• The Keepout Restriction - Copper property (as reflected in the List panels) corresponds to the Copper option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - SMD Pad property complies with the Query.

Syntax

KeepoutRestrictionsSMDPad : Boolean_String

Example Usage

KeepoutRestrictionsSMDPad = 'True'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is enabled.

KeepoutRestrictionsSMDPad = 'False'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is disabled.

Notes

• The Keepout Restriction - SMD Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
• The Keepout Restriction - SMD Pad property (as reflected in the List panels) corresponds to the SMD Pad option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - TH Pad property complies with the Query.

Syntax

KeepoutRestrictionsTHPad : Boolean_String

Example Usage

KeepoutRestrictionsTHPad = 'True'
Returns all keepout objects whose Keepout Restriction - TH Pad property is enabled.

KeepoutRestrictionsTHPad = 'False'
Returns all keepout objects whose Keepout Restriction - TH Pad property is disabled.

Notes

• The Keepout Restriction - TH Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
• The Keepout Restriction - TH Pad property (as reflected in the List panels) corresponds to the TH Pad option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - Track property complies with the Query.

Syntax

KeepoutRestrictionsTrack : Boolean_String

Example Usage

KeepoutRestrictionsTrack = 'True'
Returns all keepout objects whose Keepout Restriction - Track property is enabled.

KeepoutRestrictionsTrack = 'False'
Returns all keepout objects whose Keepout Restriction - Track property is disabled.

Notes

• The Keepout Restriction - Track property is only defined for keepout objects (arcs, fills, solid regions, tracks).
• The Keepout Restriction - Track property (as reflected in the List panels) corresponds to the Track option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - Via property complies with the Query.

Syntax

KeepoutRestrictionsVia : Boolean_String

Example Usage

KeepoutRestrictionsVia = 'True'
Returns all keepout objects whose Keepout Restriction - Via property is enabled.

KeepoutRestrictionsVia = 'False'
Returns all keepout objects whose Keepout Restriction - Via property is disabled.

Notes

• The Keepout Restriction - Via property is only defined for keepout objects (arcs, fills, solid regions, tracks).
• The Keepout Restriction - Via property (as reflected in the List panels) corresponds to the Via option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all objects whose Object Kind property complies with the Query.

Syntax

Kind = ObjectKind_String
Kind <> ObjectKind_String

ObjectKind_String specifies the object kind and must be one of the following strings:

• Design Objects – '3D Body', 'Arc', 'Angular Dimension', 'Baseline Dimension', 'Center Dimension', 'Component', 'Coordinate', 'Datum Dimension', 'Design View', 'Drill Table', 'Embedded Board', 'Fill', 'Layer Stack Table', 'Leader Dimension', 'Linear Diameter Dimension', 'Linear Dimension', 'OLE Object', 'Original Dimension', 'Pad', 'Poly', 'Radial Diameter Dimension', 'Radial Dimension', 'Region', 'Split Plane', 'Text', 'Track', 'Via'.
• Design Rules – the following strings are used to target the various rule types. The rule type, as it appears in the PCB Rules and Constraints Editor dialog, is shown in brackets after the string:
  • 'Acute Angle Rule'(Acute Angle)
  • 'Bare-board Fabrication Test Point Style Rule'(Fabrication Testpoint Style)
  • 'Bare-board Fabrication Test Point Usage Rule'(Fabrication Testpoint Usage)
  • 'Board Outline Clearance'(Board Outline Clearance)
  • 'Broken Nets Rule'(Un-Routed Net)
  • 'Clearance Rule'(Clearance)
  • 'Component Clearance Rule'(Component Clearance)
  • 'Component Rotations Rule'(Component Orientations)
  • 'Confinement Constraint Rule'(Room Definition)
  • 'Daisy Chain Stub Length Rule'(Daisy Chain Stub Length)
  • 'Differential Pairs Rule'(Differential Pairs Routing)
  • 'Fanout Control Rule'(Fanout Control)
  • 'Flight Time Falling Edge Rule'(Flight Time - Falling Edge)
  • 'Flight Time Rising Edge Rule'(Flight Time - Rising Edge)
  • 'Hole To Hole Clearance Rule'(Hole To Hole Clearance)
  • 'In-circuit Assembly Test Point Style Rule'(Assembly Testpoint Style)
  • 'In-circuit Assembly Test Point Usage Rule'(Assembly Testpoint Usage)
  • 'Layer Pair Rule'(Layer Pairs)
  • 'Matched Lengths Rule'(Matched Lengths)
  • 'Max Min Height Rule'(Height)
  • 'Max Min Hole Size Rule'(Hole Size)
  • 'Max Min Impedance Rule'(Impedance)
  • 'Max Min Length Rule'(Length)
  • 'Max Min Width Rule'(Width)
  • 'Max Slope Falling Edge Rule'(Slope - Falling Edge)
  • 'Max Slope Rising Edge Rule'(Slope - Rising Edge)
  • 'Max Via Stub Length (BackDrilling rule)' (Max Via Stub Length (Back Drilling))
  • 'Maximum Via Count Rule'(Maximum Via Count)
  • 'Minimum Annular Ring Rule'(Minimum Annular Ring)
  • 'Minimum Solder Mask Sliver Rule'(Minimum Solder Mask Sliver)
  • 'Modified Polygon'(Modified Polygon)
  • 'Net Antennae Rule'(Net Antennae)
  • 'Nets To Ignore Rule'(Nets to Ignore)
  • 'Overshoot Falling Edge Rule'(Overshoot - Falling Edge)
  • 'Overshoot Rising Edge Rule'(Overshoot - Rising Edge)
  • 'Parallel Segment Rule'(Parallel Segment)
  • 'Paste Mask Expansion Rule'(Paste Mask Expansion)
  • 'Permitted Layers Rule'(Permitted Layers)
  • 'Polygon Connect Style Rule'(Polygon Connect Style)
  • 'Power Plane Clearance Rule'(Power Plane Clearance)
  • 'Power Plane Connect Style Rule'(Power Plane Connect Style)
  • 'Routing Corner Style Rule'(Routing Corners)
  • 'Routing Layers Rule'(Routing Layers)
  • 'Routing Priority Rule'(Routing Priority)
  • 'Routing Topology Rule'(Routing Topology)
  • 'Routing Via Style Rule'(Routing Via Style)
  • 'Short Circuit Rule'(Short-Circuit)
  • 'Signal Base Value Rule'(Signal Base Value)
  • 'Signal Stimulus Rule'(Signal Stimulus)
  • 'Signal Top Value Rule'(Signal Top Value)
  • 'Silk To Silk Clearance Rule'(Silk To Silk Clearance)
  • 'Silk To Solder Mask Clearance Rule'(Silk To Solder Mask Clearance)
  • 'SMD Entry'(SMD Entry)
  • 'SMD Neck Down Rule'(SMD Neck-Down)
  • 'SMD To Corner Rule'(SMD To Corner)
  • 'SMD To Plane Rule'(SMD To Plane)
  • 'Solder Mask Expansion Rule'(Solder Mask Expansion)
  • 'Supply Nets Rule'(Supply Nets)
  • 'Unconnected Pin Rule'(Un-Connected Pin)
  • 'Undershoot Falling Edge Rule'(Undershoot - Falling Edge)
  • 'Undershoot Rising Edge Rule'(Undershoot - Rising Edge)
  • 'Vias Under SMD Rule'(Vias Under SMD)
• Others – 'Board Region', 'Class', 'Differential Pair', 'Net', 'Violation'.

Example Usage

Kind = 'Class'
Returns all class objects.

Kind <> 'Via'
Returns all objects except via objects.

Notes

• The single quote characters (') at the start and end of ObjectKind_String are mandatory.
• This function is an alias for the ObjectKind function.

Summary

Returns all objects whose Layer property complies with the Query.

Syntax

L = Layer_String
L <> Layer_String

Example Usage

L = 'MultiLayer'
Returns all objects on the Multi-Layer.

L <> 'KeepOutLayer'
Returns all objects except for those on the Keep-Out layer.

Notes

• The single quote characters (') at the start and end of Layer_String are mandatory.
• This function is an alias for the Layer function.

Summary

Returns all objects whose Layer property complies with the Query.

Syntax

Layer = Layer_String
Layer <> Layer_String

Example Usage

Layer = 'MultiLayer'
Returns all objects on the Multi-Layer.

Layer <> 'KeepOutLayer'
Returns all objects except for those on the Keep-Out layer.

Notes

• The single quote characters (') at the start and end of Layer_String are mandatory.
• This function is an alias for the L function.

Summary

Returns all leader dimension objects whose Dot property complies with the Query.

Syntax

LeaderDimensionDot : Boolean_String

Example Usage

LeaderDimensionDot = 'True'
Returns all leader dimension objects whose Dot property is enabled.

LeaderDimensionDot = 'False'
Returns all leader dimension objects whose Dot property is disabled.

Notes

• The Dot property is only defined for leader dimension objects.
• The child objects of leader dimension objects returned by the Query are not returned.

Summary

Returns leader dimension objects whose Dot Size property complies with the Query.

Syntax

LeaderDimensionDotSize : Number

Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).

A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:

• AsMils(LeaderDimensionDotSize) : Number – to specify a size in mil.
• AsMM(LeaderDimensionDotSize) : Number – to specify a size in mm.

Example Usage

LeaderDimensionDotSize = 40
Returns all leader dimension objects that have a Dot Size property which is 40 current measurement units.

LeaderDimensionDotSize >= 1.143
Returns all leader dimension objects that have a Dot Size property which is greater than or equal to 1.143 current measurement units.

AsMils(LeaderDimensionDotSize) Between 30 And 50
Returns all leader dimension objects that have a Dot Size property which is greater than or equal to 30mil and less than or equal to 50mil.

AsMM(LeaderDimensionDotSize) < 0.889
Returns all leader dimension objects that have a Dot Size property which is less than 0.889mm.

Notes

• The Dot Size property is only defined for leader dimension objects.
• The child objects of leader dimension objects returned by the Query are not returned.

Summary

Returns all leader dimension objects whose Leader Shape property complies with the Query.

Syntax