MapErrorEventHandler Delegate

A method that will handle the LayerBase.Error event.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.2.dll

Declaration

C#

public delegate void MapErrorEventHandler(
    object sender,
    MapErrorEventArgs e
);

VB.NET

Public Delegate Sub MapErrorEventHandler(
    sender As Object,
    e As MapErrorEventArgs
)

Parameters

Name	Type	Description
sender	Object	The event source. This parameter identifies the LayerBase which raised the event.
e	MapErrorEventArgs	A MapErrorEventArgs object which contains event data.

Remarks

When creating a MapErrorEventHandler delegate, you identify the method that will handle the corresponding event. To associate an event with your event handler, add a delegate instance to this event. The event handler is called whenever the event occurs unless you remove the delegate. For more information about event handler delegates, see Events and Delegates in MSDN.

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