TreeNodeCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.2.0.0)

Represents a collection of TreeNode objects.

public class TreeNodeCollection : IList, ICollection, IEnumerable, IList<TreeNode>, ICollection<TreeNode>, IEnumerable<TreeNode>

Public Class TreeNodeCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of TreeNode), ICollection(Of TreeNode), IEnumerable(Of TreeNode)

Properties

Count

: Returns the total number of objects in the collection.

IsReadOnly

: Returns a value indicating whether the collection is read-only.

Item(index)

: Returns or sets the at the specified index in the collection.

Throws:

• The being assigned is also a parent causing a circular reference.

• The value is null.

• The index value is less than 0 or is greater than the number of tree nodes in the collection.

Item(key)

: Returns the with the specified key from the collection.

Methods

Add(text)

Adds a new tree node with the specified label text to the end of the current .

Returns: . A that represents the tree node being added to the collection.

Add(key, text)

Creates a new with the specified key and text, and adds it to the collection.

Returns: . The that was added to the collection.

Add(key, text, imageIndex)

Creates a with the specified key, text, and image, and adds it to the collection.

Returns: . The that was added to the collection.

Add(key, text, imageKey)

Creates a with the specified key, text, and image, and adds it to the collection.

Returns: . The that was added to the collection.

Add(key, text, imageIndex, selectedImageIndex)

Creates a with the specified key, text, and images, and adds it to the collection.

Returns: . The tree node that was added to the collection.

Add(key, text, imageKey, selectedImageKey)

Creates a with the specified key, text, and images, and adds it to the collection.

Returns: . The that was added to the collection.

Add(node)

Adds a previously created to the end of the .

Returns: . The zero-based index value of the added to the .

Throws:

• node is null.

• The node is currently assigned to another or it is a parent node causing a circular reference.

AddRange(nodes)

Adds an array of previously created objects to the collection.

Throws:

• nodes is null or one of the items in the collection is null.

• nodes is the child of another .

Clear()

Removes all tree nodes from the collection.

Clear(dispose)

Removes and disposes all tree nodes from the collection.

Contains(node)

Determines whether the specified is a member of the collection.

Returns: . true if the is a member of the collection; otherwise, false.

ContainsKey(key)

Determines whether the collection contains a with the specified key.

Returns: . true to indicate the collection contains a with the specified key; otherwise, false.

CopyTo(dest, index)

Copies the entire collection into an existing array at a specified location within the array.

Find(key, searchAllChildren)

Finds the objects with specified key, optionally searching sub nodes.

Returns: . An array of objects whose property matches the specified key.

GetEnumerator()

Returns an enumerator that can be used to iterate through the .

Returns: . An that represents the .

IndexOf(node)

Returns the index of the specified in the collection.

Returns: . The zero-based index of the item found in the tree node collection; otherwise, -1.

IndexOfKey(key)

Returns the index of the first occurrence of a with the specified key.

Returns: . The zero-based index of the first occurrence of a tree node with the specified key, if found; otherwise, -1.

Insert(index, node)

Inserts an existing tree node into the tree node collection at the specified location.

Throws:

• node is null.

• The node is currently assigned to another or it is a parent node causing a circular reference.

Insert(index, text)

Creates a with the specified text and inserts it at the specified index.

Returns: . The that was inserted in the collection.

Insert(index, key, text)

Creates a tree node with the specified text and key, and inserts it into the collection.

Returns: . The that was inserted in the collection.

Insert(index, key, text, imageIndex)

Creates a with the specified key, text, and image, and inserts it into the collection at the specified index.

Returns: . The that was inserted in the collection.

Insert(index, key, text, imageKey)

Creates a with the specified key, text, and image, and inserts it into the collection at the specified index.

Returns: . The that was inserted in the collection.

Insert(index, key, text, imageIndex, selectedImageIndex)

Creates a with the specified key, text, and images, and inserts it into the collection at the specified index.

Returns: . The that was inserted in the collection.

Insert(index, key, text, imageKey, selectedImageKey)

Creates a with the specified key, text, and images, and inserts it into the collection at the specified index.

Returns: . The that was inserted in the collection.

Remove(node)

Removes the specified from the .

Throws:

• node is null.

RemoveAt(index)

Removes a tree node from the tree node collection at a specified index.

RemoveByKey(key)

Removes the with the specified key from the collection.

Events

CollectionChanged

Fired when the collection changes.