Fields

The Fields PCB query functions shown in the Query Helper dialog
This reference page details the query language keywords from the Fields category 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 or a Filter panel - and press F1 to access its section right away.
ArcRadius
Summary
Returns all arc objects whose Radius property complies with the Query.
Syntax
ArcRadius : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is greater than, or equal to, 15.24 current measurement units.
AsMils(ArcRadius) > 500
Returns all arc objects that have a Radius property that is greater than 500mil.
AsMM(ArcRadius) Between 10.16 And 17.78
Returns all arc objects that have a Radius property that 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 that is not equal to 550 current measurement units.
AsMils(ArcRadius) <= 650
Returns all arc objects that have a Radius property that is less than, or equal to, 650mil.
AsMM(ArcRadius) < 11.43
Returns all arc objects that have a Radius property that is less than 11.43mm.
Note
The Radius property is only defined for arc objects.
ArcStartAngle
Summary
Returns all arc objects whose Start Angle property complies with the Query.
Syntax
ArcStartAngle : Number
Example Usage
ArcStartAngle = 30.0
Returns all arc objects that have a Start Angle property that is 30.0 degrees.
ArcStartAngle > 60.0
Returns all arc objects that have a Start Angle property that is greater than 60.0 degrees.
ArcStartAngle Between 30.0 And 150.0
Returns all arc objects that have a Start Angle property that 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 that 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 that is between 315 degrees and 45 degrees.
Note
The Start Angle property is only defined for arc objects.
ArcStopAngle
Summary
Returns all arc objects whose Stop Angle property complies with the Query.
Syntax
ArcStopAngle : Number
Example Usage
ArcStopAngle = 30.0
Returns all arc objects that have a Stop Angle property that is 30.0 degrees.
ArcStopAngle > 60.0
Returns all arc objects that have a Stop Angle property that is greater than 60.0 degrees.
ArcStopAngle Between 30.0 And 150.0
Returns all arc objects that have a Stop Angle property that 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 that 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 that is between 315 degrees and 45 degrees.
Note
The Stop Angle property is only defined for arc objects.
Area
Summary
Returns all objects whose Area property complies with the Query.
Syntax
Area = Area_String
Area <> Area_String
Example Usage
Area = '29.4 sq.'
Returns all objects that have a Area property that is equal to 29.4 sq.mm.
Area <> '29.4 sq.'
Returns all objects that have a Area property that is not equal to 29.4 sq.mm.
Notes
-
The Area property is only defined for component, fill, polygon and region objects.
-
The child objects of the objects returned by the Query are not returned.
-
The single quote characters (
') at the start and end ofArea_Stringare mandatory.
AutoAssignedName
Summary
Returns all polygon pour objects whose Auto Assigned Name property complies with the Query.
Syntax
AutoAssignedName : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
AutoAssignedName = 'True'
Returns all polygon pour objects whose Auto Assigned Name property is enabled.
AutoAssignedName = 'False'
Returns all polygon pour objects whose Auto Assigned Name property is disabled.
AutoAssignedName <> 'True'
Not (AutoAssignedName = 'True')
Returns all objects except polygon pour objects whose Auto Assigned Name property is enabled.
AutoAssignedName <> 'False'
Not (AutoAssignedName = 'False')
Returns all objects except polygon pour objects whose Auto Assigned Name property is disabled.
Notes
- The Auto Assigned Name property is only defined for polygon pour objects.
- When viewing the properties for a selected polygon pour on the Properties panel, the Auto Assigned Name property is called Auto Naming.
AutoPosition
Summary
Returns all designator and comment objects (child text objects of component objects) whose Autoposition property complies with the Query.
Syntax
AutoPosition = AutoPosition_String
AutoPosition <> AutoPosition_String
AutoPosition_String must be one of the strings from the following list:
-
'Center' -
'Center-Above' -
'Center-Below' -
'Left-Above' -
'Left-Below' -
'Left-Center' -
'Manual' -
'Right-Above' -
'Right-Below' -
'Right-Center'
Example Usage
AutoPosition = 'Center'
Returns all designator and comment objects whose Autoposition property is Center.
AutoPosition <> 'Manual'
Returns all objects except designator and comment objects whose Autoposition property is Manual.
Notes
-
The single quote characters (') at the start and end of
AutoPosition_Stringare mandatory. - The Autoposition property is only defined for designator and comment objects.
BarCodeFontName
Summary
Returns all text string objects whose BarCode Text Font Name property complies with the Query.
Syntax
BarCodeFontName = FontName_String
BarCodeFontName <> FontName_String
FontName_String must use one of the names of the available TrueType and OpenType (a superset of TrueType) fonts found in the \Windows\Fonts folder.
Example Usage
BarCodeFontName = 'Arial'
Returns all text string objects whose BarCode Text Font Name property is Arial.
BarCodeFontName <> 'Batang'
Returns all objects except text string objects whose BarCode Text Font Name property is Batang.
Notes
-
The single quote characters (') at the start and end of
FontName_Stringare 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) whose BarCode Text Font Name property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeFontName = 'Arial').
BarCodeFullHeight
Summary
Returns all text string objects whose BarCode Full Height property complies with the Query.
Syntax
BarCodeFullHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that is equal to 300 current measurement units.
BarCodeFullHeight >= 5.08
Returns all text string objects that have a BarCode Full Height property that 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 that is greater than 400 mil.
AsMM(BarCodeFullHeight) Between 6.35 And 8.89
Returns all text string objects that have a BarCode Full Height property that is greater than or equal to 6.35 mm and less than or equal to 8.89 mm.
BarCodeFullHeight <> 550
Returns all text string objects that have a BarCode Full Height property that is not equal to 550 current measurement units.
AsMils(BarCodeFullHeight) <= 650
Returns all text string objects that have a BarCode Full Height property that is less than or equal to 650 mil.
AsMM(BarCodeFullHeight) < 11.43
Returns all text string objects that have a BarCode Full Height property that is less than 11.43 mm.
Notes
-
The BarCode Full Height property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Full Height property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeFullHeight = 210).
BarCodeFullWidth
Summary
Returns all text string objects whose BarCode Full Width property complies with the Query.
Syntax
BarCodeFullWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that is equal to 1050 current measurement units.
BarCodeFullWidth >= 500
Returns all text string objects that have a BarCode Full Width property that 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 that is greater than 400mil.
AsMM(BarCodeFullWidth) Between 635 And 889
Returns all text string objects that have a BarCode Full Width property that 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 that is not equal to 550 current measurement units.
AsMils(BarCodeFullWidth) <= 650
Returns all text string objects that have a BarCode Full Width property that is less than or equal to 650mil.
AsMM(BarCodeFullWidth) < 1143
Returns all text string objects that have a BarCode Full Width property that is less than 1143mm.
Notes
-
The BarCode Full Width property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Full Width property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeFullWidth = 1050).
BarCodeInverted
Summary
Returns all text string objects whose BarCode Inverted property complies with the Query.
Syntax
BarCodeInverted : Boolean_String
Example Usage
BarCodeInverted = 'True'
Returns all text string objects whose BarCode Inverted property is enabled.
BarCodeInverted = 'False'
Returns all text string objects whose BarCode Inverted property is disabled.
Notes
-
The BarCode Inverted property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Inverted property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeInverted = 'True').
BarCodeMinWidth
Summary
Returns all text string objects whose BarCode Min Width property complies with the Query.
Syntax
BarCodeMinWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that is equal to 10 current measurement units.
BarCodeMinWidth >= 5
Returns all text string objects that have a BarCode Min Width property that 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 that is greater than 4mil.
AsMM(BarCodeMinWidth) Between 6.35 And 8.89
Returns all text string objects that have a BarCode Min Width property that 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 that 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 that is less than or equal to 6.50mil.
AsMM(BarCodeMinWidth) < 6.43
Returns all text string objects that have a BarCode Min Width property that is less than 6.43mm.
Notes
-
The BarCode Min Width property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Min Width property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeMinWidth = 6.25).
BarCodeRenderMode
Summary
Returns all text string objects whose BarCode Render Mode property complies with the Query.
Syntax
BarCodeRenderMode = RenderMode_String
BarCodeRenderMode <> RenderMode_String
RenderMode_String must be one of the strings from the following list:
-
'By BarCode Full Width' -
'By BarCode Min Width'
Example Usage
BarCodeRenderMode = 'By BarCode Full Width'
Returns all text string objects whose BarCode Render Mode property is By BarCode Full Width.
BarCodeRenderMode <> 'By BarCode Min Width'
Returns all objects except text string objects whose BarCode Render Mode property is By BarCode Min Width.
Notes
-
The single quote characters (') at the start and end of
RenderMode_Stringare 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) whose BarCode Render Mode property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeRenderMode = 'By BarCode Full Width').
BarCodeShowText
Summary
Returns all text string objects whose BarCode Show Text property complies with the Query.
Syntax
BarCodeShowText : Boolean_String
Example Usage
BarCodeShowText = 'True'
Returns all text string objects whose BarCode Show Text property is enabled.
BarCodeShowText = 'False'
Returns all text string objects whose BarCode Show Text property is disabled.
Notes
-
The BarCode Show Text property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Show Text property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeShowText = 'True').
BarCodeType
Summary
Returns all text string objects whose BarCode Type property complies with the Query.
Syntax
BarCodeType = CodeType_String
BarCodeType <> CodeType_String
CodeType_String must be one of the strings from the following list:
-
'Code 39' -
'Code 128'
Example Usage
BarCodeType = 'Code 39'
Returns all text string objects whose BarCode Type property is Code 39.
BarCodeType <> 'Code 128'
Returns all objects except text string objects whose BarCode Type property is Code 128.
Notes
-
The single quote characters (') at the start and end of
CodeType_Stringare 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) whose BarCode Type property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeType = 'Code 39').
BarCodeXMargin
Summary
Returns all text string objects whose BarCode X Margin property complies with the Query.
Syntax
BarCodeXMargin : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that is greater than 40 mil.
AsMM(BarCodeXMargin) Between 0.5 And 0.89
Returns all text string objects that have a BarCode X Margin property that is greater than or equal to 0.5 mm and less than or equal to 0.89 mm.
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 that is less than or equal to 15 mil.
AsMM(BarCodeXMargin) < 1.23
Returns all text string objects that have a BarCode X Margin property that is less than 1.23 mm.
Notes
-
The BarCode X Margin property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode X Margin property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeXMargin = 20).
BarCodeYMargin
Summary
Returns all text string objects whose BarCode Y Margin property complies with the Query.
Syntax
BarCodeYMargin : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that is greater than 40 mil.
AsMM(BarCodeYMargin) Between 0.5 And 0.89
Returns all text string objects that have a BarCode Y Margin property that is greater than or equal to 0.5 mm and less than or equal to 0.89 mm.
BarCodeYMargin <> 20
Returns all text string objects that have a BarCode Y Margin property that is not equal to 20 current measurement units.
AsMils(BarCodeYMargin) <= 15
Returns all text string objects that have a BarCode Y Margin property that is less than or equal to 15 mil.
AsMM(BarCodeYMargin) < 1.23
Returns all text string objects that have a BarCode Y Margin property that is less than 1.23 mm.
Notes
-
The BarCode Y Margin property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Y Margin property complies with the Query. If you want 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 is
IsBarCodeText And (BarCodeYMargin = 20).
BodyColor3D
Summary
Returns all 3D body objects whose Body 3-D Color property complies with the Query.
Syntax
BodyColor3D : Numeric_String
BodyColor3D : Number
The 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 that is less than or equal to 192.
Note
The Body 3-D Color property is only defined for 3D body objects.
BodyColor3DOpacity
Summary
Returns all 3D body objects whose Body 3-D Color Opacity property complies with the Query.
Syntax
BodyColor3DOpacity : Numeric_String
BodyColor3DOpacity : Number
Example Usage
BodyColor3DOpacity = '1'
BodyColor3DOpacity = 1
Returns all 3D body objects whose Body 3-D Color Opacity property is 1.000.
BodyColor3DOpacity <> '0.5'
BodyColor3DOpacity <> 0.5
Returns all objects except 3D body objects whose Body 3-D Color Opacity property is 0.500.
Note
The Body 3-D Color Opacity property is only defined for 3D body objects.
BodyColor3DOverride
Summary
Returns all 3D Body objects whose Override Color property complies with the Query.
Syntax
BodyColor3DOverride : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
BodyColor3DOverride = 'True'
Returns all 3D Body objects whose Override Color property is enabled.
BodyColor3DOverride = 'False'
Returns all 3D Body objects whose Override Color property is disabled.
BodyColor3DOverride <> 'True'
Not (BodyColor3DOverride = 'True')
Returns all objects except 3D Body objects whose Override Color property is enabled.
BodyColor3DOverride <> 'False'
Not (BodyColor3DOverride = 'False')
Returns all objects except 3D Body objects whose Override Color property is disabled.
Note
The Override Color property is only defined for 3D Body objects.
BodyProjection
Summary
Returns all 3D body objects whose Body Projection property complies with the Query.
Syntax
BodyProjection = BodyProjection_String
BodyProjection <> BodyProjection_String
BodyProjection_String must be one of the strings from the following list:
-
'Top Side' -
'Bottom Side'
Example Usage
BodyProjection = 'Top Side'
Returns all 3D body objects whose Body Projection property is Top Side.
BodyProjection <> 'Bottom Side'
Returns all objects except 3D body objects whose Body Projection property is Bottom Side.
Notes
- The Body Projection property is only defined for 3D body objects.
-
The single quote characters (') at the start and end of
BodyProjection_Stringare mandatory.
CappingMaterial
Summary
Returns all via objects whose Capping Material property complies with the Query.
Syntax
CappingMaterial : String
Example Usage
CappingMaterial = 'Epoxy'
Returns all via objects whose Capping Material property is Epoxy.
CappingMaterial Like 'Epoxy*'
Returns all via objects that have a Capping Material whose associated string commences with Epoxy.
Notes
- The Capping Material property is only defined for via objects.
-
The single quote characters (') at the start and end of
Stringare mandatory.
CappingSide
Summary
Returns all via objects whose Capping Side property complies with the Query.
Syntax
CappingSide = CappingSide_String
CappingSide <> CappingSide_String
CappingSide_String must be one of the strings from the following list:
-
'Top' -
'Bottom' -
'Both'
Example Usage
CappingSide = 'Top'
Returns all via objects whose Capping Side property is Top.
CappingSide <> 'Both'
Returns all objects except via objects whose Capping Side property is Both.
CappingSide = 'Top' || CappingSide = 'Bottom'
IsVia && CappingSide <> 'Both'
Returns all objects except via objects whose Capping Side property is Both.
Notes
- The Capping Side property is only defined for via objects.
-
The single quote characters (
') at the start and end ofCappingSide_Stringare mandatory.
CavityHeight
Summary
Returns all region objects whose Cavity Height property complies with the Query.
Syntax
CavityHeight : Numeric_String
Example Usage
CavityHeight = '70'
Returns all region objects whose Cavity Height property is equal to 70.
CavityHeight Between '200' And '400'
Returns all region objects whose Cavity Height property is greater than or equal to 200 and less than or equal to 400.
CavityHeight >= '100'
Returns all region objects whose Cavity Height property is greater than or equal to 100.
CavityHeight <> '120'
Returns all objects except region objects whose Cavity Height property is equal to 120.
Note
The Cavity Height property is only defined for region objects and is only meaningful for regions whose Kind property has been set to Cavity.
ChamferFilletSize
Summary
Returns all rectangle objects whose Chamfer/Fillet Size property complies with the Query.
Syntax
ChamferFilletSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the use of an additional measurement unit-based keyword:
-
AsMils(ChamferFilletSize) : Number– to specify a width in mil. -
AsMM(ChamferFilletSize) : Number– to specify a width in mm.
Example Usage
ChamferFilletSize = 20
Returns all rectangle objects that have an Chamfer/Fillet Size property which is 20 current measurement units.
ChamferFilletSize >= 1.27
Returns all rectangle objects that have an Chamfer/Fillet Size property that is greater than, or equal to, 1.27 current measurement units.
AsMils(ChamferFilletSize) Between 10 And 30
Returns all rectangle objects that have an Chamfer/Fillet Size property that is greater than, or equal to, 10 mil and less than, or equal to, 30 mil.
AsMM(ChamferFilletSize) < 1.016
Returns all rectangle objects that have an Chamfer/Fillet Size property that is less than 1.016 mm.
Note
The Chamfer/Fillet Size property is only defined for rectangle objects and is only meaningful for rectangles whose Corner Mode property has been set to Chamfer or Fillet.
ChannelOffset
Summary
Returns all component objects whose Channel Offset property complies with the Query.
Syntax
ChannelOffset : Numeric_String
ChannelOffset : Number
Example Usage
ChannelOffset = '2'
ChannelOffset <> '' && ChannelOffset = 2
Returns all component objects whose Channel Offset property is 2.
ChannelOffset > '' && ChannelOffset Between 3 And 5
Returns all component objects whose Channel Offset property is greater than, or equal to, 3 and less than, or equal to, 5.
IsComponent && ChannelOffset < 4
Returns all component objects whose Channel Offset property is less than 4.
ObjectKind = 'Component' && ChannelOffset >= 4
Returns all component objects whose Channel Offset property is greater than, or equal to, 4.
ChannelOffset <> '1'
Returns all objects except component objects whose Channel Offset property is 1.
IsComponent && ChannelOffset <> 1
Returns all component objects whose Channel Offset property is not equal to 1.
Notes
-
The Channel Offset property is only defined for component objects.
-
The child objects of component objects returned by the Query are not returned.
ClassType
Summary
Returns all class objects whose Class Type property complies with the Query.
Syntax
ClassType = ClassType_String
ClassType <> ClassType_String
ClassType_String must be one of the strings from the following list:
-
'Component Class' -
'Design Channel' -
'DiffPair Class' -
'From To Class' -
'Layer Class' -
'Net Class' -
'Pad Class' -
'Polygon Class' -
'Structure Class' -
'xSignal Class'
Example Usage
ClassType = 'Component Class'
Returns all class objects whose Class Type property is Component Class.
ClassType <> 'Layer Class'
Returns all objects except class objects whose Class Type property is Layer Class.
Notes
- The Class Type property is only defined for class objects.
-
The single quote characters (') at the start and end of
ClassType_Stringare mandatory.
Color
Summary
Returns all Net objects whose Color property complies with the Query.
Syntax
Color : Numeric_String
Color : Number
The color corresponding to a particular number can be deduced from the following relationship:
65536 * Blue + 256 * Green + Red
where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).
When the Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:
- Blue = Color Div 65536
- Green = Color Div 256 Mod 256
- Red = Color Mod 256
Example Usage
Color = '0'
Color <> '' && Color = 0
Returns all Net objects whose Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).
Color = '16711680'
Color > '' && Color = 16711680
Returns all Net objects whose Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).
Color <> '16777215'
Returns all objects except Net objects whose Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).
ObjectKind = 'Net' && Color <> 16777215
Returns all Net objects whose Color property is not 16777215.
IsNet && Color Div 65536 >= 96 && Color Div 256 Mod 256 Between 64 And 192 && Color Mod 256 <= 128
Returns all Net objects whose Color property is such that the Blue component has a value that 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 that 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 that is greater than or equal to 64 and less than or equal to 192.
Notes
- The Color property is only defined for Net objects.
- The child objects of Net objects returned by the Query, are not returned.
Comment
Summary
Returns all component objects whose Component Comment property complies with the Query.
Syntax
Comment : String
Example Usage
Comment = '100nF'
Returns all components that have a Component Comment of 100 nF.
Comment <> '100nF'
Returns all objects except component objects that have a Component Comment of 100 nF.
Notes
- The Component Comment property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
Component
Summary
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 includes at least one additional character.
Component <> 'C1'
Returns all objects except the child objects of any component that has a Name of C1.
Component = 'Free'
Returns all objects except the child objects of component objects.
Note
The parent component objects of child objects returned by this Query are not returned.
ComponentFlippedOnLayer
Summary
Returns all component objects whose Flipped On Layer property complies with the Query.
Syntax
ComponentFlippedOnLayer : Boolean_String
Example Usage
ComponentFlippedOnLayer = 'True'
Returns all component objects whose Flipped On Layer property is enabled.
ComponentFlippedOnLayer = 'False'
Returns all component objects whose Flipped On Layer property is disabled.
Note
The Flipped On Layer property is only defined for component objects.
ComponentStringsLocked
Summary
Returns all component objects whose Lock Strings property complies with the Query.
Syntax
ComponentStringsLocked : Boolean_String
Example Usage
ComponentStringsLocked = 'True'
Returns all components whose Lock Strings property is enabled.
ComponentStringsLocked = 'False'
Returns all components whose Lock Strings property is disabled.
Note
The child objects of components returned by the Query are not returned.
ComponentType
Summary
Returns all component objects having a Component Type property that complies with the Query.
Syntax
ComponentType = ComponentType_String
ComponentType <> ComponentType_String
ComponentType_String must be one of the strings from the following list:
- 'Graphical'
- 'Jumper'
- 'Mechanical'
- 'Net Tie'
- 'Net Tie (In BOM)'
- 'Standard'
- 'Standard (No BOM)'
Example Usage
ComponentType = 'Graphical'
Returns all components whose Component Type is Graphical.
ComponentType <> 'Standard'
Returns all objects except components whose Component Type is Standard.
Notes
- The Component Type property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
-
The single quote characters (') at the start and end of
ComponentType_Stringare mandatory.
CoordinateDimensionLineWidth
Summary
Returns coordinate and original dimension objects whose Line Width (Coord/Dimen) property complies with the Query.
Syntax
CoordinateDimensionLineWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 8 mil and less than or equal to 12 mil.
AsMM(CoordinateDimensionLineWidth) < 0.2794
Returns all coordinate and original dimension objects that have a Line Width (Coord/Dimen) property which is less than 0.2794 mm.
Notes
- The Line Width (Coord/Dimen) property is only defined for coordinate and dimension objects.
- The child objects of coordinate and original dimension objects returned by the Query are not returned.
CoordinateDimensionSize
Summary
Returns coordinate, center dimension, leader dimension, and original dimension objects whose Size (Coord/Dimen) property complies with the Query.
Syntax
CoordinateDimensionSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that 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 that is greater than or equal to 8 mil and less than or equal to 12 mil.
AsMM(CoordinateDimensionSize) < 0.2794
Returns all coordinate, center dimension, leader dimension, and original dimension objects that have a Size (Coord/Dimen) property that is less than 0.2794 mm.
Notes
- The Size (Coord/Dimen) property is only defined for coordinate, center dimension, leader dimension, and original dimension objects.
- The child objects of coordinate, center dimension, leader dimension, and original dimension objects returned by the Query are not returned.
CoordinateDimensionUnitStyle
Summary
Returns all coordinate and original dimension objects whose Unit Style property complies with the Query.
Syntax
CoordinateDimensionUnitStyle = UnitStyle_String
CoordinateDimensionUnitStyle <> UnitStyle_String
UnitStyle_String must be one of the strings from the following list:
-
'Brackets' -
'None' -
'Normal'
Example Usage
CoordinateDimensionUnitStyle = 'Brackets'
Returns all coordinate and original dimension objects whose Unit Style property is Brackets.
CoordinateDimensionUnitStyle <> 'Normal'
Returns all objects except coordinate and original dimension objects whose Unit Style property is Normal.
Notes
- The Unit Style property is only defined for coordinate and original dimension objects.
-
The single quote characters (') at the start and end of
UnitStyle_Stringare mandatory. - The child objects of coordinate and original dimension objects returned by the Query are not returned.
CornerMode
Summary
Returns all rectangle objects whose Corner Mode property complies with the Query.
Syntax
CornerMode = CornerMode_String
CornerMode <> CornerMode_String
CornerMode_String must be one of the strings from the following list:
-
'Rectangle' -
'Chamfer' -
'Fillet'
Example Usage
CornerMode = 'Rectangle'
Returns all rectangle objects whose Corner Mode property is Rectangle.
CornerMode <> 'Chamfer'
Returns all objects except rectangle objects whose Corner Mode property is Chamfer.
CornerMode = 'Chamfer' || CornerMode = 'Fillet'
Returns all objects except rectangle objects whose Corner Mode property is Rectangle.
Notes
- The Corner Mode property is only defined for rectangle objects.
-
The single quote characters (
') at the start and end ofCornerMode_Stringare mandatory.
CoveringMaterial
Summary
Returns all via objects whose Covering Material property complies with the Query.
Syntax
CoveringMaterial : String
Example Usage
CoveringMaterial = 'Epoxy'
Returns all via objects whose Covering Material property is Epoxy.
CoveringMaterial Like 'Epoxy*'
Returns all via objects that have a Covering Material whose associated string commences with Epoxy.
Notes
- The Covering Material property is only defined for via objects.
-
The single quote characters (
') at the start and end ofStringare mandatory.
CoveringSide
Summary
Returns all via objects whose Covering Side property complies with the Query.
Syntax
CoveringSide = Covering_String
CoveringSide <> Covering_String
Covering_String must be one of the strings from the following list:
-
'Top' -
'Bottom' -
'Both'
Example Usage
CoveringSide = 'Top'
Returns all via objects whose Covering Side property is Top.
CoveringSide <> 'Both'
Returns all objects except via objects whose Covering Side property is Both.
CoveringSide = 'Top' || CoveringSide = 'Bottom'
IsVia && CoveringSide <> 'Both'
Returns all objects except via objects whose Covering Side property is Both.
Notes
-
The Covering Side property is only defined for via objects.
-
The single quote characters (
') at the start and end ofCovering_Stringare mandatory.
DataMatrixInverted
Summary
Returns all text string objects whose BarCode Inverted property complies with the Query.
Syntax
DataMatrixInverted : Boolean_String
Example Usage
DataMatrixInverted = 'True'
Returns all text string objects whose BarCode Inverted property is enabled.
DataMatrixInverted = 'False'
Returns all text string objects whose BarCode Inverted property is disabled.
Notes
-
The BarCode Inverted property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table) whose BarCode Inverted property complies with the Query. If you want to target solely text string objects that have been configured as QR code text, use an additional keyword prefix to target those objects. An example query expression is
IsDataMatrixText And (DataMatrixInverted = 'True').
DimensionArrowGap
Summary
Returns all leader dimension objects whose Arrow Gap property complies with the Query.
Syntax
DimensionArrowGap : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that is greater than, or equal to, 8 mil and less than, or equal to, 12 mil.
AsMM(DimensionArrowGap) < 0.2794
Returns all leader dimension objects that have an Arrow Gap property that is less than 0.2794 mm.
Notes
- The Arrow Gap property is only defined for leader dimension objects.
- The child objects of leader dimension objects returned by the Query are not returned.
DimensionArrowLength
Summary
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects whose Arrow Length property complies with the Query.
Syntax
DimensionArrowLength : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that 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 that is greater than, or equal to, 80 mil and less than, or equal to, 120 mil.
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 that is less than 2.794 mm.
Notes
-
The Arrow Length property is only defined for angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects.
-
The child objects of angular dimension, baseline dimension, linear diameter dimension, linear dimension, and radial diameter dimension objects returned by the Query are not returned.
DimensionArrowLineWidth
Summary
Returns all angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Line Width property complies with the Query.
Syntax
DimensionArrowLineWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that 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 that is greater than, or equal to, 8 mil and less than, or equal to, 12 mil.
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 that is less than 0.2794 mm.
Notes
-
The Arrow Line Width property is only defined for angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionArrowPosition
Summary
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property complies with the Query.
Syntax
DimensionArrowPosition = ArrowPosition_String
DimensionArrowPosition <> ArrowPosition_String
ArrowPosition_String must be one of the strings from the following list:
-
'Inside' -
'Outside'
Example Usage
DimensionArrowPosition = 'Inside'
Returns all angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property is Inside.
DimensionArrowPosition <> 'Outside'
Returns all objects except angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Arrow Position property is Outside.
Notes
-
The single quote characters (') at the start and end of
ArrowPosition_Stringare mandatory. -
The Arrow Position property is only defined for angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionArrowSize
Summary
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that 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 that is greater than, or equal to, 50 mil and less than, or equal to, 70 mil.
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 that is less than 2.032 mm.
Notes
-
The Arrow Size property is only defined for angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionExtensionLineWidth
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects whose Extension Line Width property complies with the Query.
Syntax
DimensionExtensionLineWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through the 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 that 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 that 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 that is greater than, or equal to, 8 mil and less than, or equal to, 12 mil.
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 that is less than 0.2794 mm.
Notes
-
The Extension Line Width property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects returned by the Query are not returned.
DimensionExtensionOffset
Summary
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects whose Extension Offset property complies with the Query.
Syntax
DimensionExtensionOffset : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001inch) or Metric (mm; 1 mm = 0.001 meter).
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 that 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 that is greater than, or equal to, 8 mil and less than, or equal to, 12 mil.
AsMM(DimensionExtensionOffset) < 0.2794
Returns all angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects that have an Extension Offset property that is less than 0.2794 mm.
Notes
-
The Extension Offset property is only defined for angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects.
-
The child objects of angular dimension, baseline dimension, linear diameter dimension, and linear dimension objects returned by the Query are not returned.
DimensionExtensionPickGap
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects whose Extension Pick Gap property complies with the Query.
Syntax
DimensionExtensionPickGap : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001inch) or Metric (mm; 1 mm = 0.001 meter).
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 that 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 that is greater than, or equal to, 8 mil and less than, or equal to, 12 mil.
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 that is less than 0.2794 mm.
Notes
-
The Extension Pick Gap property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, and linear dimension objects returned by the Query are not returned.
DimensionTextFont
Summary
Returns all angular dimensions, baseline dimensions, datum dimensions, leader dimensions, linear diameter dimensions, linear dimensions, original dimensions, radial diameter dimensions, and radial dimension objects whose Dimension Font property complies with the Query.
Syntax
DimensionTextFont = Font_String
DimensionTextFont <> Font_String
Font_String must be one of the strings from the following list:
-
'Default' -
'Serif' -
'Sans Serif'
Example Usage
DimensionTextFont = 'Default'
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Font property is Default.
DimensionTextFont <> 'Serif'
Returns all objects except angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects whose Dimension Font property is Serif.
Notes
-
The single quote characters (') at the start and end of
Font_Stringare mandatory. -
The Dimension Font property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextFormat
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property complies with the Query.
Syntax
DimensionTextFormat = TextFormat_String
DimensionTextFormat <> TextFormat_String
TextFormat_String must be 'None'.
Example Usage
DimensionTextFormat = 'None'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. no values and units are displayed).
DimensionTextFormat <> 'None'
Returns all objects except angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. will return those applicable dimension objects whose format is set to show the value only, the value and units, or the value and units (with the latter in brackets)).
Notes
-
The single quote characters (') at the start and end of
TextFormat_Stringare mandatory. -
The Dimension Format property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextGap
Summary
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Gap property complies with the Query.
Syntax
DimensionTextGap : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:
-
AsMils(DimensionTextGap) : Number– to specify a gap in mil. -
AsMM(DimensionTextGap) : Number– to specify a gap in mm.
Example Usage
DimensionTextGap = 10
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects that have a 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 a Dimension Text Gap property that 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 a Dimension Text Gap property that 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 a Dimension Text Gap property that is less than 0.2794mm.
Notes
-
The Dimension Text Gap property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.
DimensionTextHeight
Summary
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Dimension Text Height property that 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 a Dimension Text Height property that 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 a Dimension Text Height property that is greater than, or equal to, 40mil and less than, or equal to, 80 mil.
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 a Dimension Text Height property that is less than 1.778 mm.
Notes
-
The Dimension Text Height property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
-
For the original dimension, the value for the Dimension Text Height property follows the value for the dimension's Text Height property.
DimensionTextLineWidth
Summary
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Dimension Text Line Width property that 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 a Dimension Text Line Width property that 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 a Dimension Text Line Width property that 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 a Dimension Text Line Width property that is less than 0.1778mm.
Notes
-
The Dimension Text Line Width property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, original dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
-
For the original dimension, the value for the Dimension Text Line Width property follows the value for the dimension's Text Width property.
DimensionTextPosition
Summary
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property complies with the Query.
Syntax
DimensionTextPosition = DimensionTextPosition_String
DimensionTextPosition <> DimensionTextPosition_String
DimensionTextPosition_String must be one of the strings from the following list:
-
'Aligned - Bottom' -
'Aligned - Center' -
'Aligned - Inside Left' -
'Aligned - Inside Right' -
'Aligned - Left' -
'Aligned - Right' -
'Aligned - Top' -
'Automatic' -
'Manual' -
'Unidirectional'
Example Usage
DimensionTextPosition = 'Automatic'
Returns all angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property is Automatic.
DimensionTextPosition <> 'Manual'
Returns all objects except angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Text Position property is Manual.
Notes
-
The single quote characters (') at the start and end of
DimensionTextPosition_Stringare mandatory. -
The Dimension Text Position property is only defined for angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, leader dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextPrecision
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property complies with the Query.
Syntax
DimensionTextPrecision : Numeric_String
DimensionTextPrecision : Number
Example Usage
DimensionTextPrecision = '2'
DimensionTextPrecision <> '' && DimensionTextPrecision = 2
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is 2.
DimensionTextPrecision > '' && DimensionTextPrecision Between 3 And 5
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is greater than, or equal to, 3 and less than, or equal to, 5.
IsDimension && DimensionTextPrecision < 4
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is less than 4.
DimensionTextPrecision <> '1'
Returns all objects except angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is 1.
IsDimension && DimensionTextPrecision <> 1
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Precision property is not equal to 1.
Notes
-
The Dimension Precision property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextPrefix
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Prefix property complies with the Query.
Syntax
DimensionTextPrefix : String
Example Usage
DimensionTextPrefix = 'ø'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Prefix property is ø.
Notes
-
The Dimension Prefix property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextSuffix
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Suffix property complies with the Query.
Syntax
DimensionTextSuffix : String
Example Usage
DimensionTextSuffix = '(+/- 0.5%)'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Suffix property is (+/- 0.5%).
Notes
-
The Dimension Suffix property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DimensionTextUnit
Summary
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property complies with the Query.
Syntax
DimensionTextUnit = DimensionUnit_String
DimensionTextUnit <> DimensionUnit_String
For angular dimension objects, DimensionUnit_String must be one of the strings from the following list:
-
'Degrees' -
'Radians'
For baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects, DimensionUnit_String must be one of the strings from the following list:
-
'Automatic' -
'Centimeters' -
'Inches' -
'Millimeters' -
'Mils'
Example Usage
DimensionTextUnit = 'Radians'
Returns all angular dimension objects whose Dimension Unit property is Radians.
DimensionTextUnit <> 'Degrees'
Returns all objects except angular dimension objects whose Dimension Unit property is Degrees.
DimensionTextUnit = 'Mils'
Returns all baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property is Mils.
DimensionTextUnit <> 'Inches'
Returns all objects except baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Unit property is Inches.
Notes
-
The single quote characters (') at the start and end of
DimensionUnit_Stringare mandatory. -
The Dimension Unit property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
-
The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query are not returned.
DrillPair
Summary
Returns all via objects whose Drill Pair property complies with the Query.
Syntax
DrillPair = 'Start Layer - Stop Layer'
Example Usage
DrillPair = 'Top Layer - Bottom Layer'
Returns all via objects whose Drill Pair property is Top Layer - Bottom Layer.
DrillPair <> 'Signal Layer 1 - Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property is Signal Layer 1 - Signal Layer 2.
IsVia && DrillPair <> 'Top Layer - Bottom Layer'
Returns all Via objects except those whose Drill Pair property is Top Layer - Bottom Layer.
Notes
- The single quote characters (') at the start and end of the string are mandatory.
- The Drill Pair property is only defined for via objects.
DrillType
Summary
Returns all pad objects whose Drill Type property complies with the Query.
Syntax
DrillType = DrillType_String
DrillType <> DrillType_String
DrillType_String must be one of the strings from the following list:
-
'Drilled' -
'Laser Drilled' -
'Plasma Drilled' -
'Punched'
Example Usage
DrillType = 'Drilled'
Returns all pad objects whose Drill Type property is Drilled.
DrillType <> 'Punched'
Returns all objects except pad objects whose Drill Type property is Punched.
DrillType = 'Laser Drilled' || DrillType = 'Plasma Drilled' || DrillType = 'Punched'
IsPad && DrillType <> 'Drilled'
Returns all pad objects whose Drill Type property is not Drilled.
Notes
- The Drill Type property is only defined for pad objects.
-
The single quote characters (') at the start and end of
DrillType_Stringare mandatory.
EmbeddedBoard_ColCount
Summary
Returns all embedded board objects whose Col Count property complies with the Query.
Syntax
EmbeddedBoard_ColCount : Numeric_String
EmbeddedBoard_ColCount : Number
Example Usage
EmbeddedBoard_ColCount = '2'
EmbeddedBoard_ColCount = 2
Returns all embedded board objects whose Col Count property is 2.
EmbeddedBoard_ColCount <> '4'
EmbeddedBoard_ColCount <> 4
Returns all objects except embedded board objects whose Col Count property is 4.
Note
The Col Count property is only defined for embedded board objects.
EmbeddedBoard_ColumnSpacing
Summary
Returns embedded board objects whose Column Spacing property complies with the Query.
Syntax
EmbeddedBoard_ColumnSpacing : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:
-
AsMils(EmbeddedBoard_ColumnSpacing) : Number– to specify a spacing in mil. -
AsMM(EmbeddedBoard_ColumnSpacing) : Number– to specify a spacing in mm.
Example Usage
EmbeddedBoard_ColumnSpacing = 1500
Returns all embedded board objects that have a Column Spacing property that is 1500 current measurement units.
EmbeddedBoard_ColumnSpacing >= 1000
Returns all embedded board objects that have a Column Spacing property that 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 that is greater than or equal to 1000 mil and less than or equal to 1500 mil.
AsMM(EmbeddedBoard_ColumnSpacing) < 38.1
Returns all embedded board objects that have a Column Spacing property that is less than 38.1mm.
Note
The Column Spacing property is only defined for embedded board objects.
EmbeddedBoard_DocumentName
Summary
Returns all embedded board objects whose Embedded Document Name property complies with the Query.
Syntax
EmbeddedBoard_DocumentName : String
Example Usage
EmbeddedBoard_DocumentName = 'C:\Users\Public\Documents\Altium\Projects\Example_Design\Example_PCB.PcbDoc'
Returns all embedded board objects whose Embedded Document Name property is C:\Users\Public\Documents\Altium\Projects\Example_Design\Example_PCB.PcbDoc.
EmbeddedBoard_DocumentName Like '*Example_PCB.PcbDoc'
Returns all embedded board objects whose Embedded Document Name property ends in Example_PCB.PcbDoc.
Note
The Embedded Document Name property is only defined for embedded board objects.
EmbeddedBoard_OriginMode
Summary
Returns all embedded board objects whose Link To Embedded Board Origin property complies with the Query.
Syntax
EmbeddedBoard_OriginMode : Boolean_String
Example Usage
EmbeddedBoard_OriginMode = 'True'
Returns all embedded board objects whose Link To Embedded Board Origin property is enabled.
EmbeddedBoard_OriginMode = 'False'
Returns all embedded board objects whose Link To Embedded Board Origin property is disabled.
Note
The Link To Embedded Board Origin property is only defined for embedded board objects.
EmbeddedBoard_RowCount
Summary
Returns all embedded board objects whose Row Count property complies with the Query.
Syntax
EmbeddedBoard_RowCount : Numeric_String
EmbeddedBoard_RowCount : Number
Example Usage
EmbeddedBoard_RowCount = '2'
EmbeddedBoard_RowCount = 2
Returns all embedded board objects whose Row Count property is 2.
EmbeddedBoard_RowCount <> '4'
EmbeddedBoard_RowCount <> 4
Returns all objects except embedded board objects whose Row Count property is 4.
Note
The Row Count property is only defined for embedded board objects.
EmbeddedBoard_RowSpacing
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; 1 mil = 0.001inch) or Metric (mm; 1 mm = 0.001 meter).
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 that 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 that is greater than or equal to 2500 mil and less than or equal to 3000 mil.
AsMM(EmbeddedBoard_RowSpacing) < 63.5
Returns all embedded board objects that have a Row Spacing property that is less than 63.5 mm.
Note
The Row Spacing property is only defined for embedded board objects.
EnablePartSwapping
Summary
Returns all component objects whose Enable Part Swapping property complies with the Query.
Syntax
EnablePartSwapping : Boolean_String
Example Usage
EnablePartSwapping = 'True'
Returns all component objects whose Enable Part Swapping property is enabled.
EnablePartSwapping = 'False'
Returns all component objects whose Enable Part Swapping property is disabled.
Notes
- The Enable Part Swapping property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
EnablePinSwapping
Summary
Returns all component objects whose Enable Pin Swapping property complies with the Query.
Syntax
EnablePinSwapping : Boolean_String
Example Usage
EnablePinSwapping = 'True'
Returns all component objects whose Enable Pin Swapping property is enabled.
EnablePinSwapping = 'False'
Returns all component objects whose Enable Pin Swapping property is disabled.
Notes
- The Enable Pin Swapping property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
FillingMaterial
Summary
Returns all via objects whose Filling Material property complies with the Query.
Syntax
FillingMaterial : String
Example Usage
FillingMaterial = 'Epoxy'
Returns all via objects whose Filling Material property is Epoxy.
FillingMaterial Like 'Epoxy*'
Returns all via objects that have a Filling Material whose associated string commences with Epoxy.
Notes
- The Filling Material property is only defined for via objects.
-
The single quote characters (
') at the start and end ofStringare mandatory.
FillingSide
Summary
Returns all via objects whose Filling Side property complies with the Query.
Syntax
FillingSide = FillingSide_String
FillingSide <> FillingSide_String
FillingSide_String must be one of the strings from the following list:
-
'Top' -
'Bottom' -
'Both'
Example Usage
FillingSide = 'Top'
Returns all via objects whose Filling Side property is Top.
FillingSide <> 'Both'
Returns all objects except via objects whose Filling Side property is Both.
FillingSide = 'Top' || FillingSide = 'Bottom'
IsVia && FillingSide <> 'Both'
Returns all objects except via objects whose Filling Side property is Both.
Notes
- The Filling Side property is only defined for via objects.
-
The single quote characters (
') at the start and end ofFillingSide_Stringare mandatory.
FontName
Summary
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property complies with the Query.
Syntax
FontName = FontName_String
FontName <> FontName_String
FontName_String must use one of the names of the available TrueType and OpenType (a superset of TrueType) fonts, found in the \Windows\Fonts folder.
Example Usage
FontName = 'Arial'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property is Arial.
FontName <> 'Batang'
Returns all objects except coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose TrueType Font Name property is Batang.
Notes
-
The single quote characters (') at the start and end of
FontName_Stringare mandatory. - The TrueType Font Name property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
Footprint
Summary
Returns all component objects whose Footprint property complies with the Query.
Syntax
Footprint : String
Example Usage
Footprint = 'DIP14'
Returns all components that have a Footprint of DIP14.
Footprint Like 'DIP*'
Returns all components that have a Footprint whose associated string commences with DIP.
Notes
- The Footprint property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
FromToPad1
Summary
Returns all from-to objects whose From Pad property complies with the Query.
Syntax
FromToPad1 : PadName_String
PadName_String specifies the full Name that a pad has to match; this consists of an initial substring that specifies the Name property of the pad's parent component (i.e. the component's Designator), followed by a substring that specifies the pad's own Name property (i.e. the pad's Designator). The format will therefore be 'ParentComponentDesignator-PadDesignator'.
Example Usage
FromToPad1 = 'C14-2'
Returns all from-to objects whose From Pad property is C14-2.
Notes
-
The single quote characters (') at the start and end of
PadName_Stringare mandatory. - The From Pad property is only defined for from-to objects.
FromToPad2
Summary
Returns all from-to objects whose To Pad property complies with the Query.
Syntax
FromToPad2 : PadName_String
PadName_String specifies the full Name that a pad has to match; this consists of an initial substring that specifies the Name property of the pad's parent component (i.e. the component's Designator), followed by a substring that specifies the pad's own Name property (i.e. the pad's Designator). The format will therefore be 'ParentComponentDesignator-PadDesignator'.
Example Usage
FromToPad2 = 'U1-8'
Returns all from-to objects whose To Pad property is U1-8.
Notes
-
The single quote characters (') at the start and end of
PadName_Stringare mandatory. - The To Pad property is only defined for from-to objects.
H
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 300 current measurement units.
H >= 5.08
Returns all components that have a Height property that is greater than or equal to 5.08 current measurement units.
AsMils(H) > 400
Returns all components that have a Height property that is greater than 400mil.
AsMM(H) Between 6.35 And 8.89
Returns all components that have a Height property that 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 that is not equal to 550 current measurement units.
AsMils(H) <= 650
Returns all components that have a Height property that is less than or equal to 650mil.
AsMM(H) < 11.43
Returns all components that have a Height property that is less than 11.43mm.
Notes
- The Height property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
- This function is an alias for the Height function.
Height
Summary
Returns all component objects whose Height property complies with the Query.
Syntax
Height : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 300 current measurement units.
Height >= 5.08
Returns all components that have a Height property that is greater than or equal to 5.08 current measurement units.
AsMils(Height) > 400
Returns all components that have a Height property that is greater than 400 mil.
AsMM(Height) Between 6.35 And 8.89
Returns all components that have a Height property that is greater than or equal to 6.35 mm and less than or equal to 8.89 mm.
Height <> 550
Returns all components that have a Height property that is not equal to 550 current measurement units.
AsMils(Height) <= 650
Returns all components that have a Height property that is less than or equal to 650 mil.
AsMM(Height) < 11.43
Returns all components that have a Height property that is less than 11.43 mm.
Notes
- The Height property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
- This function is an alias for the H function.
Hide
Summary
Returns all component comment, component designator, and net objects whose Hide property complies with the Query.
Syntax
Hide : Boolean
Example Usage
Hide
Hide = True
Returns all component comment, component designator, and net objects whose Hide property is True.
Not Hide
Hide = False
Returns all objects except component comment, component designator, and net objects whose Hide property is False.
Note
The Hide property is only defined for component comment, component designator, and net objects.
HideJumpers
Summary
Returns all component objects whose Hide Jumpers property complies with the Query.
Syntax
HideJumpers : Boolean_String
Example Usage
HideJumpers = 'True'
Returns all component objects whose Hide Jumpers property is enabled.
HideJumpers = 'False'
Returns all component objects whose Hide Jumpers property is disabled.
Notes
- The Hide Jumpers property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
Hole
Summary
Returns all pad and via objects whose Hole Size property complies with the Query.
Syntax
Hole : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a hole size in mm.Hole) : Number
Example Usage
Hole = 16
Returns all pad and via objects that have a Hole Size property that is 16 current measurement units.
Hole >= 0.508
Returns all pad and via objects that have a Hole Size property that 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 that is greater than or equal to 12 mil and less than or equal to 32 mil.
AsMM(Hole) < 1.016
Returns all pad and via objects that have a Hole Size property that is less than 1.016 mm.
Notes
- The Hole Size property is only defined for pad and via objects.
- This function is an alias for the HoleDiameter and HoleSize functions.
HoleDiameter
Summary
Returns all pad and via objects whose Hole Size property complies with the Query.
Syntax
HoleDiameter : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a hole diameter in mm.HoleDiameter) : Number
Example Usage
HoleDiameter = 16
Returns all pad and via objects that have a Hole Size property that is 16 current measurement units.
HoleDiameter >= 0.508
Returns all pad and via objects that have a Hole Size property that 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 that is greater than or equal to 12 mil and less than or equal to 32 mil.
AsMM(HoleDiameter) < 1.016
Returns all pad and via objects that have a Hole Size property that is less than 1.016 mm.
Notes
- The Hole Size property is only defined for pad and via objects.
- This function is an alias for the HoleSize and Hole functions.
HoleNegativeTolerance
Summary
Returns all pad and via objects whose Hole Tolerance (-) property complies with the Query.
Syntax
HoleNegativeTolerance : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 4 current measurement units.
HoleNegativeTolerance >= 5.08
Returns all pad and via objects that have a Hole Tolerance (-) property that 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 that is greater than 4 mil.
AsMM(HoleNegativeTolerance) Between 0.102 And 0.105
Returns all pad and via objects that have a Hole Tolerance (-) property that is greater than or equal to 0.102 mm and less than or equal to 0.105 mm.
HoleNegativeTolerance <> 2
Returns all pad and via objects that have a Hole Tolerance (-) property that is not equal to 2 current measurement units.
AsMils(HoleNegativeTolerance) <= 1.4
Returns all pad and via objects that have a Hole Tolerance (-) property that is less than or equal to 1.4 mil.
AsMM(HoleNegativeTolerance) < 0.05
Returns all pad and via objects that have a Hole Tolerance (-) property that is less than 0.05 mm.
Note
The Hole Tolerance (-) property is only defined for pad and via objects.
HolePositiveTolerance
Summary
Returns all pad and via objects whose Hole Tolerance (+) property complies with the Query.
Syntax
HolePositiveTolerance : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 4 current measurement units.
HolePositiveTolerance >= 5.08
Returns all pad and via objects that have a Hole Tolerance (+) property that 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 that is greater than 4 mil.
AsMM(HolePositiveTolerance) Between 0.102 And 0.105
Returns all pad and via objects that have a Hole Tolerance (+) property that is greater than or equal to 0.102 mm and less than or equal to 0.105 mm.
HolePositiveTolerance <> 2
Returns all pad and via objects that have a Hole Tolerance (+) property that is not equal to 2 current measurement units.
AsMils(HolePositiveTolerance) <= 1.4
Returns all pad and via objects that have a Hole Tolerance (+) property that is less than or equal to 1.4 mil.
AsMM(HolePositiveTolerance) < 0.05
Returns all pad and via objects that have a Hole Tolerance (+) property that is less than 0.05 mm.
Note
The Hole Tolerance (+) property is only defined for pad and via objects.
HoleRotation
Summary
Returns all pad objects whose Hole Rotation property complies with the Query.
Syntax
HoleRotation : Numeric_String
HoleRotation : Number
Example Usage
HoleRotation = '30'
HoleRotation = 30
Returns all pad objects whose Hole Rotation property is 30.000.
HoleRotation <> '45'
HoleRotation <> 45
Returns all objects except pad objects whose Hole Rotation property is 45.000.
Note
The Hole Rotation property is only defined for pad objects.
HoleSize
Summary
Returns all pad and via objects whose Hole Size property complies with the Query.
Syntax
HoleSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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– to specify a hole size in mil.Size) : Number -
AsMM(– to specify a hole size in mm.HoleSize) : Number
Example Usage
HoleSize = 16
Returns all pad and via objects that have a Hole Size property that is 16 current measurement units.
HoleSize >= 0.508
Returns all pad and via objects that have a Hole Size property that 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 that is greater than or equal to 12 mil and less than or equal to 32 mil.
AsMM(HoleSize) < 1.016
Returns all pad and via objects that have a Hole Size property that is less than 1.016 mm.
Notes
- The Hole Size property is only defined for pad and via objects.
- This function is an alias for the HoleDiameter and Hole functions.
HoleType
Summary
Returns all pad objects whose Hole Type property complies with the Query.
Syntax
HoleType = HoleType_String
HoleType <> HoleType_String
HoleType_String must be one of the strings from the following list:
-
'Round' -
'Slot' -
'Square'
Example Usage
HoleType = 'Square'
Returns all pad objects whose Hole Type property is Square.
HoleType <> 'Slot'
Returns all objects except pad objects whose Hole Type property is Slot.
HoleType = 'Square' || HoleType = 'Slot'
IsPad && HoleType <> 'Round'
Returns all objects except pad objects whose Hole Type property is Round.
Notes
- The Hole Type property is only defined for pad objects.
-
The single quote characters (') at the start and end of
HoleType_Stringare mandatory.
Identifier
Summary
Returns all 3D body objects whose Identifier property complies with the Query.
Syntax
Identifier : String
Example Usage
Identifier = 'RES0402'
Returns all 3D body objects whose Identifier property is RES0402.
Identifier Like 'RES0402*'
Returns all 3D body objects that have a Identifier whose associated string starts with RES0402.
Notes
- The Identifier property is only defined for 3D body objects.
-
The single quote characters (
') at the start and end ofStringare mandatory.
InvertedBorderSpaceType
Summary
Returns all string objects whose Border Space Type property complies with the Query.
Syntax
InvertedBorderSpaceType = InvertedBorderSpaceType_String
InvertedBorderSpaceType <> InvertedBorderSpaceType_String
InvertedBorderSpaceType_String must be one of the strings from the following list:
-
'Border Margin' -
'Text Offset'
Example Usage
InvertedBorderSpaceType = 'Border Margin'
Returns all string objects whose Border Space Type property is Border Margin.
InvertedBorderSpaceType <> 'Border Margin'
Returns all objects except string objects whose Border Space Type property is Border Margin.
IsTrueTypeText && InvertedBorderSpaceType <> 'Text Offset'
Returns all string objects whose Border Space Type property is not Text Offset.
Notes
- The Border Space Type property is only defined for string objects.
-
The single quote characters (') at the start and end of
InvertedBorderSpaceType_Stringare mandatory.
InvertedRectangleHeight
Summary
Returns all text string (comment, designator, free) objects whose Inverted Rectangle Height property complies with the Query.
Syntax
InvertedRectangleHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an Inverted Rectangle Height property that is equal to 30 current measurement units.
InvertedRectangleHeight >= 5.08
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is greater than or equal to 5.08 current measurement units.
AsMils(InvertedRectangleHeight) > 40
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is greater than 40 mil.
AsMM(InvertedRectangleHeight) Between 6.35 And 8.89
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is greater than or equal to 6.35 mm and less than or equal to 8.89 mm.
InvertedRectangleHeight <> 55
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is not equal to 55 current measurement units.
AsMils(InvertedRectangleHeight) <= 65
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is less than or equal to 65 mil.
AsMM(InvertedRectangleHeight) < 11.43
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Height property that is less than 11.43 mm.
Note
The Inverted Rectangle Height property is only defined for text string (comment, designator, free) objects.
InvertedRectangleWidth
Summary
Returns all text string (comment, designator, free) objects whose Inverted Rectangle Width property complies with the Query.
Syntax
InvertedRectangleWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an Inverted Rectangle Width property that is equal to 300 current measurement units.
InvertedRectangleWidth >= 128
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is greater than or equal to 128 current measurement units.
AsMils(InvertedRectangleWidth) > 400
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is greater than 400 mil.
AsMM(InvertedRectangleWidth) Between 6 And 8
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is greater than or equal to 6 mm and less than or equal to 8 mm.
InvertedRectangleWidth <> 550
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is not equal to 550 current measurement units.
AsMils(InvertedRectangleWidth) <= 650
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is less than or equal to 650 mil.
AsMM(InvertedRectangleWidth) < 11.43
Returns all text string (comment, designator, free) objects that have an Inverted Rectangle Width property that is less than 11.43 mm.
Note
The Inverted Rectangle Width property is only defined for text string (comment, designator, free) objects.
InvertedTextJustification
Summary
Returns all text string (comment, designator, free) objects whose Inverted Text Justification property complies with the Query.
Syntax
InvertedTextJustification = TextJustification_String
InvertedTextJustification <> TextJustification_String
TextJustification_String must be one of the strings from the following list:
-
'Center' -
'Center-Above' -
'Center-Below' -
'Left-Above' -
'Left-Below' -
'Left-Center' -
'Right-Above' -
'Right-Below' -
'Right-Center'
Example Usage
InvertedTextJustification = 'Center'
Returns all text string (comment, designator, free) objects whose Inverted Text Justification property is Center.
InvertedTextJustification <> 'Right-Below'
Returns all objects except text string (comment, designator, free) objects whose Inverted Text Justification property is Right-Below.
Notes
-
The single quote characters (') at the start and end of
TextJustification_Stringare mandatory. - The Inverted Text Justification property is only defined for text string (comment, designator, free) objects.
IPC4761ViaType
Summary
Returns all via objects whose IPC 4761 Via Type property complies with the Query.
Syntax
IPC4761ViaType = IPC4761ViaType_String
IPC4761ViaType <> IPC4761ViaType_String
IPC4761ViaType_String must be one of the strings from the following list:
-
'None' -
'Type 1a' -
'Type 1b' -
'Type 2a' -
'Type 2b' -
'Type 3a' -
'Type 3b' -
'Type 4a' -
'Type 4b' -
'Type 5' -
'Type 6a' -
'Type 6b' -
'Type 7'
Example Usage
IPC4761ViaType = 'Type 1a'
Returns all via objects whose IPC 4761 Via Type property is Type 1a.
IPC4761ViaType <> 'Type 1b'
Returns all objects except via objects whose IPC 4761 Via Type property is Type 1b.
Notes
- The IPC 4761 Via Type property is only defined for via objects.
-
The single quote characters (
') at the start and end ofIPC4761ViaType_Stringare mandatory.
IsAssyTestpoint
Summary
Returns all pad and via objects that have been marked for use as Assembly Testpoints, i.e. have their Assembly Testpoint - Top and/or Assembly Testpoint - Bottom properties enabled.
Syntax
IsAssyTestpoint : Boolean
Example Usage
IsAssyTestpoint
IsAssyTestpoint = True
Returns all pad and via objects being used as Assembly Testpoints.
Not IsAssyTestpoint
IsAssyTestpoint = False
Returns all objects except pad and via objects being used as Assembly Testpoints.
IsBold
Summary
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property complies with the Query.
Syntax
IsBold : Boolean_String
Example Usage
IsBold = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is enabled.
IsBold = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Bold property is disabled.
Notes
-
The Bold property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
-
All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.
IsDataMatrixText
Summary
Returns text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to Data Matrix.
Syntax
IsDataMatrixText : Boolean
Example Usage
IsDataMatrixText
IsDataMatrixText = True
Returns all text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to Data Matrix.
Not IsDataMatrixText
IsDataMatrixText = False
Returns all objects except text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to Data Matrix.
IsFabTestpoint
Summary
Returns all pad and via objects that have been marked for use as Fabrication Testpoints, i.e. have their Fabrication Testpoint - Top and/or Fabrication Testpoint - Bottom properties enabled.
Syntax
IsFabTestpoint : Boolean
Example Usage
IsFabTestpoint
IsFabTestpoint = True
Returns all pad and via objects being used as Fabrication Testpoints.
Not IsFabTestpoint
IsFabTestpoint = False
Returns all objects except pad and via objects being used as Fabrication Testpoints.
IsItalic
Summary
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property complies with the Query.
Syntax
IsItalic : Boolean_String
Example Usage
IsItalic = 'True'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is enabled.
IsItalic = 'False'
Returns all coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects whose Italic property is disabled.
Notes
- The Italic property is only defined for coordinate, dimension (except center dimension), drill table, layer stack table, and text string (comment, designator, free) objects.
- All parent coordinate, dimension, drill table, and layer stack table objects, whose child text string primitives comply with the Query, will also be returned.
IsModified
Summary
Returns all polygon pour objects whose IsModified property complies with the Query.
Syntax
IsModified : Boolean_String
Example Usage
IsModified = 'True'
Returns all polygon pour objects whose IsModified property is enabled.
IsModified = 'False'
Returns all polygon pour objects whose IsModified property is disabled.
Note
The IsModified property is only defined for polygon pour objects.
IsQrCodeText
Summary
Returns text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to QR Code.
Syntax
IsQrCodeText : Boolean
Example Usage
IsQrCodeText
IsQrCodeText = True
Returns all text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to QR Code.
Not IsQrCodeText
IsQrCodeText = False
Returns all objects except text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to QR Code.
IsTestpoint
Summary
Returns all pad and via objects that have been marked for use as Testpoints, regardless of whether they are Assembly or Fabrication Testpoints. That is, having any of the following properties enabled:
- Assembly Testpoint - Top
- Assembly Testpoint - Bottom
- Fabrication Testpoint - Top
- Fabrication Testpoint - Bottom
Syntax
IsTestpoint : Boolean
Example Usage
IsTestpoint
IsTestpoint = True
Returns all pad and via objects being used as Testpoints.
Not IsTestpoint
IsTestpoint = False
Returns all objects except pad and via objects being used as Testpoints.
IsTextInverted
Summary
Returns all text string (comment, designator, free) objects whose Inverted property complies with the Query.
Syntax
IsTextInverted : Boolean_String
Example Usage
IsTextInverted = 'True'
Returns all text string (comment, designator, free) objects whose Inverted property is enabled.
IsTextInverted = 'False'
Returns all text string (comment, designator, free) objects whose Inverted property is disabled.
Note
The Inverted property is only defined for text string (comment, designator, free) objects.
Keepout
Summary
Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.
Syntax
Keepout : Boolean
Example Usage
Keepout
Keepout = True
Returns all Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.
Not Keepout
Keepout = False
Returns all objects except Keepout - Arc, Keepout - Fill, Keepout - Solid Region, and Keepout - Track objects.
KeepoutRestrictionsCopper
Summary
Returns all keepout objects whose Keepout Restriction - Copper property complies with the Query.
Syntax
KeepoutRestrictionsCopper : Boolean_String
Example Usage
KeepoutRestrictionsCopper = 'True'
Returns all keepout objects whose Keepout Restriction - Copper property is enabled.
KeepoutRestrictionsCopper = 'False'
Returns all keepout objects whose Keepout Restriction - Copper property is disabled.
Notes
-
The Keepout Restriction - Copper property is only defined for keepout objects (arcs, fills, solid regions, tracks).
-
The Keepout Restriction - Copper property (as reflected in the List panels) corresponds to the Copper option in the Keepout Restrictions section when viewing the properties for a selected object through the Properties panel.
KeepoutRestrictionsSMDPad
Summary
Returns all keepout objects whose Keepout Restriction - SMD Pad property complies with the Query.
Syntax
KeepoutRestrictionsSMDPad : Boolean_String
Example Usage
KeepoutRestrictionsSMDPad = 'True'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is enabled.
KeepoutRestrictionsSMDPad = 'False'
Returns all keepout objects whose Keepout Restriction - SMD Pad property is disabled.
Notes
-
The Keepout Restriction - SMD Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
-
The Keepout Restriction - SMD Pad property (as reflected in the List panels) corresponds to the SMD Pad option in the Keepout Restrictions section when viewing the properties for a selected object through the Properties panel.
KeepoutRestrictionsTHPad
Summary
Returns all keepout objects whose Keepout Restriction - TH Pad property complies with the Query.
Syntax
KeepoutRestrictionsTHPad : Boolean_String
Example Usage
KeepoutRestrictionsTHPad = 'True'
Returns all keepout objects whose Keepout Restriction - TH Pad property is enabled.
KeepoutRestrictionsTHPad = 'False'
Returns all keepout objects whose Keepout Restriction - TH Pad property is disabled.
Notes
-
The Keepout Restriction - TH Pad property is only defined for keepout objects (arcs, fills, solid regions, tracks).
-
The Keepout Restriction - TH Pad property (as reflected in the List panels) corresponds to the TH Pad option in the Keepout Restrictions section when viewing the properties for a selected object through the Properties panel.
KeepoutRestrictionsTrack
Summary
Returns all keepout objects whose Keepout Restriction - Track property complies with the Query.
Syntax
KeepoutRestrictionsTrack : Boolean_String
Example Usage
KeepoutRestrictionsTrack = 'True'
Returns all keepout objects whose Keepout Restriction - Track property is enabled.
KeepoutRestrictionsTrack = 'False'
Returns all keepout objects whose Keepout Restriction - Track property is disabled.
Notes
-
The Keepout Restriction - Track property is only defined for keepout objects (arcs, fills, solid regions, tracks).
-
The Keepout Restriction - Track property (as reflected in the List panels) corresponds to the Track option in the Keepout Restrictions section when viewing the properties for a selected object through the Properties panel.
KeepoutRestrictionsVia
Summary
Returns all keepout objects whose Keepout Restriction - Via property complies with the Query.
Syntax
KeepoutRestrictionsVia : Boolean_String
Example Usage
KeepoutRestrictionsVia = 'True'
Returns all keepout objects whose Keepout Restriction - Via property is enabled.
KeepoutRestrictionsVia = 'False'
Returns all keepout objects whose Keepout Restriction - Via property is disabled.
Notes
-
The Keepout Restriction - Via property is only defined for keepout objects (arcs, fills, solid regions, tracks).
-
The Keepout Restriction - Via property (as reflected in the List panels) corresponds to the Via option in the Keepout Restrictions section when viewing the properties for a selected object through the Properties panel.
Kind
Summary
Returns all objects whose Object Kind property complies with the Query.
Syntax
Kind = ObjectKind_String
Kind <> ObjectKind_String
ObjectKind_String specifies the object kind and must be one of the following strings:
-
Design Objects –
'3D Body','Arc','Angular Dimension','Baseline Dimension','Center Dimension','Component','Coordinate','Datum Dimension','Design View','Drill Table','Embedded Board','Fill','Layer Stack Table','Leader Dimension','Linear Diameter Dimension','Linear Dimension','OLE Object','Original Dimension','Pad','Poly','Radial Diameter Dimension','Radial Dimension','Region','Split Plane','Text','Track','Via'. -
Design Rules – the following strings are used to target the various rule types. The rule type, as it appears in the PCB Rules and Constraints Editor dialog, is shown in brackets after the string:
-
'Acute Angle Rule'(Acute Angle) -
'Bare-board Fabrication Test Point Style Rule'(Fabrication Testpoint Style) -
'Bare-board Fabrication Test Point Usage Rule'(Fabrication Testpoint Usage) -
'Board Outline Clearance'(Board Outline Clearance) -
'Broken Nets Rule'(Un-Routed Net) -
'Clearance Rule'(Clearance) -
'Component Clearance Rule'(Component Clearance) -
'Component Rotations Rule'(Component Orientations) -
'Confinement Constraint Rule'(Room Definition) -
'Daisy Chain Stub Length Rule'(Daisy Chain Stub Length) -
'Differential Pairs Rule'(Differential Pairs Routing) -
'Fanout Control Rule'(Fanout Control) -
'Flight Time Falling Edge Rule'(Flight Time - Falling Edge) -
'Flight Time Rising Edge Rule'(Flight Time - Rising Edge) -
'Hole To Hole Clearance Rule'(Hole To Hole Clearance) -
'In-circuit Assembly Test Point Style Rule'(Assembly Testpoint Style) -
'In-circuit Assembly Test Point Usage Rule'(Assembly Testpoint Usage) -
'Layer Pair Rule'(Layer Pairs) -
'Matched Lengths Rule'(Matched Lengths) -
'Max Min Height Rule'(Height) -
'Max Min Hole Size Rule'(Hole Size) -
'Max Min Impedance Rule'(Impedance) -
'Max Min Length Rule'(Length) -
'Max Min Width Rule'(Width) -
'Max Slope Falling Edge Rule'(Slope - Falling Edge) -
'Max Slope Rising Edge Rule'(Slope - Rising Edge) -
'Max Via Stub Length (BackDrilling rule)'(Max Via Stub Length (Back Drilling)) -
'Maximum Via Count Rule'(Maximum Via Count) -
'Minimum Annular Ring Rule'(Minimum Annular Ring) -
'Minimum Solder Mask Sliver Rule'(Minimum Solder Mask Sliver) -
'Modified Polygon'(Modified Polygon) -
'Net Antennae Rule'(Net Antennae) -
'Nets To Ignore Rule'(Nets to Ignore) -
'Overshoot Falling Edge Rule'(Overshoot - Falling Edge) -
'Overshoot Rising Edge Rule'(Overshoot - Rising Edge) -
'Parallel Segment Rule'(Parallel Segment) -
'Paste Mask Expansion Rule'(Paste Mask Expansion) -
'Permitted Layers Rule'(Permitted Layers) -
'Polygon Connect Style Rule'(Polygon Connect Style) -
'Power Plane Clearance Rule'(Power Plane Clearance) -
'Power Plane Connect Style Rule'(Power Plane Connect Style) -
'Routing Corner Style Rule'(Routing Corners) -
'Routing Layers Rule'(Routing Layers) -
'Routing Priority Rule'(Routing Priority) -
'Routing Topology Rule'(Routing Topology) -
'Routing Via Style Rule'(Routing Via Style) -
'Short Circuit Rule'(Short-Circuit) -
'Signal Base Value Rule'(Signal Base Value) -
'Signal Stimulus Rule'(Signal Stimulus) -
'Signal Top Value Rule'(Signal Top Value) -
'Silk To Silk Clearance Rule'(Silk To Silk Clearance) -
'Silk To Solder Mask Clearance Rule'(Silk To Solder Mask Clearance) -
'SMD Entry'(SMD Entry) -
'SMD Neck Down Rule'(SMD Neck-Down) -
'SMD To Corner Rule'(SMD To Corner) -
'SMD To Plane Rule'(SMD To Plane) -
'Solder Mask Expansion Rule'(Solder Mask Expansion) -
'Supply Nets Rule'(Supply Nets) -
'Unconnected Pin Rule'(Un-Connected Pin) -
'Undershoot Falling Edge Rule'(Undershoot - Falling Edge) -
'Undershoot Rising Edge Rule'(Undershoot - Rising Edge) -
'Vias Under SMD Rule'(Vias Under SMD)
-
-
Others –
'Board Region','Class','Differential Pair','Net','Violation'.
Example Usage
Kind = 'Class'
Returns all class objects.
Kind <> 'Via'
Returns all objects except via objects.
Notes
-
The single quote characters (') at the start and end of
ObjectKind_Stringare mandatory. -
This function is an alias for the ObjectKind function.
L
Summary
Returns all objects whose Layer property complies with the Query.
Syntax
L = Layer_String
L <> Layer_String
Example Usage
L = 'MultiLayer'
Returns all objects on the Multi-Layer.
L <> 'KeepOutLayer'
Returns all objects except for those on the Keep-Out layer.
Notes
-
The single quote characters (') at the start and end of
Layer_Stringare mandatory. - This function is an alias for the Layer function.
Layer
Summary
Returns all objects whose Layer property complies with the Query.
Syntax
Layer = Layer_String
Layer <> Layer_String
Example Usage
Layer = 'MultiLayer'
Returns all objects on the Multi-Layer.
Layer <> 'KeepOutLayer'
Returns all objects except for those on the Keep-Out layer.
Notes
-
The single quote characters (') at the start and end of
Layer_Stringare mandatory. - This function is an alias for the L function.
LeaderDimensionDot
Summary
Returns all leader dimension objects whose Dot property complies with the Query.
Syntax
LeaderDimensionDot : Boolean_String
Example Usage
LeaderDimensionDot = 'True'
Returns all leader dimension objects whose Dot property is enabled.
LeaderDimensionDot = 'False'
Returns all leader dimension objects whose Dot property is disabled.
Notes
- The Dot property is only defined for leader dimension objects.
- The child objects of leader dimension objects returned by the Query are not returned.
LeaderDimensionDotSize
Summary
Returns leader dimension objects whose Dot Size property complies with the Query.
Syntax
LeaderDimensionDotSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is 40 current measurement units.
LeaderDimensionDotSize >= 1.143
Returns all leader dimension objects that have a Dot Size property that 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 that is greater than or equal to 30 mil and less than or equal to 50 mil.
AsMM(LeaderDimensionDotSize) < 0.889
Returns all leader dimension objects that have a Dot Size property that is less than 0.889 mm.
Notes
- The Dot Size property is only defined for leader dimension objects.
- The child objects of leader dimension objects returned by the Query are not returned.
LeaderDimensionShape
Summary
Returns all leader dimension objects whose Leader Shape property complies with the Query.
Syntax
LeaderDimensionShape = LeaderShape_String
LeaderDimensionShape <> LeaderShape_String
LeaderShape_String must be one of the strings from the following list:
-
'None' -
'Round' -
'Square'
Example Usage
LeaderDimensionShape = 'Round'
Returns all leader dimension objects whose Leader Shape property is Round.
LeaderDimensionShape <> 'Square'
Returns all objects except leader dimension objects whose Leader Shape property is Square.
Notes
- The Leader Shape property is only defined for leader dimension objects.
-
The single quote characters (') at the start and end of
LeaderShape_Stringare mandatory. - The child objects of leader dimension objects returned by the Query are not returned.
Locked
Summary
Returns all objects whose Locked property complies with the Query.
Syntax
Locked : Boolean
Example Usage
Locked
Locked = True
Returns all objects whose Locked property is enabled.
Not Locked
Locked = False
Returns all objects except those whose Locked property is enabled.
LockPrimitives
Summary
Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property complies with the Query.
Syntax
LockPrimitives : Boolean_String
Example Usage
LockPrimitives = 'True'
Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property is enabled.
LockPrimitives = 'False'
Returns all component, coordinate, dimension, and polygon pour objects whose Lock Primitives property is disabled.
Notes
- The Lock Primitives property is only defined for component, coordinate, dimension, and polygon pour objects.
- The child objects of component, coordinate, dimension, and polygon pour objects returned by the Query are not returned.
Mirror
Summary
Returns all string objects whose Mirror property complies with the Query.
Syntax
Mirror : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
Mirror = 'True'
Returns all string objects whose Mirror property is enabled.
Mirror = 'False'
Returns all string objects whose Mirror property is disabled.
Mirror <> 'True'
Not (Mirror = 'True')
Returns all objects except string objects whose Mirror property is enabled.
Mirror <> 'False'
Not (Mirror = 'False')
Returns all objects except string objects whose Mirror property is disabled.
Note
The Mirror property is only defined for string objects.
ModelCylinderHeight
Summary
Returns all 3D body objects whose Model Height (Cylinder) property complies with the Query.
Syntax
ModelCylinderHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 300 current measurement units.
ModelCylinderHeight >= 500
Returns all 3D body objects that have a Model Height (Cylinder) property that 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 that is greater than 400 mil.
AsMM(ModelCylinderHeight) Between 15 And 22
Returns all 3D body objects that have a Model Height (Cylinder) property that is greater than or equal to 15 mm and less than or equal to 22 mm.
ModelCylinderHeight <> 550
Returns all 3D body objects that have a Model Height (Cylinder) property that is not equal to 550 current measurement units.
AsMils(ModelCylinderHeight) <= 650
Returns all 3D body objects that have a Model Height (Cylinder) property that is less than or equal to 650 mil.
AsMM(ModelCylinderHeight) < 11.43
Returns all 3D body objects that have a Model Height (Cylinder) property that is less than 11.43 mm.
Note
The Model Height (Cylinder) property is only defined for 3D body objects.
ModelCylinderSphereRadius
Summary
Returns all 3D body objects whose Model Radius (Cylinder/Sphere) property complies with the Query.
Syntax
ModelCylinderSphereRadius : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 30 current measurement units.
ModelCylinderSphereRadius >= 50
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property that 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 that is greater than 40 mil.
AsMM(ModelCylinderSphereRadius) Between 1.5 And 2.2
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property that is greater than or equal to 1.5 mm and less than or equal to 2.2 mm.
ModelCylinderSphereRadius <> 55
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property that is not equal to 55 current measurement units.
AsMils(ModelCylinderSphereRadius) <= 65
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property that is less than or equal to 65 mil.
AsMM(ModelCylinderSphereRadius) < 1.43
Returns all 3D body objects that have a Model Radius (Cylinder/Sphere) property that is less than 1.43 mm.
Note
The Model Radius (Cylinder/Sphere) property is only defined for 3D body objects.
ModelRotationX
Summary
Returns all 3D body objects whose Model Rotation X property complies with the Query.
Syntax
ModelRotationX : Numeric_String
ModelRotationX : Number
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.
Note
The Model Rotation X property is only defined for 3D body objects.
ModelRotationY
Summary
Returns all 3D body objects whose Model Rotation Y property complies with the Query.
Syntax
ModelRotationY : Numeric_String
ModelRotationY : Number
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.
Note
The Model Rotation Y property is only defined for 3D body objects.
ModelRotationZ
Summary
Returns all 3D body objects whose Model Rotation Z property complies with the Query.
Syntax
ModelRotationZ : Numeric_String
ModelRotationZ : Number
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.
Note
The Model Rotation Z property is only defined for 3D body objects.
ModelType
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.
Notes
- The Model Type property is only defined for 3D body objects.
-
The single quote characters (') at the start and end of
ModelType_Stringare mandatory.
ModelZ
Summary
Returns all 3D body objects whose Model Z property complies with the Query.
Syntax
ModelZ : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 30 current measurement units.
ModelZ >= 5.08
Returns all 3D body objects that have a Model Z property that 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 that is greater than 40 mil.
AsMM(ModelZ) Between 0.35 And 0.89
Returns all 3D body objects that have a Model Z property that is greater than or equal to 0.35 mm and less than or equal to 0.89 mm.
ModelZ <> 55
Returns all 3D body objects that have a Model Z property that is not equal to 55 current measurement units.
AsMils(ModelZ) <= 65
Returns all 3D body objects that have a Model Z property that is less than or equal to 65 mil.
AsMM(ModelZ) < 0.43
Returns all 3D body objects that have a Model Z property that is less than 0.43 mm.
Notes
-
The Model Z property is only defined for 3D body objects.
-
The Model Z property corresponds to the Standoff Height field when viewing the properties for a selected 3D body on the Properties panel.
N
Summary
Returns arc, fill, pad, track, via, region, polygon pour, and split-plane objects whose Net property complies with the Query.
Syntax
N : String
Example Usage
N = 'GND'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property of GND.
N Like 'G*'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property whose associated string commences with G.
Notes
-
The Net property is only defined for arc, fill, pad, track, via, region, polygon pour, and split-plane objects.
-
The parent net object (whose Name property matches the net specified, and which is a parent object of the returned objects) is not returned.
-
This function is an alias for the Net function.
Name
Summary
Returns class, component, design rule, net, pad, and polygon pour objects whose Name property complies with the Query.
Syntax
Name : String
Example Usage
Name = '<All Components>'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property of <All Components>.
Name = 'U4-1'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property of U4-1.
Name Like 'R7*'
Returns all class, component, design rule, net, pad, and polygon pour objects that have a Name property whose associated string commences with R7.
Notes
-
The Name property is only defined for class, component, design rule, net, pad, and polygon pour objects.
-
In the case of pad objects, a full Name property has to be specified; this consists of an initial sub-string that specifies the Name property of the pad's parent component, followed by a '-' character, followed by another sub-string that specifies the Name property of the pad itself. Pads that are of a 'free' nature are identified by an initial sub-string of 'Free-', followed by the sub-string that specifies the pad's own Name property.
NegativeNet
Summary
Returns all differential pair objects whose Negative Net property complies with the Query.
Syntax
NegativeNet : String
Example Usage
NegativeNet = 'D_N'
Returns all differential pair objects whose Negative Net property is D_N.
NegativeNet Like '*RX1_N'
Returns all differential pair objects whose Negative Net property ends with RX1_N.
Notes
- The Negative Net property is only defined for differential pair objects.
- The child objects of differential pair objects returned by the Query are not returned.
Net
Summary
Returns arc, fill, pad, track, via, region, polygon pour, and split-plane objects whose Net property complies with the Query.
Syntax
Net : String
Example Usage
Net = 'GND'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property of GND.
Net Like 'G*'
Returns all arc, fill, pad, track, via, region, polygon pour, and split-plane objects that have a Net property whose associated string commences with G.
Notes
- The Net property is only defined for arc, fill, pad, track, via, region, polygon pour, and split-plane objects.
- The parent net object (whose Name property matches the net specified, and which is a parent object of the returned objects) is not returned.
- This function is an alias for the N function.
ObjectKind
Summary
Returns all objects whose Object Kind property complies with the Query.
Syntax
ObjectKind = ObjectKind_String
ObjectKind <> ObjectKind_String
ObjectKind_String specifies the object kind and must be one of the following strings:
-
Design Objects –
'3D Body','Arc','Angular Dimension','Baseline Dimension','Center Dimension','Component','Coordinate','Datum Dimension','Design View','Drill Table','Embedded Board','Fill','Layer Stack Table','Leader Dimension','Linear Diameter Dimension','Linear Dimension','OLE Object','Original Dimension','Pad','Poly','Radial Diameter Dimension','Radial Dimension','Region','Split Plane','Text','Track','Via'. -
Design Rules – the following strings are used to target the various rule types. The rule type, as it appears in the PCB Rules and Constraints Editor dialog, is shown in brackets after the string:
-
'Acute Angle Rule'(Acute Angle) -
'Bare-board Fabrication Test Point Style Rule'(Fabrication Testpoint Style) -
'Bare-board Fabrication Test Point Usage Rule'(Fabrication Testpoint Usage) -
'Board Outline Clearance'(Board Outline Clearance) -
'Broken Nets Rule'(Un-Routed Net) -
'Clearance Rule'(Clearance) -
'Component Clearance Rule'(Component Clearance) -
'Component Rotations Rule'(Component Orientations) -
'Confinement Constraint Rule'(Room Definition) -
'Daisy Chain Stub Length Rule'(Daisy Chain Stub Length) -
'Differential Pairs Rule'(Differential Pairs Routing) -
'Fanout Control Rule'(Fanout Control) -
'Flight Time Falling Edge Rule'(Flight Time - Falling Edge) -
'Flight Time Rising Edge Rule'(Flight Time - Rising Edge) -
'Hole To Hole Clearance Rule'(Hole To Hole Clearance) -
'In-circuit Assembly Test Point Style Rule'(Assembly Testpoint Style) -
'In-circuit Assembly Test Point Usage Rule'(Assembly Testpoint Usage) -
'Layer Pair Rule'(Layer Pairs) -
'Matched Lengths Rule'(Matched Lengths) -
'Max Min Height Rule'(Height) -
'Max Min Hole Size Rule'(Hole Size) -
'Max Min Impedance Rule'(Impedance) -
'Max Min Length Rule'(Length) -
'Max Min Width Rule'(Width) -
'Max Slope Falling Edge Rule'(Slope - Falling Edge) -
'Max Slope Rising Edge Rule'(Slope - Rising Edge) -
'Max Via Stub Length (BackDrilling rule)'(Max Via Stub Length (Back Drilling)) -
'Maximum Via Count Rule'(Maximum Via Count) -
'Minimum Annular Ring Rule'(Minimum Annular Ring) -
'Minimum Solder Mask Sliver Rule'(Minimum Solder Mask Sliver) -
'Modified Polygon'(Modified Polygon) -
'Net Antennae Rule'(Net Antennae) -
'Nets To Ignore Rule'(Nets to Ignore) -
'Overshoot Falling Edge Rule'(Overshoot - Falling Edge) -
'Overshoot Rising Edge Rule'(Overshoot - Rising Edge) -
'Parallel Segment Rule'(Parallel Segment) -
'Paste Mask Expansion Rule'(Paste Mask Expansion) -
'Permitted Layers Rule'(Permitted Layers) -
'Polygon Connect Style Rule'(Polygon Connect Style) -
'Power Plane Clearance Rule'(Power Plane Clearance) -
'Power Plane Connect Style Rule'(Power Plane Connect Style) -
'Routing Corner Style Rule'(Routing Corners) -
'Routing Layers Rule'(Routing Layers) -
'Routing Priority Rule'(Routing Priority) -
'Routing Topology Rule'(Routing Topology) -
'Routing Via Style Rule'(Routing Via Style) -
'Short Circuit Rule'(Short-Circuit) -
'Signal Base Value Rule'(Signal Base Value) -
'Signal Stimulus Rule'(Signal Stimulus) -
'Signal Top Value Rule'(Signal Top Value) -
'Silk To Silk Clearance Rule'(Silk To Silk Clearance) -
'Silk To Solder Mask Clearance Rule'(Silk To Solder Mask Clearance) -
'SMD Entry'(SMD Entry) -
'SMD Neck Down Rule'(SMD Neck-Down) -
'SMD To Corner Rule'(SMD To Corner) -
'SMD To Plane Rule'(SMD To Plane) -
'Solder Mask Expansion Rule'(Solder Mask Expansion) -
'Supply Nets Rule'(Supply Nets) -
'Unconnected Pin Rule'(Un-Connected Pin) -
'Undershoot Falling Edge Rule'(Undershoot - Falling Edge) -
'Undershoot Rising Edge Rule'(Undershoot - Rising Edge) -
'Vias Under SMD Rule'(Vias Under SMD)
-
-
Others –
'Board Region','Class','Differential Pair','Internal Plane','Net','Violation'.
Example Usage
ObjectKind = 'Class'
Returns all class objects.
ObjectKind <> 'Via'
Returns all objects except via objects.
Notes
-
The single quote characters (') at the start and end of
ObjectKind_Stringare mandatory. - This function is an alias for the Kind function.
OptimalVoidRotation
Summary
Returns all polygon objects whose Optimal Void Rotation property complies with the Query.
Syntax
OptimalVoidRotation : Boolean
Example Usage
OptimalVoidRotation = 'True'
Returns all polygon objects whose Optimal Void Rotation property is True.
OptimalVoidRotation = 'False'
Returns all objects except component polygon objects whose Optimal Void Rotation property is False.
Note
The Optimal Void Rotation property is only defined for polygon objects.
OverallHeight
Summary
Returns all extruded 3D body objects whose Model Overall Height (Extruded) property complies with the Query.
Syntax
OverallHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 100 current measurement units.
OverallHeight >= 4.064
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property that 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 that is greater than 80 mil.
AsMM(OverallHeight) Between 1.524 And 3.81
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property that is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
OverallHeight <> 50
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property that 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 that is less than or equal to 120 mil.
AsMM(OverallHeight) < 1.778
Returns all extruded 3D body objects that have a Model Overall Height (Extruded) property that is less than 1.778 mm.
Note
The Model Overall Height (Extruded) property is only defined for extruded 3D body objects.
Pad_CornerRadius_AllLayers
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%.
Notes
-
The single quote characters (') at the start and end of
CornerRadius_Stringare mandatory. -
The Pad Corner Radius (%) (All Layers) property is only defined for simple pads (those with Stack Mode property set to
Simple).
Pad_CornerRadius_BottomLayer
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%.
Notes
-
The single quote characters (') at the start and end of
CornerRadius_Stringare 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.
Pad_CornerRadius_MidLayerN
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%.
Notes
-
The single quote characters (') at the start and end of
CornerRadius_Stringare 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.
Pad_CornerRadius_TopLayer
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%.
Notes
-
The single quote characters (') at the start and end of
CornerRadius_Stringare 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.
Pad_CornerRadius_UsesPercent_AllLayers
Summary
Returns all pad objects whose Pad Corner Radius Uses Percent (All Layers) property complies with the Query.
Syntax
Pad_CornerRadius_UsesPercent_AllLayers = Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
Pad_CornerRadius_UsesPercent_AllLayers = 'True'
Returns all pad objects whose Pad Corner Radius Uses Percent (All Layers) property is enabled.
Pad_CornerRadius_UsesPercent_AllLayers = 'False'
Returns all pad objects whose Pad Corner Radius Uses Percent (All Layers) property is disabled.
Pad_CornerRadius_UsesPercent_AllLayers <> 'True'
Not (Pad_CornerRadius_UsesPercent_AllLayers = 'True')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (All Layers) property is enabled.
Pad_CornerRadius_UsesPercent_AllLayers <> 'False'
Not (Pad_CornerRadius_UsesPercent_AllLayers = 'False')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (All Layers) property is disabled.
Pad_CornerRadius_UsesPercent_BottomLayer
Summary
Returns pad objects whose Pad Corner Radius Uses Percent (Bottom Layer) property complies with the Query.
Syntax
Pad_CornerRadius_UsesPercent_BottomLayer = Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
Pad_CornerRadius_UsesPercent_BottomLayer = 'True'
Returns all pad objects whose Pad Corner Radius Uses Percent (Bottom Layer) property is enabled.
Pad_CornerRadius_UsesPercent_BottomLayer = 'False'
Returns all pad objects whose Pad Corner Radius Uses Percent (Bottom Layer) property is disabled.
Pad_CornerRadius_UsesPercent_BottomLayer <> 'True'
Not (Pad_CornerRadius_UsesPercent_BottomLayer = 'True')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Bottom Layer) property is enabled.
Pad_CornerRadius_UsesPercent_BottomLayer <> 'False'
Not (Pad_CornerRadius_UsesPercent_BottomLayer = 'False')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Bottom Layer) property is disabled.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Uses Percent (Bottom Layer) property will be the same as the Pad Corner Radius Uses Percent (All Layers) property since the specified Corner Radius mode (absolute value or percentage) is used for all signal layers. - The Pad Corner Radius Uses Percent (Bottom Layer) property is only defined for pad objects.
Pad_CornerRadius_UsesPercent_MidLayerN
Summary
Returns pad objects whose Pad Corner Radius Uses Percent (Mid Layer <n>) property (where n = 1..30 is the number of a mid layer) complies with the Query.
Syntax
Pad_CornerRadius_UsesPercent_MidLayer<n> = Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
Pad_CornerRadius_UsesPercent_MidLayer1 = 'True'
Returns all pad objects whose Pad Corner Radius Uses Percent (Mid Layer 1) property is enabled.
Pad_CornerRadius_UsesPercent_MidLayer2 = 'False'
Returns all pad objects whose Pad Corner Radius Uses Percent (Mid Layer 2) property is disabled.
Pad_CornerRadius_UsesPercent_MidLayer10 <> 'True'
Not (Pad_CornerRadius_UsesPercent_MidLayer10 = 'True')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Mid Layer 10) property is enabled.
Pad_CornerRadius_UsesPercent_MidLayer30 <> 'False'
Not (Pad_CornerRadius_UsesPercent_MidLayer30 = 'False')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Mid Layer 30) property is disabled.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Uses Percent (Mid Layer <n>) property will be the same as the Pad Corner Radius Uses Percent (All Layers) property since the specified Corner Radius mode (absolute value or percentage) is used for all signal layers. - A Pad Corner Radius Uses Percent (Mid Layer <n>) property is only defined for pad objects.
Pad_CornerRadius_UsesPercent_TopLayer
Summary
Returns pad objects whose Pad Corner Radius Uses Percent (Top Layer) property complies with the Query.
Syntax
Pad_CornerRadius_UsesPercent_TopLayer = Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
Pad_CornerRadius_UsesPercent_TopLayer = 'True'
Returns all pad objects whose Pad Corner Radius Uses Percent (Top Layer) property is enabled.
Pad_CornerRadius_UsesPercent_TopLayer = 'False'
Returns all pad objects whose Pad Corner Radius Uses Percent (Top Layer) property is disabled.
Pad_CornerRadius_UsesPercent_TopLayer <> 'True'
Not (Pad_CornerRadius_UsesPercent_TopLayer = 'True')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Top Layer) property is enabled.
Pad_CornerRadius_UsesPercent_TopLayer <> 'False'
Not (Pad_CornerRadius_UsesPercent_TopLayer = 'False')
Returns all objects except pad objects whose Pad Corner Radius Uses Percent (Top Layer) property is disabled.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Uses Percent (Top Layer) property will be the same as the Pad Corner Radius Uses Percent (All Layers) property since the specified Corner Radius mode (absolute value or percentage) is used for all signal layers. - The Pad Corner Radius Uses Percent (Top Layer) property is only defined for pad objects.
Pad_CornerRadius_Value_AllLayers
Summary
Returns all pad objects whose Pad Corner Radius Size (All Layers) property complies with the Query.
Syntax
Pad_CornerRadius_Value_AllLayers : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1 mm = 0.001 meter).
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_CornerRadius_Value_AllLayers) : Number– to specify a corner radius in mil. -
AsMM(Pad_CornerRadius_Value_AllLayers) : Number– to specify a corner radius in mm.
Example Usage
Pad_CornerRadius_Value_AllLayers = 100
Returns all pad objects whose Pad Corner Radius Size (All Layers) property is equal to 100 current measurement units.
Pad_CornerRadius_Value_AllLayers >= 4.064
Returns all pad objects whose Pad Corner Radius Size (All Layers) property is greater than, or equal to, 4.064 current measurement units.
AsMils(Pad_CornerRadius_Value_AllLayers) > 80
Returns all pad objects whose Pad Corner Radius Size (All Layers) property is greater than 80 mil.
AsMM(Pad_CornerRadius_Value_AllLayers) Between 1.524 And 3.81
Returns all pad objects whose Pad Corner Radius Size (All Layers) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
Pad_CornerRadius_Value_AllLayers <> 50
Returns all pad objects whose Pad Corner Radius Size (All Layers) property is not equal to 50 current measurement units.
Pad_CornerRadius_Value_BottomLayer
Summary
Returns pad objects whose Pad Corner Radius Size (Bottom Layer) property complies with the Query.
Syntax
Pad_CornerRadius_Value_BottomLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_CornerRadius_Value_BottomLayer) : Number– to specify a corner radius in mil. -
AsMM(Pad_CornerRadius_Value_BottomLayer) : Number– to specify a corner radius in mm.
Example Usage
Pad_CornerRadius_Value_BottomLayer = 100
Returns all pad objects whose Pad Corner Radius Size (Bottom Layer) property is equal to 100 current measurement units.
Pad_CornerRadius_Value_BottomLayer >= 4.064
Returns all pad objects whose Pad Corner Radius Size (Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(Pad_CornerRadius_Value_BottomLayer) > 80
Returns all pad objects whose Pad Corner Radius Size (Bottom Layer) property is greater than 80 mil.
AsMM(Pad_CornerRadius_Value_BottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Corner Radius Size (Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
Pad_CornerRadius_Value_BottomLayer <> 50
Returns all pad objects whose Pad Corner Radius Size (Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Size (Bottom Layer) property will be the same as the Pad Corner Radius Size (All Layers) property since the specified Corner Radius is used for all signal layers. - The Pad Corner Radius Size (Bottom Layer) property is only defined for pad objects.
Pad_CornerRadius_Value_MidLayerN
Summary
Returns pad objects whose Pad Corner Radius Size (Mid Layer <n>) property (where n = 1..30 is the number of a mid layer) complies with the Query.
Syntax
Pad_CornerRadius_Value_MidLayer<n> = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_CornerRadius_Value_MidLayer<n>) : Number– to specify a corner radius in mil. -
AsMM(Pad_CornerRadius_Value_MidLayer<n>) : Number– to specify a corner radius in mm.
Example Usage
Pad_CornerRadius_Value_MidLayer1 = 100
Returns all pad objects whose Pad Corner Radius Size (Mid Layer 1) property is equal to 100 current measurement units.
Pad_CornerRadius_Value_MidLayer2 >= 4.064
Returns all pad objects whose Pad Corner Radius Size (Mid Layer 2) property is greater than, or equal to, 4.064 current measurement units.
AsMils(Pad_CornerRadius_Value_MidLayer5) > 80
Returns all pad objects whose Pad Corner Radius Size (Mid Layer 5) property is greater than 80 mil.
AsMM(Pad_CornerRadius_Value_MidLayer10) Between 1.524 And 3.81
Returns all pad objects whose Pad Corner Radius Size (Mid Layer 10) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
Pad_CornerRadius_Value_MidLayer30 <> 50
Returns all pad objects whose Pad Corner Radius Size (Mid Layer 30) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Size (Mid Layer <n>) properties will be the same as the Pad Corner Radius Size (All Layers) property since the specified Corner Radius is used for all signal layers. - A Pad Corner Radius Size (Mid Layer <n>) property is only defined for pad objects.
Pad_CornerRadius_Value_TopLayer
Summary
Returns pad objects whose Pad Corner Radius Size (Top Layer) property complies with the Query.
Syntax
Pad_CornerRadius_Value_TopLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_CornerRadius_Value_TopLayer) : Number– to specify a corner radius in mil. -
AsMM(Pad_CornerRadius_Value_TopLayer) : Number– to specify a corner radius in mm.
Example Usage
Pad_CornerRadius_Value_TopLayer = 100
Returns all pad objects whose Pad Corner Radius Size (Top Layer) property is equal to 100 current measurement units.
Pad_CornerRadius_Value_TopLayer >= 4.064
Returns all pad objects whose Pad Corner Radius Size (Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(Pad_CornerRadius_Value_TopLayer) > 80
Returns all pad objects whose Pad Corner Radius Size (Top Layer) property is greater than 80 mil.
AsMM(Pad_CornerRadius_Value_TopLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Corner Radius Size (Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
Pad_CornerRadius_Value_TopLayer <> 50
Returns all pad objects whose Pad Corner Radius Size (Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Corner Radius Size (Top Layer) property will be the same as the Pad Corner Radius Size (All Layers) property since the specified Corner Radius is used for all signal layers. - The Pad Corner Radius Size (Top Layer) property is only defined for pad objects.
Pad_JumperID
Summary
Returns all pad objects whose Pad Jumper ID property complies with the Query.
Syntax
Pad_JumperID : Numeric_String
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.
Note
The Pad Jumper ID property is only defined for pad objects.
Pad_PinLength
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 4 current measurement units.
Pad_PinLength >= 5.08
Returns all pad objects that have a Pin/Pkg Length property that 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 that is greater than 4 mil.
AsMM(Pad_PinLength) Between 0.102 And 0.105
Returns all pad objects that have a Pin/Pkg Length property that is greater than or equal to 0.102 mm and less than or equal to 0.105 mm.
Pad_PinLength <> 2
Returns all pad objects that have a Pin/Pkg Length property that is not equal to 2 current measurement units.
AsMils(Pad_PinLength) <= 1.4
Returns all pad objects that have a Pin/Pkg Length property that is less than or equal to 1.4 mil.
AsMM(Pad_PinLength) < 0.05
Returns all pad objects that have a Pin/Pkg Length property that is less than 0.05 mm.
Note
The Pin/Pkg Length property is only defined for pad objects.
PadDonutOuterDiameter_AllLayers
Summary
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property complies with the Query.
Syntax
PadDonutOuterDiameter_AllLayers : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutOuterDiameter_AllLayers) : Number– to specify a donut outer diameter in mil. -
AsMM(PadDonutOuterDiameter_AllLayers) : Number– to specify a donut outer diameter in mm.
Example Usage
PadDonutOuterDiameter_AllLayers = 100
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property is equal to 100 current measurement units.
PadDonutOuterDiameter_AllLayers >= 4.064
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutOuterDiameter_AllLayers) > 80
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property is greater than 80 mil.
AsMM(PadDonutOuterDiameter_AllLayers) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutOuterDiameter_AllLayers <> 50
Returns all pad objects whose Pad Donut Outer Diameter(All Layers) property is not equal to 50 current measurement units.
PadDonutOuterDiameter_BottomLayer
Summary
Returns pad objects whose Pad Donut Outer Diameter(Bottom Layer) property complies with the Query.
Syntax
PadDonutOuterDiameter_BottomLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutOuterDiameter_BottomLayer) : Number– to specify a donut outer diameter in mil. -
AsMM(PadDonutOuterDiameter_BottomLayer) : Number– to specify a donut outer diameter in mm.
Example Usage
PadDonutOuterDiameter_BottomLayer = 100
Returns all pad objects whose Pad Donut Outer Diameter(Bottom Layer) property is equal to 100 current measurement units.
PadDonutOuterDiameter_BottomLayer >= 4.064
Returns all pad objects whose Pad Donut Outer Diameter(Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutOuterDiameter_BottomLayer) > 80
Returns all pad objects whose Pad Donut Outer Diameter(Bottom Layer) property is greater than 80 mil.
AsMM(PadDonutOuterDiameter_BottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Outer Diameter(Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutOuterDiameter_BottomLayer <> 50
Returns all pad objects whose Pad Donut Outer Diameter(Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Outer Diameter(Bottom Layer) property will be the same as the Pad Donut Outer Diameter(All Layers) property since the specified donut outer diameter is used for all signal layers. -
The Pad Donut Outer Diameter(Bottom Layer) property is only defined for pad objects.
PadDonutOuterDiameter_MidLayerN
Summary
Returns pad objects whose Pad Donut Outer Diameter(Mid Layer <n>) property (where n = 1..30 is the number of a mid layer) complies with the Query.
Syntax
PadDonutOuterDiameter_MidLayer<n> = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutOuterDiameter_MidLayer<n>) : Number– to specify a donut outer diameter in mil. -
AsMM(PadDonutOuterDiameter_MidLayer<n>) : Number– to specify a donut outer diameter in mm.
Example Usage
PadDonutOuterDiameter_MidLayer1 = 100
Returns all pad objects whose Pad Donut Outer Diameter(Mid Layer 1) property is equal to 100 current measurement units.
PadDonutOuterDiameter_MidLayer2 >= 4.064
Returns all pad objects whose Pad Donut Outer Diameter(Mid Layer 2) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutOuterDiameter_MidLayer5) > 80
Returns all pad objects whose Pad Donut Outer Diameter(Mid Layer 5) property is greater than 80 mil.
AsMM(PadDonutOuterDiameter_MidLayer10) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Outer Diameter(Mid Layer 10) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutOuterDiameter_MidLayer30 <> 50
Returns all pad objects whose Pad Donut Outer Diameter(Mid Layer 30) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Outer Diameter(Mid Layer <n>) properties will be the same as the Pad Donut Outer Diameter(All Layers) property since the specified donut outer diameter is used for all signal layers. -
A Pad Donut Outer Diameter(Mid Layer <n>) property is only defined for pad objects.
PadDonutOuterDiameter_TopLayer
Summary
Returns pad objects whose Pad Donut Outer Diameter(Top Layer) property complies with the Query.
Syntax
PadDonutOuterDiameter_TopLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutOuterDiameter_TopLayer) : Number– to specify a donut outer diameter in mil. -
AsMM(PadDonutOuterDiameter_TopLayer) : Number– to specify a donut outer diameter in mm.
Example Usage
PadDonutOuterDiameter_TopLayer = 100
Returns all pad objects whose Pad Donut Outer Diameter(Top Layer) property is equal to 100 current measurement units.
PadDonutOuterDiameter_TopLayer >= 4.064
Returns all pad objects whose Pad Donut Outer Diameter(Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutOuterDiameter_TopLayer) > 80
Returns all pad objects whose Pad Donut Outer Diameter(Top Layer) property is greater than 80 mil.
AsMM(PadDonutOuterDiameter_TopLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Outer Diameter(Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutOuterDiameter_TopLayer <> 50
Returns all pad objects whose Pad Donut Outer Diameter(Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Outer Diameter(Top Layer) property will be the same as the Pad Donut Outer Diameter(All Layers) property since the specified donut outer diameter is used for all signal layers. -
The Pad Donut Outer Diameter(Top Layer) property is only defined for pad objects.
PadDonutWidth_AllLayers
Summary
Returns all pad objects whose Pad Donut Width(All Layers) property complies with the Query.
Syntax
PadDonutWidth_AllLayers : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutWidth_AllLayers) : Number– to specify a donut width in mil. -
AsMM(PadDonutWidth_AllLayers) : Number– to specify a donut width in mm.
Example Usage
PadDonutWidth_AllLayers = 100
Returns all pad objects whose Pad Donut Width(All Layers) property is equal to 100 current measurement units.
PadDonutWidth_AllLayers >= 4.064
Returns all pad objects whose Pad Donut Width(All Layers) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutWidth_AllLayers) > 80
Returns all pad objects whose Pad Donut Width(All Layers) property is greater than 80 mil.
AsMM(PadDonutWidth_AllLayers) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Width(All Layers) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutWidth_AllLayers <> 50
Returns all pad objects whose Pad Donut Width(All Layers) property is not equal to 50 current measurement units.
PadDonutWidth_BottomLayer
Summary
Returns pad objects whose Pad Donut Width(Bottom Layer) property complies with the Query.
Syntax
PadDonutWidth_BottomLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutWidth_BottomLayer) : Number– to specify a donut width in mil. -
AsMM(PadDonutWidth_BottomLayer) : Number– to specify a donut width in mm.
Example Usage
PadDonutWidth_BottomLayer = 100
Returns all pad objects whose Pad Donut Width(Bottom Layer) property is equal to 100 current measurement units.
PadDonutWidth_BottomLayer >= 4.064
Returns all pad objects whose Pad Donut Width(Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutWidth_BottomLayer) > 80
Returns all pad objects whose Pad Donut Width(Bottom Layer) property is greater than 80 mil.
AsMM(PadDonutWidth_BottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Width(Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutWidth_BottomLayer <> 50
Returns all pad objects whose Pad Donut Width(Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Width(Bottom Layer) property will be the same as the Pad Donut Width(All Layers) property since the specified donut width is used for all signal layers. -
The Pad Donut Width(Bottom Layer) property is only defined for pad objects.
PadDonutWidth_MidLayerN
Summary
Returns pad objects whose Pad Donut Width(Mid Layer <n>) property (where n = 1..30 is the number of a mid layer) complies with the Query.
Syntax
PadDonutWidth_MidLayer<n> = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutWidth_MidLayer<n>) : Number– to specify a donut width in mil. -
AsMM(PadDonutWidth_MidLayer<n>) : Number– to specify a donut width in mm.
Example Usage
PadDonutWidth_MidLayer1 = 100
Returns all pad objects whose Pad Donut Width(Mid Layer 1) property is equal to 100 current measurement units.
PadDonutWidth_MidLayer2 >= 4.064
Returns all pad objects whose Pad Donut Width(Mid Layer 2) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutWidth_MidLayer5) > 80
Returns all pad objects whose Pad Donut Width(Mid Layer 5) property is greater than 80 mil.
AsMM(PadDonutWidth_MidLayer10) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Width(Mid Layer 10) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutWidth_MidLayer30 <> 50
Returns all pad objects whose Pad Donut Width(Mid Layer 30) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Width(Mid Layer <n>) properties will be the same as the Pad Donut Width(All Layers) property since the specified donut width is used for all signal layers. -
A Pad Donut Width(Mid Layer <n>) property is only defined for pad objects.
PadDonutWidth_TopLayer
Summary
Returns pad objects whose Pad Donut Width(Top Layer) property complies with the Query.
Syntax
PadDonutWidth_TopLayer = Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(PadDonutWidth_TopLayer) : Number– to specify a donut width in mil. -
AsMM(PadDonutWidth_TopLayer) : Number– to specify a donut width in mm.
Example Usage
PadDonutWidth_TopLayer = 100
Returns all pad objects whose Pad Donut Width(Top Layer) property is equal to 100 current measurement units.
PadDonutWidth_TopLayer >= 4.064
Returns all pad objects whose Pad Donut Width(Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadDonutWidth_TopLayer) > 80
Returns all pad objects whose Pad Donut Width(Top Layer) property is greater than 80 mil.
AsMM(PadDonutWidth_TopLayer) Between 1.524 And 3.81
Returns all pad objects whose Pad Donut Width(Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadDonutWidth_TopLayer <> 50
Returns all pad objects whose Pad Donut Width(Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Pad Donut Width(Top Layer) property will be the same as the Pad Donut Width(All Layers) property since the specified donut width is used for all signal layers. -
The Pad Donut Width(Top Layer) property is only defined for pad objects.
PadElectricalType
Summary
Returns all pad objects whose Electrical Type property complies with the Query.
Syntax
PadElectricalType = ElectricalType_String
PadElectricalType <> ElectricalType_String
ElectricalType_String must be one of the strings from the following list:
-
'Load' -
'Source' -
'Terminator'
Example Usage
PadElectricalType = 'Load'
Returns all pad objects whose Electrical Type property is Load.
PadElectricalType <> 'Source'
Returns all objects except pad objects whose Electrical Type property is Source.
Notes
- The Electrical Type property is only defined for pad objects.
-
The single quote characters (') at the start and end of
ElectricalType_Stringare mandatory.
PadIsPlated
Summary
Returns all pad objects whose Plated property complies with the Query.
Syntax
PadIsPlated : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
PadIsPlated = 'True'
Returns all pad objects whose Plated property is enabled.
PadIsPlated = 'False'
Returns all pad objects whose Plated property is disabled.
PadIsPlated <> 'True'
Not (PadIsPlated = 'True')
Returns all objects except pad objects whose Plated property is enabled.
PadIsPlated <> 'False'
Not (PadIsPlated = 'False')
Returns all objects except pad objects whose Plated property is disabled.
Note
The Plated property is only defined for pad objects.
PadShape_AllLayers
Summary
Returns all simple pad objects, whose Shape (All Layers) property complies with the Query.
Syntax
PadShape_AllLayers = PadShape_String
PadShape_AllLayers <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape'
Example Usage
PadShape_AllLayers = 'Rectangular'
Returns all simple pad objects whose Shape (All Layers) property is set to Rectangular.
PadShape_AllLayers <> 'Octagonal'
Returns all objects except for simple pad objects whose Shape (All Layers) property is set to Octagonal.
PadShape_AllLayers = 'Round' || PadShape_AllLayers = 'Rectangular'
Returns all simple pad objects whose Shape (All Layers) property is set to either Round or Rectangular.
IsPad && PadShape_AllLayers <> 'Octagonal'
Returns all objects except for simple pad objects whose Shape (All Layers) property is set to Octagonal.
Notes
-
The single quote characters (') at the start and end of
PadShape_Stringare mandatory. -
The Shape (All Layers) property is only defined for simple pads (those with Stack Mode property set to
Simple).
PadShape_BottomLayer
Summary
Returns pad objects whose Shape (Bottom Layer) property complies with the Query.
Syntax
PadShape_BottomLayer = PadShape_String
PadShape_BottomLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape'
Example Usage
PadShape_BottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Bottom Layer) property is set to Rectangular.
PadShape_BottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Bottom Layer) property is set to Octagonal.
PadShape_BottomLayer = 'Round' || PadShape_BottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Bottom Layer) property is set to either Round or Rectangular.
IsPad && PadShape_BottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Bottom Layer) property is set to Octagonal.
Notes
-
The single quote characters (') at the start and end of
PadShape_Stringare mandatory. -
For simple pads (with Stack Mode set to
Simple) the Shape (Bottom Layer) property will be the same as the Shape (All Layers) property, since the specified shape is used for all signal layers. - The Shape (Bottom Layer) property is only defined for pad objects.
PadShape_MidLayerN
Summary
Returns pad objects whose Shape (Mid Layer <n>) property complies with the Query.
Syntax
PadShape_MidLayer<n> = PadShape_String
PadShape_MidLayer<n> <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape'
Example Usage
PadShape_MidLayer<n> = 'Rectangular'
Returns all pad objects whose Shape (Mid Layer <n>) property is set to Rectangular.
PadShape_MidLayer<n> <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Mid Layer <n>) property is set to Octagonal.
PadShape_MidLayer<n> = 'Round' || PadShape_MidLayer<n> = 'Rectangular'
Returns all pad objects whose Shape (Mid Layer 1) property is set to either Round or Rectangular.
IsPad && PadShape_MidLayer<n> <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Mid Layer <n>) property is set to Octagonal.
Notes
-
The single quote characters (') at the start and end of
PadShape_Stringare mandatory. -
For simple pads (with Stack Mode set to
Simple) the Shape (Mid Layer <n>) property will be the same as the Shape (All Layers) property since the specified shape is used for all signal layers. -
The Shape (Mid Layer <n>) property is only defined for pad objects.
PadShape_PasteBottomLayer
Summary
Returns pad objects whose Shape (Paste Mask Bottom Layer) property complies with the Query.
Syntax
PadShape_PasteBottomLayer = PadShape_String
PadShape_PasteBottomLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape' -
'NoShape'
Example Usage
PadShape_PasteBottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Paste Mask Bottom Layer) property is set to Rectangular.
PadShape_PasteBottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Paste Mask Bottom Layer) property is set to Octagonal.
PadShape_PasteBottomLayer = 'Round' || PadShape_PasteBottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Paste Mask Bottom Layer) property is set to either Round or Rectangular.
IsPad && PadShape_PasteBottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Paste Mask Bottom Layer) property is set to Octagonal.
Notes
-
The single quote characters (
') at the start and end ofPadShape_Stringare mandatory. - The Shape (Paste Mask Bottom Layer) property is only defined for pad objects.
PadShape_PasteTopLayer
Summary
Returns pad objects whose Shape (Paste Mask Top Layer) property complies with the Query.
Syntax
PadShape_PasteTopLayer = PadShape_String
PadShape_PasteTopLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape' -
'NoShape'
Example Usage
PadShape_PasteTopLayer = 'Rectangular'
Returns all pad objects whose Shape (Paste Mask Top Layer) property is set to Rectangular.
PadShape_PasteTopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Paste Mask Top Layer) property is set to Octagonal.
PadShape_PasteTopLayer = 'Round' || PadShape_PasteTopLayer = 'Rectangular'
Returns all pad objects whose Shape (Paste Mask Top Layer) property is set to either Round or Rectangular.
IsPad && PadShape_PasteTopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Paste Mask Top Layer) property is set to Octagonal.
Notes
-
The single quote characters (
') at the start and end ofPadShape_Stringare mandatory. - The Shape (Paste Mask Top Layer) property is only defined for pad objects.
PadShape_SolderBottomLayer
Summary
Returns pad objects whose Shape (Solder Mask Bottom Layer) property complies with the Query.
Syntax
PadShape_SolderBottomLayer = PadShape_String
PadShape_SolderBottomLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape' -
'NoShape'
Example Usage
PadShape_SolderBottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Solder Mask Bottom Layer) property is set to Rectangular.
PadShape_SolderBottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Solder Mask Bottom Layer) property is set to Octagonal.
PadShape_SolderBottomLayer = 'Round' || PadShape_SolderBottomLayer = 'Rectangular'
Returns all pad objects whose Shape (Solder Mask Bottom Layer) property is set to either Round or Rectangular.
IsPad && PadShape_SolderBottomLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Solder Mask Bottom Layer) property is set to Octagonal.
Notes
-
The single quote characters (
') at the start and end ofPadShape_Stringare mandatory. - The Shape (Solder Mask Bottom Layer) property is only defined for pad objects.
PadShape_SolderTopLayer
Summary
Returns pad objects whose Shape (Solder Mask Top Layer) property complies with the Query.
Syntax
PadShape_SolderTopLayer = PadShape_String
PadShape_SolderTopLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape' -
'NoShape'
Example Usage
PadShape_SolderTopLayer = 'Rectangular'
Returns all pad objects whose Shape (Solder Mask Bottom Layer) property is set to Rectangular.
PadShape_SolderTopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Solder Mask Bottom Layer) property is set to Octagonal.
PadShape_SolderTopLayer = 'Round' || PadShape_SolderTopLayer = 'Rectangular'
Returns all pad objects whose Shape (Solder Mask Bottom Layer) property is set to either Round or Rectangular.
IsPad && PadShape_SolderTopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Solder Mask Bottom Layer) property is set to Octagonal.
Notes
-
The single quote characters (
') at the start and end ofPadShape_Stringare mandatory. - The Shape (Solder Mask Top Layer) property is only defined for pad objects.
PadShape_TopLayer
Summary
Returns pad objects whose Shape (Top Layer) property complies with the Query.
Syntax
PadShape_TopLayer = PadShape_String
PadShape_TopLayer <> PadShape_String
PadShape_String must be one of the following strings:
-
'Round' -
'Rectangular' -
'Octagonal' -
'Rounded Rectangle' -
'Chamfered Rectangle' -
'Donut' -
'Custom Shape'
Example Usage
PadShape_TopLayer = 'Rectangular'
Returns all pad objects whose Shape (Top Layer) property is set to Rectangular.
PadShape_TopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Top Layer) property is set to Octagonal.
PadShape_TopLayer = 'Round' || PadShape_TopLayer = 'Rectangular'
Returns all pad objects whose Shape (Top Layer) property is set to either Round or Rectangular.
IsPad && PadShape_TopLayer <> 'Octagonal'
Returns all objects except for pad objects whose Shape (Top Layer) property is set to Octagonal.
Notes
-
The single quote characters (') at the start and end of
PadShape_Stringare mandatory. -
For simple pads (with Stack Mode set to
Simple) the Shape (Top Layer) property will be the same as the Shape (All Layers) property since the specified shape is used for all signal layers. -
The Shape (Top Layer) property is only defined for pad objects.
PadStackMode
Summary
Returns all pad objects whose Stack Mode property complies with the Query.
Syntax
PadStackMode = StackMode_String
PadStackMode <> StackMode_String
StackMode_String must be one of the strings from the following list:
-
'Full Stack' -
'Simple' -
'Top-Middle-Bottom'
Example Usage
PadStackMode = 'Simple'
Returns all pad objects whose Stack Mode property is Simple.
PadStackMode <> 'Full Stack'
Returns all objects except pad objects whose Stack Mode property is Full Stack.
PadStackMode = 'Simple' || PadStackMode = 'Top-Middle-Bottom'
IsPad && PadStackMode <> 'Full Stack'
Returns all objects except pad objects whose Stack Mode property is Full Stack.
Notes
- The Stack Mode property is only defined for pad objects.
-
The single quote characters (') at the start and end of
StackMode_Stringare mandatory.
PadViaCustomThermalProfile
Summary
Returns all pad and via objects whose Custom Thermal Relief property complies with the Query.
Syntax
PadViaCustomThermalProfile : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
PadViaCustomThermalProfile = 'True'
Returns all pad and via objects whose Custom Thermal Relief property is enabled.
PadViaCustomThermalProfile = 'False'
Returns all pad and via objects whose Custom Thermal Relief property is disabled.
PadViaCustomThermalProfile <> 'True'
Not (PadViaCustomThermalProfile = 'True')
Returns all objects except pad and via objects whose Custom Thermal Relief property is enabled.
PadViaCustomThermalProfile <> 'False'
Not (PadViaCustomThermalProfile = 'False')
Returns all objects except pad and via objects whose Custom Thermal Relief property is disabled.
Notes
-
The Custom Thermal Relief property is only defined for pad and via objects.
-
The Custom Thermal Relief property (as reflected in the List panels), relates to the Thermal Relief option in the Size and Shape section when viewing the properties for a selected object through the Properties panel.
PadViaLibrary
Summary
Returns all pad and via objects whose Library property complies with the Query.
Syntax
PadViaLibrary = PadViaLibrary_String
PadViaLibrary_String must be a string that:
-
Targets pads/vias from the required Pad Via Template Library. In this case, the string should target that library name (e.g.
'ExamplePVLib.PvLib'). -
Targets pads/vias from the local template library. In this case, the
'<Local>'string must be used.
Example Usage
PadViaLibrary = '<Local>'
Returns all pad and via objects whose Library property is <Local>.
PadViaLibrary = 'ExamplePVLib.PvLib'
Returns all pad and via objects whose Library property is ExamplePVLib.PvLib.
PadViaLibrary Like '*PVLib'
Returns all pad and via objects whose Library property ends in PVLib. For example, pads/vias placed from the template library ExamplePVLib.PvLib would be returned using this expression.
Notes
- The Library property is only defined for pad and via objects.
-
The single quote characters (') at the start and end of
PadViaLibrary_Stringare mandatory.
PadViaLibraryTemplate
Summary
Returns all pad and/or via objects whose Library Template property complies with the Query.
Syntax
PadViaLibraryTemplate : String
The entered string must target the name of the required pad/via template (e.g. 'c152hn127').
Example Usage
PadViaLibraryTemplate = 'c152hn127'
Returns all pad objects whose Library Template property is c152hn127.
PadViaLibraryTemplate = 'v127h71'
Returns all via objects whose Library Template property is v127h71.
PadViaLibraryTemplate Like '*127'
Returns all pad and via objects whose Library Template property ends in 127. For example, a pad placed using template c152hn127 and a via placed using template v102h71x127 would be returned using this expression.
Note
The Library Template property is only defined for pad and via objects.
PadViaLinkedToTemplate
Summary
Returns all pad and via objects whose Linked To Library property complies with the Query.
Syntax
PadViaLinkedToTemplate : Boolean_String
Example Usage
PadViaLinkedToTemplate = 'True'
Returns all pad and via objects whose Linked To Library property is enabled (are linked to a Pad Via Template Library (*.PvLib).
PadViaLinkedToTemplate = 'False'
Returns all pad and via objects whose Linked To Library property is disabled (are not linked to a Pad Via Template Library (*.PvLib).
Note
The Linked To Library property is only defined for pad and via objects.
PadXOffset
Summary
Returns all pad objects whose Pad X Offset property complies with the Query.
Syntax
PadXOffset : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Pad X Offset property that is 2 current measurement units.
PadXOffset >= 0.2286
Returns all pad objects that have a Pad X Offset property that 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 a Pad X Offset property that is greater than, or equal to, 0.5 mil and less than, or equal to, 0.6 mil.
AsMM(PadXOffset) < 0.2794
Returns all pad objects that have a Pad X Offset property that is less than 0.2794 mm.
Notes
-
The Pad X Offset property is only defined for pad objects.
-
The Pad X Offset property corresponds to the Offset From Hole Center X field when viewing the properties for a selected pad on the Properties panel.
PadXSize_AllLayers
Summary
Returns all simple pad objects, whose X Size (All Layers) property complies with the Query.
Syntax
PadXSize_AllLayers : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadXSize_AllLayers <> 50
Returns all simple pad objects whose X Size (All Layers) property is not equal to 50 current measurement units.
Note
The X Size (All Layers) property is only defined for pads and vias whose Stack Mode property is set to Simple.
PadXSize_BottomLayer
Summary
Returns pad objects whose X Size (Bottom Layer) property complies with the Query.
Syntax
PadXSize_BottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadXSize_BottomLayer <> 50
Returns all pad objects whose X Size (Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the X Size (Bottom Layer) property will be the same as the X Size (All Layers) property since the specified size is used for all signal layers. -
The X Size (Bottom Layer) property is only defined for pad and via objects.
PadXSize_MidLayerN
Summary
Returns pad objects whose X Size (Mid Layer <n>) property complies with the Query.
Syntax
PadXSize_MidLayer1 : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadXSize_MidLayer<n> <> 50
Returns all pad objects whose X Size (Mid Layer <n>) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the X Size (Mid Layer <n>) property will be the same as the X Size (All Layers) property since the specified size is used for all signal layers. -
The X Size (Mid Layer <n>) property is only defined for pad and via objects.
PadXSize_PasteBottomLayer
Summary
Returns pad objects whose X Size (Paste Mask Bottom Layer) property complies with the Query.
Syntax
PadXSize_PasteBottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_PasteBottomLayer) : Number– to specify a size in mil. -
AsMM(PadXSize_PasteBottomLayer) : Number– to specify a size in mm.
Example Usage
PadXSize_PasteBottomLayer = 100
Returns all pad objects whose X Size (Paste Mask Bottom Layer) property is equal to 100 current measurement units.
PadXSize_PasteBottomLayer >= 4.064
Returns all pad objects whose X Size (Paste Mask Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadXSize_PasteBottomLayer) > 80
Returns all pad objects whose X Size (Paste Mask Bottom Layer) property is greater than 80 mil.
AsMM(PadXSize_PasteBottomLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Paste Mask Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadXSize_PasteBottomLayer <> 50
Returns all pad objects whose X Size (Paste Mask Bottom Layer) property is not equal to 50 current measurement units.
Note
The X Size (Paste Mask Bottom Layer) property is only defined for pad objects.
PadXSize_PasteTopLayer
Summary
Returns pad objects whose X Size (Paste Mask Top Layer) property complies with the Query.
Syntax
PadXSize_PasteTopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_PasteTopLayer) : Number– to specify a size in mil. -
AsMM(PadXSize_PasteTopLayer) : Number– to specify a size in mm.
Example Usage
PadXSize_PasteTopLayer = 100
Returns all pad objects whose X Size (Paste Mask Top Layer) property is equal to 100 current measurement units.
PadXSize_PasteTopLayer >= 4.064
Returns all pad objects whose X Size (Paste Mask Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadXSize_PasteTopLayer) > 80
Returns all pad objects whose X Size (Paste Mask Top Layer) property is greater than 80 mil.
AsMM(PadXSize_PasteTopLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Paste Mask Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadXSize_PasteTopLayer <> 50
Returns all pad objects whose X Size (Paste Mask Top Layer) property is not equal to 50 current measurement units.
Note
The X Size (Paste Mask Top Layer) property is only defined for pad objects.
PadXSize_SolderBottomLayer
Summary
Returns pad objects whose X Size (Solder Mask Bottom Layer) property complies with the Query.
Syntax
PadXSize_SolderBottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_SolderBottomLayer) : Number– to specify a size in mil. -
AsMM(PadXSize_SolderBottomLayer) : Number– to specify a size in mm.
Example Usage
PadXSize_SolderBottomLayer = 100
Returns all pad objects whose X Size (Solder Mask Bottom Layer) property is equal to 100 current measurement units.
PadXSize_SolderBottomLayer >= 4.064
Returns all pad objects whose X Size (Solder Mask Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadXSize_SolderBottomLayer) > 80
Returns all pad objects whose X Size (Solder Mask Bottom Layer) property is greater than 80 mil.
AsMM(PadXSize_SolderBottomLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Solder Mask Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadXSize_SolderBottomLayer <> 50
Returns all pad objects whose X Size (Solder Mask Bottom Layer) property is not equal to 50 current measurement units.
Note
The X Size (Solder Mask Bottom Layer) property is only defined for pad objects.
PadXSize_SolderTopLayer
Summary
Returns pad objects whose X Size (Solder Mask Top Layer) property complies with the Query.
Syntax
PadXSize_SolderTopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_SolderTopLayer) : Number– to specify a size in mil. -
AsMM(PadXSize_SolderTopLayer) : Number– to specify a size in mm.
Example Usage
PadXSize_SolderTopLayer = 100
Returns all pad objects whose X Size (Solder Mask Top Layer) property is equal to 100 current measurement units.
PadXSize_SolderTopLayer >= 4.064
Returns all pad objects whose X Size (Solder Mask Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadXSize_SolderTopLayer) > 80
Returns all pad objects whose X Size (Solder Mask Top Layer) property is greater than 80 mil.
AsMM(PadXSize_SolderTopLayer) Between 1.524 And 3.81
Returns all pad objects whose X Size (Solder Mask Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadXSize_SolderTopLayer <> 50
Returns all pad objects whose X Size (Solder Mask Top Layer) property is not equal to 50 current measurement units.
Note
The X Size (Solder Mask Top Layer) property is only defined for pad objects.
PadXSize_TopLayer
Summary
Returns pad objects whose X Size (Top Layer) property complies with the Query.
Syntax
PadXSize_TopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadXSize_TopLayer <> 50
Returns all pad objects whose X Size (Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the X Size (Top Layer) property will be the same as the X Size (All Layers) property since the specified size is used for all signal layers. -
The X Size (Top Layer) property is only defined for pad and via objects.
PadYOffset
Summary
Returns all pad objects whose Pad Y Offset property complies with the Query.
Syntax
PadYOffset : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is 2 current measurement units.
PadYOffset >= 0.2286
Returns all pad objects that have an Pad Y Offset property that 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 that is greater than, or equal to, 0.5 mil and less than, or equal to, 0.6 mil.
AsMM(PadYOffset) < 0.2794
Returns all pad objects that have an Pad Y Offset property that is less than 0.2794 mm.
Notes
-
The Pad Y Offset property is only defined for pad objects.
-
The Pad Y Offset property corresponds to the Offset From Hole Center Y field when viewing the properties for a selected pad on the Properties panel.
PadYSize_AllLayers
Summary
Returns all simple pad objects, whose Y Size (All Layers) property complies with the Query.
Syntax
PadYSize_AllLayers : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadYSize_AllLayers <> 50
Returns all simple pad objects whose Y Size (All Layers) property is not equal to 50 current measurement units.
Note
The Y Size (All Layers) property is only defined for pads whose Stack Mode property is set to Simple.
PadYSize_BottomLayer
Summary
Returns pad objects whose Y Size (Bottom Layer) property complies with the Query.
Syntax
PadYSize_BottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadYSize_BottomLayer <> 50
Returns all pad objects whose Y Size (Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Y Size (Bottom Layer) property will be the same as the Y Size (All Layers) property since the specified size is used for all signal layers. -
The Y Size (Bottom Layer) property is only defined for pad objects.
PadYSize_MidLayerN
Summary
Returns pad objects whose Y Size (Mid Layer <n>) property complies with the Query.
Syntax
PadYSize_MidLayer<n> : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadYSize_MidLayer<n> <> 50
Returns all pad objects whose Y Size (Mid Layer <n>) property is not equal to 50 current measurement units.
PadYSize_PasteBottomLayer
Summary
Returns pad objects whose Y Size (Paste Mask Bottom Layer) property complies with the Query.
Syntax
PadYSize_PasteBottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_PasteBottomLayer) : Number– to specify a size in mil. -
AsMM(PadYSize_PasteBottomLayer) : Number– to specify a size in mm.
Example Usage
PadYSize_PasteBottomLayer = 100
Returns all pad objects whose Y Size (Paste Mask Bottom Layer) property is equal to 100 current measurement units.
PadYSize_PasteBottomLayer >= 4.064
Returns all pad objects whose Y Size (Paste Mask Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadYSize_PasteBottomLayer) > 80
Returns all pad objects whose Y Size (Paste Mask Bottom Layer) property is greater than 80 mil.
AsMM(PadYSize_PasteBottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Paste Mask Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadYSize_PasteBottomLayer <> 50
Returns all pad objects whose Y Size (Paste Mask Bottom Layer) property is not equal to 50 current measurement units.
Note
The Y Size (Paste Mask Bottom Layer) property is only defined for pad objects.
PadYSize_PasteTopLayer
Summary
Returns pad objects whose Y Size (Paste Mask Top Layer) property complies with the Query.
Syntax
PadYSize_PasteTopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_PasteTopLayer) : Number– to specify a size in mil. -
AsMM(PadYSize_PasteTopLayer) : Number– to specify a size in mm.
Example Usage
PadYSize_PasteTopLayer = 100
Returns all pad objects whose Y Size (Paste Mask Top Layer) property is equal to 100 current measurement units.
PadYSize_PasteTopLayer >= 4.064
Returns all pad objects whose Y Size (Paste Mask Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadYSize_PasteTopLayer) > 80
Returns all pad objects whose Y Size (Paste Mask Top Layer) property is greater than 80 mil.
AsMM(PadYSize_PasteTopLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Paste Mask Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadYSize_PasteTopLayer <> 50
Returns all pad objects whose Y Size (Paste Mask Top Layer) property is not equal to 50 current measurement units.
Note
The Y Size (Paste Mask Top Layer) property is only defined for pad objects.
PadYSize_SolderBottomLayer
Summary
Returns pad objects whose Y Size (Solder Mask Bottom Layer) property complies with the Query.
Syntax
PadYSize_SolderBottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_SolderBottomLayer) : Number– to specify a size in mil. -
AsMM(PadYSize_SolderBottomLayer) : Number– to specify a size in mm.
Example Usage
PadYSize_SolderBottomLayer = 100
Returns all pad objects whose Y Size (Solder Mask Bottom Layer) property is equal to 100 current measurement units.
PadYSize_SolderBottomLayer >= 4.064
Returns all pad objects whose Y Size (Solder Mask Bottom Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadYSize_SolderBottomLayer) > 80
Returns all pad objects whose Y Size (Solder Mask Bottom Layer) property is greater than 80 mil.
AsMM(PadYSize_SolderBottomLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Solder Mask Bottom Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadYSize_SolderBottomLayer <> 50
Returns all pad objects whose Y Size (Solder Mask Bottom Layer) property is not equal to 50 current measurement units.
Note
The Y Size (Solder Mask Bottom Layer) property is only defined for pad objects.
PadYSize_SolderTopLayer
Summary
Returns pad objects whose Y Size (Solder Mask Top Layer) property complies with the Query.
Syntax
PadYSize_SolderTopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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_SolderTopLayer) : Number– to specify a size in mil. -
AsMM(PadYSize_SolderTopLayer) : Number– to specify a size in mm.
Example Usage
PadYSize_SolderTopLayer = 100
Returns all pad objects whose Y Size (Solder Mask Top Layer) property is equal to 100 current measurement units.
PadYSize_SolderTopLayer >= 4.064
Returns all pad objects whose Y Size (Solder Mask Top Layer) property is greater than, or equal to, 4.064 current measurement units.
AsMils(PadYSize_SolderTopLayer) > 80
Returns all pad objects whose Y Size (Solder Mask Top Layer) property is greater than 80 mil.
AsMM(PadYSize_SolderTopLayer) Between 1.524 And 3.81
Returns all pad objects whose Y Size (Solder Mask Top Layer) property is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
PadYSize_SolderTopLayer <> 50
Returns all pad objects whose Y Size (Solder Mask Top Layer) property is not equal to 50 current measurement units.
Note
The Y Size (Solder Mask Top Layer) property is only defined for pad objects.
PadYSize_TopLayer
Summary
Returns pad objects whose Y Size (Top Layer) property complies with the Query.
Syntax
PadYSize_TopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
PadYSize_TopLayer <> 50
Returns all pad objects whose Y Size (Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple pads (with Stack Mode set to
Simple), the Y Size (Top Layer) property will be the same as the Y Size (All Layers) property since the specified size is used for all signal layers. -
The Y Size (Top Layer) property is only defined for pad objects.
PasteMaskEnabled
Summary
Returns all pad objects whose Use Paste property complies with the Query.
Syntax
PasteMaskEnabled : Boolean_String
Example Usage
PasteMaskEnabled = 'True'
Returns all pad objects whose Use Paste property is enabled.
PasteMaskEnabled = 'False'
Returns all pad objects whose Use Paste property is disabled.
Note
The Use Paste property is only defined for pad objects.
PasteMaskEnabledBottom
Summary
Returns all pad objects whose Paste Mask Enabled - Bottom property complies with the Query.
Syntax
PasteMaskEnabledBottom : Boolean_String
Example Usage
PasteMaskEnabledBottom = 'True'
Returns all pad objects whose Paste Mask Enabled - Bottom property is enabled.
PasteMaskEnabledBottom = 'False'
Returns all pad objects whose Paste Mask Enabled - Bottom property is disabled.
Note
The Paste Mask Enabled - Bottom property is only defined for pad objects.
PasteMaskEnabledTop
Summary
Returns all pad objects whose Paste Mask Enabled - Top property complies with the Query.
Syntax
PasteMaskEnabledTop : Boolean_String
Example Usage
PasteMaskEnabledTop = 'True'
Returns all pad objects whose Paste Mask Enabled - Top property is enabled.
PasteMaskEnabledTop = 'False'
Returns all pad objects whose Paste Mask Enabled - Top property is disabled.
Note
The Paste Mask Enabled - Top property is only defined for pad objects.
PasteMaskExpansion
Summary
The paste mask expansion distance for arcs, fills, pads, regions and tracks can be determined either by relevant Paste Mask Expansion design rules or manually by defining an expansion value as part of the object's properties. This function returns the following:
- Pads whose Paste Mask Expansion property complies with the Query.
-
Arcs, fills, regions, and tracks whose Paste Mask Expansion Mode is set to
ManualorFrom 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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a paste mask expansion in mil.PasteMaskExpansion) : Number -
AsMM(– to specify a paste mask expansion in mm.PasteMaskExpansion) : Number
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 3 mil and less than or equal to 5 mil. 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 3 mil and less than or equal to 5 mil.
AsMM(PasteMaskExpansion) < 0.1524
Returns all pad objects whose Paste Mask Expansion property is less than 0.1524 mm. 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.1524 mm.
Notes
- The paste mask expansion distance can be specified to be negative, zero, or positive in value.
- The Paste Mask Expansion property is only defined for arc, fill, pad, region and track objects.
PasteMaskExpansionMode
Summary
The paste mask expansion distance for arcs, fills, regions and tracks can be determined either by relevant Paste Mask Expansion design rules or manually by defining an expansion value as part of the object's properties. Alternatively, no masking can be employed for these objects. These three modes are determined by the object's Paste Mask Expansion Mode property. This function returns arc, fill, region and track objects whose Paste Mask Expansion Mode property complies with the Query.
Syntax
PasteMaskExpansionMode : ExpansionMode_String
ExpansionMode_String must be one of the following strings:
-
'None' -
'From Rule' -
'Manual'
Example Usage
PasteMaskExpansionMode = 'Manual'
Returns all arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to Manual, as well as pad objects whose Paste Mask Override property is enabled.
PasteMaskExpansionMode = 'From Rule'
Returns all arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to From Rule, as well as pad objects whose Paste Mask Override property is disabled.
PasteMaskExpansionMode = 'None'
Returns all objects except pad objects, and arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to either From Rule, or Manual.
PasteMaskExpansionMode <> 'Manual'
Not (PasteMaskExpansionMode = 'Manual')
Returns all objects except arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to Manual, and pad objects whose Paste Mask Override property is enabled.
PasteMaskExpansionMode <> 'From Rule'
Not (PasteMaskExpansionMode = 'From Rule')
Returns all objects except arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to From Rule, and pad objects whose Paste Mask Override property is disabled.
PasteMaskExpansionMode <> 'None'
Not (PasteMaskExpansionMode = 'None')
Returns all pad objects, as well as arc, fill, region and track objects whose Paste Mask Expansion Mode property is set to either From Rule, or Manual.
Notes
- The Paste Mask Expansion Mode property is only defined for arc, fill, region, and track objects.
-
The single quote characters (') at the start and end of
ExpansionMode_Stringare mandatory.
PasteMaskOverride
Summary
The paste mask expansion distance for pads can be determined either by relevant Paste Mask Expansion design rules or manually by defining an expansion value as part of the pad's properties. The latter requires that the pad's Paste Mask Override property be enabled. This function returns pad objects whose Paste Mask Override property complies with the Query.
Syntax
PasteMaskOverride : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
PasteMaskOverride = 'True'
Returns all pad objects whose Paste Mask Override property is enabled.
PasteMaskOverride = 'False'
Returns all pad objects whose Paste Mask Override property is disabled.
PasteMaskOverride <> 'True'
Not (PasteMaskOverride = 'True')
Returns all objects except pad objects whose Paste Mask Override property is enabled.
PasteMaskOverride <> 'False'
Not (PasteMaskOverride = 'False')
Returns all objects except pad objects whose Paste Mask Override property is disabled.
Note
The Paste Mask Override property is only defined for pad objects.
PasteMaskPercent
Summary
The paste mask expansion distance for pads can be determined as either an absolute value (mil/mm) or a percentage of the pad area. This function returns objects whose Paste Mask Percent property complies with the Query.
Syntax
PasteMaskPercent = PasteMaskPercent_String
PasteMaskPercent <> PasteMaskPercent_String
PasteMaskPercent_String specifies the paste mask expansion, expressed as a percentage.
Example Usage
PasteMaskPercent = '50%'
Returns all pad objects whose Paste Mask Percent property equals 50%.
PasteMaskPercent <> '30%'
Returns all objects except for pad objects whose Paste Mask Percent property equals 30%.
Notes
-
The single quote characters (') at the start and end of
PasteMaskPercent_Stringare mandatory. - The paste mask expansion percentage for a pad can be specified to be negative, zero, or positive in value.
PasteMaskUsePercent
Summary
The paste mask expansion distance for pads can be determined as either an absolute value (mil/mm) or a percentage of the pad area. This function returns objects whose Paste Mask Uses Percent property complies with the Query.
Syntax
PasteMaskUsePercent : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
PasteMaskUsePercent = 'True'
Returns all pad objects whose Paste Mask Uses Percent property is enabled.
PasteMaskUsePercent = 'False'
Returns all objects except for pad objects whose Paste Mask Uses Percent property is enabled.
PluggingMaterial
Summary
Returns all via objects whose Plugging Material property complies with the Query.
Syntax
PluggingMaterial : String
Example Usage
PluggingMaterial = 'Epoxy'
Returns all via objects whose Plugging Material property is Epoxy.
PluggingMaterial Like 'Epoxy*'
Returns all via objects that have a Plugging Material whose associated string commences with Epoxy.
Notes
- The Plugging Material property is only defined for via objects.
-
The single quote characters (
') at the start and end ofStringare mandatory.
PluggingSide
Summary
Returns all via objects whose Plugging Side property complies with the Query.
Syntax
PluggingSide = PluggingSide_String
PluggingSide <> PluggingSide_String
PluggingSide_String must be one of the strings from the following list:
-
'Top' -
'Bottom' -
'Both'
Example Usage
PluggingSide = 'Top'
Returns all via objects whose Plugging Side property is Top.
PluggingSide <> 'Both'
Returns all objects except via objects whose Plugging Side property is Both.
PluggingSide = 'Top' || PluggingSide = 'Bottom'
IsVia && PluggingSide <> 'Both'
Returns all objects except via objects whose Plugging Side property is Both.
Notes
- The Plugging Side property is only defined for via objects.
-
The single quote characters (
') at the start and end ofPluggingSide_Stringare mandatory.
PolygonArcApproximation
Summary
Returns all polygon pour objects whose Arc Approximation property complies with the Query.
Syntax
PolygonArcApproximation : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that 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 that is greater than, or equal to, 0.01 mil and less than, or equal to, 0.02 mil.
AsMM(PolygonArcApproximation) < 0.0127
Returns all polygon pour objects that have an Arc Approximation property that is less than 0.0127 mm.
Notes
-
The Arc Approximation property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonGridSize
Summary
Returns all polygon pour objects whose Grid Size property complies with the Query.
Syntax
PolygonGridSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Grid Size property that is 20 current measurement units.
PolygonGridSize >= 1.27
Returns all polygon pour objects that have a Grid Size property that is greater than, or equal to, 1.27 current measurement units.
AsMils(PolygonGridSize) Between 10 And 30
Returns all polygon pour objects that have a Grid Size property that is greater than, or equal to, 10 mil and less than, or equal to, 30 mil.
AsMM(PolygonGridSize) < 1.016
Returns all polygon pour objects that have a Grid Size property that is less than 1.016 mm.
Notes
-
The Grid Size property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonHatchingStyle
Summary
Returns all polygon pour objects whose Hatching Style property complies with the Query.
Syntax
PolygonHatchingStyle = PolygonHatchingStyle_String
PolygonHatchingStyle <> PolygonHatchingStyle_String
PolygonHatchingStyle_String must be one of the strings from the following list:
-
'45-Degree Hatch' -
'90-Degree Hatch' -
'Horizontal Hatch' -
'No Hatching' -
'Solid' -
'Vertical Hatch'
Example Usage
PolygonHatchingStyle = 'Horizontal Hatch'
Returns all polygon pour objects whose Hatching Style property is Horizontal Hatch.
PolygonHatchingStyle <> '45-Degree Hatch'
Returns all objects except polygon pour objects whose Hatching Style property is 45-Degree Hatch.
IsPolygon && PolygonHatchingStyle <> 'Solid'
Returns all polygon pour objects except those whose Hatching Style property is Solid.
Notes
- The Hatching Style property is only defined for polygon pour objects.
-
The single quote characters (') at the start and end of
PolygonHatchingStyle_Stringare mandatory.
PolygonIgnoreViolations
Summary
Returns all polygon pour objects whose Ignore On-Line Violations property complies with the Query.
Syntax
PolygonIgnoreViolations : Boolean_String
Example Usage
PolygonIgnoreViolations = 'True'
Returns all polygon pour objects whose Ignore On-Line Violations property is enabled.
PolygonIgnoreViolations = 'False'
Returns all polygon pour objects whose Ignore On-Line Violations property is disabled.
Notes
- The Ignore On-Line Violations property is only defined for polygon pour objects.
- The child objects of polygon pour objects returned by the Query, are not returned.
PolygonIslandAreaThreshold
Summary
Returns all polygon pour objects whose Island Area Threshold property complies with the Query.
Syntax
PolygonIslandAreaThreshold : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is 2 sqaure (current) measurement units.
PolygonIslandAreaThreshold >= 2
Returns all polygon pour objects that have an Island Area Threshold property that 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 that 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 that is less than 1.016 square mm.
Notes
-
The Island Area Threshold property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonMinimumPrimitiveSize
Summary
Returns all polygon pour objects whose Minimum Primitive Size property complies with the Query.
Syntax
PolygonMinimumPrimitiveSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Minimum Primitive Size property that is 4 current measurement units.
PolygonMinimumPrimitiveSize >= 0.0508
Returns all polygon pour objects that have a Minimum Primitive Size property that is greater than, or equal to, 0.0508 current measurement units.
AsMils(PolygonMinimumPrimitiveSize) Between 3 And 5
Returns all polygon pour objects that have a Minimum Primitive Size property that is greater than, or equal to, 3 mil and less than, or equal to, 5 mil.
AsMM(PolygonMinimumPrimitiveSize) < 0.1524
Returns all polygon pour objects that have a Minimum Primitive Size property that is less than 0.1524 mm.
Notes
-
The Minimum Primitive Size property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonNeckWidthThreshold
Summary
Returns all polygon pour objects whose Neck Width Threshold property complies with the Query.
Syntax
PolygonNeckWidthThreshold : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Neck Width Threshold property that is 5 current measurement units.
PolygonNeckWidthThreshold >= 5
Returns all polygon pour objects that have a Neck Width Threshold property that is greater than, or equal to, 5 current measurement units.
AsMils(PolygonNeckWidthThreshold) Between 5 And 10
Returns all polygon pour objects that have a Neck Width Threshold property that is greater than, or equal to, 5 mil and less than, or equal to, 10 mil.
AsMM(PolygonNeckWidthThreshold) < 0.127
Returns all polygon pour objects that have a Neck Width Threshold property that is less than 0.127 mm.
Notes
-
The Neck Width Threshold property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonPourOverSameNet
Summary
Returns all polygon pour objects whose Pour Over Same Net property complies with the Query.
Syntax
PolygonPourOverSameNet = PourOverSameNet_String
PolygonPourOverSameNet <> PourOverSameNet_String
PourOverSameNet_String must be one of the strings from the following list:
-
'Don't Pour Over Same Net Objects' -
'Pour Over All Same Net Objects' -
'Pour Over Same Net Polygons Only'
Example Usage
PolygonPourOverSameNet = 'Pour Over All Same Net Objects'
Returns all polygon pour objects whose Pour Over Same Net property is Pour Over All Same Net Objects.
PolygonPourOverSameNet <> 'Pour Over Same Net Polygons Only'
Returns all objects except polygon pour objects whose Pour Over Same Net property is Pour Over Same Net Polygons Only.
PolygonPourOverSameNet = 'Pour Over All Same Net Objects' || PolygonPourOverSameNet = 'Pour Over Same Net Polygons Only'
IsPolygon && PolygonPourOverSameNet <> 'Don't Pour Over Same Net Objects'
Returns all polygon pour objects except those whose Pour Over Same Net property is Don't Pour Over Same Net Objects.
Notes
- The Pour Over Same Net property is only defined for polygon pour objects.
-
The single quote characters (') at the start and end of
PourOverSameNet_Stringare mandatory. - The child objects of polygon pour objects returned by the Query are not returned.
PolygonRemoveDeadCopper
Summary
Returns all polygon pour objects whose Remove Dead Copper property complies with the Query.
Syntax
PolygonRemoveDeadCopper : Boolean_String
Example Usage
PolygonRemoveDeadCopper = 'True'
Returns all polygon pour objects whose Remove Dead Copper property is enabled.
PolygonRemoveDeadCopper = 'False'
Returns all polygon pour objects whose Remove Dead Copper property is disabled.
Notes
-
The Remove Dead Copper property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonRemoveIslandsByArea
Summary
Returns all polygon pour objects whose Remove Islands By Area property complies with the Query.
Syntax
PolygonRemoveIslandsByArea : Boolean_String
Example Usage
PolygonRemoveIslandsByArea = 'True'
Returns all polygon pour objects whose Remove Islands By Area property is enabled.
PolygonRemoveIslandsByArea = 'False'
Returns all polygon pour objects whose Remove Islands By Area property is disabled.
Notes
- The Remove Islands By Area property is only defined for polygon pour objects.
- The child objects of polygon pour objects returned by the Query are not returned.
PolygonRemoveNarrowNecks
Summary
Returns all polygon pour objects whose Remove Narrow Necks property complies with the Query.
Syntax
PolygonRemoveNarrowNecks : Boolean_String
Example Usage
PolygonRemoveNarrowNecks = 'True'
Returns all polygon pour objects whose Remove Narrow Necks property is enabled.
PolygonRemoveNarrowNecks = 'False'
Returns all polygon pour objects whose Remove Narrow Necks property is disabled.
Notes
-
The Remove Narrow Necks property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PolygonSurroundPads
Summary
Returns all polygon pour objects whose Surround Pads With property complies with the Query.
Syntax
PolygonSurroundPads = SurroundPads_String
PolygonSurroundPads <> SurroundPads_String
SurroundPads_String must be one of the strings from the following list:
-
'Arcs' -
'Octagons'
Example Usage
PolygonSurroundPads = 'Arcs'
Returns all polygon pour objects whose Surround Pads With property is Arcs.
PolygonSurroundPads <> 'Octagons'
Returns all objects except polygon pour objects whose Surround Pads With property is Octagons.
IsPolygon && PolygonSurroundPads <> 'Octagons'
Returns all polygon pour objects except those whose Surround Pads With property is Octagons.
Notes
- The Surround Pads With property is only defined for polygon pour objects.
-
The single quote characters (') at the start and end of
SurroundPads_Stringare mandatory. - The child objects of polygon pour objects returned by the Query are not returned.
PolygonTrackWidth
Summary
Returns all polygon pour objects whose Track Width property complies with the Query.
Syntax
PolygonTrackWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Track Width property that is 20 current measurement units.
PolygonTrackWidth >= 1.27
Returns all polygon pour objects that have a Track Width property that is greater than, or equal to, 1.27 current measurement units.
AsMils(PolygonTrackWidth) Between 10 And 30
Returns all polygon pour objects that have a Track Width property that is greater than, or equal to, 10 mil and less than, or equal to, 30 mil.
AsMM(PolygonTrackWidth) < 1.016
Returns all polygon pour objects that have a Track Width property that is less than 1.016 mm.
Notes
-
The Track Width property is only defined for polygon pour objects.
-
The child objects of polygon pour objects returned by the Query are not returned.
PositiveNet
Summary
Returns all differential pair objects whose Positive Net property complies with the Query.
Syntax
PositiveNet : String
Example Usage
PositiveNet = 'D_P'
Returns all differential pair objects whose Positive Net property is D_P.
PositiveNet Like '*RX1_P'
Returns all differential pair objects whose Positive Net property ends with RX1_P.
Notes
- The Positive Net property is only defined for differential pair objects.
- The child objects of differential pair objects returned by the Query are not returned.
PropagationDelay
Summary
Returns all arc, track, pad, via objects whose Propagation Delay property complies with the Query.
Syntax
PropagationDelay : Numeric_String
Example Usage
PropagationDelay = '70'
Returns all region objects whose Propagation Delay property is equal to 70.
PropagationDelay Between '200' And '400'
Returns all region objects whose Propagation Delay property is greater than or equal to 200 and less than or equal to 400.
PropagationDelay >= '100'
Returns all region objects whose Propagation Delay property is greater than or equal to 100.
PropagationDelay <> '120'
Returns all objects except region objects whose Propagation Delay property is equal to 120.
Note
The Propagation Delay property is only defined for component objects.
QrCodeInverted
Summary
Returns all text string objects whose BarCode Inverted property complies with the Query.
Syntax
QrCodeInverted : Boolean_String
Example Usage
QrCodeInverted = 'True'
Returns all text string objects whose BarCode Inverted property is enabled.
QrCodeInverted = 'False'
Returns all text string objects whose BarCode Inverted property is disabled.
Notes
-
The BarCode Inverted property is only defined for text string objects.
-
Use of this keyword will also return the text string child primitive objects of group design objects (component, coordinate, dimension, drill table, and layer stack table objects), whose BarCode Inverted property complies with the Query. Should you wish to target solely text string objects that have been configured as QR code text, use an additional keyword prefix to target those objects. An example query expression is
IsQrCodeText And (QrCodeInverted = 'True').
RadialDimensionAngularStep
Summary
Returns all radial diameter dimension, and radial dimension objects whose Angular Step property complies with the Query.
Syntax
RadialDimensionAngularStep : Number
Example Usage
RadialDimensionAngularStep = 30.0
Returns all radial diameter dimension, and radial dimension objects that have an Angular Step property that is 30.0 degrees.
RadialDimensionAngularStep > 60.0
Returns all radial diameter dimension, and radial dimension objects that have an Angular Step property that is greater than 60.0 degrees.
RadialDimensionAngularStep Between 30.0 And 150.0
Returns all radial diameter dimension, and radial dimension objects that have an Angular Step property that 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 an Angular Step property that is less than, or equal to, 45.0 degrees.
Note
The Angular Step property is only defined for radial diameter dimension and radial dimension objects.
Restricted
Summary
Returns all keepout objects whose Restricted for Layer property complies with the Query.
Syntax
Restricted = Layer_String
Restricted <> Layer_String
Example Usage
Restricted = 'TopLayer'
Returns all keepout objects on the TopLayer.
Restricted <> 'MidLayer1'
Returns all keepout objects except for those on the MidLayer1 layer.
Notes
-
The single quote characters (') at the start and end of
Layer_Stringare mandatory. - The Restricted for Layer property is only defined for keepout objects (arcs, fills, solid regions, and tracks).
Rotation
Summary
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects whose Rotation property complies with the Query.
Syntax
Rotation : Number
Example Usage
Rotation = 30.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is 30.0 degrees.
Rotation > 60.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is greater than 60.0 degrees.
Rotation Between 30.0 And 150.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is greater than, or equal to, 30.0 degrees and less than, or equal to, 150.0 degrees.
Rotation <= 45.0
Returns all baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects that have a Rotation property which is less than, or equal to, 45.0 degrees.
Note
The Rotation property is only defined for baseline dimension, center dimension, component, datum dimension, design view, drill table, fill, layer stack table, linear diameter dimension, linear dimension, OLE object, pad, and text string (comment, designator, free) objects.
RuleAttributes
Summary
Returns all design rule and violation objects whose Rule Attributes property complies with the Query.
Syntax
RuleAttributes : String
The entered string must target the attributes defined for the rule (e.g. 'Clearance = 10mil').
Example Usage
RuleAttributes = 'Clearance = 10mil'
Returns all design rule and violation objects whose Rule Attributes property is Clearance = 10mil.
RuleAttributes Like 'Expansion*'
Returns all design rule and violation objects whose Rule Attributes property starts with Expansion. In this case, all paste mask and solder mask-related rules and violations will be returned.
Note
The Rule Attributes property is only defined for design rule and violation objects.
RuleCategory
Summary
Returns all design rule objects whose Rule Category property complies with the Query.
Syntax
RuleCategory = Category_String
RuleCategory <> Category_String
Category_String must be one of the strings from the following list:
-
'Electrical' -
'High Speed' -
'Manufacturing' -
'Mask' -
'Placement' -
'Plane' -
'Routing' -
'Signal Integrity' -
'SMT' -
'Testpoint'
Example Usage
RuleCategory = 'Electrical'
Returns all design rule objects whose Rule Category property is Electrical.
RuleCategory <> 'High Speed'
Returns all objects except design rule objects whose Rule Category property is High Speed.
IsRule && RuleCategory <> 'Signal Integrity'
Returns all design rule objects except those whose Rule Category property is Signal Integrity.
Notes
- The Rule Category property is only defined for design rule objects.
-
The single quote characters (') at the start and end of
Category_Stringare mandatory.
RuleComment
Summary
Returns all design rule and objects whose Rule Comment property complies with the Query.
Syntax
RuleComment : String
The entered string must target the comment defined for a rule (e.g. 'This is an example clearance rule').
Example Usage
RuleComment = 'All fiducials masked on Paste Mask layers'
Returns all design rule objects whose Rule Comment property is All fiducials masked on Paste Mask layers.
RuleComment Like '*Clearance*'
Returns all design rule objects whose Rule Comment property contains the term Clearance. For example, a clearance rule with Comment = Example Clearance Rule, and a component clearance rule with Comment = Example Component Clearance Rule, would both be returned using this expression.
RuleComment = ''
Returns all objects except design rule objects that have an entry for their Rule Comment property.
Note
The Rule Comment property is only defined for design rule objects.
RuleEnabled
Summary
Returns all design rule objects whose Rule Enabled property complies with the Query.
Syntax
RuleEnabled : Boolean_String
Example Usage
RuleEnabled = 'True'
Returns all design rule objects whose Rule Enabled property is enabled.
RuleEnabled = 'False'
Returns all design rule objects whose Rule Enabled property is disabled.
Note
The Rule Enabled property is only defined for design rule objects.
RulePriority
Summary
Returns all design rule objects whose Rule Priority property complies with the Query.
Syntax
RulePriority : Numeric_String
RulePriority : Number
Example Usage
RulePriority = '1'
RulePriority <> '' && RulePriority = 1
Returns all design rule objects whose Rule Priority property is 2.
RulePriority > '' && RulePriority Between 3 And 5
Returns all design rule objects whose Rule Priority property is greater than, or equal to, 3 and less than, or equal to, 5.
ObjectKind Like '*Rule' && RulePriority >= 4
Returns all design rule objects whose Rule Priority property is greater than, or equal to, 4.
IsRule && RulePriority < 4
Returns all design rule objects whose Rule Priority property is less than 4.
RulePriority <> '1'
Returns all objects except design rule objects whose Rule Priority property is 1.
IsRule && RulePriority <> 1
Returns all design rule objects whose Rule Priority property is not equal to 1.
Note
The Rule Priority property is only defined for design rule objects.
RuleScope1
Summary
Returns all design rule and violation objects whose Scope 1 property complies with the Query.
Syntax
RuleScope1 : String
The entered string must target the scope defined for the rule (e.g. 'All').
Example Usage
RuleScope1 = 'All'
Returns all design rule and violation objects whose Scope 1 property is All.
RuleScope1 = 'InNet(''D7'')'
Returns all design rule and violation objects whose Scope 1 property is InNet('D7').
RuleScope1 Like 'InNet(''???'')'
Returns all design rule and violation objects whose Scope 1 property is InNet('???'). The string of the associated net needs to consist of exactly three characters, with examples of compliant Scope 1 properties being InNet('GND') and InNet('VCC').
Note
The Scope 1 property is only defined for design rule and violation objects.
RuleScope2
Summary
Returns all design rule and violation objects whose Scope 2 property complies with the Query.
Syntax
RuleScope2 : String
The entered string must target the scope defined for the rule (e.g. 'All').
Example Usage
RuleScope2 = 'All'
Returns all design rule and violation objects whose Scope 2 property is All.
RuleScope2 = '-'
Returns all design rule and violation objects that have no Scope 2 property. A few types of design rules have a Scope 1 and Scope 2 property (binary rules), but most types have only 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').
Note
The Scope 2 property is only defined for design rule and violation objects.
RuleType
Summary
Returns all design rule objects having a Rule Type property that complies with the Query.
Syntax
RuleType = RuleType_String
RuleType <> RuleType_String
RuleType_String must be one of the following strings:
-
Electrical Rules –
'Clearance','Short-Circuit','Un-Routed Net','Un-Connected Pin','Modified Polygon' -
Routing Rules –
'Width','Routing Topology','Routing Priority','Routing Layers','Routing Corners','Routing Via Style','Fanout Control','Differential Pairs Routing' -
SMT Rules –
'SMD To Corner','SMD To Plane','SMD Neck-Down','SMD Entry' -
Mask Rules –
'Solder Mask Expansion','Paste Mask Expansion' -
Plane Rules –
'Power Plane Connect Style','Power Plane Clearance','Polygon Connect Style' -
Testpoint Rules -
'Fabrication Testpoint Style','Fabrication Testpoint Usage','Assembly Testpoint Style','Assembly Testpoint Usage' -
Manufacturing Rules -
'Minimum Annular Ring','Acute Angle','Hole Size','Layer Pairs','Hole To Hole Clearance','Minimum Solder Mask Sliver','Silk To Solder Mask Clearance','Silk To Silk Clearance','Board Outline Clearance' -
High Speed Rules -
'Parallel Segment','Length','Matched Lengths','Daisy Chain Stub Length','Vias Under SMD','Maximum Via Count','Max Via Sub Length (Back Drilling)' -
Placement Rules –
'Room Definition','Component Clearance','Component Orientations','Permitted Layers','Nets to Ignore','Height' -
Signal Integrity Rules -
'Signal Stimulus','Overshoot - Falling Edge','Overshoot - Rising Edge','Undershoot - Falling Edge','Undershoot - Rising Edge','Impedance','Signal Top Value','Signal Base Value','Flight Time - Rising Edge','Flight Time - Falling Edge','Slope - Rising Edge','Slope - Falling Edge','Supply Nets'
Example Usage
RuleType = 'Clearance'
Returns all design rule objects whose Rule Type property is Clearance.
RuleType <> 'Paste Mask Expansion'
Returns all objects except design rule objects whose Rule Type property is Paste Mask Expansion.
IsRule && RuleType <> 'Height'
Returns all design rule objects whose Rule Type property is not Height.
Notes
- The Rule Type property is only defined for design rule objects.
-
The single quote characters (') at the start and end of
RuleType_Stringare mandatory.
ShowComment
Summary
Returns component objects whose Show Comment property complies with the Query.
Syntax
ShowComment : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
ShowComment = 'True'
Returns all component objects whose Show Comment property is enabled.
ShowComment = 'False'
Returns all component objects whose Show Comment property is disabled.
ShowComment <> 'True'
Not (ShowComment = 'True')
Returns all objects except component objects whose Show Comment property is enabled.
ShowComment <> 'False'
Not (ShowComment = 'False')
Returns all objects except component objects whose Show Comment property is disabled.
Notes
- The Show Comment property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
ShowName
Summary
Returns component objects whose Show Name property complies with the Query.
Syntax
ShowName : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
ShowName = 'True'
Returns all component objects whose Show Name property is enabled.
ShowName = 'False'
Returns all component objects whose Show Name property is disabled.
ShowName <> 'True'
Not (ShowName = 'True')
Returns all objects except component objects whose Show Name property is enabled.
ShowName <> 'False'
Not (ShowName = 'False')
Returns all objects except component objects whose Show Name property is disabled.
Notes
- The Show Name property is only defined for component objects.
- The child objects of components returned by the Query are not returned.
SlotHoleLength
Summary
Returns all pad objects whose Hole Length property complies with the Query.
Syntax
SlotHoleLength : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Hole Length property that is 50 current measurement units.
SlotHoleLength >= 50
Returns all pad objects that have a Hole Length property that is greater than, or equal to, 50 current measurement units.
AsMils(SlotHoleLength) Between 20 And 50
Returns all pad objects that have a Hole Length property that is greater than, or equal to, 0.5mil and less than, or equal to, 0.6 mil.
AsMM(SlotHoleLength) < 1.5
Returns all pad objects that have a Hole Length property that is less than 1.5 mm.
Note
The Hole Length property is only defined for pad objects.
SolderMaskExpansion
Summary
The solder mask expansion distance for arcs, fills, pads, regions, tracks, and vias can be determined either by relevant Solder Mask Expansion design rules or manually by defining an expansion value as part of the object's properties. This function returns the following:
-
Pads and vias whose Solder Mask Expansion property complies with the Query.
-
Arcs, fills, regions, and tracks whose Solder Mask Expansion Mode is set to
ManualorFrom 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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a solder mask expansion in mil.SolderMaskExpansion) : Number -
AsMM(– to specify a solder mask expansion in mm.SolderMaskExpansion) : Number
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 3 mil and less than or equal to 5 mil. 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 3 mil and less than or equal to 5 mil.
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.1524 mm. 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.1524 mm.
Notes
- The solder mask expansion distance can be specified to be negative, zero, or positive in value.
- The Solder Mask Expansion property is only defined for arc, fill, pad, region, track and via objects.
SolderMaskExpansionBottom
Summary
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 the 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
ManualorFrom 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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 3 mil and less than or equal to 5 mil. 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 3 mil and less than or equal to 5 mil.
AsMM(SolderMaskExpansionBottom) < 0.1524
Returns all pad and via objects whose Solder Mask Expansion - Bottom property is less than 0.1524 mm. 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.1524 mm.
Notes
-
The solder mask expansion distance can be specified to be negative, zero or positive in value.
-
The Solder Mask Expansion - Bottom property is only defined for pad and via objects.
SolderMaskExpansionFromHoleEdge
Summary
Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property complies with the Query.
Syntax
SolderMaskExpansionFromHoleEdge : Boolean_String
Example Usage
SolderMaskExpansionFromHoleEdge = 'True'
Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property is enabled.
SolderMaskExpansionFromHoleEdge = 'False'
Returns all pad and via objects whose Apply Solder Mask Expansion From The Hole Edge property is disabled.
Note
The Apply Solder Mask Expansion From The Hole Edge property is only defined for pad and via objects.
SolderMaskExpansionMode
Summary
The solder mask expansion distance for arcs, fills, regions and tracks can be determined either by relevant Solder Mask Expansion design rules or manually by defining an expansion value as part of the object's properties. Alternatively, no masking can be employed for these objects. These three modes are determined by the object's Solder Mask Expansion Mode property. This function returns arc, fill, region and track objects whose Solder Mask Expansion Mode property complies with the Query.
Syntax
SolderMaskExpansionMode : ExpansionMode_String
ExpansionMode_String must be one of the following strings:
-
'None' -
'From Rule' -
'Manual'
Example Usage
SolderMaskExpansionMode = 'Manual'
Returns all arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to Manual, as well as pad and via objects whose Solder Mask Override property is enabled.
SolderMaskExpansionMode = 'From Rule'
Returns all arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to From Rule, as well as pad and via objects whose Solder Mask Override property is disabled.
SolderMaskExpansionMode = 'None'
Returns all objects except pad and via objects, and arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to either From Rule, or Manual.
SolderMaskExpansionMode <> 'Manual'
Not (SolderMaskExpansionMode = 'Manual')
Returns all objects except arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to Manual, and pad and via objects whose Solder Mask Override property is enabled.
SolderMaskExpansionMode <> 'From Rule'
Not (SolderMaskExpansionMode = 'From Rule')
Returns all objects except arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to From Rule, and pad and via objects whose Solder Mask Override property is disabled.
SolderMaskExpansionMode <> 'None'
Not (SolderMaskExpansionMode = 'None')
Returns all pad and via objects, as well as arc, fill, region and track objects whose Solder Mask Expansion Mode property is set to either From Rule, or Manual.
Notes
- The Solder Mask Expansion Mode property is only defined for arc, fill, region, and track objects.
-
The single quote characters (') at the start and end of
ExpansionMode_Stringare mandatory.
SolderMaskExpansionTop
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 the 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
ManualorFrom 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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 3 mil 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 3 mil and less than or equal to 5 mil.
AsMM(SolderMaskExpansionTop) < 0.1524
Returns all pad and via objects whose Solder Mask Expansion - Top property is less than 0.1524 mm. Also returns arc, fill, region and track objects whose Solder Mask Expansion Mode is set to Manual or From Rule, and whose Solder Mask Expansion property is less than 0.1524mm.
Notes
-
The solder mask expansion distance can be specified to be negative, zero or positive in value.
-
The Solder Mask Expansion - Top property is only defined for pad and via objects.
SolderMaskOverride
Summary
The solder mask expansion distance for pads and vias can be determined either by relevant Solder Mask Expansion design rules or manually by defining an expansion value as part of the pad's/via's properties. The latter requires that the pad's/via's Solder Mask Override property be enabled. This function returns pad and via objects whose Solder Mask Override property complies with the Query.
Syntax
SolderMaskOverride : Boolean_String
Boolean_String must be either 'True' or 'False'.
Example Usage
SolderMaskOverride = 'True'
Returns all pad and via objects whose Solder Mask Override property is enabled.
SolderMaskOverride = 'False'
Returns all pad and via objects whose Solder Mask Override property is disabled.
SolderMaskOverride <> 'True'
Not (SolderMaskOverride = 'True')
Returns all objects except pad and via objects whose Solder Mask Override property is enabled.
SolderMaskOverride <> 'False'
Not (SolderMaskOverride = 'False')
Returns all objects except pad and via objects whose Solder Mask Override property is disabled.
Note
The Solder Mask Override property is only defined for pad and via objects.
SolderMaskTentingBottom
Summary
Returns all pad and via objects whose Solder Mask Tenting - Bottom property complies with the Query.
Syntax
SolderMaskTentingBottom : Boolean_String
Example Usage
SolderMaskTentingBottom = 'True'
Returns all pad and via objects whose Solder Mask Tenting - Bottom property is enabled.
SolderMaskTentingBottom = 'False'
Returns all pad and via objects whose Solder Mask Tenting - Bottom property is disabled.
Notes
-
The Solder Mask Tenting - Bottom property is only defined for pad and via objects.
-
The Solder Mask Tenting - Bottom property (as reflected in the List panels), relates to the Bottom option in the Solder Mask Expansion section when viewing the properties for a selected object through the Properties panel. When the Solder Mask Tenting - Bottom property is enabled, the Bottom option is disabled, meaning that the pad/via has no solder mask opening on the bottom of the board, and is therefore tented.
SolderMaskTentingTop
Summary
Returns all pad and via objects whose Solder Mask Tenting - Top property complies with the Query.
Syntax
SolderMaskTentingTop : Boolean_String
Example Usage
SolderMaskTentingTop = 'True'
Returns all pad and via objects whose Solder Mask Tenting - Top property is enabled.
SolderMaskTentingTop = 'False'
Returns all pad and via objects whose Solder Mask Tenting - Top property is disabled.
Notes
-
The Solder Mask Tenting - Top property is only defined for pad and via objects.
-
The Solder Mask Tenting - Top property (as reflected in the List panels), relates to the Top option in the Solder Mask Expansion section when viewing the properties for a selected object through the Properties panel. When the Solder Mask Tenting - Top property is enabled, the Top option is disabled, meaning that the pad/via has no solder mask opening on the top of the board, and is therefore tented.
StandoffHeight
Summary
Returns all extruded 3D body objects whose Model Standoff Height (Extruded) property complies with the Query.
Syntax
StandoffHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 100 current measurement units.
StandoffHeight >= 4.064
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property that 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 that is greater than 80 mil.
AsMM(StandoffHeight) Between 1.524 And 3.81
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property that is greater than or equal to 1.524 mm and less than or equal to 3.81 mm.
StandoffHeight <> 50
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property that 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 that is less than or equal to 120 mil.
AsMM(StandoffHeight) < 1.778
Returns all extruded 3D body objects that have a Model Standoff Height (Extruded) property that is less than 1.778 mm.
Note
The Model Standoff Height (Extruded) property is only defined for extruded 3D body objects.
StartLayer
Summary
Returns all via objects whose left-hand layer in their Drill Pair property complies with the Query.
Syntax
StartLayer = Layer_String
Example Usage
StartLayer = 'Top Layer'
Returns all via objects whose Drill Pair property has a left-hand entry of Top Layer.
StartLayer <> 'Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property has a left-hand entry of Signal Layer 2.
IsVia && StartLayer <> 'Internal Plane 1'
Returns all Via objects except those whose Drill Pair property has a left-hand entry of Internal Plane 1.
Notes
-
The single quote characters (') at the start and end of
Layer_Stringare mandatory. - The Drill Pair property is only defined for via objects.
StopLayer
Summary
Returns all via objects whose right-hand layer in their Drill Pair property complies with the Query.
Syntax
StopLayer = Layer_String
Example Usage
StopLayer = 'Top Layer'
Returns all via objects whose Drill Pair property has a right-hand entry of Top Layer.
StopLayer <> 'Signal Layer 2'
Returns all objects except for via objects whose Drill Pair property has a right-hand entry of Signal Layer 2.
IsVia && StopLayer <> 'Internal Plane 1'
Returns all Via objects except those whose Drill Pair property has a right-hand entry of Internal Plane 1.
Notes
-
The single quote characters (') at the start and end of
Layer_Stringare mandatory. - The Drill Pair property is only defined for via objects.
StringText
Summary
Returns text string and leader dimension objects whose String property complies with the Query.
Syntax
StringText : String
Example Usage
StringText = '100nF'
Returns all text string and leader dimension objects whose String property is 100 nF.
Notes
- The child objects of leader dimension objects returned by the Query are not returned.
- The String property is only defined for text string and leader dimension objects.
StringType
Summary
Returns all text objects whose String Type property complies with the Query.
Syntax
StringType = StringType_String
StringType <> StringType_String
StringType_String must be one of the strings from the following list:
-
'Comment' -
'Designator' -
'Free'
Example Usage
StringType = 'Designator'
Returns all text objects whose String Type property is Designator.
StringType <> 'Free'
Returns all objects except text objects whose String Type property is Free.
StringType = 'Comment' || StringType = 'Designator'
IsString && StringType <> 'Free'
Returns all text objects whose String Type property is not Free.
Notes
- The String Type property is only defined for text objects.
-
The single quote characters (') at the start and end of
StringType_Stringare mandatory.
StrokeFont
Summary
Returns all coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property complies with the Query.
Syntax
StrokeFont = Font_String
StrokeFont <> Font_String
Font_String must be one of the strings from the following list:
-
'Default' -
'Serif' -
'Sans Serif'
Example Usage
StrokeFont = 'Default'
Returns all coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property is Default.
StrokeFont <> 'Serif'
Returns all objects except coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects whose Stroke Font property is Serif.
Notes
-
The single quote characters (') at the start and end of
Font_Stringare mandatory. - The Stroke Font property is only defined for coordinate, drill table, layer stack table, original dimension, and text (comment, designator, free) objects.
TentingMaterial
Summary
Returns all via objects whose Tenting Material property complies with the Query.
Syntax
TentingMaterial : String
Example Usage
TentingMaterial = 'Epoxy'
Returns all via objects whose Tenting Material property is Epoxy.
TentingMaterial Like 'Epoxy*'
Returns all via objects that have a Tenting Material whose associated string commences with Epoxy.
Notes
- The Tenting Material property is only defined for via objects.
-
The single quote characters (
') at the start and end ofStringare mandatory.
TentingSide
Summary
Returns all via objects whose Tenting Side property complies with the Query.
Syntax
TentingSide = TentingSide_String
TentingSide <> TentingSide_String
TentingSide_String must be one of the strings from the following list:
-
'Top' -
'Bottom' -
'Both'
Example Usage
TentingSide = 'Top'
Returns all via objects whose Tenting Side property is Top.
TentingSide <> 'Both'
Returns all objects except via objects whose Tenting Side property is Both.
TentingSide = 'Top' || TentingSide = 'Bottom'
IsVia && TentingSide <> 'Both'
Returns all objects except via objects whose Tenting Side property is Both.
Notes
- The Tenting Side property is only defined for via objects.
-
The single quote characters (
') at the start and end ofTentingSide_Stringare mandatory.
Testpoint
Summary
Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, or Assembly Testpoint - Bottom properties comply with the Query.
Syntax
Testpoint : Boolean
Example Usage
Testpoint
Testpoint = True
Returns all pad and via objects that have 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 that have any of their Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, or Assembly Testpoint - Bottom properties enabled.
Note
The Fabrication Testpoint - Top, Fabrication Testpoint - Bottom, Assembly Testpoint - Top, and Assembly Testpoint - Bottom properties are only defined for pad and via objects.
TestpointAssy
Summary
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.
Note
The Assembly Testpoint - Top and Assembly Testpoint - Bottom properties are only defined for pad and via objects.
TestpointAssyBottom
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.
Note
The Assembly Testpoint - Bottom property is only defined for pad and via objects.
TestpointAssyTop
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.
Note
The Assembly Testpoint - Top property is only defined for pad and via objects.
TestpointBottom
Summary
Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties comply with the Query.
Syntax
TestpointBottom : Boolean
Example Usage
TestpointBottom
TestpointBottom = True
Returns all pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties are enabled.
Not TestpointBottom
TestpointBottom = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Bottom or Assembly Testpoint - Bottom properties are enabled.
Note
The Fabrication Testpoint - Bottom and Assembly Testpoint - Bottom properties are only defined for pad and via objects.
TestpointFab
Summary
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.
Note
The Fabrication Testpoint - Top and Fabrication Testpoint - Bottom properties are only defined for pad and via objects.
TestpointFabBottom
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.
Note
The Fabrication Testpoint - Bottom property is only defined for pad and via objects.
TestpointFabTop
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.
Note
The Fabrication Testpoint - Top property is only defined for pad and via objects.
TestpointTop
Summary
Pad and via objects can be used as fabrication and/or assembly testpoints, and on the top and/or bottom of the board. This function returns pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties comply with the Query.
Syntax
TestpointTop : Boolean
Example Usage
TestpointTop
TestpointTop = True
Returns all pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties are enabled.
Not TestpointTop
TestpointTop = False
Returns all objects except pad and via objects whose Fabrication Testpoint - Top or Assembly Testpoint - Top properties are enabled.
Note
The Fabrication Testpoint - Top and Assembly Testpoint - Top properties are only defined for pad and via objects.
TextHeight
Summary
Returns all coordinate, original dimension and text string (comment, designator, free) objects whose Text Height property complies with the Query.
Syntax
TextHeight : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1mil = 0.001inch) or Metric (mm; 1mm = 0.001meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:
-
AsMils(TextHeight) : Number– to specify a height in mil. -
AsMM(TextHeight) : Number– to specify a height in mm.
Example Usage
TextHeight = 60
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have a Text Height property that is 60 current measurement units.
TextHeight >= 1.27
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have a Text Height property that 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 a Text Height property that is greater than, or equal to, 40 mil and less than, or equal to, 80 mil.
AsMM(TextHeight) < 1.778
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have a Text Height property that is less than 1.778 mm.
Note
The Text Height property is only defined for coordinate, original dimension and text string (comment, designator, free) objects.
TextKind
Summary
Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property complies with the Query.
Syntax
TextKind = TextKind_String
TextKind <> TextKind_String
TextKind_String must be one of the strings from the following list:
-
'BarCode Text' -
'Stroke Font' -
'TrueType Font'
Example Usage
TextKind = 'Stroke Font'
Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property is Stroke Font.
TextKind <> 'BarCode Text'
Returns all objects except text string (comment, designator, free) objects whose Text Kind property is BarCode Text.
IsDesignator && TextKind = 'TrueType Font'
Returns all drill table, layer stack and text string (comment, designator, free) objects whose Text Kind property is TrueType Font.
Notes
- The Text Kind property is only defined for drill table, layer stack and text string (comment, designator, free) objects.
-
The single quote characters (') at the start and end of
TextKind_Stringare mandatory.
TextOffsetFromInvertedRectangle
Summary
Returns all text string (comment, designator, free) objects whose Inverted Text Offset From Inverted Rect property complies with the Query.
Syntax
TextOffsetFromInvertedRectangle : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an Inverted Text Offset From Inverted Rect property that is equal to 3 current measurement units.
TextOffsetFromInvertedRectangle >= 5.08
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is greater than or equal to 5.08 current measurement units.
AsMils(TextOffsetFromInvertedRectangle) > 4
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is greater than 4 mil.
AsMM(TextOffsetFromInvertedRectangle) Between 0.635 And 0.889
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is greater than or equal to 0.635 mm and less than or equal to 0.889 mm.
TextOffsetFromInvertedRectangle <> 5.5
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is not equal to 5.5 current measurement units.
AsMils(TextOffsetFromInvertedRectangle) <= 2.5
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is less than or equal to 2.5 mil.
AsMM(TextOffsetFromInvertedRectangle) < 0.143
Returns all text string (comment, designator, free) objects that have an Inverted Text Offset From Inverted Rect property that is less than 0.143 mm.
Note
The Inverted Text Offset From Inverted Rect property is only defined for text string (comment, designator, free) objects.
TextWidth
Summary
Returns all coordinate, original dimension and text string (comment, designator, free) objects whose Text Width property complies with the Query.
Syntax
TextWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 a Text Width property that is 6 current measurement units.
TextWidth >= 0.127
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have a Text Width property that 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 a Text Width property that is greater than, or equal to, 4 mil and less than, or equal to, 8 mil.
AsMM(TextWidth) < 0.1778
Returns all coordinate, original dimension and text string (comment, designator, free) objects that have a Text Width property that is less than 0.1778 mm.
Note
The Text Width property is only defined for coordinate, original dimension and text string (comment, designator, free) objects.
TrackWidth
Summary
Returns all rectangle objects whose Track Width property complies with the Query.
Syntax
TrackWidth : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
A specific option for the measurement unit can be specified – overriding the default units specified at the document level – through use of an additional measurement unit-based keyword:
-
AsMils(TrackWidth) : Number– to specify a width in mil. -
AsMM(TrackWidth) : Number– to specify a width in mm.
Example Usage
TrackWidth = 20
Returns all rectangle objects that have a Track Width property that is 20 current measurement units.
TrackWidth >= 1.27
Returns all rectangle objects that have a Track Width property that is greater than, or equal to, 1.27 current measurement units.
AsMils(TrackWidth) Between 10 And 30
Returns all rectangle objects that have a Track Width property that is greater than, or equal to, 10 mil and less than, or equal to, 30 mil.
AsMM(TrackWidth) < 1.016
Returns all rectangle objects that have a Track Width property that is less than 1.016 mm.
Note
The Track Width property is only defined for rectangle objects.
UseInvertedRectangle
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.
Note
The Use Inverted Rectangle property is only defined for text string (comment, designator, free) objects.
UseSeparateSolderMaskExpansion
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.
Note
The Use Separate Solder Mask Expansion property is only defined for pad and via objects.
UseTrueTypeFonts
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.
Note
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.
ViaDiameter
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a via diameter in mil.ViaDiameter) : Number -
AsMM(– to specify a via diameter in mm.ViaDiameter) : Number
Example Usage
ViaDiameter = 40
Returns all via objects that have an X Size (All Layers) property that is 40 current measurement units.
ViaDiameter >= 0.508
Returns all via objects that have an X Size (All Layers) property that is greater than or equal to 0.508 current measurement units.
AsMils(ViaDiameter) Between 30 And 50
Returns all via objects that have an X Size (All Layers) property that is greater than or equal to 30 mil and less than or equal to 50 mil.
AsMM(ViaDiameter) < 1.524
Returns all via objects that have an X Size (All Layers) property that is less than 1.524 mm.
Notes
-
The X Size (All Layers) property is only defined for simple via objects, i.e. those with their Stack Mode property (as seen from a List panel) set to
Simple. When viewing the properties for a via through the Properties panel, this relates to the Simple option being selected in the Size and Shape section. -
When viewing the properties for a selected via in the Properties panel, the X Size (All Layers) property corresponds to the Diameter field, in the Size and Shape section.
-
This function is an alias for the ViaSize function.
ViaSize
Summary
Returns all simple via objects whose X Size (All Layers) property complies with the Query.
Syntax
ViaSize : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an X Size (All Layers) property that is 40 current measurement units.
ViaSize >= 0.508
Returns all via objects that have an X Size (All Layers) property that is greater than or equal to 0.508 current measurement units.
AsMils(ViaSize) Between 30 And 50
Returns all via objects that have an X Size (All Layers) property that is greater than or equal to 30 mil and less than or equal to 50 mil.
AsMM(ViaSize) < 1.524
Returns all via objects that have an X Size (All Layers) property that is less than 1.524 mm.
Notes
-
The X Size (All Layers) property is only defined for simple via objects, i.e. those with their Stack Mode property (as seen from a List panel) set to
Simple. When viewing the properties for a via through the Properties panel, this relates to the Simple option being selected in the Size and Shape section. -
When viewing the properties for a selected via in the Properties panel, the X Size (All Layers) property corresponds to the Diameter field, in the Size and Shape section.
-
This function is an alias for the ViaDiameter function.
ViaSize_BottomLayer
Summary
Returns via objects whose X Size (Bottom Layer) property complies with the Query.
Syntax
ViaSize_BottomLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
ViaSize_BottomLayer <> 50
Returns all via objects whose X Size (Bottom Layer) property is not equal to 50 current measurement units.
Notes
-
For simple vias (with Stack Mode set to
Simple), the X Size (Bottom Layer) property will be the same as the X Size (All Layers) property since the specified size is used for all signal layers. -
When viewing the properties for a selected via in the Properties panel, the X Size (Bottom Layer) property corresponds to the Diameter field for the Bottom Layer (in the Size and Shape section) when the mode is set to Top-Middle-Bottom or Full Stack. When the mode is Simple, this will correspond to the Diameter field.
-
The X Size (Bottom Layer) property is only defined for pad and via objects.
ViaSize_MidLayerN
Summary
Returns via objects whose X Size (Mid Layer <n>) property complies with the Query.
Syntax
ViaSize_MidLayer<n> : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
ViaSize_MidLayer<n> <> 50
Returns all via objects whose X Size (Mid Layer <n>) property is not equal to 50 current measurement units.
Notes
-
For simple vias (with Stack Mode set to
Simple), the X Size (Mid Layer <n>) property is 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 corresponds to the Diameter field.
-
The X Size (Mid Layer <n>) property is only defined for pad and via objects.
ViaSize_TopLayer
Summary
Returns via objects whose X Size (Top Layer) property complies with the Query.
Syntax
ViaSize_TopLayer : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 80 mil.
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.524 mm and less than or equal to 3.81 mm.
ViaSize_TopLayer <> 50
Returns all via objects whose X Size (Top Layer) property is not equal to 50 current measurement units.
Notes
-
For simple vias (with Stack Mode set to
Simple), the X Size (Top Layer) property is 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 corresponds to the Diameter field.
-
The X Size (Top Layer) property is only defined for pad and via objects.
ViolatingPrimitive1
Summary
Returns all violation objects whose Primitive 1 property complies with the Query.
Syntax
ViolatingPrimitive1 : String
Example Usage
ViolatingPrimitive1 = 'Net GND'
Returns all violation objects whose Primitive 1 property is Net GND.
ViolatingPrimitive1 Like 'Pad*'
Returns all violation objects whose Primitive 1 property commences with Pad.
Notes
- The Primitive 1 property is only defined for violation objects.
- The child objects of violation objects returned by the Query are not returned.
ViolatingPrimitive2
Summary
Returns all violation objects whose Primitive 2 property complies with the Query.
Syntax
ViolatingPrimitive2 : String
Example Usage
ViolatingPrimitive2 = 'Net GND'
Returns all violation objects whose Primitive 2 property is Net GND.
ViolatingPrimitive2 Like 'Pad*'
Returns all violation objects whose Primitive 2 property commences with Pad.
Notes
- The Primitive 2 property is only defined for violation objects.
- The child objects of violation objects returned by the Query are not returned.
ViolationDescription
Summary
Returns all violation objects whose Violation Description property complies with the Query.
Syntax
ViolationDescription : String
Example Usage
ViolationDescription = '- Missing required testpoint'
Returns all violation objects whose Violation Description property is - Missing required testpoint.
ViolationDescription Like '*Length*'
Returns all violation objects whose Violation Description property contains Length.
Notes
- The Violation Description property is only defined for violation objects.
- The child objects of violation objects returned by the Query are not returned.
W
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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(– to specify a width in mm.W) : Number
Example Usage
W = 20
Returns all arc and track objects that have a Width property that is 20 current measurement units.
W >= 0.381
Returns all arc and track objects that have a Width property that 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 that is greater than or equal to 10 mil and less than or equal to 30 mil.
AsMM(W) < 0.635
Returns all arc and track objects that have a Width property that is less than 0.635 mm.
Notes
- The Width property is only defined for arc and track objects.
- This function is an alias for the Width function.
Width
Summary
Returns arc and track objects whose Width property complies with the Query.
Syntax
Width : Number
Number will follow the measurement units currently employed for the document – either Imperial (mil; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is 20 current measurement units.
Width >= 0.381
Returns all arc and track objects that have a Width property that 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 that is greater than or equal to 10 mil and less than or equal to 30 mil.
AsMM(Width) < 0.635
Returns all arc and track objects that have a Width property that is less than 0.635 mm.
Notes
- The Width property is only defined for arc and track objects.
- This function is an alias for the W function.
X1
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an X1 property that 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 an X1 property that 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 an X1 property that is greater than or equal to 1000 mil and less than or equal to 1400 mil.
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 an X1 property that is less than 20.32 mm.
Note
The X1 property is only defined for arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects.
X2
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 an X2 property that is equal to 1200 current measurement units.
X2 >= 38.1
Returns all fill, original dimension, and track objects that have an X2 property that 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 an X2 property that is greater than or equal to 1000 mil and less than or equal to 1400 mil.
AsMM(X2) < 20.32
Returns all fill, original dimension, and track objects that have an X2 property that is less than 20.32 mm.
Note
The X2 property is only defined for fill, original dimension and track objects.
Y1
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that 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 that 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 that is greater than or equal to 1000 mil and less than or equal to 1400 mil.
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 that is less than 20.32 mm.
Note
The Y1 property is only defined for arc, component, coordinate, design view, drill table, embedded board array, fill, layer stack table, OLE object, original dimension, pad, text string (comment, designator, free), track, and via objects.
Y2
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; 1 mil = 0.001 inch) or Metric (mm; 1 mm = 0.001 meter).
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 that is equal to 1200 current measurement units.
Y2 >= 38.1
Returns all fill, original dimension, and track objects that have a Y2 property that 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 that is greater than or equal to 1000 mil and less than or equal to 1400 mil.
AsMM(Y2) < 20.32
Returns all fill, original dimension, and track objects that have a Y2 property that is less than 20.32 mm.
Note
The Y2 property is only defined for fill, original dimension and track objects.