Foxit PDF SDK
fsdk.AutoTagProviderCallback类 参考

表示用于可访问性自动标记结果的提供者回调对象。 更多...

Public 成员函数

def GetReportText (type)
 获取指定自动标记结果数据类型的显示文本。 更多...
 

详细描述

表示用于可访问性自动标记结果的提供者回调对象。

本类中的所有纯虚函数都作为回调使用,应在派生类中由用户实现。

成员函数说明

◆ GetReportText()

def fsdk.AutoTagProviderCallback.GetReportText (   type)

获取指定自动标记结果数据类型的显示文本。

该回调在 SDK 生成”添加标记(Add Tags)”报告(自动标记过程中)时被调用。对于从 开始的每个值,SDK 都会向应用请求对应的 (通常是本地化的)显示字符串,因此报告中所有面向用户的文案均由应用控制。
大多数类型对应一个普通标签(例如 "Figures"、"Artifacts"、"Table Summary")。少数类型要求 返回的字符串中包含 printf 风格的占位符,SDK 会在运行时进行替换;实现时必须保留占位符及其顺序:

  • %d 页码(从 1 开始):e_AutoTagResultDataTypePage("Page \%d")、 e_AutoTagResultDataTypeMissFigure("Figure missing AltText on page \%d.");

  • %d 数量:e_AutoTagResultDataTypeSumReduceConfidence("\%d reduced confidence pages")、 e_AutoTagResultDataTypeSumAlttextFigure("\%d figures missing AltText");

  • %ls 类别名称:e_AutoTagResultDataTypeCheckCategory("\%ls to check.")、 e_AutoTagResultDataTypeFixCategory("How to Fix \%ls Tagging.");

  • %ls 文件名:e_AutoTagResultDataTypeTagreportFilename("Add Tags Report for \%ls")。

对于未知或未处理的类型,请返回空字符串。完整的参考实现可见无障碍单元测试类 CFSUT_AutoTagProviderCallbackImpl。

参数
[in]type从 开始的值之一,SDK 正在请求其显示文本。 type 对应的显示文本(可能包含上述占位符);若该类型未处理,返回空字符串。