Foxit PDF SDK
FSDK::AppProviderCallback类 参考

Public 成员函数

 Beep (type)
 用于为指定的提示音类型发出提示音的回调函数。 更多...
 
 DownLoadUrl (url)
 用于从指定 URL 下载的回调函数。 更多...
 
 GetAppInfo (app_info)
 用于获取指定信息类型的应用程序信息的回调函数。 更多...
 
 LoadString (string_id)
 用于为指定情况加载本地语言字符串的回调函数。 更多...
 
 MsgBox (message, title, icon_type, button_type)
 用于设置消息框的回调函数。 更多...
 
 PostRequestURL (url, data, content_type, encode, header)
 用于将数据发送到给定 URL 的回调函数。 更多...
 
 PutRequestURL (url, data, encode,)
 用于将数据放置到给定 URL 的回调函数。 更多...
 
 Release ()
 用于释放当前回调对象自身的回调函数。 更多...
 
 Response (question, title, default_answer, is_mask)
 用于响应的回调函数。 更多...
 
 ShowFileDialog (string_title, string_filter, is_openfile_dialog)
 用于显示文件对话框的回调函数。 更多...
 

静态 Public 属性

static e_AppInfoLanguage
 应用程序信息:语言。
 
static e_AppInfoName
 应用程序信息:名称。
 
static e_AppInfoPlatform
 应用程序信息:平台。
 
static e_AppInfoType
 应用程序信息:类型。
 
static e_AppInfoVariation
 应用程序信息:变体。
 
static e_AppInfoVersion
 XFA 应用程序信息类型的枚举。 更多...
 
static e_BeepTypeDefault
 提示音类型:默认。
 
static e_BeepTypeError
 XFA 提示音类型的枚举。 更多...
 
static e_BeepTypeQuestion
 提示音类型:问题。
 
static e_BeepTypeStatus
 提示音类型:状态。
 
static e_BeepTypeWarning
 提示音类型:警告。
 
static e_MsgBoxIconError
 XFA 消息框图标类型的枚举。 更多...
 
static e_MsgBoxIconQuestion
 消息框图标:问题。
 
static e_MsgBoxIconStatus
 消息框图标:状态。
 
static e_MsgBoxIconWarning
 消息框图标:警告。
 
static e_MsgBtnIDCancel
 消息框按钮 ID:取消。
 
static e_MsgBtnIDNo
 消息框按钮 ID:否。
 
static e_MsgBtnIDOK
 XFA 消息框按钮 ID 的枚举。 更多...
 
static e_MsgBtnIDYes
 消息框按钮 ID:是。
 
static e_MsgBtnTypeOK
 XFA 消息框按钮类型的枚举。 更多...
 
static e_MsgBtnTypeOKCancel
 消息框按钮:确定和取消。
 
static e_MsgBtnTypeYesNo
 消息框按钮:是和否。
 
static e_MsgBtnTypeYesNoCancel
 消息框按钮:是、否和取消。
 
static e_StringIDAccessProertyInNotObject
 示例消息:"试图在 SOM 表达式 %s 中引用非对象的属性 '%s'"。
 
static e_StringIDAppName
 字符串 ID(应用程序名称)。示例消息:"Foxit Phantom"。
 
static e_StringIDArgumentExpectContainer
 示例消息:"'%s' 参数应为容器"。
 
static e_StringIDArgumentMismatch
 示例消息:"属性或函数参数不匹配"。
 
static e_StringIDArgumentNotArray
 示例消息:"'%s' 函数的第 %d 个参数不能是数组"。
 
static e_StringIDBadSuffix
 示例消息:"数字后缀错误"。
 
static e_StringIDCalcOverride
 示例消息:"计算覆盖"。
 
static e_StringIDCannotAssign
 示例消息:"无法分配给 '%s'"。
 
static e_StringIDCannotCovertToObject
 示例消息:"%s.%s 无法转换为对象"。
 
static e_StringIDCannotModifyValue
 示例消息:"无法修改 '%s' 值"。
 
