ShapeTitleOptions.Pattern Property

Gets or sets the pattern for shape titles.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.1.dll

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:

Show 11 property paths

Object Type	Path to Pattern
MapBubble	.TitleOptions.Pattern
MapDot	.TitleOptions.Pattern
MapEllipse	.TitleOptions.Pattern
MapLine	.TitleOptions.Pattern
MapPath	.TitleOptions.Pattern
MapPathBase<T>	.TitleOptions.Pattern
MapPie	.TitleOptions.Pattern
MapPolygon	.TitleOptions.Pattern
MapPolyline	.TitleOptions.Pattern
MapRectangle	.TitleOptions.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 - allows customizing the Pattern used to display a title.
• ShapeTitleOptions.TextColor - allows customizing the title text color.
• ShapeTitleOptions.TextGlowColor - allows customizing the title text glowing color.
• ShapeTitleOptions.Visibility - allows specifying the title visibility.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-shape-title-options-t202086

Form1.cs

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

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 snippets (auto-collected from DevExpress Examples) contain references 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#

how-to-customize-shape-title-options-t202086/CS/ShapeTitleOptions/Form1.cs#L23

dot.TitleOptions.TextGlowColor = Color.Black;
dot.TitleOptions.Pattern = "{Title}";

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

dot.ClusteredItems = objects;
dot.TitleOptions.Pattern = objects.Count.ToString();
return dot;

VB.NET

how-to-customize-shape-title-options-t202086/VB/ShapeTitleOptions/Form1.vb#L23

dot.TitleOptions.TextGlowColor = Color.Black
dot.TitleOptions.Pattern = "{Title}"

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

dot.ClusteredItems = objects
dot.TitleOptions.Pattern = objects.Count.ToString()
Return dot