Documentation

Class CheckedItemsCollection

A partially observable wrapper for the a hash set that contains the checked items of the RadTreeView.

Inheritance
System.Object
CheckedItemsCollection
Namespace: Telerik.Windows.Controls.TreeView
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

public class CheckedItemsCollection : Object, ICollection<object>, IEnumerable<object>, IEnumerable, ICollection, INotifyPropertyChanged, INotifyCollectionChanged

Properties

Count

Gets the number of elements contained in the System.Collections.ICollection.

Declaration
public int Count { get; }
Property Value
System.Int32

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<> is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
System.Boolean

IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Declaration
public bool IsSynchronized { get; }
Property Value
System.Boolean

SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Declaration
public object SyncRoot { get; }
Property Value
System.Object

Methods

Add(Object)

Adding items to the CheckedItemsCollection is currently not supported, calling this method will throw an exception.

Declaration
public void Add(object item)
Parameters
System.Object item

No item will be added to the collection, regardless of the parameter.

Clear()

The collection is Readonly, calling this method will result in an exception.

Declaration
public void Clear()

Contains(Object)

Determines whether the System.Collections.Generic.ICollection<> contains a specific value.

Declaration
public bool Contains(object item)
Parameters
System.Object item

The object to locate in the System.Collections.Generic.ICollection<>.
Returns
System.Boolean

True if item is found in the System.Collections.Generic.ICollection<>; otherwise, false.

CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration
public void CopyTo(Array array, int index)
Parameters
System.Array array

The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32 index

The zero-based index in array at which copying begins.
Exceptions
System.ArgumentNullException

array is null.
System.ArgumentOutOfRangeException

index is less than zero.
System.ArgumentException

array is multidimensional. -or- index is equal to or greater than the length of array. -or- The number of elements in the source System.Collections.ICollection is greater than the available space from index to the end of the destination array.
System.ArgumentException

The type of the source System.Collections.ICollection cannot be cast automatically to the type of the destination array.

CopyTo(Object[], Int32)

Copies the elements of the System.Collections.Generic.ICollection<> to an System.Array, starting at a particular System.Array index.

Declaration
public void CopyTo(object[] array, int arrayIndex)
Parameters
System.Object[] array

The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection<>. The System.Array must have zero-based indexing.
System.Int32 arrayIndex

The zero-based index in array at which copying begins.
Exceptions
System.ArgumentNullException

array is null.
System.ArgumentOutOfRangeException

arrayIndex is less than 0.
System.ArgumentException

array is multidimensional. -or- arrayIndex is equal to or greater than the length of array. -or- The number of elements in the source System.Collections.Generic.ICollection<> is greater than the available space from arrayIndex to the end of the destination array.

GetCheckedItemsOnly()

Returns the items from the collection that have a ToggleState.On and excludes items with ToggleState.Indeterminate.

Declaration
public IEnumerator<object> GetCheckedItemsOnly()
Returns
System.Collections.Generic.IEnumerator<System.Object>

An enumerator that returns only the checked items which are not in indeterminate state.

GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
public IEnumerator GetEnumerator()
Returns
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.

Remove(Object)

The CheckedItems collection is read-only and cannot be modified.

Declaration
public bool Remove(object item)
Parameters
System.Object item

No item will be remove, the collection is read-only.
Returns
System.Boolean

Always returns false.

Events

CollectionChanged

Raised when the CheckedItems change. Currently it is only raised with 'Reset' since the set of items in unordered.

Declaration
public event NotifyCollectionChangedEventHandler CollectionChanged
Event Type
System.Collections.Specialized.NotifyCollectionChangedEventHandler

PropertyChanged

Raised when a property changes on the object.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Extension Methods