Foxit PDF SDK
FSDK::AlternateTextFigureData类 参考

Data structure for alternate text information of a figure. 更多...

Public 成员函数

 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. 更多...
 
 Set (is_decorative_figure, alternate_text, alternate_text_changed, page_index, rect)
 一次性设置对象值。 更多...
 

Public 属性

 alternate_text
 更改前的替换文本(原始)。
 
 alternate_text_changed
 更改后的替换文本(在修复模式下修改)。
 
 is_decorative_figure
 该图形是否为装饰性图形(无替换文本)。
 
 page_index
 图形所在页面的页面索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.PDFDoc.GetPageCount 返回。
 
 rect
 图形在页面上的边界矩形。
 

详细描述

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

成员函数说明

◆ constructor()

FSDK::AlternateTextFigureData::constructor (   is_decorative_figure,
  alternate_text,
  alternate_text_changed,
  page_index,
  rect 
)
inline

Construct with explicit values.

参数
[in]is_decorative_figuretrue if figure is decorative (no alt text).
[in]alternate_textoriginal alternate text (may be null/empty).
[in]alternate_text_changedalternate text after change (may be null/empty).
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function FSDK.PDFDoc.GetPageCount.
[in]rectbounding rectangle of the figure on the page.

◆ Set()

FSDK::AlternateTextFigureData::Set (   is_decorative_figure,
  alternate_text,
  alternate_text_changed,
  page_index,
  rect 
)
inline

一次性设置对象值。

参数
[in]is_decorative_figure该图形是否为装饰性图形。
[in]alternate_text原始替换文本。
[in]alternate_text_changed更改后的替换文本。
[in]page_index页面索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.PDFDoc.GetPageCount 返回。
[in]rect图形的边界矩形。