GetTotalPages(string) Method

Summary

Gets the number of pages in a disk file image.

Syntax

Objective-C

C++/CLI

Python

public int GetTotalPages( 
   string fileName 
)

- (NSInteger)totalPagesInFile:(NSString *)file error:(NSError **)error

public: 
int GetTotalPages(  
   String^ fileName 
)

def GetTotalPages(self,fileName):

Parameters

fileName
A String containing the name of the image file to query.

Return Value

Number of pages in the specified file.

Remarks

GetInformation and GetFormat use GetInformation internally. So, if more information about the image is required, it is recommended to call GetInformation directly and obtain the data once.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void LoadPagesFromFileTest(string fileName) 
{ 
   // Create a new RasterCodecs instance 
   using (RasterCodecs rasterCodecs = new RasterCodecs()) 
   { 
      rasterCodecs.GetFormat(fileName); 
      // Get the number of pages 
      int pageCount = rasterCodecs.GetTotalPages(fileName); 
      Debug.WriteLine("Number of pages in the file is {0}", pageCount); 
 
      // Load all pages 
      for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
      { 
         using (RasterImage rasterImage = rasterCodecs.Load(fileName, pageNumber)) 
         { 
            Debug.WriteLine("Page {0} loaded", pageNumber); 
         } 
      } 
   } 
}

 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
 
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.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
 
 
public void loadPagesFromFileExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String fileName = combine(LEAD_VARS_IMAGES_DIR, "leadtools.pdf"); 
   RasterCodecs rasterCodecs = new RasterCodecs(); 
   rasterCodecs.getFormat(fileName); 
 
   // Get the number of pages 
   int pageCount = rasterCodecs.getTotalPages(fileName); 
   System.out.printf("Number of pages in the file is %s%n", pageCount); 
 
   // Load all pages 
   int i = 0; 
   for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++) { 
      i++; 
      rasterCodecs.load(fileName, pageNumber); 
      System.out.printf("Page %s loaded%n", pageNumber); 
   } 
   assertTrue("All pages are accounted for", i == pageCount); 
   System.out.println("All pages have been loaded"); 
}

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies