文档AEM 6.4Forms 指南

HTML5表单的脚本支持 scripting-support-for-html-forms

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 用户
CAUTION
AEM 6.4已结束扩展支持，本文档将不再更新。 有关更多详细信息，请参阅 技术支助期. 查找支持的版本 此处.

HTML5表单中支持的JavaScript、FormCalc属性和方法如下所示：

$event event

属性
描述
例外
prevText
指定字段内容，然后字段根据用户的操作进行更改。 此值与撤消功能类似，可以回调。

不适用于下拉框和列表框。 PrevText 无法在以下情况下正常工作：

  • 在iPad的数字字段中键入一些特殊字符键(例如$、(、)、&、@等)，以及
  • 对于“日期”字段（通过日历输入日期时）。

不支持通过脚本设置值。

target
指定事件在其上执行操作的对象。
不支持通过脚本设置值。
newtext
指定字段在响应用户操作而发生更改后的内容。

的 newText 属性在以下情况下无法正常工作：

  • 论文本的选替
  • 删除、复制和粘贴文本时。
  • 在数字字段中键入一些特殊字符键(例如$、(、)、&、@等)
  • 使用shift+字母数字组合。
  • 使用日期/时间字段时。

不支持通过脚本设置值。

更改
指定用户在执行操作后立即键入或粘贴到字段中的值。

对于以下情况，更改属性无法正常工作：

  • 论文本的选替
  • 删除、复制和粘贴文本时。
  • 在数字字段中键入一些特殊字符键(例如$、(、)、&、@等)
  • 使用shift+字母数字组合。
  • 使用日期/时间字段时。

不支持通过脚本设置值。

关键
确定用户是否按箭头键进行选择。 此属性仅适用于列表框和下拉列表。
无
修饰符
确定在执行特定事件时是否按住修饰符键(例如，Microsoft® Windows®上的Ctrl)。
无

$host host

属性
描述
例外
apptype
返回主机的应用程序类型。 仅适用于客户端应用程序。
返回结果 HTML 5.
name
返回当前应用程序的名称。
返回浏览器名称及其版本。 例如，在Chrome浏览器中，返回的值为 Chrome <version>.
numPages
返回文档中的页数。
HTML5表单的分页策略与PDF forms分页策略不相同。 因此，numPages API在这两种情况下都可以返回不同的值。
platform
返回表示运行脚本的计算机平台的字符串。
无
title
指定文档的标题。 它仅适用于客户端应用程序。
它会以表单形式返回HTML文档的标题，而不是像PDF forms一样返回表单元数据标题。
version
返回表示当前应用程序版本号的字符串。
它会返回表单的版本。
calculationsEnabled
指定是否执行计算脚本。
无
validationsEnabled
指定是否执行验证脚本。
无
pageUp
转到上一页。
HTML5表单与PDF表单不遵循相同的分页策略，因此HTML5表单的上一页与PDF表单的上一页不同。
pageDown
移动到表单的下一页。 在运行时使用pageDown方法。
setFocus
将键盘焦点设置到指定的字段。 该字段被指定为对象，或由该字段的SOM表达式指定。 它仅适用于客户端应用程序。
resetdata
将文档中的字段重置为其默认值。
清除表单中包含合并数据的所有数据，而不是将其恢复为默认值。
messageBox
在屏幕上显示一个对话框。 它仅适用于客户端应用程序
类型为“是/否”的消息框将转换为“确定/取消”。 不支持包含三个按钮的消息框。
currentPage

在运行时设置文档的当前活动页面。

页面值以0为基础，因此文档的第一页返回值0。

当layout:ready在客户端上执行时，当前页面属性可用。 但是，当layout:ready在服务器上执行时，它不可用，因为直到表单布局执行后才会执行属性。

无

字段 field

