InComponent

This document is no longer available beyond version 21. Information can now be found here: InComponent for version 25

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all component objects whose Name property complies with the Query.

Syntax

InComponent(Name : String) : Boolean/Boolean_String

As you define the Query expression, a pop-up list of all existing components, by name, is presented.

Example Usage

InComponent('U1')
InComponent('U1') = True
InComponent('U1') = 'True'

Returns all component objects whose Name property is U1.

InComponent('U1', 'U2', 'J1')
InComponent('U1', 'U2', 'J1') = True
InComponent('U1', 'U2', 'J1') = 'True'

Returns all component objects whose Name property is U1, or U2, or J1.

Not InComponent('IDC16')
InComponent('IDC16') = False
InComponent('IDC16') = 'False'

Returns all objects except component objects whose Name property is IDC16.

InComponent('U*')
InComponent('U*') = True
InComponent('U*') = 'True'

Returns all component objects whose Name property starts with U.

Tips

  1. The single quote characters (') at the start and end of the Name string are mandatory.
  2. For each returned component object, its associated child objects are also returned.
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.