FirstPageNumber Property

Summary

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

Syntax

C++/CLI

Java

Python

public int FirstPageNumber { get; set; }

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

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

FirstPageNumber # get and set (LoadDocumentOptions)

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 LEADDocument.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

Java

using Leadtools; 
using Leadtools.Caching; 
using Leadtools.Document; 
 
 
public void DocumentFactoryLoadFromFileExample() 
{ 
   var options = new LoadDocumentOptions(); 
   options.AnnotationsUri = null; 
   options.FirstPageNumber = 1; 
   options.LastPageNumber = -1; 
   options.Password = null; 
   options.WebClient = null; 
   options.CachePolicy = new CacheItemPolicy(); 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"), options)) 
   { 
      PrintOutDocumentInfo(document); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileInputStream; 
import java.io.FileNotFoundException; 
import java.io.IOException; 
import java.io.InputStream; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.util.Calendar; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.caching.*; 
import leadtools.document.*; 
 
 
public void documentFactoryLoadFromFileExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   options.setAnnotationsUri(null); 
   options.setFirstPageNumber(1); 
   options.setLastPageNumber(-1); 
   options.setPassword(null); 
   options.setCachePolicy(new CacheItemPolicy()); 
   LEADDocument document = DocumentFactory.loadFromFile(combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"), options); 
   printOutDocumentInfo(document); 
   assertTrue(document != null); 
   System.out.println("Document created successfully"); 
   document.dispose(); 
}

or DocumentFactory.LoadFromUri.

Requirements

Target Platforms

Reference

LoadDocumentOptions Class

LoadDocumentOptions Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies