LegendItemsCollection Class
Represents a collection of LegendItem objects.
System.Collections.ObjectModel::Collection<LegendItem>
System.Windows.Forms.DataVisualization.Charting::ChartElementCollection<LegendItem>
System.Windows.Forms.DataVisualization.Charting::LegendItemsCollection
Assembly: System.Windows.Forms.DataVisualization (in System.Windows.Forms.DataVisualization.dll)
The LegendItemsCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Count | Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.) |
![]() | Item | Gets or sets the element at the specified index. (Inherited from Collection<T>.) |
![]() | Items | Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.) |
| Name | Description | |
|---|---|---|
![]() | Add(T) | Adds an object to the end of the Collection<T>. (Inherited from Collection<T>.) |
![]() | Add(Color, String) | Adds a custom LegendItem object to the end of the collection. |
![]() | Add(String, String) | Adds a custom LegendItem object with the specified image to the end of the collection. |
![]() | Clear | Removes all elements from the Collection<T>. (Inherited from Collection<T>.) |
![]() | ClearItems | Removes all elements from the Collection<T>. (Inherited from ChartElementCollection<T>.) |
![]() | Contains | Determines whether an element is in the Collection<T>. (Inherited from Collection<T>.) |
![]() | CopyTo | Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.) |
![]() | Dispose() | Releases the resources used by the ChartElementCollection<T>. (Inherited from ChartElementCollection<T>.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the ChartElementCollection<T> and optionally releases the managed resources. (Inherited from ChartElementCollection<T>.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetEnumerator | Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IndexOf | Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.) |
![]() | Insert(Int32, T) | Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.) |
![]() | Insert(Int32, Color, String) | Inserts a LegendItem object with the specified text and symbol color into the collection at the specified location. |
![]() | Insert(Int32, String, String) | Inserts a LegendItem object with the specified text and symbol image into the collection at the specified location. |
![]() | InsertItem | Inserts an element into the Collection<T> at the specified index location. (Inherited from ChartElementCollection<T>.) |
![]() | Invalidate | Forces the invalidation of the parent chart element. (Inherited from ChartElementCollection<T>.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Remove | Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.) |
![]() | RemoveAt | Removes the element at the specified index of the Collection<T>. (Inherited from Collection<T>.) |
![]() | RemoveItem | Removes the element at the specified index location of the Collection<T>. (Inherited from ChartElementCollection<T>.) |
![]() | ResumeUpdates | Resumes the invalidation of a chart element in the collection. (Inherited from ChartElementCollection<T>.) |
![]() | Reverse | Reverses the order of items in the collection. |
![]() | SetItem | Replaces the element at the specified index location. (Inherited from ChartElementCollection<T>.) |
![]() | SuspendUpdates | Suspends the invalidation of a chart element in the collection. (Inherited from ChartElementCollection<T>.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection::CopyTo | Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.) |
![]() ![]() | ICollection<T>::IsReadOnly | Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.) |
![]() ![]() | ICollection::IsSynchronized | Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.) |
![]() ![]() | ICollection::SyncRoot | Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.) |
![]() ![]() | IEnumerable::GetEnumerator | Returns an enumerator that iterates through a collection. (Inherited from Collection<T>.) |
![]() ![]() | IList::Add | Adds an item to the IList. (Inherited from Collection<T>.) |
![]() ![]() | IList::Contains | Determines whether the IList contains a specific value. (Inherited from Collection<T>.) |
![]() ![]() | IList::IndexOf | Determines the index of a specific item in the IList. (Inherited from Collection<T>.) |
![]() ![]() | IList::Insert | Inserts an item into the IList at the specified index. (Inherited from Collection<T>.) |
![]() ![]() | IList::IsFixedSize | Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.) |
![]() ![]() | IList::IsReadOnly | Gets a value indicating whether the IList is read-only. (Inherited from Collection<T>.) |
![]() ![]() | IList::Item | Gets or sets the element at the specified index. (Inherited from Collection<T>.) |
![]() ![]() | IList::Remove | Removes the first occurrence of a specific object from the IList. (Inherited from Collection<T>.) |
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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

