ShapeTitleOptions.Pattern Property

Gets or sets the pattern for shape titles.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

[DefaultValue("")]
public string Pattern { get; set; }

VB.NET

<DefaultValue("")>
Public Property Pattern As String

Property Value

Type	Default	Description
String	String.Empty	A String value.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Pattern
MapShape	.TitleOptions .Pattern

Remarks

This property allows specifying text displaying as a title of a vector item. Also it allows using attributes to show them inside the title.

Example

This example demonstrates how to customize shape title options. To do this, customize the required properties from the following list.

• ShapeTitleOptions.Pattern - specifies the Pattern used to construct title text.
• ShapeTitleOptions.TextColor - specifies the title text color.
• ShapeTitleOptions.TextGlowColor - specifies the glow color for the title text.
• ShapeTitleOptions.Visibility - specifies title visibility.

Form1.cs

using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraMap;
// ...
private void Form1_Load(object sender, System.EventArgs e) {
    MapItemStorage storage = new MapItemStorage();
    VectorItemsLayer layer = new VectorItemsLayer() {
        Data = storage
    };

    dot = new MapDot() { Size = 100 };
    dot.TitleOptions.TextColor = Color.Orange;
    dot.TitleOptions.TextGlowColor = Color.Black;
    dot.TitleOptions.Pattern = "{Title}";

    dot.Attributes.Add(new MapItemAttribute() { Name = "Title", Value = "Hello,\nI am Dot." });
    storage.Items.Add(dot);

    mapControl1.Layers.Add(layer);
}

Form1.vb

Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraMap
' ...
Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
    Dim storage As New MapItemStorage()
    Dim layer As New VectorItemsLayer() With {.Data = storage}

    dot = New MapDot() With {.Size = 100}
    dot.TitleOptions.TextColor = Color.Orange
    dot.TitleOptions.TextGlowColor = Color.Black
    dot.TitleOptions.Pattern = "{Title}"

    dot.Attributes.Add(New MapItemAttribute() With {.Name = "Title", .Value = "Hello," & ControlChars.Lf & "I am Dot."})
    storage.Items.Add(dot)

    mapControl1.Layers.Add(layer)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Pattern 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#

winforms-map-aggregate-vector-items-using-a-clusterer/CS/ClustererSample/Form1.cs#L60

public void CustomizeCluster(MapItem cluster) {
    ((MapDot)cluster).TitleOptions.Pattern = cluster.ClusteredItems.Count.ToString();
}

VB.NET

winforms-map-aggregate-vector-items-using-a-clusterer/VB/ClustererSample/Form1.vb#L62

Private Sub IClusterItemFactory_CustomizeCluster(cluster As MapItem) Implements IClusterItemFactory.CustomizeCluster
    CType(cluster, MapDot).TitleOptions.Pattern = cluster.ClusteredItems.Count.ToString()
End Sub