Object Type Checks

Updated: October 08, 2026

At a Glance

This article is a reference guide to the Object Type Checks category of query keywords available in PCB and PCB Library documents in Altium Designer. It explains what each keyword returns, shows the correct syntax, and includes simple example usage so you can quickly identify objects such as arcs, vias, pads, dimensions, back drill sites, 3D bodies, and mask-related items when working in the Query Helper or Filter panel. If you need a fast way to understand which object type check to use and what result to expect, this page gives you a clear, practical lookup to help you work more confidently, keep reading and find the exact query you need.

- A quick reference to Object Type Checks query keywords, including what each one returns and how it is written.
- Example expressions that show how to use each function with true, false, or not conditions.
- Help identifying specific PCB object categories such as holes, masks, dimensions, 3D model types, vias, and back drill sites.

Go Deeper with AI:

The Object Type Checks PCB query functions are shown in the Query Helper dialog

This reference page details the query language keywords from the Object Type Checks 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 then press F1 to access its section right away.

All

Summary

Returns all objects on the PCB document.

Syntax

All : Boolean

Example Usage

All
All = True
Returns all objects.

Not All
All = False
Returns no objects.

BackDrillBottom

Summary

Returns bottom side of board back drill sites.

Syntax

BackDrillBottom : Boolean

Example Usage

BackDrillBottom BackDrillBottom = True
Returns all bottom side back drill sites.

Not BackDrillBottom
BackDrillBottom = False
Returns all objects except bottom side back drill sites.

BackDrillTop

Summary

Returns top side of board back drill sites.

Syntax

BackDrillTop : Boolean

Example Usage

BackDrillTop
BackDrillTop = True
Returns all top side back drill sites.

Not BackDrillTop
BackDrillTop = False
Returns all objects except top side back drill sites.

HasCylinderModel

Summary

Returns all 3D body objects whose Model Type property is set to Cylinder.

Syntax

HasCylinderModel : Boolean/Boolean_String

Example Usage

HasCylinderModel HasCylinderModel = True HasCylinderModel = 'True'
Returns all 3D body objects whose Model Type property is set to Cylinder.

Not HasCylinderModel HasCylinderModel = False HasCylinderModel = 'False'
Returns all objects except 3D body objects whose Model Type property is set to Cylinder.

HasExtrudedModel

Summary

Returns all 3D body objects whose Model Type property is set to Extruded.

Syntax

HasExtrudedModel : Boolean/Boolean_String

Example Usage

HasExtrudedModel HasExtrudedModel = True HasExtrudedModel = 'True'
Returns all 3D body objects whose Model Type property is set to Extruded.

Not HasExtrudedModel HasExtrudedModel = False HasExtrudedModel = 'False'
Returns all objects except 3D body objects whose Model Type property is set to Extruded.

HasGenericStepModel

Summary

Returns all 3D body objects whose Model Type property is set to Generic Model.

Syntax

HasGenericStepModel : Boolean/Boolean_String

Example Usage

HasGenericStepModel HasGenericStepModel = True HasGenericStepModel = 'True'
Returns all 3D body objects whose Model Type property is set to Generic Model.

Not HasGenericStepModel HasGenericStepModel = False HasGenericStepModel = 'False'
Returns all objects except 3D body objects whose Model Type property is set to Generic Model.

HasMask

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

Syntax

HasMask : Boolean/Boolean_String

Example Usage

HasMask HasMask = True HasMask = 'True'
Returns all arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

Not HasMask HasMask = False HasMask = 'False'
Returns all objects except arc, fill, pad, region, track, and via objects with a defined solder mask or paste mask.

HasPasteMask

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined paste mask.

Syntax

HasPasteMask : Boolean/Boolean_String

Example Usage

HasPasteMask HasPasteMask = True HasPasteMask = 'True'
Returns all arc, fill, pad, region, track, and via objects with a defined paste mask.

Not HasPasteMask HasPasteMask = False HasPasteMask = 'False'
Returns all objects except arc, fill, pad, region, track, and via objects with a defined paste mask.

HasRectangularHole

Summary

Returns all pad objects with rectangular holes.

Syntax

HasRectangularHole : Boolean/Boolean_String

Example Usage

HasRectangularHole HasRectangularHole = True HasRectangularHole = 'True'
Returns all pad objects with rectangular holes.

Not HasRectangularHole HasRectangularHole = False HasRectangularHole = 'False'
Returns all objects except pad objects with rectangular holes.

HasRoundHole

Summary

Returns all pad objects with round holes.

Syntax

HasRoundHole : Boolean/Boolean_String

Example Usage

HasRoundHole HasRoundHole = True HasRoundHole = 'True'
Returns all pad objects with round holes.

Not HasRoundHole HasRoundHole = False HasRoundHole = 'False'
Returns all objects except pad objects with round holes.

HasSlotHole

Summary

Returns all pad objects with slotted holes.

Syntax

HasSlotHole : Boolean/Boolean_String

Example Usage

HasSlotHole HasSlotHole = True HasSlotHole = 'True'
Returns all pad objects with slotted holes.

Not HasSlotHole HasSlotHole = False HasSlotHole = 'False'
Returns all objects except pad objects with slotted holes.

HasSolderMask

Summary

Returns all arc, fill, pad, region, track, and via objects with a defined solder mask.

Syntax

HasSolderMask : Boolean/Boolean_String

Example Usage

HasSolderMask HasSolderMask = True HasSolderMask = 'True'
Returns all arc, fill, pad, region, track, and via objects with a defined solder mask.

Not HasSolderMask HasSolderMask = False HasSolderMask = 'False'
Returns all objects except arc, fill, pad, region, track, and via objects with a defined solder mask.

HasSphereModel

Summary

Returns all 3D body objects whose Model Type property is set to Sphere.

Syntax

HasSphereModel : Boolean/Boolean_String

Example Usage

HasSphereModel HasSphereModel = True HasSphereModel = 'True'
Returns all 3D body objects whose Model Type property is set to Sphere.

Not HasSphereModel HasSphereModel = False HasSphereModel = 'False'
Returns all objects except 3D body objects whose Model Type property is set to Sphere.

HasSquareHole

Summary

Returns all pad objects with square holes.

Syntax

HasSquareHole : Boolean/Boolean_String

Example Usage

HasSquareHole HasSquareHole = True HasSquareHole = 'True'
Returns all pad objects with square holes.

Not HasSquareHole HasSquareHole = False HasSquareHole = 'False'
Returns all objects except pad objects with square holes.

HasStepModel

Summary

Returns all 3D body objects.

Syntax

HasStepModel : Boolean/Boolean_String

Example Usage

HasStepModel HasStepModel = True HasStepModel = 'True'
Returns all 3D body objects.

Not HasStepModel HasStepModel = False HasStepModel = 'False'
Returns all objects except 3D body objects.

InViaShielding

Summary

Returns all via and polygon (shielding copper) objects that are members of a via shielding group.

Syntax

InViaShielding : Boolean/Boolean_String

