Export (0) Print
Expand All

LegendItemsCollection Class

Represents a collection of LegendItem objects.

Namespace:  System.Web.UI.DataVisualization.Charting
Assembly:  System.Web.DataVisualization (in System.Web.DataVisualization.dll)

public class LegendItemsCollection : ChartElementCollection<LegendItem>

The LegendItemsCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public propertyItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Protected propertyItemsGets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Top

  NameDescription
Public methodAdd(T)Adds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public methodAdd(Color, String)Adds a custom LegendItem object with the specified text and symbol color to the end of the collection.
Public methodAdd(String, String)Adds a custom LegendItem object with the specified image to the end of the collection.
Public methodClearRemoves all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected methodClearItemsRemoves all elements from the Collection<T>. (Inherited from ChartElementCollection<T>.)
Public methodContainsDetermines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public methodCopyToCopies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public methodDispose()Releases the resources used by the ChartElementCollection<T>. (Inherited from ChartElementCollection<T>.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ChartElementCollection<T> and optionally releases the managed resources. (Inherited from ChartElementCollection<T>.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public methodInsert(Int32, T)Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Public methodInsert(Int32, Color, String)Inserts a LegendItem object with the specified text and symbol color into the collection at the specified location.
Public methodInsert(Int32, String, String)Inserts a LegendItem object with the specified text and symbol image into the collection at the specified location.
Protected methodInsertItemInserts an element into the Collection<T> at the specified index location. (Inherited from ChartElementCollection<T>.)
Public methodInvalidateForces the invalidation of the parent chart element. (Inherited from ChartElementCollection<T>.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public methodRemoveAtRemoves the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected methodRemoveItemRemoves the element at the specified index location of the Collection<T>. (Inherited from ChartElementCollection<T>.)
Public methodResumeUpdatesResumes the invalidation of a chart element in the collection. (Inherited from ChartElementCollection<T>.)
Public methodReverseReverses the order of items in the collection.
Protected methodSetItemReplaces the element at the specified index location. (Inherited from ChartElementCollection<T>.)
Public methodSuspendUpdatesSuspends the invalidation of a chart element in the collection. (Inherited from ChartElementCollection<T>.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection<T>.IsReadOnlyGets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.AddAdds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.IndexOfDetermines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.InsertInserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeGets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyGets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.ItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Top

The LegendItemsCollection class represents a collection of LegendItem objects, which in turn represent items in a legend.

This collection class is exposed in two ways:

  • As the CustomItems object property of the Legend object, which can be used to add, delete or modify custom legend items. The term "custom" refers to legend items that have user-defined text, symbol color, and so forth. In comparison, "default" legend items are items that are automatically inserted into the legend and represent a data series or data point. Default legend item entries for pie and doughnut charts represent the plotted data points, whereas item entries for all other chart types represent the plotted series. The CustomItems property is available at both design time and run time.

  • In the CustomizeLegend event, as the LegendItems property of the CustomizeLegendEventArgs parameter. The LegendItems property stores both default legend items and custom legend items that have been added to the Chart control at design time. Legend items can be modified or deleted; in addition, their order can be changed.

To add legend items to the collection, use one of the overloaded Add and Insert methods in this class.

.NET Framework

Supported in: 4.5, 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft