Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::TabOrderMgr类 参考

## Public 成员函数
| AdjustStructureOrder (annot_array)
| 使用指定的注释调整结构顺序，同时 tab 顺序类型将被设置为 FSDK.TabOrderMgr.e_Structure。 更多...
| constructor (page)
| 从 PDF页面对象构造函数。 更多...
| GetFirstAnnot ()
| 获取当前tab顺序中的第一个注释。 更多...
| GetLastAnnot ()
| 获取当前tab顺序中的最后一个注释。 更多...
| GetNextAnnot (annot)
| 获取当前tab顺序中指定注释的下一个注释。 更多...
| GetOrderType ()
| 获取tab顺序类型。 更多...
| GetPrevAnnot (annot)
| 获取当前tab顺序中指定注释的前一个注释。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| Reload ()
| 重新加载注释的tab顺序。 更多...
| SetOrderType (order_type)
| 设置tab顺序类型。 更多...

## 静态 Public 属性
static | e_Column
| C（列顺序）：注释按在页面上垂直上下运行的列访问。
static | e_None
| tab顺序类型的枚举。 更多...
static | e_Row
| R（行顺序）：注释按跨页面水平运行的行访问。
static | e_Structure
| S（结构顺序）：注释按它们在结构树中出现的顺序访问。

## 详细描述

Tab顺序是通过使用键盘上Tab键在PDF页面上的注释之间导航的顺序。 此类提供函数来管理PDF页面上注释之间移动键盘焦点的顺序。 Tab顺序管理器将忽略以下类型的注释：
作为回复注释的笔记注释、作为状态注释的笔记注释、 弹出注释、标志包含 FSDK.Annot.e_FlagHidden 的注释。
此类提供函数来获取顺序类型并按顺序类型逐个获取注释。 此类还提供函数来更改顺序类型：

- FSDK.TabOrderMgr.SetOrderType 可用于更改tab顺序类型。 特别地，如果tab顺序类型更改为 FSDK.TabOrderMgr.e_Structure， 可以调用函数 FSDK.TabOrderMgr.AdjustStructureOrder 来设置顺序。
- 可以直接调用函数 FSDK.TabOrderMgr.AdjustStructureOrder 来将顺序类型更改为 结构顺序并同时设置结构顺序。

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

参见
  FSDK.PDFPage
  FSDK.Annot

## 成员函数说明

## ◆ AdjustStructureOrder()

FSDK::TabOrderMgr::AdjustStructureOrder | ( | annot_array |  | ) |

使用指定的注释调整结构顺序，同时 tab 顺序类型将被设置为 FSDK.TabOrderMgr.e_Structure。

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

参数

  [in] | annot_array | 将首先为结构 tab 顺序重新排序的注释数组。 此数组中的所有注释应属于与当前 tab 顺序管理器相关的同一页面。 这些注释都应有效且彼此不同。

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

## ◆ constructor()

FSDK::TabOrderMgr::constructor | ( | page |  | ) |

从 PDF页面对象构造函数。

参数

  [in] | page | 一个有效的PDF页面。

## ◆ GetFirstAnnot()

FSDK::TabOrderMgr::GetFirstAnnot | ( |  | ) |

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

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

## ◆ GetLastAnnot()

FSDK::TabOrderMgr::GetLastAnnot | ( |  | ) |

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

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

## ◆ GetNextAnnot()

FSDK::TabOrderMgr::GetNextAnnot | ( | annot |  | ) |

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

参数

  [in] | annot | 有效的指定注释。

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

## ◆ GetOrderType()

FSDK::TabOrderMgr::GetOrderType | ( |  | ) |

获取tab顺序类型。

返回
  tab顺序类型。请参考从 FSDK.TabOrderMgr.e_None 开始的值， 这将是这些值之一。

## ◆ GetPrevAnnot()

FSDK::TabOrderMgr::GetPrevAnnot | ( | annot |  | ) |

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

参数

  [in] | annot | 有效的指定注释。

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

## ◆ IsEmpty()

FSDK::TabOrderMgr::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ Reload()

FSDK::TabOrderMgr::Reload | ( |  | ) |

重新加载注释的tab顺序。

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

- 相关PDF页面中的任何注释被移动/删除/添加；
- 相关页面的旋转被更改；
- 相关PDF文档的阅读方向被更改；
- 使用 FSDK.TabOrderMgr.SetOrderType 或调用函数 FSDK.TabOrderMgr.AdjustStructureOrder 来 更改tab顺序类型或结构顺序。

返回
  无。

## ◆ SetOrderType()

FSDK::TabOrderMgr::SetOrderType | ( | order_type |  | ) |

设置tab顺序类型。

参数

  [in] | order_type | 新的tab顺序类型。它应是以下值之一： FSDK.TabOrderMgr.e_None：表示不使用tab顺序。 FSDK.TabOrderMgr.e_Row：表示使用行顺序。 FSDK.TabOrderMgr.e_Column：表示使用列顺序。 FSDK.TabOrderMgr.e_Structure：表示使用结构顺序，然后可以调用函数 FSDK.TabOrderMgr.AdjustStructureOrder 来设置顺序。

返回
  无。

## 类成员变量说明

## ◆ e_None

FSDK::TabOrderMgr::e_None
| static

tab顺序类型的枚举。

此枚举的值应单独使用。

无（索引顺序）：注释按注释的索引跨页面访问。