Xrm.Page.data.entity(客户端引用)

 

发布日期: 2016年11月

适用于: Dynamics CRM 2015

Xrm.Page.data.entity 提供的方法可用于专门检索页面上所显示的记录、保存方法和窗体中包含的所有属性的集合的相关信息。 属性数据仅限于窗体上字段表示的属性。

Xrm.Page.data 实体属性和方法

  • 属性
    实体属性的集合。

  • getDataXml
    返回表示当保存记录时将被发送到服务器的 xml 的字符串。

  • getEntityName
    返回表示记录实体的逻辑名称的字符串。

  • getId
    返回表示记录的 GUID id 值的字符串。

  • getIsDirty
    返回一个指示是否已修改窗体中任何字段的布尔值。

  • OnSave
    使用 addOnSave 和 removeOnSave 方法在保存事件中添加或删除事件处理程序

  • getPrimaryAttributeValue
    获取实体的主要属性值的字符串。

  • 保存
    保存完成后,保存记录和选项以关闭该窗体或打开新窗体。

属性

Xrm.Page.data.entity.attributes 集合提供的方法可用于访问窗体所示记录的数据。 有关此集合的详细信息,请参阅 集合(客户端引用)。 有关可用于此集合中对象的属性和方法,请参阅 Xrm.Page.data. 实体属性(客户端引用)

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.saveXrm.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. 实体属性(客户端引用)
为 Microsoft Dynamics CRM 2015 窗体编写代码
使用 Xrm.Page 对象模型

© 2017 Microsoft。 保留所有权利。 版权