Xrm.Page.data.entity (用戶端參考)

文章
07/06/2017

發佈日期： 2016年11月

適用對象： Dynamics CRM 2015

Xrm.Page.data.entity 提供方法擷取頁面上顯示記錄的特定資訊、save 方法，以及表單中的所有屬性集合。屬性資料受限於表單欄位所代表的屬性。

Xrm.Page.data.entity 屬性和方法

屬性
實體的屬性集合。
getDataXml
傳回字串，其代表儲存記錄時要傳送至伺服器的 xml。
getEntityName
傳回字串，表示記錄之屬性邏輯名稱。
getId
傳回字串，代表記的 GUID id 值。
getIsDirty
傳回布林值，指示表單上是否已修改任何欄位。
OnSave
使用 addOnSave 和 removeOnSave 方法新增或移除儲存活動的事件處理常式
getPrimaryAttributeValue
取得實體的主要屬性值的字串。
儲存
儲存完成之後，使用關閉表單或開啟新表單的選項儲存記錄。

屬性

Xrm.Page.data.entity.attributes 集合提供方法，存取表單上顯示記錄的資料。如需此集合的詳細資訊，請參閱集合 (用戶端參考)。如需此集合之物件可用的屬性與方法，請參閱 Xrm.Page.data.entity 屬性 (用戶端參考)。

getDataXml

傳回字串，其代表儲存記錄時要傳送至伺服器的 XML。只有已變更的欄位的資料會傳送至伺服器。

備註

此函數無法與平板電腦專用 Microsoft Dynamics CRM 搭配使用。

Xrm.Page.data.entity.getDataXml()

傳回值
**類型：**字串

**範例：**在此範例中，客戶記錄的下列三個欄位已更新：
- 名稱
- accountnumber
- telephone2
```
"<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425 555-1234</telephone2></account>"
```

getEntityName

傳回字串，表示記錄之屬性邏輯名稱。

Xrm.Page.data.entity.getEntityName()

傳回值
**類型：**字串。實體的名稱。

**範例：**在此範例中，客戶記錄進行編輯。
```
"account"
```

getId

傳回字串，代表記的 GUID id 值。

Xrm.Page.data.entity.getId()

傳回值
**類型：**字串

**範例：**記錄的 GUID Id 值。
```
"{825CB223-A651-DF11-AA8B-00155DBA3804}"
```

getIsDirty

傳回布林值，指示表單上是否已修改任何欄位。

Xrm.Page.data.entity.getIsDirty()

傳回值
**類型：**布林

OnSave

使用 addOnSave 和 removeOnSave 方法新增或移除儲存活動的事件處理常式

addOnSave

新增當記錄儲存時將呼叫的函數。

Xrm.Page.data.entity.addOnSave([function reference])

參數
**類型：**函數參考

**備註：**這個函數會加入至事件處理常式管線底端。執行內容是自動設定為傳遞至事件處理常式 (使用此方法所設定) 的第一個參數。如需詳細資訊，請參閱執行內容 (用戶端參考)。

**範例：**在此範例中，JavaScript 程式庫包含兩個函數。addMessageToOnSave 函數新增至表單 OnLoad 事件，會新增 displayOrgName 函數做為 OnSave 事件的處理常式。
```
function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function addMessageToOnSave() {
    Xrm.Page.data.entity.addOnSave(displayOrgName);
}
```

removeOnSave

移除當記錄儲存時將呼叫的函數。

Xrm.Page.data.entity.removeOnSave([function reference])

參數
**類型：**函數參考

**範例：**在此範例中，JavaScript 程式庫包含兩個函數。removeMessageFromOnSave 函數新增至表單事件，會移除 displayOrgName 函數做為 OnSave 事件的處理常式。

function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function removeMessageFromOnSave() {
    Xrm.Page.data.entity.removeOnSave(displayOrgName);
}

getPrimaryAttributeValue

取得實體的主要屬性值的字串。

Xrm.Page.data.entity.getPrimaryAttributeValue()

每個實體有一個指派為 PrimaryNameAttribute 的字串屬性。當記錄的連結顯示時，使用此屬性的值。

傳回值
**類型：**字串。實體的主要屬性的值。
備註
此方法僅適用於更新的實體。

儲存

儲存完成之後，使用關閉表單或開啟新表單的選項，以同步方式儲存記錄。

Xrm.Page.data.save 和 Xrm.Page.data.entity.save 都會儲存記錄，但是 Xrm.Page.data.save 在儲存作業完成之後提供回呼函數。

Xrm.Page.data.entity.save( null | "saveandclose" |"saveandnew" )

引數
- save()
  如果參數未包含，只是儲存記錄。這相當於使用 [儲存] 命令。
- save("saveandclose")
  這相當於使用 [儲存後關閉] 命令。
- save("saveandnew")
  這相當於使用 [儲存並新增] 命令。

備註
在 Web 應用程式使用快速建立表單時，不套用 saveandnew 選項。其運作方式就如同使用 saveandclose。平板電腦專用 Microsoft Dynamics CRM 中快速建立表單會套用 saveandnew 行為。

另請參閱

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