Foxit PDF SDK

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

## Public 成员函数
| Link ()
| 构造函数。
| Link (const Annot &annot)
| 构造函数，使用父类对象。 更多...
| ~Link ()
| 析构函数。
bool | ExecuteJavaScriptAction (const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
| 执行与链接注释关联的 JavaScript 动作。 更多...
actions::Action | GetAction ()
| 获取动作。 更多...
HighlightingMode | GetHighlightingMode ()
| 获取高亮模式。 更多...
QuadPointsArray | GetQuadPoints () const
| 获取四边形。 更多...
bool | RemoveAction ()
| 移除动作。 更多...
void | SetAction (const actions::Action &action)
| 设置动作。 更多...
void | SetHighlightingMode (HighlightingMode mode)
| 设置高亮模式。 更多...
void | SetQuadPoints (const QuadPointsArray &quad_points_array)
| 设置四边形。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Annot
| Annot ()
| 构造函数。
| Annot (const Annot &annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
virtual | ~Annot ()
| 析构函数。
objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const
| 获取具有指定类型和状态的注释外观流。 更多...
RGB | GetBorderColor () const
| 获取边框颜色。 更多...
BorderInfo | GetBorderInfo () const
| 获取边框信息。 更多...
WString | GetContent () const
| 获取内容。 更多...
RectI | GetDeviceRect (const Matrix &matrix)
| 获取设备坐标系统中的注释矩形。 更多...
objects::PDFDictionary * | GetDict () const
| 获取注释的字典对象。 更多...
Matrix | GetDisplayMatrix (const Matrix &page_display_matrix)
| 获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。 更多...
uint32 | GetFlags () const
| 获取注释标志。 更多...
int | GetIndex () const
| 获取当前注释在其所属页面中的索引。 更多...
DateTime | GetModifiedDateTime () const
| 获取最后修改日期时间。 更多...
objects::PDFDictionary * | GetOptionalContent () const
| 获取注释可选内容的PDF字典。 更多...
PDFPage | GetPage () const
| 获取相关的PDF页面。 更多...
RectF | GetRect () const
| 获取矩形，以PDF坐标系统表示。 更多...
Type | GetType () const
| 获取当前注释的实际注释类型。 更多...
WString | GetUniqueID () const
| 获取唯一ID。 更多...
bool | HasProperty (Property property) const
| 当前注释是否具有指定的注释属性。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsMarkup () const
| 检查当前注释是否为标记注释。 更多...
bool | Move (const RectF &rect)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | Move (const RectF &rect, bool is_reset_appearance)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | operator!= (const Annot &other) const
| 不等于运算符。 更多...
Annot & | operator= (const Annot &annot)
| 赋值运算符。 更多...
bool | operator== (const Annot &other) const
| 等于运算符。 更多...
bool | RemoveProperty (Property property)
| 删除指定的注释属性。 更多...
bool | ResetAppearanceStream ()
| 重置外观流。 更多...
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj)
| 重置外观流。 更多...
void | SetBorderColor (RGB color)
| 设置边框颜色。 更多...
void | SetBorderInfo (const BorderInfo &border)
| 设置边框信息。 更多...
void | SetContent (const WString &content)
| 设置内容。 更多...
void | SetFlags (uint32 flags)
| 设置注释标志。 更多...
void | SetModifiedDateTime (const DateTime &date_time)
| 设置最后修改日期时间。 更多...
void | SetUniqueID (const WString &unique_id)
| 设置唯一ID。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit::pdf::annots::Annot
enum | AppearanceType { e_AppearanceTypeNormal = 0, e_AppearanceTypeRollover = 1, e_AppearanceTypeDown = 2 }
| 注释外观类型的枚举。 更多...
enum | Flags { e_FlagInvisible = 0x0001, e_FlagHidden = 0x0002, e_FlagPrint = 0x0004, e_FlagNoZoom = 0x0008, e_FlagNoRotate = 0x0010, e_FlagNoView = 0x0020, e_FlagReadOnly = 0x0040, e_FlagLocked = 0x0080, e_FlagToggleNoView = 0x0100, e_FlagLockedContents = 0x0200 }
| PDF注释标志的枚举。 更多...
enum | HighlightingMode { e_HighlightingNone = 0, e_HighlightingInvert = 1, e_HighlightingOutline = 2, e_HighlightingPush = 3, e_HighlightingToggle = 4 }
| PDF注释高亮模式的枚举。 更多...
enum | MKEntry { e_MKEntryRotation = 0, e_MKEntryBorderColor = 1, e_MKEntryBackgroundColor = 2, e_MKEntryNormalCaption = 3, e_MKEntryRolloverCaption = 4, e_MKEntryDownCaption = 5, e_MKEntryNormalIcon = 6, e_MKEntryRolloverIcon = 7, e_MKEntryDownIcon = 8, e_MKEntryIconFit = 9, e_MKEntryIconCaptionRelation = 10 }
| 注释MK字典（外观特征）条目的枚举。 更多...
enum | MKIconCaptionRelation { e_MKRelationNoIcon = 0, e_MKRelationNoCaption = 1, e_MKRelationCaptionBelowIcon = 2, e_MKRelationCaptionAboveIcon = 3, e_MKRelationCaptionRight = 4, e_MKRelationCaptionLeft = 5, e_MKRelationCaptionOvrlayOnIcon = 6 }
| 注释MK字典中图标和标题相对位置的枚举。 更多...
enum | Property { e_PropertyModifiedDate = 0, e_PropertyCreationDate = 1, e_PropertyBorderColor = 2, e_PropertyFillColor = 3 }
| 某些PDF注释属性的枚举。 更多...
enum | Type { e_UnknownType = 0, e_Note = 1, e_Link = 2, e_FreeText = 3, e_Line = 4, e_Square = 5, e_Circle = 6, e_Polygon = 7, e_PolyLine = 8, e_Highlight = 9, e_Underline = 10, e_Squiggly = 11, e_StrikeOut = 12, e_Stamp = 13, e_Caret = 14, e_Ink = 15, e_PSInk = 16, e_FileAttachment = 17, e_Sound = 18, e_Movie = 19, e_Widget = 20, e_Screen = 21, e_PrinterMark = 22, e_TrapNet = 23, e_Watermark = 24, e_3D = 25, e_Popup = 26, e_Redact = 27, e_RichMedia = 28, e_PagingSeal = 29 }
| PDF注释类型的枚举。 更多...

## 详细描述

链接注释表示要执行的动作。
类 annots::Link 派生自 Annot，并提供函数来获取/设置链接注释的属性和 重置链接注释的外观流。

注解
  对于新创建的链接注释，如果用户直接调用函数 Annot::ResetAppearanceStream 而不设置任何其他属性，将使用默认外观：
  边框宽度 = 1.0，边框样式 = BorderInfo::e_Solid， 边框颜色 = 0xFFFF0000（红色），透明度 = 1.0， 高亮模式 = Annot::e_HighlightingNone。

参见
  Annot

## 构造及析构函数说明

## ◆ Link()

foxit::pdf::annots::Link::Link | ( | const Annot & | annot | ) |
| explicit

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ ExecuteJavaScriptAction()

bool foxit::pdf::annots::Link::ExecuteJavaScriptAction | ( | const actions::JavaScriptAction & | javascript_action = `actions::JavaScriptAction((FS_HANDLE) 0)` | ) |

执行与链接注释关联的 JavaScript 动作。

参数

  JavaScriptAction | 要执行的 JavaScript 动作，它应该属于当前注释。 如果值为空，将执行主 JavaScript 动作。

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

## ◆ GetAction()

actions::Action foxit::pdf::annots::Link::GetAction | ( |  | ) |

获取动作。

返回
  接收动作数据的动作对象。如果返回的动作对象的函数 actions::Action::IsEmpty 返回值为 true，那意味着没有动作。

## ◆ GetHighlightingMode()

HighlightingMode foxit::pdf::annots::Link::GetHighlightingMode | ( |  | ) |

获取高亮模式。

返回
  高亮模式值。请参考从 Annot::e_HighlightingNone 开始的值， 这将是这些值中的一个，除了 Annot::e_HighlightingToggle。 -1 表示没有找到高亮模式值。

## ◆ GetQuadPoints()

QuadPointsArray foxit::pdf::annots::Link::GetQuadPoints | ( |  | ) | const

获取四边形。

四边形中点的顺序应为：

- 第一个点是四边形左上角的点。
- 第二个点是四边形右上角的点。
- 第三个点是四边形左下角的点。
- 第四个点是四边形右下角的点。

返回
  接收四边形值的四边形点数组。

## ◆ RemoveAction()

bool foxit::pdf::annots::Link::RemoveAction | ( |  | ) |

移除动作。

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

## ◆ SetAction()

void foxit::pdf::annots::Link::SetAction | ( | const actions::Action & | action | ) |

设置动作。

参数

  [in] | action | 要设置的新动作。它应该是有效的。 当前仅支持以下类型作为新动作： actions::Action::e_TypeGoto, actions::Action::e_TypeURI, actions::Action::e_TypeJavaScript, actions::Action::e_TypeNamed, actions::Action::e_TypeGoToR, actions::Action::e_TypeGoToE, actions::Action::e_TypeSubmitForm, actions::Action::e_TypeResetForm, actions::Action::e_TypeHide, actions::Action::e_TypeLaunch, actions::Action::e_TypeImportData, actions::Action::e_TypeRendition。

返回
  无。

## ◆ SetHighlightingMode()

void foxit::pdf::annots::Link::SetHighlightingMode | ( | HighlightingMode | mode | ) |

设置高亮模式。

参数

  [in] | mode | 新的高亮模式值。请参考从 Annot::e_HighlightingNone 开始的值， 这应该是这些值中的一个，除了 Annot::e_HighlightingToggle。

返回
  无。

## ◆ SetQuadPoints()

void foxit::pdf::annots::Link::SetQuadPoints | ( | const QuadPointsArray & | quad_points_array | ) |

设置四边形。

此属性影响链接注释的外观。四边形中点的顺序应为：

- 第一个点是四边形左上角的点。
- 第二个点是四边形右上角的点。
- 第三个点是四边形左下角的点。
- 第四个点是四边形右下角的点。

如果用户希望新四边形对注释外观有影响，请在设置四边形后调用函数 Annot::ResetAppearanceStream。

参数

  [in] | quad_points_array | 有效的四边形数组。不应为空数组。

返回
  无。