Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::pdf::actions::EmbeddedGotoTarget类 参考
类 foxit::pdf::actions::EmbeddedGotoTarget 继承关系图:

## Public 成员函数
| EmbeddedGotoTarget (const EmbeddedGotoTarget &action)
| 构造函数，使用另一个嵌入转到目标对象。 更多...
| EmbeddedGotoTarget (const foxit::pdf::PDFDoc &document, foxit::pdf::objects::PDFDictionary *target_object)
| 构造函数，使用PDF字典。 更多...
| EmbeddedGotoTarget (const PDFDoc &document)
| 构造函数，使用PDF文档。 更多...
| ~EmbeddedGotoTarget ()
| 析构函数。
WString | GetAttachedFileName ()
| 获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
objects::PDFDictionary * | GetDict () const
| 获取当前对象的PDF字典。 更多...
int | GetFileAttachmentAnnotIndex ()
| 获取指定页面中文件附件注释的注释索引。 更多...
int | GetPageIndex ()
| 获取指定包含目标文件附件注释的页面的页面索引。 更多...
String | GetRelationship ()
| 获取当前目标对象和当前目标对象所属对象之间的关系。 更多...
EmbeddedGotoTarget | GetTarget ()
| 获取指定到目标文档的附加路径信息的目标。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const EmbeddedGotoTarget &other) const
| 不等于运算符。 更多...
EmbeddedGotoTarget & | operator= (const EmbeddedGotoTarget &other)
| 赋值运算符。 更多...
bool | operator== (const EmbeddedGotoTarget &other) const
| 等于运算符。 更多...
void | SetAttachedFileName (const WString &embed_file_name)
| 设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
void | SetFileAttachmentAnnotIndex (int annot_index)
| 设置指定页面中文件附件注释的注释索引。 更多...
void | SetPageIndex (int page_index)
| 设置指定包含目标文件附件注释的页面的页面索引。 更多...
void | SetRelationship (const String &relationship)
| 设置当前目标对象和当前目标对象所属对象之间的关系。 更多...
void | SetTarget (const EmbeddedGotoTarget &target)
| 设置指定到目标文档的附加路径信息的目标。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

嵌入转到动作的目标是目标所在的文档。

参见
  EmbeddedGotoAction

## 构造及析构函数说明

## ◆ EmbeddedGotoTarget() [1/3]

foxit::pdf::actions::EmbeddedGotoTarget::EmbeddedGotoTarget | ( | const PDFDoc & | document | ) |
| explicit

构造函数，使用PDF文档。

此构造函数用于构造一个新的嵌入转到目标对象（不包含任何数据）。

参数

  [in] | document | 有效的PDF文档对象。

## ◆ EmbeddedGotoTarget() [2/3]

foxit::pdf::actions::EmbeddedGotoTarget::EmbeddedGotoTarget | ( | const foxit::pdf::PDFDoc & | document,
|  | foxit::pdf::objects::PDFDictionary * | target_object
| ) |  |

构造函数，使用PDF字典。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | target_object | 表示嵌入转到目标数据的PDF字典。

## ◆ EmbeddedGotoTarget() [3/3]

foxit::pdf::actions::EmbeddedGotoTarget::EmbeddedGotoTarget | ( | const EmbeddedGotoTarget & | action | ) |

构造函数，使用另一个嵌入转到目标对象。

参数

  [in] | action | 另一个嵌入转到目标对象。

## 成员函数说明

## ◆ GetAttachedFileName()

WString foxit::pdf::actions::EmbeddedGotoTarget::GetAttachedFileName | ( |  | ) |

获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性是有效字符串， 那意味着目标文件是在"EmbeddedFiles"名称树中定义的嵌入文件。

返回
  嵌入文件名。

## ◆ GetDict()

objects::PDFDictionary* foxit::pdf::actions::EmbeddedGotoTarget::GetDict | ( |  | ) | const

获取当前对象的PDF字典。

返回
  PDF字典。如果有任何错误，此函数将返回NULL。

## ◆ GetFileAttachmentAnnotIndex()

int foxit::pdf::actions::EmbeddedGotoTarget::GetFileAttachmentAnnotIndex | ( |  | ) |

获取指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数EmbeddedGotoTarget::GetPageIndex可用于 获取指定包含目标文件附件注释的页面的页面索引。