Example Usage

InViaShielding InViaShielding = True InViaShielding = 'True'
Returns all via and polygon (shielding copper) objects that are members of a via shielding group.

Not InViaShielding InViaShielding = False InViaShielding = 'False'
Returns all objects except via and polygon (shielding copper) objects that are members of a via shielding group.

IsAngularDimension

Summary

Returns angular dimension objects.

Syntax

IsAngularDimension : Boolean

Example Usage

IsAngularDimension
IsAngularDimension = True
Returns all angular dimension objects.

Not IsAngularDimension
IsAngularDimension = False
Returns all objects except angular dimension objects.

IsArc

Summary

Returns arc objects.

Syntax

IsArc : Boolean

Example Usage

IsArc
IsArc = True
Returns all arc objects.

Not IsArc
IsArc = False
Returns all objects except arc objects.

IsBarCodeText

Summary

Returns text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to either Code 39 or Code 128.

Syntax

IsBarCodeText : Boolean

Example Usage

IsBarCodeText
IsBarCodeText = True
Returns all text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to either Code 39 or Code 128.

Not IsBarCodeText
IsBarCodeText = False
Returns all objects except text string objects whose Text Kind property is set to BarCode Text and BarCode Type property is set to either Code 39 or Code 128.

IsBaselineDimension

Summary

Returns baseline dimension objects.

Syntax

IsBaselineDimension : Boolean

Example Usage

IsBaselineDimension
IsBaselineDimension = True
Returns all baseline dimension objects.

Not IsBaselineDimension
IsBaselineDimension = False
Returns all objects except baseline dimension objects.

IsBlindVia

Summary

Returns blind via objects.

Syntax

IsBlindVia : Boolean

Example Usage

IsBlindVia
IsBlindVia = True
Returns all blind via objects.

Not IsBlindVia
IsBlindVia = False
Returns all objects except blind via objects.

IsBoard

Summary

Returns no objects - simply presents the region occupied by the PCB.

Syntax

IsBoard : Boolean/Boolean_String

Example Usage

IsBoard IsBoard = True IsBoard = 'True'
Returns no objects - simply presents the region occupied by the PCB.

Not IsBoard IsBoard = False IsBoard = 'False'
Returns all objects, while still presenting the region occupied by the PCB.

IsBoardCutoutRegion

Summary

Returns region objects whose Kind property is set to Board cutout.

Syntax

IsBoardCutoutRegion : Boolean

Example Usage

IsBoardCutoutRegion
IsBoardCutoutRegion = True
Returns all region objects whose Kind property is set to Board cutout.

Not IsBoardCutoutRegion
IsBoardCutoutRegion = False
Returns all objects except region objects whose Kind property is set to Board cutout.

IsBoardOutline

Summary

Returns no objects - simply presents the region occupied by the PCB.

Syntax

IsBoardOutline : Boolean/Boolean_String

Example Usage

IsBoardOutline IsBoardOutline = True IsBoardOutline = 'True'
Returns no objects - simply presents the region occupied by the PCB.

Not IsBoardOutline IsBoardOutline = False IsBoardOutline = 'False'
Returns all objects, while still presenting the region occupied by the PCB.

IsBondFinger

Summary

Returns SMD pad objects on a copper layer that have bond wires connected to them.

Syntax

IsBondFinger : Boolean

Example Usage

IsBondFinger
IsBondFinger = True
Returns all SMD pad objects on a copper layer that have bond wires connected to them.

Not IsBondFinger
IsBondFinger = False
Returns all objects except SMD pad objects on a copper layer that have bond wires connected to them.

IsBondWire

Summary

Returns bond wire objects.

Syntax

IsBondWire : Boolean

Example Usage

IsBondWire
IsBondWire = True
Returns all bond wire objects.

Not IsBondWire
IsBondWire = False
Returns all objects except bond wire objects.

IsBondWireConnected

Summary

Returns objects that have bond wires connected to them.

Syntax

IsBondWireConnected : Boolean

Example Usage

IsBondWireConnected
IsBondWireConnected = True
Returns all objects that have bond wires connected to them.

Not IsBondWireConnected
IsBondWireConnected = False
Returns all objects except objects that have bond wires connected to them.

IsBuriedVia

Summary

Returns buried via objects.

Syntax

IsBuriedVia : Boolean

Example Usage

IsBuriedVia
IsBuriedVia = True
Returns all buried via objects.

Not IsBuriedVia
IsBuriedVia = False
Returns all objects except buried via objects.

IsCenterDimension

Summary

Returns center dimension objects.

Syntax

IsCenterDimension : Boolean

Example Usage

IsCenterDimension
IsCenterDimension = True
Returns all center dimension objects.

Not IsCenterDimension
IsCenterDimension = False
Returns all objects except center dimension objects.

IsClass

Summary

Returns class objects.

Syntax

IsClass : Boolean

Example Usage

IsClass
IsClass = True
Returns all class objects.

Not IsClass
IsClass = False
Returns all objects except class objects.

IsComment

Summary

Returns text objects whose String Type property is Comment. These are children of component objects.

Syntax

IsComment : Boolean

Example Usage

IsComment
IsComment = True
Returns all text objects whose String Type property is Comment.

Not IsComment
IsComment = False
Returns all objects except text objects whose String Type property is Comment.

IsComponent

Summary

Returns component objects.

Syntax

IsComponent : Boolean

Example Usage

IsComponent
IsComponent = True
Returns all component objects.

Not IsComponent
IsComponent = False
Returns all objects except component objects.

IsComponentArc

Summary

Returns arc objects which are children of component objects.

Syntax

IsComponentArc : Boolean

Example Usage

IsComponentArc
IsComponentArc = True
Returns all arc objects that are children of component objects.

Not IsComponentArc
IsComponentArc = False
Returns all objects except arc objects that are children of component objects.

IsComponentBody

Summary

Returns 3D body objects.

Syntax

IsComponentBody : Boolean

Example Usage

IsComponentBody
IsComponentBody = True
Returns all 3D body objects.

Not IsComponentBody
IsComponentBody = False
Returns all objects except 3D body objects.

IsComponentFill

Summary

Returns fill objects that are children of component objects.

Syntax

IsComponentFill : Boolean

Example Usage

IsComponentFill
IsComponentFill = True
Returns all fill objects that are children of component objects.

Not IsComponentFill
IsComponentFill = False
Returns all objects except fill objects that are children of component objects.

IsComponentPad

Summary

Returns pad objects that are children of component objects.

Syntax

IsComponentPad : Boolean

Example Usage

IsComponentPad
IsComponentPad = True
Returns all pad objects that are children of component objects.

Not IsComponentPad
IsComponentPad = False
Returns all objects except pad objects that are children of component objects.

IsComponentText

Summary

Returns text objects that are children of component objects.

Syntax

IsComponentText : Boolean

Example Usage

IsComponentText
IsComponentText = True
Returns all text objects that are children of component objects.

