Altium NEXUS Documentation
...
((Schematic Query Functions))_AD
SCH Query((Fields))_AD
Query_Lang-SCHFunctions_Fields_PinDesignator_CustomColorPinDesignator_CustomColor_AD
This document is no longer available beyond version 4. Information can now be found here: PinDesignator_CustomColor for version 5
Parent page: Schematic Query Functions - Fields
Summary
Returns all pin objects whose Pin Designator Color property complies with the Query.
Syntax
PinDesignator_CustomColor : Numeric_String
PinDesignator_CustomColor : 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 PinDesignator_CustomColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Pin Designator Color property's Blue, Green, and Red components, by using the following constructs:
- Blue = Pin Designator Color Div 65536
- Green = Pin Designator Color Div 256 Mod 256
- Red = Pin Designator Color Mod 256
Example Usage
PinDesignator_CustomColor = '0'
PinDesignator_CustomColor <> '' && PinDesignator_CustomColor = 0
Returns all pin objects whose Pin Designator Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).
PinDesignator_CustomColor = '16711680'
PinDesignator_CustomColor > '' && PinDesignator_CustomColor = 16711680
Returns all pin objects whose Pin Designator Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).
PinDesignator_CustomColor <> '16777215'
Returns all pin objects except those whose Pin Designator Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).
IsPin && PinDesignator_CustomColor Div 65536 <= 192
Returns all pin objects whose Pin Designator Color property's Blue component has a value which is less than or equal to 192.
IsPin && PinDesignator_CustomColor Mod 256 Between 64 And 192
Returns all pin objects whose Pin Designator 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 Pin Designator Color property is only defined for pin objects.