This documentation is archived and is not being maintained.

CustomizeLegendEventArgs Class

Provides data for the CustomizeLegend event of the Chart control.


Namespace:  System.Windows.Forms.DataVisualization.Charting
Assembly:  System.Windows.Forms.DataVisualization (in System.Windows.Forms.DataVisualization.dll)

public class CustomizeLegendEventArgs : EventArgs

The CustomizeLegendEventArgs type exposes the following members.

Public methodCustomizeLegendEventArgs(LegendItemsCollection)Initializes a new instance of the CustomizeLegendEventArgs class with the specified LegendItemsCollection.
Public methodCustomizeLegendEventArgs(LegendItemsCollection, String)Initializes a new instance of the CustomizeLegendEventArgs class with the specified LegendItemsCollection and legend name.

Public propertyLegendItemsUsed to remove, modify or change the order of both custom and default legend items in the CustomizeLegend event. Can also be used to add custom legend items.
Public propertyLegendNameGets the name of the Legend object, which can be used to determine which legend was the sender of the CustomizeLegend event.

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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The CustomizeLegendEventArgs class is used in the CustomizeLegend event.

There are only two properties in this class. The LegendItems property allows you to delete or modify both default and custom legend items, and to add custom legend items. This property can also be used to change the order of legend items.

The LegendName property is used to identify the legend that raised this event.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

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.

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