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

 

Publicado: janeiro de 2017

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

O objeto de control fornece métodos para alterar a apresentação ou o comportamento de um controle e identificar o atributo correspondente.

Você acessa controles usando os seguintes conjuntos: Xrm.Page.ui.controls, Xrm.Page.ui Section.controls ou Xrm.Page.data.entity Attribute.controls. O método Xrm.Page.getControl é um método de atalho para acessar Xrm.Page.ui.controls.get.

Os exemplos de sintaxe neste tópico mostram o uso do método Xrm.Page.getControl para acessar um controle. Qual controle depende dos argumentos passados para o método. O parâmetro args para acessar um único controle deve ser o nome do controle ou do índice.

Quando um formulário exibe um controle de fluxo de processo comercial no cabeçalho, os controles adicionais serão adicionados para cada atributo exibido no fluxo de processos de negócios. Esses controles tem um nome semelhante ao seguinte exemplo: header_process_<attribute name>.

Os controles exibidos no cabeçalho do formulário são acessíveis e têm um nome exclusivo como o seguinte: header_<attribute name>.

Para controles associados aos atributos é comum acessar controles através do conjunto Xrm.Page.data.entity Attribute.controls.

Os controles personalizados para clientes móveis do Dynamics 365 (telefones e tablets) dão suporte a todas as propriedades e métodos de controle, exceto os seguintes: Métodos de preenchimento automático, getValue, Métodos ao pressionar teclas e Métodos de controle de pesquisa e eventos.

Com a versão Atualização 1 do Microsoft Dynamics CRM Online 2016 e Microsoft Dynamics CRM 2016 Service Pack 1 (local) release, os métodos a seguir foram suportados para o controle do timer no novo mecanismo de processamento de formulários (também chamado de "formulários turbo): getControlType, getName, getParent, Label métodos, refresh e Visível métodos.

Propriedades e métodos de controle

• Métodos de preenchimento automático
  Configura a experiência de preenchimento automático em controles de texto nos formulários do Dynamics 365. Esses métodos foram introduzidos no Dynamics 365.

• Disabled
  Detecta o estado e habilita ou desabilita controles usando os métodos getDisabled e setDisabled.

• getAttribute
  Obtém o atributo ao qual o controle está associado.

• getControlType
  Obtém informações sobre o tipo de controle.

• getName
  Obtém o nome do controle

• getParent
  Obtém o objeto da seção em que o controle está.

• getValue
  Obtém o valor mais recente de um controle quando usuários digitam um caractere em um campo específico de texto ou numérico. Esse método foi apresentado no Dynamics 365.

• Métodos ao pressionar teclas
  Adiciona, remove ou executa uma função quando o usuário pressionar uma tecla em um controle. Esses métodos foram introduzidos no Dynamics 365.

• Métodos de controle da base de dados de conhecimento
  Esses métodos só estão disponíveis para o controle de pesquisa da base de dados de conhecimento em uma instância do Dynamics 365 cujo recurso de gerenciamento de conhecimento está ativado.

  Para obter mais informações sobre esse controle, consulte Controle de pesquisa da base de dados de conhecimento (referência do cliente).

• Label
  Obtém ou altera a etiqueta de um controle usando os métodos getLabel e setLabel.

• Métodos de controle de pesquisa e eventos
  Controla os resultados exibidos para seleção de um usuário quando ele definir o valor de um controle de pesquisa usando os métodos addCustomFilter, addCustomView, getDefaultView, setDefaultView.

  É possível adicionar ou remover manipuladores de eventos para o Evento PreSearch usando os métodos addPreSearch e removePreSearch.

• Notificação
  Exibe e remove notificações aos usuários sobre um controle usando os métodos setNotification, addNotification e clearNotification.

• Métodos de controle OptionSet
  Modifique as opções exibidas em controles OptionSet usando os métodos addOption, clearOptions, e removeOption.

• ShowTime
  Use setShowTime para especificar se o controle de data deve mostrar a parte de hora da data e getShowTime para determinar se a parte da hora da data está sendo exibida atualmente.

• Métodos de controle de subgrade
  Para organizações que estejam usando o CRM Online 2015 Atualização 1, há novos recursos para trabalhar com controles de subgrade.Para obter mais informações:Objetos e métodos de grade (somente leitura) (referência do cliente)

  Para outras organizações, o método refresh é o único método exclusivo disponível para controles de subgrade. Esse método atualizará os dados exibidos na subgrade.

• Visível
  Determinar quais controles estão visíveis e mostrar ou ocultar usando os métodos getVisible e setVisible.

• Métodos de controle IFRAME e recursos da Web
  Interagir com o recurso da Web e controles do IFRAME usando os métodos getData, setData, getInitialUrl, getObject, setSrc e getSrc.

Métodos de preenchimento automático

Use os métodos showAutoComplete e hideAutoComplete para configurar a experiência de preenchimento automático em controles de texto nos formulários.

Para obter um exemplo de código do JavaScript que demonstra o recurso de preenchimento automático, consulte Amostra: Preenchimento Automático em controles do Dynamics 365

showAutoComplete

Use essa função para mostrar até 10 cadeias de caracteres correspondentes em uma lista suspensa quando os usuários pressionarem teclas para digitar caracteres em um campo de texto específico. Você também pode adicionar um comando personalizado com um ícone na parte inferior da lista suspensa. Ao selecionar um item na lista suspensa, o valor no campo de texto mudará para o item selecionado, a lista suspensa desaparecerá e o Evento OnChange do campo de texto será invocado.

Xrm.Page.getControl(arg).showAutoComplete(object)

• Parâmetro
  Tipo: objeto que define o conjunto de resultados, incluindo results e commands, a ser exibido na lista suspensa de preenchimento automático.

  Comentários: recorra a esse método em uma função que você adicionou usando o método addOnKeyPress que será executado no evento keypress.

  Exemplo: o seguinte exemplo mostra a definição do objeto que será transferido para o método showAutoComplete.

  var resultset = { 
     results: [{ 
           id: <value1>, 
           icon: <url>, 
           fields: [<fieldValue1>]}, 
  
           {...}, 
  
           { 
           id: <valueN>, 
           icon: <url>, 
           fields: [<fieldValue1, fieldValue2,..., fieldValueN>]}],
     commands:{ 
           id: <value>, 
           icon: <url>, 
           label: <value>, 
           action: <function reference> 
     } 
  }
  

hideAutoComplete

Use essa função para ocultar a lista suspensa de preenchimento automático que você configurou para um campo de texto específico.

Xrm.Page.getControl(arg).hideAutoComplete()

Disabled

Use getDisabled e setDisabled para detectar se um controle está desabilitado ou para habilitar ou desabilitar.

Tipos de controle: padrão, pesquisa, optionset.

getDisabled

Retorna se o controle está desabilitado.

Xrm.Page.getControl(arg).getDisabled()

• Valor de Retorno
  Tipo: Booliano. True se o controle estiver desabilitado, caso contrário, false.

setDisabled

Define se o controle está desabilitado.

Xrm.Page.getControl(arg).setDisabled(bool)

• Argumentos
  Tipo: Booliano. True se o controle deve ser desabilitado, caso contrário, False.

getAttribute

Retorna o atributo que o controle está associado.

Tipos de controle: padrão, pesquisa, optionset.

Xrm.Page.getControl(arg).getAttribute()

• Valor de Retorno
  Tipo: Objeto: Um atributo.

Comentários

Os controles constitutivos em um controle de exibição rápida são incluídos na coleção de controles e esses controles têm método getAttribute. Entretanto, o atributo não faz parte do conjunto de atributos da entidade. Embora você possa recuperar o valor do atributo usando getValue e até mesmo alterar o valor usando setValue, as alterações realizadas não serão salvas com a entidade.

Os seguintes códigos mostram o uso do valor do atributo mobilephone de contato quando exibidos em um formulário de entidade de conta usando um controle de exibição rápida chamado contactQuickForm. Este código oculta o controle quando o valor do atributo for null.

var quickViewMobilePhoneControl = Xrm.Page.getControl("contactQuickForm_contactQuickForm_contact_mobilephone");
 if (quickViewMobilePhoneControl.getAttribute().getValue() == null)
 {
  quickViewMobilePhoneControl.setVisible(false);
 }

getControlType

Retorna um valor que categoriza controles.

Tipos de controle: todos.

Xrm.Page.getControl(arg).getControlType()

• Valor de Retorno
  Tipo: Cadeia de caracteres

  Possíveis valores de retorno do getControlType:

  Valor de Retorno	Descrição
  standard	Um controle padrão.
  iframe	Um controle do IFRAME.
  lookup	Um controle de pesquisa.
  optionset	Um controle conjunto de opções.
  subgrid	Um controle de subgrade.
  webresource	Um controle de recurso da Web.
  notes	Um controle de anotações.
  timercontrol	Um controle de timer.
  kbsearch	Um controle de pesquisa da base de dados de conhecimento.
  customcontrol: <namespace>.<name>	Um controle personalizado para clientes móveis (telefones e tablets) do Dynamics 365.
  customsubgrid:<namespace>.<name>	Um conjunto de dados personalizado para clientes móveis (telefones e tablets) do Dynamics 365

getName

Retorna o nome atribuído ao controle.

Tipos de controle: todos.

Xrm.Page.getControl(arg).getName()

• Valor de Retorno
  Tipo: Cadeia de caracteres. O nome do controle.

getParent

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

Tipos de controle: todos.

Xrm.Page.getControl(arg).getParent()

• Valor de Retorno
  Tipo:Seção Xrm.Page.ui (referência do cliente) objeto.

getValue

Obtém o valor mais recente em um controle quando o usuário digitar caracteres em um campo específico de texto ou numérico. Esse método ajuda a criar experiências interativas validando dados e alertando usuários quando eles digitarem caracteres em um controle.

O método getValue é diferente do método de atributo getValue, pois o método de controle recupera o valor do controle quando o usuário estiver digitando no controle, ao contrário do método de atributo getValue que recupera o valor após o usuário fechar (salvar) o campo.

Para obter um exemplo de código do JavaScript que usa o método getValue para configurar a experiência de preenchimento automático, consulte Amostra: Preenchimento Automático em controles do Dynamics 365.

Xrm.Page.getControl(arg).getValue()

• Valor de Retorno
  Tipo: Cadeia de caracteres. O valor de dados mais recente de um controle

Métodos ao pressionar teclas

Use os métodos addOnKeyPress, removeOnKeyPress e fireOnKeyPress para fornecer comentários instantâneos ou adotar medidas quando um usuário digitar em um controle. Esses métodos permitem que você realize validações de dados em um controle mesmo após o usuário fechar (salvar) o valor em um formulário.

addOnKeyPress

Use essa opção para adicionar uma função como um manipulador de eventos para o evento de teclas, de forma que a função seja chamada quando você digitar um caractere no campo de texto ou numérico específico.

Para obter um exemplo de código do JavaScript que usa o método addOnKeyPress para configurar a experiência de preenchimento automático, consulte Amostra: Preenchimento Automático em controles do Dynamics 365.

Xrm.Page.getControl(arg).addOnKeyPress([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 é automaticamente definido para ser transferido como o primeiro parâmetro passado para o manipulador de eventos definido com esse método.Para obter mais informações:Contexto de execução (referência do cliente)

  É necessário usar referência para uma função nomeada em vez de uma função anônima se você quiser posteriormente remover o manipulador de eventos do campo.

removeOnKeyPress

Use essa opção para remover um manipulador de eventos de um campo de texto ou numérico que você adicionou usando o addOnKeyPress.

Xrm.Page.getControl(arg).removeOnKeyPress([function reference])

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

  Comentários: se uma função anônima é definida usando o método addOnKeyPress, ela não poderá ser removida usando esse método.

fireOnKeyPress

Use essa opção para acionar manualmente um manipulador de eventos que você criou para um campo de texto ou numérico específico, a ser executado no evento de keypress.

Xrm.Page.getControl(arg).fireOnKeyPress()

Métodos de controle da base de dados de conhecimento

Esses métodos só estão disponíveis para o controle de pesquisa da base de dados de conhecimento, o qual é disponibilizado quando o recurso de gerenciamento de conhecimento da organização do Dynamics 365 está ativado. Para obter mais informações sobre esses controles, consulte Controle de pesquisa da base de dados de conhecimento (referência do cliente).

Label

Obter ou alterar a etiqueta de um controle usando os métodos getLabel e setLabel.

Tipos de controle: todos.

getLabel

Retorna a etiqueta do controle.

Xrm.Page.getControl(arg).getLabel()

• Valor de Retorno
  Tipo: Cadeia de caracteres. A etiqueta do controle.

setLabel

Define a etiqueta do controle.

Xrm.Page.getControl(arg).setLabel(label)

• Argumentos
  Tipo: Cadeia de caracteres. A nova etiqueta do controle.

Métodos de controle de pesquisa e eventos

Controlar os resultados exibidos para um usuário selecionar quando definir o valor de um controle de pesquisa usando os métodos addCustomFilter, addCustomView, getDefaultView e setDefaultView. O controle Lookup também expõe o Evento PreSearch para poder adicionar de forma programática manipuladores de eventos que usam os métodos addPreSearch e removePreSearch.

Tipos de controle: pesquisa.

addCustomFilter

Use para adicionar mais filtros aos resultados exibidos na pesquisa. Cada filtro será combinados com os filtros adicionados anteriormente como uma condição “AND”.

Xrm.Page.getControl(arg).addCustomFilter(filter, entityLogicaName)

• Argumentos

  • filterXml
    Tipo: Cadeia de caracteres : O elemento de filtro fetchXml a aplicar. Por exemplo:

    <filter type="and">
     <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter>
    

  • entityLogicalName
    Tipo: Cadeia de caracteres: (Opcional) Se estiver definido, o filtro será aplicado apenas para esse tipo de entidade. Caso contrário, será aplicado a todos os tipos de entidade retornadas.

• Comentários
  Para obter mais informações:FetchXML schema.

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

  Esse método pode ser usado apenas em uma função em um manipulador de eventos para o Evento PreSearch de controle de pesquisa.

  A seguinte amostra de código é para a pesquisa do formulário de oportunidade Conta (parentaccountid). Quando a função Sdk.setParentAccountIdFilter é definida no manipulador de eventos do formulário Onload, a função Sdk.filterCustomAccounts é adicionada ao evento PreSearch para essa pesquisa. O resultado é que apenas contas com o valor de Categoria (accountcategorycode) de Cliente Preferencial (1) serão retornadas.

  var Sdk = window.Sdk || {};
  
  Sdk.filterCustomerAccounts = function () {
      //Only show accounts with the type 'Preferred Customer'
      var customerAccountFilter = "<filter type='and'><condition attribute='accountcategorycode' operator='eq' value='1'/></filter>";
      Xrm.Page.getControl("parentaccountid").addCustomFilter(customerAccountFilter, "account");
  }
  //set 'Sdk.setParentAccountIdFilter' in the Opportunity form onload event handler
  Sdk.setParentAccountIdFilter = function () {
      Xrm.Page.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
  }
  

addCustomView

Adiciona uma nova exibição para a caixa de diálogo de pesquisa.

Xrm.Page.getControl(arg).addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault)

• Argumentos

  • viewId
    Tipo: Cadeia de caracteres: A representação da cadeia de caracteres de um GUID para uma exibição.

    Observação

    Esse valor nunca é salvo e só precisa ser exclusivo entre as outras exibições disponíveis para a pesquisa. Uma cadeia de caracteres para um GUID não válido funcionará, por exemplo, “{00000000-0000-0000-0000-000000000001}”. É recomendável usar uma ferramenta como guidgen.exe para gerar um GUID válido. A ferramenta guidgen.exe é incluída no SDK do Windows.

  • entityName
    Tipo: Cadeia de caracteres: O nome da entidade.

  • viewDisplayName
    Tipo: Cadeia de caracteres: O nome da exibição.

  • fetchXml
    Cadeia de caracteres: A consulta fetchXml para a exibição.

  • layoutXml
    Tipo: Cadeia de caracteres: O XML que define o layout da exibição.

  • isdefault
    Tipo: Booliano: Se a exibição deve ser a exibição padrão.

• Comentários
  Este método não funciona com pesquisas de Proprietário. As pesquisas do proprietário são usadas para atribuir registros de propriedade do usuário.

DefaultView

Você pode detectar que a exibição é a exibição padrão a ser exibida para permitir que os usuários selecionem os registros em uma pesquisa e alterem a exibição padrão com o getDefaultView e setDefaultView.

getDefaultView

Retorna o valor de ID da exibição de diálogo de pesquisa padrão.

Xrm.Page.getControl(arg).getDefaultView()

• Valor de Retorno
  Tipo: Cadeia de caracteres. O valor da ID da exibição padrão.

setDefaultView

Define a exibição padrão da caixa de diálogo de controle de pesquisa.

Xrm.Page.getControl(arg).setDefaultView(viewGuid)

• Argumentos
  Tipo: Cadeia de caracteres. A ID da exibição a ser definida como exibição padrão.

Exemplo: essa função do setDefaultViewSample definirá a exibição padrão da pesquisa do contato principal do formulário de entidade account para a exibição de Meus Contatos Ativos.

function setDefaultViewSample() {
    Xrm.Page.getControl("primarycontactid").setDefaultView("{00000000-0000-0000-00AA-000010001003}");
}​

Evento PreSearch

É possível adicionar ou remover manipuladores de eventos para o Evento PreSearch de controle de pesquisa usando os métodos addPreSearch e removePreSearch.

Usar o evento PreSearch para controlar os resultados exibidos para o controle usando os dados do formulário atual conforme o usuário estiver começando a pesquisar registros.

Esses métodos têm Contexto de execução (referência do cliente) passado como o primeiro parâmetro.

addPreSearch

Use este método para aplicar alterações nas pesquisas com base nos valores atuais assim como o usuário está prestes a exibir os resultados da pesquisa.

Xrm.Page.getControl(arg).addPreSearch(handler)

• Argumentos
  Tipo: Função para adicionar.

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

O argumento é uma função executada imediatamente antes da pesquisa para fornecer resultados quando uma pesquisa ocorre. Você pode usar o manipulador para chamar uma das outras funções de controle de pesquisa e melhorar os resultados para que sejam exibidos na pesquisa.

removePreSearch

Usar este método para remover as funções do manipulador de eventos que foram definidas anteriormente para o evento PreSearch.

Xrm.Page.getControl(arg).removePreSearch(handler)

• Argumentos
  Tipo: Função para remover.

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

Notificação

Use estes métodos para exibir e limpar notificações para um controle.

setNotification

Exibe uma mensagem de erro para o controle para indicar que os dados não são válidos. Quando este método for usado , um ícone “X” vermelho será exibido ao lado do controle. Nos clientes móveis do Dynamics 365, toque no ícone para exibir a mensagem.

Xrm.Page.getControl(arg).setNotification(message,uniqueId)

Comentários

A definição de uma notificação de erro em um controle bloqueará o salvamento do formulário.

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

Argumentos

• mensagem
  Tipo: Cadeia de caracteres: A mensagem será exibida.

• uniqueId
  Tipo: Cadeia de caracteres: A ID para ser usada para desmarcar apenas essa mensagem ao usar clearNotification. Opcional.

Valor de Retorno

Tipo: Booliano: Indica se o método teve sucesso.

addNotification

Exibe uma notificação de erro ou de recomendação para um controle e permite que você especifique ações a serem executadas com base na notificação. Quando você especifica um tipo de erro de notificação, um "X" vermelho aparece ao lado do controle. Quando você especifica um tipo de notificação de recomendação, um ícone "i" aparece ao lado do controle. Nos clientes móveis do Dynamics 365, tocar no ícone exibirá a mensagem e permitirá que você execute a ação configurada ao clicar no botão Aplicar ou ignorar a mensagem.

Xrm.Page.getControl(arg).addNotification(object)

Comentários

A definição de uma notificação de erro em um controle bloqueia o salvamento do formulário; a definição de uma notificação de recomendação não bloqueia o salvamento do formulário.

Este método foi introduzido no Atualização de dezembro de 2016 para Dynamics 365 (online e local) e só está disponível para Entidades atualizadas.

Argumentos

O método aceita um objeto com os seguintes atributos:

Atributo	Tipo de dados	Obrigatório	Descrição
messages	Matriz	Sim	A mensagem a ser exibida na notificação. Na versão atual, somente a primeira mensagem especificada nesta matriz será exibida. A cadeia de caracteres especificada aqui aparecerá como um texto em negrito na notificação e é normalmente usada para o título ou o assunto da notificação. Você deve limitar sua mensagem a 50 caracteres para obter uma experiência do usuário ideal.
notificationLevel	Cadeia de caracteres	Não	Define o tipo de notificação. Os valores válidos são ERROR ou RECOMMENDATION. Se você não especificar esse atributo na definição do objeto, ele será definido como ERROR por padrão.
uniqueId	Cadeia de caracteres	Não	A ID a ser usada para limpar essa notificação quando você estiver usando clearNotification.
actions	Matriz de objetos	Não	Uma coleção de objetos com os seguintes atributos: message: Cadeia de caracteres. A mensagem secundária ou do corpo da notificação a ser exibida para o usuário. Limite sua mensagem a 100 caracteres para obter uma experiência do usuário ideal. actions: Matriz. As ações correspondentes para a mensagem. Na versão atual, somente a mensagem de corpo única e a ação correspondente têm suporte. Entretanto, é possível definir várias tarefas a serem realizadas usando código JavaScript no bloco de ações.

Valor de Retorno

Tipo: Booliano: Indica se o método teve sucesso.

Exemplo

O código de exemplo a seguir exibe uma notificação no campo Nome da Conta do formulário da conta para definir o Símbolo de Ação caso o campo Nome da Conta contenha "Microsoft". Clicar em Aplicar na notificação definirá o campo Símbolo de Ação como "MSFT".

function addTickerSymbolRecommendation() {
    var myControl = Xrm.Page.getControl('name');
    var accountName = Xrm.Page.data.entity.attributes.get('name');
    var tickerSymbol = Xrm.Page.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue('Microsoft') && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

clearNotification

Remove uma mensagem já exibida para um controle.

Xrm.Page.getControl(arg).clearNotification(uniqueId)

Argumentos

• uniqueId
  Tipo: Cadeia de caracteres: a ID a ser usada para limpar um conjunto de mensagens específico usando setNotification ou addNotification.

  Se o parâmetro uniqueId não for especificado, a notificação atual mostrada será removida.

Comentários

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

Valor de Retorno

Tipo: Booliano: Indica se o método teve sucesso.

Métodos de controle OptionSet

Usa os métodos addOption, clearOptions e removeOption para manipular opções disponíveis para controles OptionSet.

addOption

Adiciona uma opção para um controle de definição de opção.

Xrm.Page.getControl(arg).addOption(option, [index])

• Argumentos

  • option
    Tipo: Objeto: Um objeto de opções a ser adicionado ao OptionSet.

  • index
    Tipo: Número: (Opcional) A posição do índice para colocar a nova opção. Se não for fornecido, a opção será adicionada ao final.

clearOptions

Limpa todas as opções de um controle Conjunto de Opções.

Xrm.Page.getControl(arg).clearOptions()

removeOption

Remove uma opção de um controle conjunto de opções.

Xrm.Page.getControl(arg).removeOption(number)

• Argumentos
  Tipo: Número: O valor da opção que você deseja remover.

setFocus

Define o foco para o controle.

Xrm.Page.getControl(arg).setFocus()

ShowTime

Use setShowTime para especificar se o controle de data deve mostrar a parte de hora da data e use getShowTime para determinar se a parte da hora da data está sendo exibida atualmente.

getShowTime

Veja se um controle de data mostra a parte da hora da data.

Tipos de Controle: controle padrão para os atributos datetime.

var showsTime = Xrm.Page.getControl(arg).getShowTime();

Comentários

Esse método foi introduzido no Atualização 1 do Microsoft Dynamics CRM Online 2015.

setShowTime

Especificar se um controle de data deve mostrar a parte de hora da data.

Tipos de Controle: controle padrão para os atributos datetime.

Xrm.Page.getControl(arg).setShowTime(bool)

Comentários

Este método está disponível somente para o Entidades atualizadas. Esse método mostrará ou ocultará o componente de hora de um controle de data onde o atributo usar o formato DateAndTime. Esse método não terá efeito quando o formato DateOnly for usado.

Métodos de controle de subgrade

Para versões anteriores ao Atualização 1 do Microsoft Dynamics CRM Online 2015, o único método disponível para um controle de subgrade é refresh. Com o CRM Online 2015 Atualização 1, há recursos novos que você pode usar.Para obter mais informações:Objetos e métodos de grade (somente leitura) (referência do cliente)

refresh

Atualiza os dados exibidos em uma subgrade.

Xrm.Page.getControl(arg).refresh()

Visível

Determina quais controles estão visíveis e os mostra ou oculta usando os métodos getVisible e setVisible.

getVisible

Retorna um valor que indica se o controle está visível no momento.

Xrm.Page.getControl(arg).getVisible()

• Valor de Retorno
  Tipo: Booliano.True se o controle estiver visível. Caso contrário, false.

setVisible

Define um valor que indica se o controle está visível.

Xrm.Page.getControl(arg).setVisible(bool)

• Argumentos
  Tipo: Booliano.True se o controle deve ser visível. Caso contrário, false.

Métodos de controle IFRAME e recursos da Web

Use esses métodos para interagir com o recurso da Web e controles do IFRAME.

Dados

Recursos da Web têm um parâmetro de cadeia de caracteres de consulta especial chamado data para passar dados personalizados. Os métodos getData e setData funcionam somente para recursos da Web Silverlight adicionados a um formulário.Para obter mais informações:Transmitindo dados de um formulário para um recurso da Web do Silverlight integrado

Para recursos da Web (HTML) da página da Web, o parâmetro de dados pode ser extraído do método ou conjunto getSrc usando o método setSrc.

getData

Retorna o valor do parâmetro de cadeia de caracteres de consulta de dados passado para um recurso da Web Silverlight.

Xrm.Page.getControl(arg).getData()

• Valor de Retorno
  Tipo: Cadeia de caracteres. O valor de dados passado para o recurso da Web Silverlight.

setData

Define o valor do parâmetro de cadeia de caracteres de consulta de dados passado para um recurso da Web Silverlight.

Xrm.Page.getControl(arg).setData(string)

• Argumentos
  Tipo: Cadeia de caracteres. O valor de dados para passar ao recurso da Web Silverlight.

getInitialUrl

Retorna a URL padrão que um controle IFRAME está configurado para exibir. Este método não está disponível para recursos da Web.

Xrm.Page.getControl(arg).getInitialUrl()

• Valor de Retorno
  Tipo: Cadeia de caracteres. A URL inicial.

getObject

Retorna o objeto no formulário que representa o recurso da Web ou um I-frame.

Xrm.Page.getControl(arg).getObject()

• Valor de Retorno
  Tipo: Objeto. Qual objeto depende do tipo de controle.

  Um IFRAME retorna o elemento IFrame do Modelo de Objeto de Documento (DOM).

  Um recurso da Web Silverlight retornará o elemento Object do DOM que representa o plug-in Silverlight integrado.

Src

IFRAMEs e recursos da Web têm uma propriedade src para definir o que exibir na janela integrada. Você pode obter ou alterar a propriedade src usando os métodos getSrc e setSrc.

getSrc

Retorna a URL atual que está sendo exibida em um IFRAME ou um recurso da Web.

Xrm.Page.getControl(arg).getSrc()

• Valor de Retorno
  Tipo: Cadeia de caracteres. Uma URL representando a propriedade src do IFRAME ou recurso Web.

setSrc

Define a URL a ser exibida em um IFRAME ou um recurso da Web.

Xrm.Page.getControl(arg).setSrc(string)

• Argumentos
  Tipo: Cadeia de caracteres: A URL.

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)
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