MapLegendBase Class

The base class for all legends that can be used in the Map control.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v20.2.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public abstract class MapLegendBase :
    MapDisposableObject,
    IOwnedElement,
    IMapStyleOwner,
    ILegend,
    IUpdateSupportItem

VB.NET

Public MustInherit Class MapLegendBase
    Inherits MapDisposableObject
    Implements IOwnedElement,
               IMapStyleOwner,
               ILegend,
               IUpdateSupportItem

Related API Members

The following members return MapLegendBase objects:

• LegendItemCreatingEventArgs.Legend
• MapLegendHitInfo.Legend

Remarks

The MapLegendBase class implements basic functionality common to all legends.

For instance, it implements the MapLegendBase.Alignment property, which defines how a legend is aligned within a map; as well as the MapLegendBase.Header and MapLegendBase.Description properties, which define additional text displayed on a legend. To control the visibility of a legend, use its MapLegendBase.Visibility property.

For more information, refer to Legends.

Inheritance

Object

MapDisposableObject

MapLegendBase

DataProviderLegend

ColorLegendBase

ColorListLegend

ColorScaleLegend

ItemsLayerLegend

SizeLegend