PDFAttachment Object (IPDFAttachment Interface)
This object represents a PDF attachment. It provides access to the original file name, description added by the author, and the type of binding of the attachment. It also exposes methods that allow you to access the attached file by saving it on disk or into the global memory.
Properties
Name | Type | Description |
---|---|---|
Application | Engine, read-only | Returns the Engine object. |
Binding | PDFAttachmentBindingEnum, read-only | Specifies if the attached file is associated with one annotation, PDF Portfolio, or the document in general. For an attachment added via FineReader Engine API, this property value is always PAB_Document. |
Description | BSTR, read-only | Returns the description given to the file when it was attached. |
FileFormat | ImageFileFormatEnum, read-only |
Returns the original file format defined after its opening by ABBYY FineReader Engine (see the code sample below). Note: If the attachment format is not equal to IFF_UnknownFormat, then it can be used in the AddImageFileFromAttachment method. Otherwise, you can save the attachment using the SaveToFile or SaveToMemory method. |
FileName | BSTR, read-only | Returns the original file name. |
Methods
Name | Description |
---|---|
SaveToFile | Saves the attached file on disk. |
SaveToMemory | Saves the attached file into the global memory. |
Related objects
Input parameter
This object is passed as an input parameter to the AddImageFileFromAttachment method.
Output parameter
This object is the output parameter of the AddFromFile, AddFromMemory methods of the PDFAttachments object.
Samples
C++ (COM) code
See also
17.09.2024 15:14:41