LocationInformation Class

Contains information about a specific location on a map.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class LocationInformation

VB.NET

Public Class LocationInformation

Related API Members

The following members accept/return LocationInformation objects:

• BingRouteLeg.EndLocation
• BingRouteLeg.StartLocation

Example

To manually generate map items for received GIS data, do the following.

• Set the InformationDataProviderBase.GenerateLayerItems property to false.
• Handle the Geocode data received event of the Bing geocode data provider (BingGeocodeDataProvider.LocationInformationReceived).
• In the event handler, implement map item generation based on information stored in the GeocodeRequestResult.Locations array of LocationInformation objects.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-manually-generate-map-items-for-received-gis-data-t188443

Form1.cs

using DevExpress.XtraMap;
using System.Windows.Forms;

namespace WinForms_MapControl_InformationLayer {
    public partial class Form1 : Form {
        InformationLayer GeocodeLayer { get { return (InformationLayer)mapControl1.Layers["GeocodeLayer"]; } }
        BingGeocodeDataProvider GeocodeProvider { get { return (BingGeocodeDataProvider)GeocodeLayer.DataProvider; } }

        public Form1() {
            InitializeComponent();
            GeocodeProvider.LocationInformationReceived += GeocodeProvider_LocationInformationReceived;
        }

        void GeocodeProvider_LocationInformationReceived(object sender, LocationInformationReceivedEventArgs e) {
            if ((e.Cancelled) && (e.Result.ResultCode != RequestResultCode.Success)) return;

            GeocodeLayer.Data.Items.Clear();
            foreach (LocationInformation locationInformation in e.Result.Locations)
                GeocodeLayer.Data.Items.Add(new MapCallout() {
                    Location = locationInformation.Location,
                    Text = locationInformation.DisplayName
                });
        }
    }
}

Program.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WinForms_MapControl_InformationLayer {
    static class Program {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main() {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new Form1());
        }
    }
}

Program.vb

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Threading.Tasks
Imports System.Windows.Forms

Namespace WinForms_MapControl_InformationLayer
    Friend NotInheritable Class Program

        Private Sub New()
        End Sub

        ''' <summary>
        ''' The main entry point for the application.
        ''' </summary>
        <STAThread> _
        Shared Sub Main()
            Application.EnableVisualStyles()
            Application.SetCompatibleTextRenderingDefault(False)
            Application.Run(New Form1())
        End Sub
    End Class
End Namespace

Form1.vb

Imports DevExpress.XtraMap
Imports System.Windows.Forms

Namespace WinForms_MapControl_InformationLayer
    Partial Public Class Form1
        Inherits Form

        Private ReadOnly Property GeocodeLayer() As InformationLayer
            Get
                Return CType(mapControl1.Layers("GeocodeLayer"), InformationLayer)
            End Get
        End Property
        Private ReadOnly Property GeocodeProvider() As BingGeocodeDataProvider
            Get
                Return CType(GeocodeLayer.DataProvider, BingGeocodeDataProvider)
            End Get
        End Property

        Public Sub New()
            InitializeComponent()
            AddHandler GeocodeProvider.LocationInformationReceived, AddressOf GeocodeProvider_LocationInformationReceived
        End Sub

        Private Sub GeocodeProvider_LocationInformationReceived(ByVal sender As Object, ByVal e As LocationInformationReceivedEventArgs)
            If (e.Cancelled) AndAlso (e.Result.ResultCode <> RequestResultCode.Success) Then
                Return
            End If

            GeocodeLayer.Data.Items.Clear()
            For Each locationInformation As LocationInformation In e.Result.Locations
                GeocodeLayer.Data.Items.Add(New MapCallout() With {.Location = locationInformation.Location, .Text = locationInformation.DisplayName})
            Next locationInformation
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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-search-provider-t436085/CS/CustomSearchProvider/Form1.cs#L17

protected new SearchData Data { get { return (SearchData)base.Data; } }
public IEnumerable<LocationInformation> Addresses { get { return Data.Addresses; } }
protected override IInformationData CreateData() {

how-to-implement-a-route-calculator-using-gis-providers-t187741/CS/WinForms_MapControl_GIS/Form1.cs#L43

#region #GenerateItems
void GenerateItems(IEnumerable<LocationInformation> locations) {
    UpdateStorage();

how-to-implement-a-custom-geocode-provider-t516070/CS/CustomGeocodeProvider/Form1.cs#L33

public class GeocodeData : IInformationData {
    LocationInformation address = new LocationInformation();
    public LocationInformation Address { get { return address; } set { address = value; } }

how-to-perform-the-search-operation-for-multiple-locations-t546604/CS/GetSearchLocationAdditionalInfo/Form1.cs#L48

if (result.ResultCode == RequestResultCode.Success) {
    List<LocationInformation> regions = result.SearchResults;
    foreach (LocationInformation region in regions) {

how-to-get-additional-search-results-using-the-bing-map-search-service-e5066/CS/GetSearchLocationAdditionalInfo/Form1.cs#L51

int resCounter = 1;
foreach (LocationInformation resultInfo in requestResult.SearchResults) {
    resultList.Append(String.Format("\n Result {0}:  \n", resCounter));

VB.NET

how-to-implement-a-custom-search-provider-t436085/VB/CustomSearchProvider/Form1.vb#L31

Private ReadOnly Property Addresses As IEnumerable(Of LocationInformation) Implements ISearchPanelRequestSender.Addresses
    Get

how-to-implement-a-custom-geocode-provider-t516070/VB/CustomGeocodeProvider/Form1.vb#L50

Private address_Renamed As New LocationInformation()
Public Property Address() As LocationInformation

how-to-perform-the-search-operation-for-multiple-locations-t546604/VB/GetSearchLocationAdditionalInfo/Form1.vb#L47

If result.ResultCode = RequestResultCode.Success Then
    Dim regions As List(Of LocationInformation) = result.SearchResults

how-to-implement-a-route-calculator-using-gis-providers-t187741/VB/WinForms_MapControl_GIS/Form1.vb#L79

#Region "#GenerateItems"
Private Sub GenerateItems(ByVal locations As IEnumerable(Of LocationInformation))
    UpdateStorage()

how-to-get-additional-search-results-using-the-bing-map-search-service-e5066/VB/GetSearchLocationAdditionalInfo/Form1.vb#L53

Dim resCounter As Integer = 1
For Each resultInfo As LocationInformation In requestResult.SearchResults
    resultList.Append(String.Format(ControlChars.Lf & " Result {0}:  " & ControlChars.Lf, resCounter))

Inheritance

Object

LocationInformation

BingLocationInformation