Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::TaggedPDF类 参考

## Public 成员函数
| constructor (doc)
| 构造函数。 更多...
| GetFigureAlternateText (figure_index)
| 获取图形的替代文本。 更多...
| GetFigureCount ()
| 获取标记文档中图形的数量，不包括装饰性图形。 更多...
| GetFigurePageIndex (figure_index)
| 通过图形索引获取图形所在的页面索引。 更多...
| GetFigureRect (figure_index)
| 获取图形的矩形。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetAsDecorativeFigure (figure_index)
| 装饰图形。装饰性图形不能设置替代文本。 更多...
| SetCallback (callback)
| 为标记 PDF 设置回调对象。 更多...
| SetFigureAlternateText (figure_index, alternate_text)
| 设置图形替代文本。 更多...
| StartTagDocument (pause)
| 开始使用指定的标记设置自动标记给定的 PDF 文档。 更多...

## 详细描述

此类表示标记 PDF 文档的设置。标记 PDF 意味着此处仅为 PDF 结构标记信息。 在使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK 已通过函数 FSDK.Library.Initialize 使用包含“Accessibility”模块的密钥成功初始化。

参见
  FSDK.Library

## 成员函数说明

## ◆ constructor()

FSDK::TaggedPDF::constructor | ( | doc |  | ) |

构造函数。

参数

  [in] | doc | 要标记的有效 PDF 文档对象。

此构造函数用于使用默认设置构造标记 PDF 对象。

## ◆ GetFigureAlternateText()

FSDK::TaggedPDF::GetFigureAlternateText | ( | figure_index |  | ) |

获取图形的替代文本。

替代文本是人类可读的文本，PDF 文档可以通过为图像、 公式或其他不能自然转换为文本的项目提供替代文本来增强。 此函数仅用于带标签的 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为带标签的 PDF 文档。

参数

  [in] | figure_index | 图形的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.TaggedPDF.GetFigureCount 返回。

返回
  替代描述文本。

## ◆ GetFigureCount()

FSDK::TaggedPDF::GetFigureCount | ( |  | ) |

获取标记文档中图形的数量，不包括装饰性图形。

此函数仅用于标记 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为标记 PDF 文档。

返回
  图形的数量。

## ◆ GetFigurePageIndex()

FSDK::TaggedPDF::GetFigurePageIndex | ( | figure_index |  | ) |

通过图形索引获取图形所在的页面索引。

此函数仅用于带标签的 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为带标签的 PDF 文档。

参数

  [in] | figure_index | 图形的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.TaggedPDF.GetFigureCount 返回。

返回
  页面索引。有效值从 0 开始。如果出现任何错误，此函数将返回 -1。

## ◆ GetFigureRect()

FSDK::TaggedPDF::GetFigureRect | ( | figure_index |  | ) |

获取图形的矩形。

此函数仅用于带标签的 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为带标签的 PDF 文档。

参数

  [in] | figure_index | 图形的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.TaggedPDF.GetFigureCount 返回。

返回
  图形矩形。如果出现任何错误，此函数将返回空矩形。

## ◆ IsEmpty()

FSDK::TaggedPDF::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ SetAsDecorativeFigure()

FSDK::TaggedPDF::SetAsDecorativeFigure | ( | figure_index |  | ) |

装饰图形。装饰性图形不能设置替代文本。

此函数仅用于标记 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为标记 PDF 文档。

参数

  [in] | figure_index | 图形的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.TaggedPDF.GetFigureCount 返回。

返回
  true 表示装饰图形成功，而 false 表示失败。

## ◆ SetCallback()

FSDK::TaggedPDF::SetCallback | ( | callback |  | ) |

为标记 PDF 设置回调对象。

如果未调用此函数，则表示不会使用回调。

参数

  [in] | callback | 由用户实现的 FSDK.TaggedPDFCallback 对象。 用户可以通过此回调在标记 PDF 文档过程中更改某些信息/数据。 请确保回调对象在当前标记 PDF 对象的生命周期结束之前保持有效。 如果为 null，则表示使用默认信息/数据。

返回
  无。

## ◆ SetFigureAlternateText()

FSDK::TaggedPDF::SetFigureAlternateText | ( | figure_index | ,
|  | alternate_text |
| ) |  |

设置图形替代文本。

替代文本是人类可读的文本，PDF 文档可以通过为图像、 公式或其他不能自然转换为文本的项目提供替代文本来增强。 此函数仅用于带标签的 PDF 文档。请调用函数 FSDK.PDFDoc.IsTaggedPDF 检查当前 PDF 文档是否 为带标签的 PDF 文档。

参数

  [in] | figure_index | 图形的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.TaggedPDF.GetFigureCount 返回。
  [in] | alternate_text | 替代描述文本。

返回
  无。

## ◆ StartTagDocument()

FSDK::TaggedPDF::StartTagDocument | ( | pause |  | ) |

开始使用指定的标记设置自动标记给定的 PDF 文档。

如果用户希望在标记文档过程中获取特定的标记结果，请参考函数 FSDK.TaggedPDF.SetCallback 中关于回调函数 FSDK.TaggedPDFCallback.Report 的说明。

参数

  [in] | pause | 决定自动标记过程是否需要暂停的暂停对象。 可以为 null，表示在标记过程中不暂停。 如果不为 null，应为由用户实现的有效暂停对象。 默认值：null。

返回
  进度对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的率。 如果进度率还未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。