fsdk.AlternateTextFigureData Class Reference

Data structure for alternate text information of a figure. More...

Public Member Functions
def	GetAlternate_text ()
	Get the alternate text before change (original). More...
def	GetAlternate_text_changed ()
	Get the alternate text after change (modified in fix mode). More...
def	GetIs_decorative_figure ()
	Get whether the figure is decorative (no alternate text). More...
def	GetPage_index ()
	Get the page index where the figure is located. More...
def	GetRect ()
	Get bounding rectangle of the figure on the page. More...
def	Set (is_decorative_figure, alternate_text, alternate_text_changed, page_index, rect)
	Set object values in one call. More...
def	SetAlternate_text (value)
	Set the alternate text before change (original). More...
def	SetAlternate_text_changed (value)
	Set the alternate text after change (modified in fix mode). More...
def	SetIs_decorative_figure (value)
	Set whether the figure is decorative (no alternate text). More...
def	SetPage_index (value)
	Set the page index where the figure is located. More...
def	SetRect (value)
	Set bounding rectangle of the figure on the page. More...

Detailed Description

Data structure for alternate text information of a figure.

Stores information about a single figure used by accessibility tagging and fix workflows.

• is_decorative_figure: whether the figure is decorative and should not have alternate text.

• alternate_text: the original alternate text (before edit).

• alternate_text_changed: the alternate text after user modification (used in fix mode).

• page_index: the zero-based page index where the figure is located.

• rect: the bounding rectangle of the figure on the page.

Typical usage:

1. Iterate with TaggedPDF::GetNextFigureData() / GetPrevFigureData().

2. Modify using SetCurrentFigureDataInfo() and persist via TaggedPDF::SaveFigureData().

Member Function Documentation

GetAlternate_text()

fsdk.AlternateTextFigureData.GetAlternate_text

(

)

Get the alternate text before change (original).

Returns

The alternate text before change (original).

GetAlternate_text_changed()

fsdk.AlternateTextFigureData.GetAlternate_text_changed

(

)

Get the alternate text after change (modified in fix mode).

Returns

The alternate text after change (modified in fix mode).

GetIs_decorative_figure()

fsdk.AlternateTextFigureData.GetIs_decorative_figure

(

)

Get whether the figure is decorative (no alternate text).

Returns

Whether the figure is decorative (no alternate text).

GetPage_index()

fsdk.AlternateTextFigureData.GetPage_index

(

)

Get the page index where the figure is located.

Returns

The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

GetRect()

fsdk.AlternateTextFigureData.GetRect

(

)

Get bounding rectangle of the figure on the page.

Returns

Bounding rectangle of the figure on the page.

Set()

def fsdk.AlternateTextFigureData.Set	(		is_decorative_figure,
			alternate_text,
			alternate_text_changed,
			page_index,
			rect
	)

Set object values in one call.

Parameters

[in]	is_decorative_figure	whether the figure is decorative.
[in]	alternate_text	original alternate text.
[in]	alternate_text_changed	alternate text after change.
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	rect	bounding rectangle of the figure.

SetAlternate_text()

fsdk.AlternateTextFigureData.SetAlternate_text

(

value

)

Set the alternate text before change (original).

Parameters

[in]

value

The alternate text before change (original).

Returns

None.

SetAlternate_text_changed()

fsdk.AlternateTextFigureData.SetAlternate_text_changed

(

value

)

Set the alternate text after change (modified in fix mode).

Parameters

[in]

value

The alternate text after change (modified in fix mode).

Returns

None.

SetIs_decorative_figure()

fsdk.AlternateTextFigureData.SetIs_decorative_figure

(

value

)

Set whether the figure is decorative (no alternate text).

Parameters

[in]

value

Whether the figure is decorative (no alternate text).

Returns

None.

SetPage_index()

fsdk.AlternateTextFigureData.SetPage_index

(

value

)

Set the page index where the figure is located.

Parameters

[in]

value

The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

Returns

None.

SetRect()

fsdk.AlternateTextFigureData.SetRect

(

value

)

Set bounding rectangle of the figure on the page.

Parameters

[in]

value

Bounding rectangle of the figure on the page.

Returns

None.