Use o modelo de objeto Xrm.Page
Publicado: janeiro de 2017
Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Ao gravar scripts de formulário, você interagirá com objetos no namespace Xrm.Page para executar as seguintes ações:
Obter ou definir valores de atributo.
Mostrar e ocultar elementos da interface com o usuário.
Referenciar vários controles por atributo.
Acessar vários formulários por entidade.
Manipular itens de navegação do formulário.
Interagir com o controle de fluxo do processo empresarial.
Para obter mais exemplos, consulte Referência rápida do script de formulário.
Neste tópico
Hierarquia de objetos Xrm.Page
Contexto de execução
Coleções
Descrição de objeto
atributo
contexto
controle
Entidade
formSelector
navegação
processo
Seção
estágio
etapa
guia
Hierarquia de objetos Xrm.Page
Conforme mostrado no diagrama a seguir, o Xrm.Page fornece um contêiner de namespace para três objetos descritos na tabela a seguir:
Objeto |
Descrição |
|---|---|
context |
Fornece métodos para recuperar informações específicas a uma organização, um usuário ou parâmetros que foram informados para o formulário em uma cadeia de caracteres de consulta. |
data |
Permite acesso aos dados de entidade e métodos para gerenciar os dados no formulário, assim como no controle de fluxo de processos empresariais |
ui |
Contém métodos para recuperar informações sobre a interface com o usuário, além de coleções para vários subcomponentes do formulário. |
.jpeg "Modelo de objeto Xrm.Page")
Contexto de execução
Ao registrar uma função para um manipulador de eventos, você tem a opção de informar um objeto de contexto de execução como o primeiro parâmetro para a função. Esse objeto contém métodos que permite gerenciar as variáveis que você deseja compartilhar com outros manipuladores de eventos e com o evento de gravação. Para obter mais informações, consulte Contexto de execução (referência do cliente) e Argumentos do evento salvar (referência do cliente).
Coleções
A tabela a seguir descreve as coleções de modelos de objetos do Xrm.Page. Consulte Coleções (referência do cliente) para obter informações sobre os métodos disponíveis para coleções.
Coleta |
Descrição |
|---|---|
attributes |
A coleção do Xrm.Page.data.entity.attributes oferece acesso a cada atributo da entidade que está disponível no formulário. Somente os atributos que correspondem aos campos adicionados ao formulário estão disponíveis. |
controls |
Três objetos contêm uma coleção de controles:
|
navigation.items |
A coleção de Xrm.Page.ui.navigation.items oferece acesso aos itens de navegação definidos usando a área de navegação do editor de formulários. Com TechNet: Formulários atualizados, os usuários podem navegar por eles usando a barra de comandos. Em TechNet: Formulários clássicos, eles aparecem no lado esquerdo do formulário. |
formSelector.items |
Quando vários formulários são fornecidos para uma entidade, é possível associar cada formulário às funções de segurança. Quando as funções de segurança associadas a um usuário permitem ver mais de um formulário, a coleção de Xrm.Page.ui.formSelector.items oferece acesso a cada definição do formulário disponível para esse usuário. |
tabs |
Você pode organizar cada formulário usando uma ou mais guias. A coleção de Xrm.Page.ui.tabs oferece acesso a cada uma dessas guias. |
sections |
Você pode organizar cada guia do formulário usando uma ou mais seções. A coleção de guias sections oferece acesso a cada uma dessas seções. |
Conjuntos do fluxo do processo empresarial
Conjuntos de estágios e etapas no Xrm.Page.data.process são baseadas na mesma estrutura de coleção, mas também permite adicionar ou remover itens de coleções.
Use o método processo.getStages para acessar a coleção de estágios. Use o método estágio.getSteps para acessar a coleção de etapas.
Descrição de objeto
Cada objeto possui diversos métodos para recuperar dados, obter ou definir propriedades de objetos ou executar ações:
atributo
Cada atributo corresponde a um atributo da entidade que foi adicionado ao formulário como um campo. Geralmente, apenas os atributos da entidade que foram adicionados ao formulário como um campo são disponibilizados. Cada instância de um campo é um controle. Um campo pode ser adicionado a um formulário mais de uma vez, o que cria vários controles que se referem ao mesmo atributo.
Observação
Atributos compostos possuem comportamentos especiais.Para obter mais informações:Scripts de gravação para atributos compostos
Atributos são categorizados por tipo. Você pode determinar o tipo de um atributo usando o método getAttributeType.
Quando todos os atributos compartilharem alguns métodos comuns, determinados métodos só ficam disponíveis para tipos específicos de atributos. Para obter mais informações, consulte Atributo Xrm.Page.data.entity (referência do cliente).
Observação
Informações do tipo de atributo representam o comportamento do atributo no formulário. Não necessariamente corresponde ao tipo de campo definido no aplicativo ou nos tipos de AttributeMetadata. Os atributos de um determinado tipo de campo podem ter comportamentos diferentes, dependendo de como são formatados.
A tabela a seguir lista os valores da cadeia de caracteres do tipo de atributo que devem ser esperados para cada tipo de esquema de atributo e opção de formato.
Tipo de campo do aplicativo |
Opção de formatação |
Tipo de Atributo |
|---|---|---|
Moeda |
NA |
money |
Data e Hora |
Data e hora, data apenas |
datetime |
Número Decimal |
NA |
decimal |
Número de Ponto Flutuante |
NA |
double |
Consulta |
NA |
lookup |
Várias Linhas de Texto |
NA |
memo |
Conjunto de Opções |
NA |
optionset |
Linha Única de Texto |
Email, texto, símbolo de ação, url, telefone |
string |
Linha Única de Texto |
Área de Texto |
memo |
Status |
NA |
optionset |
Razão do Status |
NA |
optionset |
Duas Opções |
Dois botões de opção, caixa de seleção, lista |
boolean |
Número Inteiro |
Nenhum, duração |
integer |
Número Inteiro |
Idioma, fuso horário |
optionset |
contexto
O Xrm.Page.context fornece métodos para recuperar informações específicas a uma organização, um usuário ou parâmetros que foram informados para o formulário em uma cadeia de caracteres de consulta. Para obter mais informações, consulte Contexto do cliente (referência do cliente).
controle
Representa um elemento HTML presente no formulário. Alguns controles estão associados a um atributo específico, enquanto outros podem representar controles desvinculados, como um IFRAME, recurso da Web ou uma subgrade que foi adicionada ao formulário.
Use nomes de controle específicos em seu código para controles de IFrame, de recurso da Web e de subgrade. Esses controles não estão associados a um atributo. Evite incluir nomes de controle específicos no código quando o controle estiver associado a um atributo. Quando vários controles estiverem associados a um atributo, os nomes de controle serão determinados no tempo de execução e poderão variar dependendo de onde o controle está localizado no formulário.
Para a maioria das tarefas relacionadas aos controles associados ao atributo, você acessará os controles usando a coleção de controles de atributo ou através da coleção de controles de uma seção. Em vez de se referir a um controle pelo nome, você receberá uma referência a ele com base no contexto da coleção. Nesse caso, o nome não é importante. Consulte o exemplo encontrado para o atributo controls para ver uma maneira de criar funções para executar ações em todos os controles associados a um atributo específico.
Observação
Atributos compostos possuem comportamentos especiais.Para obter mais informações:Scripts de gravação para atributos compostos.
Observação
Para a maioria do trabalho de desenvolvimento de script fora do Microsoft Dynamics 365, os desenvolvedores podem estar acostumados a referenciar os elementos de página usando o método document.getElementById. Para scripts de formulário do Microsoft Dynamics 365, esse método não tem suporte. É importante reconhecer que o atributo armazena os dados, e o controle é somente a apresentação do atributo no formulário. Para controles associados a atributos, talvez seja necessário ajustar a maneira como você está acostumado a acessar os dados do formulário.
Controles são categorizados por tipo. Você pode determinar o tipo de um controle usando o método 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType. Determinados métodos de controle só estão disponíveis para tipos específicos de controles. Por exemplo, o método 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_addOption só está disponível para os controles que são apresentados como conjuntos de opções. Para obter mais informações, consulte Controle Xrm.Page.ui (referência do cliente).
Entidade
O Xrm.Page.data.entity fornece métodos para recuperar informações específicas ao registro exibido na página, o método save e uma coleção de todos os atributos incluídos no formulário. Consulte Xrm.Page.data.entity (referência do cliente) para obter mais informações.
formSelector
O Xrm.Page.ui.formSelector contém uma coleção de itens que fornece recursos para a consulta dos formulários disponíveis ao usuário atual. Use o método bcf42b09-b672-4f4b-b866-ea7b24cc3ae0#BKMK_navigate para fechar o formulário atual e abrir um diferente. Para obter mais informações, consulte Item Xrm.Page.ui.formSelector (referência do cliente).
navegação
Não contém nenhum método. Oferece acesso aos itens de navegação por meio da coleção de itens.
processo
Contém métodos para recuperar propriedades de um fluxo do processo empresarial.Para obter mais informações:Métodos de processo
Seção
Uma seção contém métodos para gerenciar como ela aparece, além de acessar a guia que contém a seção. Uma seção também fornece acesso aos controles contidos nela por meio de uma coleção de controles.Para obter mais informações:Seção Xrm.Page.ui (referência do cliente)
estágio
Cada processo contém uma coleção de estágios que podem ser acessados usando o método getStages do processo.
Um estágio é o estágio ativo.Para obter mais informações:Estrutura dos fluxos do processo empresarial
etapa
As etapas representam itens individuais de dados coletados durante um estágio. Cada estágio tem um conjunto de etapas que pode ser acessado usando o método getSteps do estágio.Para obter mais informações:Estrutura dos fluxos do processo empresarial
Você pode acessar o controle de etapa no estágio ativo de um controle de fluxo do processo empresarial fazendo referência ao nome de controle com o prefixo especial "header_process_<control name>”. Por exemplo, para ocultar a etapa que representa o atributo purchaseprocess, use o seguinte:
Xrm.Page.getControl("header_process_purchaseprocess").setVisible(false);
guia
Uma guia é um grupo de seções em uma página. Contém métodos para alterar a apresentação da guia. Seções são acessadas na guia por meio da coleção de seções. Para obter mais informações, consulte Guia Xrm.Page.ui (referência do cliente).
Confira Também
Referência rápida do script de formulário
Escrever e depurar scripts para o Dynamics 365 para telefones e tablets
Crie códigos para os formulários do Microsoft Dynamics 365
Scripts de gravação para atributos compostos
Criar scripts para fluxos de processos de negócios
Usar o Javascript com o Microsoft Dynamics 365
Referência de programação do cliente
Referência de programação do cliente
Bibliotecas JavaScript para Microsoft Dynamics 365
Personalizar formulários de entidade
Microsoft Dynamics 365
© 2017 Microsoft. Todos os direitos reservados. Direitos autorais