Manages the metadata of the document.
[SerializableAttribute()]
[CollectionDataContractAttribute()]
public class DocumentMetadata : Dictionary<string, string>
<SerializableAttribute(),
CollectionDataContractAttribute()>
Public Class DocumentMetadata
Inherits System.Collections.Generic.Dictionary(Of String, String)
public [SerializableAttribute,
CollectionDataContractAttribute]
ref class DocumentMetadata : System::Collections::Generic::Dictionary<String^, String^>
public class DocumentMetadata extends HashMap<String, String>
DocumentMetadata manages the metadata of the document and can be accessed through the Metadata property of LEADDocument.
The metadata includes default values added by the DocumentFactory when the document is loaded or created as well as any other data extracted from the document file itself, such as author, subject and any keywords stored by other applications.
Each metadata item is a key/value pair of type string/string. It is up to the user to read the value string and convert to any other data
type if required. DocumentMetadata derives from [System.Collections.Generic.Dictionary2](https://msdn.microsoft.com/en-us/library/System.Collections.Generic.Dictionary
2.aspx) and items
can be added to it directly.
When DocumentFactory creates a new document using DocumentFactory.Create or loads a document using LoadFromFile, LoadFromUri, LoadFromUriAsync or LoadFromStream the following metadata are automatically added:
Key | Value |
---|---|
Created | Current time as string (System.DateTime.ToString). |
Accessed | Current time as string (System.DateTime.ToString). |
Modified | Current time as string (System.DateTime.ToString). |
When the document type is PDF, the DocumentFactory will add the values found in PDFDocument.DocumentProperties into DocumentMetadata. These values are then used when the document is converted as PDF.
When the document type supports file comments (CommentsSupported will add the value of the comments found into DocumentMetadata. These values are then used when the document is converted to another type that supports the same comments.
The user can add, modify or delete any values at any time and they will be saved and cached.
For an example, refer to LEADDocument.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.