表示已标记 PDF 文档的设置。本模块仅涉及 PDF 结构的标记信息。更多...

类 foxit.addon.accessibility.TaggedPDF 继承关系图:

Public 成员函数
	TaggedPDF (PDFDoc doc, bool is_fix)
	构造函数。更多...

	TaggedPDF (TaggedPDF other)
	拷贝构造函数。更多...

bool	CanTagDocument ()
	检查当前 PDF 文档是否可以被标记。更多...

bool	CanTagFormFields ()
	检查当前 PDF 文档中的表单字段是否可以被自动标记。更多...

int	GetCurrentFigureElementIndex ()
	获取当前图像元素的索引。更多...

string	GetFigureAlternateText (int figure_index)
	获取图像的替代文本。更多...

int	GetFigureCount ()
	获取标记文档中（不包括装饰性图像）的图像计数。更多...

int	GetFigurePageIndex (int figure_index)
	根据图像索引获取图像所在的页面索引。更多...

RectF	GetFigureRect (int figure_index)
	获取图像的矩形区域。更多...

AlternateTextFigureData	GetNextFigureData ()
	获取下一个图像数据。更多...

AlternateTextFigureData	GetPrevFigureData ()
	获取上一个图像数据。更多...

bool	HasFigures ()
	检查文档是否包含图像。更多...

bool	IsAlreadyTagged ()
	检查当前 PDF 文档是否已被标记。更多...

bool	IsEmpty ()
	检查当前对象是否为空。更多...

void	RemoveTags ()
	从当前 PDF 文档中移除标签。更多...

bool	SaveFigureData ()
	保存图像数据。更多...

bool	SetAsDecorativeFigure (int figure_index)
	将指定索引的图像设为装饰性图像。装饰性图像不能设置替代文本。更多...

void	SetCallback (TaggedPDFCallback callback)

void	SetCurrentFigureDataInfo (bool is_decorative, string alternate_text)
	设置当前图像数据的信息。更多...

void	SetFigureAlternateText (int figure_index, string alternate_text)
	设置图像的替代文本。更多...

Progressive	StartTagDocument (PauseCallback pause, StreamCallback report_callback, AutoTagProviderCallback callback)
	开始对给定 PDF 文档执行自动标记，使用当前的标记设置。更多...

bool	TagFormFields ()
	对当前 PDF 文档的表单字段进行标记。更多...

详细描述

表示已标记 PDF 文档的设置。本模块仅涉及 PDF 结构的标记信息。

在使用本模块中的任何类或方法之前，请确保已通过密钥（包含 "Accessibility" 模块）成功调用 common.Library.Initialize 来初始化 Foxit PDF SDK。

参见: foxit.common.Library

构造及析构函数说明

◆ TaggedPDF() [1/2]

foxit.addon.accessibility.TaggedPDF.TaggedPDF	(	PDFDoc	doc,
		bool	is_fix
	)

inline

构造函数。

参数

[in]	doc	要标记的有效 PDF 文档对象。
[in]	is_fix	指示该 TaggedPDF 是否用于修复操作。若为 true，则图像数据方法将使用修复后的替代文本；若为 false，则使用未修复的替代文本。默认值：false。

本构造函数用于使用指定设置构造 TaggedPDF 对象。

◆ TaggedPDF() [2/2]

foxit.addon.accessibility.TaggedPDF.TaggedPDF ( TaggedPDF other )

inline

拷贝构造函数。

参数

[in] other 另一个 TaggedPDF 对象。

成员函数说明

◆ CanTagDocument()

bool foxit.addon.accessibility.TaggedPDF.CanTagDocument ( )

inline

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

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

◆ CanTagFormFields()

bool foxit.addon.accessibility.TaggedPDF.CanTagFormFields ( )

inline

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

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

返回: true 表示表单字段可以自动标记，false 表示不可以。

◆ GetCurrentFigureElementIndex()

int foxit.addon.accessibility.TaggedPDF.GetCurrentFigureElementIndex ( )

inline

获取当前图像元素的索引。

返回: 当前图像元素索引。

◆ GetFigureAlternateText()

string foxit.addon.accessibility.TaggedPDF.GetFigureAlternateText ( int figure_index )

inline

获取图像的替代文本。

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

参数

