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

Exposes the items owned by a heat map definition and synchronizes each item's owner with collection changes.

Definition

Namespace:Telerik.WinControls.UI.HeatMap

Assembly:Telerik.WinControls.UI.dll

Syntax:

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

Inheritance: objectHeatMapDataItemCollection

Implements: ICollectionIEnumerableIListINotifyCollectionChanged

Constructors

Creates a collection backed by the specified definition's list source.

C#
public HeatMapDataItemCollection(HeatMapDefinition owner)
Parameters:ownerHeatMapDefinition

The definition that owns the collection and its items.

Properties

Gets the number of items in the definition's current collection view.

C#
public int Count { get; }

Implements: ICollection.Count

Gets whether the collection has a fixed size; this collection always reports false.

C#
public bool IsFixedSize { get; }

Implements: IList.IsFixedSize

Gets whether the underlying list source reports that its items are read-only.

C#
public bool IsReadOnly { get; }

Implements: IList.IsReadOnly

Gets whether the underlying list source reports synchronized access.

C#
public bool IsSynchronized { get; }

Implements: ICollection.IsSynchronized

Gets the synchronization object exposed by the underlying list source.

C#
public object SyncRoot { get; }

Implements: ICollection.SyncRoot

Gets or replaces the item at a position in the definition's current collection view.

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

The position of the item.

Methods

Adds an item, moving it from its previous definition when it already has an owner.

C#
public void Add(HeatMapDataItem item)
Parameters:itemHeatMapDataItem

The item to add.

Exceptions: InvalidOperationException

The definition's list source is data-bound.

Adds all supplied items inside a single update batch.

C#
public virtual void AddRange(params HeatMapDataItem[] HeatMapDataItems)
Parameters:HeatMapDataItemsHeatMapDataItem[]

The items to add.

Exceptions: InvalidOperationException

The definition's list source is data-bound.

Suspends collection-view updates until the matching EndUpdate() call.

C#
public void BeginUpdate()

Clears the collection and removes the owner association from each item.

C#
public void Clear()

Implements: IList.Clear()

Determines whether the definition's current collection view contains an item.

C#
public bool Contains(HeatMapDataItem item)
Parameters:itemHeatMapDataItem

The item to locate.

Returns:

bool

true if the item is in the view; otherwise, false.

Determines whether an object value is a heat map item in the current collection view.

C#
public bool Contains(object value)
Parameters:valueobject

The object to locate.

Returns:

bool

true if value is a contained HeatMapDataItem; otherwise, false.

Implements: IList.Contains(object)

Copies the underlying list-source items into an array.

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

The destination array.

indexint

The zero-based destination index.

Implements: ICollection.CopyTo(Array, int)

Copies the items in the current collection view into an array.

C#
public void CopyTo(HeatMapDataItem[] array, int arrayIndex)
Parameters:arrayHeatMapDataItem[]

The destination array.

arrayIndexint

The zero-based destination index.

Completes one update level; ending the final level publishes pending changes as a reset notification.

C#
public void EndUpdate()

Returns an enumerator over the definition's current collection view.

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

IEnumerator<HeatMapDataItem>

An enumerator for the items in the view.

Gets the position of an item in the definition's current collection view.

C#
public int IndexOf(HeatMapDataItem item)
Parameters:itemHeatMapDataItem

The item to locate.

Returns:

int

The zero-based view index, or -1 if the item is not in the view.

Gets the view index of an object when it is a heat map item.

C#
public int IndexOf(object value)
Parameters:valueobject

The object to locate.

Returns:

int

The zero-based view index, or -1 if the object is not a heat map item in the view.

Implements: IList.IndexOf(object)

Inserts an item at the specified position, transferring it from another definition if necessary.

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

The position at which to insert the item.

itemHeatMapDataItem

The item to insert.

Exceptions: InvalidOperationException

The definition's list source is data-bound.

Inserts an object when it is a heat map item; objects of other types are ignored.

C#
public void Insert(int index, object value)
Parameters:indexint

The position at which to insert the item.

valueobject

The object to insert.

Implements: IList.Insert(int, object)

Raises CollectionChanged with the supplied collection-view change.

C#
protected virtual void OnCollectionChanged(NotifyCollectionChangedEventArgs args)
Parameters:argsNotifyCollectionChangedEventArgs

The change details forwarded by the underlying collection view.

Removes an item from the list source and clears its owner association.

C#
public bool Remove(HeatMapDataItem item)
Parameters:itemHeatMapDataItem

The item to remove.

Returns:

bool

true if the list source contained and removed the item; otherwise, false.

The item's owner is cleared even when it was not present in this collection.

Removes an object when it is a heat map item; objects of other types are ignored.

C#
public void Remove(object value)
Parameters:valueobject

The object to remove.

Implements: IList.Remove(object)

Removes the item at the specified position in the current collection view.

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

The position of the item to remove.

Implements: IList.RemoveAt(int)

Events

Occurs after the definition's list-source view changes and item owner associations are updated.

C#
public event NotifyCollectionChangedEventHandler CollectionChanged

Implements: INotifyCollectionChanged.CollectionChanged