PCB Layout Query Functions in Altium NEXUS | 5 User Manual

Created: December 27, 2021 | Updated: September 1, 2022

Applies to altium-nexus version: 5

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

Contents

Attribute Checks
Fields
Layer Checks
Membership Checks
Object Type Checks
Parameters

All Contents

Parent page: Working with the Query Language

PCB query functions shown in the Query Helper dialog

Underlying Altium NEXUS's schematic and PCB editors is a powerful query engine. By entering queries into this engine you can logically scope precisely those objects you require.

A query is a string you enter using specific keywords and syntax, which will return the targeted objects. There are many keywords available, allowing you to target objects by their type, their properties, or both.

For a detailed overview of using the query language, see Working with the Query Language.

This reference page details the query language keywords available in PCB and PCB library documents in Altium NEXUS. For help on a specific query keyword, use the following collapsible sections or highlight (or click inside) any given keyword - in the Query Helper, a Filter panel, or the Query field of a PCB design rule - and press F1 to access its section right away.

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

CompCenterOfPadsX

Summary

Returns component objects when the X-Coordinate of the centroid of their pads complies with the Query.

Syntax

CompCenterOfPadsX : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterOfPadsX = 1200
Returns all component objects when the X-Coordinate of the centroid of their pads is equal to 1200mil.

CompCenterOfPadsX >= 1500
Returns all component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 1500mil.

CompCenterOfPadsX Between 1000 And 1400
Returns all component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterOfPadsX < 800
Returns all objects except component objects when the X-Coordinate of the centroid of their pads is greater than, or equal to, 800mil.

Note

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

CompCenterOfPadsY

Summary

Returns component objects when the Y-Coordinate of the centroid of their pads complies with the Query.

Syntax

CompCenterOfPadsY : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterOfPadsY = 1200
Returns all component objects when the Y-Coordinate of the centroid of their pads is equal to 1200mil.

CompCenterOfPadsY >= 1500
Returns all component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 1500mil.

CompCenterOfPadsY Between 1000 And 1400
Returns all component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterOfPadsY < 800
Returns all objects except component objects when the Y-Coordinate of the centroid of their pads is greater than, or equal to, 800mil.

Note

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

CompCenterX

Summary

Returns component objects when the X-Coordinate of the centroid of all of their child objects complies with the Query.

Syntax

CompCenterX : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterX = 1200
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is equal to 1200mil.

CompCenterX >= 1500
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1500mil.

CompCenterX Between 1000 And 1400
Returns all component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterX < 800
Returns all objects except component objects when the X-Coordinate of the centroid of all of their child objects is greater than, or equal to, 800mil.

Note

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

CompCenterY

Summary

Returns component objects when the Y-Coordinate of the centroid of all of their child objects complies with the Query.

Syntax

CompCenterY : Number

The entered coordinate is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch).

Example Usage

CompCenterY = 1200
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is equal to 1200mil.

CompCenterY >= 1500
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1500mil.

CompCenterY Between 1000 And 1400
Returns all component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 1000mil, and less than, or equal to, 1400mil.

CompCenterY < 800
Returns all objects except component objects when the Y-Coordinate of the centroid of all of their child objects is greater than, or equal to, 800mil.

Note

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

CompPinCount

Summary

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

Syntax

CompPinCount : Number

Example Usage

CompPinCount = 10
Returns all component objects whose number of pads is equal to 10.

CompPinCount Between 20 And 30
Returns all component objects whose number of pads is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount <= 8
Returns all objects except component objects whose number of pads is greater than 8.

Note

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

CompPinCount_Bottom

Summary

Returns component objects whose number of pads on the Bottom Layer complies with the Query.

Syntax

CompPinCount_Bottom : Number

Example Usage

CompPinCount_Bottom = 10
Returns all component objects whose number of pads on the Bottom Layer is equal to 10.

CompPinCount_Bottom Between 20 And 30
Returns all component objects whose number of pads on the Bottom Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Bottom <= 8
Returns all objects except component objects whose number of pads on the Bottom Layer is greater than 8.

Note

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

CompPinCount_Internal

Summary

Returns component objects whose number of pads on the internal signal layers (Signal Layer 1-30) complies with the Query.

Syntax

CompPinCount_Internal : Number

Example Usage

CompPinCount_Internal = 10
Returns all component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is equal to 10.

CompPinCount_Internal Between 20 And 30
Returns all component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Internal <= 8
Returns all objects except component objects whose number of pads on the internal signal layers (Signal Layer 1-30) is greater than 8.

Note

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

CompPinCount_Surface

Summary

Returns component objects whose number of pads on the Top and Bottom signal layers complies with the Query.

Syntax

CompPinCount_Surface : Number

Example Usage

CompPinCount_Surface = 10
Returns all component objects whose number of pads on the Top and Bottom signal layers is equal to 10.

CompPinCount_Surface Between 20 And 30
Returns all component objects whose number of pads on the Top and Bottom signal layers is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Surface <= 8
Returns all objects except component objects whose number of pads on the Top and Bottom signal layers is greater than 8.

Note

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

CompPinCount_ThruHole

Summary

Returns component objects whose number of pads on the Multi-Layer complies with the Query.

Syntax

CompPinCount_ThruHole : Number

Example Usage

CompPinCount_ThruHole = 10
Returns all component objects whose number of pads on the Multi-Layer is equal to 10.

CompPinCount_ThruHole Between 20 And 30
Returns all component objects whose number of pads on the Multi-Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_ThruHole <= 8
Returns all objects except component objects whose number of pads on the Multi-Layer is greater than 8.

Note

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

CompPinCount_Top

Summary

Returns component objects whose number of pads on the Top Layer complies with the Query.

Syntax

CompPinCount_Top : Number

Example Usage

CompPinCount_Top = 10
Returns all component objects whose number of pads on the Top Layer is equal to 10.

CompPinCount_Top Between 20 And 30
Returns all component objects whose number of pads on the Top Layer is greater than, or equal to, 20, and less than, or equal to, 30.

CompPinCount_Top <= 8
Returns all objects except component objects whose number of pads on the Top Layer is greater than 8.

Note

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

HasViolations

Summary

Returns objects whose violation state is True. This occurs when a violation of one or more design rules has been detected that involves the object concerned.

Syntax

HasViolations : Boolean/Boolean_String

Example Usage

HasViolations HasViolations = True HasViolations = 'True'
Returns all objects that are currently in violation of defined design rules.

Not HasViolations HasViolations = False HasViolations = 'False'
Returns all objects except objects that are currently in violation of defined design rules.

Summary

Returns the object(s) specified by the Query.

Syntax

Id = ObjectIdentifying_String

ObjectIdentifying_String must be one of the strings that is listed within the various PCB Object Lists of the Query Helper dialog, and it needs to be preceded and followed by single quote characters ('). Which strings are actually listed depends on the objects that currently exist on the PCB/PCBLIB document being edited. The following object lists are presented:

Channel Classes
Coordinates
Components
Component Classes
Differential Pair
Differential Pair Classes
Dimensions
From-To
From-To Classes
Layer Classes
Net Classes
Nets
Pad Classes
Pads
Polygon Classes
Polygons
Rules
Text
Violations

Although a string is listed for each of these objects, these strings do not necessarily identify one particular object. As one example, the string provided for each design rule object consists of the characters 'Rule0mil,0mil', so specifying that string will result in all of the Rule objects being returned.

Example Usage

Id = 'GND'
Returns the Net object whose Net property is GND.

Id = 'C3-1'
Returns the pad object(s) whose full Name property is C3-1.

Id = 'Text[3510mil,3800mil]'
Returns the text object(s) whose point is at 3510mil,3800mil.

Id = 'D3'
Returns the component object(s) whose Designator property is D3.

Id = 'Dimension[4800mil,3800mil]'
Returns the dimension object(s) whose insertion point is at 4800mil,3800mil.

Id = 'Coordinate[3500mil,3800mil]'
Returns the coordinate object(s) whose insertion point is at 3500mil,3800mil.

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

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

Syntax

IsCustomPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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

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

Note

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

IsCustomShapePad

Summary

Returns all pad objects with a custom pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is custom.

Syntax

IsCustomShapePad : Boolean/Boolean_String

Example Usage

IsCustomShapePad IsCustomShapePad = True IsCustomShapePad = 'True'
Returns all pad objects with a custom pad shape.

Not IsCustomShapePad IsCustomShapePad = False IsCustomShapePad = 'False'
Returns all objects except pad objects with a custom pad shape.

IsDIP

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.

IsEdgeConnector

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.

Note

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

IsHorizontal

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.

IsJumperComponent

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.

IsKeepOut

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.

IsLCC

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.

IsLinkedToAnyPadViaLibrary

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.

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

IsNetSelected

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).

To first select a particular net (or nets), apply a filter with Query IsNet, then select those nets required in the List panel.

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.

IsNetTieComponent

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.

IsNoBOMComponent

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.

IsOctagonalPad

Summary

Returns all pad objects with an octagonal pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is octagonal.

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.

IsOctagonalPadShapeOnLayer

Summary

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

Syntax

IsOctagonalPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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.

IsOvalPad

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.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is oval.

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.

IsOvalPadShapeOnLayer

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

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

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.

IsPGA

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.

IsRectangularPad

Summary

Returns all pad objects with a rectangular pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is rectangular.

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.

IsRectangularPadShapeOnLayer

Summary

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

Syntax

IsRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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.

IsRoundedRectangularPad

Summary

Returns all pad objects with a rounded rectangular pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is rounded rectangular.

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.

IsRoundedRectangularPadShapeOnLayer

Summary

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

Syntax

IsRoundedRectangularPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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.

IsRoundPad

Summary

Returns all pad objects with a round pad shape.

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is round.

In addition to being Round in shape, the X-Size and Y-Size properties must be set to be equal, otherwise, the result will be an oval 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.

IsRoundPadShapeOnLayer

Summary

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

In addition to being Round in shape, the X-Size and Y-Size properties must be set to be equal, otherwise, the result will be an oval pad shape.

Syntax

IsRoundPadShapeOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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.

IsSelected

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.

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

IsSMTPin

Summary

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

Surface mount pads are located on signal layers, and not the Multi-Layer.

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.

IsSOIC

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.

IsSquarePad

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

Includes Top-Middle-Bottom, and Full Stack pads where the pad shape on at least one layer is square.

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.

IsSquarePadShapeOnLayer

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

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

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

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

Note

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

IsStandardComponent

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.

IsSubnetJumper

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.

IsThruComponent

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.

IsThruPin

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.

Thru-Hole pads are located on the Multi-Layer.

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.

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.

NetLength

Summary

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

The length of each track is the (Pythagorean) distance between its end points, and is equal to SQRT(SQR(X1 - X2) + SQR(Y1 - Y2)), where X1, Y1 are the coordinates of one end of the track, and X2, Y2 are the coordinates of its other end. The length of each arc is the product of its Radius and the difference between its End Angle and Start Angle when that difference is measured in units of radians (180 degrees = pi radians).

Syntax

NetLength : Number

The entered length is always in units of mils, irrespective of the measurement unit chosen for the board (1 mil = 0.001 inch).

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.

NetPinCount

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.

NetViaCount

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.

RowCount

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.

TraceCopperHeight

Summary

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

The Copper Thickness for a signal layer is defined within the Layer Stack Manager (Design » Layer Stack Manager).

Arc, fill, and track objects on the Multi-Layer are not returned. Because different signal layers can have different Copper Thickness properties, a Copper Thickness property for the Multi-Layer is not always meaningful.

Syntax

TraceCopperHeight : Number

The entered thickness is always in units of mils, regardless of the measurement unit chosen for the board (1 mil = 0.001 inch).

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.

TraceHeight

Summary

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

The Copper Thickness for a signal layer is defined within the Layer Stack Manager (Design » Layer Stack Manager).

Syntax

TraceHeight : Number

The entered thickness is always in units of mils regardless of the measurement unit chosen for the board (1 mil = 0.001 inch).

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.

TraceLength

Summary

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

The length of each track is the (Pythagorean) distance between its endpoints and is equal to SQRT(SQR(X1 - X2) + SQR(Y1 - Y2)), where X1, Y1 are the coordinates of one end of the track, and X2, Y2 are the coordinates of its other end. The length of each arc is the product of its Radius and the difference between its End Angle and Start Angle, when that difference is measured in units of radians. (180 degrees = pi radians.)

Syntax

TraceLength : Number

The entered length is always in units of mils, irrespective of the measurement unit chosen for the board. (1 mil = 0.001 inch). To target an object using metric measurements, use the AsMM query keyword, for example, AsMM(Width) < 1.5 or, AsMM(Width) Between 1 And 1.2. Learn more about AsMM.

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.

Note - due to an issue in the software, to correctly detect a TraceLength using the AsMM keyword or the AsMils keyword, the board units must be set to imperial before running the query.

Fields

ArcRadius

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

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.

AutoAssignedName

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.

AutoPosition

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.

BarCodeFontName

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.

Font names are case sensitive. So for example use 'Arial', and not 'arial'.

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').

BarCodeFullHeight

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).

BarCodeFullWidth

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).

BarCodeInverted

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').

BarCodeMinWidth

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).

BarCodeRenderMode

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').

BarCodeShowText

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').

BarCodeType

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').

BarCodeXMargin

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).

BarCodeYMargin

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).

BodyColor3D

Summary

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

Syntax

BodyColor3D : Numeric_String BodyColor3D : Number

