ColorListLegend.SortOrder Property

Gets or sets the sort order of the color list legend items.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.2.dll

Declaration

C#

[DefaultValue(LegendItemsSortOrder.Descending)]
public LegendItemsSortOrder SortOrder { get; set; }

VB.NET

<DefaultValue(LegendItemsSortOrder.Descending)>
Public Property SortOrder As LegendItemsSortOrder

Property Value

Type	Default	Description
LegendItemsSortOrder	**Descending**	A LegendItemsSortOrder enumeration value, specifying the color list items sort order.

Available values:

Name	Description
Ascending	Specifies an ascending sorting order. It means that the first added item will be at top of the legend.
Descending	Specifies a descending sorting order. It means that the last added item will be at top of the legend.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-change-an-order-of-color-list-legend-items-t202594

Form1.cs

using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraMap;

namespace ColorListLegend_SortOrder {
    public partial class Form1 : Form {
        ColorListLegend legend;

        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            legend = new ColorListLegend() { Alignment = LegendAlignment.TopRight };
            legend.CustomItems.Add(new ColorLegendItem() { 
                Color = Color.Orange, 
                Text = "First color" 
            });
            legend.CustomItems.Add(new ColorLegendItem() {
                Color = Color.LightGray,
                Text = "Second color"
            });
            legend.CustomItems.Add(new ColorLegendItem() {
                Color = Color.Coral,
                Text = "Third color"
            });
            mapControl.Legends.Add(legend);

            lbSortOrder.DataSource = Enum.GetValues(typeof(LegendItemsSortOrder));
        }

        private void lbSortOrder_SelectedIndexChanged(object sender, EventArgs e) {
            legend.SortOrder = (LegendItemsSortOrder)lbSortOrder.SelectedValue;
        }
    }
}

Form1.vb

Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraMap

Namespace ColorListLegend_SortOrder
    Partial Public Class Form1
        Inherits Form

        Private legend As ColorListLegend

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            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"})
            legend.CustomItems.Add(New ColorLegendItem() With {.Color = Color.Coral, .Text = "Third color"})
            mapControl.Legends.Add(legend)

            lbSortOrder.DataSource = System.Enum.GetValues(GetType(LegendItemsSortOrder))
        End Sub

        Private Sub lbSortOrder_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) Handles lbSortOrder.SelectedIndexChanged
            legend.SortOrder = DirectCast(lbSortOrder.SelectedValue, LegendItemsSortOrder)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SortOrder property.

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#L34

private void lbSortOrder_SelectedIndexChanged(object sender, EventArgs e) {
    legend.SortOrder = (LegendItemsSortOrder)lbSortOrder.SelectedValue;
}

VB.NET

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

Private Sub lbSortOrder_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) Handles lbSortOrder.SelectedIndexChanged
    legend.SortOrder = DirectCast(lbSortOrder.SelectedValue, LegendItemsSortOrder)
End Sub