Xrm.Page.ui quickForms (referência do cliente)

  • Artigo

 

Publicado: janeiro de 2017

Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

O conjunto Xrm.Page.ui.quickForms fornece métodos para acessar todos os controles de exibição rápida e seus controles de membros nos formulário Microsoft Dynamics 365 ao usar a nova ferramenta de renderização de formulário (também chamada de "formulários turbo"). Um controle de exibição rápida é uma forma rápida de exibição adicionada a um formulário principal no Microsoft Dynamics 365 que permite exibir as informações sobre um registro da entidade relacionado no formulário principal. Os dados nos controles de membro em um controle rápido de exibições não podem ser editados. Para obter mais informações sobre os controles de exibição rápida e formulários de exibição rápida, consulte TechNet: Criar e editar formulários de exibição rápida

Observação

Esse recurso foi apresentado na Atualização 1 do CRM Online 2016 e no CRM 2016 Service Pack 1 (local).

Este tópico apenas será aplicável se você estiver usando os novos mecanismos de renderização de formulários no Dynamics 365. Se estiver usando a renderização de formulário herdada (também chamada de "formulários de atualização") em Dynamics 365, você pode acessar o controle de exibição rápida e seus controles de membro usando o objeto de controle padrão, consulte Controle Xrm.Page.ui (referência do cliente).

Importante

Com o comunicado de substituição herdado nos formulários em Dynamics 365, você deve planejar usar novos formulários que renderizam o mecanismo se estiver usando a renderização herdada do formulário. Como há diferenças entre como você acessa os controles de exibição rápida na renderização herdada e novos formulários, você deve atualizar e testar seu código existente para focar nos controles de exibição rápidos para usar os métodos descritos neste tópico quando você troca para o novo mecanismo de renderização de formulário. Para obter mais informações sobre a substituição da renderização de formulário herdado, consulte Remoção da opção de renderização do formulário do processamento.

Neste tópico

métodos de conjunto de quickForms

métodos de objeto de quickForms

métodos de conjunto de quickForms

A coleção de quickForms oferece acesso a todos os controles de exibição rápida em um formulário. A coleção de quickForms oferece suporte a todos os métodos padrão da coleção em Dynamics 365. Consulte Coleções (referência do cliente)

O exemplo a seguir demonstra como recuperar uma instância de controle de exibição rápida na coleção de quickForms usando o método 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get especificando se o valor do índice (inteiro) ou nome (cadeia) da instância de controle de exibição rápida como o argumento.

quickViewControl = Xrm.Page.ui.quickForms.get(arg)

métodos de objeto de quickForms

Um quickForms objeto representa uma instância de exibição rápida de controle. Os seguintes métodos são compatíveis para instâncias do controle de exibição do formulário.

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • Métodos de rótulo

  • isLoaded

  • refresh

getControl

Obter os controles de membro em um controle de exibição rápida.

quickViewControl.getControl()

Você pode acessar um único controle na coleção dos controles membros passando um argumento com o nome ou o valor de índice do controle membro em um controle de exibição rápida. Por exemplo: quickViewControl.getControl("firstname") ou quickViewControl.getControl(0).

  • Valor de Retorno
    Tipo: Coleção de objeto se usar o método sem qualquer argumento; objeto se usar o método com um argumento.

  • Comentários
    Após recuperar um controle de membro em um controle de exibição rápida, você pode usar qualquer um dos métodos suportados em um controle do Dynamics 365 no controle de membro que não altera os dados de membro de controle. Isso ocorre porque os controles de membro em um controle rápido de exibição são somente leitura. Por exemplo, você pode usar: quickViewControl.getControl(0).getAttribute() Para obter mais informações sobre os métodos suportados em um controle Dynamics 365, consulte Controle Xrm.Page.ui (referência do cliente)

    Importante

    O 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute ou quaisquer métodos relacionados de dados em um controle de membro podem não funcionar no formulário principal de f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent porque o formulário de visualização rápida ao qual ele está vinculado pode não ter sido carregado completamente quando o formulário principal foi baixado. Você deve usar o método isLoaded para a instância rápida de controle de exibição ajudar a determinar se o formulário exibição rápida vinculado carregou por completo. Mais Informações: isLoaded

    Além disso, a forma como você recupera os controles de membro em uma exibição rápida nos formulários usando o novo mecanismo de renderização de formulário é diferente dos formulários herdados. Assim, se você estiver usando formulários herdados e tiver um código que visa os controles de membro em um controle de exibição rápida, atualize o código após decidir usar o novo formulário do mecanismo de processamento Dynamics 365.

