CalculateCheckStatesValue(TcxCheckStates,IcxCheckItems,TcxCheckStatesValueFormat) Method

Calculates the edit value by the check box items’ check states.

Declaration

function CalculateCheckStatesValue(const ACheckStates: TcxCheckStates; AItems: IcxCheckItems; AValueFormat: TcxCheckStatesValueFormat): TcxEditValue;

Parameters

Name	Type
ACheckStates	TcxCheckStates
AItems	IcxCheckItems
AValueFormat	TcxCheckStatesValueFormat

Returns

Type
TcxEditValue

Remarks

The CalculateCheckStatesValue function calculates the edit value in the specified format by the items’ check states and returns this value as the result. This might be useful for data-aware editors (for example, when it is necessary to perform additional validation of the value prior to it being posted to a database).

The AValueFormat parameter represents the format of the calculated edit value. The AItems parameter corresponds to the check box items whose states are checked (for instance, via the Properties.Items property of the check group box editor). The ACheckStates parameter represents an array of check states which match the calculated edit value.

Note

The CalculateCheckStates function represents the inverse operation for the CalculateCheckStatesValue function.