适用于HTML5表单的Form Bridge API form-bridge-apis-for-html-forms
您可以使用Form Bridge API打开基于XFA的HTML5表单与您的应用程序之间的通信渠道。 表单Bridge API提供了 connect API来创建连接。
connect API接受处理程序作为参数。 在基于XFA的HTML5表单与表单Bridge之间成功创建连接后，将调用句柄。
您可以使用以下示例代码创建连接。
// Example showing how to connect to FormBridge
window.addEventListener("FormBridgeInitialized",
function(event) {
var fb = event.detail.formBridge;
fb.connect(function() {
//use form bridge functions
})
})
可从Bridge API获取 available-form-bridge-api-nbsp
getBridgeVersion()
返回脚本库的版本号
- 输入：无
- 输出：脚本库的版本号
- 错误：无
isConnected() 检查表单状态是否已初始化
-
输入：无
-
如果XFA表单状态已初始化，输出： 真
-
错误：无
connect(handler， context) 与FormBridge建立连接并在建立连接且表单状态初始化后执行函数
-
输入：
- 处理程序：连接表单Bridge后要执行的函数
- 上下文： 处理程序 函数的上下文(this)所设置的对象。
-
输出：无
-
错误：无
getDataXML(options) 以XML格式返回当前表单数据
-
输入：
-
选项： 包含以下属性的JavaScript对象：
- 错误：错误处理程序函数
- success：成功处理程序函数。 此函数传递了一个包含 数据 属性中的XML的对象。
- context： success 函数的上下文(this)所设置的对象
- validationChecker：用于调用以检查从服务器收到的验证错误的函数。 验证函数传递了错误字符串的数组。
- formState：必须为其返回数据XML的XFA表单的JSON状态。 如果未指定，则返回当前渲染表单的数据XML。
-
-
输出： 无
-
错误： 无
registerConfig(configName， config) 向FormBridge注册用户/门户特定配置。 这些配置将覆盖默认配置。 支持的配置在配置部分中指定。
-
输入：
-
要覆盖的配置的 configName： 名称
-
小组件配置： 允许用户使用自定义小组件覆盖表单中的默认小组件。 将按如下方式覆盖配置：
formBridge.registerConfig("widgetConfig"：{/&；ast；configuration&；ast；/})
-
pagingConfig： 允许用户覆盖仅呈现第一页的默认行为。 将按如下方式覆盖配置：
window.formBridge.registerConfig("pagingConfig"：{pagingDisabled： <true | false>， shrinkPageDisabled： <true | false> })。
-
LoggingConfig： 允许用户覆盖日志记录级别，禁用某个类别的日志记录，或者是否显示日志控制台或发送到服务器。 可按如下方式覆盖配置：
code language-javascript formBridge.registerConfig{ "LoggerConfig" : { { "on":`<true *| *false>`, "category":`<array of categories>`, "level":`<level of categories>`, " type":`<"console"/"server"/"both">` } }-
SubmitServiceProxyConfig： 允许用户注册提交和记录器代理服务。
code language-javascript window.formBridge.registerConfig("submitServiceProxyConfig", { "submitServiceProxy" : "`<submitServiceProxy>`", "logServiceProxy": "`<logServiceProxy>`", "submitUrl" : "`<submitUrl>`" });
-
-
配置： 配置值
-
-
输出： 在 数据 属性中包含配置原始值的对象。
-
错误： 无
hideFields(fieldArray) 隐藏fieldArray中提供Som表达式的字段。 将指定字段的presence属性设置为不可见
-
输入：
- fieldArray： 要隐藏的字段的Som表达式数组
-
输出： 无
-
错误： 无
showFields(fieldArray) 显示在fieldArray中提供Som表达式的字段。 将所提供字段的presence属性设置为可见
-
输入：
- fieldArray： 要显示的字段的Som表达式数组
-
输出： 无
-
错误： 无
hideSubmitButtons() 隐藏表单中的所有提交按钮
- 输入：无
- 输出：无
- 错误：如果表单状态未初始化，则会引发异常
getFormState() 返回表示表单状态的JSON
-
输入： 无
-
输出： 包含表示 数据 属性中当前表单状态的JSON的对象。
-
错误： 无
restoreFormState(options) 从选项对象中提供的JSON状态还原表单状态。 应用状态，并在操作完成后调用成功或错误处理程序
-
输入：
-
选项： 包含以下属性的JavaScript对象：
- 错误：错误处理程序函数
- success： Success处理程序函数
- context： success 函数的上下文(this)所设置的对象
- formState：表单的JSON状态。 表单将恢复为JSON状态。
-
-
输出： 无
-
错误： 无
setFocus (som) 将焦点设置为Som表达式中指定的字段
- 输入： 要设置焦点的字段的Som表达式
- 输出： 无
- 错误： 如果Som表达式不正确，则引发异常
setFieldValue (som， value) 设置给定Som表达式的字段值
-
输入：
- som： 包含字段的Som表达式的数组。 用于设置字段值的som表达式。
- 值： 数组包含与 som 数组中提供的Som表达式对应的值。 如果该值的数据类型与fieldType不同，则不会修改该值。
-
输出： 无
-
错误： 如果Som表达式不正确，则引发异常
getFieldValue (som) 返回给定Som表达式的字段值
-
输入： 数组包含必须检索其值的字段的Som表达式
-
输出： 在 数据 属性中包含结果为数组的对象。
-
错误： 无
getFieldValue() API示例 example-of-nbsp-getfieldvalue-api
var a = formBridge.getFieldValue("xfa.form.form1.Subform1.TextField");
if(a.errors) {
var err;
while((err = a.getNextMessage()) != null)
alert(a.message)
} else {
alert(a.data[0])
}
getFieldProperties（som，属性） 检索Som表达式中指定的字段的给定属性的值列表
-
输入：
- som： 包含字段的Som表达式的数组
- 属性：需要其值的属性的名称
-
输出： 在 数据 属性中包含结果为数组的对象
-
错误： 无
setFieldProperties（som，属性，值） 为Som表达式中指定的所有字段设置给定属性的值
-
输入：
- som： 数组包含必须设置其值的字段的Som表达式
- 属性：必须设置其值的属性
- 值： 数组包含Som表达式中指定的字段的给定属性的值
-
输出： 无
-
错误： 无
表单Bridge API的示例用法 sample-usage-of-form-bridge-api
// Example 1: FormBridge.restoreFormState
function loadFormState() {
var suc = function(obj) {
//success
}
var err = function(obj) {
while(var t = obj.getNextMessage()) {
$("#errorDiv").append("<div>"+t.message+"</div>");
}
}
var _formState = // load form state from storage
formBridge.restoreFormState({success:suc,error:err,formState:_formState}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
}
//--------------------------------------------------------------------------------------------------
//Example 2: FormBridge.submitForm
function SubmitForm() {
var suc = function(obj) {
var data = obj.data;
// submit the data to a url;
}
var err = function(obj) {
while(var t = obj.getNextMessage()) {
$("#errorDiv").append("<div>"+t.message+"</div>");
}
}
formBridge.submitForm({success:suc,error:err}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
}