The BodyColor3D keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all other objects (which do not have a Body 3-D Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as BodyColor3D <> '', or BodyColor3D > ''. Alternatively, use entries specifically targeting 3D body objects, such as IsComponentBody.

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.

BodyColor3DOpacity

Summary

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

Syntax

BodyColor3DOpacity : Numeric_String BodyColor3DOpacity : Number

Numeric_String/Number can be from 0.000 (0% opacity) to 1.000 (100% opacity).

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.

BodyColor3DOverride

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.

BodyProjection

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.

CappingMaterial

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.

CappingSide

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.

CavityHeight

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.

ChamferFilletSize

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.

ChannelOffset

Summary

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

Syntax

ChannelOffset : Numeric_String ChannelOffset : Number

The ChannelOffset keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all other non-component objects (which do not have a Channel Offset property) have been totally excluded by one or more preceding entries within the Query expression. Use entries in the expression such as ChannelOffset <> '', or ChannelOffset > ''. Alternatively, use entries specifically targeting component objects, such as ObjectKind = 'Component', or IsComponent.

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.

ClassType

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.

Color

Summary

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

Syntax

Color : Numeric_String Color : Number

The Color keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all non-Net objects (which do not have a Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as Color <> '', or Color > ''. Alternatively, use entries specifically targeting net objects, such as ObjectKind = 'Net', or IsNet.

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.

Comment

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.

Component

Summary

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.

CoordinateDimensionLineWidth

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.

CoordinateDimensionSize

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.

CoordinateDimensionUnitStyle

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.

CornerMode

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.

CoveringMaterial

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.

CoveringSide

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.

DimensionArrowGap

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.

DimensionArrowLength

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.

DimensionArrowLineWidth

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.

DimensionArrowPosition

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.

DimensionArrowSize

Summary

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.

DimensionExtensionLineWidth

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.

DimensionExtensionOffset

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.

DimensionExtensionPickGap

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.

DimensionTextFont

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.

DimensionTextFormat

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.

DimensionTextGap

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.

DimensionTextHeight

Summary

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.

DimensionTextLineWidth

Summary

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.

DimensionTextPosition

Summary

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.

DimensionTextPrecision

Summary

Syntax

DimensionTextPrecision : Numeric_String DimensionTextPrecision : Number

The DimensionTextPrecision keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all other objects (which do not have a Dimension Precision property) have been totally excluded by one or more preceding entries within the Query expression. Use entries in the expression such as DimensionTextPrecision <> '', or DimensionTextPrecision > ''. Alternatively, use entries specifically targeting dimension objects, such as IsDimension.

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.

DimensionTextPrefix

Summary

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.

DimensionTextSuffix

Summary

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.

DimensionTextUnit

Summary

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.

DrillPair

Summary

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

Syntax

DrillPair = 'Start Layer - Stop Layer'

Where Start Layer and Stop Layer are the names given to those layers in the Layer Stack Manager. Learn more about Defining the Layer Stack.

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.

DrillType

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.

EmbeddedBoard_ColCount

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.

EmbeddedBoard_ColumnSpacing

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.

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.

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.

FillingSide

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.

FontName

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.

Font names are case sensitive. So for example use 'Arial', and not 'arial'.

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.

Footprint

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.

FromToPad1

Summary

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

While from-to objects will be returned in the PCB List panel, in order to see these in the workspace, you will need to apply the filter query after placing the PCB panel into From-To Editor mode.

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.

FromToPad2

Summary

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

Syntax

FromToPad2 : PadName_String

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.

Height

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.

Hide

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.

HideJumpers

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.

Hole

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.

HoleDiameter

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.

HoleNegativeTolerance

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.

HolePositiveTolerance

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.

HoleRotation

Summary

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

Syntax

HoleRotation : Numeric_String HoleRotation : Number

Numeric_String/Number is a value for the rotation of the pad hole, in Degrees.

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.

HoleSize

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.

HoleType

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.

Identifier

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.

InvertedBorderSpaceType

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.

InvertedRectangleHeight

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.

InvertedRectangleWidth

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.

InvertedTextJustification

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.

IPC4761ViaType

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.

IsAssyTestpoint

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.

IsBold

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.

IsFabTestpoint

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.

IsItalic

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.

IsModified

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.

IsTestpoint

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.

IsTextInverted

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.

Keepout

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.

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.

Kind

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

Layer_String is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

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.

Layer

Summary

Returns all objects whose Layer property complies with the Query.

Syntax

Layer = Layer_String
Layer <> Layer_String

Layer_String is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

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.

LeaderDimensionDot

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.

LeaderDimensionDotSize

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.

LeaderDimensionShape

Summary

Returns all leader dimension objects whose Leader Shape property complies with the Query.

Syntax

LeaderDimensionShape = LeaderShape_String
LeaderDimensionShape <> LeaderShape_String

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

'None'
'Round'
'Square'

Example Usage

LeaderDimensionShape = 'Round'
Returns all leader dimension objects whose Leader Shape property is Round.

LeaderDimensionShape <> 'Square'
Returns all objects except leader dimension objects whose Leader Shape property is Square.

Notes

The Leader Shape property is only defined for leader dimension objects.
The single quote characters (') at the start and end of LeaderShape_String are mandatory.
The child objects of leader dimension objects returned by the Query are not returned.

Locked

Summary

Returns all objects whose Locked property complies with the Query.

Syntax

Locked : Boolean

Example Usage

Locked
Locked = True
Returns all objects whose Locked property is enabled.

Not Locked
Locked = False
Returns all objects except those whose Locked property is enabled.

LockPrimitives

Summary

Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property complies with the Query.

Syntax

LockPrimitives : Boolean_String

Example Usage

LockPrimitives = 'True'
Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property is enabled.

LockPrimitives = 'False'
Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property is disabled.

Notes

The Lock Primitives property is only defined for component, coordinate, dimension, and polygon pour objects.
The child objects of component, coordinate, dimension, and polygon pour objects returned by the Query are not returned.

Mirror

Summary

Returns all string objects whose Mirror property complies with the Query.

Syntax

Mirror : Boolean_String

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

Example Usage

Mirror = 'True'
Returns all string objects whose Mirror property is enabled.

Mirror = 'False'
Returns all string objects whose Mirror property is disabled.

Mirror <> 'True'
Not (Mirror = 'True')
Returns all objects except string objects whose Mirror property is enabled.

Mirror <> 'False'
Not (Mirror = 'False')
Returns all objects except string objects whose Mirror property is disabled.

Note

The Mirror property is only defined for string objects.

ModelCylinderHeight

Summary

Returns all 3D body objects whose Model Height (Cylinder) property complies with the Query.

Syntax

ModelCylinderHeight : 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(ModelCylinderHeight) : Number – to specify a height in mil.
AsMM(ModelCylinderHeight) : Number – to specify a height in mm.

Example Usage

ModelCylinderHeight = 300
Returns all 3D body objects that have a Model Height (Cylinder) property which is equal to 300 current measurement units.

ModelCylinderHeight >= 500
Returns all 3D body objects that have a Model Height (Cylinder) property which is greater than or equal to 500 current measurement units.

AsMils(ModelCylinderHeight) > 400
Returns all 3D body objects that have a Model Height (Cylinder) property which is greater than 400mil.

AsMM(ModelCylinderHeight) Between 15 And 22
Returns all 3D body objects that have a Model Height (Cylinder) property which is greater than or equal to 15mm and less than or equal to 22mm.

ModelCylinderHeight <> 550
Returns all 3D body objects that have a Model Height (Cylinder) property which is not equal to 550 current measurement units.

AsMils(ModelCylinderHeight) <= 650
Returns all 3D body objects that have a Model Height (Cylinder) property which is less than or equal to 650mil.

AsMM(ModelCylinderHeight) < 11.43
Returns all 3D body objects that have a Model Height (Cylinder) property which is less than 11.43mm.

Note

The Model Height (Cylinder) property is only defined for 3D body objects.

ModelCylinderSphereRadius

Summary

Returns all 3D body objects whose Model Radius (Cylinder/Sphere) property complies with the Query.

Syntax

ModelCylinderSphereRadius : 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(ModelCylinderSphereRadius) : Number – to specify a radius in mil.
AsMM(ModelCylinderSphereRadius) : Number – to specify a radius in mm.

Example Usage

ModelCylinderSphereRadius = 30
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is equal to 30 current measurement units.

ModelCylinderSphereRadius >= 50
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is greater than or equal to 50 current measurement units.

ModelType = ModelType_String
ModelType <> ModelType_String

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

'Cylinder'
'Extruded'
'Generic Model'
'Sphere'

Example Usage

ModelType = 'Extruded'
Returns all 3D body objects whose Model Type property is Extruded.

ModelType <> 'Cylinder'
Returns all objects except 3D body objects whose Model Type property is Cylinder.

Notes

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

ModelZ

Summary

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

Syntax

ModelZ : 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(ModelZ) : Number – to specify a height in mil.
AsMM(ModelZ) : Number – to specify a height in mm.

Example Usage

ModelZ = 30
Returns all 3D body objects that have a Model Z property which is equal to 30 current measurement units.

ModelZ >= 5.08
Returns all 3D body objects that have a Model Z property which is greater than or equal to 5.08 current measurement units.

AsMils(ModelZ) > 40
Returns all 3D body objects that have a Model Z property which is greater than 40mil.

AsMM(ModelZ) Between 0.35 And 0.89
Returns all 3D body objects that have a Model Z property which is greater than or equal to 0.35mm and less than or equal to 0.89mm.

ModelZ <> 55
Returns all 3D body objects that have a Model Z property which is not equal to 55 current measurement units.

AsMils(ModelZ) <= 65
Returns all 3D body objects that have a Model Z property which is less than or equal to 65mil.

AsMM(ModelZ) < 0.43
Returns all 3D body objects that have a Model Z property which is less than 0.43mm.

Notes

The Model Z property is only defined for 3D body objects.
The Model Z property corresponds to the Standoff Height field, when viewing the properties for a selected 3D body on the Properties panel.

Summary

Returns arc, fill, pad, track, via, region, polygon pour, and split-plane objects whose Net property complies with the Query.

Syntax

N : String

Example Usage

N = 'GND'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property of GND.

N Like 'G*'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property whose associated string commences with G.

Notes

The Net property is only defined for arc, fill, pad, track, via, region, polygon pour, and split-plane objects.
The parent net object (whose Name property matches the net specified, and which is a parent object of the returned objects) is not returned.
This function is an alias for the Net function.

Name

Summary

Returns class, component, design rule, net, pad, and polygon pour objects whose Name property complies with the Query.

Syntax

Name : String

Example Usage

Name = '<All Components>'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property of <All Components>.

Name = 'U4-1'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property of U4-1.

Name Like 'R7*'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property whose associated string commences with R7.

Notes

The Name property is only defined for class, component, design rule, net, pad, and polygon pour objects.
In the case of pad objects, a full Name property has to be specified; this consists of an initial sub-string which specifies the Name property of the pad's parent component, followed by a '-' character, followed by another sub-string which specifies the Name property of the pad itself. Pads which are of a 'free' nature are identified by an initial sub-string of 'Free-', followed by the sub-string that specifies the pad's own Name property.

NegativeNet

Summary

Returns all differential pair objects whose Negative Net property complies with the Query.

Syntax

NegativeNet : String

Example Usage

NegativeNet = 'D_N'
Returns all differential pair objects whose Negative Net property is D_N.

NegativeNet Like '*RX1_N'
Returns all differential pair objects whose Negative Net property ends with RX1_N.

Notes

The Negative Net property is only defined for differential pair objects.
The child objects of differential pair objects returned by the Query are not returned.

Net

Summary

Returns arc, fill, pad, track, via, region, polygon pour, and split-plane objects whose Net property complies with the Query.

Syntax

Net : String

Example Usage

Net = 'GND'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property of GND.

Net Like 'G*'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property whose associated string commences with G.

Notes

The Net property is only defined for arc, fill, pad, track, via, region, polygon pour, and split-plane objects.
The parent net object (whose Name property matches the net specified, and which is a parent object of the returned objects) is not returned.
This function is an alias for the N function.

ObjectKind

Summary

Returns all objects whose Object Kind property complies with the Query.

Syntax

ObjectKind = ObjectKind_String
ObjectKind <> 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', 'Internal Plane', 'Net', 'Violation'.

Example Usage

ObjectKind = 'Class'
Returns all class objects.

ObjectKind <> '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 Kind function.

OptimalVoidRotation

Summary

Returns all polygon objects whose Optimal Void Rotation property complies with the Query.

Syntax

OptimalVoidRotation : Boolean

Example Usage

OptimalVoidRotation = 'True'
Returns all polygon objects whose Optimal Void Rotation property is True.

OptimalVoidRotation = 'False'
Returns all objects except component polygon objects whose Optimal Void Rotation property is False.

Note

The Optimal Void Rotation property is only defined for polygon objects.

OverallHeight

Summary

Returns all extruded 3D body objects whose Model Overall Height (Extruded) property complies with the Query.

Syntax

OverallHeight : 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(OverallHeight) : Number – to specify a height in mil.
AsMM(OverallHeight) : Number – to specify a height in mm.

Example Usage

OverallHeight = 100
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is equal to 100 current measurement units.

OverallHeight >= 4.064
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is greater than or equal to 4.064 current measurement units.

AsMils(OverallHeight) > 80
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is greater than 80mil.

AsMM(OverallHeight) Between 1.524 And 3.81
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is greater than or equal to 1.524mm and less than or equal to 3.81mm.

OverallHeight <> 50
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is not equal to 50 current measurement units.

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

Example Usage

Pad_PinLength = 4
Returns all pad objects that have a Pin/Pkg Length property which is equal to 4 current measurement units.

Pad_PinLength >= 5.08
Returns all pad objects that have a Pin/Pkg Length property which is greater than or equal to 5.08 current measurement units.

AsMils(Pad_PinLength) > 4
Returns all pad objects that have a Pin/Pkg Length property which is greater than 4mil.

AsMM(Pad_PinLength) Between 0.102 And 0.105
Returns all pad objects that have a Pin/Pkg Length property which is greater than or equal to 0.102mm and less than or equal to 0.105mm.

Pad_PinLength <> 2
Returns all pad objects that have a Pin/Pkg Length property which is not equal to 2 current measurement units.

AsMils(Pad_PinLength) <= 1.4
Returns all pad objects that have a Pin/Pkg Length property which is less than or equal to 1.4mil.

AsMM(Pad_PinLength) < 0.05
Returns all pad objects that have a Pin/Pkg Length property which is less than 0.05mm.

Note

The Pin/Pkg Length property is only defined for pad objects.

PadElectricalType

Summary

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

Syntax

PadElectricalType = ElectricalType_String
PadElectricalType <> ElectricalType_String

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

'Load'
'Source'
'Terminator'

Example Usage

PadElectricalType = 'Load'
Returns all pad objects whose Electrical Type property is Load.

PadElectricalType <> 'Source'
Returns all objects except pad objects whose Electrical Type property is Source.

Notes

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

PadIsPlated

Summary

Returns all pad objects whose Plated property complies with the Query.

Syntax

PadIsPlated : Boolean_String

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

Example Usage

PadIsPlated = 'True'
Returns all pad objects whose Plated property is enabled.

PadIsPlated = 'False'
Returns all pad objects whose Plated property is disabled.

PadIsPlated <> 'True'
Not (PadIsPlated = 'True')
Returns all objects except pad objects whose Plated property is enabled.

PadIsPlated <> 'False'
Not (PadIsPlated = 'False')
Returns all objects except pad objects whose Plated property is disabled.

Note

The Plated property is only defined for pad objects.

PadShape_AllLayers

Summary

Returns all simple pad objects, whose Shape (All Layers) property complies with the Query.

Syntax

PadShape_AllLayers = PadShape_String PadShape_AllLayers <> PadShape_String

PadShape_String must be one of the following strings:

'Round'
'Rectangular'
'Octagonal'
'Rounded Rectangle'
'Custom Shape'

Example Usage

PadShape_AllLayers = 'Rectangular'
Returns all simple pad objects whose Shape (All Layers) property is set to Rectangular.

PadShape_AllLayers <> 'Octagonal'
Returns all objects except for simple pad objects whose Shape (All Layers) property is set to Octagonal.

PadShape_AllLayers = 'Round' || PadShape_AllLayers = 'Rectangular'
Returns all simple pad objects whose Shape (All Layers) property is set to either Round or Rectangular.

IsPad && PadShape_AllLayers <> 'Octagonal'
Returns all objects except for simple pad objects whose Shape (All Layers) property is set to Octagonal.

Notes

The single quote characters (') at the start and end of PadShape_String are mandatory.
The Shape (All Layers) property is only defined for simple pads (those with Stack Mode property set to Simple).

PadShape_BottomLayer

Summary

Returns pad objects whose Shape (Bottom Layer) property complies with the Query.

Syntax

PadShape_BottomLayer = PadShape_String PadShape_BottomLayer <> PadShape_String

PadShape_String must be one of the following strings:

'Round'
'Rectangular'
'Octagonal'
'Rounded Rectangle'
'Custom Shape'

Example Usage

PadShape_BottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Bottom Layer) property is set to Rectangular.

PadShape_BottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Bottom Layer) property is set to Octagonal.

PadShape_BottomLayer = 'Round' || PadShape_BottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Bottom Layer) property is set to either Round or Rectangular.

IsPad && PadShape_BottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Bottom Layer) property is set to Octagonal.

Notes

The single quote characters (') at the start and end of PadShape_String are mandatory.
For simple pads (with Stack Mode set to Simple) the Shape (Bottom Layer) property will be the same as the Shape (All Layers) property, since the specified shape is used for all signal layers.
The Shape (Bottom Layer) property is only defined for pad objects.

PadShape_MidLayerN

Summary

Returns pad objects whose Shape (Mid Layer <n>) property complies with the Query.

Syntax

PadShape_MidLayer<n> = PadShape_String PadShape_MidLayer<n> <> PadShape_String

PadShape_String must be one of the following strings:

'Round'
'Rectangular'
'Octagonal'
'Rounded Rectangle'
'Custom Shape'

Example Usage

PadShape_MidLayer<n> = 'Rectangular'
Returns all pad objects whose Shape (Mid Layer <n>) property is set to Rectangular.

PadShape_MidLayer<n> <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Mid Layer <n>) property is set to Octagonal.

PadShape_MidLayer<n> = 'Round' || PadShape_MidLayer<n> = 'Rectangular'
Returns all pad objects whose Shape (Mid Layer 1) property is set to either Round or Rectangular.

IsPad && PadShape_MidLayer<n> <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Mid Layer <n>) property is set to Octagonal.

Notes

The single quote characters (') at the start and end of PadShape_String are mandatory.
For simple pads (with Stack Mode set to Simple) the Shape (Mid Layer <n>) property will be the same as the Shape (All Layers) property, since the specified shape is used for all signal layers.
The Shape (Mid Layer <n>) property is only defined for pad objects.

PadShape_TopLayer

Summary

Returns pad objects whose Shape (Top Layer) property complies with the Query.

Syntax

PadShape_TopLayer = PadShape_String PadShape_TopLayer <> PadShape_String

PadShape_String must be one of the following strings:

'Round'
'Rectangular'
'Octagonal'
'Rounded Rectangle'
'Custom Shape'

Example Usage

PadShape_TopLayer = 'Rectangular'
Returns all pad objects whose Shape (Top Layer) property is set to Rectangular.

PadShape_TopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Top Layer) property is set to Octagonal.

PadShape_TopLayer = 'Round' || PadShape_TopLayer = 'Rectangular'
Returns all pad objects whose Shape (Top Layer) property is set to either Round or Rectangular.

IsPad && PadShape_TopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Top Layer) property is set to Octagonal.

Notes

