Dundas Chart for ASP.NET
LegendItemsCollection Class
Members  See Also  Send comments on this topic.
Dundas.Charting.WebControl Namespace : LegendItemsCollection Class


This represents a collection of LegendItem objects.


LegendItemsCollection class is a strongly typed collection of legend items.

Object Model

Syntax

Visual Basic (Declaration)  
Public Class LegendItemsCollection 
Visual Basic (Usage) Copy Code
Dim instance As LegendItemsCollection
C#  
public class LegendItemsCollection 

Remarks

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

This collection class is used in two ways:

  • It is exposed as the CustomItems object property of the Legend object, and allows for the addition, deletion, etc. of custom legend items. The term "custom" refers to legend items that have user defined text, symbol color, etc. as opposed to "default" legend items that are automatically inserted into the legend and represent a data series or point (default legend entries of pie and doughnut charts represent the plotted data points, while entries for all other chart types represent the plotted Series ). The CustomItems property is available at both design-time and run-time.
     
  • It is also exposed in the CustomizeLegend event (Enterprise Edition only) as the LegendItems property of the CustomizeLegendEventArgs parameter. This LegendItems property stores both the "default" legend items and the "custom" legend items that have been added to the control at design-time. Legend items can be modified or deleted, and in addition their order can be changed.    

For further discussion concerning "custom" and "default" legend items see the Default Legend Entries and Custom Legend Entries topics.

Legend items can be added using the overloaded Add and Insert methods.

Inheritance Hierarchy

System.Object
   Dundas.Charting.WebControl.LegendItemsCollection

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Copyright © 2001 - 2009 Dundas Data Visualization, Inc. and others.