属性
描述
例外
presence
控制关联对象在不同处理阶段的参与率。 如果对象是容器，则容器的内容将继承此控件所适用的任何限制。
无
access
控制用户对内容的访问。
不适用于排除组。 此外，HTML5形式对非交互和受保护的物体给予相同的处理。
name
用于在脚本表达式中标识此元素的标识符。
HTML5表单不允许设置对象的name属性。 它是HTML5表单的只读属性。
value
包含单个数据内容单位的内容元素。
无
rawValue
指定此字段的未格式化值。
无
formattedValue
指定此字段的格式化值。
设置 formattedValue 不支持通过脚本。
editValue
指定此字段的编辑值。
设置 editValue 不支持通过脚本。
formatMessage
指定此字段的格式验证消息字符串。
设置 formatMessage 不支持通过脚本。
fillcolor
指定此字段的背景颜色值。 您需要将border.fill.presence属性设置为单独可见。
它无法正确返回字段的默认颜色。
border
边框对象描述对象周围的边框。
ui
用户界面对象封装了表单对象的用户界面描述。
mandatory
为字段指定nullTest值。
borderColor
指定此字段的边框颜色值。 您需要将border.edge.presence属性设置为单独可见。
无法正确返回字段的默认边框颜色。
length
列表中的项目数。
无
addItem
将新项目添加到当前字段。
无
clearItem
删除字段中的所有项目。
无
boundItem
获取下拉列表或列表框的特定显示项的绑定值。
无
execCalculate
执行字段的计算脚本。
无
execValidate
执行字段的验证脚本。
无
execEvent
执行对象的事件脚本。
无
getItemState
返回指定项的选择状态
无
setItemState
设置指定项目的选择状态。
无
getDisplayItem
检索指定项目索引的项目显示文本。
无
getSaveItem
检索指定项目索引的数据值。
无
deleteItem
删除指定索引处的项目。
无
setItems
设置当前字段中的指定项目。 它会替换预先存在的项目。
无
h
布局的高度测量。
无
w
指定布局宽度的测量。
无
x
使用定位布局放置时，指定容器锚点相对于父容器左上角的x坐标。
无
y
使用定位布局放置时，指定容器锚点相对于父容器左上角的y坐标。
无
caption
标题对象描述与表单设计对象关联的描述性标签。
无
验证
验证对象控制表单上用户提供数据的验证。 验证对象可在表单生命周期中多次激活。
无
parentSubform
指定此字段的父子表单（页面）。
始终返回父子表单，而不是返回第一个非范围划分的父子表单。
selectedIndex
第一个选定项的索引。
无

表单 form

属性
描述
例外
formNodes
返回绑定到指定数据对象的所有表单模型对象的列表。

InstanceManager instancemanager

属性
描述
name
用于在脚本表达式中标识此元素的标识符。
occur
描述对其封闭容器允许的实例数的限制。
min
指定可实例化的最小实例数。
max
指定可实例化的最大实例数。
count
指定实例化的当前实例数。
setInstances
从此节点添加或删除指定的子表单或子表单集。
addInstance
向此节点添加子表单或子表单集的新实例。
removeInstance
从此节点中删除子表单或子表单集。
moveInstance
将表单模型对象的子对象移动到表单模型内的其他指定位置。 对象的相应数据模型信息也在数据模型内被重新定位。
insertInstance
向此节点插入子表单或子表单集的新实例。

list list

属性
描述
length
列表中的元素数。
item
集合中从零开始的索引。
append
将节点附加到节点列表的末尾。
remove
从节点列表中删除节点。
insert
在节点列表中的特定节点之前插入节点。

节点 node

属性
描述
例外
createNode
根据有效的类名称创建新节点。
无
isContainer
指定此对象是否为容器对象。
无
isNull
指示当前数据值是否为空值。
无
resolveNode
从当前XML表单对象模型对象开始计算指定的SOM表达式，并返回在SOM表达式中指定对象的值。
无
resolveNodes
从当前XML表单对象模型对象开始计算指定的SOM表达式，并返回在SOM表达式中指定对象的值。
无
oneOfChild
根据有效的类名称创建新节点。
无
getElement
返回指定的子对象。
无
getAttribute
获取指定的属性值。
无
setAttribute
设置指定属性的值。
无

模型 model

属性
描述
例外
NA
NA
NA

子表单 subform

