FSDK.AlternateTextFigureData Class Reference

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

Public Member Functions
	constructor ()
	Default constructor: creates an empty, non-decorative figure entry.
	constructor (is_decorative_figure, alternate_text, alternate_text_changed, page_index, rect)
	Construct with explicit values. More...
	Set (is_decorative_figure, alternate_text, alternate_text_changed, page_index, rect)
	Set object values in one call. More...

Public Attributes
	alternate_text
	The alternate text before change (original).
	alternate_text_changed
	The alternate text after change (modified in fix mode).
	is_decorative_figure
	Whether the figure is decorative (no alternate text).
	page_index
	The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function FSDK.PDFDoc.GetPageCount.
	rect
	Bounding rectangle of the figure on the page.

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

constructor()

FSDK.AlternateTextFigureData.constructor (   is_decorative_figure,   alternate_text,   alternate_text_changed,   page_index,   rect  )

inline

Construct with explicit values.

Parameters

[in]	is_decorative_figure	true if figure is decorative (no alt text).
[in]	alternate_text	original alternate text (may be null/empty).
[in]	alternate_text_changed	alternate text after change (may be null/empty).
[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 on the page.

Set()

FSDK.AlternateTextFigureData.Set (   is_decorative_figure,   alternate_text,   alternate_text_changed,   page_index,   rect  )

inline

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.