Query_Lang-SCHFunctions_MembershipChecks_Object_AreaColorObject_AreaColor_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 - Membership Checks

Summary

Returns all child objects of each harness connector, port, and sheet symbol object whose Fill Color property complies with the Query.

Syntax

Object_AreaColor(Parent) : Numeric_String
Object_AreaColor(Parent) : Number

The Object_AreaColor keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all parent objects (which do not have a Fill Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as Object_AreaColor(Parent) <> '', or Object_AreaColor(Parent) > ''. Alternatively, use entries specifically targeting parent objects that do have the Fill Color property, such as Object_ObjectKind(Parent) = 'Port', Object_ObjectKind(Parent) = 'Sheet Symbol', etc.

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Object_AreaColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Fill Color property's Blue, Green, and Red components, by using the following constructs:

  • Blue = Fill Color Div 65536
  • Green = Fill Color Div 256 Mod 256
  • Red = Fill Color Mod 256

Example Usage

Object_AreaColor(Parent) = '0'
Object_AreaColor(Parent) <> '' && Object_AreaColor(Parent) = 0

Returns all child objects of each parent object whose Fill Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Object_AreaColor(Parent) = '16711680'
Object_AreaColor(Parent) > '' && Object_AreaColor(Parent) = 16711680

Returns all child objects of each parent object whose Fill Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Object_AreaColor(Parent) <> '16777215'
Returns all objects except child objects of each parent object whose Fill Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

Object_AreaColor(Parent) > '' && Object_AreaColor(Parent) Div 65536 >= 96 && Object_AreaColor(Parent) Div 256 Mod 256 Between 64 And 192 && Object_AreaColor(Parent) Mod 256 <= 128
Returns all child objects of each parent object – except parts – whose Fill Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

Object_ObjectKind(Parent) = 'Port' && Object_AreaColor(Parent) Div 65536 <= 192
Returns all child objects of port objects whose Fill Color property's Blue component has a value which is less than or equal to 192.

Object_ObjectKind(Parent) = 'Sheet Symbol' && Object_AreaColor(Parent) Mod 256 Between 64 And 192
Returns all child objects of sheet symbol objects whose Fill Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.