←Select platform

Pages Property

Summary

Gets the collection of pages in this PDF file.

Syntax

C#
VB
C++
public IList<PDFFilePage> Pages { get; } 

Public ReadOnly Property Pages As IList(Of PDFFilePage) 

public: 
property IList<PDFFilePage>^ Pages { 
   IList<PDFFilePage>^ get(); 
} 

Property Value

A collection of PDFFilePage objects that contain an item for each page in the PDF file associated with this PDFFile object. Default value is null.

Remarks

The value of Pages will be populated with the pages collection after you set a valid PDF filename (and optional password) in this PDFFile object and call the Load method.

Each item in the collection corresponds to a page in the PDF file. So item at index 0 is the properties of page 1, item at index 1 is the properties of page 2 and so on.

The PDFFilePage structure contains the width and height of the page in PDF units which is read from the PDF file directly. PDF units are in 1/72 of an inch units, so a page size of 612 by 792 corresponds to 8.5 by 11 inches (612/72 by 792/72). For more information, refer to PDF Coordinate System.

You can get the total number of pages in a PDF file with two ways:

  • Use Load to load the PDF file into the PDFFile object and use PDFFile.Pages.Count. Using the Load method will also read the size of each page as well as populating the DocumentProperties with the properties of the file.

  • A faster way is to call GetPageCount directly. This method is faster than calling Load since it will not parse the page sizes nor the document properties. Just set the filename and optional password and call the method.

The values of the PDFFilePage structure are used as read only by the PDFFile object. The toolkit will only return objects of type PDFFilePage from the PDF document and does not use them anymore.

The PDFFilePage does not contain any information about a PDF page other than its size. To get the objects, bookmarks, images, links of a page, use the PDFDocument class and its collection of PDFDocumentPage items.

Example

This example will show the size of each page in a PDF file.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
public void PDFFilePagesExample() 
{ 
   string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
 
   // Load the file 
   PDFFile file = new PDFFile(pdfFileName); 
   file.Load(); 
 
   // Show the pages 
   Console.WriteLine("File has {0} pages", file.Pages.Count); 
   foreach (PDFFilePage page in file.Pages) 
   { 
      Console.WriteLine("Page {0} size is {1} by {2} units", page.PageNumber, page.Width, page.Height); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
 
Public Sub PDFFilePagesExample() 
   Dim pdfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
 
   ' Load the file 
   Dim file As PDFFile = New PDFFile(pdfFileName) 
   file.Load() 
 
   ' Show the pages 
   Console.WriteLine("File has {0} pages", file.Pages.Count) 
   For Each page As PDFFilePage In file.Pages 
      Console.WriteLine("Page {0} size is {1} by {2} units", page.PageNumber, page.Width, page.Height) 
   Next page 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

Requirements

Target Platforms

Help Version 20.0.2018.6.20
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly