LegendAlignment Enum

Contains values that specify how a map legend is aligned.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public enum LegendAlignment

VB.NET

Public Enum LegendAlignment

Members

Name	Description
TopLeft	The legend is vertically aligned at the top and horizontally aligned on the left.
TopCenter	The legend is vertically aligned at the top and horizontally aligned in the center.
TopRight	The legend is vertically aligned at the top and horizontally aligned on the right.
MiddleLeft	The legend is vertically centered and horizontally aligned on the left.
MiddleRight	The legend is vertically centered and horizontally aligned on the right.
BottomLeft	The legend is vertically aligned at the bottom and horizontally aligned on the left.
BottomCenter	The legend is vertically aligned at the bottom and horizontally aligned in the center.
BottomRight	The legend is vertically aligned at the bottom and horizontally aligned on the right.

Related API Members

The following properties accept/return LegendAlignment values:

• MapLegendBase.Alignment

Remarks

Values listed by the LegendAlignment enumeration are used to set the MapLegendBase.Alignment property.

Related GitHub Examples

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

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

private void Form1_Load(object sender, EventArgs e) {
    legend = new ColorListLegend() { Alignment = LegendAlignment.TopRight };
    legend.CustomItems.Add(new ColorLegendItem() {

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

    ImageList = mapControl.ImageList,
    Alignment = LegendAlignment.TopRight
};

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

legend.Header = null;
legend.Alignment = LegendAlignment.BottomRight;
legend.ItemStyle.Font = new Font(Appearance.Font.FontFamily, 8);

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

legend.Header = null;
legend.Alignment = LegendAlignment.BottomRight;
legend.ItemStyle.Font = new Font(Appearance.Font.FontFamily, 8);

VB.NET

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

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"})

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"})