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.

Métodos acessíveis através da função _ADVPL_get_property que permite recuperar e manipular os valores do componente.

Expandir

title	GET ACTIVATE

Método GET: ACTIVATE

Retorna se a janela da aplicação está ativada.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"ACTIVATE") => lIsActive

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do componente que está em foco na tela.	Sim

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a janela da aplicação está ativada.

Exemplo

Bloco de código

linenumbers	true

LET l_active = _ADVPL_get_property(m_form_reference,"ACTIVATE")

Expandir

title	GET COMPONENT_FOCUS_REFERENCE

Expandir

title	GET GET

Método GET: COMPONENT_FOCUS_REFERENCE

Retorna a referência do componente em foco.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"COMPONENT_FOCUS_REFERENCE") => cComponentReference

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Referência do componente em foco

Exemplo

Bloco de código

linenumbers	true

LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_FOCUS_REFERENCE")

Expandir

title	GET COMPONENT_REFERENCE_BY_HELP_NAME

Método GET: COMPONENT_REFERENCE_BY_HELP_NAME

Retorna a referência do componente pelo nome do atalho de ajuda (propriedade HELP_NAME).

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"COMPONENT_REFERENCE_BY_HELP_NAME") => cComponentReference

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Referência do componente correspondente ao HELP_NAME indicado.

Exemplo

Bloco de código

linenumbers	true

LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_REFERENCE_BY_HELP_NAME")

Expandir

title	GET CONTAINER_HEIGHT

Método GET: CONTAINER_HEIGHT

Altura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"CONTAINER_HEIGHT") => nHeight

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`INTEGER`	Altura do componente LFORM

Exemplo

Bloco de código

linenumbers	true

LET l_height = _ADVPL_get_property(m_form_reference,"CONTAINER_HEIGHT")

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

Retorno

Expandir

title	GET CONTAINER_WIDTH

Método GET: CONTAINER_WIDTH

Largura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"CONTAINER_WIDTH") => nWidthGET", < 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

Tipo Descrição

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


lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`INTEGER`	Largura do componente LFORM

Exemplo

Bloco de código

linenumbers	true

LET l_width = _ADVPL_get_property(m_form_reference,"CONTAINER_WIDTH")

Expandir

title	GET FORM_INFO

Método GET: FORM_INFO

Breve informação sobre o formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"FORM_INFO") => cInfo

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Breve informação sobre o formulário.

Exemplo

Bloco de código

linenumbers	true

LET l_info = _ADVPL_get_property(m_form_reference,"FORM_INFO")

Expandir

title	GET FORM_MODIFICATION

Método GET: FORM_MODIFICATION

Número revisão de modificação do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION") => nModification

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`INTEGER`	Número da revisão de modificação do formulário.

Exemplo

Bloco de código

linenumbers	true

LET l_modification = _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION")

Expandir

title	GET FORM_NAME

Método GET: FORM_NAME

Nome do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"FORM_NAME") => cName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Nome do formulário.

Exemplo

Bloco de código

linenumbers	true

LET l_name = _ADVPL_get_property(m_form_reference,"FORM_NAME")

Expandir

title	GET FORM_RELEASE

Método GET: FORM_RELEASE

Retorna a release do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"FORM_RELEASE") => cRelease

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Código da release do formulário.

Exemplo

Bloco de código

linenumbers	true

LET l_release = _ADVPL_get_property(m_form_reference,"FORM_RELEASE")

Expandir

title	GET FORM_VERSION

Método GET: FORM_VERSION

Retorna a versão do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"FORM_VERSION") => cVersion

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Código da revisão do formulário.

Exemplo

Bloco de código

linenumbers	true

LET l_version = _ADVPL_get_property(m_form_reference,"FORM_VERSION")

Expandir

title	GET INIT_EVENT

Método GET: INIT_EVENT

Retorna a lista de eventos executados na abertura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"INIT_EVENT") => aList

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`ARRAY OF CHAR`	Array contendo a lista de funções executadas na abertura da janela.

Exemplo

Bloco de código

linenumbers	true

LET la_initEvent = _ADVPL_get_property(m_form_reference,"INIT_EVENT")

Expandir

title	GET MAIN_FORM_NAME

Método GET: MAIN_FORM_NAME

Nome do formulário principal em execução.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"MAIN_FORM_NAME") => cName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
`CHAR`	Nome do formulário principal em execução.

