DataObject.IsVarValueOrderEnabled

Prototypes

boolean IsVarValueOrderEnabled( String sVarName )

Return Value

If the custom ordering assigned to the specified variable is enabled, the return value is true. If the custom ordering assigned to the specified variable is disabled, the return value is false. If the specified variable does not have a custom ordering, the return value is false.

Parameters

String sVarName
The name of the variable to interrogate.

Remarks

Use this method to determine whether a variable has a custom ordering that is enabled.

For information about custom ordering, see DataObject.SetVarValueOrder.

Example

declare DataObject dobj;

x = { "Low", "Medium", "Medium", "High", "High", "High" };

dobj = DataObject.Create( "Example", "X", x );

values = { "Low", "Medium", "High" };

dobj.SetVarValueOrder( "X", values );

BarChart.Create( dobj, "X" );

if dobj.IsVarValueOrderEnabled( "X" ) then

    print "Custom ordering for variable X is enabled";

else