Foxit PDF SDK

Public Member Functions | List of all members
FSDK.Attachments Class Reference

## Public Member Functions
| AddEmbeddedFile (key, file_spec)
| Add an embedded attachment (as file specification object) with new key name. More...
| AddFromFilePath (key, file_path)
| Add a new attachment from specified file path with new key name. More...
| constructor (doc, nametree)
| Constructor, with parameters. from a PDF document object and an EmbeddedFiles name tree (if any). More...
| ExtractEmbeddedFileTo (key, dst_file_path)
| Extract an attachment and save it to a specified file path. More...
| GetCount ()
| Get the count of attachments. More...
| GetEmbeddedFile (key)
| Get the attachment (as file specification object) of a specified key. More...
| GetKey (index)
| Get the key of an attachment defined in the EmbeddedFiles name tree, by index. More...
| GetNameTree ()
| Get the EmbeddedFiles name tree. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| RemoveAllEmbeddedFiles ()
| Remove all attachments. More...
| RemoveEmbeddedFile (key)
| Remove an attachment by key. More...
| SetEmbeddedFile (key, file_spec)
| Set an embedded attachment (as file specification object) for a specified key. More...

## Detailed Description

In application, document's embedded files are known as PDF attachments. This class offers a more convenient way, than class FSDK.PDFNameTree, to get/set embedded files (also known as attachment files) in EmbeddedFiles name tree of a PDF document.

See also
  FSDK.PDFDoc
  FSDK.PDFNameTree

## Member Function Documentation

## ◆ AddEmbeddedFile()

FSDK.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.

Parameters

  [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.

Returns
  true means success, while false means failure.

## ◆ AddFromFilePath()

FSDK.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.

Parameters

  [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.

Returns
  true means success, while false means failure.

## ◆ constructor()

FSDK.Attachments.constructor | ( | doc | ,
|  | nametree |
| ) |  |

Constructor, with parameters. from a PDF document object and an EmbeddedFiles name tree (if any).

- If no name tree object is specified, this function will construct the attachments object from PDF document: if there exists EmbeddedFiles name tree in the PDF document, this function is just to construct an attachments object to be associated with the name tree; If there is no such name tree in PDF document, the constructed attachments object can be used to create such name tree in PDF document and add some embedded files to the name tree.
- If an EmbeddedFiles name tree is specified, this function will construct the attachments object from the name tree, along with the related PDF document.

Parameters

  [in] | doc | A valid PDF document object.
  [in] | nametree | A PDF name tree object that represents an EmbeddedFiles name tree. If this PDF name tree object is constructed by default constructor and has not been set any value, that means the attachments object will be constructed from PDF document; otherwise, please ensure it belongs to the PDF document specified by parameter doc. Default value: a PDF name tree object by default constructor and not set any value.

## ◆ ExtractEmbeddedFileTo()

FSDK.Attachments.ExtractEmbeddedFileTo | ( | key | ,
|  | dst_file_path |
| ) |  |

Extract an attachment and save it to a specified file path.

Parameters

  [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.

Returns
  true means success, while false means failure.

## ◆ GetCount()

FSDK.Attachments.GetCount | ( |  | ) |

Get the count of attachments.

Returns
  The count of attachments.

## ◆ GetEmbeddedFile()

FSDK.Attachments.GetEmbeddedFile | ( | key |  | ) |

Get the attachment (as file specification object) of a specified key.

Parameters

  [in] | key | Key string. It should not be an empty string.

Returns
  A file specification object.

## ◆ GetKey()

FSDK.Attachments.GetKey | ( | index |  | ) |

Get the key of an attachment defined in the EmbeddedFiles name tree, by index.

Parameters

  [in] | index | Index of the key string to be retrieved. Valid range: from 0 to (count-1). count is returned by function FSDK.Attachments.GetCount.

Returns
  A key string.

## ◆ GetNameTree()

FSDK.Attachments.GetNameTree | ( |  | ) |

Get the EmbeddedFiles name tree.

Returns
  The EmbeddedFiles name tree.

## ◆ IsEmpty()

FSDK.Attachments.IsEmpty | ( |  | ) |

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
  true means current object is empty, while false means not.

## ◆ RemoveAllEmbeddedFiles()

FSDK.Attachments.RemoveAllEmbeddedFiles | ( |  | ) |

Remove all attachments.

Returns
  true means success, while false means failure.

## ◆ RemoveEmbeddedFile()

FSDK.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.

Parameters

  [in] | key | Key string. This should not be an empty string.

Returns
  true means success, while false means failure.

## ◆ SetEmbeddedFile()

FSDK.Attachments.SetEmbeddedFile | ( | key | ,
|  | file_spec |
| ) |  |

Set an embedded attachment (as file specification object) for a specified key.

Parameters

  [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.

Returns
  true means success, while false means failure.