static e_StringIDCompilerError
 示例消息:"编译器错误"。
 
static e_StringIDConditionIsNull
 示例消息:"条件为 null"。
 
static e_StringIDDivideZero
 示例消息:"除以零"。
 
static e_StringIDErrorMessage
 示例消息:"%s : %s"。
 
static e_StringIDExpectedEndIf
 示例消息:"期望 'endif' 而不是 '%s'"。
 
static e_StringIDExpectedIdent
 示例消息:"期望标识符而不是 '%s'"。
 
static e_StringIDExpectedNumber
 示例消息:"期望数字而不是 '%s'"。
 
static e_StringIDExpectedOperator
 示例消息:"期望运算符 '%s' 而不是 '%s'"。
 
static e_StringIDExpectedString
 示例消息:"期望 '%s' 而不是 '%s'"。
 
static e_StringIDFunctionBuildIn
 示例消息:"函数 's' 是内置的。
 
static e_StringIDIllegalBreak
 示例消息:"非法 break"。
 
static e_StringIDIllegalContinue
 示例消息:"非法 continue"。
 
static e_StringIDImageFilter
 字符串 ID(图像文件过滤器)。示例消息: "Image Files(*.bmp;*.jpg;*.png;*.gif;*.tif)|*.bmp;*.jpg;*.png;*.gif;*.tif|All Files(*.*)|*.*||"。
 
static e_StringIDIncorrectNumberOfMethod
 示例消息:"调用方法 '%s' 时使用的参数数量不正确"。
 
static e_StringIDIndexValueOutOfBounds
 示例消息:"索引值超出范围"。
 
static e_StringIDInvalidAppend
 示例消息:"追加操作无效:%s 不能有 %s 的子元素"。
 
static e_StringIDInvalidateChar
 示例消息:"无效字符 '%c'"。
 
static e_StringIDInvalidateInstruction
 示例消息:"无效指令"。
 
static e_StringIDInvalidateLeftValue
 示例消息:"无效左值 '%s'"。
 
static e_StringIDInvalidBarcodeValue
 示例消息:"条形码值无效:%s 对于类型 %s 的条形码是无效值。"。
 
static e_StringIDInvalidEnumerate
 示例消息:"枚举值无效:%s"。
 
static e_StringIDInvalidEnumValue
 字符串 ID(枚举值无效)。示例消息:"枚举值无效:"。
 
static e_StringIDInvalidExpression
 示例消息:"无效表达式 '%s'"。
 
static e_StringIDInvalidNodeType
 示例消息:"节点类型无效:'%s'"。
 
static e_StringIDInvalidPropertySetOperation
 字符串 ID(对属性的某些设置操作无效)。 示例消息:"属性设置操作无效:"。
 
static e_StringIDInvalidToken
 示例消息:"无效标记 '%s'"。
 
static e_StringIDIsNotArray
 示例消息:"'%s' 不是数组"。
 
static e_StringIDModifyField
 字符串 ID(修改字段)。示例消息:"您想要修改此字段吗?"。
 
static e_StringIDMonthApril
 字符串 ID(四月的本地语言字符串)。
 
static e_StringIDMonthAug
 字符串 ID(八月的本地语言字符串)。
 
static e_StringIDMonthDec
 字符串 ID(十二月的本地语言字符串)。
 
static e_StringIDMonthFeb
 字符串 ID(二月的本地语言字符串)。
 
static e_StringIDMonthJan
 字符串 ID(一月的本地语言字符串)。
 
static e_StringIDMonthJuly
 字符串 ID(七月的本地语言字符串)。
 
static e_StringIDMonthJune
 字符串 ID(六月的本地语言字符串)。
 
static e_StringIDMonthMarch
 字符串 ID(三月的本地语言字符串)。
 
static e_StringIDMonthMay
 字符串 ID(五月的本地语言字符串)。
 
static e_StringIDMonthNov
 字符串 ID(十一月的本地语言字符串)。
 
static e_StringIDMonthOct
 字符串 ID(十月的本地语言字符串)。
 
