Xrm.Page.ui (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

Xrm.Page.ui contém propriedades e 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.

Propriedades e métodos Xrm.Page.ui

  • close
    Método para fechar o formulário.

  • controls
    Uma coleção de todos os controles na página.

  • formSelector
    Use o método formSelector.getCurrentItem para recuperar informações sobre o formulário atualmente em uso e a formSelector.items que contém informações sobre todos os formulários disponíveis para o usuário.

  • getCurrentControl
    Método para obter o objeto de controle que possui no foco no formulário.

    Observação

    Este método foi preterido no Pacote Cumulativo de Atualizações 2 do Microsoft Dynamics CRM 2013.

  • getFormType
    Método para obter o contexto do formulário para o registro.

  • navigation.items
    Uma coleção de todos os itens de navegação na página.

  • Notificação de formulário
    Use setFormNotification para exibir as notificações de nível de formulário e clearFormNotification para remover as notificações.

  • quickForms
    Uma coleção de todos os controles de exibição rápida na página.

  • refreshRibbon
    Método para fazer com que a faixa de opções reavalie os dados que controlam o que é exibido nela.

  • tabs
    Uma coleção de todas as guias na página.

  • Métodos ViewPort
    O ViewPort é área da página que contém dados do formulário. Corresponde ao corpo do formulário e não inclui as áreas de ajuda de navegação, cabeçalho, rodapé ou formulário na página. Use os métodos getViewPortHeight e getViewPortWidth para obter o tamanho atual do ViewPort.

close

Método para fechar o formulário.

Xrm.Page.ui.close()

Comentários:

O método Window.close HTML é suprimido. Para fechar a janela do formulário, use este método. Se houver alguma alteração não salva no formulário, o usuário será solicitado se deseja salvar as alterações antes de fechar a janela.

Com o Microsoft Dynamics 365 para Tablets, esse método imita o comportamento do botão de navegação novamente.

controls

Uma coleção de todos os controles na página.

Consulte Coleções (referência do cliente) para obter informações sobre os métodos da coleção e Controle Xrm.Page.ui (referência do cliente) para obter informações sobre objetos de controle na coleção.

formSelector

Use o método formSelector.getCurrentItem para recuperar informações sobre o formulário atualmente em uso e a formSelector.items que contém informações sobre todos os formulários disponíveis para o usuário.

Observação

A coleção formSelectoritems não existe e o método formSelector.getCurrentItem não é suportado para clientes móveis Dynamics 365 (telefones e tablets) e o hub de serviço interativo.

formSelector.getCurrentItem

Método para retornar uma referência ao formulário atualmente sendo exibido.

Observação

Quando apenas um formulário está disponível, este método retornará null.

  • Valor de Retorno
    Tipo:Objeto

formSelector.items

Uma coleção de todos os itens do formulário acessíveis para o usuário atual.

Observação

Somente os formulários que compartilham uma associação com uma das funções de segurança do usuário estão disponíveis neste conjunto.

Consulte Coleções (referência do cliente) para obter informações sobre os métodos da coleção e Item Xrm.Page.ui.formSelector (referência do cliente) para obter informações sobre itens na coleção.

getCurrentControl

Método para obter o objeto de controle que possui no foco no formulário. Os controles de recurso da Web e IFRAME não são retornados por este método.

Observação

Este método foi preterido no Pacote Cumulativo de Atualizações 2 do Microsoft Dynamics CRM 2013.

Este método não retorna uma referência ao controle atual quando último campo editado pelo usuário era um atributo booliano formatado como um botão de opção ou controle da caixa de seleção. Este método também falha ao retornar uma referência logo depois de usar o controle setFocus do método Xrm.Page.ui.

Xrm.Page.ui.getCurrentControl()
  • Valor de Retorno
    Tipo:Objeto

getFormType

Método para obter o contexto do formulário para o registro.

Xrm.Page.ui.getFormType()

  • Valor de Retorno
    Tipo:Número

    A tabela a seguir lista os tipos de formulário que correspondem ao valor de retorno.

    Valor

    Tipo de formulário

    0

    Indefinido

    1

    Criar

    2

    Atualizar

    3

    Somente Leitura

    4

    Desabilitado

    6

    Edição em Massa

    Observação

    Os formulários de Criação Rápida retorna 1 O valor 5 foi usado para um tipo anterior do formulário de criação rápida que foram removidos.

Uma coleção de todos os itens de navegação na página.

Observação

Esta coleção não existe com o Microsoft Dynamics 365 para Tablets.

Consulte Coleções (referência do cliente) para obter informações sobre os métodos da coleção e Item Xrm.Page.ui.navigation (referência do cliente) para obter informações sobre itens na coleção.

Notificação de formulário

Use setFormNotification para exibir as notificações de nível de formulário e clearFormNotification para remover as notificações.

clearFormNotification

Use este método para remover as notificações de nível do formulário.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Parâmetros

    • uniqueId
      Tipo: String. Um identificador exclusivo para a mensagem usado com o setFormNotification para definir a notificação.

  • Valor de Retorno
    Tipo: Booliano. True se o método tiver sucesso, caso contrário, false.

  • Comentários
    Este método está disponível somente para o Entidades atualizadas.

setFormNotification

Use este método para exibir as notificações de nível do formulário. Você pode exibir qualquer número de notificações e elas serão exibidas até serem removidas com o clearFormNotification. A altura da área de notificação é limitada, portanto, cada nova mensagem será adicionada à parte superior. Os usuários podem rolar para baixo para exibir mensagens mais antigas que ainda não foram removidas.

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

  • Parâmetros

    • message
      Tipo: String. O texto da mensagem.

    • level
      Tipo: String. O nível da mensagem.

      O nível define como a mensagem será exibida.

      • ERROR : A notificação usará o ícone de erro do sistema.

      • WARNING : A notificação usará o ícone de aviso do sistema.

      • INFO : A notificação usará o ícone de informação do sistema.

    • uniqueId
      Tipo: String. Um identificador exclusivo para a mensagem usado com o clearFormNotification para remover a notificação.

  • Valor de Retorno
    Tipo: Booliano. True se o método tiver sucesso, caso contrário, false.

  • Comentários
    Este método está disponível somente para o Entidades atualizadas.

quickForms

Uma coleção de todos os controles de exibição rápida em um formulário que usam o novo mecanismo de renderização de formulário (também chamado de "formulários turbo"). Para saber mais sobre os métodos e as propriedades com suporte para esta coleção e estes objetos da coleção, veja Xrm.Page.ui quickForms (referência do cliente)

refreshRibbon

Método para fazer com que a faixa de opções reavalie os dados que controlam o que é exibido nela.

Xrm.Page.ui.refreshRibbon()

  • Valor de Retorno
    Tipo: Nenhum

    Comentários: Essa função é tipicamente usada quando uma faixa de opções <EnableRule> (RibbonDiffXml) depende de um valor no formulário. Depois que seu código alterar um valor que será usado por uma regra, utilize este método para forçar a faixa de opções a reavaliar os dados no formulário para que a regra possa ser aplicada.

tabs

Uma coleção de todas as guias na página.

Consulte Coleções (referência do cliente) para obter informações sobre os métodos da coleção e Guia Xrm.Page.ui (referência do cliente) para obter informações sobre itens na coleção.

Métodos ViewPort

O ViewPort é área da página que contém dados do formulário. Corresponde ao corpo do formulário e não inclui as áreas de ajuda de navegação, cabeçalho, rodapé ou formulário na página. Use os métodos getViewPortHeight e getViewPortWidth para obter o tamanho atual do ViewPort.

Observação

Esses métodos não funcionam com o Microsoft Dynamics 365 para Tablets.

getViewPortHeight

Método para obter a altura da porta de exibição em pixels.

Xrm.Page.ui.getViewPortHeight()
  • Valor de Retorno
    Tipo:Número

getViewPortWidth

Método para obter o comprimento da porta de exibição em pixels.

Xrm.Page.ui.getViewPortWidth()
  • Valor de Retorno
    Tipo:Número

Confira Também

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

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais