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

Provides access to the groups that organize items in a RadTreeMapElement.

Reads synchronize this collection with groups generated by the tree map's data view. Adding a group also assigns its owner and applies the current data-view filter to its item source when possible.

Definition

Namespace:Telerik.WinControls.UI.TreeMap

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class TreeMapDataItemGroupCollection : IList, ICollection, IEnumerable, INotifyCollectionChanged

Inheritance: objectTreeMapDataItemGroupCollection

Implements: ICollectionIEnumerableIListINotifyCollectionChanged

Constructors

Initializes a group collection for the specified tree map element.

C#
public TreeMapDataItemGroupCollection(RadTreeMapElement owner)
Parameters:ownerRadTreeMapElement

The element whose groups this collection manages.

Fields

Stores the groups exposed by this collection.

C#
protected ObservableCollection<TreeMapDataItemGroup> groups

The tree map element that owns the groups in this collection.

C#
protected RadTreeMapElement owner

Properties

Gets the number of groups after synchronizing with the data view's generated groups.

C#
public int Count { get; }

Implements: ICollection.Count

Gets whether the underlying group collection permits changes.

C#
public bool IsReadOnly { get; }

Implements: IList.IsReadOnly

Gets whether access to the underlying group collection is synchronized.

C#
public bool IsSynchronized { get; }

Implements: ICollection.IsSynchronized

This value is provided by the underlying collection; this type adds no synchronization.

Gets the synchronization object supplied by the underlying group collection.

C#
public object SyncRoot { get; }

Implements: ICollection.SyncRoot

Gets or replaces a group after synchronizing with the data view's generated groups.

C#
public TreeMapDataItemGroup this[int index] { get; set; }
Parameters:indexint

The zero-based position of the group.

Methods

Adds a group and associates it with the owner of this collection.

C#
public void Add(TreeMapDataItemGroup item)
Parameters:itemTreeMapDataItemGroup

The group to add.

Adds the specified groups while deferring lazy synchronization with groups generated by the data view.

C#
public virtual void AddRange(params TreeMapDataItemGroup[] TreeMapDataItemGroups)
Parameters:TreeMapDataItemGroupsTreeMapDataItemGroup[]

The groups to add.

A CollectionChanged notification is still raised for each collection mutation.

Defers synchronization with groups generated by the data view until the update scope ends.

C#
public virtual void BeginUpdate()

This is a nesting counter for lazy group synchronization; collection change notifications are still raised while an update is in progress.

Removes all groups from this collection.

C#
public void Clear()

Implements: IList.Clear()

Determines whether the synchronized group collection contains the specified group.

C#
public bool Contains(TreeMapDataItemGroup item)
Parameters:itemTreeMapDataItemGroup

The group to locate.

Returns:

bool

true if the group is present; otherwise, false.

Copies the groups to an array, beginning at the specified array index.

C#
public void CopyTo(Array array, int index)
Parameters:arrayArray

The destination array.

indexint

The zero-based destination index at which copying begins.

Implements: ICollection.CopyTo(Array, int)

Copies the synchronized groups to an array, beginning at the specified array index.

C#
public void CopyTo(TreeMapDataItemGroup[] array, int arrayIndex)
Parameters:arrayTreeMapDataItemGroup[]

The destination array.

arrayIndexint

The zero-based destination index at which copying begins.

Ends one update scope started by BeginUpdate().

C#
public virtual void EndUpdate()

Applies the tree map's current data-view filter to the group's item source when that source supports filtering.

C#
protected virtual void EnsureFilterPredicate(TreeMapDataItemGroup item)
Parameters:itemTreeMapDataItemGroup

The group whose item source receives the filter.

Returns an enumerator over the groups after synchronizing with the data view.

C#
public IEnumerator<TreeMapDataItemGroup> GetEnumerator()
Returns:

IEnumerator<TreeMapDataItemGroup>

An enumerator for the groups in this collection.

Returns the position of a group after synchronizing with the data view's generated groups.

C#
public int IndexOf(TreeMapDataItemGroup item)
Parameters:itemTreeMapDataItemGroup

The group to locate.

Returns:

int

The group's zero-based position, or -1 if it is not present.

Inserts a group and associates it with the owner of this collection.

C#
public void Insert(int index, TreeMapDataItemGroup item)
Parameters:indexint

The zero-based position at which to insert the group.

itemTreeMapDataItemGroup

The group to insert.

Removes the specified group.

C#
public bool Remove(TreeMapDataItemGroup item)
Parameters:itemTreeMapDataItemGroup

The group to remove.

Returns:

bool

true if the group was removed; otherwise, false.

Removes the group at the specified position.

C#
public void RemoveAt(int index)
Parameters:indexint

The zero-based position of the group to remove.

Implements: IList.RemoveAt(int)

Events

Occurs when a group is added, removed, replaced, or the collection is reset.

C#
public event NotifyCollectionChangedEventHandler CollectionChanged

Implements: INotifyCollectionChanged.CollectionChanged