Public Member Functions
	CanTagDocument ()
	Check whether the current PDF document can be tagged. More...

	CanTagFormFields ()
	Check whether the form fields in the current PDF document can be auto tagged. More...

	constructor (doc, is_fix)
	Constructor. More...

	GetCurrentFigureElementIndex ()
	Get current figure element index. More...

	GetFigureAlternateText (figure_index)
	Get the alternate text of the figure. More...

	GetFigureCount ()
	Get the count of figures in tagged document, excluding the decorative figures. More...

	GetFigurePageIndex (figure_index)
	Get the figure page index by the figure index. More...

	GetFigureRect (figure_index)
	Get the rectangle of figure. More...

	GetNextFigureData ()
	Get next figure data. More...

	GetPrevFigureData ()
	Get previous figure data. More...

	HasFigures ()
	Check whether the document has figures. More...

	IsAlreadyTagged ()
	Check whether the current PDF document is already tagged. More...

	IsEmpty ()
	Check whether current object is empty or not. More...

	RemoveTags ()
	Remove the accessibility tag tree tree for the current PDF document. More...

	SaveFigureData ()
	Save figure data. More...

	SetAsDecorativeFigure (figure_index)
	Decorate the figure.The decorative figure can not set alternate text. More...

	SetCallback (callback)
	Set a callback object for tagged PDF. More...

	SetCurrentFigureDataInfo (is_decorative, alternate_text)
	Set current figure data info. More...

	SetFigureAlternateText (figure_index, alternate_text)
	Set figure alternate text. More...

	StartTagDocument (pause, report_callback, callback)
	Start to auto tag the given PDF document with specified tagged settings. More...

	TagFormFields ()
	Tag form fields in the current PDF document. More...

Detailed Description

This class represents settings for a tagged PDF document.The tagged PDF means that only tagging information for PDF structure here. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FSDK.Library.Initialize with a key including "Accessibility" module.

See also: FSDK.Library

Member Function Documentation

◆ CanTagDocument()

FSDK.TaggedPDF.CanTagDocument ( )

inline

Check whether the current PDF document can be tagged.

Returns: true means the document can be tagged, while false means not.

◆ CanTagFormFields()

FSDK.TaggedPDF.CanTagFormFields ( )

inline

Check whether the form fields in the current PDF document can be auto tagged.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns: true means form fields can be auto tagged, while false means not.

◆ constructor()

FSDK.TaggedPDF.constructor	(	doc,
		is_fix
	)

inline

Constructor.

Parameters

[in]	doc	A valid PDF document object to be tagged.
[in]	is_fix	Whether this tagged PDF is used for fix operation. If true, figure data methods will use fix alternate text; if false, they will use no-fix alternate text. Default value: false.

This constructor is to construct a tagged PDF object with specified settings.

◆ GetCurrentFigureElementIndex()

FSDK.TaggedPDF.GetCurrentFigureElementIndex ( )

inline

Get current figure element index.

Returns: The current figure element index.

◆ GetFigureAlternateText()

FSDK.TaggedPDF.GetFigureAlternateText ( figure_index )

inline

Get the alternate text of the figure.

The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in] figure_index The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount.

Returns: The alternative descriptions text.

◆ GetFigureCount()

FSDK.TaggedPDF.GetFigureCount ( )

inline

Get the count of figures in tagged document, excluding the decorative figures.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns: The count of figures.

◆ GetFigurePageIndex()

FSDK.TaggedPDF.GetFigurePageIndex ( figure_index )

inline

Get the figure page index by the figure index.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in] figure_index The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount.

Returns: The page index. Valid value would starts from 0. If there is any error, this function will return -1.

◆ GetFigureRect()

FSDK.TaggedPDF.GetFigureRect ( figure_index )

inline

Get the rectangle of figure.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in] figure_index The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount.

Returns: The figure rectangle.If there is any error, this function will return an empty rectangle.

◆ GetNextFigureData()

FSDK.TaggedPDF.GetNextFigureData ( )

inline

Get next figure data.

Returns: The next figure data object.

◆ GetPrevFigureData()

FSDK.TaggedPDF.GetPrevFigureData ( )

inline

Get previous figure data.

Returns: The previous figure data object.

◆ HasFigures()

FSDK.TaggedPDF.HasFigures ( )

