Altium Designer Documentation
...
((Schematic Query Functions))_AD
SCH Query((Fields))_AD
Query_Lang-SCHFunctions_Fields_TextColorTextColor_AD
Parent page: Schematic Query Functions - Fields
Summary
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property complies with the Query.
Syntax
TextColor : Numeric_String
TextColor : 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 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
TextColor = '0'
TextColor <> '' && TextColor = 0
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).
TextColor = '32896'
TextColor > '' && TextColor = 32896
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 32896 (which corresponds to values of Blue = 0, Green = 128, and Red = 128).
TextColor <> '16777215'
Returns all objects except harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).
IsPort Or IsTextFrame && TextColor <> 16777215
Returns all port, or text frame objects, whose Text Color property is not 16777215.
TextColor > '' && TextColor Div 65536 >= 96 && TextColor Div 256 Mod 256 Between 64 And 192 && TextColor Mod 256 <= 128
Returns all harness entry, note, port, sheet entry, and text frame 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.
IsTextFrame && TextColor Div 65536 <= 192
Returns all text frame objects whose Text Color property's Blue component has a value which is less than or equal to 192.
IsPort && TextColor Mod 256 Between 64 And 192
Returns all 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
- The Text Color property is only defined for harness entry, note, port, sheet entry, and text frame objects.