getControlType

Retornar um valor da cadeia de caracteres que categoriza controles de exibição rápida.

quickViewControl.getControlType()

Para um controle de exibição rápida, o método retorna quickform.

Para um controle de membro em um controle de exibição rápida, o método retorna a categoria real do controle. Para obter mais informações sobre devoluções de valores possíveis, consulte 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType.

getName

Retorna o nome atribuído ao controle de exibição rápida.

quickViewControl.getName()
  • Valor de Devolução
    Tipo: Cadeia de caracteres. O nome do controle de visualização rápida.

getParent

Retorna uma referência ao objeto da seção que contém o controle.

Tipos de controle: todos.

quickViewControl.getParent()

getVisible

Retorna um valor que indica se o controle de exibição rápida está visível no momento.

Observação

Se a seção ou guia contida para este controle não estiverem visíveis, este método ainda pode retornar true. Para garantir que o controle esteja realmente visível; você também precisará verificar a visibilidade de elementos possíveis.

quickViewControl.getVisible()
  • Valor de Devolução
    Tipo: Booliano.True se o controle de exibição rápida estiver visível. Caso contrário, false.

Métodos de rótulo

Obter ou alterar a etiqueta de um controle de exibição rápida usando os métodos getLabel e setLabel.

getLabel

Retorna a etiqueta do controle de exibição rápida.

quickViewControl.getLabel()
  • Valor de Devolução
    Tipo: Cadeia de caracteres. O rótulo do controle de visualização rápida.

setLabel

Definir a etiqueta do controle de exibição rápida.

quickViewControl.setLabel("label")
  • Argumentos
    Tipo: Cadeia de caracteres. O novo rótulo do controle de visualização rápida.

isLoaded

Retorna se a associação de dados para os controles constitutivos em um controle rápido de exibição for concluída.

quickViewControl.isLoaded()

  • Valor de Devolução
    Tipo: Booliano. A associação é o vínculo de dados para um controle de membro completo, caso não seja, é falsa.

  • Comentários
    A associação de dados para os controles de membro em um controle de exibição rápida pode não ser concluído no formulário principal f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent porque o formulário de visualização rápida ao qual o controle é vinculado pode não ter carregado completamente. Como resultado, usar o 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute ou quaisquer métodos relacionados aos dados em um controle de membro podem não funcionar. O método isLoaded para controle de exibição rápida ajuda a determinar o status de vínculo de dados para controles de membro em um controle de exibição rápida.

O seguinte código de exemplo mostra como usar o método isLoaded para verificar o status de associação, e recupera o valor do atributo para o qual um controle constitutivo em um controle rápido de exibição é associado.

function getAttributeValue() {
    var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
    if (quickViewControl != undefined)
    {
        if (quickViewControl.isLoaded())
        {
            // Access the value of the attribute bound to the constituent control
            var myValue = quickViewControl.getControl(0).getAttribute().getValue();
            console.log(myValue);
            return;
        }
        else
        {
            // Wait for some time and check again
            setTimeout(getAttributeValue, 10);
        }
    }
    else
    {
        console.log("No data to display in the quick view control.");
        return;
    }    
}

refresh

Atualiza os dados exibidos em um controle de exibição rápida.

quickViewControl.refresh()

Confira Também

Referência de programação do cliente
Referência rápida do script de formulário
Xrm.Page.ui (referência do cliente)
Controle Xrm.Page.ui (referência do cliente)
Crie códigos para os formulários do Microsoft Dynamics 365
Use o modelo de objeto Xrm.Page

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais