# CAP4表單前端接口 - 移動端 * * * CAP4移動端表單前端接口文檔 CAP4移動端表單前端接口文檔適用于M3(app)、微協同等 ## 1\. 表單事件 ### 1.1. cap\_form\_afterFormRender ~~~ 在表單首次渲染完成時觸發（只觸發一次） ~~~ *用法示例:* ~~~javascript document.addEventListener('cap_form_afterFormRender', function(evt) { console.log(evt) }); ~~~ *事件參數:*  ### 1.2. cap\_form\_afterFormUpdate ~~~ 在表單任何內容（包括主表字段/明細表字段/明細行）變化導致表單渲染更新時均會觸發 ~~~ *用法示例:* ~~~javascript document.addEventListener('cap_form_afterFormUpdate', function(evt) { console.log(evt) }); ~~~ *事件參數:* 無 ## 2\. 表單API ### 2.1. XForm.getData() ~~~ 獲取整個表單數據 ~~~ *接口參數:* 無 *用法示例:* ~~~javascript XForm.getData() ~~~ *返回結果:* ~~~javascript { metadata: Object, // metadata中含有表單id，權限id等信息 formmains: Object, // 主表數據 formsons: Object // 明細表數據 } ~~~  ### 2.2. XForm.getField(fieldName\[，tableName, recordId\]) ~~~ 獲取某個字段（控件）信息 ~~~ *接口參數:* | 參數名 | 參數類型 | 是否必須 | 說明 | | --- | --- | --- | --- | | fieldName | String | 必須 | 字段名 | | tableName | String | 可選 | 明細表名 | | recordId | String | 可選 | 明細行記錄id | *用法示例:* ~~~javascript XForm.getField(fieldName) // 獲取主表字段 XForm.getField(fieldName，tableName, recordId) // 獲取明細行字段 ~~~ *返回結果:* ~~~javascript { metadata: Object, // metadata中含有表單id，權限id等信息 formmains: Object, // 主表數據 formsons: Object // 明細表數據 } ~~~  ### 2.3. XForm.setField(fieldName, data\[，tableName, recordId\]) ~~~ 更新某個字段（控件）信息 ~~~ *接口參數:* | 參數名 | 參數類型 | 是否必須 | 說明 | | --- | --- | --- | --- | | fieldName | String | 必須 | 字段名 | | data | Object | 必須 | 更新的數據 | | tableName | String | 可選 | 明細表名 | | recordId | String | 可選 | 明細行記錄id | *用法示例:* ~~~javascript data = { display: '新的控件標題', showValue: '新的控件顯示值' } XForm.setField(fieldName, data) // 更新主表字段 XForm.setField(fieldName，data, tableName, recordId) // 更新明細行字段 ~~~ *返回結果:* ~~~javascript true // 更新成功 false // 更新失敗 ~~~ ### 2.4. XForm.allowedProps ~~~ 列出字段（控件）支持更新的屬性列表 ~~~ ## 3\. 注意事項 * 目前僅提供部分表單事件，后續根據實際反饋開放 * cap2的事件名為sui\_form\_afterFormRender * XForm是CAP4移動端暴露在全局的變量 * 目前只支持XForm.allowedProps列表內屬性被更新 * 未列出內容，待后續更新補充 * * * *End*