InNamedUnion

Now reading version 20. For the latest, read: InNamedUnion for version 21

Parent page: PCB Query Functions - Membership Checks

Summary

Returns all objects (parent and children) that are part of the specified union.

Syntax

InNamedUnion(UnionName : String) : Boolean/Boolean_String

Union names are automatically assigned, but can be renamed through using the PCB panel in Unions mode. As you define the Query expression, a pop-up list of all existing unions, by name, is presented.

Example Usage

InNamedUnion('Unions')
InNamedUnion('Unions') = True
InNamedUnion('Unions') = 'True'

Returns all objects (parent and children) that are part of the union whose name is Unions.

Not InNamedUnion('Unions 1')
InNamedUnion('Unions 1') = False
InNamedUnion('Unions 1') = 'False'

Returns all objects except objects (parent and children) that are part of the union whose name is Unions 1.

Tips

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