|
Foxit PDF SDK
|
Public Member Functions | |
| def | Attachments (other) |
| Constructor, with another attachments object. More... | |
| def | AddEmbeddedFile (key, file_spec) |
| Add an embedded attachment (as file specification object) with new key name. More... | |
| def | AddFromFilePath (key, file_path) |
| Add a new attachment from specified file path with new key name. More... | |
| def | ExtractEmbeddedFileTo (key, dst_file_path) |
| Extract an attachment and save it to a specified file path. More... | |
| def | GetCount () |
| Get the count of attachments. More... | |
| def | GetEmbeddedFile (key) |
| Get the attachment (as file specification object) of a specified key. More... | |
| def | GetKey (index) |
| Get the key of an attachment defined in the EmbeddedFiles name tree, by index. More... | |
| def | GetNameTree () |
| Get the EmbeddedFiles name tree. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | RemoveAllEmbeddedFiles () |
| Remove all attachments. More... | |
| def | RemoveEmbeddedFile (key) |
| Remove an attachment by key. More... | |
| def | SetEmbeddedFile (key, file_spec) |
| Set an embedded attachment (as file specification object) for a specified key. More... | |
In application, document's embedded files are known as PDF attachments. This class offers a more convenient way, than class FoxitPDFSDKPython2.PDFNameTree , to get/set embedded files (also known as attachment files) in EmbeddedFiles name tree of a PDF document.
| def FoxitPDFSDKPython2.Attachments.Attachments | ( | other | ) |
Constructor, with another attachments object.
| [in] | other | Another attachments object. |
| def FoxitPDFSDKPython2.Attachments.AddEmbeddedFile | ( | key, | |
| file_spec | |||
| ) |
Add an embedded attachment (as file specification object) with new key name.
All attachments in EmbeddedFiles name tree are ordered by their keys. When a new attachment is added, Foxit PDF SDK will find a suitable place in the name tree to add it. After adding successfully, the indexes of some old keys may be changed.
| [in] | key | New key string. If this is an empty string, the name of input file_spec will be used as the new key. This new key should not have existed in the PDF document to which current attachments object belongs. |
| [in] | file_spec | A file specification object to be added with new key. It should be valid and should has been embedded to the same PDF document as current attachments object. |
| def FoxitPDFSDKPython2.Attachments.AddFromFilePath | ( | key, | |
| file_path | |||
| ) |
Add a new attachment from specified file path with new key name.
All attachments in EmbeddedFiles name tree are ordered by their keys. When a new attachment is added, Foxit PDF SDK will find a suitable place in the name tree to add it. After adding successfully, the indexes of some old keys may be changed.
| [in] | key | New key string. If this is an empty string, the name of input file_spec will be used as the new key. This new key should not have existed in the PDF document to which current attachments object belongs. |
| [in] | file_path | A file path to specify a file to be embedded to the PDF document and also added to EmbeddedFiles name tree. |
| def FoxitPDFSDKPython2.Attachments.ExtractEmbeddedFileTo | ( | key, | |
| dst_file_path | |||
| ) |
Extract an attachment and save it to a specified file path.
| [in] | key | Key string. This should not be an empty string. |
| [in] | dst_file_path | A file path, to which the data of attachment will be saved. This should not be an empty string. |
| def FoxitPDFSDKPython2.Attachments.GetCount | ( | ) |
Get the count of attachments.
| def FoxitPDFSDKPython2.Attachments.GetEmbeddedFile | ( | key | ) |
Get the attachment (as file specification object) of a specified key.
| [in] | key | Key string. It should not be an empty string. |
| def FoxitPDFSDKPython2.Attachments.GetKey | ( | index | ) |
Get the key of an attachment defined in the EmbeddedFiles name tree, by index.
| [in] | index | Index of the key string to be retrieved. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.Attachments.GetCount . |
| def FoxitPDFSDKPython2.Attachments.GetNameTree | ( | ) |
Get the EmbeddedFiles name tree.
| def FoxitPDFSDKPython2.Attachments.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def FoxitPDFSDKPython2.Attachments.RemoveAllEmbeddedFiles | ( | ) |
Remove all attachments.
| def FoxitPDFSDKPython2.Attachments.RemoveEmbeddedFile | ( | key | ) |
Remove an attachment by key.
If the input key does not exist in EmbeddedFiles name tree, this function will return true directly.
| [in] | key | Key string. This should not be an empty string. |
| def FoxitPDFSDKPython2.Attachments.SetEmbeddedFile | ( | key, | |
| file_spec | |||
| ) |
Set an embedded attachment (as file specification object) for a specified key.
| [in] | key | Key string. It should not be an empty string. This name should have existed in current PDF document. |
| [in] | file_spec | A file specification object to be set to the key's value. It should be valid and should has been embedded to the same PDF document as current attachments object. |