A newer version of this page is available. Switch to the current version.

LegendItemCreatingEventArgs Class

Provides data for the MapControl.LegendItemCreating event.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.1.dll

Declaration

public class LegendItemCreatingEventArgs :
    EventArgs
Public Class LegendItemCreatingEventArgs
    Inherits EventArgs

Remarks

The LegendItemCreatingEventArgs class introduces the LegendItemCreatingEventArgs.Index and LegendItemCreatingEventArgs.Item properties that provide information about the legend item; and the LegendItemCreatingEventArgs.Legend property that provides access to the legend.

Note that LegendItemCreatingEventArgs objects are automatically created, initialized and passed to the corresponding event handlers.

Examples

To manually customize legend items, implement the MapControl.LegendItemCreating event handler, where you can configure MapLegendItemBase descendant class objects as you wish.

The following instance demonstrates how to do this.

void map_LegendItemCreating(object sender, LegendItemCreatingEventArgs e) {
    e.Item.Text = String.Format("{0}$", e.Item.Value);
}

Inheritance

Object
EventArgs
LegendItemCreatingEventArgs
See Also