←Select platform

GetInformation(string,bool) Method

Summary

Gets the image information from a disk file.

Syntax
C#
VB
Objective-C
C++
public CodecsImageInfo GetInformation( 
   string fileName, 
   bool totalPages 
) 
Public Overloads Function GetInformation( _ 
   ByVal fileName As String, _ 
   ByVal totalPages As Boolean _ 
) As CodecsImageInfo 
- (nullable LTCodecsImageInfo *)imageInformationForFile:(NSString *)file  
                                             totalPages:(BOOL)totalPages  
                                                  error:(NSError **)error 
public: 
CodecsImageInfo^ GetInformation(  
   String^ fileName, 
   bool totalPages 
)  

Parameters

fileName
String containing the input file name to query.

totalPages
true to query the file for total number of pages; false, otherwise.

Return Value

A CodecsImageInfo object that contains the information about the specified image.

Remarks

Specifying true for totalPages can cause the process to be slow for files with large number of pages.

To quickly query the number of an image, use GetTotalPages or GetTotalPagesAsync.

To quickly query the format of an image, use GetFormat or GetFormatAsync.

Example
C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public void GetInformationStringExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Get Information on a GIF image file and write it out 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif"); 
   CodecsImageInfo info = codecs.GetInformation(srcFileName, true); 
   Console.WriteLine("Information for: {0}", srcFileName); 
   Console.WriteLine("BitsPerPixel: {0}", info.BitsPerPixel); 
   Console.WriteLine("BytesPerLine: {0}", info.BytesPerLine); 
   Console.WriteLine("ColorSpace: {0}", info.ColorSpace.ToString()); 
   Console.WriteLine("Compression: {0}", info.Compression); 
   Console.WriteLine("Fax: {0}", info.Fax); 
   Console.WriteLine("Format: {0}", info.Format); 
   if (info.Gif.HasAnimationBackground) 
      Console.WriteLine("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()); 
   Console.WriteLine("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight); 
   Console.WriteLine("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth); 
   if (info.Gif.HasAnimationLoop) 
      Console.WriteLine("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()); 
   if (info.Gif.HasAnimationPalette) 
   { 
      RasterColor[] pal = info.Gif.GetAnimationPalette(); 
      Console.WriteLine("GifAnimationPalette:\n"); 
      for (int x = 0; x < pal.Length; x++) 
      { 
         Console.Write("{0},", pal[x]); 
      } 
      Console.WriteLine("\n"); 
   } 
   Console.WriteLine("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()); 
   Console.WriteLine("PageNumber: {0}", info.PageNumber); 
   Console.WriteLine("TotalPages: {0}", info.TotalPages); 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub GetInformationStringExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   ' Get Information on a GIF image file and write it out 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif") 
   Dim info As CodecsImageInfo = codecs.GetInformation(srcFileName, True) 
   Console.WriteLine("Information for: {0}", srcFileName) 
   Console.WriteLine("BitsPerPixel: {0}", info.BitsPerPixel) 
   Console.WriteLine("BytesPerLine: {0}", info.BytesPerLine) 
   Console.WriteLine("ColorSpace: {0}", info.ColorSpace.ToString()) 
   Console.WriteLine("Compression: {0}", info.Compression) 
   Console.WriteLine("Fax: {0}", info.Fax) 
   Console.WriteLine("Format: {0}", info.Format) 
   If info.Gif.HasAnimationBackground Then 
      Console.WriteLine("Gif.AnimationBackground: {0}", info.Gif.AnimationBackground.ToString()) 
   End If 
   Console.WriteLine("Gif.AnimationHeight: {0}", info.Gif.AnimationHeight) 
   Console.WriteLine("Gif.AnimationWidth: {0}", info.Gif.AnimationWidth) 
   If info.Gif.HasAnimationLoop Then 
      Console.WriteLine("Gif.AnimationLoop: {0}", info.Gif.AnimationLoop.ToString()) 
   End If 
   If info.Gif.HasAnimationPalette Then 
      Dim pal As RasterColor() = info.Gif.GetAnimationPalette() 
      Console.WriteLine("GifAnimationPalette:" & Constants.vbLf) 
      Dim x As Integer = 0 
      Do While x < pal.Length 
         Console.Write("{0},", pal(x)) 
         x += 1 
      Loop 
      Console.WriteLine(Constants.vbLf) 
   End If 
   Console.WriteLine("Gif.IsInterlaced: {0}", info.Gif.IsInterlaced.ToString()) 
   Console.WriteLine("PageNumber: {0}", info.PageNumber) 
   Console.WriteLine("TotalPages: {0}", info.TotalPages) 
 
   ' Clean up 
   codecs.Dispose() 
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.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly