Linha Logix

Páginas filhas
  • LGX - LCOMPONENT

Versões comparadas

Versão antiga 1

changes.mady.by.user Ieda Ferreira Alves Flock

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Ieda Ferreira Alves Flock

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Pagetitle
LForm
LForm

Componente abstrato base para outros componentes. Todos os métodos contidos neste componente poderão ser executados pelos componentes que o herdam.


Hierarquia


Métodos GET

Métodos acessíveis utilizando a função _ADVPL_get_property, que permite recuperar e manipular os valores do componente: 


Expandir
titleGET ACTIVATEALIGN

Método GET: ALIGN 

Alinhamento do componente em relação ao seu componente pai.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"ALIGN") ==> Alinhamento

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference 
CHAR

Referência do formulário.

Sim


Retorno


Tipo

Descrição

CHAR
  • Alinhamento do componente em relação ao componente pai, sendo:


    • NONE: nenhum alinhamento.
    • TOP: alinhamento ao topo.
    • LEFT: alinhamento à esquerda.
    • RIGHT: alinhamento à direita.
    • CENTER: alinhamento central.
    • BOTTOM: alinhamento ao fundo.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_align = _ADVPL_get_property(l_component_reference,"ALIGN")



Referência do componente que está em foco na tela
Expandir
titleGET COMPONENTCAN_GOT_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 >,"COMPONENTCAN_GOT_FOCUS_REFERENCE ") ==> Referência Permite ganhar foco?

Parâmetros


NomeTipoDescriçãoObrigatório?
m_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
BOOLEAN

Indicador que define se o componente pode ganhar foco.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_component_reference = _ADVPL_get_property(m_form_reference,"COMPONENTCAN_GOT_FOCUS_REFERENCE ")



Altura da janela da aplicação
Expandir
titleGET CONTAINERCHANGE_HEIGHTEVENT

Método GET:

CONTAINER

CHANGE_

HEIGHTAltura da janela da aplicação.

EVENT

Evento executado quando o valor do componente for alterado.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONTAINERCHANGE_HEIGHTEVENT ") ==> Altura
Dica
titleObs:
Para retornar a largura correta da janela da aplicação é necessário antes efetuar a chamada do método REFRESH_SIZE.
Função


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
()CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

( )
CHAR

Função que é executada quando o valor do componente for alterado.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_containerchange_heightevent = _ADVPL_get_property(l_formcomponent_reference,"CONTAINERCHANGE_HEIGHTEVENT")



Largura da janela da aplicação
Expandir
titleGET CONTAINERCLICK_WIDTHEVENT

Método GET:

CONTAINER

CLICK_

WIDTHLargura da janela da aplicação

EVENT 

Evento executado ao clicar no componente.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONTAINERCLICK_WIDTHEVENT") ==> Largura
Dica
titleObs:
Para retornar a largura correta da janela da aplicação é necessário antes efetuar a chamada do método REFRESH_SIZE.
Função


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
()CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

( )
CHAR

Função que é executada ao clicar no componente.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_containerclick_widthevent = _ADVPL_get_property(l_formcomponent_reference,"CONTAINERCLICK_WIDTHEVENT")



Expandir
titleGET FORMCOMPONENT_INFOTYPE

Método GET:

FORM

COMPONENT_

INFOBreve informação sobre o formulário

TYPE

Tipo do componente.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMCOMPONENT_INFOTYPE") ==> InformaçãoTipo


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
Largura da janela da aplicação

Tipo do componente criado (LDialog, LCheckBox, LTextField, etc).

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_formcomponent_infotype = _ADVPL_get_property(l_formcomponent_reference,"FORMCOMPONENT_INFOTYPE")



Expandir
titleGET FORMDOUBLE_CLICK_MODIFICATIONEVENT

Método GET: FORM_MODIFICATION 

Modificação do formulário

Evento executado ao efetuar um duplo clique no componente.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMDOUBLE_CLICK_MODIFICATIONEVENT") ==> ModificaçãoFunção


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
Modificação do formulário

Função que é executada ao efetuar um duplo clique no componente.


Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_double_formclick_modificationevent = _ADVPL_get_property(l_formcomponent_reference,"FORMDOUBLE_CLICK_MODIFICATIONEVENT")



Nome do formulário
Expandir
titleGET FORM_NAMEEDITABLE

Método GET:

FORM_NAME

EDITABLE

Retorna se o componente está editável

Nome do formulário

.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_NAMEEDITABLE") ==> FormulárioEditável?


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
BOOLEAN

Indicador que define se o componente está editável.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_form_nameeditable = _ADVPL_get_property(l_formcomponent_reference,"FORM_NAMEEDITABLE")



Release do formulário
Expandir
titleGET FORM_RELEASEENABLE

