LayerBase.Error Event

Occurs when an internal exception is raised.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.2.dll

Declaration

C#

public event MapErrorEventHandler Error

VB.NET

Public Event Error As MapErrorEventHandler

Event Data

The Error event's data class is MapErrorEventArgs. The following properties provide information specific to this event:

Property	Description
Exception	Returns the raised exception.

Example

This example demonstrates how to monitor errors using the LayerBase.Error event handler. For example, this event is raised when an incorrect server URI is specified for a Web Map Service Provider.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-monitor-errors-using-the-error-event-handler-t361988

Form1.cs

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

namespace MapErrorEvent {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e) {
            ImageLayer imageLayer = new ImageLayer();
            mapControl1.Layers.Add(imageLayer);
            WmsDataProvider provider = new WmsDataProvider();
            imageLayer.DataProvider = provider;
            provider.ServerUri = "http://YOUR_SERVER_URI";
            provider.ActiveLayerName = "ACTIVE_LAYER_NAME";
            imageLayer.Error += OnError;
        }
        private void OnError(object sender, MapErrorEventArgs e) {
            MessageBox.Show(e.Exception.Message);
        }
    }
}

Form1.vb

Imports DevExpress.XtraMap
Imports System
Imports System.Windows.Forms

Namespace MapErrorEvent
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            Dim imageLayer As New ImageLayer()
            mapControl1.Layers.Add(imageLayer)
            Dim provider As New WmsDataProvider()
            imageLayer.DataProvider = provider
            provider.ServerUri = "http://YOUR_SERVER_URI"
            provider.ActiveLayerName = "ACTIVE_LAYER_NAME"
            AddHandler imageLayer.Error, AddressOf OnError
        End Sub
        Private Sub OnError(ByVal sender As Object, ByVal e As MapErrorEventArgs)
            MessageBox.Show(e.Exception.Message)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Error event.

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-monitor-errors-using-the-error-event-handler-t361988/CS/MapErrorEvent/Form1.cs#L17

    provider.ActiveLayerName = "ACTIVE_LAYER_NAME";
    imageLayer.Error += OnError;
}

VB.NET

how-to-monitor-errors-using-the-error-event-handler-t361988/VB/MapErrorEvent/Form1.vb#L19

    provider.ActiveLayerName = "ACTIVE_LAYER_NAME"
    AddHandler imageLayer.Error, AddressOf OnError
End Sub