←Select platform

GetFormat(string) Method

Summary
Gets the format of the image in a disk file.
Syntax
C#
Objective-C
C++/CLI
Python
public RasterImageFormat GetFormat( 
   string fileName 
) 
- (LTRasterImageFormat)formatOfFile:(NSString *)file error:(NSError **)error 
public: 
RasterImageFormat GetFormat(  
   String^ fileName 
)  
def GetFormat(self,fileName): 

Parameters

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

Return Value

The format of the image.

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
C#
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

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.