Query_Lang-SCHFunctions_Fields_ObjectKindObjectKind_AD

Nexus message

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

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.