Skip to content

ValueToCheckedState - cCJGridColumn

Converts a data value to a checked state

Type: Function
Return Data Type: Boolean

Parameters

Parameter Type Description
sValue String Pass the data value

Syntax

Function ValueToCheckedState String sValue Returns Boolean

Call Example

Get ValueToCheckedState sValue to BooleanVariable

Description

ValueToCheckedState can be called to determine if a data value is true of false. The data value for a true and false value is determined by the psCheckBoxTrue and psCheckBoxFalse properties. If the passed value does not equal the psCheckBoxTrue value, the checked state is false.

With data aware grids (cDbCJGrid/cDbCJGridColumn), these true and false values will probably be set by your data dictionary.

You can determine a checked state's data value by sending the CheckedStateToValue message.

A column is made a checkbox column by setting pbCheckBox to true.

Return Value

Returns a true if the data value represents a checked state, false if not.