Foxit PDF SDK
FSAlternateTextFigureData Class Reference

水平对齐方式:左对齐。
More...

Inherits NSObject.

Instance Methods

(id) - init
 Default constructor: creates an empty, non-decorative figure entry.

 
(id) - initWithOther:
 Copy constructor.

 
(void) - set:alternate_text:alternate_text_changed:page_index:rect:
 Set object values in one call.
More...
 

Properties

NSString * alternate_text
 The alternate text before change (original).

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

 
BOOL is_decorative_figure
 Whether the figure is decorative (no alternate text).

 
int page_index
 The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function FSPDFDoc::getPageCount.

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


Method Documentation

◆ set:alternate_text:alternate_text_changed:page_index:rect:()

- (void) set: (BOOL)  is_decorative_figure
alternate_text: (NSString *)  alternate_text
alternate_text_changed: (NSString *)  alternate_text_changed
page_index: (int)  page_index
rect: (FSRectF*)  rect 

Set object values in one call.

Parameters
[in]is_decorative_figurewhether the figure is decorative.
[in]alternate_textoriginal alternate text.
[in]alternate_text_changedalternate text after change.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function FSPDFDoc::getPageCount.
[in]rectbounding rectangle of the figure.