TreeList.BeforeCheckNode Event

Occurs before a node’s check state is changed.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.2.dll

Declaration

C#

public event CheckNodeEventHandler BeforeCheckNode

VB.NET

Public Event BeforeCheckNode As CheckNodeEventHandler

Event Data

The BeforeCheckNode event's data class is DevExpress.XtraTreeList.CheckNodeEventArgs.

Remarks

The BeforeCheckNode event is raised when an end-user changes a node’s check state, and allows you to cancel the operation or specify the required check state.

To cancel the operation, set the event parameter’s CanCheck property to false. The previous and current node states are returned by the PrevState and State properties, respectively. You can change the State property’s value to specify the required node state.

The following code prevents an end-user from setting nodes to an indeterminate state.

C#

private void treeList1_BeforeCheckNode(object sender, DevExpress.XtraTreeList.CheckNodeEventArgs e) {
    if (e.State == CheckState.Indeterminate)
        e.State = (e.PrevState == CheckState.Checked ? CheckState.Unchecked : CheckState.Checked);
}

VB.NET

Private Sub TreeList1_BeforeCheckNode(sender As System.Object, e As DevExpress.XtraTreeList.CheckNodeEventArgs) _
Handles TreeList1.BeforeCheckNode
    If e.State = CheckState.Indeterminate Then
        If e.PrevState = CheckState.Checked Then
            e.State = (CheckState.Unchecked)
        Else
            e.State = (CheckState.Checked)
        End If
    End If
End Sub

After a node’s state has been changed, the TreeList.AfterCheckNode event is raised.

See Node Checking - Checkboxes and Radio Buttons to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeforeCheckNode event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L25

tree.OptionsView.ShowIndicator = false;
tree.BeforeCheckNode += Tree_BeforeCheckNode;
tree.AfterCheckNode += Tree_AfterCheckNode;

winforms-treelist-show-checkboxes-for-specific-level/CS/WindowsApplication1/Form1.cs#L55

    treeList.CustomDrawNodeCheckBox += treeList_CustomDrawNodeCheckBox;
    treeList.BeforeCheckNode += treeList_BeforeCheckNode;
}

winforms-treelist-custom-check-nodes-behavior/CS/Example/TreeListCheckHelper.cs#L16

    treeList.OptionsBehavior.AllowIndeterminateCheckState = false;
    treeList.BeforeCheckNode += treeList1_BeforeCheckNode;
}

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L29

tree.OptionsView.ShowIndicator = False
AddHandler tree.BeforeCheckNode, AddressOf Tree_BeforeCheckNode
AddHandler tree.AfterCheckNode, AddressOf Tree_AfterCheckNode

winforms-treelist-show-checkboxes-for-specific-level/VB/WindowsApplication1/Form1.vb#L51

    AddHandler treeList.CustomDrawNodeCheckBox, AddressOf treeList_CustomDrawNodeCheckBox
    AddHandler treeList.BeforeCheckNode, AddressOf treeList_BeforeCheckNode
End Sub

winforms-treelist-custom-check-nodes-behavior/VB/Example/TreeListCheckHelper.vb#L14

    treeList.OptionsBehavior.AllowIndeterminateCheckState = False
    AddHandler treeList.BeforeCheckNode, AddressOf treeList1_BeforeCheckNode
End Sub