ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / MapSeriesExportOptions Class / CustomPages Property
Example

In This Topic
    CustomPages Property (MapSeriesExportOptions)
    In This Topic
    Gets or sets a string that represents a list of pages and/or page ranges.
    Syntax
    Public Property CustomPages As String
    public string CustomPages {get; set;}
    Remarks

    The values in the string represent the page numbers you see in the Map Series Pages pane. These values correspond to the map series page number settings or field values. You can create a comma-delimted list of pages or you can use a hyphen to designate a range. An example might be, "1-3, 5" or , "1, 2, 23-28, 45, 63-65". When using a hyphen, it must be used between two existing values. You can't use the hyphen as a wildcard like "65-".

    When working with a field that contains strings like with roman numeral values, ranges won't work, you must build an explicit list of valid values. An example might be, "VI, VII, VII", or "V, I, II".

    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
      //Note: Must be on 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
      }
    }
    Requirements

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

    ArcGIS Pro version: 3.0 or higher.
    See Also