TreeListNodeIterator Class

The Node Iterator.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public class TreeListNodeIterator :
    IEnumerator<TreeListNode>,
    IDisposable,
    IEnumerator,
    IEnumerable<TreeListNode>,
    IEnumerable

VB.NET

Public Class TreeListNodeIterator
    Implements IEnumerator(Of TreeListNode),
               IDisposable,
               IEnumerator,
               IEnumerable(Of TreeListNode),
               IEnumerable

Remarks

The Node Iterator allows you to traverse through the nodes without writing recursive code. Nodes are visited one by one, starting from a specified node down to the last node contained within a tree.

To iterate through the nodes, do the following.

• Create a new instance of the TreeListNodeIterator class. Multiple constructors allow you to specify a start node or a collection of nodes, along with whether to process only visible nodes.

  Note

  If you have specified a collection of nodes, nodes are processed starting from the first node within a specified collection.

• Use the TreeListNodeIterator.MoveNext method to iterate through nodes. The currently processed node is returned by the TreeListNodeIterator.Current property. Each time the TreeListNodeIterator.MoveNext method is called, the Node Iterator moves to the next node in the hierarchy, and updates the TreeListNodeIterator.Current property. If the current node is the last node, the TreeListNodeIterator.MoveNext method returns false.

  To reset the Node Iterator to its initial state, call the TreeListNodeIterator.Reset method.

To learn more, see Iterating Through Nodes.

Example

This example shows how to traverse through all visible nodes to expand ones that have 4 or more child nodes. Nodes that have less than 4 child nodes are collapsed.

View Example: Iterate Through Nodes With the TreeListNodeIterator

MainWindow.xaml

<dxg:GridControl x:Name="grid" 
                 AutoGenerateColumns="AddNew" 
                 EnableSmartColumnsGeneration="True" 
                 Loaded="OnGridLoaded">
    <dxg:GridControl.View>
        <dxg:TreeListView x:Name="view" AutoWidth="True"
                          KeyFieldName="ID" ParentFieldName="ParentID"/>
    </dxg:GridControl.View>
</dxg:GridControl>

MainWindow.xaml.cs

void SmartExpandNodes(int minChildCount) {
    TreeListNodeIterator nodeIterator = new TreeListNodeIterator(view.Nodes, true);
    while (nodeIterator.MoveNext())
        nodeIterator.Current.IsExpanded = nodeIterator.Current.Nodes.Count >= minChildCount;
}

void OnGridLoaded(object sender, RoutedEventArgs e) {
    SmartExpandNodes(4);
}

MainWindow.xaml.vb

Private Sub SmartExpandNodes(ByVal minChildCount As Integer)
    Dim nodeIterator As TreeListNodeIterator = New TreeListNodeIterator(Me.view.Nodes, True)
    While nodeIterator.MoveNext()
        nodeIterator.Current.IsExpanded = nodeIterator.Current.Nodes.Count >= minChildCount
    End While
End Sub

Private Sub OnGridLoaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
    SmartExpandNodes(4)
End Sub

Inheritance

Object

TreeListNodeIterator