BingTrafficIncidentResult.Description Property

Returns the incident description.

Namespace: DevExpress.Xpf.Map

Assembly: DevExpress.Xpf.Map.v24.2.dll

NuGet Package: DevExpress.Wpf.Map

Declaration

C#

public string Description { get; }

VB.NET

Public ReadOnly Property Description As String

Property Value

Type	Description
String	A string value that contains the incident description.

Example

How to: Obtain and Display a List of Traffic Incidents

This example obtains a list of incidents in the specified area from the Bing Maps service and displays information about obtained incidents in a TextEdit control.

• Create an InformationLayer object and add it to the MapControl.Layers collection.

• Initialize the layer’s DataProvider property with a BingTrafficIncidentDataProvider object.

• Specify the provider’s BingKey property.

• Call the provider’s RequestTrafficIncidents method to receive a list of incidents.

• Handle the provider’s TrafficIncidentCalculated event to access the list of incidents and display incident-related information in a TextEdit control.

XAML

<Window xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:TrafficIncidents"
        xmlns:dxm="http://schemas.devexpress.com/winfx/2008/xaml/map" 
        x:Class="TrafficIncidents.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800" Loaded="OnWindowLoaded">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="5*"/>
            <ColumnDefinition Width="2*"/>
        </Grid.ColumnDefinitions>    
            <dxm:MapControl x:Name="mapControl" Grid.Column="0">
                <dxm:ImageLayer>
                    <dxm:BingMapDataProvider BingKey="Insert your Bing key." 
                                             Kind="RoadLight"/>
                </dxm:ImageLayer>
                <dxm:InformationLayer DataRequestCompleted="OnDataRequestCompleted">
                    <dxm:BingTrafficIncidentDataProvider x:Name="incidentProvider" 
                                                         BingKey="Insert your Bing key." 
                                                         TrafficIncidentCalculated="OnTrafficIncidentCalculated" />
                </dxm:InformationLayer>
            </dxm:MapControl>
            <dxe:TextEdit x:Name="textEdit" TextWrapping="Wrap" Grid.Column="1"/>
    </Grid>
</Window>

C#

using DevExpress.Xpf.Map;
using System.Text;
using System.Windows;

namespace TrafficIncidents {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
        }
        private void OnWindowLoaded(object sender, RoutedEventArgs e) {
            BingTrafficIncidentSeverity incidentSeverity = BingTrafficIncidentSeverity.LowImpact | BingTrafficIncidentSeverity.Minor | 
                                                                BingTrafficIncidentSeverity.Moderate | BingTrafficIncidentSeverity.Serious;
            BingTrafficIncidentType incidentType = BingTrafficIncidentType.Accident | BingTrafficIncidentType.Construction | 
                                                        BingTrafficIncidentType.Miscellaneous | BingTrafficIncidentType.Weather;
            SearchBoundingBox searchArea = new SearchBoundingBox { WestLongitude = -115.338457, NorthLatitude = 36.268745, 
                                                                    EastLongitude = -114.988268, SouthLatitude= 36.1010376 };
            incidentProvider.RequestTrafficIncidents( searchArea, incidentSeverity, incidentType);
        }
        private void OnDataRequestCompleted(object sender, RequestCompletedEventArgs e) {
            // Zoom the map so that it displays the obtained incidents.
            mapControl.ZoomToFitLayerItems();
        }
        private void OnTrafficIncidentCalculated(object sender, BingTrafficIncidentCalculatedEventArgs e) {
            if (e.Cancelled) return;
            if (e.RequestResult.ResultCode != RequestResultCode.Success) {
                textEdit.Text = "Traffic incidents were not found for this area.";
                return;
            }
            StringBuilder resultList = new StringBuilder("");
            int resCounter = 1;
            foreach (BingTrafficIncidentResult resultInfo in e.RequestResult.IncidentResults) {
                resultList.Append(string.Format("Incident {0}: \r\n", resCounter));
                resultList.Append(string.Format("Type: {0}\r\n", resultInfo.Type));
                resultList.Append(string.Format("Description: {0}\r\n", resultInfo.Description));
                resultList.Append(string.Format("Start Time: {0}\r\n", resultInfo.StartTime));
                resultList.Append(string.Format("End Time: {0}\r\n", resultInfo.EndTime));
                resultList.Append(string.Format("Lat: {0}, Lon: {1}\r\n", resultInfo.Point.Latitude, resultInfo.Point.Longitude));
                resultList.Append(string.Format("______________________________\r\n"));
                resCounter++;
            }
            textEdit.Text = resultList.ToString();
        }
    }
}

VB.NET

Imports DevExpress.Xpf.Map
Imports System.Text

Namespace TrafficIncidents
    Public Partial Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub OnWindowLoaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            Dim incidentSeverity As BingTrafficIncidentSeverity = BingTrafficIncidentSeverity.LowImpact Or BingTrafficIncidentSeverity.Minor Or BingTrafficIncidentSeverity.Moderate Or BingTrafficIncidentSeverity.Serious
            Dim incidentType As BingTrafficIncidentType = BingTrafficIncidentType.Accident Or BingTrafficIncidentType.Construction Or BingTrafficIncidentType.Miscellaneous Or BingTrafficIncidentType.Weather
            Dim searchArea As SearchBoundingBox = New SearchBoundingBox With {
                .WestLongitude = -115.338457,
                .NorthLatitude = 36.268745,
                .EastLongitude = -114.988268,
                .SouthLatitude = 36.1010376
            }
            incidentProvider.RequestTrafficIncidents(searchArea, incidentSeverity, incidentType)
        End Sub

        Private Sub OnDataRequestCompleted(ByVal sender As Object, ByVal e As RequestCompletedEventArgs)
            ' Zoom the map so that it displays the obtained incidents.
            mapControl.ZoomToFitLayerItems()
        End Sub

        Private Sub OnTrafficIncidentCalculated(ByVal sender As Object, ByVal e As BingTrafficIncidentCalculatedEventArgs)
            If e.Cancelled Then Return

            If e.RequestResult.ResultCode IsNot RequestResultCode.Success Then
                textEdit.Text = "Traffic incidents were not found for this area."
                Return
            End If

            Dim resultList As StringBuilder = New StringBuilder("")
            Dim resCounter As Integer = 1

            For Each resultInfo As BingTrafficIncidentResult In e.RequestResult.IncidentResults
                resultList.Append(String.Format("Incident {0}: " & vbCrLf, resCounter))
                resultList.Append(String.Format("Type: {0}" & vbCrLf, resultInfo.Type))
                resultList.Append(String.Format("Description: {0}" & vbCrLf, resultInfo.Description))
                resultList.Append(String.Format("Start Time: {0}" & vbCrLf, resultInfo.StartTime))
                resultList.Append(String.Format("End Time: {0}" & vbCrLf, resultInfo.EndTime))
                resultList.Append(String.Format("Lat: {0}, Lon: {1}" & vbCrLf, resultInfo.Point.Latitude, resultInfo.Point.Longitude))
                resultList.Append(String.Format("______________________________" & vbCrLf))
                resCounter += 1
            Next
            textEdit.Text = resultList.ToString()
        End Sub
    End Class
End Namespace