Altium Designer Documentation

PCB Layout Query Functions in Altium Designer

Created: July 13, 2021 | Updated: November 23, 2021
All Contents

Parent page: Working with the Query Language

PCB query functions shown in the Query Helper dialog
PCB query functions shown in the Query Helper dialog

Underlying Altium Designer'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 Designer. 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.

Attribute Checks

Summary

Returns component objects whose count of "big" columns of pads complies with the Query. In this context, each "big" column of pads contains at least four pads.

Syntax

BigColumnCount : Number

Example Usage

BigColumnCount = 8
Returns all components that have exactly 8 'big' columns of pads.

BigColumnCount Between 6 And 10
Returns all component objects that have between 6 and 10 'big' columns of pads.

BigColumnCount <= 4
Returns all objects except component objects that have more than 4 'big' columns of pads.

Tip

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

Summary

Returns component objects whose count of "big" rows of pads complies with the Query. In this context, each "big" row of pads contains at least four pads.

Syntax

BigRowCount : Number

Example Usage

BigRowCount = 8
Returns all components that have exactly 8 'big' rows of pads.

BigRowCount Between 6 And 10
Returns all component objects that have between 6 and 10 'big' rows of pads.

BigRowCount <= 4
Returns all objects except component objects that have more than 4 'big' rows of pads.

Tip

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

Summary

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

Syntax

ColumnCount : Number

Example Usage

ColumnCount = 8
Returns all components that have exactly 8 columns of pads.

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

ColumnCount < 4
Returns all objects except components that have 4 columns of pads, or more.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Id = 'My Top Side Layers'
Returns the (layer) class object whose Name property is My Top Side Layers.

Id = 'Rule[0mil,0mil]'
Returns all of the design rule objects (as these all have the same identifying string assigned to them).

Id = 'GND (ZZ4-2 : ZZ3-2)'
Returns the from-to object whose Net property is GND, From Pad property is ZZ4-2, and To Pad property is ZZ3-2.

Id = 'Violation[0mil,0mil]'
Returns all of the violation objects (as these all have the same identifying string assigned to them).

Summary

Use this keyword to quickly return all components and their child primitives.

Syntax

InAnyComponent : Boolean/Boolean_String

Example Usage

InAnyComponent
InAnyComponent = True
InAnyComponent = 'True'

Returns all component objects and their associated primitives.

Not InAnyComponent
InAnyComponent = False
InAnyComponent = 'False'

Returns all objects except component objects and their associated primitives.

Summary

Use this keyword to quickly return all differential pair objects and their associated primitives.

Syntax

InAnyDifferentialPair : Boolean/Boolean_String

Example Usage

InAnyDifferentialPair
InAnyDifferentialPair = True
InAnyDifferentialPair = 'True'

Returns all differential pair objects and their associated primitives.

Not InAnyDifferentialPair
InAnyDifferentialPair = False
InAnyDifferentialPair = 'False'

Returns all objects except differential pair objects and their associated primitives.

Summary

Use this keyword to quickly return all nets and their associated primitives (i.e. design objects that have a Net property).

Syntax

InAnyNet : Boolean/Boolean_String

Example Usage

InAnyNet
InAnyNet = True
InAnyNet = 'True'

Returns all nets and their associated primitives.

Not InAnyNet
InAnyNet = False
InAnyNet = 'False'

Returns all objects except nets and their associated primitives.

Summary

Use this keyword to quickly return all objects associated with all xSignals defined for the design.

Syntax

InAnyxSignal : Boolean/Boolean_String

Example Usage

InAnyxSignal
InAnyxSignal = True
InAnyxSignal = 'True'

Returns all objects associated with all xSignals defined for the design.

Not InAnyxSignal
InAnyxSignal = False
InAnyxSignal = 'False'

Returns all objects except objects associated with xSignals defined for the design.

Summary

Returns child objects of components that are of a BGA nature. Such a component contains at least 10 rows of pads and at least 10 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 all of the pads are of a surface-mount nature.

Syntax

InBGA : Boolean/Boolean_String

Example Usage

InBGA
InBGA = True
InBGA = 'True'

Returns all associated child primitives of BGA components.

Not InBGA
InBGA = False
InBGA = 'False'

Returns all objects except the associated child primitives of BGA components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InDIP : Boolean/Boolean_String

Example Usage

InDIP
InDIP = True
InDIP = 'True'

Returns all associated child primitives of DIP components.

Not InDIP
InDIP = False
InDIP = 'False'

Returns all objects except the associated child primitives of DIP components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InEdgeConnector : Boolean/Boolean_String

Example Usage

InEdgeConnector
InEdgeConnector = True
InEdgeConnector = 'True'

Returns all associated child primitives of Edge Connector components.

Not InEdgeConnector
InEdgeConnector = False
InEdgeConnector = 'False'

Returns all objects except the associated child primitives of Edge Connector components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InLCC : Boolean/Boolean_String

Example Usage

InLCC
InLCC = True
InLCC = 'True'

Returns all associated child primitives of LCC components.

Not InLCC
InLCC = False
InLCC = 'False'

Returns all objects except the associated child primitives of LCC components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InPGA : Boolean/Boolean_String

Example Usage

InPGA
InPGA = True
InPGA = 'True'

Returns all associated child primitives of PGA components.

Not InPGA
InPGA = False
InPGA = 'False'

Returns all objects except the associated child primitives of PGA components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Use this keyword to quickly return all polygon pours and their child primitives.

Syntax

InPoly : Boolean/Boolean_String

Example Usage

InPoly
InPoly = True
InPoly = 'True'

Returns all polygon pours and their child primitives.

Not InPoly
InPoly = False
InPoly = 'False'

Returns all objects except polygon pours and their child primitives.

Tip

  • This function is an alias for the InPolygon function.
  • Only polygon pours placed on signal layers are returned.

Summary

Use this keyword to quickly return all polygon pours and their child primitives.

Syntax

InPolygon : Boolean/Boolean_String

Example Usage

InPolygon
InPolygon = True
InPolygon = 'True'

Returns all polygon pours and their child primitives.

Not InPolygon
InPolygon = False
InPolygon = 'False'

Returns all objects except polygon pours and their child primitives.

Tip

  • This function is an alias for the InPoly function.
  • Only polygon pours placed on signal layers are returned.

Summary

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

Syntax

InSIP : Boolean/Boolean_String

Example Usage

InSIP
InSIP = True
InSIP = 'True'

Returns all associated child primitives of SIP components.

Not InSIP
InSIP = False
InSIP = 'False'

Returns all objects except the associated child primitives of SIP components.

Tip

  • The parent component objects are not returned by this Query.

Summary

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

Syntax

InSMSIP : Boolean/Boolean_String

Example Usage

InSMSIP
InSMSIP = True
InSMSIP = 'True'

Returns all associated child primitives of SMSIP components.

Not InSMSIP
InSMSIP = False
InSMSIP = 'False'

Returns all objects except the associated child primitives of SMSIP components.

Tip

  • The parent component objects are not returned by this Query.

Summary

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

Syntax

InSMTComponent : Boolean/Boolean_String

Example Usage

InSMTComponent
InSMTComponent = True
InSMTComponent = 'True'

Returns all associated child primitives of SMT components.

Not InSMTComponent
InSMTComponent = False
InSMTComponent = 'False'

Returns all objects except the associated child primitives of SMT components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InSOIC : Boolean/Boolean_String

Example Usage

InSOIC
InSOIC = True
InSOIC = 'True'

Returns all associated child primitives of SOIC components.

Not InSOIC
InSOIC = False
InSOIC = 'False'

Returns all objects except the associated child primitives of SOIC components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns child objects of 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

InThruComponent : Boolean/Boolean_String

Example Usage

InThruComponent
InThruComponent = True
InThruComponent = 'True'

Returns all associated child primitives of Thru-Hole components.

Not InThruComponent
InThruComponent = False
InThruComponent = 'False'

Returns all objects except the associated child primitives of Thru-Hole components.

Tip

  • The parent component objects are not returned by this Query.

Summary

Returns components that are of a BGA nature. Such a component contains at least 10 rows of pads and at least 10 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 all of the pads are of a surface-mount nature.

Syntax

IsBGA : Boolean/Boolean_String

Example Usage

IsBGA
IsBGA = True
IsBGA = 'True'

Returns all BGA components.

Not IsBGA
IsBGA = False
IsBGA = 'False'

Returns all objects except BGA components.

Tip

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

Summary

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

Syntax

IsComponentPrimitive : Boolean/Boolean_String

Example Usage

IsComponentPrimitive
IsComponentPrimitive = True
IsComponentPrimitive = 'True'

Returns all child primitives of component objects.

Not IsComponentPrimitive
IsComponentPrimitive = False
IsComponentPrimitive = 'False'

Returns all objects except child primitives of component objects.

Summary

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

Syntax

IsComponentSelected : Boolean/Boolean_String

Example Usage

IsComponentSelected
IsComponentSelected = True
IsComponentSelected = 'True'

Returns all child primitives of currently selected component objects.

Not IsComponentSelected
IsComponentSelected = False
IsComponentSelected = 'False'

Returns all objects except child primitives of currently selected component objects.

Summary

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

Syntax

IsDIP : Boolean/Boolean_String

Example Usage

IsDIP
IsDIP = True
IsDIP = 'True'

Returns all DIP components.

Not IsDIP
IsDIP = False
IsDIP = 'False'

Returns all objects except DIP components.

Tip

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

Summary

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

Syntax

IsEdgeConnector : Boolean/Boolean_String

Example Usage

IsEdgeConnector
IsEdgeConnector = True
IsEdgeConnector = 'True'

Returns all Edge Connector components.

Not IsEdgeConnector
IsEdgeConnector = False
IsEdgeConnector = 'False'

Returns all objects except Edge Connector components.

Tip

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

Summary

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

Syntax

IsElectrical : Boolean/Boolean_String

Example Usage

IsElectrical
IsElectrical = True
IsElectrical = 'True'

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

Not IsElectrical
IsElectrical = False
IsElectrical = 'False'

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

Summary

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

Syntax

IsFree : Boolean/Boolean_String

Example Usage

IsFree
IsFree = True
IsFree = 'True'

Returns all free design objects.

Not IsFree
IsFree = False
IsFree = 'False'

Returns all objects except free design objects.

Summary

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

Syntax

IsGraphicalComponent : Boolean/Boolean_String

Example Usage

IsGraphicalComponent
IsGraphicalComponent = True
IsGraphicalComponent = 'True'

Returns all component objects whose Component Type property is set to Graphical.

Not IsGraphicalComponent
IsGraphicalComponent = False
IsGraphicalComponent = 'False'

Returns all objects except component objects whose Component Type property is set to Graphical.

Tip

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

Summary

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

Syntax

IsHorizontal : Boolean/Boolean_String

Example Usage

IsHorizontal
IsHorizontal = True
IsHorizontal = 'True'

Returns all horizontal tracks.

Not IsHorizontal
IsHorizontal = False
IsHorizontal = 'False'

Returns all objects except horizontal tracks.

Summary

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

Syntax

IsJumperComponent : Boolean/Boolean_String

Example Usage

IsJumperComponent
IsJumperComponent = True
IsJumperComponent = 'True'

Returns all component objects whose Component Type property is set to Jumper.

Not IsJumperComponent
IsJumperComponent = False
IsJumperComponent = 'False'

Returns all objects except component objects whose Component Type property is set to Jumper.

Tip

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

Summary

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

Syntax

IsKeepOut : Boolean/Boolean_String

Example Usage

IsKeepOut
IsKeepOut = True
IsKeepOut = 'True'

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

Not IsKeepOut
IsKeepOut = False
IsKeepOut = 'False'

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

Summary

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

Syntax

IsLCC : Boolean/Boolean_String

Example Usage

IsLCC
IsLCC = True
IsLCC = 'True'

Returns all LCC components.

Not IsLCC
IsLCC = False
IsLCC = 'False'

Returns all objects except LCC components.

Tip

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

Summary

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

Syntax

IsLinkedToAnyPadViaLibrary : Boolean/Boolean_String

Example Usage

IsLinkedToAnyPadViaLibrary
IsLinkedToAnyPadViaLibrary = True
IsLinkedToAnyPadViaLibrary = 'True'

Returns all pad and via objects that are linked to any Pad Via Library.

Not IsLinkedToAnyPadViaLibrary
IsLinkedToAnyPadViaLibrary = False
IsLinkedToAnyPadViaLibrary = 'False'

Returns all objects except pad and via objects that are linked to any Pad Via Library.

Summary

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

Syntax

