Xrm.Page.ui (用戶端參考)

發行項
03/04/2017

發行︰ 2017年1月

適用於： Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online

Xrm.Page.ui 包含屬性和方法，擷取使用者介面的資訊，以及表單的數個子元件的集合。

Xrm.Page.ui 屬性和方法

關閉
關閉表單的方法。
控制項
頁面上所有控制項的集合。
formSelector
使用 formSelector.getCurrentItem 方法取得關於目前使用中表單的資訊與 formSelector.items 集合，包含供使用者使用的所有表單的資訊。
getCurrentControl
方法，取得目前在表單上有焦點的控制項物件。

注意

這個方法在 Microsoft Dynamics CRM 2013 更新彙總套件 2 中已被取代。
getFormType
方法，取得記錄的表單內容。
navigation.items
頁面上所有導覽項目的集合。
表單通知
使用 setFormNotification 顯示表單層級通知，使用 clearFormNotification 移除通知。
quickForms
頁面上所有快速檢視控制項的集合。
refreshRibbon
方法，造成功能區重新評估資料，控制其中顯示的項目。
tabs
頁面上所有索引標籤的集合。
ViewPort 方法
ViewPort 是頁面中包含表單資料的區域。它會對應於表單的本文，而且沒有頁面的導覽、頁首、頁尾或表單小幫手區域。使用 getViewPortHeight 和 getViewPortWidth 方法取得 ViewPort 目前的大小。

關閉

關閉表單的方法。

Xrm.Page.ui.close()

備註：

HTML Window.close 方法隱藏。若要關閉表單視窗，必須使用這個方法。如果表單中有任何未儲存的變更，在視窗關閉之前，系統會提示使用者是否要儲存其變更。

在平板電腦專用 Microsoft Dynamics 365，此方法模擬返回導覽按鈕的行為。

控制項

頁面上所有控制項的集合。

如需集合物件的資訊，請參閱集合 (用戶端參考)，如需集合中控制項物件的資訊，請參閱 Xrm.Page.ui 控制項 (用戶端參考)。

formSelector

使用 formSelector.getCurrentItem 方法取得關於目前使用中表單的資訊與 formSelector.items 集合，包含供使用者使用的所有表單的資訊。

注意

formSelectoritems 集合不存在，且 Dynamics 365 行動用戶端 (行動電話和平板電腦) 和互動式服務中心不支援 formSelector.getCurrentItem 方法。

formSelector.getCurrentItem

方法，傳回目前顯示之表單的參照。

注意

如果只有一個表單可使用，此方法會傳回 null。

傳回值
類型：物件

formSelector.items

可供目前使用者存取之所有表單項目的集合。

注意

集合中只有使用者其中一個資訊安全角色相關的表單。

如需集合物件的資訊，請參閱集合 (用戶端參考)，如需集合中項目的資訊，請參閱 Xrm.Page.ui.formSelector 項目 (用戶端參考)。

getCurrentControl

方法，取得目前在表單上有焦點的控制項物件。這個方法不傳回 Web 資源和 IFRAME 控制項。

注意

這個方法在 Microsoft Dynamics CRM 2013 更新彙總套件 2 中已被取代。

當使用者編輯的最後欄位是選項按鈕或核取方塊控制項格式的布林屬性，此方法不會傳回目前控制項的參照。在使用 Xrm.Page.ui 控制項 setFocus 方法之後，此方法也無法立即傳回參照。

Xrm.Page.ui.getCurrentControl()

傳回值
類型：物件

getFormType

方法，取得記錄的表單內容。

Xrm.Page.ui.getFormType()

傳回值
類型：數字

下表列出對應於傳回值的表單類型。

值

表單類型

0

未定義

1

建立

2

更新

3

唯讀

4

已停用

6

大量編輯

注意

快速建立表單會傳回 1。值 5 用於先前的快速建立表單 (已移除)。

值	表單類型
0	未定義
1	建立
2	更新
3	唯讀
4	已停用
6	大量編輯

navigation.items

頁面上所有導覽項目的集合。

注意

此集合不存在於平板電腦專用 Microsoft Dynamics 365。

如需集合物件的資訊，請參閱集合 (用戶端參考)，如需集合中項目的資訊，請參閱 Xrm.Page.ui.navigation 項目 (用戶端參考)。

表單通知

使用 setFormNotification 顯示表單層級通知，使用 clearFormNotification 移除通知。

clearFormNotification

使用此方法移除表單層級通知。

Xrm.Page.ui.clearFormNotification(uniqueId)

參數
- uniqueId
  類型：字串。訊息的唯一識別碼，用於 setFormNotification 設定通知。
傳回值
類型：布林值。如果方法成功則為 true，否則為 false。
備註
此方法僅適用於更新的實體。

setFormNotification

使用此方法顯示表單層級通知。您可以顯示任意數目的通知，而且它們會顯示，直到使用 clearFormNotification 移除。通知區域的高度有限，因此每個新訊息會在頂端加入。使用者可以向下捲動，檢視未移除的舊訊息。

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

參數
- message
  類型：字串。訊息文字。
- level
  類型：字串。訊息等級。
  
  等級定義訊息顯示方式。
  - ERROR：通知使用系統錯誤圖示。
  - WARNING：通知使用系統警告圖示。
  - INFO：通知使用系統資訊圖示。
- uniqueId
  類型：字串。訊息的唯一識別碼，用於 clearFormNotification 移除通知。
傳回值
類型：布林值。如果方法成功則為 true，否則為 false。
備註
此方法僅適用於更新的實體。

quickForms

表單上所有快速檢視控制項的集合，使用新的表單轉譯引擎 (也稱為「渦輪表單」)。如需此集合支援的屬性和方法和集合內物件的詳細資訊，請參閱 Xrm.Page.ui quickForms (用戶端參考)

refreshRibbon

方法，造成功能區重新評估資料，控制其中顯示的項目。

Xrm.Page.ui.refreshRibbon()

傳回值
類型： 無

備註： 當功能區 <EnableRule> (RibbonDiffXml) 依賴表單的值時，通常使用此函數。在您的程式碼變更規則使用的值之後，使用這個方法強制功能區重新評估表單資料，以便規則可套用。

tabs

頁面上所有索引標籤的集合。

如需集合物件的資訊，請參閱集合 (用戶端參考)，如需集合中項目的資訊，請參閱 Xrm.Page.ui 索引標籤 (用戶端參考)。

ViewPort 方法

ViewPort 是頁面中包含表單資料的區域。它會對應於表單的本文，而且沒有頁面的導覽、頁首、頁尾或表單小幫手區域。使用 getViewPortHeight 和 getViewPortWidth 方法取得 ViewPort 目前的大小。

注意

這些方法不適用於平板電腦專用 Microsoft Dynamics 365。

getViewPortHeight

方法，取得檢視區的高度 (像素)。

Xrm.Page.ui.getViewPortHeight()

傳回值
類型：數字

getViewPortWidth

方法，取得檢視區的寬度 (像素)。

Xrm.Page.ui.getViewPortWidth()

傳回值
類型：數字

另請參閱

用戶端程式設計參考
 表單指令碼快速參考
 撰寫 Microsoft Dynamics 365 表單的程式碼
 使用 Xrm.Page 物件模型
 Xrm.Page.data.entity (用戶端參考)

Microsoft Dynamics 365

共用方式為