static e_StringIDMonthSep
 字符串 ID(九月的本地语言字符串)。
 
static e_StringIDNotAssignObject
 示例消息:"无法直接将值分配给对象"。
 
static e_StringIDNotDefaultValue
 示例消息:"没有默认属性"。
 
static e_StringIDNotFoundConst
 示例消息:"找不到常量 '%s'"。
 
static e_StringIDNotFoundContainer
 示例消息:"找不到容器 '%s'"。
 
static e_StringIDNotFoundFunction
 示例消息:"找不到函数 '%s'"。
 
static e_StringIDNotFoundMethod
 示例消息:"找不到方法 '%s'"。
 
static e_StringIDNotFoundProperty
 示例消息:"找不到属性 '%s'"。
 
static e_StringIDNotHaveProperty
 示例消息:"'%s' 没有属性 '%s'"。
 
static e_StringIDNotModifyField
 字符串 ID(不允许修改字段)。示例消息:"不允许您修改此字段。"。
 
static e_StringIDNotSupportArrayCalculate
 示例消息:"'%s' 运算符不支持数组计算"。
 
static e_StringIDNumberOfOccur
 示例消息:"元素 [%s] 违反了其允许的出现次数"。
 
static e_StringIDOutOfArrayRange
 示例消息:"超出 '%s' 数组的范围"。
 
static e_StringIDParametersError
 示例消息:"函数 '%s' 没有 %d 个参数"。
 
static e_StringIDRedefinition
 示例消息:"'%s' 重定义"。
 
static e_StringIDScriptArgumentMismatch
 示例消息:"错误:属性或函数参数不匹配。"。
 
static e_StringIDScriptFailedError
 示例消息:"脚本失败(语言是 %s;上下文是 %s)脚本=%s"。
 
static e_StringIDScriptInvalidValue
 示例消息:"错误:枚举值无效:%s"。
 
static e_StringIDServerDeny
 字符串 ID(服务器拒绝)。示例消息:"服务器不允许"。
 
static e_StringIDSOMExpectedList
 示例消息:"SOM 表达式在期望单个结果时返回了列表"。
 
static e_StringIDSubmitValidateNullError
 示例消息: "至少有一个必填字段为空。请在继续之前填写必填字段(突出显示)。"。
 
static e_StringIDToday
 字符串 ID(今天的本地语言字符串)。
 
static e_StringIDUnableSetClassName
 示例消息:"无法设置属性 'className' 的值"。
 
static e_StringIDUnableSetLanguage
 示例消息:"无法设置属性 'language' 的值"。
 
static e_StringIDUnableSetLengthValue
 示例消息:"无法设置属性 'length' 的值"。
 
static e_StringIDUnableSetNumPages
 示例消息:"无法设置属性 'numPages' 的值"。
 
static e_StringIDUnableSetPlatformValue
 示例消息:"无法设置属性 'platform' 的值"。
 
static e_StringIDUnableSetReady
 示例消息:"无法设置属性 'ready' 的值"。
 
static e_StringIDUnableSetValidationsEnabledValue
 示例消息:"无法设置属性 'validationsEnabled' 的值"。
 
static e_StringIDUnableSetValidationsValue
 示例消息:"无法设置属性 'variation' 的值"。
 
static e_StringIDUnableSetVersion
 示例消息:"无法设置属性 'version' 的值"。
 
static e_StringIDUnableToSet
 示例消息:"无法设置"。
 
static e_StringIDUndefineIdentifier
 示例消息:"未定义的标识符 '%s'"。
 
static e_StringIDUnexpectedExpression
 示例消息:"意外的表达式 '%s'"。
 
static e_StringIDUnknownCaught
 示例消息:"捕获到未知错误!"。
 
static e_StringIDUnsupportChar
 示例消息:"不支持的字符 '%c'"。
 
static e_StringIDUnsupportMethod
 示例消息:"不支持的方法 %s。"。
 
static e_StringIDUnsupportProperty
 示例消息:"不支持的属性 %s。"。
 
