SetCustomTrafficLight method

Applies to the traffic light field.

Syntax

C++

HRESULT 
 SetCustomTrafficLight (



   BSTR RedText

   BSTR YellowText

   BSTR GreenText)

Scripting languages

Object.SetCustomTrafficLight 
 (

   RedText as String,

   YellowText as String,

   GreenText as String)

Parameters

RedText

The text that appears when the item is set to a red light status.

YellowText

The text that appears when the item is set to a yellow light status.

GreenText

The text that appears when the item is set to a green light status.

Return value

C++

The return code.

Scripting languages

None.

Return value

You can only call the SetCustomTrafficLight method if the DataType property is set to erColumnTypeTrafficLight and if TrafficLightStyle is set to ERUTrafficLightCustom. Otherwise, SetCustomTrafficLight returns the error EROOM_E_INVALIDOPERATION.

You can get the individual strings for red, yellow, and green status with the TrafficRedText, TrafficYellowText, and TrafficGreenText properties.

Home

Applies to
IERUDBColumn

See also
Databases