[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 TaggedPDF.GetFigureCount 返回。

返回: 替代描述文本。

◆ GetFigureCount()

int foxit.addon.accessibility.TaggedPDF.GetFigureCount ( )

inline

获取标记文档中（不包括装饰性图像）的图像计数。

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

返回: 图像数量。

◆ GetFigurePageIndex()

int foxit.addon.accessibility.TaggedPDF.GetFigurePageIndex ( int figure_index )

inline

根据图像索引获取图像所在的页面索引。

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

参数

[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 TaggedPDF.GetFigureCount 返回。

返回: 页面索引（从 0 开始）。如发生错误，返回 -1。

◆ GetFigureRect()

RectF foxit.addon.accessibility.TaggedPDF.GetFigureRect ( int figure_index )

inline

获取图像的矩形区域。

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

参数

[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 TaggedPDF.GetFigureCount 返回。

返回: 图像矩形区域。如果发生错误，返回空矩形。

◆ GetNextFigureData()

AlternateTextFigureData foxit.addon.accessibility.TaggedPDF.GetNextFigureData ( )

inline

获取下一个图像数据。

返回: 下一个图像数据对象。

◆ GetPrevFigureData()

AlternateTextFigureData foxit.addon.accessibility.TaggedPDF.GetPrevFigureData ( )

inline

获取上一个图像数据。

返回: 上一个图像数据对象。

◆ HasFigures()

bool foxit.addon.accessibility.TaggedPDF.HasFigures ( )

inline

检查文档是否包含图像。

返回: true 表示包含图像，false 表示不包含。

◆ IsAlreadyTagged()

bool foxit.addon.accessibility.TaggedPDF.IsAlreadyTagged ( )

inline

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

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

◆ IsEmpty()

bool foxit.addon.accessibility.TaggedPDF.IsEmpty ( )

inline

检查当前对象是否为空。

当对象为空时，表示该对象不可用或无效。

返回: true 表示对象为空，false 表示不为空。

◆ RemoveTags()

void foxit.addon.accessibility.TaggedPDF.RemoveTags ( )

inline

从当前 PDF 文档中移除标签。

返回: 无。

◆ SaveFigureData()

bool foxit.addon.accessibility.TaggedPDF.SaveFigureData ( )

inline

保存图像数据。

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

◆ SetAsDecorativeFigure()

bool foxit.addon.accessibility.TaggedPDF.SetAsDecorativeFigure ( int figure_index )

inline

将指定索引的图像设为装饰性图像。装饰性图像不能设置替代文本。

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

参数

[in] figure_index 图像索引。有效范围：0 到 (count-1)，count 由 TaggedPDF.GetFigureCount 返回。

返回: true 表示设置成功，false 表示失败。

◆ SetCallback()

void foxit.addon.accessibility.TaggedPDF.SetCallback ( TaggedPDFCallback callback )

inline

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

若不调用此函数，则不会使用回调。

参数

[in] callback 一个由用户实现的 TaggedPDFCallback 对象。用户可以通过该回调在标记过程中改变某些信息/数据。请确保在当前 TaggedPDF 对象的生命周期内 callback 保持有效。若为 null，则表示使用默认信息/数据。

返回: 无。

◆ SetCurrentFigureDataInfo()

void foxit.addon.accessibility.TaggedPDF.SetCurrentFigureDataInfo	(	bool	is_decorative,
		string	alternate_text
	)

inline

设置当前图像数据的信息。

参数

[in]	is_decorative	是否为装饰性图像。
[in]	alternate_text	替代文本。

返回: 无。

◆ SetFigureAlternateText()

void foxit.addon.accessibility.TaggedPDF.SetFigureAlternateText	(	int	figure_index,
		string	alternate_text
	)

inline

设置图像的替代文本。

替代文本是人类可读的描述文本，为图片、公式或其他不易转换为文本的项提供可读描述。该函数仅用于已标记的 PDF 文档。请先调用 pdf.PDFDoc.IsTaggedPDF 检查当前文档是否为已标记 PDF。该函数仅可在 fix（修复）模式下使用。

参数

[in]	figure_index	图像索引。有效范围：0 到 (count-1)，count 由 TaggedPDF.GetFigureCount 返回。
[in]	alternate_text	替代描述文本。

返回: 无。

◆ StartTagDocument()

Progressive foxit.addon.accessibility.TaggedPDF.StartTagDocument	(	PauseCallback	pause,
		StreamCallback	report_callback,
		AutoTagProviderCallback	callback
	)

inline

开始对给定 PDF 文档执行自动标记，使用当前的标记设置。

若用户希望在标记过程中获取具体的标记结果，请为本函数传入有效的 report_callback 和/或 callback 参数。

参数

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

返回: 一个 progressive 对象。请使用函数 common.Progressive.GetRateOfProgress 检查当前进度百分比。若进度未达到 100，请调用 common.Progressive.Continue 继续，直到完成。

◆ TagFormFields()

bool foxit.addon.accessibility.TaggedPDF.TagFormFields ( )

inline

对当前 PDF 文档的表单字段进行标记。

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

返回: true 表示表单字段标记成功，false 表示失败。

Public 成员函数

详细描述

构造及析构函数说明

◆ TaggedPDF() [1/2]

◆ TaggedPDF() [2/2]

成员函数说明

◆ CanTagDocument()

◆ CanTagFormFields()

◆ GetCurrentFigureElementIndex()

◆ GetFigureAlternateText()

◆ GetFigureCount()

◆ GetFigurePageIndex()

◆ GetFigureRect()

◆ GetNextFigureData()

◆ GetPrevFigureData()

◆ HasFigures()

◆ IsAlreadyTagged()

◆ IsEmpty()

◆ RemoveTags()

◆ SaveFigureData()

◆ SetAsDecorativeFigure()

◆ SetCallback()

◆ SetCurrentFigureDataInfo()

◆ SetFigureAlternateText()

◆ StartTagDocument()

◆ TagFormFields()