Componente abstrato, base dos componentes para criação de janelas de aplicações. Todos os métodos contidos neste componente poderão ser executados pelos componentes que o herdam.

Hierarquia

LCOMPONENT

Métodos GET

Métodos acessíveis utilizando a 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(< l_form_reference >,"ACTIVATE")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	BOOLEAN	Define se a janela está ativada.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se a janela está ativada.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

l_activate = _ADVPL_get_property(l_form_reference,"ACTIVATE")

Expandir

title	GET COMPONENT_FOCUS_REFERENCE

Método GET: COMPONENT_FOCUS_REFERENCE

Referência do componente em foco.

Sintaxe

Bloco de código
_ADVPL_get_property(< m_form_reference >,"COMPONENT_FOCUS_REFERENCE")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`m_form_reference`	CHAR	Componente que está em foco na tela.	Sim

Retorno

Tipo	Descrição
CHAR	Referência do componente que está em foco na tela.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_component_reference = _ADVPL_get_property(m_form_reference,"COMPONENT_FOCUS_REFERENCE")

Expandir

title	GET CONTAINER_HEIGHT

Método GET: CONTAINER_HEIGHT

Altura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONTAINER_HEIGHT")

Dica

title	Obs:

Para retornar a largura correta da janela da aplicação é necessário antes efetuar a chamada do método REFRESH_SIZE.

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	()	Altura da janela da aplicação.	Sim

Retorno

Tipo	Descrição
( )	Altura da janela da aplicação.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_container_height = _ADVPL_get_property(l_form_reference,"CONTAINER_HEIGHT")

Expandir

title	GET CONTAINER_WIDTH

Método GET: CONTAINER_WIDTH

Largura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONTAINER_WIDTH")

Dica

title	Obs:

Para retornar a largura correta da janela da aplicação é necessário antes efetuar a chamada do método REFRESH_SIZE.

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	()	Largura da janela da aplicação.	Sim

Retorno

Tipo	Descrição
( )	Largura da janela da aplicação.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_container_width = _ADVPL_get_property(l_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(< l_form_reference >,"FORM_INFO")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Breve informação sobre o formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Largura da janela da aplicação.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_form_info = _ADVPL_get_property(l_form_reference,"FORM_INFO")

Expandir

title	GET FORM_MODIFICATION

Método GET: FORM_MODIFICATION

Modificação do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_MODIFICATION")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Modificação do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Modificação do formulário.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_form_modification = _ADVPL_get_property(l_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(< l_form_reference >,"FORM_NAME")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Nome do formulário.	Sim

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_form_name = _ADVPL_get_property(l_form_reference,"FORM_NAME")

Expandir

title	GET FORM_RELEASE

Método GET: FORM_RELEASE

Release do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_RELEASE")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Release do formulário.	Sim

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_release = _ADVPL_get_property(l_form_reference,"FORM_RELEASE")

Expandir

title	GET INIT_EVENT

Método GET: INIT_EVENT

Lista de eventos executados na abertura da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"INIT_EVENT")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	()	Lista de funções executadas na abertura da janela da aplicação.	Sim

Retorno

Tipo	Descrição
( )	Nome do formulário.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET la_init_event = _ADVPL_get_property(l_form_reference,"INIT_EVENT")

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(< l_form_reference >,"MAXIMIZED")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	BOOLEAN	Define se a janela da aplicação está maximizada.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se a janela da aplicação está maximizada.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_maximized = _ADVPL_get_property(l_form_reference,"MAXIMIZED")

Expandir

title	GET TITLE

Método GET: TITLE

Título da janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"TITLE")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	BOOLEAN	Título da janela da aplicação.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Título da janela da aplicação.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_title = _ADVPL_get_property(l_form_reference,"TITLE")

Métodos SET

Métodos acessíveis utilizando a função _ADVPL_set_property que permite alterar e manipular os valores do componente.

Expandir

title	SET ACTIVATE

Método SET: ACTIVATE

Ativa/Desativa a janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ACTIVATE", < l_status >)

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário.

Sim

l_status

SMALLINT

Indicador que define se será ativado ou desativado o formulário.

TRUE - Ativa o formulário

FALSE - Desativa/Fecha o formulário.

Sim

Para ativar ou desativar um formulário, deverá ter executado previamente o método "FORM" ou "INIT_FORM" para o mesmo.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)

Exemplo

Expandir

title	SET CENTER

Método SET:

ACTIVATE

CENTER

Centraliza a janela da aplicação na área de trabalho do usuário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ACTIVATE", < l_status >CENTER")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência centralizar a janela da aplicação na área de trabalho do usuário.	Sim

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

Sim

l_status

SMALLINT

Indicador que define se será ativado ou desativado o formulário.

TRUE - Ativa o formulário

FALSE - Desativa/Fecha o formulário.

Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"CENTER")

Expandir

title	SET CENTERED

Método SET: CENTER

Define se a tela abrirá no centro da área de trabalho.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"CENTERED",< status >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`BOOLEAN`	Indicador que define se a tela será aberta no centro da área de trabalho do usuário.	Sim

Para ativar ou desativar um formulário, deverá ter executado previamente o método "FORM" ou "INIT_FORM" para o mesmo.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ACTIVATECENTERED",TRUE)

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 9

Nova versão 10

Chave

Hierarquia

Métodos GET

Método GET: ACTIVATE

Sintaxe

Parâmetros

Exemplo

Método GET: COMPONENT_FOCUS_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CONTAINER_HEIGHT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CONTAINER_WIDTH

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_INFO

Sintaxe

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: INIT_EVENT

Sintaxe

Parâmetros

Exemplo

Método GET: MAXIMIZED

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: TITLE

Sintaxe

Parâmetros

Retorno

Exemplo

Métodos SET

Método SET: ACTIVATE

Sintaxe

Parâmetros

Exemplo

Método SET:

CENTER

Sintaxe

Parâmetros

Exemplo

Método SET: CENTER

Sintaxe

Parâmetros