New to Telerik UI for WinForms? Start a free 30-day trial

TreeViewTraverser

Class

Traverses visible tree nodes in hierarchy order, descending into children only when their parent is expanded. Invisible nodes are included while the tree is in design mode.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

public class TreeViewTraverser : ITraverser<RadTreeNode>, IDisposable, IEnumerator, IEnumerable

Inheritance: objectTreeViewTraverser

Implements: IDisposableIEnumerableIEnumeratorITraverser<RadTreeNode>

Constructors

TreeViewTraverser(RadTreeViewElement, RadTreeNode)

Creates a traverser for the specified tree view and positions it at the supplied node.

public TreeViewTraverser(RadTreeViewElement owner, RadTreeNode position)

Parameters:ownerRadTreeViewElement

The tree element whose nodes are traversed.

positionRadTreeNode

The initial node position.

TreeViewTraverser(RadTreeViewElement)

Creates a traverser for the specified tree view.

public TreeViewTraverser(RadTreeViewElement owner)

Parameters:ownerRadTreeViewElement

The tree element whose nodes are traversed.

Properties

Current

RadTreeNode

Gets the node at the current traversal position.

public RadTreeNode Current { get; }

Property Value:

The current node, or null when traversal has no position.

Position

object

Gets or sets the node at the current traversal position.

public object Position { get; set; }

Property Value:

The current RadTreeNode, or null when no node is positioned.

Implements: ITraverser<RadTreeNode>.Position

Methods

Dispose()

Performs no cleanup; this traverser does not release resources or clear its node references.

public void Dispose()

Implements: IDisposable.Dispose()

GetEnumerator()

Gets the cached enumerator positioned at this traverser's current node. Repeated calls reuse the same enumerator instance.

public IEnumerator GetEnumerator()

Returns:

IEnumerator

The cached tree-node enumerator.

Implements: IEnumerable.GetEnumerator()

MoveBackward(RadTreeNode)

Searches backward from the current position, including the current node, for the specified node.

public bool MoveBackward(RadTreeNode node)

Parameters:nodeRadTreeNode

The node to find.

Returns:

bool

true if the node is reached; otherwise, false.

MoveForward(RadTreeNode)

Searches forward from the current position, including the current node, for the specified node.

public bool MoveForward(RadTreeNode node)

Parameters:nodeRadTreeNode

The node to find.

Returns:

bool

true if the node is reached; otherwise, false.

MoveNext()

Advances to the next visible node in hierarchy order, descending into children of expanded nodes. Nodes rejected by Traversing are skipped.

public bool MoveNext()

Returns:

bool

true if another node was reached; otherwise, false.

Implements: IEnumerator.MoveNext()

MoveNextCore()

Advances the internal position to the next visible node without raising Traversing.

protected virtual bool MoveNextCore()

Returns:

bool

true if another node was reached; otherwise, false.

MovePrevious()

Moves to the preceding visible node, visiting the deepest visible descendant of an expanded previous sibling. When no node is positioned, starts at the first visible root node.

public bool MovePrevious()

Returns:

bool

true if a node was reached; otherwise, false.

Implements: ITraverser<RadTreeNode>.MovePrevious()

MovePreviousCore()

Advances the internal position to the preceding visible node without raising Traversing.

protected virtual bool MovePreviousCore()

Returns:

bool

true if a preceding node was reached; otherwise, false.

MoveTo(int)

public void MoveTo(int index)

Parameters:indexint

MoveTo(RadTreeNode)

Resets traversal and returns the zero-based position of the specified node among nodes accepted by Traversing.

public int MoveTo(RadTreeNode item)

Parameters:itemRadTreeNode

The node to locate.

Returns:

int

The node's position, or -1 if it is not reached.

MoveToEnd()

Moves to the last root node accepted by Traversing, searching the root collection from end to beginning. This operation does not descend into child nodes.

public bool MoveToEnd()

Returns:

bool

true if a root node was accepted; otherwise, false.

Implements: ITraverser<RadTreeNode>.MoveToEnd()

OnTraversing()

Raises the traversal event for the current node and returns whether traversal should yield it.

protected bool OnTraversing()

Returns:

bool

true when the current node should be processed or no handler is registered.

OnTraversing(TreeViewTraversingEventArgs)

Raises the Traversing event with the supplied event data.

protected virtual void OnTraversing(TreeViewTraversingEventArgs e)

Parameters:eTreeViewTraversingEventArgs

The candidate node and its processing flag.

Reset()

Resets traversal so the next move starts at the first root node.

public void Reset()

Implements: IEnumerator.Reset()

Events

Traversing

TreeViewTraversingEventHandler

Occurs for each candidate node before traversal returns it. Set Process to false to skip that node.

public event TreeViewTraversingEventHandler Traversing