属性
描述
例外
instanceIndex
指定对象相对于其他实例化实例的索引。
无
execEvent
执行对象的事件脚本。
无
getInvalidObjects
返回子表单（包括）中包含的未通过验证测试的节点列表。
无
边框
边框对象描述对象周围的边框。
无
borderColor
指定此字段的边框颜色值。 您需要将border.edge.presence属性设置为单独可见。
无
h
布局的高度测量。
无
w
指定布局宽度的测量。
无
x
使用定位布局放置时，指定容器锚点相对于父容器左上角的x坐标。
无
y
使用定位布局放置时，指定容器锚点相对于父容器左上角的y坐标。
无
验证
验证对象控制表单上用户提供数据的验证。 验证对象可在表单生命周期中多次激活。
无
name
用于在脚本表达式中标识此元素的标识符。
无
存在
指定对象的可见性。
无
访问
控制用户对容器对象（如子表单）内容的访问。
无
execValidate
根据子表单或子表单集相对于同一表单对象的其他实例的位置计算其索引。
无
instanceManager
instanceManager对象管理表单模型对象的实例创建、移除和移动。
无

提交 submit

属性
描述
目标
数据提交到的URL。 此属性的遗漏意味着XFA处理应用程序使用产品特定技术（如访问配置对象中的产品特定信息）来获取URI。

树 tree

属性
描述
例外
节点
返回当前对象的所有子对象的列表。
  • xfa.nodes、desc不支持
  • 报告的PDF和HTML节点数不同。
name
指定此节点的名称。
不允许在HTML中使用脚本设置名称。
parent
获取此节点的父项。
无
index
返回此节点在其相似名称、范围内、相似子关系节点集合中的位置。
无
somExpression
获取此节点的SOM表达式。
无
resolveNode
从当前XML表单对象模型对象开始计算指定的SOM表达式，并返回在SOM表达式中指定对象的值。
无
resolveNodes
从当前XML表单对象模型对象开始计算指定的SOM表达式，并返回在SOM表达式中指定对象的值。
无

子格式集 subformset

属性
描述
例外
instanceManager
instanceManager对象管理表单模型对象的实例创建、移除和移动。
无

content content

属性
描述
例外
isNull
指示当前数据值是否为null值。

dataValue datavalue

属性
描述
例外
isNull
指示当前数据值是否为null值。

边缘 edge

属性
描述
例外
颜色
color属性描述阵列对象的唯一颜色。
  • 无法检索默认值。
  • 这些更改会反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

填充 fill

属性
描述
例外
颜色
颜色属性定义填充的唯一颜色。
  • 无法检索默认值。
  • 这些更改会反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

线性 linear

属性
描述
例外
颜色
颜色属性描述表单上线性渐变填充的唯一颜色。
  • 无法检索默认值。
  • 这些更改会反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

折线图 line

属性
描述
例外
边缘
边缘对象描述边框或矩形的弧、线或一侧。
不支持颜色、大写等属性。

图案 pattern

属性
描述
例外
颜色
color属性描述阵列对象的唯一颜色。
  • 无法检索默认值。
  • 这些更改会反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

径向 radial

属性
描述
例外
颜色
颜色属性描述径向对象的唯一颜色
  • 无法检索默认值。
  • 这些更改会反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

拼点 stipple

属性
描述
例外
颜色
color属性描述拼合对象的唯一颜色。
  • 无法检索默认值。
  • 这些更改将反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

绘制 draw

属性
描述
例外
ui
用户界面对象封装了表单对象的用户界面描述。
caption
标题对象描述与表单设计对象关联的描述性标签。
存在
指定对象的可见性。
name
指定可用于在脚本表达式中指定此对象或事件的标识符。
不支持在运行时设置值
值
值对象将封装单个数据内容单位。

角 corner

属性
描述
例外
颜色
color属性描述角对象的唯一颜色。
  • 无法检索默认值。
  • 这些更改将反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

checkButton checkbutton

属性
描述
例外
边框
边框对象描述checkButton对象周围的边框。
这些更改将反映在模型中，可用于编写脚本，但不会与HTML元素同步。 因此，这些更改不会反映在UI中。

choiceList choicelist

属性
描述
例外
边框
边框对象描述choiceList对象周围的边框。

dateTimeEdit datetimeedit

属性
描述
例外
边框
边框对象描述dateTimeEdit对象周围的边框。

图像 image

属性
描述
例外
contentType
指定引用文档中的内容类型，以MIME类型表示。
无
name
用于在脚本表达式中标识此元素的标识符。
无

imageEdit imageedit

属性
描述
例外
边框
边框对象描述imageEdit对象周围的边框。

numericEdit numericedit

属性
描述
例外
边框
边框对象描述对象周围的边框。
无

