Public Member Functions | |
Metadata (PDFDoc document) throws com.foxit.sdk.PDFException | |
Constructor, from a PDF document object. More... | |
Metadata (Metadata other) | |
Constructor, with another metadata object. More... | |
DateTime | getCreationDateTime () throws com.foxit.sdk.PDFException |
Get creation date time. More... | |
WStringArray | getCustomerKeys () throws com.foxit.sdk.PDFException |
Get customer keys from metadata. More... | |
DateTime | getModifiedDateTime () throws com.foxit.sdk.PDFException |
Get modified date time. More... | |
WStringArray | getValues (String key) throws com.foxit.sdk.PDFException |
Get metadata value(s). More... | |
boolean | hasKey (String key) throws com.foxit.sdk.PDFException |
Check whether the related PDF document has a specified metadata key or not. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
void | removeCustomerKey (String key) throws com.foxit.sdk.PDFException |
Remove a specified customer key (along with related value). More... | |
void | setCreationDateTime (DateTime date_time) throws com.foxit.sdk.PDFException |
Set creation date time. More... | |
void | setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException |
Set modified date time. More... | |
boolean | setValues (String key, WStringArray value_array) throws com.foxit.sdk.PDFException |
Set metadata value(s). More... | |
In PDF document, metadata information is stored in document's Info dictionary or in metadata stream (represented in Extensible Markup Language, known as XML). When a key exists in both Info dictionary and metadata stream, the latest modified one will be used.
This class is constructed from PDF document object and is used to get or set metadata information from both document's Info dictionary and metadata stream.
com.foxit.sdk.pdf.Metadata.Metadata | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException |
Constructor, from a PDF document object.
If there exists metadata information in the specified PDF document, this function is just to construct a metadata object to be associated with these information. If there is no such information in the specified PDF document, the constructed metadata object can be used to set metadata information to PDF document.
[in] | document | A valid PDF document object. |
com.foxit.sdk.pdf.Metadata.Metadata | ( | Metadata | other | ) |
Constructor, with another metadata object.
[in] | other | Another metadata object. |
DateTime com.foxit.sdk.pdf.Metadata.getCreationDateTime | ( | ) | throws com.foxit.sdk.PDFException |
Get creation date time.
WStringArray com.foxit.sdk.pdf.Metadata.getCustomerKeys | ( | ) | throws com.foxit.sdk.PDFException |
Get customer keys from metadata.
In Info dictionary and metadata stream, they have some standard keys which have same feature but different name. For this case, Foxit PDF SDK will use the standard key names in Info dictionary. Besides these standard keys, other keys will be treated as customer keys.
DateTime com.foxit.sdk.pdf.Metadata.getModifiedDateTime | ( | ) | throws com.foxit.sdk.PDFException |
Get modified date time.
WStringArray com.foxit.sdk.pdf.Metadata.getValues | ( | String | key | ) | throws com.foxit.sdk.PDFException |
Get metadata value(s).
For a metadata key, it may contain single or multiple values.
[in] | key | Metadata key string. It should not be an empty string. Currently it can be one of the following keys: "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "Trapped", "CreationDate", "ModDate", "pdfaid". It can also be some other custom information keys if they're supported by the PDF file. For "CreationDate" and "ModDate", user is recommended to use functions Metadata.getCreationDateTime and Metadata.getModifiedDateTime to get the date information. |
boolean com.foxit.sdk.pdf.Metadata.hasKey | ( | String | key | ) | throws com.foxit.sdk.PDFException |
Check whether the related PDF document has a specified metadata key or not.
[in] | key | The metadata key to be checked. |
boolean com.foxit.sdk.pdf.Metadata.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void com.foxit.sdk.pdf.Metadata.removeCustomerKey | ( | String | key | ) | throws com.foxit.sdk.PDFException |
Remove a specified customer key (along with related value).
[in] | key | A customer key string. It should not be an empty string. This should be one of the keys retrieved from function Metadata.getCustomerKeys . |
void com.foxit.sdk.pdf.Metadata.setCreationDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException |
Set creation date time.
[in] | date_time | New creation date time. Please refer to comment of class com.foxit.sdk.common.DateTime to check the valid range for each member. |
void com.foxit.sdk.pdf.Metadata.setModifiedDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException |
Set modified date time.
[in] | date_time | New modified date time. Please refer to comment of class com.foxit.sdk.common.DateTime to check the valid range for each member. |
boolean com.foxit.sdk.pdf.Metadata.setValues | ( | String | key, |
WStringArray | value_array | ||
) | throws com.foxit.sdk.PDFException |
Set metadata value(s).
This function is used to set single or multiple values to a specified metadata key:
[in] | key | Metadata key string. It should not be an empty string. Currently it can be one of the following keys: "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "Trapped", "CreationDate", "ModDate", "pdfaid". It can also be some other custom information keys if they're supported by the PDF file. For "CreationDate" and "ModDate", user is recommended to use Metadata.setCreationDateTime and Metadata.setModifiedDateTime to set the date information. |
[in] | value_array | An string array of metadata value(s). |