PlusWnd::LstView_SetCheckedState

The PlusWnd::LstView_SetCheckedState function checks or unchecks an item in a ListViewControl.

Syntax

LstView_SetCheckedState(
    [string] ControlId,
    [number] ItemIdx,
    [boolean] CheckedState
);

Parameters

ControlId

[string] Unique identifier of the control

ItemIdx

[number] Index of the item which check state is to be retrieved.

CheckedState

[boolean] True is the item is to be checked, false if it is to be unchecked.

Return Value

No value is returned by this function.

This function typically fails for the following reason:

• The PlusWnd object refers to a window that has been destroyed.

Remarks

This function will only work if the List View control is in Report View mode with the "HasCheckboxes" attribute set to true.

Function Information

See Also

PlusWnd Object, LstView_GetCheckedState.