MapItemsLayerBase.ToolTipPattern Property

Gets or sets a string which represents the pattern specifying the text to be displayed within a tooltip.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	A System.String, which represents the tooltip pattern.

Remarks

The pattern string can contain placeholders that the Map Control replaces with specific values when generating tooltip text for a map item. The tooltip pattern supports the following groups of placeholders:

Attribute Placeholders

These placeholders define values of map item attributes and enclosed with braces (“{“, “}”). For example the “{NAME}: ${GDP_MD_EST:#,0}M” pattern utilizes two placeholders. The first placeholder is for the NAME attribute and the second placeholder is for the GDP_MD_EST attribute. Note that the second placeholder has the #,0 format string that goes after the “:” symbol.

Map Chart Value Placeholders

The Map Control uses this placeholder group to display map bubbles’ and map pies’ arguments and values in the tooltip. The “%” symbol encloses these placeholders. The following table lists available placeholders:

Placeholder	Placeholder’s meaning for Map Bubbles	Placeholder’s meaning for Map Pies
A	A map bubble’s argument.	Data objects’ PieChartDataAdapter.PieItemDataMember field value when the Pie Chart Data adapter generates map pies.
V	A map bubble’s value.	A map pie’s total value.
A<index>	Is not supported.	An argument of a map pie segment with the specified index.
V<index>	Is not supported.	A value of a map pie segment with the specified index.

For example, the “%A0%: %V0%\r\n%A1%: %V1%\r\n%A2%: %V2%” pattern generates the text that displays the first three segments’ arguments and values.

The chart value attributes with indices are useful when all map pies have a similar number of segments. You can use the ToolTip Controller to manage the tooltip’s content when map pies have various segment counts:

C#

private void Form1_Load(object sender, EventArgs e) {
    ToolTipController toolTipController = new ToolTipController();
    toolTipController.BeforeShow += OnBeforeShowToolTip;
    mapControl.ToolTipController = toolTipController;
}

private void OnBeforeShowToolTip(object sender, ToolTipControllerShowEventArgs e) {
    if (!(e.SelectedObject is MapPie mapPie)) return;
    e.Title = mapPie.Argument.ToString();
    e.ToolTip = BuildSegmentsTooltip(mapPie.Segments);
}

private string BuildSegmentsTooltip(PieSegmentCollection segments) {
    if (segments.Count == 0) return String.Empty;
    var segment = segments[0];
    var builder = new StringBuilder()
        .Append(segment.Argument)
        .Append(": ")
        .Append(segment.Value);
    for (int i = 1; i < segments.Count; i++) {
        segment = segments[i];
        builder.Append(Environment.NewLine)
               .Append(segment.Argument)
               .Append(": ")
               .Append(segment.Value);
    }
    return builder.ToString();
}

VB.NET

Private Sub Form1_Load(object sender, EventArgs e) {
    Dim toolTipController As ToolTipController = New ToolTipController()
    AddHandler toolTipController.BeforeShow AddressOf OnBeforeShowToolTip
    mapControl.ToolTipController = toolTipController
}

Private Sub OnBeforeShowToolTip(sender As Object, e As ToolTipControllerShowEventArgs)
    Dim mapPie As MapPie = TryCast(e.SelectedObject, MapPie)
    If (mapPie Is Nothing) Then Return
    e.Title = mapPie.Argument.ToString()
    e.ToolTip = BuildSegmentsTooltip(mapPie.Segments)
End Sub

Private Function BuildSegmentsTooltip(segments As PieSegmentCollection) As String
    If (segments.Count Is 0) Return String.Empty
    Dim segment = segments[0]
    Dim builder = New StringBuilder()
        .Append(segment.Argument)
        .Append(": ")
        .Append(segment.Value)
    For i As Integer = 1 To segments.Count
        segment = segments[i]
        builder.Append(Environment.NewLine)
               .Append(segment.Argument)
               .Append(": ")
               .Append(segment.Value)
    Next
    Return builder.ToString()
End Function

VB.NET

Private Sub Form1_Load(object sender, EventArgs e) {
    Dim toolTipController As ToolTipController = New ToolTipController()
    AddHandler toolTipController.BeforeShow AddressOf OnBeforeShowToolTip
    mapControl.ToolTipController = toolTipController
}

Private Sub OnBeforeShowToolTip(sender As Object, e As ToolTipControllerShowEventArgs)
    Dim mapPie As MapPie = TryCast(e.SelectedObject, MapPie)
    If (mapPie Is Nothing) Then Return
    e.Title = mapPie.Argument.ToString()
    e.ToolTip = BuildSegmentsTooltip(mapPie.Segments)
End Sub

Private Function BuildSegmentsTooltip(segments As PieSegmentCollection) As String
    If (segments.Count Is 0) Return String.Empty
    Dim segment = segments[0]
    Dim builder = New StringBuilder()
        .Append(segment.Argument)
        .Append(": ")
        .Append(segment.Value)
    For i As Integer = 1 To segments.Count
        segment = segments[i]
        builder.Append(Environment.NewLine)
               .Append(segment.Argument)
               .Append(": ")
               .Append(segment.Value)
    Next
    Return builder.ToString()
End Function

The code above utilizes the following classes and members:

Symbol	Description
ToolTipController	Provides tooltip management for individual controls.
ToolTipController.BeforeShow	Enables you to customize the text and settings of the tooltip before displaying it onscreen.
MapPie	The class used to draw a pie chart on a map.
MapPie.Argument	Gets or sets an object, which provides arguments for the MapPie.
MapPie.Segments	Gets or sets segments of a map pie.
PieSegment	A segment of a pie chart item.
PieSegment.Argument	Gets or sets an object, which provides arguments for the PieSegment.
PieSegment.Value	Gets or sets the value of the pie segment.

Example

Tip

The complete sample project is available on GitHub.

This example illustrates how to bind a Map control to data. This data is stored in an external XML file, which contains information about wrecked ships, including ship coordinates.

In this example, the map control automatically generates ship images based on data from the datasource, along with a description for each image in a tooltip.

To accomplish this task, do the following:

1. Create a ListSourceDataAdapter object and assign it to the VectorItemsLayer.Data property.
2. Create a data source (in this example, this is a data table object generated by the LoadData method) and assign it to the DataSourceAdapterBase.DataSource property of the data adapter.
3. To define names of data fields that contain information about latitude and longitude of vector items, specify appropriate values for MapItemMappingInfo.Latitude and MapItemMappingInfo.Longitude properties of the object, returned by the ListSourceDataAdapter.Mappings property.
4. After that, define the names of other data fields that provide additional information for generated vector items. Note that these data fields values are accessible via attributes - and so you should specify attribute mapping via the DataSourceAdapterBase.AttributeMappings object.

Also, this sample illustrates how to customize tooltips using the MapItemsLayerBase.ToolTipPattern property.

Note

If you run this sample as is, you will get a warning message saying that the specified Bing Maps key is invalid. To learn how to avoid this error, refer to the How to: Get a Bing Maps Key tutorial.

C#

// In the Form's constructor.
object data = LoadData(@"..\..\Data\Ships.xml");

// Create a vector layer.
map.Layers.Add(new VectorItemsLayer() {
    Data = CreateAdapter(data),
    ToolTipPattern = "<b>{Name} ({Year})</b> \r\n{Description}",
    ItemImageIndex = 0
});


// Creates an adapter for the map's vector layer.
private IMapDataAdapter CreateAdapter(object source) {
    ListSourceDataAdapter adapter = new ListSourceDataAdapter();

    adapter.DataSource = source;

    adapter.Mappings.Latitude = "Latitude";
    adapter.Mappings.Longitude = "Longitude";

    adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Name", Name = "Name" });
    adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Year", Name = "Year" });
    adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Description", Name = "Description" });

    return adapter;
}

// Loads data from a XML file.
private List<ShipwreckData> LoadData(string path) {
    return XDocument.Load(path).Element("Ships").Elements("Ship")
        .Select(e => new ShipwreckData(
            year: Convert.ToInt32(e.Element("Year").Value, CultureInfo.InvariantCulture),
            name: e.Element("Name").Value,
            description: e.Element("Description").Value,
            latitude: Convert.ToDouble(e.Element("Latitude").Value, CultureInfo.InvariantCulture),
            longitude: Convert.ToDouble(e.Element("Longitude").Value, CultureInfo.InvariantCulture)
        ))
        .ToList();
}

public class ShipwreckData {
    public int Year { get; }
    public string Name { get; }
    public string Description { get; }
    public double Latitude { get; }
    public double Longitude { get; }

    public ShipwreckData(int year, string name, string description, double latitude, double longitude) {
        this.Year = year;
        this.Name = name;
        this.Description = description;
        this.Latitude = latitude;
        this.Longitude = longitude;
    }
}

VB.NET

' In the Form's constructor.
Dim data As Object = LoadData("..\..\Data\Ships.xml")

' Create a vector layer.
map.Layers.Add(New VectorItemsLayer() With { _
    .Data = CreateAdapter(data), _
    .ToolTipPattern = "<b>{Name} ({Year})</b> " & ControlChars.CrLf & "{Description}", _
    .ItemImageIndex = 0 _
})


' Creates an adapter for the map's vector layer.
Private Function CreateAdapter(ByVal source As Object) As IMapDataAdapter
    Dim adapter As New ListSourceDataAdapter()

    adapter.DataSource = source

    adapter.Mappings.Latitude = "Latitude"
    adapter.Mappings.Longitude = "Longitude"

    adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Name", .Name = "Name"})
    adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Year", .Name = "Year"})
    adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Description", .Name = "Description"})

    Return adapter
End Function

' Loads data from a XML file.
Private Function LoadData(ByVal path As String) As List(Of ShipwreckData)
    Return XDocument.Load(path).Element("Ships").Elements("Ship") _
        .Select(Function(e) New ShipwreckData(
            year:=Convert.ToInt32(e.Element("Year").Value, CultureInfo.InvariantCulture),
            name:=e.Element("Name").Value,
            description:=e.Element("Description").Value,
            latitude:=Convert.ToDouble(e.Element("Latitude").Value, CultureInfo.InvariantCulture),
            longitude:=Convert.ToDouble(e.Element("Longitude").Value, CultureInfo.InvariantCulture)
        )) _
        .ToList()
End Function

Public Class ShipwreckData
    Public ReadOnly Property Year() As Integer
    Public ReadOnly Property Name() As String
    Public ReadOnly Property Description() As String
    Public ReadOnly Property Latitude() As Double
    Public ReadOnly Property Longitude() As Double

    Public Sub New(ByVal year As Integer, ByVal name As String, ByVal description As String, ByVal latitude As Double, ByVal longitude As Double)
        Me.Year = year
        Me.Name = name
        Me.Description = description
        Me.Latitude = latitude
        Me.Longitude = longitude
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ToolTipPattern 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-implement-a-custom-colorizer-e4753/CS/CustomColorizer/Form1.cs#L33

// Specify the tooltip content.
itemsLayer.ToolTipPattern = "{" + powerAttrName + "}";

VB.NET

how-to-implement-a-custom-colorizer-e4753/VB/CustomColorizer/Form1.vb#L35

' Specify the tooltip content.
itemsLayer.ToolTipPattern = "{" & powerAttrName & "}"