GetEquipmentColor
(Function Library)
| Description: |
Returns a defined equipment color as set in a Style tag. |
| Returns: | Text defining a color. "<AARRGGBB>" |
Usage:  |
Script or steady state. |
| Function Groups: | Color, Function Library |
| Related to: | GetEquipmentLabel |
| Format: |
\FunctionLib.GetEquipmentColor( IOTagObject[, FlashNotRequired, SelectSecondary, StyleTagObject, Value]) |
| Parameters: |
| IOTagObject |
| Required. An I/O tag object whose Equipment parameter contains the equipment type to examine. |
| FlashNotRequired |
| Optional Boolean. Set TRUE for flash to be disabled. |
| SelectSecondary |
|
Optional Boolean. Relevant only if FlashNotRequired is set TRUE or if FlashNotRequired is set FALSE and Flash is disabled in the StyleTag for the specified state of the EquipmentType. If SelectSecondary is also set TRUE then the flash off color (secondary color) is returned. |
| StyleTagObject |
| Optional tag object. A Style tag with the desired equipment type. Defaults to the style tag used by the indicated I/O tag (which in turn defaults to System Style). |
| Value |
| Optional numeric. If the equipment style has a set of values, each with a different color, use this to select which should be returned. |
| Comments: |
If flash is enabled in the style and not suppressed by the second parameter of this function, GetEquipmentColor will cycle between the flash-on and flash-off colors. |
