E9表单建模前端接口API:字段属性操作指南

需积分: 44 7 下载量 118 浏览量 更新于2024-08-06 收藏 1.2MB PDF 举报
"本文档介绍了在泛微OA E9API中与表单建模前端接口相关的API使用,特别是关于获取和设置字段属性的操作,如`getFieldInfo`和`getFieldCurViewAttr`。这些接口用于中型项目的实战场景,帮助开发者获取字段的详细信息并实时调整字段的只读和必填属性。" 在泛微OA E9API中,表单建模前端接口API提供了一系列工具,方便开发者处理与表单交互的各种任务。这些接口统一封装在全局对象`window.ModeForm`中,推荐使用API而非jQuery或原生JS操作DOM,以确保代码的稳定性和效率。 ### 6.2 根据字段ID获取字段信息 `getFieldInfo`函数用于获取字段的详细信息,包括名称、类型、只读和必填属性等。此功能返回JSON格式的数据,其中关键属性有: - `fieldhtmltype`: 字段的大类型,如文本、多行文本等。 - `fieldtype`: 字段的数据类型,例如1表示文本,2表示整数,4表示金额转换,3表示浮点数。 - `fieldname`: 字段在数据库中的名称。 - `fieldlabel`: 字段在用户界面中的显示名称。 - `viewattr`: 字段的属性标志,1代表只读,2代表可编辑,3代表必填。 调用示例:`ModeForm.getFieldInfo("field15612");` ### 6.3 获取字段当前的只读/必填属性 `getFieldCurViewAttr`方法用于实时获取字段的当前显示属性,这与后台配置的字段属性可能有所不同。如果需要获取后台配置的属性,应使用6.2中的`getFieldInfo`方法。返回值表示字段状态,1表示只读,2表示可编辑,3表示必填。 调用示例:`ModeForm.getFieldCurViewAttr("field110_2");` ### 常用基础操作接口 #### 2.1 将字段名称转换成字段id `convertFieldNameToId`函数用于将字段名称转换为字段标识,方便在不同表单和环境中通用。函数接受三个参数: - `fieldName`: 字段名称。 - `symbol`: 表单标识,默认为主表`main`,可设置为明细表如`detail_1`。 - `prefix`: 是否在返回值中包含`field`前缀,默认为`true`。 调用示例: ```javascript var fieldId = ModeForm.convertFieldNameToId("zs"); var fieldId = ModeForm.convertFieldNameToId("zs_mx", "detail_1"); var fieldId = ModeForm.convertFieldNameToId("zs_mx", "detail_1", false); ``` #### 2.2 获取单个字段值 `getFieldValue`函数用于获取指定字段标识的字段值,例如:`var fieldValue = ModeForm.getFieldValue("field110");` #### 2.3 修改单个字段值 `changeFieldValue`方法用于更新字段值,并能自动触发关联的联动效果。参数包括: - `fieldMark`: 字段标识。 - `valueInfo`: 字段的新值信息,非浏览按钮字段以JSON格式传递,包含`value`属性;浏览按钮字段的特殊信息以数组格式传递,包含`showhtml`属性(仅在文本字段且只读时有效)。 调用示例: ```javascript ModeForm.changeFieldValue("field110", {value: "新值"}); ``` 泛微OA E9API提供了丰富的表单操作接口,允许开发者高效地管理表单的字段属性,从而实现灵活的业务逻辑和用户界面交互。通过熟练掌握这些接口,可以提升中型项目开发的效率和质量。