Skip to main content

ColorListLegend.SortOrder Property

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

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

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

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.

MapControl_ColorListLegend_SortingOrder_Ascending

Descending

Specifies a descending sorting order. It means that the last added item will be at top of the legend.

MapControl_ColorListLegend_SortingOrder_Descending

Example

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;
        }
    }
}
See Also