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:

Método GET: ACTIVATE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"ACTIVATE") ==> BOOLEAN

Parâmetros

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

Retorno

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

Exemplo

l_activate = _ADVPL_get_property(l_form_reference,"ACTIVATE")

Método GET: COMPONENT_FOCUS_REFERENCE

Referência do componente em foco.

Sintaxe

_ADVPL_get_property(< m_form_reference >,"COMPONENT_FOCUS_REFERENCE") ==> Referência

Parâmetros

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

Retorno

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

Exemplo

LET l_component_reference = _ADVPL_get_property(m_form_reference,"COMPONENT_FOCUS_REFERENCE")

Método GET: CONTAINER_HEIGHT

Altura da janela da aplicação.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"CONTAINER_HEIGHT") ==> Altura

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`	()	Referência do formulário.	Sim

Retorno

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

Exemplo

LET l_container_height = _ADVPL_get_property(l_form_reference,"CONTAINER_HEIGHT")

Método GET: CONTAINER_WIDTH

Largura da janela da aplicação.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"CONTAINER_WIDTH") ==> Largura

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`	()	Referência do formulário.	Sim

Retorno

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

Exemplo

LET l_container_width = _ADVPL_get_property(l_form_reference,"CONTAINER_WIDTH")

Método GET: FORM_INFO

Breve informação sobre o formulário.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"FORM_INFO") ==> Informação

Parâmetros

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

Retorno

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

Exemplo

LET l_form_info = _ADVPL_get_property(l_form_reference,"FORM_INFO")

Método GET: FORM_MODIFICATION

Modificação do formulário.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"FORM_MODIFICATION") ==> Modificação

Parâmetros

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

Retorno

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

Exemplo

LET l_form_modification = _ADVPL_get_property(l_form_reference,"FORM_MODIFICATION")

Método GET: FORM_NAME

Nome do formulário.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"FORM_NAME") ==> Formulário

Parâmetros

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

Retorno

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

Exemplo

LET l_form_name = _ADVPL_get_property(l_form_reference,"FORM_NAME")

Método GET: FORM_RELEASE

Release do formulário.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"FORM_RELEASE") ==> Release

Parâmetros

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

Retorno

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

Exemplo

LET l_release = _ADVPL_get_property(l_form_reference,"FORM_RELEASE")

Método GET: FORM_VERSION

Versão do formulário.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"FORM_VERSION") ==> Versão

Parâmetros

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

Retorno

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

Exemplo

LET l_form_version = _ADVPL_get_property(l_form_reference,"FORM_VERSION")

Método GET: INIT_EVENT

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"INIT_EVENT") ==> Lista de funções

Parâmetros

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

Retorno

Tipo	Descrição
( )	Lista de funções executadas na abertura da janela da aplicação.

Exemplo

LET la_init_event = _ADVPL_get_property(l_form_reference,"INIT_EVENT")

Método GET: MAXIMIZED

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"MAXIMIZED") ==> Maximizada?

Parâmetros

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

Retorno

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

Exemplo

LET l_maximized = _ADVPL_get_property(l_form_reference,"MAXIMIZED")

Método GET: TITLE

Título da janela da aplicação.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"TITLE") ==> Título

Parâmetros

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

Retorno

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

Exemplo

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.

Método SET: ACTIVATE

Ativa/Desativa a janela da aplicação.

Sintaxe

_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

CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)

Método SET: CENTER

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

Sintaxe

_ADVPL_set_property(< l_form_reference >,"CENTER")

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulá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).

Exemplo

CALL _ADVPL_set_property(l_form_reference,"CENTER")

Método SET: CENTERED

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

Sintaxe

_ADVPL_set_property(< l_form_reference >,"CENTERED",< l_status >)

Parâmetros

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

Exemplo

CALL _ADVPL_set_property(l_form_reference,"CENTERED",TRUE)

Método SET: ENABLE_ESC_CLOSE

Define se habilita o encerramento da janela com a tecla ESC.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"ENABLE_ESC_CLOSE",< l_status >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
l_status	`BOOLEAN`	Indicador que define se a janela poderá ser encerrada com a tecla ESC.	Sim

Exemplo

CALL _ADVPL_set_property(l_form_reference,"ENABLE_ESC_CLOSE",FALSE)