IsLinkedToPadViaLibrary(PadViaLibraryName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaLibrary('ExamplePVLib.PvLib')
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = True
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'True'

Returns all pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Not IsLinkedToPadViaLibrary('ExamplePVLib.PvLib')
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = False
IsLinkedToPadViaLibrary('ExamplePVLib.PvLib') = 'False'

Returns all objects except pad and via objects that are linked to the Pad Via Library ExamplePVLib.PvLib.

Tip

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

Summary

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

Syntax

IsLinkedToPadViaTemplate(TemplateName : String) : Boolean/Boolean_String

Example Usage

IsLinkedToPadViaTemplate('c152hn127')
IsLinkedToPadViaTemplate('c152hn127') = True
IsLinkedToPadViaTemplate('c152hn127') = 'True'

Returns all pad objects that use the pad template c152hn127.

Not IsLinkedToPadViaTemplate('v127h71')
IsLinkedToPadViaTemplate('v127h71') = False
IsLinkedToPadViaTemplate('v127h71') = 'False'

Returns all objects except via objects that use the via template v127h71.

Tip

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

Summary

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

Syntax

IsMechanicalComponent : Boolean/Boolean_String

Example Usage

IsMechanicalComponent
IsMechanicalComponent = True
IsMechanicalComponent = 'True'

Returns all component objects whose Component Type property is set to Mechanical.

Not IsMechanicalComponent
IsMechanicalComponent = False
IsMechanicalComponent = 'False'

Returns all objects except component objects whose Component Type property is set to Mechanical.

Tip

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

Summary

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

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

Tip

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

Summary

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

Syntax

IsNetTieComponent : Boolean/Boolean_String

Example Usage

IsNetTieComponent
IsNetTieComponent = True
IsNetTieComponent = 'True'

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

Not IsNetTieComponent
IsNetTieComponent = False
IsNetTieComponent = 'False'

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

Tip

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

Summary

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

Syntax

IsNoBOMComponent : Boolean/Boolean_String

Example Usage

IsNoBOMComponent
IsNoBOMComponent = True
IsNoBOMComponent = 'True'

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

Not IsNoBOMComponent
IsNoBOMComponent = False
IsNoBOMComponent = 'False'

Returns all objects except component objects whose Component Type property is set to Standard (No BOM).

Tip

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

Summary

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

Syntax

IsOblique : Boolean/Boolean_String

Example Usage

IsOblique
IsOblique = True
IsOblique = 'True'

Returns all +/-45 Degree tracks.

Not IsOblique
IsOblique = False
IsOblique = 'False'

Returns all objects except +/-45 Degree tracks.

Summary

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

Syntax

IsObliqueNegative : Boolean/Boolean_String

Example Usage

IsObliqueNegative
IsObliqueNegative = True
IsObliqueNegative = 'True'

Returns all -45 Degree tracks.

Not IsObliqueNegative
IsObliqueNegative = False
IsObliqueNegative = 'False'

Returns all objects except -45 Degree tracks.

Summary

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

Syntax

IsObliquePositive : Boolean/Boolean_String

Example Usage

IsObliquePositive
IsObliquePositive = True
IsObliquePositive = 'True'

Returns all +45 Degree tracks.

Not IsObliquePositive
IsObliquePositive = False
IsObliquePositive = 'False'

Returns all objects except +45 Degree tracks.

Summary

Returns all pad objects with 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.

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.

Tip

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

Summary

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

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.

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.

Tip

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

Summary

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

Syntax

IsPGA : Boolean/Boolean_String

Example Usage

IsPGA
IsPGA = True
IsPGA = 'True'

Returns all PGA components.

Not IsPGA
IsPGA = False
IsPGA = 'False'

Returns all objects except PGA components.

Tip

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

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.

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.

Tip

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

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.

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.

Tip

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

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.

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.

Tip

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

Summary

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

Syntax

IsSelected : Boolean/Boolean_String

Example Usage

IsSelected
IsSelected = True
IsSelected = 'True'

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

Not IsSelected
IsSelected = False
IsSelected = 'False'

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

Summary

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

Syntax

IsSIP : Boolean/Boolean_String

Example Usage

IsSIP
IsSIP = True
IsSIP = 'True'

Returns all SIP components.

Not IsSIP
IsSIP = False
IsSIP = 'False'

Returns all objects except SIP components.

Tip

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

Summary

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

Syntax

IsSMSIP : Boolean/Boolean_String

Example Usage

IsSMSIP
IsSMSIP = True
IsSMSIP = 'True'

Returns all SMSIP components.

Not IsSMSIP
IsSMSIP = False
IsSMSIP = 'False'

Returns all objects except SMSIP components.

Tip

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

Summary

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

Syntax

IsSMTComponent : Boolean/Boolean_String

Example Usage

IsSMTComponent
IsSMTComponent = True
IsSMTComponent = 'True'

Returns all SMT components.

Not IsSMTComponent
IsSMTComponent = False
IsSMTComponent = 'False'

Returns all objects except SMT components.

Tip

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

Summary

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

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.

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.

Tip

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

Summary

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

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.

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.

Tip

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

Summary

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

Syntax

IsStandardComponent : Boolean/Boolean_String

Example Usage

IsStandardComponent
IsStandardComponent = True
IsStandardComponent = 'True'

Returns all component objects whose Component Type property is set to Standard.

Not IsStandardComponent
IsStandardComponent = False
IsStandardComponent = 'False'

Returns all objects except component objects whose Component Type property is set to Standard.

Tip

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

Summary

Returns all subnet jumper objects.

Syntax

IsSubnetJumper : Boolean/Boolean_String

Example Usage

IsSubnetJumper
IsSubnetJumper = True
IsSubnetJumper = 'True'

Returns all subnet jumper objects.

Not IsSubnetJumper
IsSubnetJumper = False
IsSubnetJumper = 'False'

Returns all objects except subnet jumper objects.

Summary

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

Syntax

IsThruComponent : Boolean/Boolean_String

Example Usage

IsThruComponent
IsThruComponent = True
IsThruComponent = 'True'

Returns all Thru-Hole components.

Not IsThruComponent
IsThruComponent = False
IsThruComponent = 'False'

Returns all objects except Thru-Hole components.

Tip

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

Summary

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

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.

Summary

Returns all design objects placed manually by the user.

Syntax

IsUserRouted : Boolean/Boolean_String

Example Usage

IsUserRouted
IsUserRouted = True
IsUserRouted = 'True'

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

Not IsUserRouted
IsUserRouted = False
IsUserRouted = 'False'

Returns all objects except design objects placed manually by the user.

Summary

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

Syntax

IsVertical : Boolean/Boolean_String

Example Usage

IsVertical
IsVertical = True
IsVertical = 'True'

Returns all vertical tracks.

Not IsVertical
IsVertical = False
IsVertical = 'False'

Returns all objects except vertical tracks.

Summary

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

Syntax

IsWire : Boolean/Boolean_String

Example Usage

IsWire
IsWire = True
IsWire = 'True'

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

Not IsWire
IsWire = False
IsWire = 'False'

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

Summary

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

Syntax

ManHat : Number

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

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

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

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

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

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

Summary

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

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.

Tip

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

Summary

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

Syntax

NetPinCount : Number

Example Usage

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

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

Tip

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

Summary

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

Syntax

NetViaCount : Number

Example Usage

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

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

Tip

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

Summary

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

Syntax

RowCount : Number

Example Usage

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

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

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

Tip

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

Summary

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

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.

Tip

  • This function is an alias for the TraceHeight function.

Summary

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

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

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.

Tip

  • This function is an alias for the TraceCopperHeight function.

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

Summary

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

Syntax

ArcRadius : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tip

The Radius property is only defined for arc objects.

Summary

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

Syntax

ArcStartAngle : Number

The number returned specifies the Start Angle in units of degrees.

Example Usage

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

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

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

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

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

Tip

The Start Angle property is only defined for arc objects.

Summary

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

Syntax

ArcStopAngle : Number

The number returned specifies the Stop Angle in units of degrees.

Example Usage

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

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

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

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

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

Tip

The Stop Angle property is only defined for arc objects.

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.

Tips

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

Summary

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

Syntax

AutoPosition = AutoPosition_String
AutoPosition <> AutoPosition_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

BarCodeFontName = FontName_String
BarCodeFontName <> FontName_String

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

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.

Tips

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

Summary

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

Syntax

BarCodeFullHeight : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

BarCodeFullWidth : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

BarCodeInverted : Boolean_String

Example Usage

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

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

Tips

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

Summary

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

Syntax

BarCodeMinWidth : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

BarCodeRenderMode = RenderMode_String
BarCodeRenderMode <> RenderMode_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

BarCodeShowText : Boolean_String

Example Usage

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

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

Tips

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

Summary

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

Syntax

BarCodeType = CodeType_String
BarCodeType <> CodeType_String

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

  • 'Code 39'
  • 'Code 128'

Example Usage

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

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

Tips

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

Summary

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

Syntax

BarCodeXMargin : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

BarCodeYMargin : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

BodyColor3D : Numeric_String
BodyColor3D : Number

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

Tip

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

Summary

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

Syntax

BodyColor3DOpacity : Numeric_String
BodyColor3DOpacity : Number

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.

Tip

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

Summary

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

Syntax

BodyColor3DOverride : Boolean_String

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

Example Usage

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

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

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

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

Tip

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

Summary

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

Syntax

BodyProjection = BodyProjection_String
BodyProjection <> BodyProjection_String

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

  • 'Top Side'
  • 'Bottom Side'

Example Usage

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

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

Tips

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

Summary

Returns all 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.

Tip

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

Summary

Returns all 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.

Tips

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

Summary

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

Syntax

ClassType = ClassType_String
ClassType <> ClassType_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

Color : Numeric_String
Color : Number

The Color 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.

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

65536 * Blue + 256 * Green + Red

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

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

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

Example Usage

Color = '0'
Color <> '' && Color = 0

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

Color = '16711680'
Color > '' && Color = 16711680

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

Comment : String

Example Usage

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

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

Tips

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

Summary

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

Syntax

Component : String

Example Usage

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

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

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

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

Tip

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

Summary

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

Syntax

ComponentFlippedOnLayer : Boolean_String

Example Usage

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

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

Tip

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

Summary

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

Syntax

ComponentStringsLocked : Boolean_String

Example Usage

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

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

Tip

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

Summary

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

Syntax

ComponentType = ComponentType_String

ComponentType <> ComponentType_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

CoordinateDimensionLineWidth : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

CoordinateDimensionSize : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

CoordinateDimensionUnitStyle = UnitStyle_String
CoordinateDimensionUnitStyle <> UnitStyle_String

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

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

Example Usage

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

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

Tips

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

Summary

Returns all 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.

Tips

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

Summary

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

Syntax

DimensionArrowLength : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionArrowLineWidth : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionArrowPosition = ArrowPosition_String
DimensionArrowPosition <> ArrowPosition_String

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

  • 'Inside'
  • 'Outside'

Example Usage

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

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

Tips

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

Summary

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

Syntax

DimensionArrowSize : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionExtensionLineWidth : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionExtensionOffset : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionExtensionPickGap : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionTextFont = Font_String
DimensionTextFont <> Font_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

DimensionTextFormat = TextFormat_String
DimensionTextFormat <> TextFormat_String

TextFormat_String must be 'None'.

Example Usage

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

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

Tips

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

Summary

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

Syntax

DimensionTextGap : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionTextHeight : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionTextLineWidth : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DimensionTextPosition = DimensionTextPosition_String
DimensionTextPosition <> DimensionTextPosition_String

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

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

Example Usage

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

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

Tips

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

Summary

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

Syntax

DimensionTextPrecision : Numeric_String
DimensionTextPrecision : Number

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.

Tips

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

Summary

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

Syntax

DimensionTextPrefix : String

Example Usage

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

Tips

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

Summary

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

Syntax

DimensionTextSuffix : String

Example Usage

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

Tips

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

Summary

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

Syntax

DimensionTextUnit = DimensionUnit_String
DimensionTextUnit <> DimensionUnit_String

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

  • 'Degrees'
  • 'Radians'

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

DrillPair = 'Start Layer - Stop Layer'

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.

Tips

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

Summary

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

Syntax

DrillType = DrillType_String
DrillType <> DrillType_String

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

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

Example Usage

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

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

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

Tips

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

Summary

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

Syntax

EmbeddedBoard_ColCount : Numeric_String
EmbeddedBoard_ColCount : Number

Example Usage

EmbeddedBoard_ColCount = '2'
EmbeddedBoard_ColCount = 2

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

EmbeddedBoard_ColCount <> '4'
EmbeddedBoard_ColCount <> 4

Returns all objects except embedded board objects whose Col Count property is 4.

Tip

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

Summary

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

Syntax

EmbeddedBoard_ColumnSpacing : Number

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

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

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

Example Usage

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

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

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

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

Tip

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

Summary

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

Syntax

EmbeddedBoard_DocumentName : String

Example Usage

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

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

Tip

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

Summary

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

Syntax

EmbeddedBoard_OriginMode : Boolean_String

Example Usage

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

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

Tip

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

Summary

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

Syntax

EmbeddedBoard_RowCount : Numeric_String
EmbeddedBoard_RowCount : Number

Example Usage

EmbeddedBoard_RowCount = '2'
EmbeddedBoard_RowCount = 2

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

EmbeddedBoard_RowCount <> '4'
EmbeddedBoard_RowCount <> 4

Returns all objects except embedded board objects whose Row Count property is 4.

Tip

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

Summary

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

Syntax

EmbeddedBoard_RowSpacing : Number

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

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

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

Example Usage

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

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

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

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

Tip

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

Summary

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

Syntax

EnablePartSwapping : Boolean_String

Example Usage

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

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

Tips

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

Summary

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

Syntax

EnablePinSwapping : Boolean_String

Example Usage

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

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

Tips

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

Summary

Returns all 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.

Tips

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

Summary

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

Syntax

Footprint : String

Example Usage

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

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

Tips

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

Summary

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

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.

Tips

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

Summary

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

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

FromToPad2 : PadName_String

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

Example Usage

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

Tips

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

Tips

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

Summary

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

Syntax

Height : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tips

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

Summary

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

Syntax

Hide : Boolean

Example Usage

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

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

Tip

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

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.

Tips

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

Summary

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

Syntax

HoleDiameter : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

HoleNegativeTolerance : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tip

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

Summary

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

Syntax

HolePositiveTolerance : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tip

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

Summary

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

Syntax

HoleRotation : Numeric_String
HoleRotation : Number

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.

Tip

The Hole Rotation property is only defined for pad objects.

Summary

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

Syntax

HoleSize : Number

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

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

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

Example Usage

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

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

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

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

Tips

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

Summary

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

Syntax

HoleType = HoleType_String
HoleType <> HoleType_String

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

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

Example Usage

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

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

HoleType = 'Square' || HoleType = 'Slot'
IsPad && HoleType <> 'Round'

Returns all objects except pad objects whose Hole Type property is Round.

Tips

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

Summary

Returns all 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.

Tips

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

Summary

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

Syntax

InvertedRectangleHeight : Number

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

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

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

Example Usage

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

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

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

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

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

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

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

Tip

The Inverted Rectangle Height property is only defined for text string (comment, designator, free) objects.

Summary

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

Syntax

InvertedRectangleWidth : Number

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

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

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

Example Usage

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

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

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

AsMM(InvertedRectangleWidth) Between 6 And 8
Returns all text string (comment, designator, free) objects that have a Inverted Rectangle Width property which is greater than or equal to 6mm and less than or equal to 8mm.

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

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

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

Tip

The Inverted Rectangle Width property is only defined for text string (comment, designator, free) objects.

Summary

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

Syntax

InvertedTextJustification = TextJustification_String
InvertedTextJustification <> TextJustification_String

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

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

Example Usage

InvertedTextJustification = 'Center'
Returns all text string (comment, designator, free) objects whose Inverted Text Justification property is Center.

InvertedTextJustification <> 'Right-Below'
Returns all objects except text string (comment, designator, free) objects whose Inverted Text Justification property is Right-Below.

Tips

  • The single quote characters (') at the start and end of TextJustification_String are mandatory.
  • The Inverted Text Justification property is only defined for text string (comment, designator, free) objects.

Summary

Returns all pad and via objects that have been marked for use as Assembly Testpoints – having their Assembly Testpoint - Top and/or Assembly Testpoint - Bottom properties enabled.

Syntax

IsAssyTestpoint : Boolean

Example Usage

IsAssyTestpoint
IsAssyTestpoint = True
Returns all pad and via objects being used as Assembly Testpoints.

Not IsAssyTestpoint
IsAssyTestpoint = False
Returns all objects except pad and via objects being used as Assembly Testpoints.

Summary

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

Syntax

IsBold : Boolean_String

Example Usage

IsBold = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is enabled.

IsBold = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is disabled.

Tips

  • The Bold property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
  • All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.

Summary

Returns all pad and via objects that have been marked for use as Fabrication Testpoints – having their Fabrication Testpoint - Top and/or Fabrication Testpoint - Bottom properties enabled.

Syntax

IsFabTestpoint : Boolean

Example Usage

IsFabTestpoint
IsFabTestpoint = True
Returns all pad and via objects being used as Fabrication Testpoints.

Not IsFabTestpoint
IsFabTestpoint = False
Returns all objects except pad and via objects being used as Fabrication Testpoints.

Summary

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

Syntax

IsItalic : Boolean_String

Example Usage

IsItalic = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is enabled.

IsItalic = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is disabled.

Tips

  • The Italic property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
  • All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.

Summary

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

Syntax

IsModified : Boolean_String

Example Usage

IsModified = 'True'
Returns all polygon pour objects whose IsModified property is enabled.

IsModified = 'False'
Returns all polygon pour objects whose IsModified property is disabled.

Tip

The IsModified property is only defined for polygon pour objects.

Summary

Returns all pad and via objects that have been marked for use as Testpoints, regardless of whether they are Assembly or Fabrication Testpoints – so having any of the following properties enabled:

  • Assembly Testpoint - Top
  • Assembly Testpoint - Bottom
  • Fabrication Testpoint - Top
  • Fabrication Testpoint - Bottom

Syntax

IsTestpoint : Boolean

Example Usage

IsTestpoint
IsTestpoint = True
Returns all pad and via objects being used as Testpoints.

Not IsTestpoint
IsTestpoint = False
Returns all objects except pad and via objects being used as Testpoints.

Summary

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

Syntax

IsTextInverted : Boolean_String

Example Usage

IsTextInverted = 'True'
Returns all text string (comment, designator, free) objects whose Inverted property is enabled.

IsTextInverted = 'False'
Returns all text string (comment, designator, free) objects whose Inverted property is disabled.

Tip

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

Summary

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

Syntax

Keepout : Boolean

Example Usage

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

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

Summary

Returns all keepout objects whose Keepout Restriction - Copper property complies with the Query.

Syntax

KeepoutRestrictionsCopper : Boolean_String

Example Usage

KeepoutRestrictionsCopper = 'True'
Returns all keepout objects whose Keepout Restriction - Copper property is enabled.

KeepoutRestrictionsCopper = 'False'
Returns all keepout objects whose Keepout Restriction - Copper property is disabled.

Tips

  • The Keepout Restriction - Copper property is only defined for keepout objects (arcs, fills, solid regions, tracks).
  • The Keepout Restriction - Copper property (as reflected in the List panels) corresponds to the Copper option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - SMD Pad property complies with the Query.

Syntax

KeepoutRestrictionsSMDPad : Boolean_String

Example Usage

KeepoutRestrictionsSMDPad = 'True'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is enabled.

KeepoutRestrictionsSMDPad = 'False'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is disabled.

Tips

  • The Keepout Restriction - SMD Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
  • The Keepout Restriction - SMD Pad property (as reflected in the List panels) corresponds to the SMD Pad option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - TH Pad property complies with the Query.

Syntax

KeepoutRestrictionsTHPad : Boolean_String

Example Usage

KeepoutRestrictionsTHPad = 'True'
Returns all keepout objects whose Keepout Restriction - TH Pad property is enabled.

KeepoutRestrictionsTHPad = 'False'
Returns all keepout objects whose Keepout Restriction - TH Pad property is disabled.

Tips

  • The Keepout Restriction - TH Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
  • The Keepout Restriction - TH Pad property (as reflected in the List panels) corresponds to the TH Pad option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - Track property complies with the Query.

Syntax

KeepoutRestrictionsTrack : Boolean_String

Example Usage

KeepoutRestrictionsTrack = 'True'
Returns all keepout objects whose Keepout Restriction - Track property is enabled.

KeepoutRestrictionsTrack = 'False'
Returns all keepout objects whose Keepout Restriction - Track property is disabled.

Tips

  • The Keepout Restriction - Track property is only defined for keepout objects (arcs, fills, solid regions, tracks).
  • The Keepout Restriction - Track property (as reflected in the List panels) corresponds to the Track option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

Returns all keepout objects whose Keepout Restriction - Via property complies with the Query.

Syntax

KeepoutRestrictionsVia : Boolean_String

Example Usage

KeepoutRestrictionsVia = 'True'
Returns all keepout objects whose Keepout Restriction - Via property is enabled.

KeepoutRestrictionsVia = 'False'
Returns all keepout objects whose Keepout Restriction - Via property is disabled.

Tips

  • The Keepout Restriction - Via property is only defined for keepout objects (arcs, fills, solid regions, tracks).
  • The Keepout Restriction - Via property (as reflected in the List panels) corresponds to the Via option, in the Keepout Restrictions section, when viewing the properties for a selected object through the Properties panel.

Summary

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

Syntax

Kind = ObjectKind_String
Kind <> ObjectKind_String

ObjectKind_String specifies the object kind and must be one of the following strings:

  • Design Objects'3D Body', 'Arc', 'Angular Dimension', 'Baseline Dimension', 'Center Dimension', 'Component', 'Coordinate', 'Datum Dimension', 'Design View', 'Drill Table', 'Embedded Board', 'Fill', 'Layer Stack Table', 'Leader Dimension', 'Linear Diameter Dimension', 'Linear Dimension', 'OLE Object', 'Original Dimension', 'Pad', 'Poly', 'Radial Diameter Dimension', 'Radial Dimension', 'Region', 'Split Plane', 'Text', 'Track', 'Via'.
  • Design Rules – the following strings are used to target the various rule types. The rule type, as it appears in the PCB Rules and Constraints Editor dialog, is shown in brackets after the string:
    • 'Acute Angle Rule'(Acute Angle)
    • 'Bare-board Fabrication Test Point Style Rule'(Fabrication Testpoint Style)
    • 'Bare-board Fabrication Test Point Usage Rule'(Fabrication Testpoint Usage)
    • 'Board Outline Clearance'(Board Outline Clearance)
    • 'Broken Nets Rule'(Un-Routed Net)
    • 'Clearance Rule'(Clearance)
    • 'Component Clearance Rule'(Component Clearance)
    • 'Component Rotations Rule'(Component Orientations)
    • 'Confinement Constraint Rule'(Room Definition)
    • 'Daisy Chain Stub Length Rule'(Daisy Chain Stub Length)
    • 'Differential Pairs Rule'(Differential Pairs Routing)
    • 'Fanout Control Rule'(Fanout Control)
    • 'Flight Time Falling Edge Rule'(Flight Time - Falling Edge)
    • 'Flight Time Rising Edge Rule'(Flight Time - Rising Edge)
    • 'Hole To Hole Clearance Rule'(Hole To Hole Clearance)
    • 'In-circuit Assembly Test Point Style Rule'(Assembly Testpoint Style)
    • 'In-circuit Assembly Test Point Usage Rule'(Assembly Testpoint Usage)
    • 'Layer Pair Rule'(Layer Pairs)
    • 'Matched Lengths Rule'(Matched Lengths)
    • 'Max Min Height Rule'(Height)
    • 'Max Min Hole Size Rule'(Hole Size)
    • 'Max Min Impedance Rule'(Impedance)
    • 'Max Min Length Rule'(Length)
    • 'Max Min Width Rule'(Width)
    • 'Max Slope Falling Edge Rule'(Slope - Falling Edge)
    • 'Max Slope Rising Edge Rule'(Slope - Rising Edge)
    • 'Max Via Stub Length (BackDrilling rule)' (Max Via Stub Length (Back Drilling))
    • 'Maximum Via Count Rule'(Maximum Via Count)
    • 'Minimum Annular Ring Rule'(Minimum Annular Ring)
    • 'Minimum Solder Mask Sliver Rule'(Minimum Solder Mask Sliver)
    • 'Modified Polygon'(Modified Polygon)
    • 'Net Antennae Rule'(Net Antennae)
    • 'Nets To Ignore Rule'(Nets to Ignore)
    • 'Overshoot Falling Edge Rule'(Overshoot - Falling Edge)
    • 'Overshoot Rising Edge Rule'(Overshoot - Rising Edge)
    • 'Parallel Segment Rule'(Parallel Segment)
    • 'Paste Mask Expansion Rule'(Paste Mask Expansion)
    • 'Permitted Layers Rule'(Permitted Layers)
    • 'Polygon Connect Style Rule'(Polygon Connect Style)
    • 'Power Plane Clearance Rule'(Power Plane Clearance)
    • 'Power Plane Connect Style Rule'(Power Plane Connect Style)
    • 'Routing Corner Style Rule'(Routing Corners)
    • 'Routing Layers Rule'(Routing Layers)
    • 'Routing Priority Rule'(Routing Priority)
    • 'Routing Topology Rule'(Routing Topology)
    • 'Routing Via Style Rule'(Routing Via Style)
    • 'Short Circuit Rule'(Short-Circuit)
    • 'Signal Base Value Rule'(Signal Base Value)
    • 'Signal Stimulus Rule'(Signal Stimulus)
    • 'Signal Top Value Rule'(Signal Top Value)
    • 'Silk To Silk Clearance Rule'(Silk To Silk Clearance)
    • 'Silk To Solder Mask Clearance Rule'(Silk To Solder Mask Clearance)
    • 'SMD Entry'(SMD Entry)
    • 'SMD Neck Down Rule'(SMD Neck-Down)
    • 'SMD To Corner Rule'(SMD To Corner)
    • 'SMD To Plane Rule'(SMD To Plane)
    • 'Solder Mask Expansion Rule'(Solder Mask Expansion)
    • 'Supply Nets Rule'(Supply Nets)
    • 'Unconnected Pin Rule'(Un-Connected Pin)
    • 'Undershoot Falling Edge Rule'(Undershoot - Falling Edge)
    • 'Undershoot Rising Edge Rule'(Undershoot - Rising Edge)
    • 'Vias Under SMD Rule'(Vias Under SMD)
  • Others'Board Region', 'Class', 'Differential Pair', 'Net', 'Violation'.

Example Usage

Kind = 'Class'
Returns all class objects.

Kind <> 'Via'
Returns all objects except via objects.

Tips

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

Tips

  • The single quote characters (') at the start and end of Layer_String are mandatory.
  • This function is an alias for the Layer function.

Summary

Returns all objects whose Layer property complies with the Query.

Syntax

Layer = Layer_String
Layer <> Layer_String

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.

Tips

  • The single quote characters (') at the start and end of Layer_String are mandatory.
  • This function is an alias for the L function.

Summary

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

Syntax

LeaderDimensionDot : Boolean_String

Example Usage

LeaderDimensionDot = 'True'
Returns all leader dimension objects whose Dot property is enabled.

LeaderDimensionDot = 'False'
Returns all leader dimension objects whose Dot property is disabled.

Tips

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

Summary

Returns leader dimension objects whose Dot Size property complies with the Query.

Syntax

LeaderDimensionDotSize : Number

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

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

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

Example Usage

LeaderDimensionDotSize = 40
Returns all leader dimension objects that have a Dot Size property which is 40 current measurement units.

LeaderDimensionDotSize >= 1.143
Returns all leader dimension objects that have a Dot Size property which is greater than or equal to 1.143 current measurement units.

AsMils(LeaderDimensionDotSize) Between 30 And 50
Returns all leader dimension objects that have a Dot Size property which is greater than or equal to 30mil and less than or equal to 50mil.

AsMM(LeaderDimensionDotSize) < 0.889
Returns all leader dimension objects that have a Dot Size property which is less than 0.889mm.

Tips

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

Summary

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

Syntax

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.

Tips

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

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.

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.

Tips

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

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.

Tip

The Mirror property is only defined for string objects.

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.

Tip

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

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.

AsMils(ModelCylinderSphereRadius) > 40
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is greater than 40mil.

AsMM(ModelCylinderSphereRadius) Between 1.5 And 2.2
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is greater than or equal to 1.5mm and less than or equal to 2.2mm.

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

AsMils(ModelCylinderSphereRadius) <= 65
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is less than or equal to 65mil.

AsMM(ModelCylinderSphereRadius) < 1.43
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property which is less than 1.43mm.

Tip

The Model Radius (Cylinder/Sphere) property is only defined for 3D body objects.

Summary

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

Syntax

ModelRotationX : Numeric_String
ModelRotationX : Number

Numeric_String/Number is a value for the rotation of the model in the X plane, in Degrees.

Example Usage

ModelRotationX = '30'
ModelRotationX = 30

Returns all 3D body objects whose Model Rotation X property is 30.000.

ModelRotationX <> '45'
ModelRotationX <> 45

Returns all objects except 3D body objects whose Model Rotation X property is 45.000.

Tip

The Model Rotation X property is only defined for 3D body objects.

Summary

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

Syntax

ModelRotationY : Numeric_String
ModelRotationY : Number

Numeric_String/Number is a value for the rotation of the model in the Y plane, in Degrees.

Example Usage

ModelRotationY = '30'
ModelRotationY = 30

Returns all 3D body objects whose Model Rotation Y property is 30.000.

ModelRotationY <> '45'
ModelRotationY <> 45

Returns all objects except 3D body objects whose Model Rotation Y property is 45.000.

Tip

The Model Rotation Y property is only defined for 3D body objects.

Summary

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

Syntax

ModelRotationZ : Numeric_String
ModelRotationZ : Number

Numeric_String/Number is a value for the rotation of the model in the X plane, in Degrees.

Example Usage

ModelRotationZ = '30'
ModelRotationZ = 30

Returns all 3D body objects whose Model Rotation Z property is 30.000.

ModelRotationZ <> '45'
ModelRotationZ <> 45

Returns all objects except 3D body objects whose Model Rotation Z property is 45.000.

Tip

The Model Rotation Z property is only defined for 3D body objects.

Summary

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

Syntax

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.

Tips

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

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.

Tips

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

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

  • The single quote characters (') at the start and end of ObjectKind_String are mandatory.
  • This function is an alias for the Kind function.

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(OverallHeight) <= 120
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property which is less than or equal to 120mil.

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

Tip

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

Summary

Returns all simple pad objects, whose Pad Corner Radius (%) (All Layers) property complies with the Query.

Syntax

Pad_CornerRadius_AllLayers = CornerRadius_String
Pad_CornerRadius_AllLayers <> CornerRadius_String

CornerRadius_String specifies the corner radius, expressed as a percentage.

Example Usage

Pad_CornerRadius_AllLayers = '50%'
Returns all simple pad objects whose Pad Corner Radius (%) (All Layers) property equals 50%.

Pad_CornerRadius_AllLayers <> '30%'
Returns all objects except for simple pad objects whose Pad Corner Radius (%) (All Layers) property equals 30%.

Tips

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

Summary

Returns pad objects whose Pad Corner Radius (%) (Bottom Layer) property complies with the Query.

Syntax

Pad_CornerRadius_BottomLayer = CornerRadius_String
Pad_CornerRadius_BottomLayer <> CornerRadius_String

CornerRadius_String specifies the corner radius, expressed as a percentage.

Example Usage

Pad_CornerRadius_BottomLayer = '50%'
Returns all pad objects whose Pad Corner Radius (%) (Bottom Layer) property equals 50%.

Pad_CornerRadius_BottomLayer <> '30%'
Returns all objects except for pad objects whose Pad Corner Radius (%) (Bottom Layer) property equals 30%.

Tips

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

Summary

Returns pad objects whose Pad Corner Radius (%) (Mid Layer <n>) property complies with the Query. This includes:

Syntax

Pad_CornerRadius_MidLayer<n> = CornerRadius_String
Pad_CornerRadius_MidLayer<n> <> CornerRadius_String

CornerRadius_String specifies the corner radius, expressed as a percentage.

Example Usage

Pad_CornerRadius_MidLayer<n> = '50%'
Returns all pad objects whose Pad Corner Radius (%) (Mid Layer <n>) property equals 50%.

Pad_CornerRadius_MidLayer<n> <> '30%'
Returns all objects except for pad objects whose Pad Corner Radius (%) (Mid Layer <n>) property equals 30%.

Tips

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

Summary

Returns pad objects whose Pad Corner Radius (%) (Top Layer) property complies with the Query.

Syntax

Pad_CornerRadius_TopLayer = CornerRadius_String
Pad_CornerRadius_TopLayer <> CornerRadius_String

CornerRadius_String specifies the corner radius, expressed as a percentage.

Example Usage

Pad_CornerRadius_TopLayer = '50%'
Returns all pad objects whose Pad Corner Radius (%) (Top Layer) property equals 50%.

Pad_CornerRadius_TopLayer <> '30%'
Returns all objects except for pad objects whose Pad Corner Radius (%) (Top Layer) property equals 30%.

Tips

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

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.

Tips

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

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.

Tip

The Plated property is only defined for pad objects.

Summary

Returns all pad objects whose Pad Jumper ID property complies with the Query.

Syntax

Pad_JumperID : Numeric_String

Numeric_String is a value for the ID between '0' and '1000'.

Example Usage

Pad_JumperID = '3'
Returns all pad objects whose Pad Jumper ID property is 3.

Pad_JumperID <> '567'
Returns all objects except pad objects whose Pad Jumper ID property is 567.

Tip

The Pad Jumper ID property is only defined for pad objects.

Summary

Returns all pad objects whose Pin/Pkg Length property complies with the Query.

Syntax

Pad_PinLength : 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(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.

Tip

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

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'

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.

Tips

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

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'

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.

Tips

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

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'

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.

Tips

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

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'

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tip

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

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

Tip

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

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.

Tips

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

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.

Tip

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tip

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

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.

Tips

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

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.

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.

Tips

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

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.

Tip

The Use Paste property is only defined for pad objects.

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.

Tips

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

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.

Tips

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

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.

Tip

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

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.

The ability to define paste mask expansion as a percentage of the pad area is in Open Beta. If required, it (and hence the PasteMaskPercent query keyword) can be turned off by disabling the PCB.PasteMask.Percentage option in the Advanced Settings dialog.

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

Tips

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

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.

The ability to define paste mask expansion as a percentage of the pad area is in Open Beta. If required, it (and hence the PasteMaskUsePercent query keyword) can be turned off by disabling the PCB.PasteMask.Percentage option in the Advanced Settings dialog.

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.

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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 an Minimum Primitive Size property which is less than 0.1524mm.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tip

The Propogation Delay property is only defined for component objects.

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.

Tip

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

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.

Tips

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

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.

Tip

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.

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.

Tip

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

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.

Tips

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tip

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tip

The Hole Length property is only defined for pad objects.

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.

Tips

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

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. For pads and vias, expansion values can be specified independently for both top and bottom sides of the board. This function returns the following:

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

Tips

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

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.

Tip

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

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.

Tips

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

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. For pads and vias, expansion values can be specified independently for both top and bottom sides of the board. This function returns the following:

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

Tips

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

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.

Tip

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

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.

Tips

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

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.

Tips

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

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.

Tip

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tip

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

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 Assembly Testpoint - Top or Assembly Testpoint - Bottom properties comply with the Query.

Syntax

TestpointAssy : Boolean

Example Usage

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

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

Tip

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

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 Assembly Testpoint - Bottom property complies with the Query.

Syntax

TestpointAssyBottom : Boolean

Example Usage

TestpointAssyBottom
TestpointAssyBottom = True
Returns all pad and via objects whose Assembly Testpoint - Bottom property is enabled.

Not TestpointAssyBottom
TestpointAssyBottom = False
Returns all objects except pad and via objects whose Assembly Testpoint - Bottom property is enabled.

Tip

The Assembly Testpoint - Bottom property is only defined for pad and via objects.

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 Assembly Testpoint - Top property complies with the Query.

Syntax

TestpointAssyTop : Boolean

Example Usage

TestpointAssyTop
TestpointAssyTop = True
Returns all pad and via objects whose Assembly Testpoint - Top property is enabled.

Not TestpointAssyTop
TestpointAssyTop = False
Returns all objects except pad and via objects whose Assembly Testpoint - Top property is enabled.

Tip

The Assembly Testpoint - Top property is only defined for pad and via objects.

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.

Tip

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

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 Fabrication Testpoint - Bottom properties comply with the Query.

Syntax

TestpointFab : Boolean

Example Usage

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

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

Tip

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

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 property complies with the Query.

Syntax

TestpointFabBottom : Boolean

Example Usage

TestpointFabBottom
TestpointFabBottom = True
Returns all pad and via objects whose Fabrication Testpoint - Bottom property is enabled.

Not TestpointFabBottom
TestpointFabBottom = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Bottom property is enabled.

Tip

The Fabrication Testpoint - Bottom property is only defined for pad and via objects.

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 property complies with the Query.

Syntax

TestpointFabTop : Boolean

Example Usage

TestpointFabTop
TestpointFabTop = True
Returns all pad and via objects whose Fabrication Testpoint - Top property is enabled.

Not TestpointFabTop
TestpointFabTop = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Top property is enabled.

Tip

The Fabrication Testpoint - Top property is only defined for pad and via objects.

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.

Tip

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

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.

Tip

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

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.

Tips

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

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.

Tip

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

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.

Tip

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

Summary

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

Syntax

UseInvertedRectangle : Boolean_String

Example Usage

UseInvertedRectangle = 'True'
Returns all text string (comment, designator, free) objects whose Use Inverted Rectangle property is enabled.

UseInvertedRectangle = 'False'
Returns all text string (comment, designator, free) objects whose Use Inverted Rectangle property is disabled.

Tip

The Use Inverted Rectangle property is only defined for text string (comment, designator, free) objects.

Summary

Returns all pad and via objects whose Use Separate Solder Mask Expansion property complies with the Query.

Syntax

UseSeparateSolderMaskExpansion : Boolean_String

Example Usage

UseSeparateSolderMaskExpansion = 'True'
Returns all pad and via objects whose Use Separate Solder Mask Expansion property is enabled.

UseSeparateSolderMaskExpansion = 'False'
Returns all pad and via objects whose Use Separate Solder Mask Expansion property is disabled.

Tip

The Use Separate Solder Mask Expansion property is only defined for pad and via objects.

Summary

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

Syntax

UseTrueTypeFonts : Boolean_String

Example Usage

UseTrueTypeFonts = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Use TrueType Fonts property is enabled.

UseTrueTypeFonts = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Use TrueType Fonts property is disabled.

Tip

The Use TrueType Fonts property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.

Summary

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

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

Tips

  • The Width property is only defined for arc and track objects.
  • This function is an alias for the Width function.

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.

Tips

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

Tip

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.

Tip

The X2 property is only defined for fill, original dimension, and track objects.

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 Y1 property complies with the Query.

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.

Tip

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.

AsMM(Y2) < 20.32
Returns all fill, original dimension, and track objects that have a Y2 property which is less than 20.32mm.

Tip

The Y2 property is only defined for fill, original dimension, and track objects.

Layer Checks

Summary

Returns all objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.

Syntax

OnBottom : Boolean

Example Usage

OnBottom
OnBottom = True
Returns all objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.

Not OnBottom
OnBottom = False
Returns all objects except objects on the layers: Bottom Layer, Bottom Overlay, Bottom Paste, and Bottom Solder.

Summary

Returns all objects on the Bottom Layer.

Syntax

OnBottomLayer : Boolean

Example Usage

OnBottomLayer
OnBottomLayer = True
Returns all objects on the Bottom Layer.

Not OnBottomLayer
OnBottomLayer = False
Returns all objects except objects on the Bottom Layer.

Summary

Returns all objects on the Bottom Paste layer, and all pads on the Bottom Layer – the latter objects are returned because they also render to the Bottom Paste layer.

Syntax

OnBottomPaste : Boolean

Example Usage

OnBottomPaste
OnBottomPaste = True
Returns all objects on the Bottom Paste layer, and all pads on the Bottom Layer.

Not OnBottomPaste
OnBottomPaste = False
Returns all objects except objects on the Bottom Paste layer, and all pads on the Bottom Layer.

Summary

Returns all objects on the Bottom Overlay layer.

Syntax

OnBottomSilkscreen : Boolean

Example Usage

OnBottomSilkscreen
OnBottomSilkscreen = True
Returns all objects on the Bottom Overlay layer.

Not OnBottomSilkscreen
OnBottomSilkscreen = False
Returns all objects except objects on the Bottom Overlay layer.

Summary

Returns all objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer. The pad and via objects are returned because they also render to the Bottom Solder layer.

Syntax

OnBottomSolderMask : Boolean

Example Usage

OnBottomSolderMask
OnBottomSolderMask = True
Returns all objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer.

Not OnBottomSolderMask
OnBottomSolderMask = False
Returns all objects except objects on the Bottom Solder layer, all pads on the Bottom Layer and Multi-Layer, and all vias ending on the Bottom Layer.

Summary

Returns all objects on signal layers (Top Layer, Bottom Layer, Signal Layer 1-30), the Multi-Layer, and internal plane layers (Internal Plane 1-16).

Syntax

OnCopper : Boolean

Example Usage

OnCopper
OnCopper = True
Returns all objects on signal layers (Top Layer, Bottom Layer, Signal Layer 1-30), the Multi-Layer, and internal plane layers (Internal Plane 1-16).

Not OnCopper
OnCopper = False
Returns all objects except objects on signal layers (Top Layer, Bottom Layer, Signal Layer 1-30), the Multi-Layer, and internal plane layers (Internal Plane 1-16).

Summary

Returns all objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16). These layers are all of an "Inverted" or "Reverse" nature, because the presence of any object on these layers results in a corresponding opening in a solder paste stencil, or in the solder mask film, or a corresponding absence of copper (in the cases of Paste Mask, Solder Mask, and Internal Plane layers respectively).

Syntax

OnInverted : Boolean

Example Usage

OnInverted
OnInverted = True
Returns all objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16).

Not OnInverted
OnInverted = False
Returns all objects except objects on the following layers: Top Paste, Bottom Paste, Top Solder, Bottom Solder, and Internal Plane layers (Internal Plane 1-16).

Summary

Returns all objects on any enabled Mechanical layers.

Syntax

OnMechanical : Boolean

Example Usage

OnMechanical
OnMechanical = True
Returns all objects on any enabled Mechanical layers.

Not OnMechanical
OnMechanical = False
Returns all objects except objects on any enabled Mechanical layers.

Summary

Returns all objects on any internal signal layers (Signal Layer 1-30).

Syntax

OnMid : Boolean

Example Usage

OnMid
OnMid = True
Returns all objects on any internal signal layers (Signal Layer 1-30).

Not OnMid
OnMid = False
Returns all objects except objects on any internal signal layers (Signal Layer 1-30).

Summary

Returns all objects on the Multi-Layer layer.

Syntax

OnMultiLayer : Boolean

Example Usage

OnMultiLayer
OnMultiLayer = True
Returns all objects on the Multi-Layer layer.

Not OnMultiLayer
OnMultiLayer = False
Returns all objects except objects on the Multi-Layer layer.

Summary

Returns all objects on the 'outside' signal layers – Top Layer and Bottom Layer.

Syntax

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.

Summary

Returns all objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer – the pad objects on these layers are returned because they also render to the Top Paste and Bottom Paste layers respectively.

Syntax

OnPaste : Boolean

Example Usage

OnPaste
OnPaste = True
Returns all objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer.

Not OnPaste
OnPaste = False
Returns all objects except objects on the Top Paste and Bottom Paste layers, and all pads on the Top Layer and Bottom Layer.

Summary

Returns all objects on internal plane layers (Internal Plane 1-16).

Syntax

OnPlane : Boolean

Example Usage

OnPlane
OnPlane = True
Returns all objects on internal plane layers (Internal Plane 1-16).

Not OnPlane
OnPlane = False
Returns all objects except objects on internal plane layers (Internal Plane 1-16).

Summary

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

Syntax

OnSignal : Boolean

Example Usage

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

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

Summary

Returns all objects on the Top Overlay and Bottom Overlay layers.

Syntax

OnSilkscreen : Boolean

Example Usage

OnSilkscreen
OnSilkscreen = True
Returns all objects on the Top Overlay and Bottom Overlay layers.

Not OnSilkscreen
OnSilkscreen = False
Returns all objects except objects on the Top Overlay and Bottom Overlay layers.

Summary

Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer. The pad and via objects are returned because they also render to the Top Solder or Bottom Solder layer respectively.

Syntax

OnSolderMask : Boolean

Example Usage

OnSolderMask
OnSolderMask = True
Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.

Not OnSolderMask
OnSolderMask = False
Returns all objects except objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.

Summary

Returns all objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.

Syntax

OnTop : Boolean

Example Usage

OnTop
OnTop = True
Returns all objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.

Not OnTop
OnTop = False
Returns all objects except objects on the layers: Top Layer, Top Overlay, Top Paste, and Top Solder.

Summary

Returns all objects on the Top Layer.

Syntax

OnTopLayer : Boolean

Example Usage

OnTopLayer
OnTopLayer = True
Returns all objects on the Top Layer.

Not OnTopLayer
OnTopLayer = False
Returns all objects except objects on the Top Layer.

Summary

Returns all objects on the Top Paste layer, and all pads on the Top Layer – the latter objects are returned because they also render to the Top Paste layer.

Syntax

OnTopPaste : Boolean

Example Usage

OnTopPaste
OnTopPaste = True
Returns all objects on the Top Paste layer, and all pads on the Top Layer.

Not OnTopPaste
OnTopPaste = False
Returns all objects except objects on the Top Paste layer, and all pads on the Top Layer.

Summary

Returns all objects on the Top Overlay layer.

Syntax

OnTopSilkscreen : Boolean

Example Usage

OnTopSilkscreen
OnTopSilkscreen = True
Returns all objects on the Top Overlay layer.

Not OnTopSilkscreen
OnTopSilkscreen = False
Returns all objects except objects on the Top Overlay layer.

Summary

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. The pad and via objects are returned because they also render to the Top Solder layer.

Syntax

OnTopSolderMask : Boolean

Example Usage

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

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.

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.

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.

Tips

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

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.

Tips

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

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.

Tips

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

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.

Tips

  • The single quote characters (') at the start and end of the Footprint and Name strings are mandatory.
  • The parent component objects are not returned.

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.

Tips

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

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.

Tips

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

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.

Tips

  • The single quote characters (') at the start and end of each ClassName string are mandatory.
  • The parent component objects are also returned.

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.

Tips

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

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.

Tips

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

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.

Tips

  • The single quote characters (') at the start and end of each DifferentialPairName string are mandatory.
  • The parent differential pair objects are also returned.

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.

Tips

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

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.

Tips

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

Summary

Returns all objects associated with a from-to object whose Net , From Pad, and To Pad properties comply 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

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

Tips

The parent from-to objects are also returned.

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

InFromToClass('Bus Terminators')
InFromToClass('Bus Terminators') = True
InFromToClass('Bus Terminators') = 'True'

Returns all from-to objects that are members of the Bus Terminators From To Class.

Not InFromToClass('Bus Terminators')
InFromToClass('Bus Terminators') = False
InFromToClass('Bus Terminators') = 'False'

Returns all objects except from-to objects that are members of the Bus Terminators From To Class.

Tips

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

Summary

Returns all objects whose Layer property matches a layer that is a member of the specified Layer Class.

Syntax

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

InLayerClass('TopSide')
InLayerClass('TopSide') = True
InLayerClass('TopSide') = 'True'

Returns all objects whose Layer property matches a layer that is a member of the TopSide Layer Class.

Not InLayerClass('BottomSide')
InLayerClass('BottomSide') = False
InLayerClass('BottomSide') = 'False'

Returns all objects except objects whose Layer property matches a layer that is a member of the BottomSide Layer Class.

Tips

The single quote characters (') at the start and end of the ClassName string is mandatory.

Summary

Returns all objects whose reference point is within the named Board Region.

Syntax

InLayerStackRegion(RegionName1 : String,RegionName2 : String,...,RegionNamen : String) : Boolean/Boolean_String

Example Usage

InLayerStackRegion('Region1')
InLayerStackRegion('Region1') = True
InLayerStackRegion('Region1') = 'True'

Returns all objects whose reference point is within the Board Region whose Name property is Region1.

InLayerStackRegion('Region1','Region2')
InLayerStackRegion('Region1','Region2') = True
InLayerStackRegion('Region1','Region2') = 'True'

Returns all objects whose reference point is within the Board Region whose Name property is Region1, or the Board Region whose Name property is Region2.

Not InLayerStackRegion('Region2')
InLayerStackRegion('Region2') = False
InLayerStackRegion('Region2') = 'False'

Returns all objects except objects whose reference point is within the Board Region whose Name property is Region2.

Tips

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

Summary

Returns all primitive objects that are children of the specified polygon pour.

Syntax

InNamedPolygon(PolygonName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing polygon pours, by name, is presented.

Example Usage

InNamedPolygon('Power3V3')
InNamedPolygon('Power3V3') = True
InNamedPolygon('Power3V3') = 'True'

Returns all primitive objects that are children of the polygon pour whose Name property is Power3V3.

Not InNamedPolygon('Power3V3')
InNamedPolygon('Power3V3') = False
InNamedPolygon('Power3V3') = 'False'

Returns all objects except primitive objects that are children of the polygon pour whose Name property is Power3V3.

Tips

  • The single quote characters (') at the start and end of the PolygonName string are mandatory.
  • The parent polygon pour object is also returned.

Summary

Returns all objects (parent and children) that are part of the specified union.

Syntax

InNamedUnion(UnionName : String) : Boolean/Boolean_String

Union names are automatically assigned, but can be renamed through using the PCB panel in Unions mode. As you define the Query expression, a pop-up list of all existing unions, by name, is presented.

Example Usage

InNamedUnion('Unions')
InNamedUnion('Unions') = True
InNamedUnion('Unions') = 'True'

Returns all objects (parent and children) that are part of the union whose name is Unions.

Not InNamedUnion('Unions 1')
InNamedUnion('Unions 1') = False
InNamedUnion('Unions 1') = 'False'

Returns all objects except objects (parent and children) that are part of the union whose name is Unions 1.

Tips

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

Summary

Returns all objects associated with Net objects whose Name property complies with the Query.

Syntax

InNet(NetName1 : String,NetName2 : String,...,NetNamen : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing nets, 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.

Tips

  • The single quote characters (') at the start and end of each NetName string are mandatory.
  • The parent Net objects are also returned.

Summary

Returns all nets (and their associated objects) that are members of the specified Net Class.

Syntax

InNetClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined net classes, by name, is presented.

Example Usage

InNetClass('Data Bus Nets')
InNetClass('Data Bus Nets') = True
InNetClass('Data Bus Nets') = 'True'

Returns all nets (and their associated objects) that are members of the Data Bus Nets Net Class.

Not InNetClass('Address Bus Nets')
InNetClass('Address Bus Nets') = False
InNetClass('Address Bus Nets') = 'False'

Returns all objects except nets (and their associated objects) that are members of the Address Bus Nets Net Class.

Tips

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

Summary

Returns all pad objects that are members of the specified Pad Class.

Syntax

InPadClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined pad classes, by name, is presented.

Example Usage

InPadClass('Top Side Probe Pads')
InPadClass('Top Side Probe Pads') = True
InPadClass('Top Side Probe Pads') = 'True'

Returns all pad objects that are members of the Top Side Probe Pads Pad Class.

Not InPadClass('Bottom Side Probe Pads')
InPadClass('Bottom Side Probe Pads') = False
InPadClass('Bottom Side Probe Pads') = 'False'

Returns all objects except pad objects that are members of the Bottom Side Probe Pads Pad Class.

Tips

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

Summary

Returns all polygon pour objects that are members of the specified Polygon Class.

Syntax

InPolygonClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined polygon classes, by name, is presented.

Example Usage

InPolygonClass('Top Side Polys')
InPolygonClass('Top Side Polys') = True
InPolygonClass('Top Side Polys') = 'True'

Returns all polygon pour objects that are members of the Top Side Polys Polygon Class.

Not InPolygonClass('Custom Polys')
InPolygonClass('Custom Polys') = False
InPolygonClass('Custom Polys') = 'False'

Returns all objects except polygon pour objects that are members of the Custom Polys Polygon Class.

Tips

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

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.

Tips

  • Parent component, coordinate, dimension, and Net objects are not returned.
  • This keyword is an alias for the InRegionAbsolute keyword.

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

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

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.

Tips

  • Parent component, coordinate, dimension, and Net objects are not returned.
  • This keyword is an alias for the InRegion keyword.

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

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

Tips

  • Parent component, coordinate, dimension, and Net objects are not returned.

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')
In
StructureClass('Output channel','Input channel') = True
In
StructureClass('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*')
In
StructureClass('Input*') = True
In
StructureClass('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.

Tips

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

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.

Not InUnion(4)
InUnion(4) = False
InUnion(4) = 'False'

Returns all objects except objects (parent and children) that are part of the union whose assigned number is 4.

Summary

Returns all objects that are associated with the specified xSignal.

Syntax

InxSignal(Name : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing xSignals, by name, is presented.

Example Usage

InxSignal('DRAM_A0_PP1')
InxSignal('DRAM_A0_PP1') = True
InxSignal('DRAM_A0_PP1') = 'True'

Returns all objects that are associated with the xSignal DRAM_A0_PP1.

Not InxSignal('DRAM_A0_PP1')
InxSignal('DRAM_A0_PP1') = False
InxSignal('DRAM_A0_PP1') = 'False'

Returns all objects except objects that are associated with the xSignal DRAM_A0_PP1.

Tips

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

Summary

Returns all xSignal objects that are members of the specified xSignal Class.

Syntax

InxSignalClass(ClassName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing user-defined xSignal classes, by name, is presented.

Example Usage

InxSignalClass('PCIE')
InxSignalClass('PCIE') = True
InxSignalClass('PCIE') = 'True'

Returns all xSignal objects that are members of the PCIE xSignal Class.

Not InxSignalClass('PCIE')
InxSignalClass('PCIE') = False
InxSignalClass('PCIE') = 'False'

Returns all objects except xSignal objects that are members of the PCIE xSignal Class.

Tips

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

Summary

Returns the specified polygon pour.

Syntax

IsNamedPolygon(PolygonName : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing polygon pours, by name, is presented.

Example Usage

IsNamedPolygon('Power3V3')
IsNamedPolygon('Power3V3') = True
IsNamedPolygon('Power3V3') = 'True'

Returns the polygon pour object whose Name property is Power3V3.

Not IsNamedPolygon('Power3V3')
IsNamedPolygon('Power3V3') = False
IsNamedPolygon('Power3V3') = 'False'

Returns all objects except the polygon pour object whose Name property is Power3V3.

Tips

  • The single quote characters (') at the start and end of the PolygonName string are mandatory.
  • The child primitive objects of the returned polgon pour object are not returned.

Summary

Returns the xSignal object with the specified name.

Syntax

IsxSignal(Name : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing xSignals, by name, is presented.

Example Usage

IsxSignal('DRAM_A0_PP1')
IsxSignal('DRAM_A0_PP1') = True
IsxSignal('DRAM_A0_PP1') = 'True'

Returns the xSignal DRAM_A0_PP1.

Not IsxSignal('DRAM_A0_PP1')
IsxSignal('DRAM_A0_PP1') = False
IsxSignal('DRAM_A0_PP1') = 'False'

Returns all objects except the xSignal DRAM_A0_PP1.

Tips

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

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.

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.

Tips

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

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.

Tips

  • The single quote characters (') at the start and end of each RoomName string are mandatory.
  • Parent coordinate, dimension, and Net objects are not returned.

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.

Tips

  • The single quote characters (') at the start and end of each RoomName string are mandatory.
  • Parent coordinate, dimension, and Net objects are not returned.

Object Type Checks

Summary

Returns all objects on the PCB document.

Syntax

All : Boolean

Example Usage

All
All = True
Returns all objects.

Not All
All = False
Returns no objects.

Summary

Returns all 3D body objects whose Model Type property is set to Cylinder.

Syntax

HasCylinderModel : Boolean/Boolean_String

Example Usage

HasCylinderModel
HasCylinderModel = True
HasCylinderModel = 'True'

Returns all 3D body objects whose Model Type property is set to Cylinder.

Not HasCylinderModel
HasCylinderModel = False
HasCylinderModel = 'False'

Returns all objects except 3D body objects whose Model Type property is set to Cylinder.

Summary

Returns all 3D body objects whose Model Type property is set to Extruded.

Syntax

HasExtrudedModel : Boolean/Boolean_String

Example Usage

HasExtrudedModel
HasExtrudedModel = True
HasExtrudedModel = 'True'

Returns all 3D body objects whose Model Type property is set to Extruded.

Not HasExtrudedModel
HasExtrudedModel = False
HasExtrudedModel = 'False'

Returns all objects except 3D body objects whose Model Type property is set to Extruded.

Summary

Returns all 3D body objects whose Model Type property is set to Generic Model.

Syntax

HasGenericStepModel : Boolean/Boolean_String

Example Usage

HasGenericStepModel
HasGenericStepModel = True
HasGenericStepModel = 'True'

Returns all 3D body objects whose Model Type property is set to Generic Model.

Not HasGenericStepModel
HasGenericStepModel = False
HasGenericStepModel = 'False'

Returns all objects except 3D body objects whose Model Type property is set to Generic Model.

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

Syntax

HasMask : Boolean/Boolean_String

Example Usage

HasMask
HasMask = True
HasMask = 'True'

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

Not HasMask
HasMask = False
HasMask = 'False'

Returns all objects except arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined paste mask.

Syntax

HasPasteMask : Boolean/Boolean_String

Example Usage

HasPasteMask
HasPasteMask = True
HasPasteMask = 'True'

Returns all arc, fill, pad, region, track, and via objects with a defined paste mask.

Not HasPasteMask
HasPasteMask = False
HasPasteMask = 'False'

Returns all objects except arc, fill, pad, region, track, and via objects with a defined paste mask.

Summary

Returns all pad objects with rectangular holes.

Syntax

HasRectangularHole : Boolean/Boolean_String

Example Usage

HasRectangularHole
HasRectangularHole = True
HasRectangularHole = 'True'

Returns all pad objects with rectangular holes.

Not HasRectangularHole
HasRectangularHole = False
HasRectangularHole = 'False'

Returns all objects except pad objects with rectangular holes.

Summary

Returns all pad objects with round holes.

Syntax

HasRoundHole : Boolean/Boolean_String

Example Usage

HasRoundHole
HasRoundHole = True
HasRoundHole = 'True'

Returns all pad objects with round holes.

Not HasRoundHole
HasRoundHole = False
HasRoundHole = 'False'

Returns all objects except pad objects with round holes.

Summary

Returns all pad objects with slotted holes.

Syntax

HasSlotHole : Boolean/Boolean_String

Example Usage

HasSlotHole
HasSlotHole = True
HasSlotHole = 'True'

Returns all pad objects with slotted holes.

Not HasSlotHole
HasSlotHole = False
HasSlotHole = 'False'

Returns all objects except pad objects with slotted holes.

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask.

Syntax

HasSolderMask : Boolean/Boolean_String

Example Usage

HasSolderMask
HasSolderMask = True
HasSolderMask = 'True'

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask.

Not HasSolderMask
HasSolderMask = False
HasSolderMask = 'False'

Returns all objects except arc, fill, pad, region, track, and via objects with a defined solder mask.

Summary

Returns all 3D body objects whose Model Type property is set to Sphere.

Syntax

HasSphereModel : Boolean/Boolean_String

Example Usage

HasSphereModel
Has
SphereModel = True
Has
SphereModel = 'True'
Returns all 3D body objects whose Model Type property is set to Sphere.

Not HasSphereModel
Has
SphereModel = False
Has
SphereModel = 'False'
Returns all objects except 3D body objects whose Model Type property is set to Sphere.

Summary

Returns all 3D body objects.

Syntax

HasStepModel : Boolean/Boolean_String

Example Usage

HasStepModel
HasStepModel = True
HasStepModel = 'True'

Returns all 3D body objects.

Not HasStepModel
HasStepModel = False
HasStepModel = 'False'

Returns all objects except 3D body objects.

Summary

Returns angular dimension objects.

Syntax

IsAngularDimension : Boolean

Example Usage

IsAngularDimension
IsAngularDimension = True
Returns all angular dimension objects.

Not IsAngularDimension
IsAngularDimension = False
Returns all objects except angular dimension objects.

Summary

Returns arc objects.

Syntax

IsArc : Boolean

Example Usage

IsArc
IsArc = True
Returns all arc objects.

Not IsArc
IsArc = False
Returns all objects except arc objects.

Summary

Returns text string objects whose Text Kind property is set to BarCode Text.

Syntax

IsBarCodeText : Boolean

Example Usage

IsBarCodeText
IsBarCodeText = True
Returns all text string objects whose Text Kind property is set to BarCode Text.

Not IsBarCodeText
IsBarCodeText = False
Returns all objects except text string objects whose Text Kind property is set to BarCode Text.

Summary

Returns baseline dimension objects.

Syntax

IsBaselineDimension : Boolean

Example Usage

IsBaselineDimension
IsBaselineDimension = True
Returns all baseline dimension objects.

Not IsBaselineDimension
IsBaselineDimension = False
Returns all objects except baseline dimension objects.

Summary

Returns region objects whose Kind property is set to Board cutout.

Syntax

IsBoardCutoutRegion : Boolean

Example Usage

IsBoardCutoutRegion
IsBoardCutoutRegion = True
Returns all region objects whose Kind property is set to Board cutout.

Not IsBoardCutoutRegion
IsBoardCutoutRegion = False
Returns all objects except region objects whose Kind property is set to Board cutout.

Summary

Returns center dimension objects.

Syntax

IsCenterDimension : Boolean

Example Usage

IsCenterDimension
IsCenterDimension = True
Returns all center dimension objects.

Not IsCenterDimension
IsCenterDimension = False
Returns all objects except center dimension objects.

Summary

Returns class objects.

Syntax

IsClass : Boolean

Example Usage

IsClass
IsClass = True
Returns all class objects.

Not IsClass
IsClass = False
Returns all objects except class objects.

Summary

Returns text objects whose String Type property is Comment – these are children of component objects.

Syntax

IsComment : Boolean

Example Usage

IsComment
IsComment = True
Returns all text objects whose String Type property is Comment.

Not IsComment
IsComment = False
Returns all objects except text objects whose String Type property is Comment.

Summary

Returns component objects.

Syntax

IsComponent : Boolean

Example Usage

IsComponent
IsComponent = True
Returns all component objects.

Not IsComponent
IsComponent = False
Returns all objects except component objects.

Summary

Returns arc objects which are children of component objects.

Syntax

IsComponentArc : Boolean

Example Usage

IsComponentArc
IsComponentArc = True
Returns all arc objects which are children of component objects.

Not IsComponentArc
IsComponentArc = False
Returns all objects except arc objects which are children of component objects.

Summary

Returns 3D body objects.

Syntax

IsComponentBody : Boolean

Example Usage

IsComponentBody
IsComponentBody = True
Returns all 3D body objects.

Not IsComponentBody
IsComponentBody = False
Returns all objects except 3D body objects.

Summary

Returns fill objects which are children of component objects.

Syntax

IsComponentFill : Boolean

Example Usage

IsComponentFill
IsComponentFill = True
Returns all fill objects which are children of component objects.

Not IsComponentFill
IsComponentFill = False
Returns all objects except fill objects which are children of component objects.

Summary

Returns pad objects which are children of component objects.

Syntax

IsComponentPad : Boolean

Example Usage

IsComponentPad
IsComponentPad = True
Returns all pad objects which are children of component objects.

Not IsComponentPad
IsComponentPad = False
Returns all objects except pad objects which are children of component objects.

Summary

Returns text objects which are children of component objects.

Syntax

IsComponentText : Boolean

Example Usage

IsComponentText
IsComponentText = True
Returns all text objects which are children of component objects.

Not IsComponentText
IsComponentText = False
Returns all objects except text objects which are children of component objects.

Summary

Returns track objects which are children of component objects.

Syntax

IsComponentTrack : Boolean

Example Usage

IsComponentTrack
IsComponentTrack = True
Returns all track objects which are children of component objects.

Not IsComponentTrack
IsComponentTrack = False
Returns all objects except track objects which are children of component objects.

Summary

Returns via objects which are children of component objects.

Syntax

IsComponentVia : Boolean

Example Usage

IsComponentVia
IsComponentVia = True
Returns all via objects which are children of component objects.

Not IsComponentVia
IsComponentVia = False
Returns all objects except via objects which are children of component objects.

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.

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.

Summary

Returns polygon cutout region objects – regions that have their Cutout property enabled.

When viewing the properties of a region object through the Properties panel, such an object has its Kind property set to Polygon Cutout.

Syntax

IsCutoutRegion : Boolean

Example Usage

IsCutoutRegion
IsCutoutRegion = True
Returns all polygon cutout region objects.

Not IsCutoutRegion
IsCutoutRegion = False
Returns all objects except polygon cutout region objects.

Summary

Returns datum dimension objects.

Syntax

IsDatumDimension : Boolean

Example Usage

IsDatumDimension
IsDatumDimension = True
Returns all datum dimension objects.

Not IsDatumDimension
IsDatumDimension = False
Returns all objects except datum dimension objects.

Summary

Returns text objects whose String Type property is Designator – these are children of component objects.

Syntax

IsDesignator : Boolean

Example Usage

IsDesignator
IsDesignator = True
Returns all text objects whose String Type property is Designator.

Not IsDesignator
IsDesignator = False
Returns all objects except text objects whose String Type property is Designator.

Summary

Returns all dimension objects (regardless of type).

Syntax

IsDimension : Boolean

Example Usage

IsDimension
IsDimension = True
Returns all dimension objects.

Not IsDimension
IsDimension = False
Returns all objects except dimension objects.

Summary

Returns fill objects.

Syntax

IsFill : Boolean

Example Usage

IsFill
IsFill = True
Returns all fill objects.

Not IsFill
IsFill = False
Returns all objects except fill objects.

Summary

Returns leader dimension objects.

Syntax

IsLeaderDimension : Boolean

Example Usage

IsLeaderDimension
IsLeaderDimension = True
Returns all leader dimension objects.

Not IsLeaderDimension
IsLeaderDimension = False
Returns all objects except leader dimension objects.

Summary

Returns linear diameter dimension objects.

Syntax

IsLinearDiameterDimension : Boolean

Example Usage

IsLinearDiameterDimension
IsLinearDiameterDimension = True
Returns all linear diameter dimension objects.

Not IsLinearDiameterDimension
IsLinearDiameterDimension = False
Returns all objects except linear diameter dimension objects.

Summary

Returns linear dimension objects.

Syntax

IsLinearDimension : Boolean

Example Usage

IsLinearDimension
IsLinearDimension = True
Returns all linear dimension objects.

Not IsLinearDimension
IsLinearDimension = False
Returns all objects except linear dimension objects.

Summary

Returns net objects. Any object that includes the Net property can belong to a net, for example Track, Arc, Fill, Region, Polygon, Pad and Via.

Syntax

IsNet : Boolean

Example Usage

IsNet
IsNet = True
Returns all net objects.

Not IsNet
IsNet = False
Returns all objects except net objects.

Summary

Returns pad objects.

Syntax

IsPad : Boolean

Example Usage

IsPad
IsPad = True
Returns all pad objects.

Not IsPad
IsPad = False
Returns all objects except pad objects.

Summary

Returns polygon pour objects.

Syntax

IsPoly : Boolean

Example Usage

IsPoly
IsPoly = True
Returns all polygon pour objects.

Not IsPoly
IsPoly = False
Returns all objects except polygon pour objects.

Tips

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

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.

Tips

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

Summary

Returns radial diameter dimension objects.

Syntax

IsRadialDiameterDimension : Boolean

Example Usage

IsRadialDiameter Dimension
IsRadialDiameterDimension = True
Returns all radial diameter dimension objects.

Not IsRadialDiameterDimension
IsRadialDiameterDimension = False
Returns all objects except radial diameter dimension objects.

Summary

Returns radial dimension objects.

Syntax

IsRadialDimension : Boolean

Example Usage

IsRadial Dimension
IsRadialDimension = True
Returns all radial dimension objects.

Not IsRadialDimension
IsRadialDimension = False
Returns all objects except radial dimension objects.

Summary

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.

Summary

Returns all design rule objects (regardless of type).

Syntax

IsRule : Boolean

Example Usage

IsRule
IsRule = True
Returns all design rule objects.

Not IsRule
IsRule = False
Returns all objects except design rule objects.

Summary

Returns Acute Angle rule objects.

Syntax

IsRule_AcuteAngle : Boolean

Example Usage

IsRule_AcuteAngle
IsRule_AcuteAngle = True
Returns all Acute Angle rule objects.

Not IsRule_AcuteAngle
IsRule_AcuteAngle = False
Returns all objects except Acute Angle rule objects.

Summary

Returns Board Outline Clearance rule objects.

Syntax

IsRule_BoardOutlineClearance : Boolean

Example Usage

IsRule_BoardOutlineClearance
IsRule_BoardOutlineClearance = True
Returns all Board Outline Clearance rule objects.

Not IsRule_BoardOutlineClearance
IsRule_BoardOutlineClearance = False
Returns all objects except Board Outline Clearance rule objects.

Summary

Returns Un-Routed Net rule objects.

Syntax

IsRule_BrokenNets : Boolean

Example Usage

IsRule_BrokenNets
IsRule_BrokenNets = True
Returns all Un-Routed Net rule objects.

Not IsRule_BrokenNets
IsRule_BrokenNets = False
Returns all objects except Un-Routed Net rule objects.

Summary

Returns Clearance rule objects.

Syntax

IsRule_Clearance : Boolean

Example Usage

IsRule_Clearance
IsRule_Clearance = True
Returns all Clearance rule objects.

Not IsRule_Clearance
IsRule_Clearance = False
Returns all objects except Clearance rule objects.

Summary

Returns Component Clearance rule objects.

Syntax

IsRule_ComponentClearance : Boolean

Example Usage

IsRule_ComponentClearance
IsRule_ComponentClearance = True
Returns all Component Clearance rule objects.

Not IsRule_ComponentClearance
IsRule_ComponentClearance = False
Returns all objects except Component Clearance rule objects.

Summary

Returns Component Orientations rule objects.

Syntax

IsRule_ComponentRotations : Boolean

Example Usage

IsRule_ComponentRotations
IsRule_ComponentRotations = True
Returns all Component Orientations rule objects.

Not IsRule_ComponentRotations
IsRule_ComponentRotations = False
Returns all objects except Component Orientations rule objects.

Summary

Returns Room Definition rule (Confinement Constraint Rule) objects.

Syntax

IsRule_ConfinementConstraint : Boolean/Boolean_String

Example Usage

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.

Tips

This function is an alias for the IsRoom function.

Summary

Returns all violation objects.

Syntax

IsRule_Creepage : Boolean

Example Usage

IsRule_Creepage
IsRule_Creepage = True
Returns all violation objects.

Not IsRule_Creepage
IsRule_Creepage = False
Returns all objects except violation objects.

Summary

Returns Daisy Chain Stub Length rule objects.

Syntax

IsRule_DaisyChainStubLength : Boolean

Example Usage

IsRule_DaisyChainStubLength
IsRule_DaisyChainStubLength = True
Returns all Daisy Chain Stub Length rule objects.

Not IsRule_DaisyChainStubLength
IsRule_DaisyChainStubLength = False
Returns all objects except Daisy Chain Stub Length rule objects.

Summary

Returns Differential Pairs Routing rule objects.

Syntax

IsRule_DifferentialPairsRouting : Boolean

Example Usage

IsRule_DifferentialPairsRouting
IsRule_DifferentialPairsRouting = True
Returns all Differential Pairs Routing rule objects.

Not IsRule_DifferentialPairsRouting
IsRule_DifferentialPairsRouting = False
Returns all objects except Differential Pairs Routing rule objects.

Summary

Returns Fanout Control rule objects.

Syntax

IsRule_FanoutControl : Boolean

Example Usage

IsRule_FanoutControl
IsRule_FanoutControl = True
Returns all Fanout Control rule objects.

Not IsRule_FanoutControl
IsRule_FanoutControl = False
Returns all objects except Fanout Control rule objects.

Summary

Returns Flight Time - Falling Edge rule objects.

Syntax

IsRule_FlightTime_FallingEdge : Boolean

Example Usage

IsRule_FlightTime_FallingEdge
IsRule_FlightTime_FallingEdge = True
Returns all Flight Time - Falling Edge rule objects.

Not IsRule_FlightTime_FallingEdge
IsRule_FlightTime_FallingEdge = False
Returns all objects except Flight Time - Falling Edge rule objects.

Summary

Returns Flight Time - Rising Edge rule objects.

Syntax

IsRule_FlightTime_RisingEdge : Boolean

Example Usage

IsRule_FlightTime_RisingEdge
IsRule_FlightTime_RisingEdge = True
Returns all Flight Time - Rising Edge rule objects.

Not IsRule_FlightTime_RisingEdge
IsRule_FlightTime_RisingEdge = False
Returns all objects except Flight Time - Rising Edge rule objects.

Summary

Returns Hole To Hole Clearance rule objects.

Syntax

IsRule_HoleToHoleClearance : Boolean

Example Usage

IsRule_HoleToHoleClearance
IsRule_HoleToHoleClearance = True
Returns all Hole To Hole Clearance rule objects.

Not IsRule_HoleToHoleClearance
IsRule_HoleToHoleClearance = False
Returns all objects except Hole To Hole Clearance rule objects.

Summary

Returns Layer Pairs rule objects.

Syntax

IsRule_LayerPair : Boolean

Example Usage

IsRule_LayerPair
IsRule_LayerPair = True
Returns all Layer Pairs rule objects.

Not IsRule_LayerPair
IsRule_LayerPair = False
Returns all objects except Layer Pairs rule objects.

Summary

Returns Matched Lengths rule objects.

Syntax

IsRule_MatchedLengths : Boolean

Example Usage

IsRule_MatchedLengths
IsRule_MatchedLengths = True
Returns all Matched Lengths rule objects.

Not IsRule_MatchedLengths
IsRule_MatchedLengths = False
Returns all objects except Matched Lengths rule objects.

Summary

Returns Height rule objects.

Syntax

IsRule_MaxMinHeightConstraint : Boolean

Example Usage

IsRule_MaxMinHeightConstraint
IsRule_MaxMinHeightConstraint = True
Returns all Height rule objects.

Not IsRule_MaxMinHeightConstraint
IsRule_MaxMinHeightConstraint = False
Returns all objects except Height rule objects.

Summary

Returns Width rule objects.

Syntax

IsRule_MaxMinWidth : Boolean

Example Usage

IsRule_MaxMinWidth
IsRule_MaxMinWidth = True
Returns all Width rule objects.

Not IsRule_MaxMinWidth
IsRule_MaxMinWidth = False
Returns all objects except Width rule objects.

Summary

Returns Paste Mask Expansion rule objects.

Syntax

IsRule_PasteMaskExpansion : Boolean

Example Usage

IsRule_PasteMaskExpansion
IsRule_PasteMaskExpansion = True
Returns all Paste Mask Expansion rule objects.

Not IsRule_PasteMaskExpansion
IsRule_PasteMaskExpansion = False
Returns all objects except Paste Mask Expansion rule objects.

Summary

Returns Permitted Layers rule objects.

Syntax

IsRule_PermittedLayers : Boolean

Example Usage

IsRule_PermittedLayers
IsRule_PermittedLayers = True
Returns all Permitted Layers rule objects.

Not IsRule_PermittedLayers
IsRule_PermittedLayers = False
Returns all objects except Permitted Layers rule objects.

Summary

Returns Polygon Connect Style rule objects.

Syntax

IsRule_PolygonConnectStyle : Boolean

Example Usage

IsRule_PolygonConnectStyle
IsRule_PolygonConnectStyle = True
Returns all Polygon Connect Style rule objects.

Not IsRule_PolygonConnectStyle
IsRule_PolygonConnectStyle = False
Returns all objects except Polygon Connect Style rule objects.

Summary

Returns Power Plane Clearance rule objects.

Syntax

IsRule_PowerPlaneClearance : Boolean

Example Usage

IsRule_PowerPlaneClearance
IsRule_PowerPlaneClearance = True
Returns all Power Plane Clearance rule objects.

Not IsRule_PowerPlaneClearance
IsRule_PowerPlaneClearance = False
Returns all objects except Power Plane Clearance rule objects.

Summary

Returns Power Plane Connect Style rule objects.

Syntax

IsRule_PowerPlaneConnectStyle : Boolean

Example Usage

IsRule_PowerPlaneConnectStyle
IsRule_PowerPlaneConnectStyle = True
Returns all Power Plane Connect Style rule objects.

Not IsRule_PowerPlaneConnectStyle
IsRule_PowerPlaneConnectStyle = False
Returns all objects except Power Plane Connect Style rule objects.

Summary

Returns Routing Corners rule objects.

Syntax

IsRule_RoutingCornerStyle : Boolean

Example Usage

IsRule_RoutingCornerStyle
IsRule_RoutingCornerStyle = True
Returns all Routing Corners rule objects.

Not IsRule_RoutingCornerStyle
IsRule_RoutingCornerStyle = False
Returns all objects except Routing Corners rule objects.

Summary

Returns Routing Layers rule objects.

Syntax

IsRule_RoutingLayers : Boolean

Example Usage

IsRule_RoutingLayers
IsRule_RoutingLayers = True
Returns all Routing Layers rule objects.

Not IsRule_RoutingLayers
IsRule_RoutingLayers = False
Returns all objects except Routing Layers rule objects.

Summary

Returns Routing Priority rule objects.

Syntax

IsRule_RoutingPriority : Boolean

Example Usage

IsRule_RoutingPriority
IsRule_RoutingPriority = True
Returns all Routing Priority rule objects.

Not IsRule_RoutingPriority
IsRule_RoutingPriority = False
Returns all objects except Routing Priority rule objects.

Summary

Returns Routing Topology rule objects.

Syntax

IsRule_RoutingTopology : Boolean

Example Usage

IsRule_RoutingTopology
IsRule_RoutingTopology = True
Returns all Routing Topology rule objects.

Not IsRule_RoutingTopology
IsRule_RoutingTopology = False
Returns all objects except Routing Topology rule objects.

Summary

Returns Routing Via Style rule objects.

Syntax

IsRule_RoutingViaStyle : Boolean

Example Usage

IsRule_RoutingViaStyle
IsRule_RoutingViaStyle = True
Returns all Routing Via Style rule objects.

Not IsRule_RoutingViaStyle
IsRule_RoutingViaStyle = False
Returns all objects except Routing Via Style rule objects.

Summary

Returns Short-Circuit rule objects.

Syntax

IsRule_ShortCircuit : Boolean

Example Usage

IsRule_ShortCircuit
IsRule_ShortCircuit = True
Returns all Short-Circuit rule objects.

Not IsRule_ShortCircuit
IsRule_ShortCircuit = False
Returns all objects except Short-Circuit rule objects.

Summary

Returns SMD Neck-Down rule objects.

Syntax

IsRule_SMDNeckDown : Boolean

Example Usage

IsRule_SMDNeckDown
IsRule_SMDNeckDown = True
Returns all SMD Neck-Down rule objects.

Not IsRule_SMDNeckDown
IsRule_SMDNeckDown = False
Returns all objects except SMD Neck-Down rule objects.

Summary

Returns SMD To Corner rule objects.

Syntax

IsRule_SMDToCorner : Boolean

Example Usage

IsRule_SMDToCorner
IsRule_SMDToCorner = True
Returns all SMD To Corner rule objects.

Not IsRule_SMDToCorner
IsRule_SMDToCorner = False
Returns all objects except SMD To Corner rule objects.

Summary

Returns SMD To Plane rule objects.

Syntax

IsRule_SMDToPlane : Boolean

Example Usage

IsRule_SMDToPlane
IsRule_SMDToPlane = True
Returns all SMD To Plane rule objects.

Not IsRule_SMDToPlane
IsRule_SMDToPlane = False
Returns all objects except SMD To Plane rule objects.

Summary

Returns Solder Mask Expansion rule objects.

Syntax

IsRule_SolderMaskExpansion : Boolean

Example Usage

IsRule_SolderMaskExpansion
IsRule_SolderMaskExpansion = True
Returns all Solder Mask Expansion rule objects.

Not IsRule_SolderMaskExpansion
IsRule_SolderMaskExpansion = False
Returns all objects except Solder Mask Expansion rule objects.

Summary

Returns Un-Connected Pin rule objects.

Syntax

IsRule_UnconnectedPin : Boolean

Example Usage

IsRule_UnconnectedPin
IsRule_UnconnectedPin = True
Returns all Un-Connected Pin rule objects.

Not IsRule_UnconnectedPin
IsRule_UnconnectedPin = False
Returns all objects except Un-Connected Pin rule objects.

Summary

Returns split plane objects.

Syntax

IsSplitPlane : Boolean

Example Usage

IsSplitPlane
IsSplitPlane = True
Returns all split plane objects.

Not IsSplitPlane
IsSplitPlane = False
Returns all objects except split plane objects.

Summary

Returns all text-based objects that are using a Stroke font to display their text.

Syntax

IsStrokeText : Boolean

Example Usage

IsStrokeText
IsStrokeText = True
Returns all text-based objects that are using a Stroke font.

Not IsStrokeText
IsStrokeText = False
Returns all objects except text-based objects that are using a Stroke font.

Summary

Returns all text-based objects, irrespective of the type of font (Stroke, TrueType, BarCode) being used to display the text.

Syntax

IsText : Boolean

Example Usage

IsText
IsText = True
Returns all text-based objects.

Not IsText
IsText = False
Returns all objects except text-based objects.

Summary

Returns track objects.

Syntax

IsTrack : Boolean

Example Usage

IsTrack
IsTrack = True
Returns all track objects.

Not IsTrack
IsTrack = False
Returns all objects except track objects.

Summary

Returns all text-based objects that are using a TrueType font to display their text.

Syntax

IsTrueTypeText : Boolean

Example Usage

IsTrueTypeText
IsTrueTypeText = True
Returns all text-based objects that are using a TrueType font.

Not IsTrueTypeText
IsTrueTypeText = False
Returns all objects except text-based objects that are using a TrueType font.

Summary

Returns via objects.

Syntax

IsVia : Boolean

Example Usage

IsVia
IsVia = True
Returns all via objects.

Not IsVia
IsVia = False
Returns all objects except via objects.

Summary

Returns all violation objects.

Syntax

IsViolation : Boolean

Example Usage

IsViolation
IsViolation = True
Returns all violation objects.

Not IsViolation
IsViolation = False
Returns all objects except violation objects.

Summary

Returns Maximum Via Count rule objects.

Syntax

IsRule_MaximumViaCount : Boolean

Example Usage

IsRule_MaximumViaCount
IsRule_MaximumViaCount = True
Returns all Maximum Via Count rule objects.

Not IsRule_MaximumViaCount
IsRule_MaximumViaCount = False
Returns all objects except Maximum Via Count rule objects.

Summary

Returns Hole Size rule objects.

Syntax

IsRule_MaxMinHoleSize : Boolean

Example Usage

IsRule_MaxMinHoleSize
IsRule_MaxMinHoleSize = True
Returns all Hole Size rule objects.

Not IsRule_MaxMinHoleSize
IsRule_MaxMinHoleSize = False
Returns all objects except Hole Size rule objects.

Summary

Returns Impedance rule objects.

Syntax

IsRule_MaxMinImpedance : Boolean

Example Usage

IsRule_MaxMinImpedance
IsRule_MaxMinImpedance = True
Returns all Impedance rule objects.

Not IsRule_MaxMinImpedance
IsRule_MaxMinImpedance = False
Returns all objects except Impedance rule objects.

Summary

Returns Length rule objects.

Syntax

IsRule_MaxMinLength : Boolean

Example Usage

IsRule_MaxMinLength
IsRule_MaxMinLength = True
Returns all Length rule objects.

Not IsRule_MaxMinLength
IsRule_MaxMinLength = False
Returns all objects except Length rule objects.

Summary

Returns Slope - Falling Edge rule objects.

Syntax

IsRule_MaxSlope_FallingEdge : Boolean

Example Usage

IsRule_MaxSlope_FallingEdge
IsRule_MaxSlope_FallingEdge = True
Returns all Slope - Falling Edge rule objects.

Not IsRule_MaxSlope_FallingEdge
IsRule_MaxSlope_FallingEdge = False
Returns all objects except Slope - Falling Edge rule objects.

Summary

Returns Slope - Rising Edge rule objects.

Syntax

IsRule_MaxSlope_RisingEdge : Boolean

Example Usage

IsRule_MaxSlope_RisingEdge
IsRule_MaxSlope_RisingEdge = True
Returns all Slope - Rising Edge rule objects.

Not IsRule_MaxSlope_RisingEdge
IsRule_MaxSlope_RisingEdge = False
Returns all objects except Slope - Rising Edge rule objects.

Summary

Returns Minimum Annular Ring rule objects.

Syntax

IsRule_MinimumAnnularRing : Boolean

Example Usage

IsRule_MinimumAnnularRing
IsRule_MinimumAnnularRing = True
Returns all Minimum Annular Ring rule objects.

Not IsRule_MinimumAnnularRing
IsRule_MinimumAnnularRing = False
Returns all objects except Minimum Annular Ring rule objects.

Summary

Returns Minimum Solder Mask Sliver rule objects.

Syntax

IsRule_MinimumSolderMaskSliver : Boolean

Example Usage

IsRule_MinimumSolderMaskSliver
IsRule_MinimumSolderMaskSliver = True
Returns all Minimum Solder Mask Sliver rule objects.

Not IsRule_MinimumSolderMaskSliver
IsRule_MinimumSolderMaskSliver = False
Returns all objects except Minimum Solder Mask Sliver rule objects.

Summary

Returns Net Antennae rule objects.

Syntax

IsRule_NetAntennae : Boolean

Example Usage

IsRule_NetAntennae
IsRule_NetAntennae = True
Returns all Net Antennae rule objects.

Not IsRule_NetAntennae
IsRule_NetAntennae = False
Returns all objects except Net Antennae rule objects.

Summary

Returns Nets To Ignore rule objects.

Syntax

IsRule_NetsToIgnore : Boolean

Example Usage

IsRule_NetsToIgnore
IsRule_NetsToIgnore = True
Returns all Nets to Ignore rule objects.

Not IsRule_NetsToIgnore
IsRule_NetsToIgnore = False
Returns all objects except Nets to Ignore rule objects.

Summary

Returns Overshoot - Falling Edge rule objects.

Syntax

IsRule_Overshoot_FallingEdge : Boolean

Example Usage

IsRule_Overshoot_FallingEdge
IsRule_Overshoot_FallingEdge = True
Returns all Overshoot - Falling Edge rule objects.

Not IsRule_Overshoot_FallingEdge
IsRule_Overshoot_FallingEdge = False
Returns all objects except Overshoot - Falling Edge rule objects.

Summary

Returns Overshoot - Rising Edge rule objects.

Syntax

IsRule_Overshoot_RisingEdge : Boolean

Example Usage

IsRule_Overshoot_RisingEdge
IsRule_Overshoot_RisingEdge = True
Returns all Overshoot - Rising Edge rule objects.

Not IsRule_Overshoot_RisingEdge
IsRule_Overshoot_RisingEdge = False
Returns all objects except Overshoot - Rising Edge rule objects.

Summary

Returns Parallel Segment rule objects.

Syntax

IsRule_ParallelSegment : Boolean

Example Usage

IsRule_ParallelSegment
IsRule_ParallelSegment = True
Returns all Parallel Segment rule objects.

Not IsRule_ParallelSegment
IsRule_ParallelSegment = False
Returns all objects except Parallel Segment rule objects.

Summary

Returns all violation objects.

Syntax

IsRule_ReturnPath : Boolean

Example Usage

IsRule_ReturnPath
IsRule_ReturnPath = True
Returns all violation objects.

Not ReturnPath
IsRule_ReturnPath = False
Returns all objects except violation objects.

Summary

Returns Signal Base Value rule objects.

Syntax

IsRule_SignalBaseValue : Boolean

Example Usage

IsRule_SignalBaseValue
IsRule_SignalBaseValue = True
Returns all Signal Base Value rule objects.

Not IsRule_SignalBaseValue
IsRule_SignalBaseValue = False
Returns all objects except Signal Base Value rule objects.

Summary

Returns Signal Stimulus rule objects.

Syntax

IsRule_SignalStimulus : Boolean

Example Usage

IsRule_SignalStimulus
IsRule_SignalStimulus = True
Returns all Signal Stimulus rule objects.

Not IsRule_SignalStimulus
IsRule_SignalStimulus = False
Returns all objects except Signal Stimulus rule objects.

Summary

Returns Signal Top Value rule objects.

Syntax

IsRule_SignalTopValue : Boolean

Example Usage

IsRule_SignalTopValue
IsRule_SignalTopValue = True
Returns all Signal Top Value rule objects.

Not IsRule_SignalTopValue
IsRule_SignalTopValue = False
Returns all objects except Signal Top Value rule objects.

Summary

Returns Silk To Silk Clearance rule objects.

Syntax

IsRule_SilkToSilkClearance : Boolean

Example Usage

IsRule_SilkToSilkClearance
IsRule_SilkToSilkClearance = True
Returns all Silk To Silk Clearance rule objects.

Not IsRule_SilkToSilkClearance
IsRule_SilkToSilkClearance = False
Returns all objects except Silk To Silk Clearance rule objects.

Summary

Returns Silk To Solder Mask Clearance rule objects.

Syntax

IsRule_SilkToSolderMaskClearance : Boolean

Example Usage

IsRule_SilkToSolderMaskClearance
IsRule_SilkToSolderMaskClearance = True
Returns all Silk To Solder Mask Clearance rule objects.

Not IsRule_SilkToSolderMaskClearance
IsRule_SilkToSolderMaskClearance = False
Returns all objects except Silk To Solder Mask Clearance rule objects.

Summary

Returns Supply Nets rule objects.

Syntax

IsRule_SupplyNets : Boolean

Example Usage

IsRule_SupplyNets
IsRule_SupplyNets = True
Returns all Supply Nets rule objects.

Not IsRule_SupplyNets
IsRule_SupplyNets = False
Returns all objects except Supply Nets rule objects.

Summary

Returns Fabrication Testpoint Style rule objects.

Syntax

IsRule_TestPointStyle : Boolean

Example Usage

IsRule_TestPointStyle
IsRule_TestPointStyle = True
Returns all Fabrication Testpoint Style rule objects.

Not IsRule_TestPointStyle
IsRule_TestPointStyle = False
Returns all objects except Fabrication Testpoint Style rule objects.

Summary

Returns Fabrication Testpoint Usage rule objects.

Syntax

IsRule_TestPointUsage : Boolean

Example Usage

IsRule_TestPointUsage
IsRule_TestPointUsage = True
Returns all Fabrication Testpoint Usage rule objects.

Not IsRule_TestPointUsage
IsRule_TestPointUsage = False
Returns all objects except Fabrication Testpoint Usage rule objects.

Summary

Returns Undershoot - Falling Edge rule objects.

Syntax

IsRule_Undershoot_FallingEdge : Boolean

Example Usage

IsRule_Undershoot_FallingEdge
IsRule_Undershoot_FallingEdge = True
Returns all Undershoot - Falling Edge rule objects.

Not IsRule_Undershoot_FallingEdge
IsRule_Undershoot_FallingEdge = False
Returns all objects except Undershoot - Falling Edge rule objects.

Summary

Returns Undershoot - Rising Edge rule objects.

Syntax

IsRule_Undershoot_RisingEdge : Boolean

Example Usage

IsRule_Undershoot_RisingEdge
IsRule_Undershoot_RisingEdge = True
Returns all Undershoot - Rising Edge rule objects.

Not IsRule_Undershoot_RisingEdge
IsRule_Undershoot_RisingEdge = False
Returns all objects except Undershoot - Rising Edge rule objects.

Summary

Returns Vias Under SMD rule objects.

Syntax

IsRule_ViasUnderSMD : Boolean

Example Usage

IsRule_ViasUnderSMD
IsRule_ViasUnderSMD = True
Returns all Vias Under SMD rule objects.

Not IsRule_ViasUnderSMD
IsRule_ViasUnderSMD = False
Returns all objects except Vias Under SMD rule objects.

Summary

Returns all pad objects with square holes.

Syntax

HasSquareHole : Boolean/Boolean_String

Example Usage

HasSquareHole
HasSquareHole = True
HasSquareHole = 'True'

Returns all pad objects with square holes.

Not HasSquareHole
HasSquareHole = False
HasSquareHole = 'False'

Returns all objects except pad objects with square holes.

Summary

Returns all via and polygon (shielding copper) objects that are members of a via shielding group.

Syntax

InViaShielding : Boolean/Boolean_String

Example Usage

InViaShielding
InViaShielding = True
InViaShielding = 'True'

Returns all via and polygon (shielding copper) objects that are members of a via shielding group.

Not InViaShielding
InViaShielding = False
InViaShielding = 'False'

Returns all objects except via and polygon (shielding copper) objects that are members of a via shielding group.

Summary

Returns no objects - simply presents the region occupied by the PCB.

Syntax

IsBoard : Boolean/Boolean_String

Example Usage

IsBoard
IsBoard = True
IsBoard = 'True'

Returns no objects - simply presents the region occupied by the PCB.

Not IsBoard
IsBoard = False
IsBoard = 'False'

Returns all objects, while still presenting the region occupied by the PCB.

Summary

Returns no objects - simply presents the region occupied by the PCB.

Syntax

IsBoardOutline : Boolean/Boolean_String

Example Usage

IsBoardOutline
IsBoardOutline = True
IsBoardOutline = 'True'

Returns no objects - simply presents the region occupied by the PCB.

Not IsBoardOutline
IsBoardOutline = False
IsBoardOutline = 'False'

Returns all objects, while still presenting the region occupied by the PCB.

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.

Summary

Returns all differential pair objects.

Syntax

IsDifferentialPair : Boolean/Boolean_String

Example Usage

IsDifferentialPair
IsDifferentialPair = True
IsDifferentialPair = 'True'

Returns all differential pair objects.

Not IsDifferentialPair
IsDifferentialPair = False
IsDifferentialPair = 'False'

Returns all objects except differential pair objects.

Summary

Returns all embedded board array objects.

Syntax

IsEmbeddedBoard : Boolean/Boolean_String

Example Usage

IsEmbeddedBoard
IsEmbeddedBoard = True
IsEmbeddedBoard = 'True'

Returns all embedded board array objects.

Not IsEmbeddedBoard
IsEmbeddedBoard = False
IsEmbeddedBoard = 'False'

Returns all objects except embedded board array objects.

Summary

Returns all from-to objects.

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

Syntax

IsFromTo : Boolean/Boolean_String

Example Usage

IsFromTo
IsFromTo = True
IsFromTo = 'True'

Returns all from-to objects.

Not IsFromTo
IsFromTo = False
IsFromTo = 'False'

Returns all objects except from-to objects.

Summary

Returns all original dimension objects.

Syntax

IsOriginalDimension : Boolean/Boolean_String

Example Usage

IsOriginalDimension
IsOriginalDimension = True
IsOriginalDimension = 'True'

Returns all original dimension objects.

Not IsOriginalDimension
IsOriginalDimension = False
IsOriginalDimension = 'False'

Returns all objects except original dimension objects.

Summary

Returns all pad objects that have a valid hole. To be a valid hole, the pad's Hole Size property must be a non-zero value. Additionally, if the hole is slotted, it must have a non-zero length.

Syntax

IsPadHoleValid : Boolean/Boolean_String

Example Usage

IsPadHoleValid
IsPadHoleValid = True
IsPadHoleValid = 'True'

Returns all pad objects that have a valid hole.

Not IsPadHoleValid
IsPadHoleValid = False
IsPadHoleValid = 'False'

Returns all objects except pad objects that have a valid hole.

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.

Tips

This function is an alias for the IsRule_ConfinementConstraint function.

Summary

Returns all via objects that are members of a via shielding group.

Syntax

IsShieldingVia : Boolean/Boolean_String

Example Usage

IsShieldingVia
IsShieldingVia = True
IsShieldingVia = 'True'

Returns all via objects that are members of a via shielding group. Polygon (shielding copper) objects are also returned.

Not IsShieldingVia
IsShieldingVia = False
IsShieldingVia = 'False'

Returns all objects except via objects that are members of a via shielding group. Polygon (shielding copper) objects are also returned.

Summary

Returns all teardrop objects. Teardrops are often added to a routed PCB design to create stronger track-to-pad, track-to-via and track-to-track connections. This is valuable when the the design objects are very small, and is particularly valuable for drilled pads and vias, because mis-alignment between the drill center and the pad/via center can result in the drill hole removing much of the copper connecting the track to the pad/via - known as drill breakout. Each teardrop shape is created from a single region object, which can have straight or curved edges.

Syntax

IsTeardrop : Boolean/Boolean_String

Example Usage

IsTeardrop
IsTeardrop = True
IsTeardrop = 'True'

Returns all teardrop region objects.

Not IsTeardrop
IsTeardrop = False
IsTeardrop = 'False'

Returns all objects except teardrop region objects.

Summary

Returns all via objects that are members of a via stitching group.

Syntax

IsStitchingVia : Boolean/Boolean_String

Example Usage

IsStitchingVia
IsStitchingVia = True
IsStitchingVia = 'True'

Returns all via objects that are members of a via stitching group.

Not IsStitchingVia
IsStitchingVia = False
IsStitchingVia = 'False'

Returns all objects except via objects that are members of a via stitching group.

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.

Tips

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

Summary

Returns bottom side of board Back Drill sites.

Syntax

BackDrillBottom : Boolean

Example Usage

BackDrillBottom
BackDrillBottom = True

Returns all bottom side back drill sites.

Not BackDrillBottom
BackDrillBottom = False
Returns all objects except bottom side back drill sites.

Summary

Returns top side of board Back Drill sites.

Syntax

BackDrillTop : Boolean

Example Usage

BackDrillTop
BackDrillTop = True
Returns all top side back drill sites.

Not BackDrillTop
BackDrillTop = False
Returns all objects except top side back drill sites.

Summary

Returns thru via objects.

Syntax

IsThruVia : Boolean

Example Usage

IsThruVia
IsThruVia = True
Returns all thru via objects.

Not IsThruVia
IsThruVia = False
Returns all objects except thru via objects.

Summary

Returns µvia objects.

Syntax

IsMicroVia : Boolean

Example Usage

IsMicroVia
IsMicroVia = True
Returns all µvia objects.

Not IsMicroVia
IsMicroVia = False
Returns all objects except µvia objects.

Summary

Returns stacked via objects.

Syntax

IsStackedVia : Boolean

Example Usage

IsStackedVia
IsStackedVia = True
Returns all stacked via objects.

Not IsStackedVia
IsStackedVia = False
Returns all objects except stacked via objects.

Summary

Returns skip via objects.

Syntax

IsSkipVia : Boolean

Example Usage

IsSkipVia
IsSkipVia = True
Returns all skip via objects.

Not IsSkipVia
IsSkipVia = False
Returns all objects except skip via objects.

Summary

Returns blind via objects.

Syntax

IsBlindVia : Boolean

Example Usage

IsBlindVia
IsBlindVia = True
Returns all blind via objects.

Not IsBlindVia
IsBlindVia = False
Returns all objects except blind via objects.

Summary

Returns buried via objects.

Syntax

IsBuriedVia : Boolean

Example Usage

IsBuriedVia
IsBuriedVia = True
Returns all buried via objects.

Not IsBuriedVia
IsBuriedVia = False
Returns all objects except buried via objects.

Parameters

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.

Summary

Returns PCB components incorporating the specified Parameter Name.

Syntax

HasCompParameter(ParameterName : String) : Boolean

Example Usage

HasCompParameter(‘Design Item Id’)
HasCompParameter(‘Design Item Id’) = True

Returns all component parent objects that have the Design Item Id Parameter Name. The associated child objects of a complying component object, such as tracks, arcs, pads, text etc, are also returned.

Not HasCompParameter(‘Design Item Id’)
HasCompParameter(‘Design Item Id’) = False
Returns all components and their associated child objects, except for those component parent objects that have the Design Item Id Parameter.

Summary

Returns PCB components that incorporate the specified Parameter Name which has a Value that complies with the Query.

Syntax

HasCompParameterValue(ParameterName : String , ParameterValue : String) : Boolean

Example Usage

HasCompParameterValue(‘Design Item Id’,'LED-RED-HSMHC170')
HasCompParameterValue(‘Design Item Id’,'LED-RED-HSMHC170') = True

Returns all  component parent objects that have the Design Item Id Parameter Name with a matching Value property of LED-RED-HSMHC170. The associated child objects of a complying component object, such as tracks, arcs, pads, text etc, are also returned.

Not HasCompParameterValue(‘Design Item Status’,'RoHS-Compliant')
HasCompParameterValue(‘Design Item Status’,'RoHS-Compliant') = False

Returns all components and their associated child objects that do not have a Design Item Status Parameter with a Value of RoHS-Compliant.

Summary

Returns PCB objects incorporating the specified Parameter Name.

Syntax

HasParameter(ParameterName : String) : Boolean

Example Usage

HasParameter(‘Design Item Id’)
HasParameter(‘Design Item Id’) = True

Returns all objects that have the Design Item Id Parameter Name.

Not HasParameter(‘Design Item Id’)
HasParameter(‘Design Item Id’) = False

Returns all objects except those that have the Design Item Id Parameter.

Summary

Returns PCB objects incorporating the specified Parameter Name which has a Value that complies with the Query.

Syntax

HasParameterValue(ParameterName : String , ParameterValue : String) : Boolean

Example Usage

HasParameterValue(‘Design Item Id’,'LED-RED-HSMHC170')
HasParameterValue(‘Design Item Id’,'LED-RED-HSMHC170') = True

Returns all objects that have the Design Item Id Parameter Name and a matching Value property of LED-RED-HSMHC170.

Not HasParameterValue(‘Design Item Status’,'RoHS-Compliant')
HasParameterValue(‘Design Item Status’,'RoHS-Compliant') = False

Returns all objects that do not have a Design Item Status Parameter with a Value of RoHS-Compliant.

Summary

Returns the string Value of a PCB object Parameter, which can be tested to return PCB objects that comply to the Query.

Syntax

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.

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

Tips

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

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.

Tips

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
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

联系我们

联系原厂或当地办公室

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: