MapControl.ExportMapItem Event

Occurs when executing the export action of the map item.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.1.dll

Declaration

C#

public event ExportMapItemEventHandler ExportMapItem

VB.NET

Public Event ExportMapItem As ExportMapItemEventHandler

Event Data

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

Property	Description
Cancel	Gets or sets whether the export of a map item should be canceled.
IsSelected	Gets a value that indicates whether an exported map item is selected.
Item	Gets a map item to be represented in the map control. Inherited from MapItemEventArgs.

Example

The following example demonstrates how to export selected map items to an image.

To do this, handle the MapControl.ExportMapItem event and set the ExportMapItemEventArgs.Cancel property to true if the map item is not selected (the ExportMapItemEventArgs.IsSelected property is set to false). Then, call the MapControl.ExportToImage method using the map path (where the map image should be stored) and the specified image format (e.g., .png).

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-export-selected-map-items-to-an-image-e5182

Form1.cs

using System;
using System.Windows.Forms;
using System.Drawing.Imaging;
using DevExpress.XtraMap;
using System.Diagnostics;

namespace ExportSelectedItems {
    public partial class Form1 : Form {
        string mapPath = "Image.png";

        public Form1() {
            InitializeComponent();
            mapControl1.ExportMapItem += mapControl1_ExportMapItem;
        }

        private void mapControl1_ExportMapItem(object sender, ExportMapItemEventArgs e) {
            if (!e.IsSelected)
                e.Cancel = true;
        }

        private void simpleButton1_Click(object sender, EventArgs e) {
            mapControl1.ExportToImage(mapPath, ImageFormat.Png);
            Process.Start(mapPath);
        }
    }
}

Form1.vb

Imports System
Imports System.Windows.Forms
Imports System.Drawing.Imaging
Imports DevExpress.XtraMap
Imports System.Diagnostics

Namespace ExportSelectedItems
    Partial Public Class Form1
        Inherits Form

        Private mapPath As String = "Image.png"

        Public Sub New()
            InitializeComponent()
            AddHandler mapControl1.ExportMapItem, AddressOf mapControl1_ExportMapItem
        End Sub

        Private Sub mapControl1_ExportMapItem(ByVal sender As Object, ByVal e As ExportMapItemEventArgs)
            If Not e.IsSelected Then
                e.Cancel = True
            End If
        End Sub

        Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton1.Click
            mapControl1.ExportToImage(mapPath, ImageFormat.Png)
            Process.Start(mapPath)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportMapItem 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-export-selected-map-items-to-an-image-e5182/CS/Form1.cs#L13

    InitializeComponent();
    mapControl1.ExportMapItem += mapControl1_ExportMapItem;
}

VB.NET

how-to-export-selected-map-items-to-an-image-e5182/VB/Form1.vb#L15

    InitializeComponent()
    AddHandler mapControl1.ExportMapItem, AddressOf mapControl1_ExportMapItem
End Sub