LegendItemsCollection Class

Definition

Represents a collection of LegendItem objects.

public ref class LegendItemsCollection : System::Web::UI::DataVisualization::Charting::ChartElementCollection<System::Web::UI::DataVisualization::Charting::LegendItem ^>
public class LegendItemsCollection : System.Web.UI.DataVisualization.Charting.ChartElementCollection<System.Web.UI.DataVisualization.Charting.LegendItem>
type LegendItemsCollection = class
    inherit ChartElementCollection<LegendItem>
Public Class LegendItemsCollection
Inherits ChartElementCollection(Of LegendItem)
Inheritance

Remarks

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.

Properties

Count

Gets the number of elements actually contained in the Collection<T>.

(Inherited from Collection<T>)
Item[Int32]

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>)

Methods

Add(Color, String)

Adds a custom LegendItem object with the specified text and symbol color to the end of the collection.

Add(String, String)

Adds a custom LegendItem object with the specified image to the end of the collection.

Add(T)

Adds an object to the end of the Collection<T>.

(Inherited from Collection<T>)
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(T)

Determines whether an element is in the Collection<T>.

(Inherited from Collection<T>)
CopyTo(T[], Int32)

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)
GetEnumerator()

Returns an enumerator that iterates through the Collection<T>.

(Inherited from Collection<T>)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IndexOf(T)

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, 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.

Insert(Int32, T)

Inserts an element into the Collection<T> at the specified index.

(Inherited from Collection<T>)
InsertItem(Int32, T)

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(T)

Removes the first occurrence of a specific object from the Collection<T>.

(Inherited from Collection<T>)
RemoveAt(Int32)

Removes the element at the specified index of the Collection<T>.

(Inherited from Collection<T>)
RemoveItem(Int32)

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(Int32, T)

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)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

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

(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>)
ICollection<T>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

(Inherited from Collection<T>)
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

(Inherited from Collection<T>)
IList.Add(Object)

Adds an item to the IList.

(Inherited from Collection<T>)
IList.Contains(Object)

Determines whether the IList contains a specific value.

(Inherited from Collection<T>)
IList.IndexOf(Object)

Determines the index of a specific item in the IList.

(Inherited from Collection<T>)
IList.Insert(Int32, Object)

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[Int32]

Gets or sets the element at the specified index.

(Inherited from Collection<T>)
IList.Remove(Object)

Removes the first occurrence of a specific object from the IList.

(Inherited from Collection<T>)

Extension Methods

CopyToDataTable<T>(IEnumerable<T>)

Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)

Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)

Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Enables parallelization of a query.

AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Ancestors<T>(IEnumerable<T>)

Returns a collection of elements that contains the ancestors of every node in the source collection.

Ancestors<T>(IEnumerable<T>, XName)

Returns a filtered collection of elements that contains the ancestors of every node in the source collection. Only elements that have a matching XName are included in the collection.

DescendantNodes<T>(IEnumerable<T>)

Returns a collection of the descendant nodes of every document and element in the source collection.

Descendants<T>(IEnumerable<T>)

Returns a collection of elements that contains the descendant elements of every element and document in the source collection.

Descendants<T>(IEnumerable<T>, XName)

Returns a filtered collection of elements that contains the descendant elements of every element and document in the source collection. Only elements that have a matching XName are included in the collection.

Elements<T>(IEnumerable<T>)

Returns a collection of the child elements of every element and document in the source collection.

Elements<T>(IEnumerable<T>, XName)

Returns a filtered collection of the child elements of every element and document in the source collection. Only elements that have a matching XName are included in the collection.

InDocumentOrder<T>(IEnumerable<T>)

Returns a collection of nodes that contains all nodes in the source collection, sorted in document order.

Nodes<T>(IEnumerable<T>)

Returns a collection of the child nodes of every document and element in the source collection.

Remove<T>(IEnumerable<T>)

Removes every node in the source collection from its parent node.

Applies to