←Select platform

FirstPageNumber Property (LoadDocumentOptions)

Summary

Number of the first page to be loaded from the document.

Syntax

Java

C++

public int FirstPageNumber { get; set; }

Public Property FirstPageNumber() As Integer 
   Get 
   Set

public:  
   property int FirstPageNumber 
   { 
      int get() 
      void set(int value) 
   }

public int getFirstPageNumber() 
public void getFirstPageNumber(int value)

Property Value

The 1-based number of the first page to be converted from the input document. Default value is 0.

Remarks

The factory will automatically uses 1 for FirstPageNumber and -1 (last page) for LastPageNumber if the values are left as the default of 0 or set to -1.

Use FirstPageNumber and LastPageNumber to load a document containing a desired subset of the pages found in the original file. After loading is successful, the document is treated as if contains only the specified number of pages when it is viewed or when it is converted.

When loading succeeds, the document will store the page numbers set in read-only properties OriginalFirstPageNumber and OriginalLastPageNumber (and the original number of pages in OriginalPageCount) accessed through Document.Pages.

For example, if the factory is loading a PDF document with 10 pages, and FirstPageNumber and LastPageNumber was set to 2 and 5 respectively, then the result document will contain 4 pages (pages 2 through 5) and Pages will have OriginalFirstPageNumber set to 2, OriginalLastPageNumber set to 5 and OriginalPageCount set to 10.

Example

For an example, refer to DocumentFactory.LoadFromFile or DocumentFactory.LoadFromUri.

Requirements

Target Platforms

See Also