Exemplo

Bloco de código

linenumbers	true

LET l_name = _ADVPL_get_property(m_form_reference,"MAIN_FORM_NAME")

Expandir

title	GET MAXIMIZED

Método GET: MAXIMIZED

Retorna se a janela da aplicação está maximizada.

Sintaxe

Bloco de código
_ADVPL_get_property(< lFormReference >,"MAXIMIZED") => lIsMaximized

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	TRUE se a janela está maximizada

Exemplo

Bloco de código

linenumbers	true

LET la_initEvent = _ADVPL_get_property(m_form_reference,"MAXIMIZED")

Expandir

title	GET TITLE

Método GET: TITLE

Retorna o título da janela.

Sintaxe

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

Retorno

Tipo	Descrição
`CHAR`	Título definido na janela.

Exemplo

Bloco de código

linenumbers	true

LET l_title

Exemplo

Bloco de código

title	Exemplo SQLCODE
linenumbers	true

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

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

    IF  l_status THEN
        CALL CONOUT("OK.:",TITLE")

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 ACTIVATE

Método SET: ACTIVATE

Define o título da janela.

Sintaxe

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

Parâmetros

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

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"ACTIVATE",)

Expandir

title	SET CENTER

Método SET: CENTER

Define se a janela (ainda não exibida) abrirá no centro da área de trabalho.

Sintaxe

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

Parâmetros

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

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_set_property(m_form_reference,"CENTER",TRUE)

Observação

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

Expandir

title	SET CENTERED

Método SET: CENTERED

Centraliza a janela já aberta na área de trabalho.

Sintaxe

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

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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 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 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 FORM_INFO

Método SET: FORM_INFO

Define uma breve informação sobre o formulário.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< lFormReference >,"FORM_INFO", < cInfo > )

Parâmetros

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

linenumbers	true

CALL_ADVPL_get_property(m_restform_reference,"FORM_INFO","Programa de cadastro de Usuários.")

Expandir

title	SET FORM_MODIFICATION

Método SET: FORM_MODIFICATION

Ajusta o número revisão de modificação do formulário.

Sintaxe

Bloco de código
CALL _ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION", < nModification > )

Parâmetros

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

linenumbers	true

CALL _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION",48)

Expandir

title	SET FORM_NAME

Método SET: FORM_NAME

Nome do formulário.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< lFormReference >,"FORM_NAME", < cName > )

Parâmetros

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

linenumbers	true

CALL _ADVPL_get_property(m_form_reference,"FORM_NAME","log03948")

Expandir

title	SET FORM_RELEASE

Método SET: FORM_RELEASE

Ajusta a release do formulário.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< lFormReference >,"FORM_RELEASE", < cRelease > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	`CHAR`	Referência do formulário.	Sim
cRelease	CHAR	Código da release do formulário	Sim

Exemplo

Bloco de código

linenumbers	true

CALL _ADVPL_get_property(m_form_reference,"FORM_RELEASE", "2305")

Expandir

title	SET FORM_VERSION

Método SET: FORM_VERSION

Ajusta a versão do formulário.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< lFormReference >,"FORM_VERSION", < cVersion >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
lFormReference	CHAR	Referência do formulário.	Sim
cVersion	CHAR	Versão do formulário	Sim

Exemplo

Bloco de código

linenumbers	true

CALL "RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_restform_reference,"ERROR_MESSAGE"))
    END IF
END FUNCTION

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.

Métodos SET

Inclusão de trechoLFORM - Métodos SETLFORM - Métodos SETnopaneltrueMétodos acessíveis através da função _ADVPL_set_property que permite alterar e manipular os valores do componente:

FORM_VERSION","12.1")

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

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 TITLE

Método SET: TITLE

... parei aqui....

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

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Hierarquia

Métodos GET

Método GET: ACTIVATE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_FOCUS_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_REFERENCE_BY_HELP_NAME

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CONTAINER_HEIGHT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CONTAINER_WIDTH

Sintaxe

Parâmetros

Retorno

Retorno

Exemplo

Método GET: FORM_INFO

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_MODIFICATION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_NAME

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_RELEASE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_VERSION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: INIT_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MAIN_FORM_NAME

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MAXIMIZED

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: TITLE

Sintaxe

Retorno

Exemplo

Exemplo

Método SET: ACTIVATE