inline

Check whether the document has figures.

Returns: true means the document has figures, while false means not.

◆ IsAlreadyTagged()

FSDK.TaggedPDF.IsAlreadyTagged ( )

inline

Check whether the current PDF document is already tagged.

Returns: true means the document is already tagged, while false means not.

◆ IsEmpty()

FSDK.TaggedPDF.IsEmpty ( )

inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns: true means current object is empty, while false means not.

◆ RemoveTags()

FSDK.TaggedPDF.RemoveTags ( )

inline

Remove the accessibility tag tree tree for the current PDF document.

This method releases the accessibility-side tag tree/cache associated with the document.

Returns: None.

◆ SaveFigureData()

FSDK.TaggedPDF.SaveFigureData ( )

inline

Save figure data.

Returns: true means success, while false means not.

◆ SetAsDecorativeFigure()

FSDK.TaggedPDF.SetAsDecorativeFigure ( figure_index )

inline

Decorate the figure.The decorative figure can not set alternate text.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in] figure_index The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount.

Returns: true means decorate figure successed, while false means not.

◆ SetCallback()

FSDK.TaggedPDF.SetCallback ( callback )

inline

Set a callback object for tagged PDF.

Deprecated:: This function has been deprecated since Foxit PDF SDK 12.0. Please use function FSDK.TaggedPDF.StartTagDocument instead, which receives the report callbacks (report stream and localized report text) directly as parameters.

If this function is not called, that means no callback will be used.

Parameters

[in] callback A FSDK.TaggedPDFCallback object which is implemented by user. User can change some information/data during tagged PDF document by this callback. Please ensure that the callback object keeps valid until the life-cycle of current tagged PDF object ends.
If this is NULL, that means to use default information/data.

Returns: None.

◆ SetCurrentFigureDataInfo()

FSDK.TaggedPDF.SetCurrentFigureDataInfo	(	is_decorative,
		alternate_text
	)

inline

Set current figure data info.

Parameters

[in]	is_decorative	Whether the figure is decorative.
[in]	alternate_text	The alternate text.

Returns: None.

◆ SetFigureAlternateText()

FSDK.TaggedPDF.SetFigureAlternateText	(	figure_index,
		alternate_text
	)

inline

Set figure alternate text.

The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]	figure_index	The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount.
[in]	alternate_text	The alternative descriptions text.

Returns: None.

◆ StartTagDocument()

FSDK.TaggedPDF.StartTagDocument	(	pause,
		report_callback,
		callback
	)

inline

Start to auto tag the given PDF document with specified tagged settings.

If user wants to get specific tag results during the tagging document process, please pass a valid report_callback and/or callback parameter to this function.

Parameters

[in]	pause	Pause object which decides if the auto tagging process needs to be paused. This can be NULL which means not to pause during the tagging process. If this is not NULL, it should be a valid pause object implemented by user. Default value: NULL.
[in]	report_callback	A FSDK.StreamCallback object used to receive the generated auto tag report stream. This can be NULL which means not to output the report. If this is not NULL, it should be a valid stream callback object implemented by user. Default value: NULL.
[in]	callback	An FSDK.AutoTagProviderCallback object which is implemented by user. User can provide the localized report text during tagged PDF document by this callback. Please ensure that the callback object keeps valid until the life-cycle of current tagged PDF object ends. If this is NULL, that means to use default report text.

Returns: A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.

◆ TagFormFields()

FSDK.TaggedPDF.TagFormFields ( )

inline

Tag form fields in the current PDF document.

The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns: true means form fields tagged successfully, while false means not.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanTagDocument()

◆ CanTagFormFields()

◆ constructor()

◆ GetCurrentFigureElementIndex()

◆ GetFigureAlternateText()

◆ GetFigureCount()

◆ GetFigurePageIndex()

◆ GetFigureRect()

◆ GetNextFigureData()

◆ GetPrevFigureData()

◆ HasFigures()

◆ IsAlreadyTagged()

◆ IsEmpty()

◆ RemoveTags()

◆ SaveFigureData()

◆ SetAsDecorativeFigure()

◆ SetCallback()

◆ SetCurrentFigureDataInfo()

◆ SetFigureAlternateText()

◆ StartTagDocument()

◆ TagFormFields()