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

Inherits SystemIDisposable.

Public Member Functions
	AlternateTextFigureData ()
	Default constructor: creates an empty, non-decorative figure entry.

	AlternateTextFigureData (bool is_decorative_figure, string alternate_text, string alternate_text_changed, int page_index, RectF rect)
	Construct with explicit values. More...

	AlternateTextFigureData (AlternateTextFigureData other)
	Copy constructor.

void	Set (bool is_decorative_figure, string alternate_text, string alternate_text_changed, int page_index, RectF rect)
	Set object values in one call. More...

Properties
string	alternate_text `[get, set]`
	The alternate text before change (original).

string	alternate_text_changed `[get, set]`
	The alternate text after change (modified in fix mode).

bool	is_decorative_figure `[get, set]`
	Whether the figure is decorative (no alternate text).

int	page_index `[get, set]`
	The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .

RectF?	rect `[get, set]`
	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:

Iterate with TaggedPDF::GetNextFigureData() / GetPrevFigureData().
Modify using SetCurrentFigureDataInfo() and persist via TaggedPDF::SaveFigureData().

Constructor & Destructor Documentation

foxit.addon.accessibility.AlternateTextFigureData.AlternateTextFigureData	(	bool	is_decorative_figure,
		string	alternate_text,
		string	alternate_text_changed,
		int	page_index,
		RectF	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 pdf.PDFDoc.GetPageCount .
[in]	rect	bounding rectangle of the figure on the page.

void foxit.addon.accessibility.AlternateTextFigureData.Set	(	bool	is_decorative_figure,
		string	alternate_text,
		string	alternate_text_changed,
		int	page_index,
		RectF	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 pdf.PDFDoc.GetPageCount .
[in]	rect	bounding rectangle of the figure.