ColorLegendItem Class

An item that stores information about the color and description of the ColorLegendBase class descendants.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class ColorLegendItem :
    MapLegendItemBase

VB.NET

Public Class ColorLegendItem
    Inherits MapLegendItemBase

Example

To use images in a legend, do the following.

1. Assign the image storage to the ColorListLegend.ImageList property.
2. Add several ColorLegendItem objects with the specified ColorLegendItem.ImageIndex property to the ColorListLegend.CustomItems collection.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/xtramap-getting-started-lesson-3-binding-a-map-control-to-data-loaded-from-xml-e4687

Form1.cs

    object data = LoadData(xmlFilepath);

    // Create a map and data for it.
    MapControl map = new MapControl() {
        CenterPoint = new GeoPoint(-37.2, 143.2),
        ZoomLevel = 5,
        Dock = DockStyle.Fill,
        ToolTipController = new ToolTipController() { AllowHtmlText = true },
        ImageList = LoadImage(imageFilepath)
    };
    this.Controls.Add(map);
    //Create a Legend containing images.
    ColorListLegend legend = new ColorListLegend();
    legend.ImageList = map.ImageList;
    legend.CustomItems.Add(new ColorLegendItem() { ImageIndex = 0, Text = "Shipwreck" });
    map.Legends.Add(legend);
// Loads an image to an image collection.
private ImageCollection LoadImage(string path) {
    ImageCollection imageCollection = new ImageCollection();
    Bitmap image = new Bitmap(path);
    imageCollection.ImageSize = new Size(50, 50);
    imageCollection.Images.Add(image);
    return imageCollection;
}

Form1.vb

    Dim data As Object = LoadData(xmlFilepath)

    ' Create a map and data for it.
    Dim map As New MapControl() With {.CenterPoint = New GeoPoint(-37.2, 143.2), .ZoomLevel = 5, .Dock = DockStyle.Fill, .ToolTipController = New ToolTipController() With {.AllowHtmlText = True}, .ImageList = LoadImage(imageFilepath)}
    Me.Controls.Add(map)
    'Create a Legend containing images.
    Dim legend As New ColorListLegend()
    legend.ImageList = map.ImageList
    legend.CustomItems.Add(New ColorLegendItem() With {.ImageIndex = 0, .Text = "Shipwreck"})
    map.Legends.Add(legend)
' Loads an image to an image collection.
Private Function LoadImage(ByVal path As String) As ImageCollection
    Dim imageCollection As New ImageCollection()
    Dim image As New Bitmap(path)
    imageCollection.ImageSize = New Size(50, 50)
    imageCollection.Images.Add(image)
    Return imageCollection
End Function

Related GitHub Examples

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

vote-app-t445500/CS/VoteApp/Map.cs#L70

legend.CustomItems.Add(new ColorLegendItem() { Color = HSLColor.Darken(dem, 0.5), Text = "85% +" });
legend.CustomItems.Add(new ColorLegendItem() { Color = HSLColor.Darken(dem, 0.8), Text = "70%..85%" });

vote-applications-t446758/CS/VoteApp/Map.cs#L69

legend.CustomItems.Add(new ColorLegendItem() { Color = HSLColor.Darken(dem, 0.5), Text = "85% +" });
legend.CustomItems.Add(new ColorLegendItem() { Color = HSLColor.Darken(dem, 0.8), Text = "70%..85%" });

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

legend = new ColorListLegend() { Alignment = LegendAlignment.TopRight };
legend.CustomItems.Add(new ColorLegendItem() {
    Color = Color.Orange,

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

};
legend.CustomItems.Add(new ColorLegendItem() {
    ImageIndex = 0,

xtramap-getting-started-lesson-3-binding-a-map-control-to-data-loaded-from-xml-e4687/CS/WinForms_MapControl_ListAdapter/Form1.cs#L66

legend.ImageList = map.ImageList;
legend.CustomItems.Add(new ColorLegendItem() { ImageIndex = 0, Text = "Shipwreck" });
map.Legends.Add(legend);

VB.NET

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

legend = New ColorListLegend() With {.Alignment = LegendAlignment.TopRight}
legend.CustomItems.Add(New ColorLegendItem() With {.Color = Color.Orange, .Text = "First color"})
legend.CustomItems.Add(New ColorLegendItem() With {.Color = Color.LightGray, .Text = "Second color"})

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

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

xtramap-getting-started-lesson-3-binding-a-map-control-to-data-loaded-from-xml-e4687/VB/WinForms_MapControl_ListAdapter/Form1.vb#L66

legend.ImageList = map.ImageList
legend.CustomItems.Add(New ColorLegendItem() With { _
    .ImageIndex = 0, _

Inheritance

Object

MapLegendItemBase

ColorLegendItem