Not IsComponentText
IsComponentText = False
Returns all objects except text objects that are children of component objects.

IsComponentTrack

Summary

Returns track objects that are children of component objects.

Syntax

IsComponentTrack : Boolean

Example Usage

IsComponentTrack
IsComponentTrack = True
Returns all track objects that are children of component objects.

Not IsComponentTrack
IsComponentTrack = False
Returns all objects except track objects that are children of component objects.

IsComponentVia

Summary

Returns via objects that are children of component objects.

Syntax

IsComponentVia : Boolean

Example Usage

IsComponentVia
IsComponentVia = True
Returns all via objects that are children of component objects.

Not IsComponentVia
IsComponentVia = False
Returns all objects except via objects that are children of component objects.

IsConnection

Summary

Returns all connection lines.

Note that the returned connections are displayed in the design space, but no objects of this type are presented in the PCB List panel.

Syntax

IsConnection : Boolean/Boolean_String

Example Usage

IsConnection IsConnection = True IsConnection = 'True'
Returns all connection lines.

Not IsConnection IsConnection = False IsConnection = 'False'
Returns all objects AND connection lines. The "connection" details are also displayed because they are (unlisted) child objects of net objects that are returned by this query.

Not IsConnection And Not IsNet
(IsConnection = False) And (IsNet = False)
Returns all objects except for net objects; the "connection" details are not displayed because they are (unlisted) child objects of net objects, and no net objects are returned by this query.

IsCoordinate

Summary

Returns coordinate objects.

Syntax

IsCoordinate : Boolean

Example Usage

IsCoordinate
IsCoordinate = True
Returns all coordinate objects.

Not IsCoordinate
IsCoordinate = False
Returns all objects except coordinate objects.

IsCopperRegion

Summary

Returns solid region objects, i.e. regions that do not have their Kind property set to Polygon cutout or Board cutout (which would make them Polygon Cutout or Board Cutout regions respectively).

Polygon pours that have their Fill Mode set to Solid (Copper Regions) will also be returned.

Syntax

IsCopperRegion : Boolean

Example Usage

IsCopperRegion
IsCopperRegion = True
Returns all solid region objects.

Not IsCopperRegion
IsCopperRegion = False
Returns all objects except solid region objects.

IsCutoutRegion

Summary

Returns polygon cutout region objects, i.e. regions that have their Cutout property enabled.

When viewing the properties of a region object through the Properties panel, such an object has its Kind property set to Polygon Cutout.

Syntax

IsCutoutRegion : Boolean

Example Usage

IsCutoutRegion
IsCutoutRegion = True
Returns all polygon cutout region objects.

Not IsCutoutRegion
IsCutoutRegion = False
Returns all objects except polygon cutout region objects.

IsDatumDimension

Summary

Returns datum dimension objects.

Syntax

IsDatumDimension : Boolean

Example Usage

IsDatumDimension
IsDatumDimension = True
Returns all datum dimension objects.

Not IsDatumDimension
IsDatumDimension = False
Returns all objects except datum dimension objects.

IsDesignator

Summary

Returns text objects whose String Type property is Designator – these are children of component objects.

Syntax

IsDesignator : Boolean

Example Usage

IsDesignator
IsDesignator = True
Returns all text objects whose String Type property is Designator.

Not IsDesignator
IsDesignator = False
Returns all objects except text objects whose String Type property is Designator.

IsDifferentialPair

Summary

Returns all differential pair objects.

Syntax

IsDifferentialPair : Boolean/Boolean_String

Example Usage

IsDifferentialPair IsDifferentialPair = True IsDifferentialPair = 'True'
Returns all differential pair objects.

Not IsDifferentialPair IsDifferentialPair = False IsDifferentialPair = 'False'
Returns all objects except differential pair objects.

IsDimension

Summary

Returns all dimension objects (regardless of type).

Syntax

IsDimension : Boolean

Example Usage

IsDimension
IsDimension = True
Returns all dimension objects.

Not IsDimension
IsDimension = False
Returns all objects except dimension objects.

IsEmbeddedBoard

Summary

Returns all embedded board array objects.

Syntax

IsEmbeddedBoard : Boolean/Boolean_String

Example Usage

IsEmbeddedBoard IsEmbeddedBoard = True IsEmbeddedBoard = 'True'
Returns all embedded board array objects.

Not IsEmbeddedBoard IsEmbeddedBoard = False IsEmbeddedBoard = 'False'
Returns all objects except embedded board array objects.

IsFill

Summary

Returns fill objects.

Syntax

IsFill : Boolean

Example Usage

IsFill
IsFill = True
Returns all fill objects.

Not IsFill
IsFill = False
Returns all objects except fill objects.

IsFromTo

Summary

Returns all from-to objects.

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

Syntax

IsFromTo : Boolean/Boolean_String

Example Usage

IsFromTo IsFromTo = True IsFromTo = 'True'
Returns all from-to objects.

Not IsFromTo IsFromTo = False IsFromTo = 'False'
Returns all objects except from-to objects.

IsLeaderDimension

Summary

Returns leader dimension objects.

Syntax

IsLeaderDimension : Boolean

Example Usage

IsLeaderDimension
IsLeaderDimension = True
Returns all leader dimension objects.

Not IsLeaderDimension
IsLeaderDimension = False
Returns all objects except leader dimension objects.

IsLinearDiameterDimension

Summary

Returns linear diameter dimension objects.

Syntax

IsLinearDiameterDimension : Boolean

Example Usage

IsLinearDiameterDimension
IsLinearDiameterDimension = True
Returns all linear diameter dimension objects.

Not IsLinearDiameterDimension
IsLinearDiameterDimension = False
Returns all objects except linear diameter dimension objects.

IsLinearDimension

Summary

Returns linear dimension objects.

Syntax

IsLinearDimension : Boolean

Example Usage

IsLinearDimension
IsLinearDimension = True
Returns all linear dimension objects.

Not IsLinearDimension
IsLinearDimension = False
Returns all objects except linear dimension objects.

IsMicroVia

Summary

Returns µvia objects.

Syntax

IsMicroVia : Boolean

Example Usage

IsMicroVia
IsMicroVia = True
Returns all µvia objects.

Not IsMicroVia
IsMicroVia = False
Returns all objects except µvia objects.

IsNet

Summary

Returns net objects. Any object that includes the Net property can belong to a net, for example, track, arc, fill, region, polygon, pad and via.

Syntax

IsNet : Boolean

Example Usage

IsNet
IsNet = True
Returns all net objects.

Not IsNet
IsNet = False
Returns all objects except net objects.

IsObjectKind

Summary

Returns all objects whose Object Kind property matches the specified type of object.

Syntax

IsObjectKind(ObjectType : String) : Boolean/Boolean_String

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

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

Example Usage

IsObjectKind('Via') IsObjectKind('Via') = True IsObjectKind('Via') = 'True'
Returns all via objects.

Not IsObjectKind('Track') IsObjectKind('Track') = False IsObjectKind('Track') = 'False'
Returns all objects except track objects.

