CustomizeLegendEventArgs Class (System.Web.UI.DataVisualization.Charting)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

CustomizeLegendEventArgs Class

Provides data for the CustomizeLegend event of the Chart control.

Inheritance Hierarchy

System.Object
System.EventArgs
System.Web.UI.DataVisualization.Charting.CustomizeLegendEventArgs

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

Syntax

Visual Basic

Public Class CustomizeLegendEventArgs _
	Inherits EventArgs

public class CustomizeLegendEventArgs : EventArgs

Visual C++

public ref class CustomizeLegendEventArgs : public EventArgs

type CustomizeLegendEventArgs =  
    class
        inherit EventArgs
    end

The CustomizeLegendEventArgs type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	LegendItems	Used 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.
	LegendName	Gets the name of the Legend object, which can be used to determine which legend was the sender of the CustomizeLegend event.

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

Version Information

.NET Framework

Supported in: 4

Platforms

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.

Thread Safety

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

Reference

System.Web.UI.DataVisualization.Charting Namespace