IsObjectKind

Now reading version 18. For the latest, read: IsObjectKind for version 21

Parent page: PCB Query Functions - Membership Checks

Summary

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

Syntax

IsObjectKind(ObjectType : String) : Boolean/Boolean_String

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

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

Example Usage

IsObjectKind('Via')
IsObjectKind('Via') = True
IsObjectKind('Via') = 'True'

Returns all via objects.

Not IsObjectKind('Track')
IsObjectKind('Track') = False
IsObjectKind('Track') = 'False'

Returns all objects except track objects.

Tips

  1. The single quote characters (') at the start and end of the ObjectType string are mandatory.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

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