Pagetitle

	LGX - LFORM
	LGX - LFORM

Componente abstrato herdado pelos componentes de criação de janelas LDIALOG e LFRAME.

Hierarquia

LCOMPONENT
- LCONTAINER
  - LFORM

Métodos GET

Efetua uma requisição GET e retorna verdadeiro se a requisição foi efetuada com sucesso.

Expandir

title	GET GET

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"GET", < l_path >, [ l_headers ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
l_path	`CHAR`	Caminho do serviço REST para requisição.	Sim
`l_headers`	`CHAR`	Lista de cabeçalhos específicos da requisição.¹	Não

¹ Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}. Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}.

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a requisição foi efetuada com sucesso.

Exemplo

Bloco de código

title	Exemplo SQLCODE
linenumbers	true

#------------------------------------------------------------------------------#
FUNCTION LREST_getGET()
#------------------------------------------------------------------------------#
    DEFINE l_status SMALLINT

    LET l_status = _ADVPL_get_property(m_rest_reference,"GET","/posts")

    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT, disponível na Classe LREST.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE, disponível na Classe LREST.

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

title	SET TITLE

Método SET: TITLE

Define o título da janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"TITLE", < l_title >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
`l_title`	`CHAR`	Título que será definido para a janela.	Sim

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"TITLE","Manutenção de Pedidos")

Expandir

title	SET ENABLE_ESC_CLOSE

Método SET: ENABLE_ESC_CLOSE

Habilita/desabilita o encerramento da janela através do botão ESC.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"ENABLE_ESC_CLOSE", < l_enable >)

Parâmetros

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

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"ENABLE_ESC_CLOSE",FALSE)

Expandir

title	SET MAXIMIZED

Método SET: MAXIMIZED

Maximiza a janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"MAXIMIZED", < l_maximized >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
l_maximized	`SMALLINT`	Verdadeiro para maximizar a janela, falso para manter o tamanho definido.	Sim

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"MAXIMIZED",TRUE)

Expandir

title	SET CENTERED

Método SET: CENTERED

Centraliza a janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"CENTERED", < l_centered >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
l_centered	`SMALLINT`	Verdadeiro para centralizar a janela, falso para manter na posição definida.	Sim

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"CENTERED",TRUE)

Observação

Este método só tem efeito se a janela não está maximizada.

Expandir

title	SET HOTKEY

Método SET: HOTKEY

Define uma tecla de atalho para a janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"HOTKEY", < l_hotkey >, [ l_event ], [ l_info ], [ l_component ], [ l_focus ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_hotkey	`SMALLINT`	Código da tecla de atalho. ¹	Sim
l_event	`CHAR`	Função 4GL que será executada na tecla de atalho. ²	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. ³	Não
l_focus	`SMALLINT`	Verdadeiro para limitar a execução da tecla de atalho apenas quando o componente informado estiver focado.	Não

¹ As teclas de atalho disponíveis encontram-se no link Teclas de atalhos disponíveis atualmente para formulários Freeform e Metadado.² Se não informada a função 4GL, a tecla de atalho será removida da janela.
³ Se informado um componente, a execução da tecla de atalho não será realizada quando este estiver desabilitado ou invisível.

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"HOTKEY",116,"job005_refresh","Atualiza os valores da tela")

Expandir

title	SET CLEAR_HOTKEYS

Método SET: CLEAR_HOTKEYS

Remove todas as teclas de atalho disponíveis na janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"CLEAR_HOTKEYS")

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"CLEAR_HOTKEYS")

Expandir

title	SET INIT_EVENT

Método SET: INIT_EVENT

Adiciona um evento que será executado na ativação da janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"INIT_EVENT", < l_event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
l_event	`CHAR`	Função 4GL que será executada na ativação da janela.	Sim

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"INIT_EVENT","job0005_init_event")

Expandir

title	SET MAXIMIZE_EVENT

Método SET: MAXIMIZE_EVENT

Define um evento que será executado quando o usuário maximizar a janela.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_reference >,"MAXIMIZE_EVENT", < l_event >)

Parâmetros

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

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"MAXIMIZE_EVENT","job0005_maximize_event")

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 13

Nova versão 14

Chave

Hierarquia

Métodos GET

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método SET: TITLE

Sintaxe

Parâmetros

Exemplo

Método SET: ENABLE_ESC_CLOSE

Sintaxe

Parâmetros

Exemplo

Método SET: MAXIMIZED

Sintaxe

Parâmetros

Exemplo

Método SET: CENTERED

Sintaxe

Parâmetros

Exemplo

Observação

Método SET: HOTKEY

Sintaxe

Parâmetros

Exemplo

Método SET: CLEAR_HOTKEYS

Sintaxe

Exemplo

Método SET: INIT_EVENT

Sintaxe

Parâmetros

Exemplo

Método SET: MAXIMIZE_EVENT

Sintaxe

Parâmetros

Exemplo