Controles (referência da API do cliente)

Em aplicativos controlados por modelos, um controle representa um elemento HTML no formulário. Alguns controles são associados a uma coluna específica, enquanto outros representam controles não associados, como um IFRAME, um recurso da Web ou uma subgrid adicionado ao formulário.

O objeto de controle fornece métodos para alterar a apresentação ou o comportamento de um controle e identificar a coluna correspondente. Controles de acesso usando uma das seguintes coleções:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

O formContext. O método getControl é um método de atalho para acessar formContext.ui.controls.get.

Observação

Ao executar ações em controles vinculados a uma coluna, considere que o controle pode aparecer na página mais de uma vez. Em geral, você deve executar as mesmas ações para cada controle da coluna. Você pode fazer loop pela coleção de controles de coluna e executar as ações em cada controle.

Os controles são categorizados por tipo. Use o método getControlType para determinar o tipo de um controle. Determinados métodos de controle estão disponíveis apenas para tipos específicos de controles.

Este artigo fornece informações sobre os métodos disponíveis para cada tipo de controle.

Tipo de controle padrão

Esses métodos estão disponíveis para um controle Standard.

Method Description
addNotification Exibe uma notificação de erro ou recomendação com ações opcionais.
clearNotification Remove uma notificação do controle.
getAttribute Retorna a coluna à qual o controle está associado.
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getOutputs Retorna um dicionário das propriedades de saída do controle.
getParent Retorna a seção que contém o controle.
getVisible Retorna se o controle está visível.
setDisabled Habilita ou desabilita o controle.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setNotification Exibe uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou oculta o controle.

Os métodos a seguir para o controle Standard são preteridos: addOnKeyPress, fireOnKeyPress e removeOnKeyPress.

Tipo de controle IFRAME

Esses métodos estão disponíveis para um controle IFRAME.

Method Description
getContentWindow Retorna a janela de conteúdo do IFRAME ou do recurso da Web.
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getInitialUrl Retorna a URL padrão configurada para o IFRAME.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getObject Retorna o objeto de formulário que representa o IFRAME ou o recurso da Web.
getParent Retorna a seção que contém o controle.
getSrc Retorna a URL exibida no momento no IFRAME ou no recurso da Web.
getVisible Retorna se o controle está visível.
setDisabled Habilita ou desabilita o controle.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setSrc Define a URL a ser exibida no IFRAME ou no recurso da Web.
setVisible Mostra ou oculta o controle.

Tipo de controle Kbsearch (pesquisa de base de dados de conhecimento)

Esses métodos estão disponíveis para o controle de pesquisa da base de dados de conhecimento.

Method Description
addOnPostSearch Adiciona um manipulador de eventos que é executado após a conclusão de uma pesquisa.
addOnResultOpened Adiciona um manipulador de eventos que é executado quando um resultado da pesquisa é aberto.
addOnSelection Adiciona um manipulador de eventos que é executado quando um resultado da pesquisa é selecionado.
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getParent Retorna a seção que contém o controle.
getSearchQuery Retorna o texto usado como critério de pesquisa.
getSelectedResults Retorna o resultado da pesquisa selecionado no momento.
getTotalResultCount Retorna o número de resultados da pesquisa.
getVisible Retorna se o controle está visível.
openSearchResult Abre um resultado de pesquisa especificado.
removeOnPostSearch Remove um manipulador de eventos para conclusão da pesquisa.
removeOnResultOpened Remove um manipulador de eventos para abrir um resultado de pesquisa.
removeOnSelection Remove um manipulador de eventos para selecionar um resultado de pesquisa.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setSearchQuery Define o texto usado como critério de pesquisa.
setVisible Mostra ou oculta o controle.

Observação

Quando você adiciona o controle de pesquisa da base de dados de conhecimento ao painel social, o nome do controle é searchwidgetcontrol_notescontrol. Você não pode mudar esse nome.

Tipo de controle de pesquisa

Esses métodos estão disponíveis para um controle de pesquisa.

