E9流程表单前端接口API(2021)

### E9流程表单前端接口API(2021)详解 #### 1. 说明 ##### 1.1 简介 E9流程表单前端接口API是一套专门为泛微E9平台设计的前端交互接口集合。该API旨在简化前端开发人员的工作流程，提高开发效率，并确保在不同设备上的兼容性和一致性。通过使用这套API，开发人员可以轻松地实现对表单的操作，包括但不限于字段值的获取和修改、自定义事件的注册以及各种表单级别的功能。 ##### 1.2 移动端兼容 API的设计充分考虑了移动端的兼容性问题。所有的API接口都经过了优化，能够在不同的移动设备上正常运行，例如eMobile、微信和钉钉等移动终端。此外，为了进一步提升兼容性，建议开发者使用WfForm对象下的API接口进行操作，而不是直接使用jQuery或其他JavaScript库来操作DOM。 ##### 1.3 前端代码开发方式 前端代码开发主要通过以下几种方式进行： - **方式1**：在模板上编写代码块，这种方式适用于单个节点，可以在显示、打印或移动模板中单独配置。 - **方式2**：通过“路径管理”中的“基础设置”->“自定义页面”，这种方式适用于路径下的所有节点的所有模板。 - **方式3**：在“路径管理”->“应用设置”->“流程表单自定义页面设置”中进行配置，这种方式适用于整个系统的非模板模式场景。 需要注意的是，第三种方式的自定义页面为全局custompage，应避免写入ready、checkCustomize等全局函数，只定义具体的函数体。此外，方式二和方式三中禁止引入init_wev8.js。 ##### 1.4 PC端打开表单的方式 对于PC端，可以通过以下方式打开表单： - **新建请求**：通过传入路径ID，可以打开创建请求的页面。例如：`window.open("/workflow/request/CreateRequestForward.jsp?workflowid=747")` - **查看请求**：通过传入请求ID，可以查看具体的请求详情。例如：`window.open("/workflow/request/ViewRequestForwardSPA.jsp?requestid=5963690")` #### 1.5 移动端打开表单的方式 对于移动端，可以使用WfForm对象中的isMobile()方法来判断当前是否处于移动端环境。例如： ```javascript var isMobile = WfForm.isMobile(); // true表示是eMobile、微信、钉钉等移动终端，false代表PC端 ``` #### 2. 注册自定义事件 - **2.1 注册拦截事件**：可以指定某个动作执行前触发的事件，并且可以选择阻断或放行后续操作。 - **2.2 注册钩子事件**：指定某个动作完成后触发的事件。 #### 3. 字段基础操作接口 - **3.1 将字段名称转换成字段ID** - **3.2 获取单个字段值** - **3.3 修改单个字段值** - **3.4 改变单个字段显示属性**（如只读、必填等） - **3.5 同时修改字段的值及显示属性** - **3.6 批量修改字段值或显示属性** - **3.7 触发指定字段涉及的所有联动** - **3.8 根据字段ID获取字段信息** - **3.9 获取字段当前的只读/必填属性** #### 4. 表单字段事件绑定、自定义渲染 - **4.1 表单字段值变化触发事件** - **4.2 明细字段值变化触发事件** - **4.3 字段区域绑定动作事件** - **4.4 自定义代理渲染单行文本框字段** - **4.5 自定义追加渲染表单字段** - **4.6 函数式自定义渲染表单字段** - **4.7 根据字段标识获取字段组件** #### 5. 明细表操作相关接口 - **5.1 添加明细行并设置初始值** - **5.2 删除明细表指定行/全部行** - **5.3 选中明细指定行/全部行** - **5.4 获取明细行所有行标示** - **5.5 获取明细选中行下标** - **5.6 控制明细行check框是否禁用勾选** - **5.7 控制明细数据行的显示及隐藏** - **5.8 获取明细已有行的数据库主键** - **5.9 获取明细总行数** - **5.10 添加行、删除行前执行逻辑或阻断事件** - **5.11 添加行、删除行后触发事件** - **5.12 移动端跳转至明细编辑行页面执行事件** - **5.13 添加明细时默认复制最后一行记录** #### 6. 常用全局接口 - **6.1 获取当前打开请求的基础信息** - **6.2 可控制显示时间的message信息** - **6.3 系统样式的Confirm确认框** - **6.4 表单顶部按钮、右键菜单置灰** - **6.5 调用右键按钮事件** - **6.6 刷新表单页面** - **6.7 移动端打开链接方式** - **6.8 扩展提交操作发送给服务端的参数** - **6.9 获取校验必填逻辑第一个未必填的字段** - **6.10 触发一次必填验证** #### 7. 不同字段类型特定接口 除了以上提到的基本操作外，还有一系列针对特定字段类型的接口，这些接口可以更细致地控制不同类型的表单字段。这些接口涵盖了从基本的文本输入到复杂的表格操作等各个方面，旨在满足开发人员在实际项目中的多样化需求。