Xrm.Page.ui quickForms (用戶端參考)
發行︰ 2017年1月
適用於： Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online
Xrm.Page.ui.quickForms 集合提供存取所有快速檢視控制項及其組成控制項的方法，在 Microsoft Dynamics 365 表單上，使用新的表單轉譯引擎 (也稱為「渦輪表單」)。 快速檢視控制項是新增至 Microsoft Dynamics 365 中主要表單的快速檢視表單，可讓您檢視主要表單內相關實體記錄的資訊。 快速檢視控制項的組成控制項中的資料無法編輯。 如需快速檢視控制項和快速檢視表單的詳細資訊，請參閱 TechNet：建立和編輯快速檢視表單
注意
CRM Online 2016 更新 1 和 CRM 2016 Service Pack 1 (內部部署) 已經引進此功能。
只有當您使用 Dynamics 365 中新的表單轉譯引擎時，本主題才適用。 如果您使用 Dynamics 365 中舊有的表單轉譯功能 (也稱為「重新整理表單」)，您可以使用標準控制項物件存取快速檢視控制項及其組成控制項；請參閱 Xrm.Page.ui 控制項 (用戶端參考)。
重要
Dynamics 365 中舊表單的取代公告發佈後，您必須盡快改用新的表單轉譯引擎，如果您使用舊的表單轉譯功能。 由於採用新舊表單轉譯功能存取快速檢視控制項的方式有所差異，因此您必須更新和測試以快速檢視控制項為目標的現有程式碼，並且在您轉換成新的表單轉譯引擎時，使用本主題中所述的方法。 如需取代舊表單轉譯的詳細資訊，請參閱移除舊版表單轉譯選項
本主題內容
quickForms 集合方法
quickForms 物件方法
quickForms 集合方法
quickForms 集合讓您存取表單上的所有快速檢視控制項。quickForms 集合支援 Dynamics 365 中集合的所有標準方法。 請參閱集合 (用戶端參考)
下列範例示範如何擷取 quickForms 集合中的快速檢視控制項執行個體，使用 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get 方法，藉由指定快速檢視控制項執行個體的索引值 (整數) 或名稱 (字串) 做為引數。
quickViewControl = Xrm.Page.ui.quickForms.get(arg)
quickForms 物件方法
quickForms 物件代表快速檢視控制項執行個體。 下列方法為表單上快速檢視控制項執行個體所支援。
getControl
getControlType
getName
getParent
getVisible
標籤方法
isLoaded
重新整理
getControl
取得快速檢視控制項中的組成控制項。
quickViewControl.getControl()
您可以存取組成控制項集合中的單一控制項，藉由傳遞引數做為快速檢視控制項中組成控制項的名稱或索引值。 例如：quickViewControl.getControl("firstname") 或 quickViewControl.getControl(0)
傳回值
類型︰ 如果您使用的方法沒有任何引數，則為物件集合；如果您使用的方法有引數，則為物件。備註
擷取快速檢視控制項中的組成控制項之後，您可以使用組成控制項上支援 Dynamics 365 控制項，且不會修改組成控制項資料的任何方法。 這是因為快速檢視控制項中的組成控制項是唯讀的。 例如，您可以使用：quickViewControl.getControl(0).getAttribute()。如需 Dynamics 365 控制項支援方法的詳細資訊，請參閱 Xrm.Page.ui 控制項 (用戶端參考)重要
51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute 或組成控制項上任何資料相關方法不一定可在主要表單 f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent 上運作，因為它所繫結的快速檢視表單在主要表單載入時，不一定會完整載入。 您必須對快速檢視控制項執行個體使用 isLoaded 方法，幫助您判斷繫結的快速檢視表單是否完整載入。 其他資訊：isLoaded
此外，您使用新的表單轉譯引擎擷取表單上快速檢視控制項中的組成控制項的方式，與舊表單不同。 因此，如果您使用舊表單且快速檢視控制項中的程式碼以組成控制項為目標，則必須更新您的程式碼，當您決定使用 Dynamics 365 中新的表單轉譯引擎時。
getControlType
傳回字串值，將快速檢視控制項分類。
quickViewControl.getControlType()
若是快速檢視控制項，方法會傳回 quickform。
若是快速檢視控制項中的組成控制項，方法會傳回控制項的實際類別。 如需可能傳回值的詳細資訊，請參閱 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType。
getName
傳回指派給快速檢視控制項的名稱。
quickViewControl.getName()
- 傳回值
類型： 字串。 快速檢視控制項的名稱。
getParent
傳回包含控制項之區段物件的參考。
控制項類型： 所有。
quickViewControl.getParent()
- 傳回值
類型：Xrm.Page.ui 區段 (用戶端參考) 物件。
getVisible
傳回表示快速檢視控制項目前是否為可見的值。
注意
如果包含此控制項的區段或索引標籤並非可見，此方法仍然可以傳回 true。 若要確定控制項實際可見，您還需要檢查包含元素的顯示性。
quickViewControl.getVisible()
- 傳回值
類型： 布林。 如果快速檢視控制項為可見則為 True，否則為 false。
標籤方法
使用 getLabel 和 setLabel 方法，取得或變更快速檢視控制項的標籤。
getLabel
傳回快速檢視控制項的標籤。
quickViewControl.getLabel()
- 傳回值
類型： 字串。 快速檢視控制項的標籤。
setLabel
設定快速檢視控制項的標籤。
quickViewControl.setLabel("label")
- 引數
類型： 字串。 快速檢視控制項的新標籤。
isLoaded
傳回快速檢視控制項中組成控制項的資料繫結是否完成。
quickViewControl.isLoaded()
傳回值
類型： 布林。 True 表示組成控制項的資料繫結完成，否則為 false。備註
快速檢視控制項中組成控制項的資料繫結不一定會在主要表單 f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent 期間完成，因為控制項繫結的快速檢視表單可能未完整載入。 因此，在組成控制項上使用 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute 或任何資料相關方法可能無法運作。 快速檢視控制項的 isLoaded 方法有助於判斷快速檢視控制項中組成控制項的資料繫結狀態。
下列範例程式碼示範如何使用 isLoaded 方法檢查繫結狀態，然後擷取快速檢視控制項中組成控制項繫結的屬性的值。
function getAttributeValue() {
var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
if (quickViewControl != undefined)
{
if (quickViewControl.isLoaded())
{
// Access the value of the attribute bound to the constituent control
var myValue = quickViewControl.getControl(0).getAttribute().getValue();
console.log(myValue);
return;
}
else
{
// Wait for some time and check again
setTimeout(getAttributeValue, 10);
}
}
else
{
console.log("No data to display in the quick view control.");
return;
}
}
重新整理
重新整理快速檢視控制項中顯示的資料。
quickViewControl.refresh()
另請參閱
用戶端程式設計參考
表單指令碼快速參考
Xrm.Page.ui (用戶端參考)
Xrm.Page.ui 控制項 (用戶端參考)
撰寫 Microsoft Dynamics 365 表單的程式碼
使用 Xrm.Page 物件模型
Microsoft Dynamics 365
© 2017 Microsoft. 著作權所有，並保留一切權利。 著作權