Method Description
addCustomFilter Adiciona um filtro aos resultados da pesquisa, combinado com filtros existentes usando AND.
addCustomView Adiciona uma exibição à caixa de diálogo de pesquisa.
addNotification Exibe uma notificação de erro ou recomendação com ações opcionais.
addOnLookupTagClick Adiciona um manipulador de eventos que é executado quando uma marca de pesquisa é clicada.
addPreSearch Adiciona um manipulador de eventos que é executado antes de uma pesquisa de pesquisa.
clearNotification Remove uma notificação do controle.
getAttribute Retorna a coluna à qual o controle está associado.
getControlType Retorna o tipo do controle.
getDefaultView Retorna a ID do modo de exibição de pesquisa padrão.
getDisabled Retorna se o controle está desabilitado.
getEntityTypes Retorna os tipos de tabela permitidos na pesquisa.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getParent Retorna a seção que contém o controle.
getVisible Retorna se o controle está visível.
removeOnLookupTagClick Remove um manipulador de eventos para cliques de marca de pesquisa.
removePreSearch Remove um manipulador de eventos que é executado antes de uma pesquisa de pesquisa.
setDefaultView Define o modo de exibição padrão na caixa de diálogo de pesquisa.
setDisabled Habilita ou desabilita o controle.
setEntityTypes Define os tipos de tabela permitidos na pesquisa.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setNotification Exibe uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou oculta o controle.

Opções e tipos de controle de escolha

Opções e controles de escolha têm o mesmo conjunto de métodos disponíveis.

Method Description
addNotification Exibe uma notificação de erro ou recomendação com ações opcionais.
addOption Adiciona uma opção ao controle.
clearNotification Remove uma notificação do controle.
clearOptions Remove todas as opções do controle.
getAttribute Retorna a coluna à qual o controle está associado.
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getOptions Retorna as opções disponíveis, incluindo a opção em branco e excluindo as opções removidas.
getParent Retorna a seção que contém o controle.
getVisible Retorna se o controle está visível.
removeOption Remove uma opção do controle.
setDisabled Habilita ou desabilita o controle.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setNotification Exibe uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou oculta o controle.

Tipo de controle de formulário rápido

Consulte formContext.ui.quickForms para obter informações sobre os métodos compatíveis com esse tipo de controle.

Tipo de controle subgrid

Consulte Grades e subgrids para obter informações sobre os métodos compatíveis com esse tipo de controle.

Tipo de controle de parede da linha do tempo

O controle da linha do tempo apresenta as postagens, as atividades e as anotações em uma exibição unificada. Esses métodos estão disponíveis para esse tipo de controle.

Method Description
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getParent Retorna a seção que contém o controle.
getVisible Retorna se o controle está visível.
atualizar Atualiza os dados exibidos na linha do tempo.
setDisabled Habilita ou desabilita o controle.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setVisible Mostra ou oculta o controle.

Tipo de controle de temporizador

Esses métodos estão disponíveis para o controle de temporizador.

Method Description
getControlType Retorna o tipo do controle.
getDisabled Retorna se o controle está desabilitado.
getLabel Retorna o rótulo do controle.
getName Retorna o nome do controle.
getParent Retorna a seção que contém o controle.
getState Retorna o estado atual do temporizador.
getVisible Retorna se o controle está visível.
atualizar Atualiza os dados exibidos no temporizador.
setDisabled Habilita ou desabilita o controle.
setFocus Move o foco para o controle.
setLabel Altera o rótulo do controle.
setVisible Mostra ou oculta o controle.

Tipo de controle de recurso da Web

Um controle de recurso da Web tem o mesmo conjunto de métodos disponíveis que o controle iframe. Veja o tipo de controle iframe.

Tipo de controle de componente de formulário

Um tipo de controle de componente de formulário tem o mesmo conjunto de métodos disponíveis que o formContext em um formulário principal. Consulte a API do cliente do comportamento > do componente Formulário.

Columns