...
Componente abstrato herdado pelos componentes de criação de janelas LDIALOG e LFRAME. Efetua uma requisição GET
e retorna verdadeiro se a requisição foi efetuada com sucesso.
...
Métodos acessíveis através da função _ADVPL_get_property
que permite recuperar e manipular os valores do componente.
Expandir |
---|
|
Retorna se a janela da aplicação está ativada.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"ACTIVATE") => lIsActive |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | - Referência do componente que está em foco na tela.
| Sim |
Tipo | Descrição |
---|
SMALLINT | Verdadeiro se a janela da aplicação está ativada. |
Bloco de código |
---|
| LET l_active = _ADVPL_get_property(m_form_reference,"ACTIVATE")
|
|
Expandir |
---|
title | GET COMPONENT_FOCUS_REFERENCE |
---|
|
Retorna a referência do componente em foco. |
...
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"COMPONENT_FOCUS_REFERENCE") => cComponentReference |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Referência do componente em foco |
Bloco de código |
---|
| LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_FOCUS_REFERENCE")
|
|
Expandir |
---|
title | GET COMPONENT_REFERENCE_BY_HELP_NAME |
---|
|
Retorna a referência do componente pelo nome do atalho de ajuda (propriedade HELP_NAME).
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >," |
|
...
COMPONENT_REFERENCE_BY_HELP_NAME") => cComponentReference |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Referência do componente correspondente ao HELP_NAME indicado. |
Bloco de código |
---|
| LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_REFERENCE_BY_HELP_NAME")
|
|
Expandir |
---|
title | GET CONTAINER_HEIGHT |
---|
|
Altura da janela da aplicação.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"CONTAINER_HEIGHT") => nHeight |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
INTEGER | Altura do componente LFORM |
Bloco de código |
---|
| LET l_height = _ADVPL_get_property(m_form_reference,"CONTAINER_HEIGHT")
|
|
Expandir |
---|
|
Largura da janela da aplicação.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"CONTAINER_WIDTH") => nWidth |
Nome | Tipo | Descrição | Obrigatório? |
---|
|
...
1 Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}
. Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}
.
Retorno
...
Exemplo
...
title | Exemplo SQLCODE |
---|
linenumbers | true |
---|
...
|
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
INTEGER | Largura do componente LFORM |
Bloco de código |
---|
| LET l_width = _ADVPL_get_property(m_form_reference,"CONTAINER_WIDTH")
|
|
Expandir |
---|
|
Breve informação sobre o formulário.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"FORM_INFO") => cInfo |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Breve informação sobre o formulário. |
Bloco de código |
---|
| LET l_info = _ADVPL_get_property(m_form_reference,"FORM_INFO")
|
|
Expandir |
---|
title | GET FORM_MODIFICATION |
---|
|
Número revisão de modificação do formulário.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION") => nModification |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
INTEGER | Número da revisão de modificação do formulário. |
Bloco de código |
---|
| LET l_modification = _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION")
|
|
Expandir |
---|
|
Nome do formulário.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"FORM_NAME") => cName |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Nome do formulário. |
Bloco de código |
---|
| LET l_name = _ADVPL_get_property(m_form_reference,"FORM_NAME")
|
|
Expandir |
---|
|
Retorna a release do formulário.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"FORM_RELEASE") => cRelease |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Código da release do formulário. |
Bloco de código |
---|
| LET l_release = _ADVPL_get_property(m_form_reference,"FORM_RELEASE")
|
|
Expandir |
---|
|
Retorna a versão do formulário.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"FORM_VERSION") => cVersion |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Código da revisão do formulário. |
Bloco de código |
---|
| LET l_version = _ADVPL_get_property(m_form_reference,"FORM_VERSION")
|
|
Expandir |
---|
|
Retorna a lista de eventos executados na abertura da janela da aplicação.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"INIT_EVENT") => aList |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
ARRAY OF CHAR | Array contendo a lista de funções executadas na abertura da janela. |
Bloco de código |
---|
| LET la_initEvent = _ADVPL_get_property(m_form_reference,"INIT_EVENT")
|
|
Expandir |
---|
|
Método GET: MAIN_FORM_NAMENome do formulário principal em execução.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"MAIN_FORM_NAME") => cName |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
CHAR | Nome do formulário principal em execução. |
Bloco de código |
---|
| LET l_name = _ADVPL_get_property(m_form_reference,"MAIN_FORM_NAME")
|
|
Expandir |
---|
|
Retorna se a janela da aplicação está maximizada.
Bloco de código |
---|
_ADVPL_get_property(< lFormReference >,"MAXIMIZED") => lIsMaximized |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim |
Tipo | Descrição |
---|
BOOLEAN | TRUE se a janela está maximizada |
Bloco de código |
---|
| LET la_initEvent = _ADVPL_get_property(m_form_reference,"MAXIMIZED")
|
|
Expandir |
---|
|
Retorna o título da janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"TITLE") => cTitle |
Tipo | Descrição |
---|
CHAR | Título definido na janela. |
Bloco de código |
---|
| LET l_title = _ADVPL_get_property(m_ |
|
...
...
Métodos SET
Métodos acessíveis através da função _ADVPL_set_property
que permite alterar e manipular os valores do componente:
Expandir |
---|
|
Define o título da janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"ACITVATE", < l_activate >) |
Nome | Tipo | Descrição | Obrigatório? |
---|
l_reference | CHAR | Referência do formulário | Sim | l_activate | SMALLINT | TRUE - Ativa a janela. FALSE - Desativa/Fecha a janela | Sim |
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"ACTIVATE",) |
|
Expandir |
---|
|
Define se a janela (ainda não exibida) abrirá no centro da área de trabalho.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"CENTER", < l_center >) |
Nome | Tipo | Descrição | Obrigatório? |
---|
l_center | SMALLINT | TRUE para centralizar a janela na abertura. FALSE não centraliza a janela na abertura. | Sim |
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"CENTER",TRUE) |
- Este método só tem efeito se a janela não está maximizada.
|
Expandir |
---|
|
Centraliza a janela já aberta na área de trabalho.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"CENTERED", < l_centered >) |
Nome | Tipo | Descrição | Obrigatório? |
---|
l_centered | SMALLINT | Verdadeiro para centralizar a janela, falso para manter na posição definida. | Sim |
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"CENTERED",TRUE) |
- Este método só tem efeito se a janela não está maximizada.
|
Expandir |
---|
|
Remove todas as teclas de atalho disponíveis na janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"CLEAR_HOTKEYS") |
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"CLEAR_HOTKEYS") |
|
Expandir |
---|
title | SET ENABLE_ESC_CLOSE |
---|
|
Habilita/desabilita o encerramento da janela através do botão ESC.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"ENABLE_ESC_CLOSE", < l_enable >) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_enable | SMALLINT | Verdadeiro para habilitar o encerramento da janela através do botão ESC, falso para desabilitar. | Sim |
|
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"ENABLE_ESC_CLOSE",FALSE) |
|
Expandir |
---|
|
Define uma breve informação sobre o formulário.
Bloco de código |
---|
CALL _ADVPL_set_property(< lFormReference >,"FORM_INFO", < cInfo > ) |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim | cInfo | CHAR | Breve informação sobre o formulário. | Sim |
Exemplo
Bloco de código |
---|
| CALL_ADVPL_get_property(m_ |
|
...
...
,"FORM_INFO","Programa de cadastro de Usuários.")
|
|
Expandir |
---|
title | SET FORM_MODIFICATION |
---|
|
Ajusta o número revisão de modificação do formulário.
Bloco de código |
---|
CALL _ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION", < nModification > ) |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim | nModification | INTEGER | Número da modificação do formulário. | Sim |
Exemplo
Bloco de código |
---|
| CALL _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION",48)
|
|
Expandir |
---|
|
Nome do formulário.
Bloco de código |
---|
CALL _ADVPL_set_property(< lFormReference >,"FORM_NAME", < cName > ) |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim | cName | CHAR | Nome do Formulário. | Sim |
Exemplo
Bloco de código |
---|
| CALL _ADVPL_get_property(m_form_reference,"FORM_NAME","log03948")
|
|
Expandir |
---|
|
Ajusta a release do formulário.
Bloco de código |
---|
CALL _ADVPL_set_property(< lFormReference >,"FORM_RELEASE", < cRelease > ) |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim | cRelease | CHAR | Código da release do formulário | Sim |
Bloco de código |
---|
| CALL _ADVPL_get_property(m_form_reference,"FORM_RELEASE", "2305")
|
|
Expandir |
---|
|
Ajusta a versão do formulário.
Bloco de código |
---|
CALL _ADVPL_set_property(< lFormReference >,"FORM_VERSION", < cVersion >) |
Nome | Tipo | Descrição | Obrigatório? |
---|
lFormReference | CHAR | Referência do formulário. | Sim | cVersion | CHAR | Versão do formulário | Sim |
Bloco de código |
---|
| CALL _ADVPL_get_property(m_ |
|
...
...
Observação
- Para recuperar o resultado da requisição, utilize o método RESULT.
- Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.
Expandir |
---|
|
Define uma tecla de atalho para a janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"HOTKEY", < l_hotkey >, [ l_event ], [ l_info ], [ l_component ], [ l_focus ]) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_hotkey | SMALLINT | Código da tecla de atalho. 1 | Sim |
| l_event | CHAR | Função 4GL que será executada na tecla de atalho. 2 | Não |
| l_info | CHAR | Breve descrição da tecla de atalho (utilizada na tela de exibição das teclas de atalho disponíveis na janela). | Não |
| l_component | VARCHAR | Referência do componente FREEFORM para o qual será definida a tecla de atalho. 3 | Não |
| l_focus | SMALLINT | Verdadeiro para limitar a execução da tecla de atalho apenas quando o componente informado estiver focado. | Não |
|
1 As teclas de atalho disponíveis encontram-se no link Teclas de atalhos disponíveis atualmente para formulários Freeform e Metadado. 2 Se não informada a função 4GL, a tecla de atalho será removida da janela. 3 Se informado um componente, a execução da tecla de atalho não será realizada quando este estiver desabilitado ou invisível.
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"HOTKEY",116,"job005_refresh","Atualiza os valores da tela") |
|
Expandir |
---|
|
Adiciona um evento que será executado na ativação da janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"INIT_EVENT", < l_event >) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_event | CHAR | Função 4GL que será executada na ativação da janela. | Sim |
|
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"INIT_EVENT","job0005_init_event") |
|
Expandir |
---|
|
Define um evento que será executado quando o usuário maximizar a janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"MAXIMIZE_EVENT", < l_event >) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_event | CHAR | Função 4GL que será executada quando o usuário maximizar a janela. | Sim |
|
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"MAXIMIZE_EVENT","job0005_maximize_event") |
|
Expandir |
---|
|
Maximiza a janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"MAXIMIZED", < l_maximized >) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_maximized | SMALLINT | Verdadeiro para maximizar a janela, falso para manter o tamanho definido. | Sim |
|
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"MAXIMIZED",TRUE) |
|
Expandir |
---|
|
Define o título da janela.
Bloco de código |
---|
CALL _ADVPL_set_property(< l_reference >,"TITLE", < l_title >) |
Nome | Tipo | Descrição | Obrigatório? | Padrão |
---|
l_title | CHAR | Título que será definido para a janela. | Sim |
|
Bloco de código |
---|
| CALL _ADVPL_set_property(m_form_reference,"TITLE","Manutenção de Pedidos") |
|
Métodos SET
...