|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFileSpec () |
| Get the file specification. More... | |
| def | GetIconName () |
| Get icon name. More... | |
| def | SetFileSpec (file_spec) |
| Set a file specification, which should specify an embedded file. More... | |
| def | SetIconName (icon_name) |
| Set icon name. More... | |
A file attachment annotation contains a reference to a file, which typically is embedded in the PDF file.
File attachment annotation is a kind of markup annotation, so class FileAttachment is derived from class Markup , and also offers functions to get/set file attachment annotation's properties and reset appearance stream of a file attachment annotation.
| def fsdk.FileAttachment.GetFileSpec | ( | ) |
Get the file specification.
| def fsdk.FileAttachment.GetIconName | ( | ) |
Get icon name.
This property has effect on file attachment annotation's appearance. File attachment annotation has predefined standard icon names:
"Graph", "PushPin", "Paperclip", "Tag".
An empty icon name string means current File attachment annotation would be treated as "PushPin".
| def fsdk.FileAttachment.SetFileSpec | ( | file_spec | ) |
Set a file specification, which should specify an embedded file.
| [in] | file_spec | A valid file specification object to be set. |
| def fsdk.FileAttachment.SetIconName | ( | icon_name | ) |
Set icon name.
This property has effect on file attachment annotation's appearance. File attachment annotation has predefined standard icon names:
"Graph", "PushPin", "Paperclip", "Tag".
For a newly created file attachment annotation, if current function is not called, icon name will be "PushPin" by default.
If user wants the new icon name have effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the new icon name.
| [in] | icon_name | New icon name string to be set. |