fsdk.TaggedPDF Class Reference

Public Member Functions
def	CanTagDocument ()
	Check whether the current PDF document can be tagged. More...
def	CanTagFormFields ()
	Check whether the form fields in the current PDF document can be auto tagged. More...
def	GetCurrentFigureElementIndex ()
	Get current figure element index. More...
def	GetFigureAlternateText (figure_index)
	Get the alternate text of the figure. More...
def	GetFigureCount ()
	Get the count of figures in tagged document, excluding the decorative figures. More...
def	GetFigurePageIndex (figure_index)
	Get the figure page index by the figure index. More...
def	GetFigureRect (figure_index)
	Get the rectangle of figure. More...
def	GetNextFigureData ()
	Get next figure data. More...
def	GetPrevFigureData ()
	Get previous figure data. More...
def	HasFigures ()
	Check whether the document has figures. More...
def	IsAlreadyTagged ()
	Check whether the current PDF document is already tagged. More...
def	IsEmpty ()
	Check whether current object is empty or not. More...
def	RemoveTags ()
	Remove the accessibility tag tree tree for the current PDF document. More...
def	SaveFigureData ()
	Save figure data. More...
def	SetAsDecorativeFigure (figure_index)
	Decorate the figure.The decorative figure can not set alternate text. More...
def	SetCallback (callback)
def	SetCurrentFigureDataInfo (is_decorative, alternate_text)
	Set current figure data info. More...
def	SetFigureAlternateText (figure_index, alternate_text)
	Set figure alternate text. More...
def	StartTagDocument (pause, report_callback, callback)
	Start to auto tag the given PDF document with specified tagged settings. More...
def	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.LibraryInitialize with a key including "Accessibility" module.

See also

fsdk.Library

Member Function Documentation

CanTagDocument()

def fsdk.TaggedPDF.CanTagDocument

(

)

Check whether the current PDF document can be tagged.

Returns

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

CanTagFormFields()

def fsdk.TaggedPDF.CanTagFormFields

(

)

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.

GetCurrentFigureElementIndex()

def fsdk.TaggedPDF.GetCurrentFigureElementIndex

(

)

Get current figure element index.

Returns

The current figure element index.

GetFigureAlternateText()

def fsdk.TaggedPDF.GetFigureAlternateText

(

figure_index

)

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()

def fsdk.TaggedPDF.GetFigureCount

(

)

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()

def fsdk.TaggedPDF.GetFigurePageIndex

(

figure_index

)

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()

def fsdk.TaggedPDF.GetFigureRect

(

figure_index

)

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()

def fsdk.TaggedPDF.GetNextFigureData

(

)

Get next figure data.

Returns

The next figure data object.

GetPrevFigureData()

def fsdk.TaggedPDF.GetPrevFigureData

(

)

Get previous figure data.

Returns

The previous figure data object.

HasFigures()

def fsdk.TaggedPDF.HasFigures

(

)

Check whether the document has figures.

Returns

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

IsAlreadyTagged()

def fsdk.TaggedPDF.IsAlreadyTagged

(

)

Check whether the current PDF document is already tagged.

Returns

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

IsEmpty()

def fsdk.TaggedPDF.IsEmpty

(

)

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()

def fsdk.TaggedPDF.RemoveTags

(

)

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()

def fsdk.TaggedPDF.SaveFigureData

(

)

Save figure data.

Returns

true means success, while false means not.

SetAsDecorativeFigure()

def fsdk.TaggedPDF.SetAsDecorativeFigure

(

figure_index

)

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()

def fsdk.TaggedPDF.SetCallback

(

callback

)

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 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()

def fsdk.TaggedPDF.SetCurrentFigureDataInfo	(		is_decorative,
			alternate_text
	)

Set current figure data info.

Parameters

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

Returns

None.

SetFigureAlternateText()

def fsdk.TaggedPDF.SetFigureAlternateText	(		figure_index,
			alternate_text
	)

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()

def fsdk.TaggedPDF.StartTagDocument	(		pause,
			report_callback,
			callback
	)

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()

def fsdk.TaggedPDF.TagFormFields

(

)

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.