Foxit PDF SDK
foxit.pdf.annots.Link类 参考
类 foxit.pdf.annots.Link 继承关系图:
foxit.pdf.annots.Annot foxit.common.Base

Public 成员函数

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

额外继承的成员函数

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

详细描述

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

注解
对于新创建的链接注释,如果用户直接调用函数 Annot.ResetAppearanceStream 而不设置任何其他属性,将使用默认外观:
边框宽度 = 1.0,边框样式 = foxit.pdf.annots.BorderInfo.Style.e_Solid , 边框颜色 = 0xFFFF0000(红色),透明度 = 1.0, 高亮模式 = foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingNone
参见
Annot

构造及析构函数说明

◆ Link()

foxit.pdf.annots.Link.Link ( Annot  annot)
inline

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

参数
[in]annot父类对象。

成员函数说明

◆ ExecuteJavaScriptAction()

bool foxit.pdf.annots.Link.ExecuteJavaScriptAction ( JavaScriptAction  javascript_action)
inline

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

参数
要执行的JavaScript 动作,它应该属于当前注释。 如果值为空,将执行主 JavaScript 动作。
返回
true 表示成功,而 false 表示失败。

◆ GetAction()

Action foxit.pdf.annots.Link.GetAction ( )
inline

获取动作。

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

◆ GetHighlightingMode()

Annot.HighlightingMode foxit.pdf.annots.Link.GetHighlightingMode ( )
inline

获取高亮模式。

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

◆ GetQuadPoints()

QuadPointsArray foxit.pdf.annots.Link.GetQuadPoints ( )
inline

获取四边形。

四边形中点的顺序应为:

  • 第一个点是四边形左上角的点。

  • 第二个点是四边形右上角的点。

  • 第三个点是四边形左下角的点。

  • 第四个点是四边形右下角的点。

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

◆ RemoveAction()

bool foxit.pdf.annots.Link.RemoveAction ( )
inline

移除动作。

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

◆ SetAction()

◆ SetHighlightingMode()

void foxit.pdf.annots.Link.SetHighlightingMode ( Annot.HighlightingMode  mode)
inline

设置高亮模式。

参数
[in]mode新的高亮模式值。请参考从 foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingNone 开始的值, 这应该是这些值中的一个,除了 foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingToggle
返回
无。

◆ SetQuadPoints()

void foxit.pdf.annots.Link.SetQuadPoints ( QuadPointsArray  quad_points_array)
inline

设置四边形。

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

  • 第一个点是四边形左上角的点。

  • 第二个点是四边形右上角的点。

  • 第三个点是四边形左下角的点。

  • 第四个点是四边形右下角的点。

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

参数
[in]quad_points_array有效的四边形数组。不应为空数组。
返回
无。