Notes

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

IsOriginalDimension

Summary

Returns all original dimension objects.

Syntax

IsOriginalDimension : Boolean/Boolean_String

Example Usage

IsOriginalDimension IsOriginalDimension = True IsOriginalDimension = 'True'
Returns all original dimension objects.

Not IsOriginalDimension IsOriginalDimension = False IsOriginalDimension = 'False'
Returns all objects except original dimension objects.

IsPad

Summary

Returns pad objects.

Syntax

IsPad : Boolean

Example Usage

IsPad
IsPad = True
Returns all pad objects.

Not IsPad
IsPad = False
Returns all objects except pad objects.

IsPadHoleValid

Summary

Returns all pad objects that have a valid hole. To be a valid hole, the pad's Hole Size property must be a non-zero value. Additionally, if the hole is slotted, it must have a non-zero length.

Syntax

IsPadHoleValid : Boolean/Boolean_String

Example Usage

IsPadHoleValid IsPadHoleValid = True IsPadHoleValid = 'True'
Returns all pad objects that have a valid hole.

Not IsPadHoleValid IsPadHoleValid = False IsPadHoleValid = 'False'
Returns all objects except pad objects that have a valid hole.

IsPoly

Summary

Returns polygon pour objects.

Syntax

IsPoly : Boolean

Example Usage

IsPoly
IsPoly = True
Returns all polygon pour objects.

Not IsPoly
IsPoly = False
Returns all objects except polygon pour objects.

Notes

This function is an alias for the IsPolygon function.
When defining an Electrical Clearance rule for polygon pours, you must use the InPolygon (or InPoly) attribute check rather than the IsPolygon (or IsPoly) object type check. This is because the clearance rules operate on the primitives (regions, tracks and arcs) that make up, or are in the polygon pour, rather than the polygon pour as a whole object. A valid clearance rule for polygon pours would be between InPolygon objects and All other objects.

IsPolygon

Summary

Returns polygon pour objects.

Syntax

IsPolygon : Boolean

Example Usage

IsPolygon
IsPolygon = True
Returns all polygon pour objects.

Not IsPolygon
IsPolygon = False
Returns all objects except polygon pour objects.

Notes

This function is an alias for the IsPoly function.
When defining an Electrical Clearance rule for polygon pours, you must use the InPolygon (or InPoly) attribute check rather than the IsPolygon (or IsPoly) object type check. This is because the clearance rules operate on the primitives (regions, tracks and arcs) that make up, or are in the polygon pour, rather than the polygon pour as a whole object. A valid clearance rule for polygon pours would be between InPolygon objects and All other objects.

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.

IsRadialDiameterDimension

Summary

Returns radial diameter dimension objects.

Syntax

IsRadialDiameterDimension : Boolean

Example Usage

IsRadialDiameter Dimension
IsRadialDiameterDimension = True
Returns all radial diameter dimension objects.

Not IsRadialDiameterDimension
IsRadialDiameterDimension = False
Returns all objects except radial diameter dimension objects.

IsRadialDimension

Summary

Returns radial dimension objects.

Syntax

IsRadialDimension : Boolean

Example Usage

IsRadial Dimension
IsRadialDimension = True
Returns all radial dimension objects.

Not IsRadialDimension
IsRadialDimension = False
Returns all objects except radial dimension objects.

IsRegion

Summary

Returns all region objects, i.e. solid regions, polygon cutout regions and board cutout regions.

Polygon pours that have their Fill Mode set to Solid (Copper Regions) will also be returned.

Syntax

IsRegion : Boolean

Example Usage

IsRegion
IsRegion = True
Returns all region objects.

Not IsRegion
IsRegion = False
Returns all objects except region objects.

IsRoom

Summary

Returns Room Definition rule (Confinement Constraint Rule) objects.

Syntax

IsRoom : Boolean/Boolean_String

Example Usage

IsRoom
IsRoom= True
IsRoom= 'True'
Returns all Room Definition rule objects.

Not IsRoom
IsRoom= False IsRoom= 'False'
Returns all objects except Room Definition rule objects.

Notes

This function is an alias for the IsRule_ConfinementConstraint function.

IsRule

Summary

Returns all design rule objects (regardless of type).

Syntax

IsRule : Boolean

Example Usage

IsRule
IsRule = True
Returns all design rule objects.

Not IsRule
IsRule = False
Returns all objects except design rule objects.

IsRule_AcuteAngle

Summary

Returns Acute Angle rule objects.

Syntax

IsRule_AcuteAngle : Boolean

Example Usage

IsRule_AcuteAngle
IsRule_AcuteAngle = True
Returns all Acute Angle rule objects.

Not IsRule_AcuteAngle
IsRule_AcuteAngle = False
Returns all objects except Acute Angle rule objects.

IsRule_BoardOutlineClearance

Summary

Returns Board Outline Clearance rule objects.

Syntax

IsRule_BoardOutlineClearance : Boolean

Example Usage

IsRule_BoardOutlineClearance
IsRule_BoardOutlineClearance = True
Returns all Board Outline Clearance rule objects.

Not IsRule_BoardOutlineClearance
IsRule_BoardOutlineClearance = False
Returns all objects except Board Outline Clearance rule objects.

IsRule_BrokenNets

Summary

Returns Un-Routed Net rule objects.

Syntax

IsRule_BrokenNets : Boolean

Example Usage

IsRule_BrokenNets
IsRule_BrokenNets = True
Returns all Un-Routed Net rule objects.

Not IsRule_BrokenNets
IsRule_BrokenNets = False
Returns all objects except Un-Routed Net rule objects.

IsRule_Clearance

Summary

Returns Clearance rule objects.

Syntax

IsRule_Clearance : Boolean

Example Usage

IsRule_Clearance
IsRule_Clearance = True
Returns all Clearance rule objects.

Not IsRule_Clearance
IsRule_Clearance = False
Returns all objects except Clearance rule objects.

IsRule_ComponentClearance

Summary

Returns Component Clearance rule objects.

Syntax

IsRule_ComponentClearance : Boolean

Example Usage

IsRule_ComponentClearance
IsRule_ComponentClearance = True
Returns all Component Clearance rule objects.

Not IsRule_ComponentClearance
IsRule_ComponentClearance = False
Returns all objects except Component Clearance rule objects.

IsRule_ComponentRotations

Summary

Returns Component Orientations rule objects.

Syntax

IsRule_ComponentRotations : Boolean

Example Usage

IsRule_ComponentRotations
IsRule_ComponentRotations = True
Returns all Component Orientations rule objects.

Not IsRule_ComponentRotations
IsRule_ComponentRotations = False
Returns all objects except Component Orientations rule objects.

IsRule_ConfinementConstraint

Summary

Returns Room Definition rule (Confinement Constraint Rule) objects.

Syntax

IsRule_ConfinementConstraint : Boolean/Boolean_String

Example Usage

