FSDK.AutoTagProviderCallback Class Reference

Public Member Functions
	GetReportText (type)
	Get the display text for an auto tag result data type. More...

Static Public Attributes
static	e_AutoTagResultDataTypeAlttext
	Auto tag result data type: alttext.
static	e_AutoTagResultDataTypeArtifacts
	Auto tag result data type: artifacts.
static	e_AutoTagResultDataTypeBacktotop
	Auto tag result data type: back to top.
static	e_AutoTagResultDataTypeCheckCategory
	Auto tag result data type: check category.
static	e_AutoTagResultDataTypeCheckerTable5
	Auto tag result data type: checker table 5.
static	e_AutoTagResultDataTypeFigures
	Auto tag result data type: figures.
static	e_AutoTagResultDataTypeFixCategory
	Auto tag result data type: fix category.
static	e_AutoTagResultDataTypeHighConfidence
	Auto tag result data type: high confidence.
static	e_AutoTagResultDataTypeHintAlttext
	Auto tag result data type: hint alttext.
static	e_AutoTagResultDataTypeHintArtifacts
	Auto tag result data type: hint artifacts.
static	e_AutoTagResultDataTypeHintFigure
	Auto tag result data type: hint figure.
static	e_AutoTagResultDataTypeHintList
	Auto tag result data type: hint list.
static	e_AutoTagResultDataTypeHintParagraph
	Auto tag result data type: hint paragraph.
static	e_AutoTagResultDataTypeHintRegion
	Auto tag result data type: hint region.
static	e_AutoTagResultDataTypeHintRepair
	Auto tag result data type: hint repair.
static	e_AutoTagResultDataTypeHintTableHeader
	Auto tag result data type: hint tableheader.
static	e_AutoTagResultDataTypeHintTableRow
	Auto tag result data type: hint tablerow.
static	e_AutoTagResultDataTypeHintTables
	Auto tag result data type: hint tables.
static	e_AutoTagResultDataTypeHintToc
	Auto tag result data type: hint toc.
static	e_AutoTagResultDataTypeIntroduction
	Auto tag result data type: introduction.
static	e_AutoTagResultDataTypeListItem
	Auto tag result data type: listitem.
static	e_AutoTagResultDataTypeLowConfidence
	Auto tag result data type: low confidence.
static	e_AutoTagResultDataTypeMediumConfidence
	Auto tag result data type: medium confidence.
static	e_AutoTagResultDataTypeMediumhighConfidence
	Auto tag result data type: mediumhigh confidence.
static	e_AutoTagResultDataTypeMediumlowConfidence
	Auto tag result data type: mediumlow confidence.
static	e_AutoTagResultDataTypeMissFigure
	Auto tag result data type: miss figure.
static	e_AutoTagResultDataTypePage
	Auto tag result data type: page.
static	e_AutoTagResultDataTypeParagraphs
	Auto tag result data type: paragraphs.
static	e_AutoTagResultDataTypeReduceConfidence
	Enumeration for accessibility auto tag result data type. More...
static	e_AutoTagResultDataTypeRegions
	Auto tag result data type: regions.
static	e_AutoTagResultDataTypeRibbonCategory
	Auto tag result data type: ribbon category.
static	e_AutoTagResultDataTypeSumAlttextFigure
	Auto tag result data type: sum alttext figure.
static	e_AutoTagResultDataTypeSumReduceConfidence
	Auto tag result data type: sum reduce confidence.
static	e_AutoTagResultDataTypeTableHeader
	Auto tag result data type: table header.
static	e_AutoTagResultDataTypeTableRow
	Auto tag result data type: table row.
static	e_AutoTagResultDataTypeTables
	Auto tag result data type: tables.
static	e_AutoTagResultDataTypeTagrepIntroduction
	Auto tag result data type: tagrep introduction.
static	e_AutoTagResultDataTypeTagreportFilename
	Auto tag result data type: tagreport filename.
static	e_AutoTagResultDataTypeTagreportNextpage
	Auto tag result data type: tagreport nextpage.
static	e_AutoTagResultDataTypeTagreportPrepage
	Auto tag result data type: tagreport prepage.
static	e_AutoTagResultDataTypeToc
	Auto tag result data type: toc.
static	e_AutoTagResultDataTypeTouchupReadingOrder
	Auto tag result data type: touchup reading order.

Detailed Description

This class represents an auto tag results provider for accessibility.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class.

Member Function Documentation

GetReportText()

FSDK.AutoTagProviderCallback.GetReportText (   type )

inline

Get the display text for an auto tag result data type.

This callback is invoked by the SDK while it generates the "Add Tags" report during auto tagging. For each value starting from FSDK.AutoTagProviderCallback.AutoTagResultDataType.e_AutoTagResultDataTypeReduceConfidence, SDK requests the corresponding (typically localized) display string from the application, so the application controls all user-visible wording in the report.

Most types map to a plain label (for example "Figures", "Artifacts", "Table Summary"). A few types expect the returned string to contain a printf-style placeholder that the SDK substitutes at runtime; the implementation must keep the placeholder and its order intact:

• %d page number (1-based): e_AutoTagResultDataTypePage ("Page %d"), e_AutoTagResultDataTypeMissFigure ("Figure missing AltText on page %d.");
• %d count: e_AutoTagResultDataTypeSumReduceConfidence ("%d reduced confidence pages"), e_AutoTagResultDataTypeSumAlttextFigure ("%d figures missing AltText");
• %ls category name: e_AutoTagResultDataTypeCheckCategory ("%ls to check."), e_AutoTagResultDataTypeFixCategory ("How to Fix %ls Tagging.");
• %ls file name: e_AutoTagResultDataTypeTagreportFilename ("Add Tags Report for %ls").

Return an empty string for an unknown or unhandled type.

Parameters

[in]

type

One value starting from FSDK.AutoTagProviderCallback.AutoTagResultDataType.e_AutoTagResultDataTypeReduceConfidence that the SDK is requesting text for.

Returns

The display text for type (may contain a placeholder as noted above), or an empty string if the type is not handled.

Member Data Documentation

e_AutoTagResultDataTypeReduceConfidence

FSDK.AutoTagProviderCallback.e_AutoTagResultDataTypeReduceConfidence

static

Enumeration for accessibility auto tag result data type.

Values of this enumeration should be used alone.Auto tag result data type: reduce confidence.