Query_Lang-SCHFunctions_Fields_TextColorTextColor_AD

Created: August 28, 2015 | Updated: August 18, 2021 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2

Now reading version 1.0. For the latest, read: Query_Lang-SCHFunctions_Fields_TextColor((TextColor))_AD for version 4

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 - 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 TextColor 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 other objects (which do not have a Text Color property) have been totally excluded by one or more preceding entries within the Query expression. Use entries in the expression such as TextColor <> '', or TextColor > ''. Alternatively, use entries specifically targeting port and text frame objects, such as IsPort, IsTextFrame.

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.

Druckversion

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