IsRule_ConfinementConstraint
IsRule_ConfinementConstraint= True
IsRule_ConfinementConstraint= 'True'
Returns all Room Definition rule objects.

Not IsRule_ConfinementConstraint
IsRule_ConfinementConstraint= False Is Rule_ConfinementConstraint= 'False'
Returns all objects except Room Definition rule objects.

Notes

This function is an alias for the IsRoom function.

IsRule_Creepage

Summary

Returns Creepage rule objects.

Syntax

IsRule_Creepage : Boolean

Example Usage

IsRule_Creepage
IsRule_Creepage = True
Returns all Creepage rule objects.

Not IsRule_Creepage
IsRule_Creepage = False
Returns all objects except Creepage rule objects.

IsRule_DaisyChainStubLength

Summary

Returns Daisy Chain Stub Length rule objects.

Syntax

IsRule_DaisyChainStubLength : Boolean

Example Usage

IsRule_DaisyChainStubLength
IsRule_DaisyChainStubLength = True
Returns all Daisy Chain Stub Length rule objects.

Not IsRule_DaisyChainStubLength
IsRule_DaisyChainStubLength = False
Returns all objects except Daisy Chain Stub Length rule objects.

IsRule_DifferentialPairsRouting

Summary

Returns Differential Pairs Routing rule objects.

Syntax

IsRule_DifferentialPairsRouting : Boolean

Example Usage

IsRule_DifferentialPairsRouting
IsRule_DifferentialPairsRouting = True
Returns all Differential Pairs Routing rule objects.

Not IsRule_DifferentialPairsRouting
IsRule_DifferentialPairsRouting = False
Returns all objects except Differential Pairs Routing rule objects.

IsRule_FanoutControl

Summary

Returns Fanout Control rule objects.

Syntax

IsRule_FanoutControl : Boolean

Example Usage

IsRule_FanoutControl
IsRule_FanoutControl = True
Returns all Fanout Control rule objects.

Not IsRule_FanoutControl
IsRule_FanoutControl = False
Returns all objects except Fanout Control rule objects.

IsRule_FlightTime_FallingEdge

Summary

Returns Flight Time - Falling Edge rule objects.

Syntax

IsRule_FlightTime_FallingEdge : Boolean

Example Usage

IsRule_FlightTime_FallingEdge
IsRule_FlightTime_FallingEdge = True
Returns all Flight Time - Falling Edge rule objects.

Not IsRule_FlightTime_FallingEdge
IsRule_FlightTime_FallingEdge = False
Returns all objects except Flight Time - Falling Edge rule objects.

IsRule_FlightTime_RisingEdge

Summary

Returns Flight Time - Rising Edge rule objects.

Syntax

IsRule_FlightTime_RisingEdge : Boolean

Example Usage

IsRule_FlightTime_RisingEdge
IsRule_FlightTime_RisingEdge = True
Returns all Flight Time - Rising Edge rule objects.

Not IsRule_FlightTime_RisingEdge
IsRule_FlightTime_RisingEdge = False
Returns all objects except Flight Time - Rising Edge rule objects.

IsRule_HoleToHoleClearance

Summary

Returns Hole To Hole Clearance rule objects.

Syntax

IsRule_HoleToHoleClearance : Boolean

Example Usage

IsRule_HoleToHoleClearance
IsRule_HoleToHoleClearance = True
Returns all Hole To Hole Clearance rule objects.

Not IsRule_HoleToHoleClearance
IsRule_HoleToHoleClearance = False
Returns all objects except Hole To Hole Clearance rule objects.

IsRule_LayerPair

Summary

Returns Layer Pairs rule objects.

Syntax

IsRule_LayerPair : Boolean

Example Usage

IsRule_LayerPair
IsRule_LayerPair = True
Returns all Layer Pairs rule objects.

Not IsRule_LayerPair
IsRule_LayerPair = False
Returns all objects except Layer Pairs rule objects.

IsRule_MatchedLengths

Summary

Returns Matched Lengths rule objects.

Syntax

IsRule_MatchedLengths : Boolean

Example Usage

IsRule_MatchedLengths
IsRule_MatchedLengths = True
Returns all Matched Lengths rule objects.

Not IsRule_MatchedLengths
IsRule_MatchedLengths = False
Returns all objects except Matched Lengths rule objects.

IsRule_MaximumViaCount

Summary

Returns Maximum Via Count rule objects.

Syntax

IsRule_MaximumViaCount : Boolean

Example Usage

IsRule_MaximumViaCount
IsRule_MaximumViaCount = True
Returns all Maximum Via Count rule objects.

Not IsRule_MaximumViaCount
IsRule_MaximumViaCount = False
Returns all objects except Maximum Via Count rule objects.

IsRule_MaxMinHeightConstraint

Summary

Returns Height rule objects.

Syntax

IsRule_MaxMinHeightConstraint : Boolean

Example Usage

IsRule_MaxMinHeightConstraint
IsRule_MaxMinHeightConstraint = True
Returns all Height rule objects.

Not IsRule_MaxMinHeightConstraint
IsRule_MaxMinHeightConstraint = False
Returns all objects except Height rule objects.

IsRule_MaxMinHoleSize

Summary

Returns Hole Size rule objects.

Syntax

IsRule_MaxMinHoleSize : Boolean

Example Usage

IsRule_MaxMinHoleSize
IsRule_MaxMinHoleSize = True
Returns all Hole Size rule objects.

Not IsRule_MaxMinHoleSize
IsRule_MaxMinHoleSize = False
Returns all objects except Hole Size rule objects.

IsRule_MaxMinImpedance

Summary

Returns Impedance rule objects.

Syntax

IsRule_MaxMinImpedance : Boolean

Example Usage

IsRule_MaxMinImpedance
IsRule_MaxMinImpedance = True
Returns all Impedance rule objects.

Not IsRule_MaxMinImpedance
IsRule_MaxMinImpedance = False
Returns all objects except Impedance rule objects.

IsRule_MaxMinLength

Summary

Returns Length rule objects.

Syntax

IsRule_MaxMinLength : Boolean

Example Usage

IsRule_MaxMinLength
IsRule_MaxMinLength = True
Returns all Length rule objects.

Not IsRule_MaxMinLength
IsRule_MaxMinLength = False
Returns all objects except Length rule objects.

IsRule_MaxMinWidth

Summary

Returns Width rule objects.

Syntax

IsRule_MaxMinWidth : Boolean

Example Usage

IsRule_MaxMinWidth
IsRule_MaxMinWidth = True
Returns all Width rule objects.

Not IsRule_MaxMinWidth
IsRule_MaxMinWidth = False
Returns all objects except Width rule objects.

IsRule_MaxSlope_FallingEdge

Summary

Returns Slope - Falling Edge rule objects.

Syntax

IsRule_MaxSlope_FallingEdge : Boolean

Example Usage

IsRule_MaxSlope_FallingEdge
IsRule_MaxSlope_FallingEdge = True
Returns all Slope - Falling Edge rule objects.

