ReadMetadataItems(string,int) Method

Summary

Reads metadata from the specified file.

Syntax

C++

public IDictionary<string, string> ReadMetadataItems( 
   string fileName, 
   int pageNumber 
)

Public Overloads Function ReadMetadataItems( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer _ 
) As IDictionary(Of String,String)

public: 
IDictionary<String^,String^>^ ReadMetadataItems(  
   String^ fileName, 
   int pageNumber 
)

Parameters

fileName
A String containing the name of the image file from which the metadata should be read.

pageNumber
1-based index to the page number from which the metadata should be read.

Return Value

Returns a Dictionary. of key, value pairs for the file metadata items.

Remarks

Possible values for the metadata keys:

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
 
public static void ReadMetadataItemsExample() 
{ 
   // The source file 
   string srcFileName = Path.Combine(ImagesPath.Path, "random.dxf"); 
 
   using (var codecs = new RasterCodecs()) 
   { 
      bool isMetadataItemsSupported; 
 
      using (var fileInfo = codecs.GetInformation(srcFileName, false)) 
      { 
         Console.WriteLine("Format {0}", (int)fileInfo.Format); 
         //Check if Metadata supported for the specified file format. 
         isMetadataItemsSupported = RasterCodecs.MetadataItemsSupported(fileInfo.Format); 
         Console.WriteLine("isMetadataItemsSupported {0}", isMetadataItemsSupported); 
      } 
 
      if (isMetadataItemsSupported) 
      { 
         IDictionary<string, string> metadata = null; 
 
         try 
         { 
            //Read Metadata Items 
            metadata = codecs.ReadMetadataItems(srcFileName, 1); 
         } 
         catch (RasterException ex) 
         { 
            Console.WriteLine(ex.Message); 
         } 
 
         Console.WriteLine("Items count {0}", metadata.Count); 
         foreach (var item in metadata) 
         { 
            //Key Ex: RasterCodecs.FileMetadataKeyAuthor; 
            Console.WriteLine("{0}: {1}", item.Key, item.Value); 
         } 
      } 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Shared Sub ReadMetadataItemsExample() 
   ' The source file 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "random.dxf") 
 
   Using codecs As New RasterCodecs() 
      Dim isMetadataItemsSupported As Boolean 
 
      Using fileInfo As CodecsImageInfo = codecs.GetInformation(srcFileName, False) 
         Console.WriteLine("Format {0}", CInt(fileInfo.Format)) 
         'Check if Metadata supported for the specified file format. 
         isMetadataItemsSupported = RasterCodecs.MetadataItemsSupported(fileInfo.Format) 
         Console.WriteLine("isMetadataItemsSupported {0}", isMetadataItemsSupported) 
      End Using 
 
      If isMetadataItemsSupported Then 
         Dim metadata As IDictionary(Of String, String) = Nothing 
 
         Try 
            'Read Metadata Items 
            metadata = codecs.ReadMetadataItems(srcFileName, 1) 
         Catch ex As RasterException 
            Console.WriteLine(ex.Message) 
         End Try 
 
         Console.WriteLine("Items count {0}", metadata.Count) 
         For Each item As KeyValuePair(Of String, String) In metadata 
            'Key Ex: RasterCodecs.FileMetadataKeyAuthor; 
            Console.WriteLine("{0}: {1}", item.Key, item.Value) 
         Next 
      End If 
   End Using 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies