ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / MapSeriesExportOptions Class / ExportFileOptions Property
Example

In This Topic
    ExportFileOptions Property
    In This Topic
    Gets and sets how the map series will be exported to file.
    Syntax
    public ExportFileOptions ExportFileOptions {get; set;}
    Public Property ExportFileOptions As ExportFileOptions
    Remarks

    For PDF export, there are 3 options: a single, multiple page PDF, individual pages using the map name as a suffix, or individual pages using page numbers as a suffix.

    For all other export formats, there are only two valid options: individual pages using the map name as a suffix, or individual pages using page numbers as a suffix.

    Example
    Export a map series to single PDF
    {
      //Export a map series with multiple pages to a single PDF.
      string filePath = @"Path and file name for the output export file";
      //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
      //Check to see if the path is valid and export
      if (MS_PDF.ValidateOutputFilePath())
      {
        await QueuedTask.Run(() => 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.
      string filePath = @"Path and file name for the output export 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
      //Check to see if the path is valid and export
      if (TIFF.ValidateOutputFilePath())
      {
        await QueuedTask.Run(() => layout.Export(TIFF, MSExportOptions_TIFF));  //Export to TIFF
      }
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also