返回
  指定文件附件注释的注释索引。有效值从0开始。 -1表示没有此类属性。

## ◆ GetPageIndex()

int foxit::pdf::actions::EmbeddedGotoTarget::GetPageIndex | ( |  | ) |

获取指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关。此属性仅指定包含文件附件注释的页面。 函数EmbeddedGotoTarget::GetFileAttachmentAnnotIndex 可用于获取目标文件附件注释的注释索引。

返回
  页面索引。有效值从0开始。-1表示没有此类属性。

## ◆ GetRelationship()

String foxit::pdf::actions::EmbeddedGotoTarget::GetRelationship | ( |  | ) |

获取当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

- "P"：当前目标对象是当前目标对象所属对象的父对象。
- "C"：当前目标对象是当前目标对象所属对象的子对象。

返回
  关系字符串。

## ◆ GetTarget()

EmbeddedGotoTarget foxit::pdf::actions::EmbeddedGotoTarget::GetTarget | ( |  | ) |

获取指定到目标文档的附加路径信息的目标。

返回
  嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget::IsEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

## ◆ IsEmpty()

bool foxit::pdf::actions::EmbeddedGotoTarget::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当当前对象为空时，那意味着当前对象是无用的。

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

## ◆ operator!=()

bool foxit::pdf::actions::EmbeddedGotoTarget::operator!= | ( | const EmbeddedGotoTarget & | other | ) | const

不等于运算符。

参数

  [in] | other | 另一个嵌入转到目标对象。此函数将检查当前对象是否不等于此对象。

返回
  true表示不相等，而false表示相等。

## ◆ operator=()

EmbeddedGotoTarget& foxit::pdf::actions::EmbeddedGotoTarget::operator= | ( | const EmbeddedGotoTarget & | other | ) |

赋值运算符。

参数

  [in] | other | 另一个嵌入转到目标对象，其值将分配给当前对象。

返回
  当前对象本身的引用。

## ◆ operator==()

bool foxit::pdf::actions::EmbeddedGotoTarget::operator== | ( | const EmbeddedGotoTarget & | other | ) | const

等于运算符。

参数

  [in] | other | 另一个嵌入转到目标对象。此函数将检查当前对象是否等于此对象。

返回
  true表示相等，而false表示不相等。

## ◆ SetAttachedFileName()

void foxit::pdf::actions::EmbeddedGotoTarget::SetAttachedFileName | ( | const WString & | embed_file_name | ) |

设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件是 在"EmbeddedFiles"名称树中定义的嵌入文件。

参数

  [in] | embed_file_name | 嵌入文件的名称。

返回
  无。

## ◆ SetFileAttachmentAnnotIndex()

void foxit::pdf::actions::EmbeddedGotoTarget::SetFileAttachmentAnnotIndex | ( | int | annot_index | ) |

设置指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数EmbeddedGotoTarget::SetPageIndex可用于 设置指定包含目标文件附件注释的页面的页面索引。

参数

  [in] | annot_index | 指定文件附件注释的注释索引。 有效范围：从0到(count-1)。count表示 指定页面中的注释数量。

返回
  无。

## ◆ SetPageIndex()

void foxit::pdf::actions::EmbeddedGotoTarget::SetPageIndex | ( | int | page_index | ) |

设置指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定包含文件附件注释的页面。 函数EmbeddedGotoTarget::SetFileAttachmentAnnotIndex 可用于设置目标文件附件注释的注释索引。

参数

  [in] | page_index | 指定包含目标文件附件注释的页面的页面索引。 有效范围：从0到(count-1)。count表示 当前目标PDF文件的页面数量。

返回
  无。

## ◆ SetRelationship()

void foxit::pdf::actions::EmbeddedGotoTarget::SetRelationship | ( | const String & | relationship | ) |

设置当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

- "P"：当前目标对象是当前目标对象所属对象的父对象。
- "C"：当前目标对象是当前目标对象所属对象的子对象。

参数

  [in] | relationship | 应该是以下字符串之一："P"、"C"。

返回
  无。

## ◆ SetTarget()

void foxit::pdf::actions::EmbeddedGotoTarget::SetTarget | ( | const EmbeddedGotoTarget & | target | ) |

设置指定到目标文档的附加路径信息的目标。

参数

  [in] | target | 嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget::IsEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

返回
  无。