Foxit PDF SDK
|
Public Member Functions | |
constructor (doc) | |
Constructor. More... | |
GetFigureAlternateText (figure_index) | |
Get the alternate text of the figure. More... | |
GetFigureCount () | |
Get the count of figures in tagged document,excluding the decorative figures. More... | |
GetFigurePageIndex (figure_index) | |
Get the figure page index by the figure index. More... | |
GetFigureRect (figure_index) | |
Get the rectangle of figure. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
SetAsDecorativeFigure (figure_index) | |
Decorate the figure.The decorative figure can not set alternate text. More... | |
SetCallback (callback) | |
Set a callback object for tagged PDF. More... | |
SetFigureAlternateText (figure_index, alternate_text) | |
Set figure alternate text. More... | |
StartTagDocument (pause) | |
Start to auto tag the given PDF document with specified tagged settings. More... | |
This class represents settings for a tagged PDF document.The tagged PDF means that only tagging information for PDF structure here. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FSDK.Library.Initialize with a key including "Accessibility" module.
FSDK.TaggedPDF.constructor | ( | doc | ) |
Constructor.
[in] | doc | A valid PDF document object to be tagged. |
This constructor is to construct a tagged PDF object with default settings.
FSDK.TaggedPDF.GetFigureAlternateText | ( | figure_index | ) |
Get the alternate text of the figure.
The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
[in] | figure_index | The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount. |
FSDK.TaggedPDF.GetFigureCount | ( | ) |
Get the count of figures in tagged document,excluding the decorative figures.
The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
FSDK.TaggedPDF.GetFigurePageIndex | ( | figure_index | ) |
Get the figure page index by the figure index.
The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
[in] | figure_index | The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount. |
FSDK.TaggedPDF.GetFigureRect | ( | figure_index | ) |
Get the rectangle of figure.
The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
[in] | figure_index | The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount. |
FSDK.TaggedPDF.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.TaggedPDF.SetAsDecorativeFigure | ( | figure_index | ) |
Decorate the figure.The decorative figure can not set alternate text.
The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
[in] | figure_index | The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount. |
FSDK.TaggedPDF.SetCallback | ( | callback | ) |
Set a callback object for tagged PDF.
If this function is not called, that means no callback will be used.
[in] | callback | A FSDK.TaggedPDFCallback object which is implemented by user. User can change some information/data during tagged PDF document by this callback. Please ensure that the callback object keeps valid until the life-cycle of current tagged PDF object ends. If this is null, that means to use default information/data. |
FSDK.TaggedPDF.SetFigureAlternateText | ( | figure_index | , |
alternate_text | |||
) |
Set figure alternate text.
The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function FSDK.PDFDoc.IsTaggedPDF to check current PDF document whether is a tagged PDF document.
[in] | figure_index | The index of figure. Valid range: from 0 to (count-1). count is returned by function FSDK.TaggedPDF.GetFigureCount. |
[in] | alternate_text | The alternative descriptions text. |
FSDK.TaggedPDF.StartTagDocument | ( | pause | ) |
Start to auto tag the given PDF document with specified tagged settings.
If user wants to get specific tag results when tagging document process, please refer to function FSDK.TaggedPDF.SetCallback about callback function FSDK.TaggedPDFCallback.Report.
[in] | pause | Pause object which decides if the auto tagging process needs to be paused. This can be null which means not to pause during the tagging process. If this is not null, it should be a valid pause object implemented by user. Default value: null. |