Altium Designer Documentation
...
Schematic Query Functions
Membership Checks
Object_TextColor
This document is no longer available beyond version 21. Information can now be found here: Object_TextColor for version 25
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.
Parent page: Schematic Query Functions - Membership Checks
Summary Copy Link Copied
Returns all child objects of port objects whose Text Color property complies with the Query.
Syntax Copy Link Copied
Object_TextColor(Parent) : Numeric_String
Object_TextColor(Parent) : Number
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_TextColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Text Color property's Blue, Green, and Red components, by using the following constructs:
- Blue = Text Color Div 65536
- Green = Text Color Div 256 Mod 256
- Red = Text Color Mod 256
Example Usage Copy Link Copied
Object_TextColor(Parent) = '0'
Object_TextColor(Parent) <> '' && Object_TextColor(Parent) = 0
Returns all child objects of port objects whose Text Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).
Object_TextColor(Parent) = '32896'
Object_TextColor(Parent) > '' && Object_TextColor(Parent) = 32896
Returns all child objects of port objects whose Text Color property is 32896 (which corresponds to values of Blue = 0, Green = 128, and Red = 128).
Object_TextColor(Parent) <> '16777215'
Returns all objects except child objects of port objects whose Text Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).
Object_ObjectKind(Parent) = 'Port' && Object_TextColor(Parent) <> 16777215
Returns all child objects of port objects whose Text Color property is not 16777215.
Object_TextColor(Parent) > '' && Object_TextColor(Parent) Div 65536 >= 96 && Object_TextColor(Parent) Div 256 Mod 256 Between 64 And 192 && Object_TextColor(Parent) Mod 256 <= 128
Returns all child objects of port objects whose Text 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_TextColor(Parent) Mod 256 Between 64 And 192
Returns all child objects of port objects whose Text Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.
Tips Copy Link Copied
- The Text Color property is defined for harness entry, note, port, sheet entry, and text frame objects, but only port objects can have children that are returnable by this expression.