Controles (referência da API do cliente)

Em aplicações orientadas a modelos, um controlo representa um elemento HTML no formulário. Alguns controlos estão ligados a uma coluna específica, enquanto outros representam controlos não vinculados, como um IFRAME, recurso web ou subgrelha adicionados 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. Controlos de acesso utilizando uma das seguintes coleções:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAtributo.controles

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

Observação

Quando realiza ações em controlos ligados a uma coluna, considere que o controlo pode aparecer na página mais do que uma vez. Geralmente, deve realizar as mesmas ações para cada controlo da coluna. Podes percorrer a coleção de controlos de coluna e realizar as ações em cada controlo.

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

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

Tipo de controlo padrão

Estes métodos estão disponíveis para um controlo padrão.

Method Description
adicionarNotificação Apresenta uma notificação de erro ou recomendação com ações opcionais.
clearNotificação Remove uma notificação do controlo.
getAttribute Retorna a coluna à qual o controle está vinculado.
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getOutputs Devolve um dicionário das propriedades de saída do controlo.
getParent Devolve a secção que contém o controlo.
getVisible Devolve se o controlo é visível.
setDesativado Ativa ou desativa o controlo.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setNotification Mostra uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou esconde o controlo.

Os seguintes métodos para o controlo Standard estão obsoletos: addOnKeyPress, fireOnKeyPress e removeOnKeyPress.

Tipo de controle IFRAME

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

Method Description
getContentWindow Devolve a janela de conteúdo do IFRAME ou recurso web.
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getInitialUrl Devolve a URL padrão configurada para o IFRAME.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getObject Devolve o objeto formulário que representa o IFRAME ou recurso web.
getParent Devolve a secção que contém o controlo.
getSrc Devolve a URL atualmente exibida no IFRAME ou recurso web.
getVisible Devolve se o controlo é visível.
setDesativado Ativa ou desativa o controlo.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setSrc Define a URL para ser exibida no IFRAME ou recurso web.
setVisible Mostra ou esconde o controlo.

Tipo de controlo de Kbsearch (pesquisa na base de conhecimento)

Estes métodos estão disponíveis para o controlo da pesquisa da base de conhecimento.

Method Description
addOnPostSearch Adiciona um gestor de eventos que é executado após a conclusão da pesquisa.
addOnResultOpened Adiciona um gestor de eventos que é executado quando um resultado de pesquisa é aberto.
addOnSelection Adiciona um gestor de eventos que é executado quando um resultado de pesquisa é selecionado.
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getParent Devolve a secção que contém o controlo.
getSearchQuery Devolve o texto usado como critério de pesquisa.
getSelectedResults Devolve o resultado de pesquisa atualmente selecionado.
getTotalResultCount Devolve o número de resultados de pesquisa.
getVisible Devolve se o controlo é visível.
openSearchResult Abre um resultado de pesquisa especificado.
removeOnPostSearch Remove um gestor de eventos para a conclusão da pesquisa.
removeOnResultOpened Remove um gestor de eventos para abrir um resultado de pesquisa.
removeOnSelection Remove um gestor de eventos para selecionar um resultado de pesquisa.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setSearchQuery Define o texto usado como critério de pesquisa.
setVisible Mostra ou esconde o controlo.

Observação

Quando adiciona o controlo de pesquisa da base de conhecimento ao painel social, o nome do controlo é searchwidgetcontrol_notescontrol. Não podes mudar este 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 de pesquisa, combinado com filtros existentes usando AND.
adicionarCustomView Adiciona uma vista ao diálogo de consulta.
adicionarNotificação Apresenta uma notificação de erro ou recomendação com ações opcionais.
addOnLookupTagClick Adiciona um gestor de eventos que é executado quando uma etiqueta de pesquisa é clicada.
addPreSearch Adiciona um gestor de eventos que é executado antes de uma pesquisa de pesquisa.
clearNotificação Remove uma notificação do controlo.
getAttribute Retorna a coluna à qual o controle está vinculado.
getControlType Devolve o tipo do controlo.
getDefaultView Devolve o ID da vista de pesquisa por defeito.
getDisabled Devolve se o controlo está desativado.
getEntityTypes Devolve os tipos de tabela permitidos na pesquisa.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getParent Devolve a secção que contém o controlo.
getVisible Devolve se o controlo é visível.
removeOnLookupTagClick Remove um gestor de eventos para cliques em etiquetas de pesquisa.
removePreSearch Remove um gestor de eventos que é executado antes de uma pesquisa de pesquisa.
setDefaultView Define a vista padrão no diálogo de consulta.
setDesativado Ativa ou desativa o controlo.
setEntityTypes Define os tipos de tabelas permitidos na pesquisa.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setNotification Mostra uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou esconde o controlo.

Opções e tipos de controlo de escolha

As escolhas e os controlos de escolha têm o mesmo conjunto de métodos disponíveis.

Method Description
adicionarNotificação Apresenta uma notificação de erro ou recomendação com ações opcionais.
addOption Adiciona uma opção ao controlo.
clearNotificação Remove uma notificação do controlo.
limparOpções Remove todas as opções do controlo.
getAttribute Retorna a coluna à qual o controle está vinculado.
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getOptions Devolve as opções disponíveis, incluindo a opção em branco e excluindo as opções removidas.
getParent Devolve a secção que contém o controlo.
getVisible Devolve se o controlo é visível.
removeOption Remove uma opção do controlo.
setDesativado Ativa ou desativa o controlo.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setNotification Mostra uma mensagem de erro para indicar que os dados não são válidos.
setVisible Mostra ou esconde o controlo.

Tipo de controlo de forma rápida

Consulte formContext.ui.quickForms para obter informações sobre métodos suportados para esse tipo de controle.

Tipo de controle de subgrade

Consulte Grelhas e subgrelhas para informações sobre métodos suportados para este tipo de controlo.

Tipo de controlo da parede da linha temporal

O controlo da linha temporal apresenta as publicações, atividades e notas numa vista unificada. Esses métodos estão disponíveis para esse tipo de controle.

Method Description
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getParent Devolve a secção que contém o controlo.
getVisible Devolve se o controlo é visível.
atualizar Atualiza os dados exibidos na linha temporal.
setDesativado Ativa ou desativa o controlo.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setVisible Mostra ou esconde o controlo.

Tipo de controle de temporizador

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

Method Description
getControlType Devolve o tipo do controlo.
getDisabled Devolve se o controlo está desativado.
getLabel Devolve a etiqueta do controlo.
getName Devolve o nome do controlo.
getParent Devolve a secção que contém o controlo.
getState Devolve o estado atual do temporizador.
getVisible Devolve se o controlo é visível.
atualizar Atualiza os dados exibidos no temporizador.
setDesativado Ativa ou desativa o controlo.
setFocus Muda o foco para o controlo.
setLabel Muda a etiqueta do controlo.
setVisible Mostra ou esconde o controlo.

Tipo de controle de recursos da Web

Um controle de recurso da Web tem o mesmo conjunto de métodos disponíveis como o controle iframe. Veja o tipo de controlo 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 como o formContext em um formulário principal. Veja Comportamento > dos componentes do formulário API do cliente.

Columns