Método SET: FORM_INFO

Define se habilita o encerramento da janela com a tecla ESC.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"FORM_INFO",< informação >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`informação`	`CHAR`	Breve informação sobre o formulá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).

Exemplo

CALL _ADVPL_set_property(l_form_reference,"FORM_INFO","Formulário de manutenção de usuário Logix.")

Método SET: FORM_INFO

Modificação do formulário.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"FORM_MODIFICATION",< informação >)

Parâmetros

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

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

Exemplo

CALL _ADVPL_set_property(l_form_reference,"FORM_MODIFICATION","01")

Método SET: FORM_NAME

Modificação do formulário.

Sintaxe

_ADVPL_set_property(< l_form_name >,"FORM_INFO",< formulário >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_name`	`CHAR`	Referência do formulário.	Sim
`formulário`	`CHAR`	Nome do formulá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).

Exemplo

CALL _ADVPL_set_property(l_form_name,"FORM_NAME","LOG5500")

Método SET: FORM_RELEASE

Release do formulário.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"FORM_RELEASE",< release >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`release`	`CHAR`	Release do formulá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).

Exemplo

CALL _ADVPL_set_property(l_form_reference,"FORM_RELEASE","02")

Método SET: FORM_VERSION

Versão do formulário.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"FORM_VERSION",< versao >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`versao`	`CHAR`	Versão do formulá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).

Exemplo

CALL _ADVPL_set_property(l_form_reference,"FORM_VERSION","10")

Método SET: HOTKEY

Tecla de atalho a ser executada quando a janela da aplicação estiver ativa.

Sintaxe

_ADVPL_set_property(< l_form_reference >,< tecla >,< função >,< descrição >,< componente >, < status >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
tecla	`CHAR`	Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.	Sim
função	CHAR	Função que será executada ao acionar a tecla de atalho.	Sim
descrição	CHAR	Descrição da execução da tecla de atalho, esta descrição será exibida na janela de tecla disponíveis no formulário para o usuário.	Sim
componente	CHAR	Referência do componente do qual pertence a tecla de atalho.	Não
status	BOOLEAN	Indicador lógico que define se o atalho deverá ser executado sempre ou somente quando o componente informado no método estiver focado em tela.	Não

Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.

Exemplo

CALL _ADVPL_set_property(l_form_reference,"HOTKEY","CTRL-I","Incluir um novo registro.",l_menubutton_reference,FALSE)

Método SET: INIT_EVENT

Adiciona um evento a ser executado ao iniciar a janela da aplicação.

Sintaxe

_ADVPL_set_property(< l_form_reference >,< função>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`função`	`CHAR`	Função executada executada ao iniciar a janela de aplicação.	Sim

Este método pode ser chamado mais de uma vez, sendo que as funções serão empilhadas e executadas na ordem em que foram enviadas.

Método SET: MAXIMIZED

Define se a tela abrirá maximizada.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"MAXIMIZED",< status >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`status`	`BOOLEAN`	Indicador que define se a janela abrirá maximizada.	Sim

Importante: por padrão no Logix, caso não definido este método, toda janela pai (primeira execução) são abertas maximizadas. As janelas abertas na mesma thread por outras janelas são abertas no modo normal.

Exemplo

CALL _ADVPL_set_property(l_form_reference,"MAXIMIZED",FALSE)

Método SET: MAXIMIZED

Título da janela.

Sintaxe

_ADVPL_set_property(< l_form_reference >," TITLE ",< título>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`título`	`CHAR`	Título da janela.	Sim

Exemplo

CALL _ADVPL_set_property(l_form_reference,"TITLE","Central do Usuário")

Método SET: VALID

Define se a tela abrirá maximizada.

Sintaxe

_ADVPL_set_property(< funçao >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`função`	`CHAR`	Função que será executada quando o usuário fechar a janela de diálogo.	Sim

Importante: este evento é executado tanto na chamada do método ACTIVATE (para desativar a janela de diálogo), quanto no fechamento da janela pelo sistema operacional (pelo X da janela de diálogo). Este evento não é o mesmo evento definido no método EVENT para o botão LQuitButton.

Importante: caso a função informada neste método retornar falso, a tela não será finalizada.