static e_StringIDValidateError
 示例消息:"您为 %s 输入的值无效。"。
 
static e_StringIDValidateFailed
 用于指定情况的字符串 ID 枚举。 更多...
 
static e_StringIDValidateLimit
 示例消息:"超出消息限制。剩余的 %d 个验证错误未报告。"。
 
static e_StringIDValidateNullError
 示例消息:"%s 不能留空。"。
 
static e_StringIDValidateNullWarning
 示例消息:"%s 不能留空。要忽略 %s 的验证,请单击忽略。"。
 
static e_StringIDValidateNumberError
 示例消息:"非法值:无法将 '%s' 分配给 %s。"。
 
static e_StringIDValidateOutOfArray
 示例消息:"验证访问索引 '%s' 超出数组"。
 
static e_StringIDValidateWarning
 示例消息:"您为 %s 输入的值无效。要忽略 %s 的验证,请单击忽略。"。
 
static e_StringIDValueExcalmatory
 示例消息:"值!"。
 
static e_StringIDViolateBoundary
 示例消息:"元素 [%s] 违反了其允许的出现次数"。
 
static e_StringIDWeekDayFri
 字符串 ID(星期五的本地语言字符串)。
 
static e_StringIDWeekDayMon
 字符串 ID(星期一的本地语言字符串)。
 
static e_StringIDWeekDaySat
 字符串 ID(星期六的本地语言字符串)。
 
static e_StringIDWeekDaySun
 字符串 ID(星期日的本地语言字符串)。
 
static e_StringIDWeekDayThu
 字符串 ID(星期四的本地语言字符串)。
 
static e_StringIDWeekDayTue
 字符串 ID(星期二的本地语言字符串)。
 
static e_StringIDWeekDayWed
 字符串 ID(星期三的本地语言字符串)。
 

详细描述

此类表示作为 XFA 应用程序提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

成员函数说明

◆ Beep()

FSDK::AppProviderCallback::Beep ( type  )

用于为指定的提示音类型发出提示音的回调函数。

参数
[in]type提示音类型。请参阅从 FSDK.AppProviderCallback.e_BeepTypeError 开始的值,并且该值应为这些值之一。
返回
无。

◆ DownLoadUrl()

FSDK::AppProviderCallback::DownLoadUrl ( url  )

用于从指定 URL 下载的回调函数。

参数
[in]url要下载的 URL。
返回
可用于读取下载结果的 FSDK.FileReaderCallback 对象。

◆ GetAppInfo()

FSDK::AppProviderCallback::GetAppInfo ( app_info  )

用于获取指定信息类型的应用程序信息的回调函数。

参数
[in]app_info要检索其信息的应用程序信息类型。请参阅从 FSDK.AppProviderCallback.e_AppInfoType 开始的值,并且该值应为这些值之一。
返回
应用程序信息字符串。

◆ LoadString()

FSDK::AppProviderCallback::LoadString ( string_id  )

用于为指定情况加载本地语言字符串的回调函数。

此函数对于用户在指定情况下使用本地语言消息非常有用。 用户可以将示例消息(在从 FSDK.AppProviderCallback.e_StringIDValidateFailed 开始的值的注释中定义)重写或翻译为指定情况的本地语言, 并将结果字符串返回给 Foxit PDF SDK。 特别地,Foxit PDF SDK 将在示例消息中的格式部分添加一些必要的信息/数据, 以使消息更有用。建议用户在重写或翻译的结果字符串中保留这些格式部分; 否则,这些信息/数据将不会丢失,也不会添加到用户提供的消息中。

参数
[in]string_id用于指定情况的字符串 ID。请参阅从 FSDK.AppProviderCallback.e_StringIDValidateFailed 开始的值,并且该值应为这些值之一。
返回
用于指定情况的字符串。

◆ MsgBox()

FSDK::AppProviderCallback::MsgBox ( message  ,
title  ,
icon_type  ,
button_type   
)

用于设置消息框的回调函数。

