ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / MapSeriesExportOptions Class
Members Example

In This Topic
    MapSeriesExportOptions Class
    In This Topic
    Represents a collection of settings for exporting a map series.
    Syntax
    public class MapSeriesExportOptions 
    Public Class MapSeriesExportOptions 
    Remarks
    Before you can export a map series, you need to configure your ExportFormat and you need to construct your export settings.
    Example
    Layout_ExportMS_PDF
    //Export multiple map series pages to PDF
    
    //Create a PDF export format
    PDFFormat msPDF = new PDFFormat()
    {
      Resolution = 300,
      OutputFileName = filePath,
      DoCompressVectorGraphics = true
    };
    
    //Set up the export options for the map series
    MapSeriesExportOptions MSExport_custom = new MapSeriesExportOptions()
    {
      ExportPages = ExportPages.Custom,
      CustomPages = "1-3, 5",
      ExportFileOptions = ExportFileOptions.ExportAsSinglePDF,
      ShowSelectedSymbology = false
    };
    
    //Check to see if the path is valid and export
    if (msPDF.ValidateOutputFilePath())
    {
      layout.Export(msPDF, MSExport_custom);  //Export the PDF to a single, multiple page PDF. 
    }
    MapSeries_Constructor1
    //Set up map series export options
    
    MapSeriesExportOptions MSExport_SinglePage = new MapSeriesExportOptions()
    {
      ExportPages = ExportPages.Custom,  //Provide a specific list of pages
      CustomPages = "1-3, 5",  //Only used if ExportPages.Custom is set
      ExportFileOptions = ExportFileOptions.ExportAsSinglePDF,  //Export all pages to a single, multi-page PDF
      ShowSelectedSymbology = false  //Do no show selection symbology in the output
    };
    MapSeries_Constructor2
    //Set up map series export options
    
    MapSeriesExportOptions MSExport_IndivPages = new MapSeriesExportOptions()
    {
      ExportPages = ExportPages.All,  //All pages
      ExportFileOptions = ExportFileOptions.ExportMultipleNames,  //Export each page to an individual file using page name as a suffix.
      ShowSelectedSymbology = true  //Include selection symbology in the output
    };
    Export a map series to single PDF
    //Export a map series with multiple pages to a single PDF.
    
    //Create PDF format with appropriate settings
    PDFFormat MS_PDF = new PDFFormat()
    {
      OutputFileName = filePath,
      Resolution = 300,
      DoCompressVectorGraphics = true,
      DoEmbedFonts = true,
      HasGeoRefInfo = true,
      ImageCompression = ImageCompression.Adaptive,
      ImageQuality = ImageQuality.Best,
      LayersAndAttributes = LayersAndAttributes.LayersAndAttributes
    };
    
    //Set up map series export options
    MapSeriesExportOptions MS_ExportOptions = new MapSeriesExportOptions()
    {
      ExportPages = ExportPages.Custom,  //Provide a specific list of pages
      CustomPages = "1-3, 5",  //Only used if ExportPages.Custom is set
      ExportFileOptions = ExportFileOptions.ExportAsSinglePDF,  //Export all pages to a single, multi-page PDF
      ShowSelectedSymbology = false  //Do no show selection symbology in the output
    };
    
    //Export on the worker thread
    await QueuedTask.Run(() =>
    {
      //Check to see if the path is valid and export
      if (MS_PDF.ValidateOutputFilePath())
      {
        layout.Export(MS_PDF, MS_ExportOptions);  //Export to PDF
      }
    });
    Export a map series to individual TIFF files
    //Export each page of a map series to an individual TIFF file.
    
    //Create TIFF format with appropriate settings
    TIFFFormat TIFF = new TIFFFormat()
    {
      OutputFileName = filePath,
      Resolution = 300,
      ColorMode = TIFFColorMode.TwentyFourBitTrueColor,
      HasGeoTiffTags = true,
      HasWorldFile = true,
      ImageCompression = TIFFImageCompression.LZW
    };
    
    //Set up map series export options
    MapSeriesExportOptions MSExportOptions_TIFF = new MapSeriesExportOptions()
    {
      ExportPages = ExportPages.All,  //All pages
      ExportFileOptions = ExportFileOptions.ExportMultipleNames,  //Export each page to an individual file using page name as a suffix.
      ShowSelectedSymbology = true  //Include selection symbology in the output
    };
    
    //Export on the worker thread
    await QueuedTask.Run(() =>
    {
      //Check to see if the path is valid and export
      if (TIFF.ValidateOutputFilePath())
      {
        layout.Export(TIFF, MSExportOptions_TIFF);  //Export to TIFF
      }
    });
    Inheritance Hierarchy

    System.Object
       ArcGIS.Desktop.Layouts.MapSeriesExportOptions

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also