ReadMetadataItems(string,int) Method

Summary

Reads metadata from the specified file.

Syntax

C++/CLI

Python

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

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

def ReadMetadataItems(self,fileName,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

The file referenced by filename must be a file format that supports XMP. For example PNG, PDF, JPEG, TIFF, SVG, DOC, DOCX, XLS, XLSX, PPT and PPTX. The possible values for the metadata keys are:

Example

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

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies