MapOverlayItemBase.Alignment Property

Gets or sets the alignment of the overlay item.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v23.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

[DefaultValue(ContentAlignment.TopLeft)]
public ContentAlignment Alignment { get; set; }

VB.NET

<DefaultValue(ContentAlignment.TopLeft)>
Public Property Alignment As ContentAlignment

Property Value

Type	Default	Description
ContentAlignment	TopLeft	A ContentAlignment enumeration value.

Remarks

You can use this property to align two or more items within the overlay. Note that, the overlay does not consider the item’s Alignment property then the Location property is set.

Example

This example demonstrates how to implement a map overlay that looks like a button with an icon:

C#

// In the Form_Load event handler.
MapOverlay overlay = CreateButtonLikeOverlay(
    image: LoadOkIconFromResources(),
    text: "OK"
);
overlay.Alignment = ContentAlignment.TopLeft;
overlay.Margin = new Padding(16);
mapControl1.Overlays.Add(overlay);
// ...

private MapOverlay CreateButtonLikeOverlay(Image image, String text) {
    MapOverlay overlay = new MapOverlay();
    overlay.Padding = new Padding(8);
    overlay.Items.Add(new MapOverlayTextItem {
        Text = text,
        Alignment = ContentAlignment.MiddleRight
    });
    overlay.Items.Add(new MapOverlayImageItem {
        Image = image,
        Alignment = ContentAlignment.MiddleLeft
    });
    return overlay;
}

VB

' In the Form_Load event handler.
Dim Resources As ComponentResourceManager = New ComponentResourceManager(GetType(Form1))
Dim overlay As MapOverlay = CreateButtonLikeOverlay(
    image:=LoadOkIconFromResources(),
    text:="OK"
)
overlay.Alignment = ContentAlignment.TopLeft
overlay.Margin = new Padding(16)
MapControl1.Overlays.Add(overlay)
' ...

Private Function CreateButtonLikeOverlay(image As Image, text As String) As MapOverlay
    Dim overlay As MapOverlay = New MapOverlay()
    overlay.Padding = new Padding(8)
    overlay.Items.Add(New MapOverlayTextItem() With {
        .Text = text,
        .Alignment = ContentAlignment.MiddleRight
    })
    overlay.Items.Add(New MapOverlayImageItem With {
        .Image = image,
        .Alignment = ContentAlignment.MiddleLeft
    })
    Return overlay
End Function