TreeListView.CheckBoxFieldName Property

Gets or sets the name of a field in a data source to which check boxes embedded into nodes are bound.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public string CheckBoxFieldName { get; set; }

VB.NET

Public Property CheckBoxFieldName As String

Property Value

Type	Description
String	A String value that specifies the field in a data source.

Remarks

You can embed check boxes into nodes to allow an end user to check/uncheck individual nodes.

Embed Check Boxes into Nodes

1. Set the TreeListView.ShowCheckboxes property to true to display check boxes embedded into nodes.

2. Set values of check boxes. Do one of the following:

   • Specify the TreeListView.CheckBoxFieldName property to bind check boxes to a Boolean field in the grid’s data source.
   • Check nodes in code.

The code sample below shows how to display check boxes and bind them to the OnVacation field:

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"
            CheckBoxFieldName="OnVacation" ShowCheckboxes="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 

Tip

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-embed-check-boxes-into-nodes.

Note

A field in a data source to which check boxes are bound should be of the Boolean or Nullable<Boolean> data type.

Note

Starting from v18.2, the CheckBoxFieldName property supports complex paths to nested properties (e.g., “Order.IsProcessed”).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CheckBoxFieldName 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.

C#

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

<dxg:TreeListControl.View>
    <dxg:TreeListView x:Name="view" TreeDerivationMode="ChildNodesSelector" ShowCheckboxes="True" CheckBoxFieldName="Checked"
                      ChildNodesSelector="{StaticResource childrenSelector}"

how-to-display-checkboxes-in-treelist-nodes-e4147/VB/TreeListCheckBoxes/MainWindow.xaml#L19

<dxg:TreeListView Name="treeListView1" ShowTotalSummary="True" ChildNodesPath="Children" TreeDerivationMode="ChildNodesSelector"
                  ShowCheckboxes="{Binding IsChecked, ElementName=cbShowCheckBoxes}" CheckBoxFieldName="IsChecked"
                  AllowRecursiveNodeChecking="{Binding IsChecked, ElementName=cbAllowRecursiveChecking}" />

how-to-embed-check-boxes-into-nodes/VB/MainWindow.xaml#L15

    <dxg:TreeListView KeyFieldName="ID" ParentFieldName="ParentID" AutoExpandAllNodes="True"
                      ShowCheckboxes="True" CheckBoxFieldName="OnVacation" IsCheckBoxEnabledBinding="{Binding Enabled}" />
</dxg:GridControl.View>