The single quote characters (') at the start and end of PadShape_String are mandatory.
For simple pads (with Stack Mode set to Simple) the Shape (Top Layer) property will be the same as the Shape (All Layers) property, since the specified shape is used for all signal layers.
The Shape (Top Layer) property is only defined for pad objects.

PadStackMode

Summary

Returns all pad objects whose Stack Mode property complies with the Query.

Syntax

PadStackMode = StackMode_String
PadStackMode <> StackMode_String

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

'Full Stack'
'Simple'
'Top-Middle-Bottom'

Example Usage

PadStackMode = 'Simple'
Returns all pad objects whose Stack Mode property is Simple.

PadStackMode <> 'Full Stack'
Returns all objects except pad objects whose Stack Mode property is Full Stack.

PadStackMode = 'Simple' || PadStackMode = 'Top-Middle-Bottom' IsPad && PadStackMode <> 'Full Stack'
Returns all objects except pad objects whose Stack Mode property is Full Stack.

Notes

The Stack Mode property is only defined for pad objects.
The single quote characters (') at the start and end of StackMode_String are mandatory.

PadViaCustomThermalProfile

Summary

Returns all pad and via objects whose Custom Thermal Relief property complies with the Query.

Syntax

PadViaCustomThermalProfile : Boolean_String

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

Example Usage

PadViaCustomThermalProfile = 'True'
Returns all pad and via objects whose Custom Thermal Relief property is enabled.

PadViaCustomThermalProfile = 'False'
Returns all pad and via objects whose Custom Thermal Relief property is disabled.

PadViaCustomThermalProfile <> 'True'
Not (PadViaCustomThermalProfile = 'True')
Returns all objects except pad and via objects whose Custom Thermal Relief property is enabled.

PadViaCustomThermalProfile <> 'False'
Not (PadViaCustomThermalProfile = 'False')
Returns all objects except pad and via objects whose Custom Thermal Relief property is disabled.

Notes

The Custom Thermal Relief property is only defined for pad and via objects.
The Custom Thermal Relief property (as reflected in the List panels), relates to the Thermal Relief option in the Size and Shape section when viewing the properties for a selected object through the Properties panel.

PadViaLibrary

Summary

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

Syntax

PadViaLibrary = PadViaLibrary_String

PadViaLibrary_String must be a string that:

Targets pads/vias from the required Pad Via Template Library. In this case, the string should target that library name (e.g. 'ExamplePVLib.PvLib').
Targets pads/vias from the local template library. In this case, the '<Local>' string must be used.

Example Usage

PadViaLibrary = '<Local>'
Returns all pad and via objects whose Library property is <Local>.

PadViaLibrary = 'ExamplePVLib.PvLib'
Returns all pad and via objects whose Library property is ExamplePVLib.PvLib.

PadViaLibrary Like '*PVLib'
Returns all pad and via objects whose Library property ends in PVLib. For example, pads/vias placed from the template library ExamplePVLib.PvLib would be returned using this expression.

Notes

The Library property is only defined for pad and via objects.
The single quote characters (') at the start and end of PadViaLibrary_String are mandatory.

PadViaLibraryTemplate

Summary

Returns all pad and/or via objects whose Library Template property complies with the Query.

Syntax

PadViaLibraryTemplate : String

The entered string must target the name of the required pad/via template (e.g. 'c152hn127').

Example Usage

PadViaLibraryTemplate = 'c152hn127'
Returns all pad objects whose Library Template property is c152hn127.

PadViaLibraryTemplate = 'v127h71'
Returns all via objects whose Library Template property is v127h71.

PadViaLibraryTemplate Like '*127'
Returns all pad and via objects whose Library Template property ends in 127. For example, a pad placed using template c152hn127, and a via placed using template v102h71x127, would be returned using this expression.

Note

The Library Template property is only defined for pad and via objects.

PadViaLinkedToTemplate

Summary

Returns all pad and via objects whose Linked To Library property complies with the Query.

Syntax

PadViaLinkedToTemplate : Boolean_String

Example Usage

PadViaLinkedToTemplate = 'True'
Returns all pad and via objects whose Linked To Library property is enabled (are linked to a Pad Via Template Library (*.PvLib).

PadViaLinkedToTemplate = 'False'
Returns all pad and via objects whose Linked To Library property is disabled (are not linked to a Pad Via Template Library (*.PvLib).

Note

The Linked To Library property is only defined for pad and via objects.

PadXOffset

Summary

Returns all pad objects whose Pad X Offset property complies with the Query.

Syntax

PadXOffset : 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(PadXOffset) : Number – to specify an offset in mil.
AsMM(PadXOffset) : Number – to specify an offset in mm.

Example Usage

PadXOffset = 2
Returns all pad objects that have an Pad X Offset property which is 2 current measurement units.

PadXOffset >= 0.2286
Returns all pad objects that have an Pad X Offset property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(PadXOffset) Between 0.5 And 0.6
Returns all pad objects that have an Pad X Offset property which is greater than, or equal to, 0.5mil and less than, or equal to, 0.6mil.

AsMM(PadXOffset) < 0.2794
Returns all pad objects that have an Pad X Offset property which is less than 0.2794mm.

Notes

The Pad X Offset property is only defined for pad objects.
The Pad X Offset property corresponds to the Offset From Hole Center X field, when viewing the properties for a selected pad on the Properties panel.

PadXSize_AllLayers

Summary

Returns all simple pad objects, whose X Size (All Layers) property complies with the Query.

Syntax

PadXSize_AllLayers : 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(PadXSize_AllLayers) : Number – to specify a size in mil.
AsMM(PadXSize_AllLayers) : Number – to specify a size in mm.

Example Usage

PadXSize_AllLayers = 100
Returns all simple pad objects whose X Size (All Layers) property is equal to 100 current measurement units.

PadXSize_AllLayers >= 4.064
Returns all simple pad objects whose X Size (All Layers) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadXSize_AllLayers) > 80
Returns all simple pad objects whose X Size (All Layers) property is greater than 80mil.

AsMM(PadXSize_AllLayers) Between 1.524 And 3.81
Returns all simple pad objects whose X Size (All Layers) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadXSize_AllLayers <> 50
Returns all simple pad objects whose X Size (All Layers) property is not equal to 50 current measurement units.

Note

The X Size (All Layers) property is only defined for pads and vias whose Stack Mode property is set to Simple.

PadXSize_BottomLayer

Summary

Returns pad objects whose X Size (Bottom Layer) property complies with the Query.

Syntax

PadXSize_BottomLayer : 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(PadXSize_BottomLayer) : Number – to specify a size in mil.
AsMM(PadXSize_BottomLayer) : Number – to specify a size in mm.

Example Usage

PadXSize_BottomLayer = 100
Returns all pad objects whose X Size (Bottom Layer) property is equal to 100 current measurement units.

PadXSize_BottomLayer >= 4.064
Returns all pad objects whose X Size (Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadXSize_BottomLayer) > 80
Returns all pad objects whose X Size (Bottom Layer) property is greater than 80mil.

AsMM(PadXSize_BottomLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Bottom Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadXSize_BottomLayer <> 50
Returns all pad objects whose X Size (Bottom Layer) property is not equal to 50 current measurement units.

Notes

For simple pads (with Stack Mode set to Simple) the X Size (Bottom Layer) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
The X Size (Bottom Layer) property is only defined for pad and via objects.

PadXSize_MidLayerN

Summary

Returns pad objects whose X Size (Mid Layer <n>) property complies with the Query.

Syntax

PadXSize_MidLayer1 : 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(PadXSize_MidLayer<n>) : Number – to specify a size in mil.
AsMM(PadXSize_MidLayer<n>) : Number – to specify a size in mm.

Example Usage

PadXSize_MidLayer<n> = 100
Returns all pad objects whose X Size (Mid Layer <n>) property is equal to 100 current measurement units.

PadXSize_MidLayer<n> >= 4.064
Returns all pad objects whose X Size (Mid Layer <n>) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadXSize_MidLayer<n>) > 80
Returns all pad objects whose X Size (Mid Layer <n>) property is greater than 80mil.

AsMM(PadXSize_MidLayer<n>) Between 1.524 And 3.81
Returns all pad objects whose X Size (Mid Layer <n>) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadXSize_MidLayer<n> <> 50
Returns all pad objects whose X Size (Mid Layer <n>) property is not equal to 50 current measurement units.

Notes

For simple pads (with Stack Mode set to Simple) the X Size (Mid Layer <n>) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
The X Size (Mid Layer <n>) property is only defined for pad and via objects.

PadXSize_TopLayer

Summary

Returns pad objects whose X Size (Top Layer) property complies with the Query.

Syntax

PadXSize_TopLayer : 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(PadXSize_TopLayer) : Number – to specify a size in mil.
AsMM(PadXSize_TopLayer) : Number – to specify a size in mm.

Example Usage

PadXSize_TopLayer = 100
Returns all pad objects whose X Size (Top Layer) property is equal to 100 current measurement units.

PadXSize_TopLayer >= 4.064
Returns all pad objects whose X Size (Top Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadXSize_TopLayer) > 80
Returns all pad objects whose X Size (Top Layer) property is greater than 80mil.

AsMM(PadXSize_TopLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Top Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadXSize_TopLayer <> 50
Returns all pad objects whose X Size (Top Layer) property is not equal to 50 current measurement units.

Notes

For simple pads (with Stack Mode set to Simple) the X Size (Top Layer) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
The X Size (Top Layer) property is only defined for pad and via objects.

PadYOffset

Summary

Returns all pad objects whose Pad Y Offset property complies with the Query.

Syntax

PadYOffset : 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(PadYOffset) : Number – to specify an offset in mil.
AsMM(PadYOffset) : Number – to specify an offset in mm.

Example Usage

PadYOffset = 2
Returns all pad objects that have an Pad Y Offset property which is 2 current measurement units.

PadYOffset >= 0.2286
Returns all pad objects that have an Pad Y Offset property which is greater than, or equal to, 0.2286 current measurement units.

AsMils(PadYOffset) Between 0.5 And 0.6
Returns all pad objects that have an Pad Y Offset property which is greater than, or equal to, 0.5mil and less than, or equal to, 0.6mil.

AsMM(PadYOffset) < 0.2794
Returns all pad objects that have an Pad Y Offset property which is less than 0.2794mm.

Notes

The Pad Y Offset property is only defined for pad objects.
The Pad Y Offset property corresponds to the Offset From Hole Center Y field, when viewing the properties for a selected pad on the Properties panel.

PadYSize_AllLayers

Summary

Returns all simple pad objects, whose Y Size (All Layers) property complies with the Query.

Syntax

PadYSize_AllLayers : 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(PadYSize_AllLayers) : Number – to specify a size in mil.
AsMM(PadYSize_AllLayers) : Number – to specify a size in mm.

Example Usage

PadYSize_AllLayers = 100
Returns all simple pad objects whose Y Size (All Layers) property is equal to 100 current measurement units.

PadYSize_AllLayers >= 4.064
Returns all simple pad objects whose Y Size (All Layers) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadYSize_AllLayers) > 80
Returns all simple pad objects whose Y Size (All Layers) property is greater than 80mil.

AsMM(PadYSize_AllLayers) Between 1.524 And 3.81
Returns all simple pad objects whose Y Size (All Layers) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadYSize_AllLayers <> 50
Returns all simple pad objects whose Y Size (All Layers) property is not equal to 50 current measurement units.

Note

The Y Size (All Layers) property is only defined for pads whose Stack Mode property is set to Simple.

PadYSize_BottomLayer

Summary

Returns pad objects whose Y Size (Bottom Layer) property complies with the Query.

Syntax

PadYSize_BottomLayer : 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(PadYSize_BottomLayer) : Number – to specify a size in mil.
AsMM(PadYSize_BottomLayer) : Number – to specify a size in mm.

Example Usage

PadYSize_BottomLayer = 100
Returns all pad objects whose Y Size (Bottom Layer) property is equal to 100 current measurement units.

PadYSize_BottomLayer >= 4.064
Returns all pad objects whose Y Size (Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadYSize_BottomLayer) > 80
Returns all pad objects whose Y Size (Bottom Layer) property is greater than 80mil.

AsMM(PadYSize_BottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Bottom Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadYSize_BottomLayer <> 50
Returns all pad objects whose Y Size (Bottom Layer) property is not equal to 50 current measurement units.

Notes

For simple pads (with Stack Mode set to Simple) the Y Size (Bottom Layer) property will be the same as the Y Size (All Layers) property, since the specified size is used for all signal layers.
The Y Size (Bottom Layer) property is only defined for pad objects.

PadYSize_MidLayerN

Summary

Returns pad objects whose Y Size (Mid Layer <n>) property complies with the Query.

Syntax

PadYSize_MidLayer<n> : 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(PadYSize_MidLayer<n>) : Number – to specify a size in mil.
AsMM(PadYSize_MidLayer<n>) : Number – to specify a size in mm.

Example Usage

PadYSize_MidLayer<n> = 100
Returns all pad objects whose Y Size (Mid Layer <n>) property is equal to 100 current measurement units.

PadYSize_MidLayer<n> >= 4.064
Returns all pad objects whose Y Size (Mid Layer <n>) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadYSize_MidLayer<n>) > 80
Returns all pad objects whose Y Size (Mid Layer <n>) property is greater than 80mil.

AsMM(PadYSize_MidLayer<n>) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Mid Layer <n>) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadYSize_MidLayer<n> <> 50
Returns all pad objects whose Y Size (Mid Layer <n>) property is not equal to 50 current measurement units.

PadYSize_TopLayer

Summary

Returns pad objects whose Y Size (Top Layer) property complies with the Query.

Syntax

PadYSize_TopLayer : 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(PadYSize_TopLayer) : Number – to specify a size in mil.
AsMM(PadYSize_TopLayer) : Number – to specify a size in mm.

Example Usage

PadYSize_TopLayer = 100
Returns all pad objects whose Y Size (Top Layer) property is equal to 100 current measurement units.

PadYSize_TopLayer >= 4.064
Returns all pad objects whose Y Size (Top Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(PadYSize_TopLayer) > 80
Returns all pad objects whose Y Size (Top Layer) property is greater than 80mil.

AsMM(PadYSize_TopLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Top Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

PadYSize_TopLayer <> 50
Returns all pad objects whose Y Size (Top Layer) property is not equal to 50 current measurement units.

Notes

For simple pads (with Stack Mode set to Simple) the Y Size (Top Layer) property will be the same as the Y Size (All Layers) property since the specified size is used for all signal layers.
The Y Size (Top Layer) property is only defined for pad objects.

PasteMaskEnabled

Summary

Returns all pad objects whose Use Paste property complies with the Query.

Syntax

PasteMaskEnabled : Boolean_String

Example Usage

PasteMaskEnabled = 'True'
Returns all pad objects whose Use Paste property is enabled.

PasteMaskEnabled = 'False'
Returns all pad objects whose Use Paste property is disabled.

Note

The Use Paste property is only defined for pad objects.

PasteMaskExpansion

Summary

The paste mask expansion distance for arcs, fills, pads, regions and tracks can be determined either by relevant Paste Mask Expansion design rules or manually, by defining an expansion value as part of the object's properties. This function returns the following:

Pads whose Paste Mask Expansion property complies with the Query.
Arcs, fills, regions, and tracks whose Paste Mask Expansion Mode is set to Manual or From Rule, AND whose Paste Mask Expansion property complies with the Query.

Syntax

PasteMaskExpansion : 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(PasteMaskExpansion) : Number – to specify a paste mask expansion in mil.
AsMM(PasteMaskExpansion) : Number – to specify a paste mask expansion in mm.

Example Usage

PasteMaskExpansion = 4
Returns all pad objects whose Paste Mask Expansion property is 4 current measurement units. Also returns arc, fill, region and track objects whose Paste Mask Expansion Mode is set to Manual or From Rule, and whose Paste Mask Expansion property is 4 current measurement units.

PasteMaskExpansion >= 0.0508
Returns all pad objects whose Paste Mask Expansion property is greater than or equal to 0.0508 current measurement units. Also returns arc, fill, region and track objects whose Paste Mask Expansion Mode is set to Manual or From Rule, and whose Paste Mask Expansion property is greater than or equal to 0.0508 current measurement units.

AsMils(PasteMaskExpansion) Between 3 And 5
Returns all pad objects whose Paste Mask Expansion property is greater than or equal to 3mil and less than or equal to 5mil. Also returns arc, fill, region and track objects whose Paste Mask Expansion Mode is set to Manual or From Rule, and whose Paste Mask Expansion property is greater than or equal to 3mil and less than or equal to 5mil.

AsMM(PasteMaskExpansion) < 0.1524
Returns all pad objects whose Paste Mask Expansion property is less than 0.1524mm. Also returns arc, fill, region and track objects whose Paste Mask Expansion Mode is set to Manual or From Rule, and whose Paste Mask Expansion property is less than 0.1524mm.

Notes

The paste mask expansion distance can be specified to be negative, zero, or positive in value.
The Paste Mask Expansion property is only defined for arc, fill, pad, region and track objects.

PasteMaskExpansionMode

Summary

The paste mask expansion distance for arcs, fills, regions and tracks can be determined either by relevant Paste Mask Expansion design rules, or manually, by defining an expansion value as part of the object's properties. Alternatively, no masking can be employed for these objects. These three modes are determined by the object's Paste Mask Expansion Mode property. This function returns arc, fill, region and track objects whose Paste Mask Expansion Mode property complies with the Query.

Syntax

PasteMaskExpansionMode : ExpansionMode_String

ExpansionMode_String must be one of the following strings:

'None'
'From Rule'
'Manual'

Example Usage

PasteMaskExpansionMode = 'Manual'
Returns all arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to Manual, as well as pad objects whose Paste Mask Override property is enabled.

PasteMaskExpansionMode = 'From Rule'
Returns all arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to From Rule, as well as pad objects whose Paste Mask Override property is disabled.

PasteMaskExpansionMode = 'None'
Returns all objects except pad objects, and arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to either From Rule, or Manual.

PasteMaskExpansionMode <> 'Manual'
Not (PasteMaskExpansionMode = 'Manual')
Returns all objects except arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to Manual, and pad objects whose Paste Mask Override property is enabled.

PasteMaskExpansionMode <> 'From Rule'
Not (PasteMaskExpansionMode = 'From Rule')
Returns all objects except arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to From Rule, and pad objects whose Paste Mask Override property is disabled.

PasteMaskExpansionMode <> 'None'
Not (PasteMaskExpansionMode = 'None')
Returns all pad objects, as well as arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to either From Rule, or Manual.

Notes

The Paste Mask Expansion Mode property is only defined for arc, fill, region, and track objects.
The single quote characters (') at the start and end of ExpansionMode_String are mandatory.

PasteMaskOverride

Summary

The paste mask expansion distance for pads can be determined either by relevant Paste Mask Expansion design rules, or manually, by defining an expansion value as part of the pad's properties. The latter requires that the pad's Paste Mask Override property be enabled. This function returns pad objects whose Paste Mask Override property complies with the Query.

Syntax

PasteMaskOverride : Boolean_String

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

Example Usage

PasteMaskOverride = 'True'
Returns all pad objects whose Paste Mask Override property is enabled.

PasteMaskOverride = 'False'
Returns all pad objects whose Paste Mask Override property is disabled.

PasteMaskOverride <> 'True'
Not (PasteMaskOverride = 'True')
Returns all objects except pad objects whose Paste Mask Override property is enabled.

PasteMaskOverride <> 'False'
Not (PasteMaskOverride = 'False')
Returns all objects except pad objects whose Paste Mask Override property is disabled.

Note

The Paste Mask Override property is only defined for pad objects.

PasteMaskPercent

Summary

The paste mask expansion distance for pads can be determined as either an absolute value (mil/mm) or percentage of the pad area. This function returns objects whose Paste Mask Percent property complies with the Query.

Syntax

PasteMaskPercent = PasteMaskPercent_String PasteMaskPercent <> PasteMaskPercent_String

PasteMaskPercent_String specifies the paste mask expansion, expressed as a percentage.

Example Usage

PasteMaskPercent = '50%'
Returns all pad objects whose Paste Mask Percent property equals 50%.

PasteMaskPercent <> '30%'
Returns all objects except for pad objects whose Paste Mask Percent property equals 30%.

Notes

The single quote characters (') at the start and end of PasteMaskPercent_String are mandatory.
The paste mask expansion percentage for a pad can be specified to be negative, zero, or positive in value.

PasteMaskUsePercent

Summary

The paste mask expansion distance for pads can be determined as either an absolute value (mil/mm) or percentage of the pad area. This function returns objects whose Paste Mask Uses Percent property complies with the Query.

Syntax

PasteMaskUsePercent : Boolean_String

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

Example Usage

PasteMaskUsePercent = 'True'
Returns all pad objects whose Paste Mask Uses Percent property is enabled.

PasteMaskUsePercent = 'False'
Returns all objects except for pad objects whose Paste Mask Uses Percent property is enabled.

PluggingMaterial

Summary

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

Syntax

PluggingMaterial : String

Example Usage

PluggingMaterial = 'Epoxy'
Returns all via objects whose Plugging Material property is Epoxy.

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

Notes

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

PluggingSide

Summary

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

Syntax

PluggingSide = PluggingSide_String
PluggingSide <> PluggingSide_String

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

'Top'
'Bottom'
'Both'

Example Usage

PluggingSide = 'Top'
Returns all via objects whose Plugging Side property is Top.

PluggingSide <> 'Both'
Returns all objects except via objects whose Plugging Side property is Both.

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

Notes

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

PolygonArcApproximation

Summary

Returns all polygon pour objects whose Arc Approximation property complies with the Query.

Syntax

PolygonArcApproximation : 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(PolygonArcApproximation) : Number – to specify an approximation in mil.
AsMM(PolygonArcApproximation) : Number – to specify an approximation in mm.

Example Usage

PolygonArcApproximation = 0.0127
Returns all polygon pour objects that have an Arc Approximation property which is 0.0127 current measurement units.

PolygonArcApproximation >= 1.27
Returns all polygon pour objects that have an Arc Approximation property which is greater than, or equal to, 1.27 current measurement units.

AsMils(PolygonArcApproximation) Between 0.01 And 0.02
Returns all polygon pour objects that have an Arc Approximation property which is greater than, or equal to, 0.01mil and less than, or equal to, 0.02mil.

AsMM(PolygonArcApproximation) < 0.0127
Returns all polygon pour objects that have an Arc Approximation property which is less than 0.0127mm.

Notes

The Arc Approximation property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonGridSize

Summary

Returns all polygon pour objects whose Grid Size property complies with the Query.

Syntax

PolygonGridSize : 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(PolygonGridSize) : Number – to specify an size in mil.
AsMM(PolygonGridSize) : Number – to specify an size in mm.

Example Usage

PolygonGridSize = 20
Returns all polygon pour objects that have an Grid Size property which is 20 current measurement units.

PolygonGridSize >= 1.27
Returns all polygon pour objects that have an Grid Size property which is greater than, or equal to, 1.27 current measurement units.

AsMils(PolygonGridSize) Between 10 And 30
Returns all polygon pour objects that have an Grid Size property which is greater than, or equal to, 10mil and less than, or equal to, 30mil.

AsMM(PolygonGridSize) < 1.016
Returns all polygon pour objects that have an Grid Size property which is less than 1.016mm.

Notes

The Grid Size property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonHatchingStyle

Summary

Returns all polygon pour objects whose Hatching Style property complies with the Query.

Syntax

PolygonHatchingStyle = PolygonHatchingStyle_String
PolygonHatchingStyle <> PolygonHatchingStyle_String

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

'45-Degree Hatch'
'90-Degree Hatch'
'Horizontal Hatch'
'No Hatching'
'Solid'
'Vertical Hatch'

Example Usage

PolygonHatchingStyle = 'Horizontal Hatch'
Returns all polygon pour objects whose Hatching Style property is Horizontal Hatch.

PolygonHatchingStyle <> '45-Degree Hatch'
Returns all objects except polygon pour objects whose Hatching Style property is 45-Degree Hatch.

IsPolygon && PolygonHatchingStyle <> 'Solid'
Returns all polygon pour objects except those whose Hatching Style property is Solid.

Notes

The Hatching Style property is only defined for polygon pour objects.
The single quote characters (') at the start and end of PolygonHatchingStyle_String are mandatory.

PolygonIgnoreViolations

Summary

Returns all polygon pour objects whose Ignore On-Line Violations property complies with the Query.

Syntax

PolygonIgnoreViolations : Boolean_String

Example Usage

PolygonIgnoreViolations = 'True'
Returns all polygon pour objects whose Ignore On-Line Violations property is enabled.

PolygonIgnoreViolations = 'False'
Returns all polygon pour objects whose Ignore On-Line Violations property is disabled.

Notes

The Ignore On-Line Violations property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonIslandAreaThreshold

Summary

Returns all polygon pour objects whose Island Area Threshold property complies with the Query.

Syntax

PolygonIslandAreaThreshold : 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(PolygonIslandAreaThreshold) : Number – to specify a threshold in mil.
AsMM(PolygonIslandAreaThreshold) : Number – to specify a threshold in mm.

Example Usage

PolygonIslandAreaThreshold = 2
Returns all polygon pour objects that have an Island Area Threshold property which is 2 sqaure (current) measurement units.

PolygonIslandAreaThreshold >= 2
Returns all polygon pour objects that have an Island Area Threshold property which is greater than, or equal to, 2 sqaure (current) measurement units.

AsMils(PolygonIslandAreaThreshold) Between 3000 And 4000
Returns all polygon pour objects that have an Island Area Threshold property which is greater than, or equal to, 3000 square mils and less than, or equal to, 4000 square mils.

AsMM(PolygonIslandAreaThreshold) < 1.016
Returns all polygon pour objects that have an Island Area Threshold property which is less than 1.016 square mm.

Notes

The Island Area Threshold property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonMinimumPrimitiveSize

Summary

Returns all polygon pour objects whose Minimum Primitive Size property complies with the Query.

Syntax

PolygonMinimumPrimitiveSize : 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(PolygonMinimumPrimitiveSize) : Number – to specify a size in mil.
AsMM(PolygonMinimumPrimitiveSize) : Number – to specify a size in mm.

Example Usage

PolygonMinimumPrimitiveSize = 4
Returns all polygon pour objects that have an Minimum Primitive Size property which is 4 current measurement units.

PolygonMinimumPrimitiveSize >= 0.0508
Returns all polygon pour objects that have an Minimum Primitive Size property which is greater than, or equal to, 0.0508 current measurement units.

AsMils(PolygonMinimumPrimitiveSize) Between 3 And 5
Returns all polygon pour objects that have an Minimum Primitive Size property which is greater than, or equal to, 3mil and less than, or equal to, 5mil.

AsMM(PolygonMinimumPrimitiveSize) < 0.1524
Returns all polygon pour objects that have a Minimum Primitive Size property which is less than 0.1524mm.

Notes

The Minimum Primitive Size property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonNeckWidthThreshold

Summary

Returns all polygon pour objects whose Neck Width Threshold property complies with the Query.

Syntax

PolygonNeckWidthThreshold : 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(PolygonNeckWidthThreshold) : Number – to specify a threshold in mil.
AsMM(PolygonNeckWidthThreshold) : Number – to specify a threshold in mm.

Example Usage

PolygonNeckWidthThreshold = 5
Returns all polygon pour objects that have an Neck Width Threshold property which is 5 current measurement units.

PolygonNeckWidthThreshold >= 5
Returns all polygon pour objects that have an Neck Width Threshold property which is greater than, or equal to, 5 current measurement units.

AsMils(PolygonNeckWidthThreshold) Between 5 And 10
Returns all polygon pour objects that have an Neck Width Threshold property which is greater than, or equal to, 5mil and less than, or equal to, 10mil.

AsMM(PolygonNeckWidthThreshold) < 0.127
Returns all polygon pour objects that have an Neck Width Threshold property which is less than 0.127mm.

Notes

The Neck Width Threshold property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonPourOverSameNet

Summary

Returns all polygon pour objects whose Pour Over Same Net property complies with the Query.

Syntax

PolygonPourOverSameNet = PourOverSameNet_String
PolygonPourOverSameNet <> PourOverSameNet_String

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

'Don't Pour Over Same Net Objects'
'Pour Over All Same Net Objects'
'Pour Over Same Net Polygons Only'

Example Usage

PolygonPourOverSameNet = 'Pour Over All Same Net Objects'
Returns all polygon pour objects whose Pour Over Same Net property is Pour Over All Same Net Objects.

PolygonPourOverSameNet <> 'Pour Over Same Net Polygons Only'
Returns all objects except polygon pour objects whose Pour Over Same Net property is Pour Over Same Net Polygons Only.

PolygonPourOverSameNet = 'Pour Over All Same Net Objects' || PolygonPourOverSameNet = 'Pour Over Same Net Polygons Only' IsPolygon && PolygonPourOverSameNet <> 'Don't Pour Over Same Net Objects'
Returns all polygon pour objects except those whose Pour Over Same Net property is Don't Pour Over Same Net Objects.

Notes

The Pour Over Same Net property is only defined for polygon pour objects.
The single quote characters (') at the start and end of PourOverSameNet_String are mandatory.
The child objects of polygon pour objects returned by the Query are not returned.

PolygonRemoveDeadCopper

Summary

Returns all polygon pour objects whose Remove Dead Copper property complies with the Query.

Syntax

PolygonRemoveDeadCopper : Boolean_String

Example Usage

PolygonRemoveDeadCopper = 'True'
Returns all polygon pour objects whose Remove Dead Copper property is enabled.

PolygonRemoveDeadCopper = 'False'
Returns all polygon pour objects whose Remove Dead Copper property is disabled.

Notes

The Remove Dead Copper property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonRemoveIslandsByArea

Summary

Returns all polygon pour objects whose Remove Islands By Area property complies with the Query.

Syntax

PolygonRemoveIslandsByArea : Boolean_String

Example Usage

PolygonRemoveIslandsByArea = 'True'
Returns all polygon pour objects whose Remove Islands By Area property is enabled.

PolygonRemoveIslandsByArea = 'False'
Returns all polygon pour objects whose Remove Islands By Area property is disabled.

Notes

The Remove Islands By Area property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query are not returned.

PolygonRemoveNarrowNecks

Summary

Returns all polygon pour objects whose Remove Narrow Necks property complies with the Query.

Syntax

PolygonRemoveNarrowNecks : Boolean_String

Example Usage

PolygonRemoveNarrowNecks = 'True'
Returns all polygon pour objects whose Remove Narrow Necks property is enabled.

PolygonRemoveNarrowNecks = 'False'
Returns all polygon pour objects whose Remove Narrow Necks property is disabled.

Notes

The Remove Narrow Necks property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PolygonSurroundPads

Summary

Returns all polygon pour objects whose Surround Pads With property complies with the Query.

Syntax

PolygonSurroundPads = SurroundPads_String
PolygonSurroundPads <> SurroundPads_String

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

'Arcs'
'Octagons'

Example Usage

PolygonSurroundPads = 'Arcs'
Returns all polygon pour objects whose Surround Pads With property is Arcs.

PolygonSurroundPads <> 'Octagons'
Returns all objects except polygon pour objects whose Surround Pads With property is Octagons.

IsPolygon && PolygonSurroundPads <> 'Octagons'
Returns all polygon pour objects except those whose Surround Pads With property is Octagons.

Notes

The Surround Pads With property is only defined for polygon pour objects.
The single quote characters (') at the start and end of SurroundPads_String are mandatory.
The child objects of polygon pour objects returned by the Query are not returned.

PolygonTrackWidth

Summary

Returns all polygon pour objects whose Track Width property complies with the Query.

Syntax

PolygonTrackWidth : 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(PolygonTrackWidth) : Number – to specify a width in mil.
AsMM(PolygonTrackWidth) : Number – to specify a width in mm.

Example Usage

PolygonTrackWidth = 20
Returns all polygon pour objects that have an Track Width property which is 20 current measurement units.

PolygonTrackWidth >= 1.27
Returns all polygon pour objects that have an Track Width property which is greater than, or equal to, 1.27 current measurement units.

AsMils(PolygonTrackWidth) Between 10 And 30
Returns all polygon pour objects that have an Track Width property which is greater than, or equal to, 10mil and less than, or equal to, 30mil.

AsMM(PolygonTrackWidth) < 1.016
Returns all polygon pour objects that have an Track Width property which is less than 1.016mm.

Notes

The Track Width property is only defined for polygon pour objects.
The child objects of polygon pour objects returned by the Query, are not returned.

PositiveNet

Summary

Returns all differential pair objects whose Positive Net property complies with the Query.

Syntax

PositiveNet : String

Example Usage

PositiveNet = 'D_P'
Returns all differential pair objects whose Positive Net property is D_P.

PositiveNet Like '*RX1_P'
Returns all differential pair objects whose Positive Net property ends with RX1_P.

Notes

The Positive Net property is only defined for differential pair objects.
The child objects of differential pair objects returned by the Query are not returned.

PropagationDelay

Summary

Returns all arc, track, pad, via objects whose Propogation Delay property complies with the Query.

Syntax

PropogationDelay : Numeric_String

Example Usage

PropogationDelay = '70'
Returns all region objects whose Propogation Delay property is equal to 70.

PropogationDelay Between '200' And '400'
Returns all region objects whose Propogation Delay property is greater than or equal to 200 and less than or equal to 400.

PropogationDelay >= '100'
Returns all region objects whose Propogation Delay property is greater than or equal to 100.

PropogationDelay <> '120'
Returns all objects except region objects whose Propogation Delay property is equal to 120.

Note

The Propogation Delay property is only defined for component objects.

RadialDimensionAngularStep

Summary

Returns all radial diameter dimension, and radial dimension objects whose Angular Step property complies with the Query.

Syntax

RadialDimensionAngularStep : Number

The number returned specifies the Angular Step in units of degrees.

Example Usage

RadialDimensionAngularStep = 30.0
Returns all radial diameter dimension, and radial dimension objects that have a Angular Step property which is 30.0 degrees.

RadialDimensionAngularStep > 60.0
Returns all radial diameter dimension, and radial dimension objects that have a Angular Step property which is greater than 60.0 degrees.

RadialDimensionAngularStep Between 30.0 And 150.0
Returns all radial diameter dimension, and radial dimension objects that have a Angular Step property which is greater than, or equal to, 30.0 degrees and less than, or equal to, 150.0 degrees.

RadialDimensionAngularStep <= 45.0
Returns all radial diameter dimension, and radial dimension objects that have a Angular Step property which is less than, or equal to, 45.0 degrees.

Note

The Angular Step property is only defined for radial diameter dimension, and radial dimension objects.

Restricted

Summary

Returns all keepout objects whose Restricted for Layer property complies with the Query.

Syntax

Restricted = Layer_String
Restricted <> Layer_String

Layer_String is the name of the signal layer as it appears on the Layers & Colors tab of the View Configuration panel or All Layers. Example signal layers are TopLayer, BottomLayer, MidLayer1-30, and Signal Layer 1-30.

Example Usage

Restricted = 'TopLayer'
Returns all keepout objects on the TopLayer.

Restricted <> 'MidLayer1'
Returns all keepout objects except for those on the MidLayer1 layer.

Notes

The single quote characters (') at the start and end of Layer_String are mandatory.
The Restricted for Layer property is only defined for keepout objects (arcs, fills, solid regions, and tracks).

Rotation

Summary

Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects whose Rotation property complies with the Query.

Syntax

Rotation : Number

The number returned specifies the Rotation in units of degrees.

Example Usage

Rotation = 30.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is 30.0 degrees.

Rotation > 60.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is greater than 60.0 degrees.

Rotation Between 30.0 And 150.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is greater than, or equal to, 30.0 degrees and less than, or equal to, 150.0 degrees.

Rotation <= 45.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is less than, or equal to, 45.0 degrees.

Note

The Rotation property is only defined for baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects.

RuleAttributes

Summary

Returns all design rule and violation objects whose Rule Attributes property complies with the Query.

Syntax

RuleAttributes : String

The entered string must target the attributes defined for the rule (e.g. 'Clearance = 10mil').

Example Usage

RuleAttributes = 'Clearance = 10mil'
Returns all design rule and violation objects whose Rule Attributes property is Clearance = 10mil.

RuleAttributes Like 'Expansion*'
Returns all design rule and violation objects whose Rule Attributes property starts with Expansion. In this case all paste mask and solder mask related rules and violations will be returned.

Note

The Rule Attributes property is only defined for design rule and violation objects.

RuleCategory

Summary

Returns all design rule objects whose Rule Category property complies with the Query.

Syntax

RuleCategory = Category_String
RuleCategory <> Category_String

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

'Electrical'
'High Speed'
'Manufacturing'
'Mask'
'Placement'
'Plane'
'Routing'
'Signal Integrity'
'SMT'
'Testpoint'

Example Usage

RuleCategory = 'Electrical'
Returns all design rule objects whose Rule Category property is Electrical.

RuleCategory <> 'High Speed'
Returns all objects except design rule objects whose Rule Category property is High Speed.

IsRule && RuleCategory <> 'Signal Integrity'
Returns all design rule objects except those whose Rule Category property is Signal Integrity.

Notes

The Rule Category property is only defined for design rule objects.
The single quote characters (') at the start and end of Category_String are mandatory.

RuleComment

Summary

Returns all design rule and objects whose Rule Comment property complies with the Query.

Syntax

RuleComment : String

The entered string must target the comment defined for a rule (e.g. 'This is an example clearance rule').

Example Usage

RuleComment = 'All fiducials masked on Paste Mask layers'
Returns all design rule objects whose Rule Comment property is All fiducials masked on Paste Mask layers.

RuleComment Like '*Clearance*'
Returns all design rule objects whose Rule Comment property contains the term Clearance. For example, a clearance rule with Comment = Example Clearance Rule, and a component clearance rule with Comment = Example Component Clearance Rule, would both be returned using this expression.

RuleComment = ''
Returns all objects except design rule objects that have an entry for their Rule Comment property.

Note

The Rule Comment property is only defined for design rule objects.

RuleEnabled

Summary

Returns all design rule objects whose Rule Enabled property complies with the Query.

Syntax

RuleEnabled : Boolean_String

Example Usage

RuleEnabled = 'True'
Returns all design rule objects whose Rule Enabled property is enabled.

RuleEnabled = 'False'
Returns all design rule objects whose Rule Enabled property is disabled.

Note

The Rule Enabled property is only defined for design rule objects.

RulePriority

Summary

Returns all design rule objects whose Rule Priority property complies with the Query.

Syntax

RulePriority : Numeric_String RulePriority : Number

The RulePriority keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all other objects (which do not have a Rule Priority property) have been totally excluded by one or more preceding entries within the Query expression. Use entries in the expression such as RulePriority <> '', or RulePriority > ''. Alternatively, use entries specifically targeting dimension objects, such as ObjectKind Like '*Rule', or IsRule.

Example Usage

RulePriority = '1' RulePriority <> '' && RulePriority = 1
Returns all design rule objects whose Rule Priority property is 2.

RulePriority > '' && RulePriority Between 3 And 5
Returns all design rule objects whose Rule Priority property is greater than, or equal to, 3 and less than, or equal to, 5.

ObjectKind Like '*Rule' && RulePriority >= 4
Returns all design rule objects whose Rule Priority property is greater than, or equal to, 4.

IsRule && RulePriority < 4
Returns all design rule objects whose Rule Priority property is less than 4.

RulePriority <> '1'
Returns all objects except design rule objects whose Rule Priority property is 1.

IsRule && RulePriority <> 1
Returns all design rule objects whose Rule Priority property is not equal to 1.

Note

The Rule Priority property is only defined for design rule objects.

RuleScope1

Summary

Returns all design rule and violation objects whose Scope 1 property complies with the Query.

Syntax

RuleScope1 : String

The entered string must target the scope defined for the rule (e.g. 'All').

Example Usage

RuleScope1 = 'All'
Returns all design rule and violation objects whose Scope 1 property is All.

RuleScope1 = 'InNet(''D7'')'
Returns all design rule and violation objects whose Scope 1 property is InNet('D7').

RuleScope1 Like 'InNet(''???'')'
Returns all design rule and violation objects whose Scope 1 property is InNet('???'). The string of the associated net needs to consist of exactly three characters, with examples of compliant Scope 1 properties being InNet('GND') and InNet('VCC').

In the second and third examples, the name of the net (D7 and ???) is surrounded by single quote characters within the Query specifying the Scope 1 property. When such a Query is used within another Query, it needs to be enclosed in another set of single quote characters, and hence the double single quotes.

Note

The Scope 1 property is only defined for design rule and violation objects.

RuleScope2

Summary

Returns all design rule and violation objects whose Scope 2 property complies with the Query.

Syntax

RuleScope2 : String

The entered string must target the scope defined for the rule (e.g. 'All').

Example Usage

RuleScope2 = 'All'
Returns all design rule and violation objects whose Scope 2 property is All.

RuleScope2 = '-'
Returns all design rule and violation objects that have no Scope 2 property. A few types of design rules have a Scope 1 and Scope 2 property (binary rules), but most types of have just a Scope 1 property (unary rules), and thus a Scope 2 property cannot be defined for such rules.

RuleScope2 = 'InNet(''D7'')'
Returns all design rule and violation objects whose Scope 2 property is InNet('D7').

RuleScope2 Like 'InNet(''???'')'
Returns all design rule and violation objects whose Scope 2 property is InNet('???'). The string of the associated net needs to consist of exactly three characters, with examples of compliant Scope 1 properties being InNet('GND') and InNet('VCC').

RuleScope2 Like 'InComponent(''??*'')'
Returns all design rule and violation objects whose Scope 2 property is InComponent('??*'). The string of the associated component needs to consist of at least two characters, with examples of compliant Scope 2 properties being InComponent('C3') and InComponent('RP1').

In the second, third, and fourth examples, the name of the net (D7 and ???) is surrounded by single quote characters within the Query specifying the Scope 1 property. When such a Query is used within another Query, it needs to be enclosed in another set of single quote characters, and hence the double single quotes.

Note

The Scope 2 property is only defined for design rule and violation objects.

RuleType

Summary

Returns all design rule objects having a Rule Type property that complies with the Query.

Syntax

RuleType = RuleType_String
RuleType <> RuleType_String

RuleType_String must be one of the following strings:

Electrical Rules – 'Clearance', 'Short-Circuit', 'Un-Routed Net', 'Un-Connected Pin', 'Modified Polygon'
Routing Rules – 'Width', 'Routing Topology', 'Routing Priority', 'Routing Layers', 'Routing Corners', 'Routing Via Style', 'Fanout Control', 'Differential Pairs Routing'
SMT Rules – 'SMD To Corner', 'SMD To Plane', 'SMD Neck-Down', 'SMD Entry'
Mask Rules – 'Solder Mask Expansion', 'Paste Mask Expansion'
Plane Rules – 'Power Plane Connect Style', 'Power Plane Clearance', 'Polygon Connect Style'
Testpoint Rules - 'Fabrication Testpoint Style', 'Fabrication Testpoint Usage', 'Assembly Testpoint Style', 'Assembly Testpoint Usage'
Manufacturing Rules - 'Minimum Annular Ring', 'Acute Angle', 'Hole Size', 'Layer Pairs', 'Hole To Hole Clearance', 'Minimum Solder Mask Sliver', 'Silk To Solder Mask Clearance', 'Silk To Silk Clearance', 'Board Outline Clearance'
High Speed Rules - 'Parallel Segment', 'Length', 'Matched Lengths', 'Daisy Chain Stub Length', 'Vias Under SMD', 'Maximum Via Count', 'Max Via Sub Length (Back Drilling)'
Placement Rules – 'Room Definition', 'Component Clearance', 'Component Orientations', 'Permitted Layers', 'Nets to Ignore', 'Height'
Signal Integrity Rules - 'Signal Stimulus', 'Overshoot - Falling Edge', 'Overshoot - Rising Edge', 'Undershoot - Falling Edge', 'Undershoot - Rising Edge', 'Impedance', 'Signal Top Value', 'Signal Base Value', 'Flight Time - Rising Edge', 'Flight Time - Falling Edge', 'Slope - Rising Edge', 'Slope - Falling Edge', 'Supply Nets'

Example Usage

RuleType = 'Clearance'
Returns all design rule objects whose Rule Type property is Clearance.

RuleType <> 'Paste Mask Expansion'
Returns all objects except design rule objects whose Rule Type property is Paste Mask Expansion.

IsRule && RuleType <> 'Height'
Returns all design rule objects whose Rule Type property is not Height.

Notes

The Rule Type property is only defined for design rule objects.
The single quote characters (') at the start and end of RuleType_String are mandatory.

ShowComment

Summary

Returns component objects whose Show Comment property complies with the Query.

Syntax

ShowComment : Boolean_String

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

Example Usage

ShowComment = 'True'
Returns all component objects whose Show Comment property is enabled.

ShowComment = 'False'
Returns all component objects whose Show Comment property is disabled.

ShowComment <> 'True'
Not (ShowComment = 'True')
Returns all objects except component objects whose Show Comment property is enabled.

ShowComment <> 'False'
Not (ShowComment = 'False')
Returns all objects except component objects whose Show Comment property is disabled.

Notes

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

ShowName

Summary

Returns component objects whose Show Name property complies with the Query.

Syntax

ShowName : Boolean_String

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

Example Usage

ShowName = 'True'
Returns all component objects whose Show Name property is enabled.

ShowName = 'False'
Returns all component objects whose Show Name property is disabled.

ShowName <> 'True'
Not (ShowName = 'True')
Returns all objects except component objects whose Show Name property is enabled.

ShowName <> 'False'
Not (ShowName = 'False')
Returns all objects except component objects whose Show Name property is disabled.

Notes

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

SlotHoleLength

Summary

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

Syntax

SlotHoleLength : 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(SlotHoleLength) : Number – to specify a length in mil.
AsMM(SlotHoleLength) : Number – to specify a length in mm.

Example Usage

SlotHoleLength = 50
Returns all pad objects that have an Hole Length property which is 50 current measurement units.

SlotHoleLength >= 50
Returns all pad objects that have an Hole Length property which is greater than, or equal to, 50 current measurement units.

AsMils(SlotHoleLength) Between 20 And 50
Returns all pad objects that have an Hole Length property which is greater than, or equal to, 0.5mil and less than, or equal to, 0.6mil.

AsMM(SlotHoleLength) < 1.5
Returns all pad objects that have an Hole Length property which is less than 1.5mm.

Note

The Hole Length property is only defined for pad objects.

SolderMaskExpansion

Summary

The solder mask expansion distance for arcs, fills, pads, regions, tracks, and vias can be determined either by relevant Solder Mask Expansion design rules, or manually, by defining an expansion value as part of the object's properties. This function returns the following:

Pads and vias whose Solder Mask Expansion property complies with the Query.

If separate expansion values have been set for the top and bottom layers, the function checks the expansion value assigned to the top layer (Solder Mask Expansion - Top).

Arcs, fills, regions, and tracks whose Solder Mask Expansion Mode is set to Manual or From Rule, AND whose Solder Mask Expansion property complies with the Query.

Syntax

SolderMaskExpansion : 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(SolderMaskExpansion) : Number – to specify a solder mask expansion in mil.
AsMM(SolderMaskExpansion) : Number – to specify a solder mask expansion in mm.

Example Usage

SolderMaskExpansion = 4
Returns all pad and via objects whose Solder Mask Expansion property (or Solder Mask Expansion - Top property if separate) is 4 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is 4 current measurement units.

SolderMaskExpansion >= 0.0508
Returns all pad and via objects whose Solder Mask Expansion property (or Solder Mask Expansion - Top property if separate) is greater than or equal to 0.0508 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 0.0508 current measurement units.

AsMils(SolderMaskExpansion) Between 3 And 5
Returns all pad and via objects whose Solder Mask Expansion property (or Solder Mask Expansion - Top property if separate) is greater than or equal to 3mil and less than or equal to 5mil. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 3mil and less than or equal to 5mil.

AsMM(SolderMaskExpansion) < 0.1524
Returns all pad and via objects whose Solder Mask Expansion property (or Solder Mask Expansion - Top property if separate) is less than 0.1524mm. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is less than 0.1524mm.

Notes

The solder mask expansion distance can be specified to be negative, zero, or positive in value.
The Solder Mask Expansion property is only defined for arc, fill, pad, region, track and via objects.

SolderMaskExpansionBottom

Summary

Pads and vias whose Solder Mask Expansion - Bottom property complies with the Query.
Arcs, fills, regions, and tracks whose Solder Mask Expansion Mode is set to Manual or From Rule, AND whose Solder Mask Expansion property complies with the Query.

Syntax

SolderMaskExpansionBottom : 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(SolderMaskExpansionBottom) : Number – to specify a solder mask expansion in mil.
AsMM(SolderMaskExpansionBottom) : Number – to specify a solder mask expansion in mm.

Example Usage

SolderMaskExpansionBottom = 4
Returns all pad and via objects whose Solder Mask Expansion - Bottom property is 4 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is 4 current measurement units.

SolderMaskExpansionBottom >= 0.0508
Returns all pad and via objects whose Solder Mask Expansion - Bottom property is greater than or equal to 0.0508 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 0.0508 current measurement units.

AsMils(SolderMaskExpansionBottom) Between 3 And 5
Returns all pad and via objects whose Solder Mask Expansion - Bottom property is greater than or equal to 3mil and less than or equal to 5mil. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 3mil and less than or equal to 5mil.

AsMM(SolderMaskExpansionBottom) < 0.1524
Returns all pad and via objects whose Solder Mask Expansion - Bottom property is less than 0.1524mm. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is less than 0.1524mm.

Notes

The solder mask expansion distance can be specified to be negative, zero, or positive in value.
The Solder Mask Expansion - Bottom property is only defined for pad and via objects.

SolderMaskExpansionFromHoleEdge

Summary

Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property complies with the Query.

Syntax

SolderMaskExpansionFromHoleEdge : Boolean_String

Example Usage

SolderMaskExpansionFromHoleEdge = 'True'
Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property is enabled.

SolderMaskExpansionFromHoleEdge = 'False'
Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property is disabled.

Note

The Apply Solder Mask Expansion From The Hole Edge property is only defined for pad and via objects.

SolderMaskExpansionMode

Summary

The solder mask expansion distance for arcs, fills, regions and tracks can be determined either by relevant Solder Mask Expansion design rules, or manually, by defining an expansion value as part of the object's properties. Alternatively, no masking can be employed for these objects. These three modes are determined by the object's Solder Mask Expansion Mode property. This function returns arc, fill, region and track objects whose Solder Mask Expansion Mode property complies with the Query.

Syntax

SolderMaskExpansionMode : ExpansionMode_String

ExpansionMode_String must be one of the following strings:

'None'
'From Rule'
'Manual'

Example Usage

SolderMaskExpansionMode = 'Manual'
Returns all arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to Manual, as well as pad and via objects whose Solder Mask Override property is enabled.

SolderMaskExpansionMode = 'From Rule'
Returns all arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to From Rule, as well as pad and via objects whose Solder Mask Override property is disabled.

SolderMaskExpansionMode = 'None'
Returns all objects except pad and via objects, and arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to either From Rule, or Manual.

SolderMaskExpansionMode <> 'Manual'
Not (SolderMaskExpansionMode = 'Manual')
Returns all objects except arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to Manual, and pad and via objects whose Solder Mask Override property is enabled.

SolderMaskExpansionMode <> 'From Rule'
Not (SolderMaskExpansionMode = 'From Rule')
Returns all objects except arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to From Rule, and pad and via objects whose Solder Mask Override property is disabled.

SolderMaskExpansionMode <> 'None'
Not (SolderMaskExpansionMode = 'None')
Returns all pad and via objects, as well as arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to either From Rule, or Manual.

Notes

The Solder Mask Expansion Mode property is only defined for arc, fill, region, and track objects.
The single quote characters (') at the start and end of ExpansionMode_String are mandatory.

SolderMaskExpansionTop

Summary

Pads and vias whose Solder Mask Expansion - Top property complies with the Query.
Arcs, fills, regions, and tracks whose Solder Mask Expansion Mode is set to Manual or From Rule, AND whose Solder Mask Expansion property complies with the Query.

Syntax

SolderMaskExpansionTop : 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(SolderMaskExpansionTop) : Number – to specify a solder mask expansion in mil.
AsMM(SolderMaskExpansionTop) : Number – to specify a solder mask expansion in mm.

Example Usage

SolderMaskExpansionTop = 4
Returns all pad and via objects whose Solder Mask Expansion - Top property is 4 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is 4 current measurement units.

SolderMaskExpansionTop >= 0.0508
Returns all pad and via objects whose Solder Mask Expansion - Top property is greater than or equal to 0.0508 current measurement units. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 0.0508 current measurement units.

AsMils(SolderMaskExpansionTop) Between 3 And 5
Returns all pad and via objects whose Solder Mask Expansion - Top property is greater than or equal to 3mil and less than or equal to 5mil. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is greater than or equal to 3mil and less than or equal to 5mil.

AsMM(SolderMaskExpansionTop) < 0.1524
Returns all pad and via objects whose Solder Mask Expansion - Top property is less than 0.1524mm. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is less than 0.1524mm.

Notes

The solder mask expansion distance can be specified to be negative, zero, or positive in value.
The Solder Mask Expansion - Top property is only defined for pad and via objects.

SolderMaskOverride

Summary

The solder mask expansion distance for pads and vias can be determined either by relevant Solder Mask Expansion design rules, or manually, by defining an expansion value as part of the pad's/via's properties. The latter requires that the pad's/via's Solder Mask Override property be enabled. This function returns pad and via objects whose Solder Mask Override property complies with the Query.

Syntax

SolderMaskOverride : Boolean_String

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

Example Usage

SolderMaskOverride = 'True'
Returns all pad and via objects whose Solder Mask Override property is enabled.

SolderMaskOverride = 'False'
Returns all pad and via objects whose Solder Mask Override property is disabled.

SolderMaskOverride <> 'True'
Not (SolderMaskOverride = 'True')
Returns all objects except pad and via objects whose Solder Mask Override property is enabled.

SolderMaskOverride <> 'False'
Not (SolderMaskOverride = 'False')
Returns all objects except pad and via objects whose Solder Mask Override property is disabled.

Note

The Solder Mask Override property is only defined for pad and via objects.

SolderMaskTentingBottom

Summary

Returns all pad and via objects whose Solder Mask Tenting - Bottom property complies with the Query.

Syntax

SolderMaskTentingBottom : Boolean_String

Example Usage

SolderMaskTentingBottom = 'True'
Returns all pad and via objects whose Solder Mask Tenting - Bottom property is enabled.

SolderMaskTentingBottom = 'False'
Returns all pad and via objects whose Solder Mask Tenting - Bottom property is disabled.

Notes

The Solder Mask Tenting - Bottom property is only defined for pad and via objects.
The Solder Mask Tenting - Bottom property (as reflected in the List panels), relates to the Bottom option in the Solder Mask Expansion section, when viewing the properties for a selected object through the Properties panel. When the Solder Mask Tenting - Bottom property is enabled, the Bottom option is disabled, meaning that the pad/via has no solder mask opening on the bottom of the board, and is therefore tented.

SolderMaskTentingTop

Summary

Returns all pad and via objects whose Solder Mask Tenting - Top property complies with the Query.

Syntax

SolderMaskTentingTop : Boolean_String

Example Usage

SolderMaskTentingTop = 'True'
Returns all pad and via objects whose Solder Mask Tenting - Top property is enabled.

SolderMaskTentingTop = 'False'
Returns all pad and via objects whose Solder Mask Tenting - Top property is disabled.

Notes

The Solder Mask Tenting - Top property is only defined for pad and via objects.
The Solder Mask Tenting - Top property (as reflected in the List panels), relates to the Top option in the Solder Mask Expansion section, when viewing the properties for a selected object through the Properties panel. When the Solder Mask Tenting - Top property is enabled, the Top option is disabled, meaning that the pad/via has no solder mask opening on the top of the board, and is therefore tented.

StandoffHeight

Summary

Returns all extruded 3D body objects whose Model Standoff Height (Extruded) property complies with the Query.

Syntax

StandoffHeight : 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(StandoffHeight) : Number – to specify a height in mil.
AsMM(StandoffHeight) : Number – to specify a height in mm.

Example Usage

StandoffHeight = 100
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is equal to 100 current measurement units.

StandoffHeight >= 4.064
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is greater than or equal to 4.064 current measurement units.

AsMils(StandoffHeight) > 80
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is greater than 80mil.

AsMM(StandoffHeight) Between 1.524 And 3.81
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is greater than or equal to 1.524mm and less than or equal to 3.81mm.

StandoffHeight <> 50
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is not equal to 50 current measurement units.

AsMils(StandoffHeight) <= 120
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is less than or equal to 120mil.

AsMM(StandoffHeight) < 1.778
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property which is less than 1.778mm.

Note

The Model Standoff Height (Extruded) property is only defined for extruded 3D body objects.

StartLayer

Summary

Returns all via objects whose left-hand layer in their Drill Pair property complies with the Query.

Syntax

StartLayer = Layer_String

Where Layer_String is the name given to that layer in the Layer Stack Manager. Learn more about Defining the Layer Stack.

Example Usage

StartLayer = 'Top Layer'
Returns all via objects whose Drill Pair property has a left-hand entry of Top Layer.

StartLayer <> 'Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property has a left-hand entry of Signal Layer 2.

IsVia && StartLayer <> 'Internal Plane 1'
Returns all Via objects except those whose Drill Pair property has a left-hand entry of Internal Plane 1.

Notes

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

StopLayer

Summary

Returns all via objects whose right-hand layer in their Drill Pair property complies with the Query.

Syntax

StopLayer = Layer_String

Layer_String is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

StopLayer = 'Top Layer'
Returns all via objects whose Drill Pair property has a right-hand entry of Top Layer.

StopLayer <> 'Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property has a right-hand entry of Signal Layer 2.

IsVia && StopLayer <> 'Internal Plane 1'
Returns all Via objects except those whose Drill Pair property has a right-hand entry of Internal Plane 1.

Notes

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

StringText

Summary

Returns text string and leader dimension objects whose String property complies with the Query.

Syntax

StringText : String

Example Usage

StringText = '100nF'

Returns all text string and leader dimension objects whose String property is 100nF.

Notes

The child objects of leader dimension objects returned by the Query are not returned.
The String property is only defined for text string and leader dimension objects.

StringType

Summary

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

Syntax

StringType = StringType_String
StringType <> StringType_String

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

'Comment'
'Designator'
'Free'

Example Usage

StringType = 'Designator'
Returns all text objects whose String Type property is Designator.

StringType <> 'Free'
Returns all objects except text objects whose String Type property is Free.

StringType = 'Comment' || StringType = 'Designator'
IsString && StringType <> 'Free'
Returns all text objects whose String Type property is not Free.

Notes

The String Type property is only defined for text objects.
The single quote characters (') at the start and end of StringType_String are mandatory.

StrokeFont

Summary

Returns all coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property complies with the Query.

Syntax

StrokeFont = Font_String StrokeFont <> Font_String

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

'Default'
'Serif'
'Sans Serif'

Example Usage

StrokeFont = 'Default'
Returns all coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property is Default.

StrokeFont <> 'Serif'
Returns all objects except coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property is Serif.

Notes

The single quote characters (') at the start and end of Font_String are mandatory.
The Stroke Font property is only defined for coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects.

TentingMaterial

Summary

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

Syntax

TentingMaterial : String

Example Usage

TentingMaterial = 'Epoxy'
Returns all via objects whose Tenting Material property is Epoxy.

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

Notes

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

TentingSide

Summary

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

Syntax

TentingSide = TentingSide_String
TentingSide <> TentingSide_String

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

'Top'
'Bottom'
'Both'

Example Usage

TentingSide = 'Top'
Returns all via objects whose Tenting Side property is Top.

TentingSide <> 'Both'
Returns all objects except via objects whose Tenting Side property is Both.

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

Notes

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

Testpoint

Summary

Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, or Assembly Testpoint - Bottom properties comply with the Query.

Syntax

Testpoint : Boolean

Example Usage

Testpoint
Testpoint = True
Returns all pad and via objects having any of their Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, or Assembly Testpoint - Bottom properties enabled.

Not Testpoint
Testpoint = False
Returns all objects except pad and via objects having any of their Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, or Assembly Testpoint - Bottom properties enabled.

Note

The Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, and Assembly Testpoint - Bottom properties are only defined for pad and via objects.

TestpointAssy

Summary

Summary

Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties comply with the Query.

Syntax

TestpointBottom : Boolean

Example Usage

TestpointBottom
TestpointBottom = True
Returns all pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties are enabled.

Not TestpointBottom
TestpointBottom = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties are enabled.

Note

The Fabrication Testpoint - Bottom and Assembly Testpoint - Bottom properties are only defined for pad and via objects.

TestpointFab

Summary

Summary

Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties comply with the Query.

Syntax

TestpointTop : Boolean

Example Usage

TestpointTop
TestpointTop = True
Returns all pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties are enabled.

Not TestpointTop
TestpointTop = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties are enabled.

Note

The Fabrication Testpoint - Top and Assembly Testpoint - Top properties are only defined for pad and via objects.

TextHeight

Summary

Returns all coordinate, original dimension and text string (comment, designator, free) objects whose Text Height property complies with the Query.

Syntax

TextHeight : 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(TextHeight) : Number – to specify a height in mil.
AsMM(TextHeight) : Number – to specify a height in mm.

Example Usage

TextHeight = 60
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Height property which is 60 current measurement units.

TextHeight >= 1.27
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Height property which is greater than, or equal to, 1.27 current measurement units.

AsMils(TextHeight) Between 40 And 80
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Height property which is greater than, or equal to, 40mil and less than, or equal to, 80mil.

AsMM(TextHeight) < 1.778
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Height property which is less than 1.778mm.

Note

The Text Height property is only defined for coordinate, original dimension and text string (comment, designator, free) objects.

TextKind

Summary

Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property complies with the Query.

Syntax

TextKind = TextKind_String
TextKind <> TextKind_String

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

'BarCode Text'
'Stroke Font'
'TrueType Font'

'BarCode Text' only applies to text string (comment, designator, free) objects.

Example Usage

TextKind = 'Stroke Font'
Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property is Stroke Font.

TextKind <> 'BarCode Text'
Returns all objects except text string (comment, designator, free) objects whose Text Kind property is BarCode Text.

IsDesignator && TextKind = 'TrueType Font'
Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property is TrueType Font.

Notes

The Text Kind property is only defined for drill table, layer stack and text string (comment, designator, free) objects.
The single quote characters (') at the start and end of TextKind_String are mandatory.

TextOffsetFromInvertedRectangle

Summary

Returns all text string (comment, designator, free) objects whose Inverted Text Offset From Inverted Rect property complies with the Query.

Syntax

TextOffsetFromInvertedRectangle : 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(TextOffsetFromInvertedRectangle) : Number – to specify an offset in mil.
AsMM(TextOffsetFromInvertedRectangle) : Number – to specify an offset in mm.

Example Usage

TextOffsetFromInvertedRectangle = 3
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is equal to 3 current measurement units.

TextOffsetFromInvertedRectangle >= 5.08
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is greater than or equal to 5.08 current measurement units.

AsMils(TextOffsetFromInvertedRectangle) > 4
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is greater than 4mil.

AsMM(TextOffsetFromInvertedRectangle) Between 0.635 And 0.889
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is greater than or equal to 0.635mm and less than or equal to 0.889mm.

TextOffsetFromInvertedRectangle <> 5.5
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is not equal to 5.5 current measurement units.

AsMils(TextOffsetFromInvertedRectangle) <= 2.5
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is less than or equal to 2.5mil.

AsMM(TextOffsetFromInvertedRectangle) < 0.143
Returns all text string (comment, designator, free) objects that have a Inverted Text Offset From Inverted Rect property which is less than 0.143mm.

Note

The Inverted Text Offset From Inverted Rect property is only defined for text string (comment, designator, free) objects.

TextWidth

Summary

Returns all coordinate, original dimension and text string (comment, designator, free) objects whose Text Width property complies with the Query.

Syntax

TextWidth : 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(TextWidth) : Number – to specify a width in mil.
AsMM(TextWidth) : Number – to specify a width in mm.

Example Usage

TextWidth = 6
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Width property which is 6 current measurement units.

TextWidth >= 0.127
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Width property which is greater than, or equal to, 0.127 current measurement units.

AsMils(TextWidth) Between 4 And 8
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Width property which is greater than, or equal to, 4mil and less than, or equal to, 8mil.

AsMM(TextWidth) < 0.1778
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have an Text Width property which is less than 0.1778mm.

Note

The Text Width property is only defined for coordinate, original dimension and text string (comment, designator, free) objects.

TrackWidth

Summary

Returns all rectangle objects whose Track Width property complies with the Query.

Syntax

TrackWidth : 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(TrackWidth) : Number – to specify a width in mil.
AsMM(TrackWidth) : Number – to specify a width in mm.

Syntax

ViaDiameter : 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(ViaDiameter) : Number – to specify a via diameter in mil.
AsMM(ViaDiameter) : Number – to specify a via diameter in mm.

Example Usage

ViaDiameter = 40
Returns all via objects that have a X Size (All Layers) property which is 40 current measurement units.

ViaDiameter >= 0.508
Returns all via objects that have a X Size (All Layers) property which is greater than or equal to 0.508 current measurement units.

AsMils(ViaDiameter) Between 30 And 50
Returns all via objects that have a X Size (All Layers) property which is greater than or equal to 30mil and less than or equal to 50mil.

AsMM(ViaDiameter) < 1.524
Returns all via objects that have a X Size (All Layers) property which is less than 1.524mm.

Notes

The X Size (All Layers) property is only defined for simple via objects - those with their Stack Mode property (as seen from a List panel) set to Simple. When viewing the properties for a via through the Properties panel, this relates to the Simple option being selected, in the Size and Shape section.
When viewing the properties for a selected via in the Properties panel, the X Size (All Layers) property corresponds to the Diameter field, in the Size and Shape section.
This function is an alias for the ViaSize function.

ViaSize

Summary

Returns all simple via objects whose X Size (All Layers) property complies with the Query.

Syntax

ViaSize : 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(ViaSize) : Number – to specify a via diameter in mil.
AsMM(ViaSize) : Number – to specify a via diameter in mm.

Example Usage

ViaSize = 40
Returns all via objects that have a X Size (All Layers) property which is 40 current measurement units.

ViaSize >= 0.508
Returns all via objects that have a X Size (All Layers) property which is greater than or equal to 0.508 current measurement units.

AsMils(ViaSize) Between 30 And 50
Returns all via objects that have a X Size (All Layers) property which is greater than or equal to 30mil and less than or equal to 50mil.

AsMM(ViaSize) < 1.524
Returns all via objects that have a X Size (All Layers) property which is less than 1.524mm.

Notes

The X Size (All Layers) property is only defined for simple via objects - those with their Stack Mode property (as seen from a List panel) set to Simple. When viewing the properties for a via through the Properties panel, this relates to the Simple option being selected, in the Size and Shape section.
When viewing the properties for a selected via in the Properties panel, the X Size (All Layers) property corresponds to the Diameter field, in the Size and Shape section.
This function is an alias for the ViaDiameter function.

ViaSize_BottomLayer

Summary

Returns via objects whose X Size (Bottom Layer) property complies with the Query.

Syntax

ViaSize_BottomLayer : 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(ViaSize_BottomLayer) : Number – to specify a size in mil.
AsMM(ViaSize_BottomLayer) : Number – to specify a size in mm.

Example Usage

ViaSize_BottomLayer = 100
Returns all via objects whose X Size (Bottom Layer) property is equal to 100 current measurement units.

ViaSize_BottomLayer >= 4.064
Returns all via objects whose X Size (Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(ViaSize_BottomLayer) > 80
Returns all via objects whose X Size (Bottom Layer) property is greater than 80mil.

AsMM(ViaSize_BottomLayer) Between 1.524 And 3.81
Returns all via objects whose X Size (Bottom Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

ViaSize_BottomLayer <> 50
Returns all via objects whose X Size (Bottom Layer) property is not equal to 50 current measurement units.

Notes

For simple vias (with Stack Mode set to Simple) the X Size (Bottom Layer) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
When viewing the properties for a selected via in the Properties panel, the X Size (Bottom Layer) property corresponds to the Diameter field for the Bottom Layer (in the Size and Shape section) when the mode is set to Top-Middle-Bottom, or Full Stack. When the mode is Simple, this will correspond to the Diameter field.
The X Size (Bottom Layer) property is only defined for pad and via objects.

ViaSize_MidLayerN

Summary

Returns via objects whose X Size (Mid Layer <n>) property complies with the Query.

Syntax

ViaSize_MidLayer<n> : 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(ViaSize_MidLayer<n>) : Number – to specify a size in mil.
AsMM(ViaSize_MidLayer<n>) : Number – to specify a size in mm.

Example Usage

ViaSize_MidLayer<n> = 100
Returns all via objects whose X Size (Mid Layer <n>) property is equal to 100 current measurement units.

ViaSize_MidLayer<n> >= 4.064
Returns all via objects whose X Size (Mid Layer <n>) property is greater than, or equal to, 4.064 current measurement units.

AsMils(ViaSize_MidLayer<n>) > 80
Returns all via objects whose X Size (Mid Layer <n>) property is greater than 80mil.

AsMM(ViaSize_MidLayer<n>) Between 1.524 And 3.81
Returns all via objects whose X Size (Mid Layer <n>) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

ViaSize_MidLayer<n> <> 50
Returns all via objects whose X Size (Mid Layer <n>) property is not equal to 50 current measurement units.

Notes

For simple vias (with Stack Mode set to Simple) the X Size (Mid Layer <n>) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
When viewing the properties for a selected via in the Properties panel, the X Size (Mid Layer <n>) property corresponds to the Diameter field for Mid Layer 1 (in the Size and Shape section) when the mode is set to Top-Middle-Bottom, or Full Stack. When the mode is Simple, this will correspond to the Diameter field.
The X Size (Mid Layer <n>) property is only defined for pad and via objects.

ViaSize_TopLayer

Summary

Returns via objects whose X Size (Top Layer) property complies with the Query.

Syntax

ViaSize_TopLayer : 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(ViaSize_TopLayer) : Number – to specify a size in mil.
AsMM(ViaSize_TopLayer) : Number – to specify a size in mm.

Example Usage

ViaSize_TopLayer = 100
Returns all via objects whose X Size (Top Layer) property is equal to 100 current measurement units.

ViaSize_TopLayer >= 4.064
Returns all via objects whose X Size (Top Layer) property is greater than, or equal to, 4.064 current measurement units.

AsMils(ViaSize_TopLayer) > 80
Returns all via objects whose X Size (Top Layer) property is greater than 80mil.

AsMM(ViaSize_TopLayer) Between 1.524 And 3.81
Returns all via objects whose X Size (Top Layer) property is greater than or equal to 1.524mm and less than or equal to 3.81mm.

ViaSize_TopLayer <> 50
Returns all via objects whose X Size (Top Layer) property is not equal to 50 current measurement units.

Notes

For simple vias (with Stack Mode set to Simple) the X Size (Top Layer) property will be the same as the X Size (All Layers) property, since the specified size is used for all signal layers.
When viewing the properties for a selected via in the Properties panel, the X Size (Top Layer) property corresponds to the Diameter field for the Top Layer (in the Size and Shape section) when the mode is set to Top-Middle-Bottom, or Full Stack. When the mode is Simple, this will correspond to the Diameter field.
The X Size (Top Layer) property is only defined for pad and via objects.

ViolatingPrimitive1

Summary

Returns all violation objects whose Primitive 1 property complies with the Query.

Syntax

ViolatingPrimitive1 : String

Example Usage

ViolatingPrimitive1 = 'Net GND'
Returns all violation objects whose Primitive 1 property is Net GND.

ViolatingPrimitive1 Like 'Pad*'
Returns all violation objects whose Primitive 1 property commences with Pad.

Notes

The Primitive 1 property is only defined for violation objects.
The child objects of violation objects returned by the Query are not returned.

ViolatingPrimitive2

Summary

Returns all violation objects whose Primitive 2 property complies with the Query.

The Primitive 2 property is meaningful only for violation of a binary design rule.

Syntax

ViolatingPrimitive2 : String

Example Usage

ViolatingPrimitive2 = 'Net GND'
Returns all violation objects whose Primitive 2 property is Net GND.

ViolatingPrimitive2 Like 'Pad*'
Returns all violation objects whose Primitive 2 property commences with Pad.

Notes

The Primitive 2 property is only defined for violation objects.
The child objects of violation objects returned by the Query are not returned.

ViolationDescription

Summary

Returns all violation objects whose Violation Description property complies with the Query.

Syntax

ViolationDescription : String

Example Usage

ViolationDescription = '- Missing required testpoint'
Returns all violation objects whose Violation Description property is - Missing required testpoint.

ViolationDescription Like '*Length*'
Returns all violation objects whose Violation Description property contains Length.

Notes

The Violation Description property is only defined for violation objects.
The child objects of violation objects returned by the Query are not returned.

Summary

Returns arc and track objects whose Width property complies with the Query.

Syntax

W : 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(W) : Number – to specify a width in mil.
AsMM(W) : Number – to specify a width in mm.

Example Usage

W = 20
Returns all arc and track objects that have a Width property which is 20 current measurement units.

W >= 0.381
Returns all arc and track objects that have a Width property which is greater than or equal to 0.381 current measurement units.

AsMils(W) Between 10 And 30
Returns all arc and track objects that have a Width property which is greater than or equal to 10mil and less than or equal to 30mil.

AsMM(W) < 0.635
Returns all arc and track objects that have a Width property which is less than 0.635mm.

Notes

The Width property is only defined for arc and track objects.
This function is an alias for the Width function.

Width

Summary

Returns arc and track objects whose Width property complies with the Query.

Syntax

Width : 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(Width) : Number – to specify a width in mil.
AsMM(Width) : Number – to specify a width in mm.

Example Usage

Width = 20
Returns all arc and track objects that have a Width property which is 20 current measurement units.

Width >= 0.381
Returns all arc and track objects that have a Width property which is greater than or equal to 0.381 current measurement units.

AsMils(Width) Between 10 And 30
Returns all arc and track objects that have a Width property which is greater than or equal to 10mil and less than or equal to 30mil.

AsMM(Width) < 0.635
Returns all arc and track objects that have a Width property which is less than 0.635mm.

Notes

The Width property is only defined for arc and track objects.
This function is an alias for the W function.

Summary

Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects whose X1 property complies with the Query.

Syntax

X1 : 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(X1) : Number – to specify a value in mil.
AsMM(X1) : Number – to specify a value in mm.

Example Usage

X1 = 1200
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a X1 property which is equal to 1200 current measurement units.

X1 >= 38.1
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a X1 property which is greater than or equal to 38.1 current measurement units.

AsMils(X1) Between 1000 And 1400
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a X1 property which is greater than or equal to 1000mil and less than or equal to 1400mil.

AsMM(X1) < 20.32
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a X1 property which is less than 20.32mm.

Note

The X1 property is only defined for arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects.

Summary

Returns all fill, original dimension, and track objects whose X2 property complies with the Query.

Syntax

X2 : 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(X2) : Number – to specify a value in mil.
AsMM(X2) : Number – to specify a value in mm.

Example Usage

X2 = 1200
Returns all fill, original dimension, and track objects that have a X2 property which is equal to 1200 current measurement units.

X2 >= 38.1
Returns all fill, original dimension, and track objects that have a X2 property which is greater than or equal to 38.1 current measurement units.

AsMils(X2) Between 1000 And 1400
Returns all fill, original dimension, and track objects that have a X2 property which is greater than or equal to 1000mil and less than or equal to 1400mil.

AsMM(X2) < 20.32
Returns all fill, original dimension, and track objects that have a X2 property which is less than 20.32mm.

Note

The X2 property is only defined for fill, original dimension, and track objects.

Summary

Syntax

Y1 : 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(Y1) : Number – to specify a value in mil.
AsMM(Y1) : Number – to specify a value in mm.

Example Usage

Y1 = 1200
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a Y1 property which is equal to 1200 current measurement units.

Y1 >= 38.1
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a Y1 property which is greater than or equal to 38.1 current measurement units.

AsMils(Y1) Between 1000 And 1400
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a Y1 property which is greater than or equal to 1000mil and less than or equal to 1400mil.

AsMM(Y1) < 20.32
Returns all arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects that have a Y1 property which is less than 20.32mm.

Note

The Y1 property is only defined for arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects.

Summary

Returns all fill, original dimension, and track objects whose Y2 property complies with the Query.

Syntax

Y2 : 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(Y2) : Number – to specify a value in mil.
AsMM(Y2) : Number – to specify a value in mm.

Example Usage

Y2 = 1200
Returns all fill, original dimension, and track objects that have a Y2 property which is equal to 1200 current measurement units.

Y2 >= 38.1
Returns all fill, original dimension, and track objects that have a Y2 property which is greater than or equal to 38.1 current measurement units.

AsMils(Y2) Between 1000 And 1400
Returns all fill, original dimension, and track objects that have a Y2 property which is greater than or equal to 1000mil and less than or equal to 1400mil.

OnOutside : Boolean

Example Usage

OnOutside
OnOutside = True
Returns all objects on the 'outside' signal layers – Top Layer and Bottom Layer.

Not OnOutside
OnOutside = False
Returns all objects except objects on the 'outside' signal layers – Top Layer and Bottom Layer.

OnTopSolderMask
OnTopSolderMask = True
Returns all objects on the Top Solder layer, all pads on the Top Layer and Multi-Layer, and all vias starting on the Top Layer.

Not OnTopSolderMask
OnTopSolderMask = False
Returns all objects except objects on the Top Solder layer, all pads on the Top Layer and Multi-Layer, and all vias starting on the Top Layer.

Membership Checks

AsMils

Summary

For numeric properties of objects (e.g. height, width, radius, etc), this keyword is used to convert the current value - measured in the default workspace units - into imperial units - mil - where 1mil = 0.001inch, which is then tested against the value entered in the expression.

Syntax

AsMils(Keyword : Number) : Number

Example Usage

AsMils(ArcRadius) = 250
Returns all arc objects that have a Radius property which is 250mil.

AsMils(Height) Between 300 And 500
Returns all component objects that have a Height property which is greater than, or equal to, 300mil, and less than, or equal to, 500mil.

AsMils(PolygonGridSize) >= 10
Returns all polygon pour objects that have a Grid Size property which is greater than, or equal to, 10mil.

AsMils(Width) < 50
Returns all arc and track objects that have a Width property which is less than 50mil.

AsMils(TraceLength) = 10
Returns all arc and track objects that have a Length which is equal to 10mil.

Note - due to an issue in the software, to correctly detect the TraceLength using the AsMils keyword the board units must be set to mils before running the query.

AsMM

Summary

For numeric properties of objects (e.g. height, width, radius, etc), this keyword is used to convert the current value - measured in the default workspace units - into metric units - mm - where 1mm = 0.001meter, which is then tested against the value entered in the expression.

Syntax

AsMM(Keyword : Number) : Number

Example Usage

AsMM(ArcRadius) = 6.35
Returns all arc objects that have a Radius property which is 6.35mm.

AsMM(Height) Between 7.62 And 12.7
Returns all component objects that have a Height property which is greater than, or equal to, 7.62mm, and less than, or equal to, 12.7mm.

AsMM(PolygonGridSize) >= 0.254
Returns all polygon pour objects that have a Grid Size property which is greater than, or equal to, 0.254mm.

AsMM(Width) < 1.27
Returns all arc and track objects that have a Width property which is less than 1.27mm.

AsMM(TraceLength) = 1
Returns all arc and track objects that have a Length which is equal to 1mm.

Note - due to an issue in the software, to correctly detect the TraceLength using the AsMM keyword the board units must be set to mils before running the query.

ComponentInLayerClass

Summary

Returns all component objects whose Layer property matches a layer that is a member of the specified Layer Class.

Syntax

ComponentInLayerClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined layer classes, by name, is presented.

Example Usage

ComponentInLayerClass('TopSide') ComponentInLayerClass('TopSide') = True ComponentInLayerClass('TopSide') = 'True'
Returns all component objects whose Layer property matches a layer that is a member of the TopSide Layer Class.

Not ComponentInLayerClass('BottomSide') ComponentInLayerClass('BottomSide') = False ComponentInLayerClass('BottomSide') = 'False'
Returns all objects except component objects whose Layer property matches a layer that is a member of the BottomSide Layer Class.

Notes

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

ExistsOnLayer

Summary

Returns all objects that exist on the specified layer.

Syntax

ExistsOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

ExistsOnLayer('Top Layer') ExistsOnLayer('Top Layer') = True ExistsOnLayer('Top Layer') = 'True'
Returns all objects that exist on the Top Layer.

Not ExistsOnLayer('Mechanical 3') ExistsOnLayer('Mechanical 3') = False ExistsOnLayer('Mechanical 3') = 'False'
Returns all objects except objects that exist on the Mechanical 3 layer.

Notes

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

HasFootprint

Summary

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

Syntax

HasFootprint(Footprint : String) : Boolean/Boolean_String

Example Usage

HasFootprint('SIP?0') HasFootprint('SIP?0') = True HasFootprint('SIP?0') = 'True'
Returns all component objects whose Footprint property starts with SIP and finishes with 0, and includes one other intermediate character. Example compliant footprints include SIP10, SIP20, and SIPQ0.

HasFootprint('DIP*') HasFootprint('DIP*') = True HasFootprint('DIP*') = 'True'
Returns all component objects whose Footprint property starts with DIP. Example compliant footprints include DIP8, DIP14, and DIP24N.

Not HasFootprint('IDC16') HasFootprint('IDC16') = False HasFootprint('IDC16') = 'False'
Returns all objects except component objects whose Footprint property is IDC16.

HasFootprint('*2*') HasFootprint('*2*') = True HasFootprint('*2*') = 'True'
Returns all component objects whose Footprint property includes the character 2. Example compliant footprints include 2012, 2N5001, IDC20, and HDR1X2.

Notes

The single quote characters (') at the start and end of the Footprint string are mandatory.
For each returned component object, its associated child objects are also returned.

HasFootprintPad

Summary

Returns all pad objects that are children of component objects with the specified Footprint, and where the pad's Name property complies with the Query.

Syntax

HasFootprintPad(Footprint : String,Name : String) : Boolean/Boolean_String

Example Usage

Not HasFootprintPad('0805','1') HasFootprintPad('0805','1') = False HasFootprintPad('0805','1') = 'False'
Returns all objects except pad objects whose Name property is 1, and which are child objects of component objects whose Footprint property is 0805.

HasFootprintPad('SIP?0','1') HasFootprintPad('SIP?0','1') = True HasFootprintPad('SIP?0','1') = 'True'
Returns all pad objects whose Name property is 1, and which are child objects of component objects whose Footprint property starts with SIP, finishes with 0, and includes one other intermediate character. Example compliant footprints include SIP10, SIP20, SIPQ0.

HasFootprintPad('DB*','MNT') HasFootprintPad('DB*','MNT') = True HasFootprintPad('DB*','MNT') = 'True'
Returns all pad objects whose Name property is MNT, and which are child objects of component objects whose Footprint property starts with DB. Example compliant footprints include DB9S, DB15HD, DB25P.

HasFootprintPad('','MN*') HasFootprintPad('','MN*') = True HasFootprintPad('','MN*') = 'True'
Returns all pad objects whose Name property starts with MN, and which are child objects of any component object.

Notes

The single quote characters (') at the start and end of the Footprint and Name strings are mandatory.
The parent component objects are not returned.

HasMaskExpansionOnLayer

Summary

Returns all arc, fill, pad, region, track, and via objects that have Paste Mask Expansion (except via), or Solder Mask Expansion values, defined for the specified layer. Values may be defined manually, or taken from the applicable defined design rule.

Syntax

HasMaskExpansionOnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer, as it appears in the applicable Layers section, on the Layers & Colors tab of the View Configuration panel.

Example Usage

HasMaskExpansionOnLayer('Top Layer') HasMaskExpansionOnLayer('Top Layer') = True HasMaskExpansionOnLayer('Top Layer') = 'True'
Returns all arc, fill, pad, region, track, and via objects that have Paste Mask Expansion (except via), or Solder Mask Expansion values, defined for the Top Layer.

Not HasMaskExpansionOnLayer('Bottom Layer') HasMaskExpansionOnLayer('Bottom Layer') = False HasMaskExpansionOnLayer('Bottom Layer') = 'False'
Returns all objects except arc, fill, pad, region, track, and via objects that have Paste Mask Expansion (except via), or Solder Mask Expansion values, defined for the Bottom Layer.

Notes

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

HasPad

Summary

Returns all pad objects whose full name property complies with the Query.

Syntax

HasPad(PadName : String) : Boolean/Boolean_String

The 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

Not HasPad('C14-1') HasPad('C14-1') = False HasPad('C14-1') = 'False'
Returns all objects except the pad object whose Name property is 1, and which is a child object of the component object whose Name property is C14.

HasPad('U5-11') HasPad('U5-11') = True HasPad('U5-11') = 'True'
Returns the pad object whose Name property is 11, and which is a child object of the component object whose Name property is U5.

HasPad('U*-11') HasPad('U*-11') = True HasPad('U*-11') = 'True'
Returns all pad objects whose Name property is 11, and which are child objects of component objects whose Name property starts with U.

HasPad('*-1*') HasPad('*-1*') = True HasPad('*-1*') = 'True'
Returns all pad objects whose Name property starts with 1, and which are child objects of any component object.

Notes

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

HasViaFeature

Summary

Returns all via objects whose via feature property complies with the Query.

Syntax

HasViaFeature(ViaFeature : String) : Boolean/Boolean_String

The ViaFeature string specifies the via feature that a via has to match; this can be one of the following:

Capping
Covering
Filling
Plugging
Tenting

Example Usage

Not HasViaFeature('Capping') HasViaFeature('Capping') = False HasViaFeature('Capping') = 'False'
Returns all objects except the via object whose via feature property is Capping.

HasViaFeature('Covering') HasViaFeature('Covering') = True HasViaFeature('Covering') = 'True'
Returns the via object whose via feature property is Covering.

Note

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

HasViaType

Summary

Returns all via objects whose via type property complies with the Query.

Syntax

HasViaType(ViaType : String) : Boolean/Boolean_String

The ViaType string specifies the IPC 4761 Via Type property that a via has to match; this can be one of the following:

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

Not HasViaFeature('Capping') HasViaFeature('Capping') = False HasViaFeature('Capping') = 'False'
Returns all objects except the via object whose via feature property is Capping.

HasViaFeature('Covering') HasViaFeature('Covering') = True HasViaFeature('Covering') = 'True'
Returns the via object whose via feature property is Covering.

Note

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

InChannelClass

Summary

Returns all objects associated with component objects that are members of the specified Design Channel Class.

Syntax

InChannelClass(ClassName1 : String,ClassName2 : String,...,ClassNamen : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined design channel classes, by name, is presented.

Example Usage

InChannelClass('Red_LED') InChannelClass('Red_LED') = True InChannelClass('Red_LED') = 'True'
Returns all objects associated with component objects that are members of the Red_LED Design Channel Class.

InChannelClass('Output channel','Input channel') InChannelClass('Output channel','Input channel') = True InChannelClass('Output channel','Input channel') = 'True'
Returns all objects associated with component objects that are members of either the Output channel or Input channel Design Channel Classes.

InChannelClass('Input*') InChannelClass('Input*') = True InChannelClass('Input*') = 'True'
Returns all objects associated with component objects that are members of any Design Channel Class whose Name property starts with Input.

Notes

The single quote characters (') at the start and end of each ClassName string are mandatory.
The parent component objects are also returned.

InComponent

Summary

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

Syntax

InComponent(Name : String) : Boolean/Boolean_String

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

Example Usage

InComponent('U1') InComponent('U1') = True InComponent('U1') = 'True'
Returns all component objects whose Name property is U1.

InComponent('U1', 'U2', 'J1') InComponent('U1', 'U2', 'J1') = True InComponent('U1', 'U2', 'J1') = 'True'
Returns all component objects whose Name property is U1, or U2, or J1.

Not InComponent('IDC16') InComponent('IDC16') = False InComponent('IDC16') = 'False'
Returns all objects except component objects whose Name property is IDC16.

InComponent('U*') InComponent('U*') = True InComponent('U*') = 'True'
Returns all component objects whose Name property starts with U.

Notes

The single quote characters (') at the start and end of the Name string are mandatory.
For each returned component object, its associated child objects are also returned.

InComponentClass

Summary

Returns all component objects that are members of the specified Component Class.

Syntax

InComponentClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined component classes, by name, is presented.

Example Usage

InComponentClass('TopSideSMD') InComponentClass('TopSideSMD') = True InComponentClass('TopSideSMD') = 'True'
Returns all component objects that are members of the TopSideSMD Component Class.

Not InComponentClass('BottomSideSMD') InComponentClass('BottomSideSMD') = False InComponentClass('BottomSideSMD') = 'False'
Returns all objects except component objects that are members of the BottomSideSMD Component Class.

Notes

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

InDifferentialPair

Summary

Returns all objects associated with differential pair objects whose Name property complies with the Query.

Syntax

InDifferentialPair(DifferentialPairName1 : String,DifferentialPair2 : String,...,DifferentialPairn : String) : Boolean/Boolean_String

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

Example Usage

InDifferentialPair('Red_LED') InDifferentialPair('Red_LED') = True InDifferentialPair('Red_LED') = 'True'
Returns all objects associated with the differential pair object whose Name property is Red_LED.

InDifferentialPair('D0','D1')
InDifferentialPair('D0','D1') = True
InDifferentialPair('D0','D1') = 'True'
Returns all objects associated with differential pair objects whose Name property is either D0 or D1.

InDifferentialPair('Input*')
InDifferentialPair('Input*') = True
InDifferentialPair('Input*') = 'True'
Returns all objects associated with differential pair objects whose Name property starts with Input.

Notes

The single quote characters (') at the start and end of each DifferentialPairName string are mandatory.
The parent differential pair objects are also returned.

InDifferentialPairClass

Summary

Returns all differential pair objects that are members of the specified Differential Pair Class.

Syntax

InDifferentialPairClass(ClassName : String) : Boolean/Boolean_String

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

Example Usage

InDifferentialPairClass('TopSide') InDifferentialPairClass('TopSide') = True InDifferentialPairClass('TopSide') = 'True'
Returns all differential pair objects that are members of the TopSide Differential Pair Class.

Not InDifferentialPairClass('BottomSide') InDifferentialPairClass('BottomSide') = False InDifferentialPairClass('BottomSide') = 'False'
Returns all objects except differential pair objects that are members of the BottomSide Differential Pair Class.

Notes

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

InDrillLayerPair

Summary

Returns all via objects whose Drill Pair property matches the specified Drill Layer Pair.

Syntax

InDrillLayerPair(LayerPair : String) : Boolean/Boolean_String

Example Usage

InDrillLayerPair('Top Layer - Bottom Layer') InDrillLayerPair('Top Layer - Bottom Layer') = True InDrillLayerPair('Top Layer - Bottom Layer') = 'True'
Returns all via objects whose Drill Pair property matches the Top Layer - Bottom Layer Drill Layer Pair.

Not InDrillLayerPair('Top Layer - Signal Layer 1') InDrillLayerPair('Top Layer - Signal Layer 1') = False InDrillLayerPair('Top Layer - Signal Layer 1') = 'False'
Returns all objects except via objects whose Drill Pair property matches the Top Layer - Signal Layer 1 Drill Layer Pair.

Notes

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

InFromTo

Summary

Returns all objects associated with a from-to object whose Net , From Pad, and To Pad properties comply with the Query.

Syntax

InFromTo('Net_Name (From_Pad : To_Pad)') : Boolean/Boolean_String

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

Net_Name, From_Pad, and To_Pad are all strings; the only single quote characters (') used are those depicted above (immediately within the outermost pair of brackets).

Each of the From_Pad and To_Pad strings 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

InFromTo('VDD_XTAL (C13-2 : U1-8)') InFromTo('VDD_XTAL (C13-2 : U1-8)') = True InFromTo('VDD_XTAL (C13-2 : U1-8)') = 'True'
Returns all objects associated with a from-to object whose Net property is VDD_XTAL, From Pad property is C13-2, and To Pad property is U1-8. (As such, the From Pad has a Name property of 2, and its parent component object has a Name property of C13. Similarly, the To Pad has a Name property of 8, and its parent component object has a Name property of U1).

Notes

The parent from-to objects are also returned.

InFromToClass

Summary

Returns all from-to objects that are members of the specified From To Class.

Syntax

InFromToClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined from to classes, by name, is presented.

Example Usage

InNet('Red_LED') InNet('Red_LED') = True InNet('Red_LED') = 'True'
Returns all objects associated with the Net object whose Name property is Red_LED.

InNet('D0','D1')
InNet('D0','D1') = True
InNet('D0','D1') = 'True'
Returns all objects associated with Net objects whose Name property is either D0 or D1.

InNet('V*')
InNet('V*') = True
InNet('V*') = 'True'
Returns all objects associated with Net objects whose Name property starts with V.

Notes

The single quote characters (') at the start and end of each NetName string are mandatory.
The parent Net objects are also returned.

InRegion

Summary

Returns all objects that reside within the area specified by the Query.

Syntax

InRegion(X1 : Number ,Y1 : Number ,X2 : Number ,Y2 : Number) : Boolean/Boolean_String

X1,Y1 and X2,Y2 specify coordinates in the PCB (Library) file. The left and right boundaries of the region are specified by the X1 and X2 parameters, while the lower and upper boundaries of the region are specified by the Y1 and Y2 parameters.

All coordinates are referenced to the absolute origin (and not to the user origin or component insertion point), and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

InRegion(12700,4700,13300,5000) InRegion(12700,4700,13300,5000) = True InRegion(12700,4700,13300,5000) = 'True'
Returns objects residing within the rectangular region bounded by X1 = 12700 and X2 = 13300, and by Y1 = 4700 and Y2 = 5000; those coordinates are referenced to the absolute origin.

Notes

Parent component, coordinate, dimension, and Net objects are not returned.
This keyword is an alias for the InRegionAbsolute keyword.

InRegionAbsolute

Summary

Returns all objects that reside within the area specified by the Query.

Syntax

InRegionAbsolute(X1 : Number ,Y1 : Number ,X2 : Number ,Y2 : Number) : Boolean/Boolean_String

All coordinates are referenced to the absolute origin (and not to the user origin or component insertion point), and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

InRegionAbsolute(12700,4700,13300,5000) InRegionAbsolute(12700,4700,13300,5000) = True InRegionAbsolute(12700,4700,13300,5000) = 'True'
Returns objects residing within the rectangular region bounded by X1 = 12700 and X2 = 13300, and by Y1 = 4700 and Y2 = 5000; those coordinates are referenced to the absolute origin.

Notes

Parent component, coordinate, dimension, and Net objects are not returned.
This keyword is an alias for the InRegion keyword.

InRegionRelative

Summary

Returns all objects that reside within the area specified by the Query.

Syntax

InRegionRelative(X1 : Number ,Y1 : Number ,X2 : Number ,Y2 : Number) : Boolean/Boolean_String

All coordinates are referenced to the user origin (PCB files) or component insertion point (PCB Library files), rather than to the absolute origin, and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

InRegionRelative(-700,-400,1300,1600) InRegionRelative(-700,-400,1300,1600) = True InRegionRelative(-700,-400,1300,1600) = 'True'
Returns objects residing within the rectangular region bounded by X1 = -700 and X2 = 1300, and by Y1 = -400 and Y2 = 1600; those coordinates are referenced to the user origin (or component insertion point).

Notes

Parent component, coordinate, dimension, and Net objects are not returned.

InStructureClass

Summary

Returns all parent and child objects of the Component Classes and Net Classes, that are members of the specified Structure Class.

Syntax

InStructureClass(ClassName1 : String,ClassName2 : String,...,ClassNamen : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined structure classes, by name, is presented.

Example Usage

InStructureClass('Red_LED') InStructureClass('Red_LED') = True InStructureClass('Red_LED') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of the Red_LED Structure Class.

InStructureClass('Output channel','Input channel') InStructureClass('Output channel','Input channel') = True InStructureClass('Output channel','Input channel') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of either the Output channel or Input channel Structurel Classes.

InStructureClass('Input*') InStructureClass('Input*') = True InStructureClass('Input*') = 'True'
Returns all parent and child objects of the Component Classes and Net Classes, that are members of any Structure Class whose Name property starts with Input.

Notes

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

InUnion

Summary

Returns all objects (parent and children) that are part of the specified union.

Syntax

InUnion(Union : Number) : Boolean/Boolean_String

Union numbers are automatically assigned. As you define the Query expression, a pop-up list of all existing unions, by number, is presented.

Example Usage

InUnion(1) InUnion(1) = True InUnion(1) = 'True'
Returns all objects (parent and children) that are part of the union whose assigned number is 1.

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

OnGrid

Summary

Returns all objects whose X1 and Y1 properties comply with the Query.

Syntax

OnGrid(X1 : Number,Y1 : Number) : Boolean/Boolean_String

Each instance of Distance_String is a numerical string that specifies a distance in the PCB (Library) file. To be returned, an object's X1 property has to be an integral multiple of the first distance specified, and its Y1 property has to be an integral multiple of the second distance specified.

X1 and Y1 specify coordinates in the PCB (Library) file. To be returned, an object's X1 property has to be an integral multiple of the first value specified, and its Y1 property has to be an integral multiple of the second value specified.

All coordinates are referenced to the absolute origin (and not to the user origin or component insertion point), and at present, all coordinates always use units of mils. (1 mil = 0.001 inch).

Example Usage

OnGrid(25,25) OnGrid(25,25) = True OnGrid(25,25) = 'True'
Returns all objects whose X1 property is an integral multiple of 25mil and whose Y1 property is an integral multiple of 25mil.

OnGrid(5,100) OnGrid(5,100) = True OnGrid(5,100) = 'True'
Returns all objects whose X1 property is an integral multiple of 5mil and whose Y1 property is an integral multiple of 100mil.

OnLayer

Summary

Returns all objects whose Layer property complies with the Query.

Syntax

OnLayer(Layer : String) : Boolean/Boolean_String

Layer is the name of the layer as it appears on the Layers & Colors tab of the View Configuration panel.

Example Usage

OnLayer('Top Layer') OnLayer('Top Layer') = True OnLayer('Top Layer') = 'True'
Returns all objects whose Layer property is Top Layer.

Not OnLayer('Mechanical 3') OnLayer('Mechanical 3') = False OnLayer('Mechanical 3') = 'False'
Returns all objects except objects whose Layer property is Mechanical 3 layer.

Notes

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

TouchesRoom

Summary

Returns objects that either totally or partially reside within the region occupied by any room object (confinement constraint rule) whose Name property complies with the Query.

Syntax

TouchesRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String

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

Example Usage

TouchesRoom('Power') TouchesRoom('Power') = True TouchesRoom('Power') = 'True'
Returns objects that either totally or partially reside within the region occupied by any Room whose Name property is Power.

TouchesRoom('COUT1','COUT2') TouchesRoom('COUT1','COUT2') = True TouchesRoom('COUT1','COUT2') = 'True'
Returns objects that either totally or partially reside within the regions occupied by any Rooms whose Name property is either COUT1 or COUT2.

TouchesRoom('Monitor','Auxilary','Effects') TouchesRoom('Monitor','Auxilary','Effects') = True TouchesRoom('Monitor','Auxilary','Effects') = 'True'
Returns objects that either totally or partially reside within the regions occupied by any Rooms whose Name property is Monitor, or Auxilary, or Effects.

Notes

The single quote characters (') at the start and end of each RoomName string are mandatory.
Parent coordinate, dimension, and Net objects are not returned.

WithinRoom

Summary

Returns objects that totally reside within the region occupied by any room object (confinement constraint rule) whose Name property complies with the Query.

For pads and vias to be returned, their center points must reside within the specified room(s).

Syntax

WithinRoom(RoomName1 : String,RoomName2 : String,...,RoomNamen : String) : Boolean/Boolean_String

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

Example Usage

WithinRoom('Power')
WithinRoom('Power') = True
WithinRoom('Power') = 'True'
Returns objects that totally reside within the region occupied by any Room whose Name property is Power.

WithinRoom('COUT1','COUT2')
WithinRoom('COUT1','COUT2') = True
WithinRoom('COUT1','COUT2') = 'True'
Returns objects that totally reside within the regions occupied by any Rooms whose Name property is either COUT1 or COUT2.

WithinRoom('Monitor','Auxilary','Effects')
WithinRoom('Monitor','Auxilary','Effects') = True
WithinRoom('Monitor','Auxilary','Effects') = 'True'
Returns objects that totally reside within the regions occupied by any Rooms whose Name property is Monitor, or Auxilary, or Effects.

Notes

The single quote characters (') at the start and end of each RoomName string are mandatory.
Parent coordinate, dimension, and Net objects are not returned.

Not IsComponentVia
IsComponentVia = False
Returns all objects except via objects which are children of component objects.

IsConnection

Summary

Returns all connection lines.

Note that the returned connections are displayed in the design space, but no objects of this type are presented in the PCB List panel.

Syntax

IsConnection : Boolean/Boolean_String

Example Usage

IsConnection IsConnection = True IsConnection = 'True'
Returns all connection lines.

Not IsConnection IsConnection = False IsConnection = 'False'
Returns all objects AND connection lines. The "connection" details are also displayed, because they are (un-listed) child objects of Net objects, which are returned by this Query.

Not IsConnection And Not IsNet
(IsConnection = False) And (IsNet = False)
Returns all objects except for Net objects; the "connection" details are not displayed, because they are (un-listed) child objects of Net objects, and no Net objects are returned by this Query.

IsCoordinate

Summary

Returns coordinate objects.

Syntax

IsCoordinate : Boolean

Example Usage

IsCoordinate
IsCoordinate = True
Returns all coordinate objects.

Not IsCoordinate
IsCoordinate = False
Returns all objects except coordinate objects.

IsCopperRegion

Summary

Returns solid region objects – regions that do not have their Kind property set to Polygon cutout or Board cutout (which would make them Polygon Cutout or Board Cutout regions respectively).

Polygon pours that have their Fill Mode set to Solid (Copper Regions) will also be returned.

Syntax

IsCopperRegion : Boolean

Example Usage

IsCopperRegion
IsCopperRegion = True
Returns all solid region objects.

Not IsCopperRegion
IsCopperRegion = False
Returns all objects except solid region objects.

IsCutoutRegion

Summary

Summary

Summary

Returns all objects whose Object Kind property matches the specified type of object.

Syntax

IsObjectKind(ObjectType : String) : Boolean/Boolean_String

ObjectType 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

IsObjectKind('Via') IsObjectKind('Via') = True IsObjectKind('Via') = 'True'
Returns all via objects.

Not IsObjectKind('Track') IsObjectKind('Track') = False IsObjectKind('Track') = 'False'
Returns all objects except track objects.

Notes

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

IsPoly
IsPoly = True
Returns all polygon pour objects.

Not IsPoly
IsPoly = False
Returns all objects except polygon pour objects.

Notes

This function is an alias for the IsPolygon function.
When defining an Electrical Clearance rule for polygon pours, you must use the InPolygon (or InPoly) attribute check, rather than the IsPolygon (or IsPoly) object type check. This is because the clearance rules operate on the primitives (regions, tracks and arcs) that make up, or are in the polygon pour, rather than the polygon pour as a whole object. A valid clearance rule for polygon pours would be between InPolygon objects and All other objects.

IsPolygon

Summary

Returns polygon pour objects.

Syntax

IsPolygon : Boolean

Example Usage

IsPolygon
IsPolygon = True
Returns all polygon pour objects.

Not IsPolygon
IsPolygon = False
Returns all objects except polygon pour objects.

Notes

This function is an alias for the IsPoly function.
When defining an Electrical Clearance rule for polygon pours, you must use the InPolygon (or InPoly) attribute check, rather than the IsPolygon (or IsPoly) object type check. This is because the clearance rules operate on the primitives (regions, tracks and arcs) that make up, or are in the polygon pour, rather than the polygon pour as a whole object. A valid clearance rule for polygon pours would be between InPolygon objects and All other objects.

Returns all region objects – solid regions, polygon cutout regions and board cutout regions.

Polygon pours that have their Fill Mode set to Solid (Copper Regions) will also be returned.

Syntax

IsRegion : Boolean

Example Usage

IsRegion
IsRegion = True
Returns all region objects.

Not IsRegion
IsRegion = False
Returns all objects except region objects.

IsRoom

Summary

Returns Room Definition rule (Confinement Constraint Rule) objects.

Syntax

IsRoom : Boolean/Boolean_String

Example Usage

IsRoom
IsRoom= True
IsRoom= 'True'
Returns all Room Definition rule objects.

Not IsRoom
IsRoom= False IsRoom= 'False'
Returns all objects except Room Definition rule objects.

IsRule_ConfinementConstraint
IsRule_ConfinementConstraint= True
IsRule_ConfinementConstraint= 'True'
Returns all Room Definition rule objects.

Not IsRule_ConfinementConstraint
IsRule_ConfinementConstraint= False Is Rule_ConfinementConstraint= 'False'
Returns all objects except Room Definition rule objects.

IsViolation
IsViolation = True
Returns all violation objects.

Not IsViolation
IsViolation = False
Returns all objects except violation objects.

Parameters

CompParameterValue

Summary

Returns the string Value of a PCB component Parameter, which can be tested to return PCB components that comply to the Query.

Syntax

CompParameterValue(ParameterName : String) : String

Example Usage

CompParameterValue(‘Design Item Id’) Like 'CAP*'
Returns all components that incorporate the Design Item Id Parameter which has a Value string beginning with CAP, such as CAP-NP-100nF-50V-0805, CAP-P-22uF-10V-MCCT-B, etc. The associated child objects of a complying component object, such as tracks, arcs, pads, text etc, are also returned.

CompParameterValue(‘Design Item Id’) Like '*0805*'
Returns all components and their associated child objects where the Design Item Id Parameter has a Value string which includes 0805.

StrToNumber(CompParameterValue('VoltageRating'),V) > 50
Returns all components and their associated child objects where the VoltageRating Parameter Value is greater than 50 volts. The string Value returned by CompParameterValue is converted to a number for the comparison by the unit-aware StrToNumber function.

ParameterValue(ParameterName : String) : String

Example Usage

ParameterValue(‘Design Item Id’) Like 'CAP*'
Returns all objects with the Design Item Id Parameter that has a Value string beginning with CAP, such as CAP-NP-100nF-50V-0805, CAP-P-22uF-10V-MCCT-B, etc.

ParameterValue(‘Design Item Id’) Like '*0805*'
Returns all objects with the Design Item Id Parameter that has a Value string which includes 0805.

StrToNumber(ParameterValue('VoltageRating'),V) > 50
Returns all objects that have a VoltageRating Parameter Value greater than 50 volts. The string Value returned by ParameterValue is converted to a number for the comparison by the unit-aware StrToNumber function.

StrToNumber

Summary

Converts the nominated Parameter Value string to a number, using the stipulated unit type.

Syntax

StrToNumber(Value : String , Unit : String) : Number

Example Usage

StrToNumber(ParameterValue('VoltageRating'),V) > 50
Converts the Value string returned by the VoltageRating Parameter to a number, using Voltage (V) as the unit, then returns all objects with a Value greater than 50V.

StrToNumber(ParameterValue('Resistance'),Ohms) Between 1000 And 10000
Converts the Value string returned by the Resistance Parameter to a number, using Ohms as the unit, then returns all objects with a Value between 1kΩ and 10kΩ.

StrToNumber(ParameterValue('CapacitanceValue'),F) < 2e-9
Converts the Value string returned by the CapacitanceValue Parameter to a number, using Capacitance (F) as the unit, then returns all objects with a Value less than 2nF (2e-9 in scientific notation).

Notes

A scripting error will be thrown if the Value string cannot be converted to a number. To allow for this situation, use the StrToNumberDef function, which returns a nominated default number if the conversion fails.

The unit-aware string-to-number converter function accepts a large range of Unit type definitions, including:

V – Voltage
A – Current
Ohm – Resistance
Z – Impedance
F – Capacitance
H – Inductance
G – Conductance
W – Power
Hz – Frequency
Q – Charge
C – Temperature
dB – Decibels
% – Percent
m – Length
Kg – Mass
s – Time

The converter accepts standard value scaling factors (micro, kilo, mega etc) and therefore Parameter strings containing prefix abbreviations such as mV, uA, kHz etc.

Several value constructs are also supported. For example, the same resistance value can be represented as:

2k2
2.2k
2200
2,200

StrToNumberDef

Summary

Converts the nominated Parameter Value string to a number, or a default number, using the stipulated unit type.

Syntax

StrToNumber(Value : String , Unit : String , Default : Number) : Number

Example Usage

StrToNumberDef(ParameterValue('VoltageRating'),V,10) > 50
Converts the Value string returned by the VoltageRating Parameter to a number, using Voltage (V) as the unit, then returns all objects with a Value greater than 50V. If the Parameter string or unit is unrecognized (can't be converted), a default value of 10 is returned.

StrToNumberDef(ParameterValue('VoltageRating'),'V',6) Between 10 And 50
Converts the Value string returned by the VoltageRating Parameter to a number, using Voltage (V) as the unit, then returns all objects with a Value rating between 10V and 50V. If the value cannot be read, a voltage of 6V (the defined default value) is assumed.

Notes

The unit-aware string-to-number converter function accepts a large range of Unit type definitions, including:

V – Voltage
A – Current
Ohm – Resistance
Z – Impedance
F – Capacitance
H – Inductance
G – Conductance
W – Power
Hz – Frequency
Q – Charge
C – Temperature
dB – Decibels
% – Percent
m – Length
Kg – Mass
s – Time

The converter accepts standard value scaling factors (micro, kilo, mega etc) and therefore Parameter strings containing prefix abbreviations such as mV, uA, kHz etc.

Several value constructs are also supported. For example, the same resistance value can be represented as:

2k2
2.2k
2200
2,200