Foxit PDF SDK

Public 成员函数 | 所有成员列表
FoxitPDFSDKPython3.Attachments类 参考
类 FoxitPDFSDKPython3.Attachments 继承关系图:

## Public 成员函数
def | Attachments (other)
| 构造函数，通过另一个附件对象。 更多...
def | AddEmbeddedFile (key, file_spec)
| 使用新键名添加嵌入附件（作为文件规范对象）。 更多...
def | AddFromFilePath (key, file_path)
| 使用新键名从指定文件路径添加新附件。 更多...
def | ExtractEmbeddedFileTo (key, dst_file_path)
| 提取附件并将其保存到指定文件路径。 更多...
def | GetCount ()
| 获取附件的数量。 更多...
def | GetEmbeddedFile (key)
| 获取指定键的附件（作为文件规范对象）。 更多...
def | GetKey (index)
| 通过索引获取EmbeddedFiles名称树中定义的附件键。 更多...
def | GetNameTree ()
| 获取EmbeddedFiles名称树。 更多...
def | IsEmpty ()
| 检查当前对象是否为空。 更多...
def | RemoveAllEmbeddedFiles ()
| 移除所有附件。 更多...
def | RemoveEmbeddedFile (key)
| 通过键移除附件。 更多...
def | SetEmbeddedFile (key, file_spec)
| 为指定键设置嵌入附件（作为文件规范对象）。 更多...

## 详细描述

在应用程序中，文档的嵌入文件被称为PDF附件。此类提供了一种比类 FoxitPDFSDKPython3.PDFNameTree 更便捷的方式， 用于获取/设置PDF文档的EmbeddedFiles名称树中的嵌入文件（也称为附件文件）。

参见
  PDFDoc
  FoxitPDFSDKPython3.PDFNameTree

## 构造及析构函数说明

## ◆ Attachments()

def FoxitPDFSDKPython3.Attachments.Attachments | ( |  | other | ) |

构造函数，通过另一个附件对象。

参数

  [in] | other | 另一个附件对象。

## 成员函数说明

## ◆ AddEmbeddedFile()

def FoxitPDFSDKPython3.Attachments.AddEmbeddedFile | ( |  | key,
|  |  | file_spec
| ) |  |

使用新键名添加嵌入附件（作为文件规范对象）。

EmbeddedFiles名称树中的所有附件都按其键排序。 当添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 添加成功后，一些旧键的索引可能会发生变化。

参数

  [in] | key | 新键字符串。如果这是一个空字符串，将使用输入的 file_spec 的名称 作为新键。此新键不应该已存在于当前附件对象所属的PDF文档中。
  [in] | file_spec | 要用新键添加的文件规范对象。它应该是有效的， 并且应该已嵌入到与当前附件对象相同的PDF文档中。

返回
  true 表示成功，false 表示失败。

## ◆ AddFromFilePath()

def FoxitPDFSDKPython3.Attachments.AddFromFilePath | ( |  | key,
|  |  | file_path
| ) |  |

使用新键名从指定文件路径添加新附件。

EmbeddedFiles名称树中的所有附件都按其键排序。 当添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 添加成功后，一些旧键的索引可能会发生变化。

参数

  [in] | key | 新键字符串。如果这是一个空字符串，将使用输入的 file_spec 的名称 作为新键。此新键不应该已存在于当前附件对象所属的PDF文档中。
  [in] | file_path | 指定要嵌入到PDF文档并添加到EmbeddedFiles名称树的文件的文件路径。

返回
  true 表示成功，false 表示失败。

## ◆ ExtractEmbeddedFileTo()

def FoxitPDFSDKPython3.Attachments.ExtractEmbeddedFileTo | ( |  | key,
|  |  | dst_file_path
| ) |  |

提取附件并将其保存到指定文件路径。

参数

  [in] | key | 键字符串。这不应该是空字符串。
  [in] | dst_file_path | 文件路径，附件数据将保存到此路径。 这不应该是空字符串。

返回
  true 表示成功，false 表示失败。

## ◆ GetCount()

def FoxitPDFSDKPython3.Attachments.GetCount | ( |  | ) |

获取附件的数量。

返回
  附件的数量。

## ◆ GetEmbeddedFile()

def FoxitPDFSDKPython3.Attachments.GetEmbeddedFile | ( |  | key | ) |

获取指定键的附件（作为文件规范对象）。

参数

  [in] | key | 键字符串。它不应该是空字符串。

返回
  文件规范对象。

## ◆ GetKey()

def FoxitPDFSDKPython3.Attachments.GetKey | ( |  | index | ) |

通过索引获取EmbeddedFiles名称树中定义的附件键。

参数

  [in] | index | 要检索的键字符串的索引。有效范围：从0到（count-1）。 count 由函数 FoxitPDFSDKPython3.Attachments.GetCount 返回。

返回
  键字符串。

## ◆ GetNameTree()

def FoxitPDFSDKPython3.Attachments.GetNameTree | ( |  | ) |

获取EmbeddedFiles名称树。

返回
  EmbeddedFiles名称树。

## ◆ IsEmpty()

def FoxitPDFSDKPython3.Attachments.IsEmpty | ( |  | ) |

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ RemoveAllEmbeddedFiles()

def FoxitPDFSDKPython3.Attachments.RemoveAllEmbeddedFiles | ( |  | ) |

移除所有附件。

返回
  true 表示成功，false 表示失败。

## ◆ RemoveEmbeddedFile()

def FoxitPDFSDKPython3.Attachments.RemoveEmbeddedFile | ( |  | key | ) |

通过键移除附件。

如果输入键在EmbeddedFiles名称树中不存在， 此函数将直接返回 true。

参数

  [in] | key | 键字符串。这不应该是空字符串。

返回
  true 表示成功，false 表示失败。

## ◆ SetEmbeddedFile()

def FoxitPDFSDKPython3.Attachments.SetEmbeddedFile | ( |  | key,
|  |  | file_spec
| ) |  |

为指定键设置嵌入附件（作为文件规范对象）。

参数

  [in] | key | 键字符串。它不应该是空字符串。 此名称应该已存在于当前PDF文档中。
  [in] | file_spec | 要设置为键值的文件规范对象。它应该是有效的， 并且应该已嵌入到与当前附件对象相同的PDF文档中。

返回
  true 表示成功，false 表示失败。