参数
[in]message消息字符串。
[in]title消息框的标题。
[in]icon_type消息框的图标类型。请参阅从 FSDK.AppProviderCallback.e_MsgBoxIconError 开始的值,并且该值应为这些值之一。
[in]button_type消息框的按钮类型。请参阅从 FSDK.AppProviderCallback.e_MsgBtnTypeOK 开始的值,并且该值应为这些值之一。
返回
消息框的按钮 ID。请参阅从 FSDK.AppProviderCallback.e_MsgBtnIDOK 开始的值,并且该值应为这些值之一。

◆ PostRequestURL()

FSDK::AppProviderCallback::PostRequestURL ( url  ,
data  ,
content_type  ,
encode  ,
header   
)

用于将数据发送到给定 URL 的回调函数。

参数
[in]url将数据发送到的 URL。
[in]data要发送的数据。
[in]content_type表示数据内容类型的字符串。此字符串可以是 "text/html"、 "text/xml"、"text/plain"、"multipart/form-data"、"application/x-www-form-urlencoded"、 "application/octet-stream" 或任何有效的 MIME 类型。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何被认可的 [IANA] 字符编码。
[in]header表示要包含在 post 中的任何附加 HTTP 标头的字符串。
返回
响应字符串。

◆ PutRequestURL()

FSDK::AppProviderCallback::PutRequestURL ( url  ,
data  ,
encode   
)

用于将数据放置到给定 URL 的回调函数。

参数
[in]url将数据放置到的 URL。
[in]data要放置的数据。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何被认可的 [IANA] 字符编码。
返回
true 表示成功,而 false 表示失败。

◆ Release()

FSDK::AppProviderCallback::Release ( )

用于释放当前回调对象自身的回调函数。

返回
无。

◆ Response()

FSDK::AppProviderCallback::Response ( question  ,
title  ,
default_answer  ,
is_mask   
)

用于响应的回调函数。

参数
[in]question表示问题的字符串。
[in]title表示标题的字符串。
[in]default_answer表示默认答案的字符串。它可以是空字符串, 表示没有默认答案。
[in]is_masktrue 表示答案应该用 '*' 掩盖, 而 false 表示答案不需要用 '*' 掩盖。
返回
表示响应答案的字符串。

◆ ShowFileDialog()

FSDK::AppProviderCallback::ShowFileDialog ( string_title  ,
string_filter  ,
is_openfile_dialog   
)

用于显示文件对话框的回调函数。

参数
[in]string_title表示对话框标题的字符串。
[in]string_filter表示对话框文件过滤器的字符串。
[in]is_openfile_dialogtrue 表示对话框是打开文件对话框, 而 false 表示对话框是另存为对话框。
返回
文件路径数组。

类成员变量说明

◆ e_AppInfoVersion

FSDK::AppProviderCallback::e_AppInfoVersion
static

XFA 应用程序信息类型的枚举。

此枚举的值应单独使用。应用程序信息:版本。

◆ e_BeepTypeError

FSDK::AppProviderCallback::e_BeepTypeError
static

XFA 提示音类型的枚举。

此枚举的值应单独使用。提示音类型:错误。

◆ e_MsgBoxIconError

FSDK::AppProviderCallback::e_MsgBoxIconError
static

XFA 消息框图标类型的枚举。

此枚举的值应单独使用。消息框图标:错误。

◆ e_MsgBtnIDOK

FSDK::AppProviderCallback::e_MsgBtnIDOK
static

XFA 消息框按钮 ID 的枚举。

此枚举的值应单独使用。消息框按钮 ID:确定。

◆ e_MsgBtnTypeOK

FSDK::AppProviderCallback::e_MsgBtnTypeOK
static

XFA 消息框按钮类型的枚举。

此枚举的值应单独使用。消息框按钮:确定。

◆ e_StringIDValidateFailed

FSDK::AppProviderCallback::e_StringIDValidateFailed
static

用于指定情况的字符串 ID 枚举。

此枚举的值应单独使用。示例消息:"验证失败"。