ExportToPDF Method—ArcGIS Pro

ExportToPDF Method

In This Topic

Export a report to a PDF format. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void ExportToPDF( 
   string outputName,
   PDFFormat exportFormat,
   ReportExportOptions reportExportOptions,
   bool useSelection
)

Public Sub ExportToPDF( _
   ByVal outputName As String, _
   ByVal exportFormat As PDFFormat, _
   ByVal reportExportOptions As ReportExportOptions, _
   ByVal useSelection As Boolean _
)

Parameters

outputName: Output file name.
exportFormat: Provides PDFFormat export options.
reportExportOptions: Report export options.
useSelection: Use the MapMember selection. If set to false, will override the default behavior and force all records to be exported.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	Invalid Export Format parameter.
System.ArgumentException	A valid file path could not be resolved.

Example

Export report to pdf

//Note: Call within QueuedTask.Run()
//Define Export Options
var exportOptions = new ReportExportOptions
{
  ExportPageOption = ExportPageOptions.ExportAllPages,
  TotalPageNumberOverride = 0

};
//Create PDF format with appropriate settings
PDFFormat pdfFormat = new PDFFormat();
pdfFormat.Resolution = 300;
pdfFormat.OutputFileName = path;
report.ExportToPDF($"{report.Name}", pdfFormat, exportOptions, useSelection);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Report Class
Report Members

Send feedback