MapControl.ExportToPdf(String) Method

Exports the Map Control’s data to the specified file in PDF format.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.2.dll

Declaration

C#

public void ExportToPdf(
    string filePath
)

VB.NET

Public Sub ExportToPdf(
    filePath As String
)

Parameters

Name	Type	Description
filePath	String	A string that specifies the full path to the file which the Map Control’s data will be exported to.

Remarks

This method exports the current map as a *.PDF file to the specified path, calling the PrintingSystemBase.ExportToPdf method. After creating a PDF file, the map can be displayed in an appropriate application. For more information, refer to the PrintingSystemBase.ExportToPdf topic.

Note

The MapControl’s data can only be exported if the XtraPrinting Library is available.

Example

To export a map image to a file, use one of the following methods.

• MapControl.ExportToImage - exports the map to an image file;
• MapControl.ExportToMht - exports the map to a *.MHT file;
• MapControl.ExportToPdf - exports the map to a *.PDF file;
• MapControl.ExportToXls - exports the map to a *.XLS file;
• MapControl.ExportToXlsx - exports the map to a *.XLSX file;

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-print-or-export-a-map-t185956

Form1.cs

private void ddbExport_Click(object sender, EventArgs e) {
    string filepath = filepathBase + exportFormat.ToString();
    switch (exportFormat) {
        case (ExportFormat.Image):
            mapControl.ExportToImage(filepath, ImageFormat.Jpeg);
            break;
        case (ExportFormat.Mht):
            mapControl.ExportToMht(filepathBase);
            break;
        case (ExportFormat.Pdf):
            mapControl.ExportToPdf(filepathBase);
            break;
        case (ExportFormat.Xls):
            mapControl.ExportToXls(filepathBase);
            break;
        case (ExportFormat.Xlsx):
            mapControl.ExportToXlsx(filepathBase);
            break;
        default:
            MessageBox.Show("Export to a *" + exportFormat.ToString() + " file format is impossible.", "Export to " + exportFormat.ToString());
            return;
    }

    MessageBox.Show("Export to a *" + exportFormat.ToString() + " file is done.", "Export to " + exportFormat.ToString());
}

Form1.vb

Private Sub ddbExport_Click(ByVal sender As Object, ByVal e As EventArgs) Handles ddbExport.Click
    Dim filepath As String = filepathBase & exportFormat.ToString()
    Select Case exportFormat
        Case (ExportFormat.Image)
            mapControl.ExportToImage(filepath, ImageFormat.Jpeg)
        Case (ExportFormat.Mht)
            mapControl.ExportToMht(filepathBase)
        Case (ExportFormat.Pdf)
            mapControl.ExportToPdf(filepathBase)
        Case (ExportFormat.Xls)
            mapControl.ExportToXls(filepathBase)
        Case (ExportFormat.Xlsx)
            mapControl.ExportToXlsx(filepathBase)
        Case Else
            MessageBox.Show("Export to a *" & exportFormat.ToString() & " file format is impossible.", "Export to " & exportFormat.ToString())
            Return
    End Select

    MessageBox.Show("Export to a *" & exportFormat.ToString() & " file is done.", "Export to " & exportFormat.ToString())
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToPdf(String) method.

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-print-or-export-a-map-t185956/CS/MapControl_PrintingExporting/Form1.cs#L128

case (ExportFormat.Pdf):
    mapControl.ExportToPdf(filepathBase);
    break;

VB.NET

how-to-print-or-export-a-map-t185956/VB/MapControl_PrintingExporting/Form1.vb#L129

Case (ExportFormat.Pdf)
    mapControl.ExportToPdf(filepathBase)
Case (ExportFormat.Xls)