Xrm.Page.data.entity (referência do cliente)

Artigo
07/06/2017

Publicado: novembro de 2016

Aplicável a: Dynamics CRM 2015

O Xrm.Page.data.entity fornece métodos para recuperar informações específicas ao registro exibido na página, o método e uma coleção de todos os atributos incluídos no formulário. Os dados do atributo estão limitados a atributos representados por campos no formulário.

Propriedades e métodos do Xrm.Page.data.entity

atributos
A coleção de atributos da entidade.
getDataXml
Retorna uma cadeia de caracteres que representa o xml que será enviado ao servidor quando o registro for salvo.
getEntityName
Retorna uma cadeia de caracteres que representa o nome da entidade para o registro.
getId
Retorna uma cadeia de caracteres que representa o valor de ID de GUID para o registro.
getIsDirty
Retorna um valor booliano que indique se algum campo no formulário for alterado.
OnSave
Use os métodos addOnSave e removeOnSave para adicionar ou remover manipuladores de eventos para salvar ao evento
getPrimaryAttributeValue
Obtém uma cadeia de caracteres para o valor do atributo principal da entidade.
Salvar
Salva o registro com as opções para fechar o formulário ou abrir um novo formulário após o salvamento ser concluído.

atributos

O conjunto Xrm.Page.data.entity.attributes fornece métodos para acessar os dados de um registro exibido no formulário. Para obter mais informações sobre este conjunto, consulte Coleções (referência do cliente). Consulte Atributo Xrm.Page.data.entity (referência do cliente) para propriedades e métodos disponíveis para objetos nesta coleção.

getDataXml

Retorna uma cadeia de caracteres que representa o XML que será enviado ao servidor quando o registro for salvo. Somente os dados em campos que foram alterados são definidos no servidor.

Observação

Essa função não funciona com o Microsoft Dynamics CRM para Tablets.

Xrm.Page.data.entity.getDataXml()

Valor de Retorno
Tipo: Cadeia de caracteres

Exemplo: Neste exemplo, os seguintes três campos de um registro de conta foram atualizados:
- nome
- accountnumber
- telephone2
```
"<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425 555-1234</telephone2></account>"
```

getEntityName

Retorna uma cadeia de caracteres que representa o nome da entidade para o registro.

Xrm.Page.data.entity.getEntityName()

Valor de Retorno
Tipo: Cadeia de caracteres. O nome da entidade.

Exemplo: Neste exemplo, um registro de conta foi editado.
```
"account"
```

getId

Retorna uma cadeia de caracteres que representa o valor de ID de GUID para o registro.

Xrm.Page.data.entity.getId()

Valor de Retorno
Tipo: Cadeia de caracteres

Exemplo: O valor de ID do GUID para o registro.
```
"{825CB223-A651-DF11-AA8B-00155DBA3804}"
```

getIsDirty

Retorna um valor booliano que indique se algum campo no formulário for alterado.

Xrm.Page.data.entity.getIsDirty()

Valor de Retorno
Tipo: Booleano

OnSave

Use os métodos addOnSave e removeOnSave para adicionar ou remover manipuladores de eventos para salvar ao evento

addOnSave

Adiciona uma função a ser chamada quando o registro é salvo.

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

Parâmetro
Tipo: referência de função

Comentários: A função será adicionada à parte inferior do pipeline do manipulador de eventos. O contexto de execução é definido automaticamente definido para ser transferido como o primeiro parâmetro passado para manipuladores de eventos definidos usando este método. Consulte Contexto de execução (referência do cliente) para obter mais informações.

Exemplo: Neste exemplo, a biblioteca JavaScript contém duas funções. Adicionando a função addMessageToOnSave para o evento OnLoad do formulário adicionará a função displayOrgName como um manipulador para o evento OnSave.
```
function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

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

removeOnSave

Remove uma função a ser chamada quando o registro é salvo.

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

Parâmetro
Tipo: referência de função

Exemplo: Neste exemplo, a biblioteca JavaScript contém duas funções. Adicionar a função removeMessageFromOnSave para um evento de formulário removerá a função displayOrgName como um manipulador para o evento OnSave.

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

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

getPrimaryAttributeValue

Obtém uma cadeia de caracteres para o valor do atributo principal da entidade.

Xrm.Page.data.entity.getPrimaryAttributeValue()

Cada entidade tem um atributo de cadeia de caracteres que é designado como PrimaryNameAttribute. O valor do atributo é usado quando os vínculos do registro são exibidos.

Valor de Retorno
Tipo: Cadeia de caracteres. O valor do atributo principal da entidade.
Comentários
Este método está disponível somente para o Entidades atualizadas.

Salvar

Salva o registro sincronizadamente com as opções para fechar o formulário ou abrir um novo formulário após o salvamento ser concluído.

Xrm.Page.data.save e Xrm.Page.data.entity.save salvarão o registro, mas Xrm.Page.data.save oferece funções de retorno de chamada depois de concluir a operação de salvar.

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

Argumentos
- save()
  Se nenhum parâmetro está incluído, somente o registro será salvo. Isso é equivalente ao uso do comando Salvar.
- save("saveandclose")
  Isso é equivalente ao uso do comando Salvar e Fechar.
- save("saveandnew")
  Isso é equivalente ao uso do comando Salvar e Novo.

Comentários
Ao usar formulários de criação rápida no aplicativo Web, a opção saveandnew não é aplicada. Funcionará sempre se saveandclose for usado. Formulários de criação rápida no Microsoft Dynamics CRM para Tablets aplicarão o comportamento saveandnew.

Confira Também

Referência de programação do cliente
Referência rápida do script de formulário
Atributo Xrm.Page.data.entity (referência do cliente)
Criar códigos para os formulários do Microsoft Dynamics CRM 2015
Use o modelo de objeto Xrm.Page