Not IsRule_MaxSlope_FallingEdge
IsRule_MaxSlope_FallingEdge = False
Returns all objects except Slope - Falling Edge rule objects.

IsRule_MaxSlope_RisingEdge

Summary

Returns Slope - Rising Edge rule objects.

Syntax

IsRule_MaxSlope_RisingEdge : Boolean

Example Usage

IsRule_MaxSlope_RisingEdge
IsRule_MaxSlope_RisingEdge = True
Returns all Slope - Rising Edge rule objects.

Not IsRule_MaxSlope_RisingEdge
IsRule_MaxSlope_RisingEdge = False
Returns all objects except Slope - Rising Edge rule objects.

IsRule_MinimumAnnularRing

Summary

Returns Minimum Annular Ring rule objects.

Syntax

IsRule_MinimumAnnularRing : Boolean

Example Usage

IsRule_MinimumAnnularRing
IsRule_MinimumAnnularRing = True
Returns all Minimum Annular Ring rule objects.

Not IsRule_MinimumAnnularRing
IsRule_MinimumAnnularRing = False
Returns all objects except Minimum Annular Ring rule objects.

IsRule_MinimumSolderMaskSliver

Summary

Returns Minimum Solder Mask Sliver rule objects.

Syntax

IsRule_MinimumSolderMaskSliver : Boolean

Example Usage

IsRule_MinimumSolderMaskSliver
IsRule_MinimumSolderMaskSliver = True
Returns all Minimum Solder Mask Sliver rule objects.

Not IsRule_MinimumSolderMaskSliver
IsRule_MinimumSolderMaskSliver = False
Returns all objects except Minimum Solder Mask Sliver rule objects.

IsRule_NetAntennae

Summary

Returns Net Antennae rule objects.

Syntax

IsRule_NetAntennae : Boolean

Example Usage

IsRule_NetAntennae
IsRule_NetAntennae = True
Returns all Net Antennae rule objects.

Not IsRule_NetAntennae
IsRule_NetAntennae = False
Returns all objects except Net Antennae rule objects.

IsRule_NetsToIgnore

Summary

Returns Nets To Ignore rule objects.

Syntax

IsRule_NetsToIgnore : Boolean

Example Usage

IsRule_NetsToIgnore
IsRule_NetsToIgnore = True
Returns all Nets to Ignore rule objects.

Not IsRule_NetsToIgnore
IsRule_NetsToIgnore = False
Returns all objects except Nets to Ignore rule objects.

IsRule_Overshoot_FallingEdge

Summary

Returns Overshoot - Falling Edge rule objects.

Syntax

IsRule_Overshoot_FallingEdge : Boolean

Example Usage

IsRule_Overshoot_FallingEdge
IsRule_Overshoot_FallingEdge = True
Returns all Overshoot - Falling Edge rule objects.

Not IsRule_Overshoot_FallingEdge
IsRule_Overshoot_FallingEdge = False
Returns all objects except Overshoot - Falling Edge rule objects.

IsRule_Overshoot_RisingEdge

Summary

Returns Overshoot - Rising Edge rule objects.

Syntax

IsRule_Overshoot_RisingEdge : Boolean

Example Usage

IsRule_Overshoot_RisingEdge
IsRule_Overshoot_RisingEdge = True
Returns all Overshoot - Rising Edge rule objects.

Not IsRule_Overshoot_RisingEdge
IsRule_Overshoot_RisingEdge = False
Returns all objects except Overshoot - Rising Edge rule objects.

IsRule_ParallelSegment

Summary

Returns Parallel Segment rule objects.

Syntax

IsRule_ParallelSegment : Boolean

Example Usage

IsRule_ParallelSegment
IsRule_ParallelSegment = True
Returns all Parallel Segment rule objects.

Not IsRule_ParallelSegment
IsRule_ParallelSegment = False
Returns all objects except Parallel Segment rule objects.

IsRule_PasteMaskExpansion

Summary

Returns Paste Mask Expansion rule objects.

Syntax

IsRule_PasteMaskExpansion : Boolean

Example Usage

IsRule_PasteMaskExpansion
IsRule_PasteMaskExpansion = True
Returns all Paste Mask Expansion rule objects.

Not IsRule_PasteMaskExpansion
IsRule_PasteMaskExpansion = False
Returns all objects except Paste Mask Expansion rule objects.

IsRule_PermittedLayers

Summary

Returns Permitted Layers rule objects.

Syntax

IsRule_PermittedLayers : Boolean

Example Usage

IsRule_PermittedLayers
IsRule_PermittedLayers = True
Returns all Permitted Layers rule objects.

Not IsRule_PermittedLayers
IsRule_PermittedLayers = False
Returns all objects except Permitted Layers rule objects.

IsRule_PolygonConnectStyle

Summary

Returns Polygon Connect Style rule objects.

Syntax

IsRule_PolygonConnectStyle : Boolean

Example Usage

IsRule_PolygonConnectStyle
IsRule_PolygonConnectStyle = True
Returns all Polygon Connect Style rule objects.

Not IsRule_PolygonConnectStyle
IsRule_PolygonConnectStyle = False
Returns all objects except Polygon Connect Style rule objects.

IsRule_PowerPlaneClearance

Summary

Returns Power Plane Clearance rule objects.

Syntax

IsRule_PowerPlaneClearance : Boolean

Example Usage

IsRule_PowerPlaneClearance
IsRule_PowerPlaneClearance = True
Returns all Power Plane Clearance rule objects.

Not IsRule_PowerPlaneClearance
IsRule_PowerPlaneClearance = False
Returns all objects except Power Plane Clearance rule objects.

IsRule_PowerPlaneConnectStyle

Summary

Returns Power Plane Connect Style rule objects.

Syntax

IsRule_PowerPlaneConnectStyle : Boolean

Example Usage

IsRule_PowerPlaneConnectStyle
IsRule_PowerPlaneConnectStyle = True
Returns all Power Plane Connect Style rule objects.

Not IsRule_PowerPlaneConnectStyle
IsRule_PowerPlaneConnectStyle = False
Returns all objects except Power Plane Connect Style rule objects.

IsRule_ReturnPath

Summary

Returns Return Path rule objects.

Syntax

IsRule_ReturnPath : Boolean

Example Usage

IsRule_ReturnPath
IsRule_ReturnPath = True
Returns all Return Path rule objects.

Not ReturnPath
IsRule_ReturnPath = False
Returns all objects except Return Path rule objects.

IsRule_RoutingCornerStyle

Summary

Returns Routing Corners rule objects.

Syntax

IsRule_RoutingCornerStyle : Boolean

Example Usage

IsRule_RoutingCornerStyle
IsRule_RoutingCornerStyle = True
Returns all Routing Corners rule objects.

Not IsRule_RoutingCornerStyle
IsRule_RoutingCornerStyle = False
Returns all objects except Routing Corners rule objects.

IsRule_RoutingLayers

Summary

Returns Routing Layers rule objects.

Syntax

IsRule_RoutingLayers : Boolean

Example Usage