对象 object

属性
描述
例外
className
确定此对象的类的名称。
无

矩形 rectangle

属性
描述
例外
边缘
边缘对象描述边框或矩形的弧、线或一侧。
不支持颜色、大写等属性。

textEdit textedit

属性
描述
例外
边框
边框对象描述对象周围的边框。
无

exclGroup exclgroup

属性
描述
例外
布局
指定要由此对象使用的布局策略。
无
边框
指定此字段周围的边框。
无
强制
为字段指定nullTest值。
无
borderColor
指定此字段的边框颜色值。必须先定义边框，然后才能通过脚本更改颜色。
无
borderWidth
指定此字段的边框宽度。
无
h
布局的高度测量。
无
瞬态
指定处理应用程序是否必须在表单提交或保存操作中保存排除组的值。
无
w
指定布局宽度的测量。
无
x
使用定位布局放置时，指定容器锚点相对于父容器左上角的x坐标。
无
y
使用定位布局放置时，指定容器锚点相对于父容器左上角的y坐标。
无
caption
标题对象描述与表单设计对象关联的描述性标签。
无
验证
验证对象控制表单上用户提供数据的验证。 验证对象可在表单生命周期中多次激活。
无
dataNode
获取在合并后表单节点绑定到的数据节点。
无
存在
指定对象的可见性。
访问
控制用户对容器对象（如子表单）内容的访问。
对于排除组中的单个项目，始终会返回打开状态。
name
指定可用于在脚本表达式中指定此对象或事件的标识符。
无
成员
指定排除组的成员。
无
selectedMember
返回排除组的选定成员。
无
execCalculate
对指定对象的计算事件和任何子对象执行任何脚本。
无
计算
计算对象控制字段值的计算。
无

弧 arc

属性
描述
例外
边缘
边缘对象描述边框或矩形的弧、线或一侧。
不支持颜色、大写等属性。

边框 border

属性
描述
例外
边缘
边缘对象描述边框或矩形的弧、线或一侧。
不支持颜色、大写等属性。

$布局 layout

属性
描述
例外
h
确定给定表单设计对象的高度。
  • 页面区域和内容区域不支持高度(h)属性。
  • 不支持参数“XFA-Form对象发生在的第一个内容区域的偏移”。
w
确定给定表单设计对象的宽度。
  • 页面区域和内容区域不支持宽度(w)属性。
  • 不支持参数“XFA-Form对象发生在的第一个内容区域的偏移”。
x
确定给定表单设计对象相对于其父对象的x坐标。
  • 页面区域和内容区域不支持x坐标(x)属性。
  • 不支持参数“XFA-Form对象发生在的第一个内容区域的偏移”。
y
确定给定表单设计对象相对于其父对象的y坐标。
  • 页面区域和内容区域不支持y坐标(y)属性。
  • 不支持参数“XFA-Form对象发生在的第一个内容区域的偏移”。
pagecount
确定当前表单的页数。
  • layout.pageCount()方法会为PDF表单和HTML表单返回不同的值。
  • 通过隐藏对象来减少页面计数时，abspagecount方法会返回错误值。
页面内容
从表单的指定页面中检索表单设计对象的类型。
无
absPageCount
确定当前表单的页面计数。
  • layout.pageCount()方法会为PDF表单和HTML表单返回不同的值。
  • 通过隐藏对象来减少页面计数时，abspagecount方法会返回错误值。

项目 items

属性
描述
例外
存在
指定对象的可见性。
无

FormCalc formcalc

FormCalc是一种特定于XFA的语言，用于创建以电子表单为中心的逻辑和计算根。 FormCalculation提供了一组功能强大的构建函数。

FormCalc支持的函数 formcalc-supported-functions

表单计算表达式支持 formcalc-expression-support

类别
描述
样本
简单表达式
加、减、乘、除和圆括号
(a+b)*3
变量声明
定义变量
var a
var a=3
a=3
逻辑表达式
  • 逻辑（和/或）
  • 比较（大/小/等）
A或1
1 <> 2
A NE B
A或1
1 <> 2
A NE B
如果表达式
如果(a>b)，则为2 endif
while
而(ilt 5)do i = i + 1 endwile
的
对于i = 100 - 1
do s = s + i endfor
每个
(1、2、3)中的每个i
do s = s + i endfor
函数声明
在FormCalc中定义自定义函数
func foo(n)do var f = nendfunc

