VirtualTreeGetCellValueInfo.IsCheckState Property

Gets whether the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is currently fired for you to provide a node’s check state.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v21.1.dll

Declaration

public bool IsCheckState { get; }

Property Value

Type Description
Boolean

true if the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is fired for you to provide a node’s check state; false if this event/method is fired for you to provide a node’s cell values.

Remarks

TreeList nodes can display check boxes/radio buttons that allow end-users to check certain nodes (see Node Checking - Checkboxes and Radio Buttons). By default, the TreeList.VirtualTreeGetCellValue event and IVirtualTreeListData.VirtualTreeGetCellValue interface method are used to supply node values. If the TreeListOptionsBehavior.AllowBoundCheckBoxesInVirtualMode option is enabled, this event and method are also fired, so you provide a node’s check state. Read the IsCheckState parameter to learn if the event is fired to query a check state. If it returns true, assign the check state to the VirtualTreeGetCellValueInfo.CellData parameter.

Similarly, when an end-user modifies a node’s check state, the TreeList.VirtualTreeSetCellValue event/IVirtualTreeListData.VirtualTreeSetCellValue method fires (if the TreeListOptionsBehavior.AllowBoundCheckBoxesInVirtualMode option is enabled) with the VirtualTreeSetCellValueInfo.IsCheckState parameter set to true. In this case, you can save the node’s new check state (which is stored in the VirtualTreeSetCellValueInfo.NewCellData parameter) according to your logic.

See Also