IsRule_RoutingLayers
IsRule_RoutingLayers = True
Returns all Routing Layers rule objects.

Not IsRule_RoutingLayers
IsRule_RoutingLayers = False
Returns all objects except Routing Layers rule objects.

IsRule_RoutingPriority

Summary

Returns Routing Priority rule objects.

Syntax

IsRule_RoutingPriority : Boolean

Example Usage

IsRule_RoutingPriority
IsRule_RoutingPriority = True
Returns all Routing Priority rule objects.

Not IsRule_RoutingPriority
IsRule_RoutingPriority = False
Returns all objects except Routing Priority rule objects.

IsRule_RoutingTopology

Summary

Returns Routing Topology rule objects.

Syntax

IsRule_RoutingTopology : Boolean

Example Usage

IsRule_RoutingTopology
IsRule_RoutingTopology = True
Returns all Routing Topology rule objects.

Not IsRule_RoutingTopology
IsRule_RoutingTopology = False
Returns all objects except Routing Topology rule objects.

IsRule_RoutingViaStyle

Summary

Returns Routing Via Style rule objects.

Syntax

IsRule_RoutingViaStyle : Boolean

Example Usage

IsRule_RoutingViaStyle
IsRule_RoutingViaStyle = True
Returns all Routing Via Style rule objects.

Not IsRule_RoutingViaStyle
IsRule_RoutingViaStyle = False
Returns all objects except Routing Via Style rule objects.

IsRule_ShortCircuit

Summary

Returns Short-Circuit rule objects.

Syntax

IsRule_ShortCircuit : Boolean

Example Usage

IsRule_ShortCircuit
IsRule_ShortCircuit = True
Returns all Short-Circuit rule objects.

Not IsRule_ShortCircuit
IsRule_ShortCircuit = False
Returns all objects except Short-Circuit rule objects.

IsRule_SignalBaseValue

Summary

Returns Signal Base Value rule objects.

Syntax

IsRule_SignalBaseValue : Boolean

Example Usage

IsRule_SignalBaseValue
IsRule_SignalBaseValue = True
Returns all Signal Base Value rule objects.

Not IsRule_SignalBaseValue
IsRule_SignalBaseValue = False
Returns all objects except Signal Base Value rule objects.

IsRule_SignalStimulus

Summary

Returns Signal Stimulus rule objects.

Syntax

IsRule_SignalStimulus : Boolean

Example Usage

IsRule_SignalStimulus
IsRule_SignalStimulus = True
Returns all Signal Stimulus rule objects.

Not IsRule_SignalStimulus
IsRule_SignalStimulus = False
Returns all objects except Signal Stimulus rule objects.

IsRule_SignalTopValue

Summary

Returns Signal Top Value rule objects.

Syntax

IsRule_SignalTopValue : Boolean

Example Usage

IsRule_SignalTopValue
IsRule_SignalTopValue = True
Returns all Signal Top Value rule objects.

Not IsRule_SignalTopValue
IsRule_SignalTopValue = False
Returns all objects except Signal Top Value rule objects.

IsRule_SilkToSilkClearance

Summary

Returns Silk To Silk Clearance rule objects.

Syntax

IsRule_SilkToSilkClearance : Boolean

Example Usage

IsRule_SilkToSilkClearance
IsRule_SilkToSilkClearance = True
Returns all Silk To Silk Clearance rule objects.

Not IsRule_SilkToSilkClearance
IsRule_SilkToSilkClearance = False
Returns all objects except Silk To Silk Clearance rule objects.

IsRule_SilkToSolderMaskClearance

Summary

Returns Silk To Solder Mask Clearance rule objects.

Syntax

IsRule_SilkToSolderMaskClearance : Boolean

Example Usage

IsRule_SilkToSolderMaskClearance
IsRule_SilkToSolderMaskClearance = True
Returns all Silk To Solder Mask Clearance rule objects.

Not IsRule_SilkToSolderMaskClearance
IsRule_SilkToSolderMaskClearance = False
Returns all objects except Silk To Solder Mask Clearance rule objects.

IsRule_SMDNeckDown

Summary

Returns SMD Neck-Down rule objects.

Syntax

IsRule_SMDNeckDown : Boolean

Example Usage

IsRule_SMDNeckDown
IsRule_SMDNeckDown = True
Returns all SMD Neck-Down rule objects.

Not IsRule_SMDNeckDown
IsRule_SMDNeckDown = False
Returns all objects except SMD Neck-Down rule objects.

IsRule_SMDToCorner

Summary

Returns SMD To Corner rule objects.

Syntax

IsRule_SMDToCorner : Boolean

Example Usage

IsRule_SMDToCorner
IsRule_SMDToCorner = True
Returns all SMD To Corner rule objects.

Not IsRule_SMDToCorner
IsRule_SMDToCorner = False
Returns all objects except SMD To Corner rule objects.

IsRule_SMDToPlane

Summary

Returns SMD To Plane rule objects.

Syntax

IsRule_SMDToPlane : Boolean

Example Usage

IsRule_SMDToPlane
IsRule_SMDToPlane = True
Returns all SMD To Plane rule objects.

Not IsRule_SMDToPlane
IsRule_SMDToPlane = False
Returns all objects except SMD To Plane rule objects.

IsRule_SolderMaskExpansion

Summary

Returns Solder Mask Expansion rule objects.

Syntax

IsRule_SolderMaskExpansion : Boolean

Example Usage

IsRule_SolderMaskExpansion
IsRule_SolderMaskExpansion = True
Returns all Solder Mask Expansion rule objects.

Not IsRule_SolderMaskExpansion
IsRule_SolderMaskExpansion = False
Returns all objects except Solder Mask Expansion rule objects.

IsRule_SupplyNets

Summary

Returns Supply Nets rule objects.

Syntax

IsRule_SupplyNets : Boolean

Example Usage

IsRule_SupplyNets
IsRule_SupplyNets = True
Returns all Supply Nets rule objects.

Not IsRule_SupplyNets
IsRule_SupplyNets = False
Returns all objects except Supply Nets rule objects.

IsRule_TestPointStyle

Summary

Returns Fabrication Testpoint Style rule objects.

Syntax

IsRule_TestPointStyle : Boolean

Example Usage

IsRule_TestPointStyle
IsRule_TestPointStyle = True
Returns all Fabrication Testpoint Style rule objects.

Not IsRule_TestPointStyle
IsRule_TestPointStyle = False
Returns all objects except Fabrication Testpoint Style rule objects.

IsRule_TestPointUsage

Summary

Returns Fabrication Testpoint Usage rule objects.

Syntax

IsRule_TestPointUsage : Boolean

Example Usage

IsRule_TestPointUsage
IsRule_TestPointUsage = True
Returns all Fabrication Testpoint Usage rule objects.

Not IsRule_TestPointUsage
IsRule_TestPointUsage = False
Returns all objects except Fabrication Testpoint Usage rule objects.

IsRule_UnconnectedPin

Summary

