取得表單上的控制項。
備註
getControl 僅適用於表單本文和標題中的控制項。 頁面上其他位置的控制項不支援它,即使它們參考相同的資料行也一樣。
- 如需 商務程序流程內的控制項,請使用前置詞
header_process_來參照它們。 - 不支援其他控制項 (例如 子方格 和 時間軸控制項 ) 內的控制項。
語法
formContext.getControl(arg);
formContext.getControl(arg) 方法是存取 formContext.ui.controls.get 的捷徑方法。
參數
arg:選擇性。 您可以將引數傳遞為表單上控制項的 名稱 或 索引值 ,以存取表單上的控制項。 例如:formContext.getControl("firstname") 或 formContext.getControl(0)。 如果名稱拼字錯誤且不在表單上,則 arg 會傳回 Null 值。
如果未提供值 arg ,它會傳回表單上所有控制項的陣列。
傳回值
類型:物件集合、物件或 null。
描述:如果您使用沒有任何參數的方法,則為物件集合。 Object 或 null (如果您將方法與參數搭配使用)。 如果您使用 名稱 作為參數,且同一資料行有多個控制項,則只會傳回第一個控制項。
小提示
如果您想要修改繫結至表單上欄的所有控制項,請使用欄類型內的控制項集合。
例如,若要將通知新增至繫結至 name 資料行的每個控制項,您可以執行下列動作:
const notification = {
messages: ['Sample Notification on Name Controls'],
notificationLevel: 'RECOMMENDATION',
uniqueId: 'my_unique_id'};
formContext.getAttribute("name").controls.forEach(control => control.addNotification(notification));