fsdk.TabOrderMgr类 参考

Public 成员函数
def	AdjustStructureOrder (annot_array)
	使用指定注释调整结构顺序，Tab键顺序类型将同时设置为fsdk.TabOrderMgrE_Structure 。 更多...
def	GetFirstAnnot ()
	获取当前Tab键顺序中的第一个注释。 更多...
def	GetLastAnnot ()
	获取当前Tab键顺序中的最后一个注释。 更多...
def	GetNextAnnot (annot)
	获取当前Tab键顺序中指定注释的下一个注释。 更多...
def	GetOrderType ()
	获取Tab键顺序类型。 更多...
def	GetPrevAnnot (annot)
	获取当前Tab键顺序中指定注释的前一个注释。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	Reload ()
	重新加载注释的Tab键顺序。 更多...
def	SetOrderType (order_type)
	设置Tab键顺序类型。 更多...

详细描述

Tab键顺序是在PDF页面上使用键盘Tab键在注释间导航的顺序。 此类提供了管理在PDF页面上注释间移动键盘焦点顺序的功能。 Tab键顺序管理器将忽略以下类型的注释：
作为回复注释的备注注释、作为状态注释的备注注释、 弹出注释、标志包含fsdk.AnnotE_FlagHidden 的注释。
此类提供了获取顺序类型和按顺序类型逐个获取注释的功能。 此类还提供了更改顺序类型的功能：

• fsdk.TabOrderMgr.SetOrderType 可用于更改Tab键顺序类型。 特别地，如果Tab键顺序类型更改为fsdk.TabOrderMgrE_Structure ， 可以调用fsdk.TabOrderMgr.AdjustStructureOrder 函数来设置顺序。

• 可以直接调用fsdk.TabOrderMgr.AdjustStructureOrder 函数将顺序类型 更改为结构顺序并同时设置结构顺序。

在使用fsdk.TabOrderMgr.SetOrderType 或调用fsdk.TabOrderMgr.AdjustStructureOrder 函数后，应该调用fsdk.TabOrderMgr.Reload 函数； 否则注释的顺序可能不会按预期更改。

参见

PDFPage

fsdk.Annot

成员函数说明

AdjustStructureOrder()

def fsdk.TabOrderMgr.AdjustStructureOrder

(

annot_array

)

使用指定注释调整结构顺序，Tab键顺序类型将同时设置为fsdk.TabOrderMgrE_Structure 。

此函数用于调整结构Tab键顺序的注释顺序。 首先，根据输入数组中的顺序重新排序输入数组中的注释， 然后根据PDF文档的阅读方向重新排序其余注释（未包含在输入数组中的注释）。
此函数成功后，相关PDF页面中所有注释的索引都将更改。

参数

[in]

annot_array

将首先为结构Tab键顺序重新排序的注释数组。 此数组中的所有注释都应属于与当前Tab键顺序管理器相关的同一页面。 这些注释都应该是有效的，并且应该彼此不同。

返回

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

GetFirstAnnot()

def fsdk.TabOrderMgr.GetFirstAnnot

(

)

获取当前Tab键顺序中的第一个注释。

返回

第一个注释。如果返回的注释对象的fsdk.Annot.IsEmpty 函数返回值为true， 则表示没有注释。

GetLastAnnot()

def fsdk.TabOrderMgr.GetLastAnnot

(

)

获取当前Tab键顺序中的最后一个注释。

返回

最后一个注释。如果返回的注释对象的fsdk.Annot.IsEmpty 函数返回值为true， 则表示没有注释。

GetNextAnnot()

def fsdk.TabOrderMgr.GetNextAnnot

(

annot

)

获取当前Tab键顺序中指定注释的下一个注释。

参数

[in]

annot

有效的指定注释。

返回

下一个注释。如果返回的注释对象的fsdk.Annot.IsEmpty 函数返回值为true， 则表示指定注释是当前Tab键顺序中的最后一个注释。

GetOrderType()

def fsdk.TabOrderMgr.GetOrderType

(

)

获取Tab键顺序类型。

返回

Tab键顺序类型。请参考从fsdk.TabOrderMgrE_None 开始的值， 这将是这些值中的一个。

GetPrevAnnot()

def fsdk.TabOrderMgr.GetPrevAnnot

(

annot

)

获取当前Tab键顺序中指定注释的前一个注释。

参数

[in]

annot

有效的指定注释。

返回

前一个注释。如果返回的注释对象的fsdk.Annot.IsEmpty 函数返回值为true， 则表示指定注释是当前Tab键顺序中的第一个注释。

IsEmpty()

def fsdk.TabOrderMgr.IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

Reload()

def fsdk.TabOrderMgr.Reload

(

)

重新加载注释的Tab键顺序。

在以下情况下应该调用此函数：

• 相关PDF页面中的任何注释被移动/删除/添加；

• 相关页面的旋转发生更改；

• 相关PDF文档的阅读方向发生更改；

• 使用fsdk.TabOrderMgr.SetOrderType 或调用fsdk.TabOrderMgr.AdjustStructureOrder 函数来更改Tab键顺序类型或结构顺序。

返回

无。

SetOrderType()

def fsdk.TabOrderMgr.SetOrderType

(

order_type

)

设置Tab键顺序类型。

参数

[in]

order_type

新的Tab键顺序类型。应为以下值之一： fsdk.TabOrderMgrE_None ：表示不使用Tab键顺序。 fsdk.TabOrderMgrE_Row ：表示使用行顺序。 fsdk.TabOrderMgrE_Column ：表示使用列顺序。 fsdk.TabOrderMgrE_Structure ：表示使用结构顺序，然后可以调用 fsdk.TabOrderMgr.AdjustStructureOrder 函数来设置顺序。

返回

无。