MapLegendBase Class

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

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#
VB.NET

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

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

The following members accept/return MapLegendBase objects:

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.

The following code snippets (auto-collected from DevExpress Examples) contain references to the MapLegendBase class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#
VB.NET

how-to-color-manually-added-shapes-using-the-choropleth-colorizer-e4744/CS/Manual Colorization/Form1.cs#L107


private MapLegendBase CreateLegend(MapItemsLayerBase layer) {
    ColorScaleLegend legend = new ColorScaleLegend();

how-to-colorize-map-contours-loaded-from-shapefiles-using-the-choropleth-colorizer-e4691/CS/XtraMap_ShapefileDataAdapter/Form1.cs#L74

#region #CreateLegend
private MapLegendBase CreateLegend(MapItemsLayerBase layer) {
    // Create a color scale legend.

how-to-customize-mini-map-layers-t201418/CS/MiniMapLayers/Form1.cs#L60

#region #ColorListLegend
MapLegendBase CreateLegend() {
    ColorListLegend legend = new ColorListLegend() {

how-to-color-manually-added-shapes-using-the-choropleth-colorizer-e4744/VB/Manual Colorization/Form1.vb#L94


Private Function CreateLegend(ByVal layer As MapItemsLayerBase) As MapLegendBase
    Dim legend As New ColorScaleLegend()

how-to-colorize-map-contours-loaded-from-shapefiles-using-the-choropleth-colorizer-e4691/VB/XtraMap_ShapefileDataAdapter/Form1.vb#L77

#Region "#CreateLegend"
Private Function CreateLegend(ByVal layer As MapItemsLayerBase) As MapLegendBase
    ' Create a color scale legend.

how-to-customize-mini-map-layers-t201418/VB/MiniMapLayers/Form1.vb#L58

#Region "#ColorListLegend"
Private Function CreateLegend() As MapLegendBase
    Dim legend As New ColorListLegend() With {.ImageList = mapControl.ImageList, .Alignment = LegendAlignment.TopRight}