Returns Un-Connected Pin rule objects.

Syntax

IsRule_UnconnectedPin : Boolean

Example Usage

IsRule_UnconnectedPin
IsRule_UnconnectedPin = True
Returns all Un-Connected Pin rule objects.

Not IsRule_UnconnectedPin
IsRule_UnconnectedPin = False
Returns all objects except Un-Connected Pin rule objects.

IsRule_Undershoot_FallingEdge

Summary

Returns Undershoot - Falling Edge rule objects.

Syntax

IsRule_Undershoot_FallingEdge : Boolean

Example Usage

IsRule_Undershoot_FallingEdge
IsRule_Undershoot_FallingEdge = True
Returns all Undershoot - Falling Edge rule objects.

Not IsRule_Undershoot_FallingEdge
IsRule_Undershoot_FallingEdge = False
Returns all objects except Undershoot - Falling Edge rule objects.

IsRule_Undershoot_RisingEdge

Summary

Returns Undershoot - Rising Edge rule objects.

Syntax

IsRule_Undershoot_RisingEdge : Boolean

Example Usage

IsRule_Undershoot_RisingEdge
IsRule_Undershoot_RisingEdge = True
Returns all Undershoot - Rising Edge rule objects.

Not IsRule_Undershoot_RisingEdge
IsRule_Undershoot_RisingEdge = False
Returns all objects except Undershoot - Rising Edge rule objects.

IsRule_ViasUnderSMD

Summary

Returns Vias Under SMD rule objects.

Syntax

IsRule_ViasUnderSMD : Boolean

Example Usage

IsRule_ViasUnderSMD
IsRule_ViasUnderSMD = True
Returns all Vias Under SMD rule objects.

Not IsRule_ViasUnderSMD
IsRule_ViasUnderSMD = False
Returns all objects except Vias Under SMD rule objects.

IsRule_Wirebonding

Summary

Returns Wire Bonding rule objects.

Syntax

IsRule_Wirebonding : Boolean

Example Usage

IsRule_Wirebonding
IsRule_Wirebonding = True
Returns all Wire Bonding rule objects.

Not IsRule_Wirebonding
IsRule_Wirebonding = False
Returns all objects except Wire Bonding rule objects.

IsShieldingVia

Summary

Returns all via objects that are members of a via shielding group.

Syntax

IsShieldingVia : Boolean/Boolean_String

Example Usage

IsShieldingVia IsShieldingVia = True IsShieldingVia = 'True'
Returns all via objects that are members of a via shielding group. Polygon (shielding copper) objects are also returned.

Not IsShieldingVia IsShieldingVia = False IsShieldingVia = 'False'
Returns all objects except via objects that are members of a via shielding group. Polygon (shielding copper) objects are also returned.

IsSkipVia

Summary

Returns skip via objects.

Syntax

IsSkipVia : Boolean

Example Usage

IsSkipVia
IsSkipVia = True
Returns all skip via objects.

Not IsSkipVia
IsSkipVia = False
Returns all objects except skip via objects.

IsSplitPlane

Summary

Returns split plane objects.

Syntax

IsSplitPlane : Boolean

Example Usage

IsSplitPlane
IsSplitPlane = True
Returns all split plane objects.

Not IsSplitPlane
IsSplitPlane = False
Returns all objects except split plane objects.

IsStackedVia

Summary

Returns stacked via objects.

Syntax

IsStackedVia : Boolean

Example Usage

IsStackedVia
IsStackedVia = True
Returns all stacked via objects.

Not IsStackedVia
IsStackedVia = False
Returns all objects except stacked via objects.

IsStitchingVia

Summary

Returns all via objects that are members of a via stitching group.

Syntax

IsStitchingVia : Boolean/Boolean_String

Example Usage

IsStitchingVia IsStitchingVia = True IsStitchingVia = 'True'
Returns all via objects that are members of a via stitching group.

Not IsStitchingVia IsStitchingVia = False IsStitchingVia = 'False'
Returns all objects except via objects that are members of a via stitching group.

IsStrokeText

Summary

Returns all text-based objects that are using a Stroke font to display their text.

Syntax

IsStrokeText : Boolean

Example Usage

IsStrokeText
IsStrokeText = True
Returns all text-based objects that are using a Stroke font.

Not IsStrokeText
IsStrokeText = False
Returns all objects except text-based objects that are using a Stroke font.

IsTeardrop

Summary

Returns all teardrop objects. Teardrops are often added to a routed PCB design to create stronger track-to-pad, track-to-via and track-to-track connections. This is valuable when the the design objects are very small, and is particularly valuable for drilled pads and vias, because misalignment between the drill center and the pad/via center can result in the drill hole removing much of the copper connecting the track to the pad/via - known as drill breakout. Each teardrop shape is created from a single region object, which can have straight or curved edges.

Syntax

IsTeardrop : Boolean/Boolean_String

Example Usage

IsTeardrop IsTeardrop = True IsTeardrop = 'True'
Returns all teardrop region objects.

Not IsTeardrop IsTeardrop = False IsTeardrop = 'False'
Returns all objects except teardrop region objects.

IsText

Summary

Returns all text-based objects irrespective of the type of font (Stroke, TrueType, BarCode) being used to display the text.

Syntax

IsText : Boolean

Example Usage

IsText
IsText = True
Returns all text-based objects.

Not IsText
IsText = False
Returns all objects except text-based objects.

IsThruVia

Summary

Returns thru via objects.

Syntax

IsThruVia : Boolean

Example Usage

IsThruVia
IsThruVia = True
Returns all thru via objects.

Not IsThruVia
IsThruVia = False
Returns all objects except thru via objects.

IsTrack

Summary

Returns track objects.

Syntax

IsTrack : Boolean

Example Usage

IsTrack
IsTrack = True
Returns all track objects.

Not IsTrack
IsTrack = False
Returns all objects except track objects.

IsTrueTypeText

Summary

Returns all text-based objects that are using a TrueType font to display their text.

Syntax

IsTrueTypeText : Boolean

Example Usage

IsTrueTypeText
IsTrueTypeText = True
Returns all text-based objects that are using a TrueType font.

Not IsTrueTypeText
IsTrueTypeText = False
Returns all objects except text-based objects that are using a TrueType font.

IsVia

Summary

Returns via objects.

Syntax

IsVia : Boolean

Example Usage

IsVia
IsVia = True
Returns all via objects.

Not IsVia
IsVia = False
Returns all objects except via objects.

IsViolation

Summary

Returns all violation objects.

Syntax

IsViolation : Boolean

Example Usage

IsViolation
IsViolation = True
Returns all violation objects.

Not IsViolation
IsViolation = False
Returns all objects except violation objects.

Printer-friendly version

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.

Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, or Altium Designer (on active term).

If you don’t see a documented feature in your actual software, contact Altium Sales to find out more.

Legacy Documentation

Altium Designer documentation is no longer versioned. If you need to access documentation for older versions of Altium Designer, visit the Legacy Documentation section of the Other Installers page.