Foxit PDF SDK
|
Public Member Functions | |
def | Metadata (document) |
Constructor, from a PDF document object. More... | |
def | GetCreationDateTime () |
Get creation date time. More... | |
def | GetCustomerKeys () |
Get customer keys from metadata. More... | |
def | GetModifiedDateTime () |
Get modified date time. More... | |
def | GetValues (key) |
Get metadata value(s). More... | |
def | HasKey (key) |
Check whether the related PDF document has a specified metadata key or not. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | RemoveCustomerKey (key) |
Remove a specified customer key (along with related value). More... | |
def | SetCreationDateTime (date_time) |
Set creation date time. More... | |
def | SetModifiedDateTime (date_time) |
Set modified date time. More... | |
def | SetValues (key, value_array) |
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.
def FoxitPDFSDKPython3.Metadata.Metadata | ( | document | ) |
Constructor, from a PDF document object.
Constructor, with another metadata 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. |
[in] | other | Another metadata object. |
def FoxitPDFSDKPython3.Metadata.GetCreationDateTime | ( | ) |
Get creation date time.
def FoxitPDFSDKPython3.Metadata.GetCustomerKeys | ( | ) |
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.
def FoxitPDFSDKPython3.Metadata.GetModifiedDateTime | ( | ) |
Get modified date time.
def FoxitPDFSDKPython3.Metadata.GetValues | ( | key | ) |
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", "InstanceID", "DocumentID". 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 FoxitPDFSDKPython3.Metadata.GetCreationDateTime and FoxitPDFSDKPython3.Metadata.GetModifiedDateTime to get the date information. |
def FoxitPDFSDKPython3.Metadata.HasKey | ( | key | ) |
Check whether the related PDF document has a specified metadata key or not.
[in] | key | The metadata key to be checked. |
def FoxitPDFSDKPython3.Metadata.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython3.Metadata.RemoveCustomerKey | ( | key | ) |
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 FoxitPDFSDKPython3.Metadata.GetCustomerKeys . |
def FoxitPDFSDKPython3.Metadata.SetCreationDateTime | ( | date_time | ) |
Set creation date time.
[in] | date_time | New creation date time. Please refer to comment of class FoxitPDFSDKPython3.DateTime to check the valid range for each member. |
def FoxitPDFSDKPython3.Metadata.SetModifiedDateTime | ( | date_time | ) |
Set modified date time.
[in] | date_time | New modified date time. Please refer to comment of class FoxitPDFSDKPython3.DateTime to check the valid range for each member. |
def FoxitPDFSDKPython3.Metadata.SetValues | ( | key, | |
value_array | |||
) |
Set metadata value(s).
This function is used to set single or multiple values to a specified metadata key:
For metadata keys "Author" and "Keywords", they can contain single or multiple values.
For metadata key "pdfaid" which means the PDFA file version, the length of its value string is always 2, such as "2a", "1a", etc. So, only the first two characters of the first element in parameter valueArray will be used.
For rest pre-defined keys, they do not support multiple values. So all the elements in parameter value_array will be put into one string and connected by ";". Then this string will be treated as a single value.
[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", "InstanceID", "DocumentID". 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 FoxitPDFSDKPython3.Metadata.SetCreationDateTime and FoxitPDFSDKPython3.Metadata.SetModifiedDateTime to set the date information. |
[in] | value_array | An string array of metadata value(s). |