TreeListView.AllowRecursiveNodeChecking Property

Gets or sets whether recursive node selection is enabled. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

public bool AllowRecursiveNodeChecking { get; set; }

VB.NET

Public Property AllowRecursiveNodeChecking As Boolean

Property Value

Type	Default	Description
Boolean	false	true, to enable recursive selection; otherwise, false.

Remarks

Set the AllowRecursiveNodeChecking property to true to enable recursive node checking:

• When you check/uncheck a parent node, its children become checked/unchecked.
• When you check/uncheck all child nodes, its parent becomes checked/unchecked.
• When you check/uncheck a child node, but not all child nodes are checked/unchecked, its parent goes to the indeterminate check state.

Xaml

<dxg:GridControl Name="gridControl">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="Name"/>
        <dxg:GridColumn FieldName="Department"/>
        <dxg:GridColumn FieldName="Position"/>
    </dxg:GridControl.Columns>
    <dxg:GridControl.View>
        <dxg:TreeListView KeyFieldName="ID" ParentFieldName="ParentID" AutoExpandAllNodes="True"
                          ShowCheckboxes="True" CheckBoxFieldName="OnVacation" AllowRecursiveNodeChecking="True" />
    </dxg:GridControl.View>
</dxg:GridControl>

C#

public class Employee {
    public int ID { get; set; }
    public int ParentID { get; set; }
    public string Name { get; set; }
    public string Position { get; set; }
    public string Department { get; set; }
    public bool OnVacation { get; set; }
}

VB.NET

Public Class Employee
    Public Property ID As Integer
    Public Property ParentID As Integer
    Public Property Name As String
    Public Property Position As String
    Public Property Department As String
    Public Property OnVacation As Boolean
End Class 

The TreeListNode.IsChecked property returns the following values:

• true - if all child nodes are checked
• false - if none of child nodes are checked
• null - if a node contains both checked and unchecked children.

Note

If the AllowRecursiveNodeChecking is true, when you use the TreeListView.CheckBoxFieldName property to update a field in a data source, this field should be of the Nullable<Boolean> data type.

Note

Even if the TreeListView.AllowRecursiveNodeChecking is true, for the first time the TreeListView sets values of check boxes in accordance with a data source values.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowRecursiveNodeChecking property.

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.

XAML

how-to-show-check-boxes-near-nodes-and-check-child-nodes-when-a-parent-node-is-checked-e3466/CS/HierarchicalDataBinding/MainWindow.xaml#L25

                      ChildNodesSelector="{StaticResource childrenSelector}"
                      ShowNodeImages="True" AllowRecursiveNodeChecking="True" />
</dxg:TreeListControl.View>