Foxit PDF SDK
fsdk.Link类 参考

Public 成员函数

def ExecuteJavaScriptAction (javascript_action)
 执行与链接注释关联的 JavaScript 动作。 更多...
 
def GetAction ()
 获取动作。 更多...
 
def GetHighlightingMode ()
 获取高亮模式。 更多...
 
def GetQuadPoints ()
 获取四边形。 更多...
 
def RemoveAction ()
 移除动作。 更多...
 
def SetAction (action)
 设置动作。 更多...
 
def SetHighlightingMode (mode)
 设置高亮模式。 更多...
 
def SetQuadPoints (quad_points_array)
 设置四边形。 更多...
 

详细描述

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

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

成员函数说明

◆ ExecuteJavaScriptAction()

def fsdk.Link.ExecuteJavaScriptAction (   javascript_action)

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

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

◆ GetAction()

def fsdk.Link.GetAction ( )

获取动作。

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

◆ GetHighlightingMode()

def fsdk.Link.GetHighlightingMode ( )

获取高亮模式。

返回
高亮模式值。请参考从 fsdk.AnnotE_HighlightingNone 开始的值, 这将是这些值中的一个,除了 fsdk.AnnotE_HighlightingToggle 。 -1 表示没有找到高亮模式值。

◆ GetQuadPoints()

def fsdk.Link.GetQuadPoints ( )

获取四边形。

四边形中点的顺序应为:

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

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

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

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

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

◆ RemoveAction()

def fsdk.Link.RemoveAction ( )

移除动作。

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

◆ SetAction()

def fsdk.Link.SetAction (   action)

◆ SetHighlightingMode()

def fsdk.Link.SetHighlightingMode (   mode)

设置高亮模式。

参数
[in]mode新的高亮模式值。请参考从 fsdk.AnnotE_HighlightingNone 开始的值, 这应该是这些值中的一个,除了 fsdk.AnnotE_HighlightingToggle
返回
无。

◆ SetQuadPoints()

def fsdk.Link.SetQuadPoints (   quad_points_array)

设置四边形。

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

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

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

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

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

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

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