Xrm.Page.data.entity (referencia del lado del cliente)

  • Article

 

Publicado: noviembre de 2016

Se aplica a: Dynamics CRM 2015

Xrm.Page.data.entity proporciona métodos para recuperar información específica del registro que se muestra en la página, el método y una recopilación de todos los atributos incluidos en el formulario. Los datos del atributo están limitados a los atributos representados por campos en el formulario.

Métodos y propiedades de Xrm.Page.data.entity

  • atributos
    La colección de atributos de la entidad.

  • getDataXml
    Devuelve una cadena que representa el xml que se enviará al servidor cuando se guarde el registro.

  • getEntityName
    Devuelve una cadena que representa el nombre lógico de la entidad para el registro.

  • getId
    Devuelve una cadena que representa el valor de identificador GUID del registro.

  • getIsDirty
    Devuelve un valor booleano que indica si algunos campos del formulario se han editado.

  • OnSave
    Use los métodos addOnSave y removeOnSave para agregar o quitar controladores de eventos para el evento guardar

  • getPrimaryAttributeValue
    Obtiene una cadena para el valor del atributo principal de la entidad.

  • Guardar
    Guarda el registro con las opciones de cerrar el formulario o abrir un nuevo formulario después de completar la operación de guardar.

atributos

La colección Xrm.Page.data.entity.attributes proporciona métodos para tener acceso a los datos para un registro mostrado en el formulario. Para obtener más información acerca de esta colección, vea Colecciones (referencia del lado del cliente). Vea Atributo Xrm.Page.data.entity (referencia de cliente) para las propiedades y métodos disponibles para objetos en esta colección.

getDataXml

Devuelve una cadena que representa el XML que se enviará al servidor cuando se guarde el registro. Solo los datos de los campos que han cambiado se establecen en el servidor.

Nota

Esta función no funciona con Microsoft Dynamics CRM para tabletas.

Xrm.Page.data.entity.getDataXml()

  • Valor devuelto
    Tipo: Cadena

    **Ejemplo:**En este ejemplo, se actualizaron los tres campos siguientes para un registro de cuenta:

    • nombre

    • accountnumber

    • telephone2

    "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425 555-1234</telephone2></account>"

getEntityName

Devuelve una cadena que representa el nombre lógico de la entidad para el registro.

Xrm.Page.data.entity.getEntityName()

  • Valor devuelto
    Tipo: Cadena. El nombre de la entidad.

    Ejemplo: En este ejemplo, se editaba un registro de cuenta.

    "account"

getId

Devuelve una cadena que representa el valor de identificador GUID del registro.

Xrm.Page.data.entity.getId()

  • Valor devuelto
    Tipo: Cadena

    Ejemplo: El valor de identificador GUID del registro.

    "{825CB223-A651-DF11-AA8B-00155DBA3804}"

getIsDirty

Devuelve un valor booleano que indica si algunos campos del formulario se han editado.

Xrm.Page.data.entity.getIsDirty()
  • Valor devuelto
    Tipo: Booleano

OnSave

Use los métodos addOnSave y removeOnSave para agregar o quitar controladores de eventos para el evento guardar

addOnSave

Agrega una característica que se llamará cuando se guarde el registro.

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

  • Parámetro
    Tipo: referencia de función

    Comentarios: La función se agregará al final de la canalización del controlador de eventos. El contexto de ejecución se configura automáticamente para pasarse como el primer parámetro que se pasa al controlador de eventos utilizando este método. Para obtener más información, vea Contexto de ejecución (referencia del lado del cliente).

    Ejemplo: En este ejemplo, la biblioteca JavaScript contiene dos funciones. Al agregar la función addMessageToOnSave al evento de formulario OnLoad se agregará la función displayOrgName como controlador para el evento OnSave.

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

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

removeOnSave

Quita una característica que se llamará cuando se guarde el registro.

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

  • Parámetro
    Tipo: referencia de función

    Ejemplo: En este ejemplo, la biblioteca JavaScript contiene dos funciones. Al agregar la función removeMessageFromOnSave a un evento de formulario, se quitará la función displayOrgName como controlador del evento OnSave.

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

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

getPrimaryAttributeValue

Obtiene una cadena para el valor del atributo principal de la entidad.

Xrm.Page.data.entity.getPrimaryAttributeValue()

Cada entidad tiene un atributo de cadena que está designado como PrimaryNameAttribute. El valor para este atributo se usa cuando se muestran los vínculos al registro.

  • Valor devuelto
    Tipo: Cadena. El valor del atributo principal de la entidad.

  • Comentarios
    Este método solo está disponible para Entidades actualizadas.

Guardar

Guarda el registro sincrónicamente con las opciones de cerrar el formulario o abrir un nuevo formulario después de completar la operación de guardar.

Xrm.Page.data.save y Xrm.Page.data.entity.save guardarán el registro, pero Xrm.Page.data.save ofrece funcionalidades de devolución de llamada después de que se complete la operación de guardar.

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

  • Argumentos

    • save()
      Si no se incluye ningún parámetro el registro simplemente se guardará. Esto es el equivalente a usar el comando Guardar.

    • save("saveandclose")
      Esto es el equivalente a usar el comando Guardar y Cerrar.

    • save("saveandnew")
      Esto es el equivalente a usar el comando Guardar y nuevo.

  • Comentarios
    Cuando usa formularios de creación rápida en la aplicación web, no se aplica la opción saveandnew. Funcionará siempre como si saveandclose se usara. Los formularios de creación rápida de Microsoft Dynamics CRM para tabletas aplicarán el comportamiento de saveandnew.

Ver también

Referencia de programación del lado del cliente
Referencia de scripting de formularios
Atributo Xrm.Page.data.entity (referencia de cliente)
Escriba código para formularios de Microsoft Dynamics CRM 2015
Use el modelo de objeto Xrm.Page

© 2017 Microsoft. Todos los derechos reservados. Copyright