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.v18.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

When the TreeListView.AllowRecursiveNodeChecking option is enabled, the TreeListRowData.IsChecked property returns the following values:

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

Note, that in this case, if you use the CheckBoxFieldName property to update corresponding property in your data items, this property should be of the Nullable<Boolean> data type.

Note

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

To learn more, see Checking Nodes.

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}" />