AddVoltage

<< Click to Display Table of Contents >>

 

AddVoltage

AddVoltage(Voltage, [ColorEnergized], [FollowEnergized], [ColorDeEnergized])

Adds a Voltage Color object with the voltage indicated in the Voltage parameter in the collection of Voltage Colors. The ColorEnergized parameter indicates the color used to represent energized devices in that voltage. This parameter is optional and, if omitted, configures this color as black (RGB(0, 0, 0)). The FollowEnergized parameter is a Boolean indicating whether the color informed in the ColorDeEnergized parameter is not used and the voltage color of de-energized devices is automatically calculated as a darker version of the color informed in the ColorEnergized parameter. This parameter is optional and, if omitted, the voltage color of de-energized devices is automatically calculated. The ColorDeEnergized parameter indicates the color used to represent de-energized devices in that voltage. This parameter is optional and, if omitted, configures this color as black (RGB(0, 0, 0)). The color indicated in the ColorDeEnergized parameter has no effect if the FollowEnergized parameter is equal to True.

If the voltage already exists in the collection of Voltage Colors object, this method returns an error. This method returns a Voltage Color object if successful.

Was this page useful?