PropertiesFillColourColourGetEx

Reads the current color value set for the specified index point on the Fill | Color tab of the Object Properties dialog for Array, Threshold and Gradient types.

Syntax

PropertiesFillColourColourGet(Index, OnColourNo, OffColourNo, Limit, Operator)

Index:

Specify the index you would like to read the current color for. This values depends on the type of color fill selected:

• 0 - 31 for type Multi-state
• 0 - 255 for type Array
• 0 - 255 for type Threshold
• 0- 1 for Gradient

OnColourNo:

An RGB value representing the "on" color applied to the Index setting.

OffColourNo:

An RGB value representing the "off" color applied to the Index setting.

Limit:

A value between 0 and 100 representing the threshold limit. Used for type Threshold only.

Operator:

The value representing the current operator used for the threshold limit setting:

• 0 : < (less than)
• 1 : > (greater than)
• 2 : <= (less than or equal to)
• 3 : >= (greater than or equal to)

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

PropertiesFillColourColourPutEx, PropertiesFillColourGet, PropertiesFillColourPut