Método GET:

FORM_RELEASE

ENABLE

Retorna se o componente está habilitado

Release do formulário

.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_RELEASEENABLE") ==> Release


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
BOOLEAN

Indicador que define se o componente está habilitado.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_releaseenable = _ADVPL_get_property(l_formcomponent_reference,"FORM_RELEASEENABLE")



Expandir
titleGET FORM_VERSION

Método GET: FORM_VERSION 

Versão do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_VERSIONREFERENCE") ==> Versão


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim


Retorno


Tipo

Descrição

 ( )

Versão do formulário.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_form_version = _ADVPL_get_property(l_form_reference,"FORM_VERSION")









Expandir
titleGET 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") ==> Lista de funções


Parâmetros


NomeTipoDescriçãoObrigató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


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET la_init_event = _ADVPL_get_property(l_form_reference,"INIT_EVENT")



Expandir
titleGET 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") ==> Maximizada?


Parâmetros


NomeTipoDescriçãoObrigató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


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_maximized = _ADVPL_get_property(l_form_reference,"MAXIMIZED")



Expandir
titleGET TITLE

Método GET: TITLE

Título da janela da aplicação.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"TITLE") ==> Título


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

BOOLEAN

Título da janela da aplicação.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
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
titleSET 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


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_statusSMALLINT

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

   TRUE - Ativa o formulário

   FALSE - Desativa/Fecha o formulário.

Sim

(informação) 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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)



Expandir
titleSET CENTER

Método SET: 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 >,"CENTER")

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"CENTER")



Expandir
titleSET CENTERED

Método SET: CENTERED

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

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigató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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"CENTERED",TRUE)



Expandir
titleSET ENABLE_ESC_CLOSE

Método SET: ENABLE_ESC_CLOSE

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

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigató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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ENABLE_ESC_CLOSE",FALSE)



Expandir
titleSET FORM_INFO

Método SET: FORM_INFO 

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

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >,"FORM_INFO",< informação >)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
informação
CHAR
Breve informação sobre o formulário.Sim

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"FORM_INFO","Formulário de manutenção de usuário Logix.")



Expandir
titleSET FORM_MODIFICATION

Método SET: FORM_INFO 

Modificação do formulário.

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >,"FORM_MODIFICATION",< informação >)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
informação
CHAR
Breve informação sobre o formulário.Não

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"FORM_MODIFICATION","01")



Expandir
titleSET FORM_NAME

Método SET: FORM_NAME 

Modificação do formulário.

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_name >,"FORM_INFO",< formulário >)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_name
CHAR
Referência do formulário.Sim
formulário
CHAR
Nome do formulário.Sim

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_name,"FORM_NAME","LOG5500")



Expandir
titleSET FORM_RELEASE

Método SET: FORM_RELEASE 

Release do formulário.

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
release
CHAR
Release do formulário.Sim

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"FORM_RELEASE","02")



Expandir
titleSET FORM_VERSION

Método SET: FORM_VERSION 

Versão do formulário.

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >,"FORM_VERSION",< versao >)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
versao
CHAR
Versão do formulário.Sim

(informaçã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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"FORM_VERSION","10")



Expandir
titleSET HOTKEY

Método SET: HOTKEY 

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

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >,< tecla >,< função >,< descrição >,< componente >, < status >)

Parâmetros


NomeTipoDescriçãoObrigató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çãoCHARFunção que será executada ao acionar a tecla de atalho.Sim
descriçãoCHARDescriçã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
componenteCHARReferência do componente do qual pertence a tecla de atalho.Não
statusBOOLEANIndicador 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

(informação) Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.

Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"HOTKEY","CTRL-I","Incluir um novo registro.",l_menubutton_reference,FALSE)



Expandir
titleSET INIT_EVENT

Método SET: INIT_EVENT 

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

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >,< função>)

Parâmetros


NomeTipoDescriçãoObrigató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

(informação) 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.



Expandir
titleSET MAXIMIZED

Método SET: MAXIMIZED 

Define se a tela abrirá maximizada.

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
status
BOOLEAN
Indicador que define se a janela abrirá maximizada.Sim

(informação) 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


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"MAXIMIZED",FALSE)



Expandir
titleSET TITLE

Método SET: MAXIMIZED 

Título da janela.

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_reference >," TITLE ",< título>)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
título
CHAR
Título da janela.Sim


Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"TITLE","Central do Usuário")



Expandir
titleSET VALID

Método SET: VALID 

Define se a tela abrirá maximizada.

Sintaxe


Bloco de código
_ADVPL_set_property(< funçao >)

Parâmetros


NomeTipoDescriçãoObrigatório?
função
CHAR
Função que será executada quando o usuário fechar a janela de diálogo.Sim

(informação) 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.

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