FSDK::TaggedPDF类 参考

Public 成员函数
	CanTagDocument ()
	检查当前 PDF 文档是否可以被标记。 更多...
	CanTagFormFields ()
	检查当前 PDF 文档中的表单域是否可以自动标记。 更多...
	constructor (doc, is_fix)
	构造函数。 更多...
	GetCurrentFigureElementIndex ()
	获取当前图形元素索引。 更多...
	GetFigureAlternateText (figure_index)
	获取图形的替换文本。 更多...
	GetFigureCount ()
	获取已标记文档中图形的数量，不包括装饰性图形。 更多...
	GetFigurePageIndex (figure_index)
	通过图形索引获取图形所在页面的索引。 更多...
	GetFigureRect (figure_index)
	获取图形的矩形。 更多...
	GetNextFigureData ()
	获取下一个图形数据。 更多...
	GetPrevFigureData ()
	获取上一个图形数据。 更多...
	HasFigures ()
	检查文档是否包含图形。 更多...
	IsAlreadyTagged ()
	检查当前 PDF 文档是否已被标记。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	RemoveTags ()
	移除当前 PDF 文档的无障碍标签树。 更多...
	SaveFigureData ()
	保存图形数据。 更多...
	SetAsDecorativeFigure (figure_index)
	将图形设置为装饰性图形。装饰性图形不能设置替换文本。 更多...
	SetCallback (callback)
	为标记 PDF 设置回调对象。 更多...
	SetCurrentFigureDataInfo (is_decorative, alternate_text)
	设置当前图形数据信息。 更多...
	SetFigureAlternateText (figure_index, alternate_text)
	设置图形替换文本。 更多...
	StartTagDocument (pause, report_callback, callback)
	使用指定的标记设置开始自动标记给定的 PDF 文档。 更多...
	TagFormFields ()
	标记当前 PDF 文档中的表单域。 更多...

详细描述

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

参见

FSDK.Library

成员函数说明

CanTagDocument()

FSDK::TaggedPDF::CanTagDocument ( )

inline

检查当前 PDF 文档是否可以被标记。

返回

true 表示文档可以被标记，false 表示不可以。

CanTagFormFields()

FSDK::TaggedPDF::CanTagFormFields ( )

inline

检查当前 PDF 文档中的表单域是否可以自动标记。

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

返回

true 表示表单域可以自动标记，false 表示不可以。

constructor()

FSDK::TaggedPDF::constructor (   doc,   is_fix  )

inline

构造函数。

参数

[in]	doc	一个有效的待标记 PDF 文档对象。
[in]	is_fix	此标记 PDF 是否用于修复操作。 如果为 true，图形数据方法将使用修复替换文本； 如果为 false，将使用非修复替换文本。默认值：false。

此构造函数用于以指定设置构造标记 PDF 对象。

GetCurrentFigureElementIndex()

FSDK::TaggedPDF::GetCurrentFigureElementIndex ( )

inline

获取当前图形元素索引。

返回

当前图形元素索引。

GetFigureAlternateText()

FSDK::TaggedPDF::GetFigureAlternateText (   figure_index )

inline

获取图形的替换文本。

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

参数

[in]

figure_index

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

返回

替代描述文本。

GetFigureCount()

FSDK::TaggedPDF::GetFigureCount ( )

inline

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

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

返回

图形的数量。

GetFigurePageIndex()

FSDK::TaggedPDF::GetFigurePageIndex (   figure_index )

inline

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

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

参数

[in]

figure_index

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

返回

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

GetFigureRect()

FSDK::TaggedPDF::GetFigureRect (   figure_index )

inline

获取图形的矩形。

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

参数

[in]

figure_index

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

返回

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

GetNextFigureData()

FSDK::TaggedPDF::GetNextFigureData ( )

inline

获取下一个图形数据。

返回

下一个图形数据对象。

GetPrevFigureData()

FSDK::TaggedPDF::GetPrevFigureData ( )

inline

获取上一个图形数据。

返回

上一个图形数据对象。

HasFigures()

FSDK::TaggedPDF::HasFigures ( )

inline

检查文档是否包含图形。

返回

true 表示文档包含图形，false 表示不包含。

IsAlreadyTagged()

FSDK::TaggedPDF::IsAlreadyTagged ( )

inline

检查当前 PDF 文档是否已被标记。

返回

true 表示文档已被标记，false 表示未被标记。

IsEmpty()

FSDK::TaggedPDF::IsEmpty ( )

inline

检查当前对象是否为空。

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

返回

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

RemoveTags()

FSDK::TaggedPDF::RemoveTags ( )

inline

移除当前 PDF 文档的无障碍标签树。

此方法释放与文档关联的无障碍侧标签树/缓存。

返回

无。

SaveFigureData()

FSDK::TaggedPDF::SaveFigureData ( )

inline

保存图形数据。

返回

true 表示成功，false 表示不成功。

SetAsDecorativeFigure()

FSDK::TaggedPDF::SetAsDecorativeFigure (   figure_index )

inline

将图形设置为装饰性图形。装饰性图形不能设置替换文本。

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

参数

[in]

figure_index

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

返回

true 表示设置装饰性图形成功，false 表示不成功。

SetCallback()

FSDK::TaggedPDF::SetCallback (   callback )

inline

为标记 PDF 设置回调对象。

弃用:

此函数自 Foxit PDF SDK 12.0 起已弃用。 请改用函数 FSDK.TaggedPDF.StartTagDocument，该函数直接接收报告回调 （报告流和本地化报告文本）作为参数。

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

参数

[in]

callback

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

返回

无。

SetCurrentFigureDataInfo()

FSDK::TaggedPDF::SetCurrentFigureDataInfo (   is_decorative,   alternate_text  )

inline

设置当前图形数据信息。

参数

[in]	is_decorative	该图形是否为装饰性图形。
[in]	alternate_text	替换文本。

返回

无。

SetFigureAlternateText()

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

inline

设置图形替换文本。

替换文本是可读文本，通过为图像、公式或其他无法自然转换为文本的项目提供替换文本，可以增强 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,   report_callback,   callback  )

inline

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

如果用户希望在标记文档过程中获取特定的标记结果，请向此函数传递有效的 report_callback 和/或 callback 参数。

参数

[in]	pause	暂停对象，用于决定自动标记过程是否需要暂停。 可以为 NULL，表示在标记过程中不暂停。 如果不为 NULL，则应为用户实现的有效暂停对象。 默认值：NULL。
[in]	report_callback	一个 FSDK.StreamCallback 对象，用于接收 生成的自动标记报告流。可以为 NULL，表示不输出报告。 如果不为 NULL，则应为用户实现的有效流回调对象。默认值：NULL。
[in]	callback	一个由用户实现的 FSDK.AutoTagProviderCallback 对象。 用户可以通过该回调在标记过程中提供本地化报告文本。 请确保在当前 TaggedPDF 对象的生命周期内 callback 保持有效。 若为 NULL，则表示使用默认报告文本。

返回

一个渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度。 如果进度未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

TagFormFields()

FSDK::TaggedPDF::TagFormFields ( )

inline

标记当前 PDF 文档中的表单域。

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

返回

true 表示表单域标记成功，false 表示不成功。