表示已标记 PDF 文档的设置。本模块仅涉及 PDF 结构的标记信息。
更多...
详细描述
表示已标记 PDF 文档的设置。本模块仅涉及 PDF 结构的标记信息。
在使用本模块中的任何类或方法之前，请确保已通过密钥（包含 "Accessibility" 模块） 成功调用 FSLibrary::initialize:key: 来初始化 Foxit PDF SDK。
函数文档
◆ canTagDocument()
| - (BOOL) canTagDocument |
检查当前 PDF 文档是否可以被标记。
- 返回
- YES 表示文档可以被标记，NO 表示不可以。
◆ canTagFormFields()
| - (BOOL) canTagFormFields |
检查当前 PDF 文档中的表单字段是否可以被自动标记。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 返回
- YES 表示表单字段可以自动标记，NO 表示不可以。
◆ getCurrentFigureElementIndex()
| - (int) getCurrentFigureElementIndex |
获取当前图像元素的索引。
- 返回
- 当前图像元素索引。
◆ getFigureAlternateText:()
| - (NSString *) getFigureAlternateText: | (int) | figure_index |
获取图像的替代文本。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 参数
-
[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 FSTaggedPDF::getFigureCount 返回。
- 返回
- 替代描述文本。
◆ getFigureCount()
| - (int) getFigureCount |
◆ getFigurePageIndex:()
| - (int) getFigurePageIndex: | (int) | figure_index |
根据图像索引获取图像所在的页面索引。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 参数
-
[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 FSTaggedPDF::getFigureCount 返回。
- 返回
- 页面索引（从 0 开始）。如发生错误，返回 -1。
◆ getFigureRect:()
| - (FSRectF *) getFigureRect: | (int) | figure_index |
获取图像的矩形区域。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 参数
-
[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 FSTaggedPDF::getFigureCount 返回。
- 返回
- 图像矩形区域。如果发生错误，返回空矩形。
◆ getNextFigureData()
| - (FSAlternateTextFigureData *) getNextFigureData |
获取下一个图像数据。
- 返回
- 下一个图像数据对象。
◆ getPrevFigureData()
| - (FSAlternateTextFigureData *) getPrevFigureData |
获取上一个图像数据。
- 返回
- 上一个图像数据对象。
◆ hasFigures()
| - (BOOL) hasFigures |
检查文档是否包含图像。
- 返回
- YES 表示包含图像，NO 表示不包含。
◆ initWithDoc:is_fix:()
| - (id) initWithDoc: | (FSPDFDoc*) | doc | |
| is_fix: | (BOOL) | is_fix | |
构造函数。
- 参数
-
[in] doc 要标记的有效 PDF 文档对象。
[in] is_fix 指示该 TaggedPDF 是否用于修复操作。 若为 true，则图像数据方法将使用修复后的替代文本； 若为 false，则使用未修复的替代文本。默认值：NO。
本构造函数用于使用指定设置构造 TaggedPDF 对象。
◆ initWithOther:()
| - (id) initWithOther: | (FSTaggedPDF*) | other |
拷贝构造函数。
- 参数
-
[in] other 另一个 TaggedPDF 对象。
◆ isAlreadyTagged()
| - (BOOL) isAlreadyTagged |
检查当前 PDF 文档是否已被标记。
- 返回
- YES 表示文档已被标记，NO 表示未被标记。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当对象为空时，表示该对象不可用或无效。
- 返回
- YES 表示对象为空，NO 表示不为空。
◆ removeTags()
| - (void) removeTags |
从当前 PDF 文档中移除标签。
- 返回
- 无。
◆ saveFigureData()
| - (BOOL) saveFigureData |
保存图像数据。
- 返回
- YES 表示成功，NO 表示失败。
◆ setAsDecorativeFigure:()
| - (BOOL) setAsDecorativeFigure: | (int) | figure_index |
将指定索引的图像设为装饰性图像。装饰性图像不能设置替代文本。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 参数
-
[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 FSTaggedPDF::getFigureCount 返回。
- 返回
- YES 表示设置成功，NO 表示失败。
◆ setCallback:()
| - (void) setCallback: | (id<FSTaggedPDFCallback>) | callback |
- 弃用:
- 此函数自 Foxit PDF SDK 12.0 起已废弃。 请改用函数 FSTaggedPDF::startTagDocument:report_callback:callback:，该函数将报告回调 （报告数据流与本地化报告文本）直接作为参数接收。
若不调用此函数，则不会使用回调。
- 参数
-
[in] callback 一个由用户实现的 FSTaggedPDFCallback 对象。 用户可以通过该回调在标记过程中改变某些信息/数据。 请确保在当前 TaggedPDF 对象的生命周期内 callback 保持有效。 若为 nil，则表示使用默认信息/数据。
- 返回
- 无。
◆ setCurrentFigureDataInfo:alternate_text:()
| - (void) setCurrentFigureDataInfo: | (BOOL) | is_decorative | |
| alternate_text: | (NSString *) | alternate_text | |
设置当前图像数据的信息。
- 参数
-
[in] is_decorative 是否为装饰性图像。
[in] alternate_text 替代文本。
- 返回
- 无。
◆ setFigureAlternateText:alternate_text:()
| - (void) setFigureAlternateText: | (int) | figure_index | |
| alternate_text: | (NSString *) | alternate_text | |
设置图像的替代文本。
替代文本是人类可读的描述文本，为图片、公式或其他不易转换为文本的项提供可读描述。 该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。 该函数仅可在 fix（修复）模式下使用。
- 参数
-
[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 FSTaggedPDF::getFigureCount 返回。
[in] alternate_text 替代描述文本。
- 返回
- 无。
◆ startTagDocument:report_callback:callback:()
| - (FSProgressive *) startTagDocument: | (id<FSPauseCallback>) | pause | |
| report_callback: | (id<FSFileStreamCallback>) | report_callback | |
| callback: | (id<FSAutoTagProviderCallback>) | callback | |
开始对给定 PDF 文档执行自动标记，使用当前的标记设置。
若用户希望在标记过程中获取具体的标记结果，请为本函数传入有效的 report_callback 和/或 callback 参数。
- 参数
-
[in] pause 决定是否在自动标记过程中需要暂停的 Pause 对象。 可为 nil（表示不在标记过程中暂停）。 若不为 nil，该对象应为用户实现的有效 Pause 对象。 默认值：nil。
[in] report_callback 用于接收生成的自动标记报告数据流的 FSFileStreamCallback 对象。 可为 nil（表示不输出报告）。若不为 nil，该对象应为用户实现的有效 stream 回调对象。默认值：nil。
[in] callback 一个由用户实现的 FSAutoTagProviderCallback 对象。 用户可以通过该回调在标记过程中提供本地化报告文本。 请确保在当前 TaggedPDF 对象的生命周期内 callback 保持有效。 若为 nil，则表示使用默认报告文本。
- 返回
- 一个 progressive 对象。请使用函数 FSProgressive::getRateOfProgress 检查当前进度百分比。 若进度未达到 100，请调用 FSProgressive::resume 继续，直到完成。
◆ tagFormFields()
| - (BOOL) tagFormFields |
对当前 PDF 文档的表单字段进行标记。
该函数仅用于已标记的 PDF 文档。请先调用 FSPDFDoc::isTaggedPDF 检查当前文档是否为已标记 PDF。
- 返回
- YES 表示表单字段标记成功，NO 表示失败。