Acrobat API支持 acrobat-api-support

  1. 算术函数

    1. Abs()
    2. Avg()
    3. Ceil()
    4. 计数()
    5. Floor()
    6. Max()
    7. 最小()
    8. Mod()
    9. Round()
    10. 总计()

  2. 科学功能

    1. Acos()
    2. Asin()
    3. Atan()
    4. Atan2()
    5. Cos()
    6. Sin()
    7. 棕褐色()
    8. Exp()
    9. 日志()
    10. Pow()
    11. Sqrt()
    12. Deg2Rad()
    13. Rad2Deg()
    14. Pi()

  3. 财务职能

    1. 四月()
    2. Cterm()
    3. Fv()
    4. Ipmt()
    5. Npv()
    6. Pmt()
    7. Ppmt()
    8. Pv()
    9. Rate()
    10. 术语()

  4. 逻辑函数

    1. Choose()
    2. If()
    3. Oneof()
    4. Within()

  5. 字符串函数

    1. 于()
    2. Concat()
    3. 左()
    4. Len()
    5. Lower()
    6. Ltrim()
    7. 替换()
    8. 右()
    9. Rtrim()
    10. 空间()
    11. Stuff()
    12. Substr()
    13. Upper()
    14. WordNum()

  6. 日期和时间

    1. 日期()
    2. num2date()
    3. DateFmt()
API
描述
象差
console.println()
此Acrobat API将输出转储到Javascript控制台。
app.alert()
此Acrobat API通过javascript弹出窗口发出警报消息。
app.beep()
使系统播放声音。
不执行任何操作。
app.execDialog()
向用户显示一个模式对话框。 必须先由用户关闭模态对话框，然后才能直接再次使用主机应用程序。
不执行任何操作。
app.launchURL()
在浏览器窗口中启动URL。
app.setInterval()
指定JavaScript脚本和时间段。 每经过一段时间，都会执行该脚本。 此方法的返回值必须保留在JavaScript变量中。 否则，间隔对象将被垃圾收集，这将导致时钟停止。 要终止定期执行，请将返回的间隔对象传递到clearInterval。
app.setTimeOut()
指定JavaScript脚本和时间段。 该脚本仅在经过该时段后执行一次。此方法的返回值必须保留在JavaScript变量中。 否则，超时对象将被垃圾收集，这将导致时钟停止。 要取消超时事件，请将返回的超时对象传递给clearTimeOut。
app.clearInterval()
取消由setInterval方法最初设置的先前注册的间隔。
在HTML5表单中，API无法正确运行。
app.clearTimeOut()
取消之前注册的超时间隔。 此类间隔最初由setTimeOut设置。
在HTML5表单中，API无法正确运行。
app.eval()
运行给定脚本。
app.activeDocs
包含每个活动文档的Doc对象的数组。 如果没有处于活动状态的文档，则activeDocs不返回任何内容；即，它的行为与核心JavaScript中的d = new Array(0)的行为相同。
为HTMl5表单返回空数组。
app.calculate
如果为true（默认值），则可以执行计算。 如果为false，则不允许计算。
对于HTMl5 Forms，始终为true。
app.constants
用于保存各种常数值的包装器对象。 当前，此属性返回具有单个属性align的对象。
HTML5表单返回空对齐对象。
app.focusRect
打开和关闭焦点矩形。 焦点矩形是按钮、复选框、单选按钮和签名周围的淡淡虚线，用于指示表单字段具有键盘焦点。 值为true会打开焦点矩形。
对于HTML5表单，始终为true。
app.formsVersion
查看器的版本号构成软件。 如果要在脚本中保持向后兼容性，请检查此属性以确定较新版本软件中的对象、属性或方法是否可用。
始终为11.001。
app.language
运行的Acrobat查看器的语言。
对于HTMl5表单，始终为“简体中文”。

支持的XFA事件 supported-xfa-events

支持以下客户端XFA事件：

  • 初始化
  • 验证
  • 计算
  • 单击
  • 输入
  • 退出
  • 更改
  • ValidationState
NOTE
HTML5表单在客户端（浏览器）上呈现。 建议使用客户端 验证 和 计算 脚本，而不是服务器端脚本。
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da