ObjectKind

Now reading version 18.0. For the latest, read: ObjectKind for version 21

Parent page: Schematic Query Functions - Fields

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:

Electrical Objects'Blanket', 'Bus' , 'Bus Entry', 'Compile Mask', 'Harness Connector', 'Harness Entry''Net Label', 'No ERC', 'Off Sheet Connector', 'Parameter Set', 'Part''Pin''Port', 'Power Object', 'Probe', 'Sheet Entry', 'Sheet Symbol', 'Signal Harness', 'Wire'.

Non-Electrical Objects'Arc', 'Bezier', 'Designator', 'Ellipse', 'Harness Connector Type', 'IEEE Symbol', 'Image', 'Line', 'Note', 'Parameter', 'Polygon', 'Rectangle', 'Round Rectangle', 'Sheet File Name', 'Sheet Name', 'Text Frame', 'Text String'.

Example Usage

ObjectKind = 'Bus'
Returns all bus objects.

ObjectKind <> 'Pie'
Returns all objects except for pie charts.

ObjectKind = 'Line'
Returns all line objects.

Tips

  1. The single quote characters (') at the start and end of ObjectKind_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.