|
Products | Support | Email a link to this topic. | Send comments on this topic. | Back to Introduction - All Topics | Help Version 19.0.4.3
|
| Leadtools.Documents Namespace : DocumentMetadata Class |
[CollectionDataContractAttribute()] [SerializableAttribute()] public class DocumentMetadata : System.Collections.Generic.Dictionary<string,string>
'Declaration
<CollectionDataContractAttribute()> <SerializableAttribute()> Public Class DocumentMetadata Inherits System.Collections.Generic.Dictionary(Of String,String)
'Usage
Dim instance As DocumentMetadata
public class DocumentMetadata extends HashMap<String, String>
[CollectionDataContractAttribute()] [SerializableAttribute()] public ref class DocumentMetadata : public System.Collections.Generic.Dictionary<String,String>
DocumentMetadata manages the metadata of the document and can be accessed through the Metadata property of Document.
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 Dictionary<string, string> and items can be added to it directly.
When DocumentFactory creates a new document using Create or loads a document using LoadFromFile, LoadFromUri, LoadFromUriAsync or LoadFromStream the following metadata are automatically added:
| Key | Value |
|---|---|
| Created |
Current time as string (DateTime.Now.ToString). |
| Accessed |
Current time as string (DateTime.Now.ToString). |
| Modified |
Current time as string (DateTime.Now.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 (RasterCodecs.CommentsSupported) such as EXIF, the DocumentFactory 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 Document.