Altium Designer Documentation

Query_Lang-SCHFunctions_MembershipChecks_Object_ColorObject_Color_AD

Created: September 18, 2015 | Updated: August 19, 2021

Parent page: Schematic Query Functions - Membership Checks

Summary

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

Syntax

Object_Color(Parent) : Numeric_String
Object_Color(Parent) : Number

The Object_Color 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 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_Color(Parent) <> '', Object_Color(Parent) > '', or Object_ObjectKind(Parent) <> 'Part'. Alternatively, use entries specifically targeting parent objects that do have the Color property, such as Object_ObjectKind(Parent) = 'Parameter Set', Object_ObjectKind(Parent) = 'Port', 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_Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:

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

Example Usage

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

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

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

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

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

Object_ObjectKind(Parent) <> 'Part' && Object_Color(Parent) <> 16777215
Returns all child objects of each parent object – except parts – whose Color property is 16777215.

Object_Color(Parent) > '' && Object_Color(Parent) Div 65536 >= 96 && Object_Color(Parent) Div 256 Mod 256 Between 64 And 192 && Object_Color(Parent) Mod 256 <= 128
Returns all child objects of each parent object – except parts – whose 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) = 'Parameter Set' && Object_Color(Parent) Div 65536 <= 192
Returns all child objects of parameter set objects whose Color property's Blue component has a value which is less than or equal to 192.

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

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: