在模型驅動應用程式中，控制項代表表單上的 HTML 元素。 有些控制項綁定於特定欄位，而另一些則代表未綁定的控制項，例如加入表單的 IFRAME、網頁資源或子格線。
控制項物件提供方法來變更控制項的呈現或行為，並識別對應的資料行。 透過以下集合之一進行存取控制：
- formContext.ui.controls
- formContext.ui 區段.controls
- formContext.data.entity屬性.controls
formContext。getControl方法是一種存取formContext.ui.controls.get的捷徑方法。
備註
當你對與欄位綁定的控制項執行操作時，請考慮該控制項可能會在頁面上出現不只一次。 一般來說，你應該對該欄位的每個控制項執行相同的操作。 你可以循環於欄位 控制集合 中，對每個控制項執行相應操作。
控制項會依類型分類。 使用 getControlType 方法來判斷控制項的類型。 某些控制方法僅適用於特定類型的控制。
本文提供每種控制類型可用的方法資訊。
標準控制類型
這些方法適用於標準控制。
| Method | Description |
|---|---|
| 新增通知 | 顯示錯誤或推薦通知，並附有可選操作。 |
| 清除通知 | 移除控制鍵上的通知。 |
| get屬性 | 傳回控制項繫結的資料行。 |
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getOutputs | 回傳控制項輸出屬性的字典。 |
| getParent | 回傳包含控制項的區塊。 |
| getVisible | 回傳控制項是否可見。 |
| 設定已停用 | 啟用或停用控制。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| 設定通知 | 顯示錯誤訊息以表示資料無效。 |
| setVisible | 顯示或隱藏控制項。 |
以下標準控制的方法已被 棄用： addOnKeyPress、 fireOnKeyPress 和 removeOnKeyPress。
IFRAME 控制類型
這些方法適用於 IFRAME 控制項。
| Method | Description |
|---|---|
| getContentWindow | 回傳 IFRAME 或網頁資源的內容視窗。 |
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| getInitialUrl | 回傳 IFRAME 預設的 URL。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getObject | 回傳代表 IFRAME 或網頁資源的表單物件。 |
| getParent | 回傳包含控制項的區塊。 |
| getSrc | 回傳目前在 IFRAME 或網頁資源中顯示的 URL。 |
| getVisible | 回傳控制項是否可見。 |
| 設定已停用 | 啟用或停用控制。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| setSrc | 將網址設定為在 IFRAME 或網頁資源中顯示。 |
| setVisible | 顯示或隱藏控制項。 |
Kbsearch（知識庫搜尋）控制類型
這些方法可用於知識庫搜尋控制。
| Method | Description |
|---|---|
| addOnPostSearch | 新增一個在搜尋完成後執行的事件處理器。 |
| addOn結果已開啟 | 新增一個事件處理程序，當搜尋結果開啟時會執行。 |
| addOn選擇 | 新增一個事件處理器，當選取搜尋結果時會執行。 |
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getParent | 回傳包含控制項的區塊。 |
| getSearch查詢 | 回傳用作搜尋條件的文字。 |
| getSelected結果 | 回傳目前選取的搜尋結果。 |
| getTotalResultCount | 回傳搜尋結果的數量。 |
| getVisible | 回傳控制項是否可見。 |
| 開啟搜尋結果 | 開啟指定的搜尋結果。 |
| removeOnPostSearch | 移除搜尋完成時的事件處理器。 |
| removeOn結果已開啟 | 移除開啟搜尋結果的事件處理器。 |
| removeOnSelection | 移除選取搜尋結果的事件處理程序。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| setSearch查詢 | 設定所用的文本作為搜尋條件。 |
| setVisible | 顯示或隱藏控制項。 |
備註
當你將知識庫搜尋控制項加入社交窗格時，控制名稱為 searchwidgetcontrol_notescontrol。 你不能改這個名字。
查閱控制項類型
這些方法可用於查閱控制項。
| Method | Description |
|---|---|
| 新增自訂篩選器 | 透過使用 AND 將現有篩選器加入搜尋結果。 |
| addCustomView | 在查詢對話框中新增檢視功能。 |
| 新增通知 | 顯示錯誤或推薦通知，並附有可選操作。 |
| addOnLookupTagClick | 新增一個事件處理器，當點擊查詢標籤時會執行。 |
| addPreSearch | 新增一個事件處理程序，會在查詢搜尋前執行。 |
| 清除通知 | 移除控制鍵上的通知。 |
| get屬性 | 傳回控制項繫結的資料行。 |
| getControlType | 回傳控制的類型。 |
| getDefaultView | 回傳預設查詢視圖的 ID。 |
| get禁用 | 傳回控制項是否已停用。 |
| getEntity類型 | 回傳查詢中允許的資料表類型。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getParent | 回傳包含控制項的區塊。 |
| getVisible | 回傳控制項是否可見。 |
| removeOnLookupTagClick | 移除用於查詢標籤點擊的事件處理程序。 |
| removePreSearch | 移除在查詢搜尋前執行的事件處理器。 |
| setDefaultView | 在查詢對話框中設定預設視圖。 |
| 設定已停用 | 啟用或停用控制。 |
| setEntity類型 | 設定查找時允許的資料表類型。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| 設定通知 | 顯示錯誤訊息以表示資料無效。 |
| setVisible | 顯示或隱藏控制項。 |
選擇和選擇控制類型
選擇與選擇控制有相同的方法。
| Method | Description |
|---|---|
| 新增通知 | 顯示錯誤或推薦通知，並附有可選操作。 |
| add選項 | 在控制中新增了一個選項。 |
| 清除通知 | 移除控制鍵上的通知。 |
| 清除選項 | 移除控制中的所有選項。 |
| get屬性 | 傳回控制項繫結的資料行。 |
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| get選項 | 返回可用選項，包括空白選項並排除已移除的選項。 |
| getParent | 回傳包含控制項的區塊。 |
| getVisible | 回傳控制項是否可見。 |
| 刪除選項 | 移除控制鍵中的一個選項。 |
| 設定已停用 | 啟用或停用控制。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| 設定通知 | 顯示錯誤訊息以表示資料無效。 |
| setVisible | 顯示或隱藏控制項。 |
快速表單控制類型
如需此控制項型別支援方法的相關資訊，請參閱 formContext.ui.quickForms 。
子格控項類型
有關此控制類型支援的方法，請參見「 網格與子網格 」。
時間軸牆控制類型
時間軸控制項以統一的視圖呈現貼文、活動與筆記。 這些方法適用於此控制項類型。
| Method | Description |
|---|---|
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getParent | 回傳包含控制項的區塊。 |
| getVisible | 回傳控制項是否可見。 |
| 重新整理 | 刷新時間軸中顯示的資料。 |
| 設定已停用 | 啟用或停用控制。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| setVisible | 顯示或隱藏控制項。 |
定時器控制類型
這些方法可用於計時器控制。
| Method | Description |
|---|---|
| getControlType | 回傳控制的類型。 |
| get禁用 | 傳回控制項是否已停用。 |
| get標籤 | 回傳對照組的標籤。 |
| 取得名稱 | 回傳控制組名稱。 |
| getParent | 回傳包含控制項的區塊。 |
| getState | 回傳計時器的當前狀態。 |
| getVisible | 回傳控制項是否可見。 |
| 重新整理 | 刷新計時器中顯示的資料。 |
| 設定已停用 | 啟用或停用控制。 |
| 設定焦點 | 移動時會專注於控制。 |
| setLabel | 更改控制標籤。 |
| setVisible | 顯示或隱藏控制項。 |
Web 資源控制類型
Web 資源控制項具有與 iframe 控制項相同的方法集。 請參見 iframe 控制類型。
表單元件控制類型
表單元件控制項型別具有與主要表單上的 formContext 相同的方法集。 請參見 表單元件行為 > 用戶端 API。