ColorListLegend Class

Represents a color legend as a list of colors.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class ColorListLegend :
    ColorLegendBase,
    IImageCollectionHelper

VB.NET

Public Class ColorListLegend
    Inherits ColorLegendBase
    Implements IImageCollectionHelper

Remarks

To show this legend on a map, create an instance of the ColorListLegend class and add it to the MapControl.Legends. Then, specify the ItemsLayerLegend.Layer property of the instance. Note that a layer assigned to the legend should contain a colorizer.

The following image shows an instance of Color List Legend.

For more information, refer to Legends.

Example

To add a color legend listing the colors on the Map, create an instance of the ColorListLegend class and specify its ItemsLayerLegend.Layer property. Optionally, specify MapLegendBase.Header, MapLegendBase.Description and other properties.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-colorize-a-cartesian-map-using-a-key-color-colorizer-t176227

Form1.cs

// Add a legend to the map.
map.Legends.Add(new ColorListLegend() {
    Header = "Room Type",
    Layer = hotelLayer
});

Form1.vb

' Add a legend to the map.
map.Legends.Add(New ColorListLegend() With {.Header = "Room Type", .Layer = hotelLayer})

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ColorListLegend 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#

how-to-change-an-order-of-color-list-legend-items-t202594/CS/ColorListLegend_SortOrder/Form1.cs#L8

public partial class Form1 : Form {
    ColorListLegend legend;

how-to-colorize-a-cartesian-map-using-a-key-color-colorizer-t176227/CS/WinForms_MapControl_KeyColorColorizer/Form1.cs#L36

// Add a legend to the map.
map.Legends.Add(new ColorListLegend() {
    Header = "Room Type",

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

MapLegendBase CreateLegend() {
    ColorListLegend legend = new ColorListLegend() {
        ImageList = mapControl.ImageList,

how-to-manually-add-mapbubble-items-to-the-map-t116230/CS/MapBubbleItem/Form1.cs#L21

    // Show a color legend.
    mapControl1.Legends.Add(new ColorListLegend() { Layer = itemsLayer });
}

how-to-manually-add-mappie-items-to-the-map-t116241/CS/MapPieItem/Form1.cs#L21

    // Show a color legend.
    mapControl1.Legends.Add(new ColorListLegend() { Layer = itemsLayer });
}

VB.NET

how-to-change-an-order-of-color-list-legend-items-t202594/VB/ColorListLegend_SortOrder/Form1.vb#L10

Private legend As ColorListLegend

how-to-colorize-a-cartesian-map-using-a-key-color-colorizer-t176227/VB/WinForms_MapControl_KeyColorColorizer/Form1.vb#L29

            ' Add a legend to the map.
            map.Legends.Add(New ColorListLegend() With {.Header = "Room Type", .Layer = hotelLayer})
'            #End Region ' #AddLegend

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

Private Function CreateLegend() As MapLegendBase
    Dim legend As New ColorListLegend() With {.ImageList = mapControl.ImageList, .Alignment = LegendAlignment.TopRight}
    legend.CustomItems.Add(New ColorLegendItem() With {.ImageIndex = 0, .Text = "Shipwreck Location"})

how-to-manually-add-mapbubble-items-to-the-map-t116230/VB/MapBubbleItem/Form1.vb#L20

    ' Show a color legend.
    mapControl1.Legends.Add(New ColorListLegend() With {.Layer = itemsLayer})
End Sub

how-to-manually-add-mappie-items-to-the-map-t116241/VB/MapPieItem/Form1.vb#L20

    ' Show a color legend.
    mapControl1.Legends.Add(New ColorListLegend() With {.Layer = itemsLayer})
End Sub

Inheritance

Object

MapDisposableObject

MapLegendBase

DataProviderLegend

ItemsLayerLegend

ColorLegendBase

ColorListLegend