Linha Logix

Páginas filhas
  • LGX - LParMetaData

Versões comparadas

Versão antiga 2

changes.mady.by.user Usuário desconhecido (ieda.alves)

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Usuário desconhecido (ieda.alves)

Gravado em

Chave

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


Pagetitle
LGX - LParMetaData
LGX - LParMetaData
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 herdamque cria e executa formulário metadado de processamento.

Atualmente estes formulários são cadastrados utilizando o programa "FRM0003 - FORMULÁRIOS DE PARÂMETROS/PROCESSAMENTO".

Hierarquia


Métodos GET

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


Exemplo

Expandir
titleGET ACTIVATECOMPONENT_REFERENCE

Método GET:

ACTIVATERetorna se a janela da aplicação está ativada

COMPONENT_REFERENCE

Referência do componente de um determinado campo do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"ACTIVATE"COMPONENT_REFERENCE", < Tabela >, < Coluna >) ==> BOOLEANReferência

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference 
CHAR

Referência do formulário.

Sim
Retorno
Tabela

Tipo

Descrição

BOOLEANIndicador que define se a janela está ativada.
CHARNome da tabela da coluna do formulário da qual deseja-se recuperar a referência do componente.Sim
ColunaCHARNome da coluna do formulário da qual deseja-se recuperar a referência do componente.Sim


Retorno


Tipo

Descrição

CHAR

Referência do componente de um campo do formulário.

Exemplo


Bloco de código
languageruby
Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_component_activatereference = _ADVPL_get_property(l_form_reference,"ACTIVATECOMPONENT_REFERENCE","item","cod_empresa")



Expandir
titleGET COMPONENTCURRENT_FOCUS_REFERENCEOPERATION

Método GET:

COMPONENT

CURRENT_

FOCUS_REFERENCE

OPERATION

Operação em execução

Referência do componente em foco

.

Sintaxe


Bloco de código
_ADVPL_get_property(< ml_form_reference >,"COMPONENTCURRENT_FOCUS_REFERENCEOPERATION") ==> ReferênciaOperação

Parâmetros


NomeTipoDescriçãoObrigatório?
ml_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR
Referência do componente

Nome da operação que está em

foco na tela

execução, conforme cadastrada no programa "FRM0001 - Barra de Ferramentas".

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_componentcurrent_referenceoperation = _ADVPL_get_property(ml_form_reference,"COMPONENTCURRENT_FOCUS_REFERENCEOPERATION")



Altura da janela da aplicação
Expandir
titleGET CONTAINEREXECUTE_HEIGHTOPERATION

Método GET:

CONTAINER

EXECUTE_

HEIGHTAltura da janela da aplicação

OPERATION

Executa uma determinada operação do formulário, conforme cadastrada no programa "FRM0001 - Barra de Ferramentas".

Sintaxe


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


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
()CHAR

Referência do formulário.

Sim
OperaçãoCHARNome da operação do formulário da qual deseja-se executar, conforme cadastrada no programa "FRM0001 - Barra de Ferramentas".Sim

Retorno


Tipo

Descrição

( )
BOOLEAN

Caso a operação foi executado com sucesso retornará verdadeiro, caso contrário retornará falso.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_container_heightstatus = _ADVPL_get_property(l_form_reference,"CONTAINER_HEIGHTEXECUTE_OPERATION","inform")



Largura da janela da aplicação
Expandir
titleGET CONTAINER_WIDTHINFORMED

Método GET:

CONTAINER_WIDTHLargura da janela da aplicação

INFORMED

Verificação se os parâmetros do formulário já foram informados ou não no formulário.

Sintaxe


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


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
()CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

( )
BOOLEAN

Indicador que define se os parâmetros do formulário já foram informados ou não no formulário.

Exemplo


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



Expandir
titleGET FORMITEM_INFOCOUNT

Método GET:

FORM

ITEM_

INFOBreve informação sobre o

COUNT

Quantidade de linhas de um determinado multivalorado do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMITEM_INFO"COUNT",  < Associação >) ==> InformaçãoQuantidade


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno

AssociaçãoCHARNome da associação do multivalorado do formulário da qual deseja-se retornar o número de linhas.Sim

Retorno


Tipo

Descrição

( )

Número de linhas informadas no multivalorado do formulário

CHAR

Largura da janela da aplicação.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_formitem_infocount = _ADVPL_get_property(l_form_reference,"FORM_INFOITEM_COUNT","item")



Expandir
titleGET FORMLABEL_MODIFICATIONREFERENCE

Método GET:

FORM

LABEL_

MODIFICATION 

REFERENCE

Modificação do formulário.

Referência do componente da descrição de um determinado campo do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMLABEL_MODIFICATION"REFERENCE",  < Tabela >, < Coluna >) ==> ModificaçãoReferência


Parâmetros


Tipo
NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno

Tabela

Descrição

CHAR
Modificação
Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência da descrição.
Exemplo
Sim
code
ColunaCHARNome da coluna do formulário da qual deseja-se recuperar a referência da descrição.Sim

Retorno


Tipo

Descrição

CHAR

Referência do componente de descrição de um campo do formulário.

Exemplo


Bloco de código
languageruby
themeEclipse
languageruby
themeEclipse
linenumberstrue
LET l_formlabel_modificationreference = _ADVPL_get_property(l_form_reference,"FORM_MODIFICATIONLABEL_REFERENCE","item","cod_empresa")



Expandir
titleGET FORMMENU_NAMEBUTTON_REFERENCE

Método GET:

FORM

MENU_BUTTON_

NAME

REFERENCE

Referência de um botão da barra de ferramentas

Nome

do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMMENU_BUTTON_NAME"REFERENCE", < Operação >) ==> FormulárioReferência


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim
Retorno
Operação

Tipo

Descrição

CHARNome da operação, cadastrada no programa "FRM0001 - Barra de Ferramentas", do formulário da qual deseja-se retornar a referência.
Exemplo
Sim
code

Retorno


Tipo

Descrição

CHAR

Referência de um botão da barra de ferramentas (LMenuButton) correspondente à operação informada como parâmetro.

Exemplo


Bloco de código
languagelanguageruby
themeEclipse
linenumberstrue
LET l_formmenubutton_namereference = _ADVPL_get_property(l_form_reference,"FORM_NAMEMENU_BUTTON_REFERENCE","inform")



Expandir
titleGET FORMMENUBAR_RELEASEREFERENCE

Método GET:

FORM

MENUBAR_

RELEASE

REFERENCE

Referência da barra de ferramentas

Release

do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORMMENUBAR_RELEASEREFERENCE") ==> ReleaseReferência


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

CHAR

Release do Referência da barra de ferramentas (LMenuBar) do formulário.

Exemplo


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



Expandir
titleGET FORM_VERSIONMULTI_VALUED_BUTTON_REFERENCE

Método GET:

FORM_VERSION 

MULTI_VALUED_BUTTON_REFERENCE 

Referência do componente do botão de multivalorado de um determinado campo

Versão

do formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_VERSION"MULTI_VALUED_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> VersãoReferência


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno

TabelaCHARNome da tabela da coluna do formulário da qual deseja-se recuperar a referência do botão de multivalorado.Sim
ColunaCHARNome da coluna do formulário da qual deseja-se recuperar a referência do botão de multivalorado.Sim


Retorno


Tipo

Descrição

CHAR

Referência do componente do botão de zoom de um campo

 ( )

Versão do formulário.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_zoom_formbutton_versionreference = _ADVPL_get_property(l_form_reference_reference,"MULTI_VALUED_BUTTON_REFERENCE","item","FORMcod_VERSIONitem")



Expandir
titleGET INIT_EVENT MULTI_VALUED_COLUMN_REFERENCE

Método GET:

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

MULTI_VALUED_COLUMN_REFERENCE

Referência de uma determinada coluna do componente grid do multivalorado em execução no formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"INIT_EVENT"(< l_form_reference >,"MULTI_VALUED_COLUMN_REFERENCE",< Coluna >) ==> Lista de funçõesReferência


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim
ColunaCHARNome da coluna do multivalorado em execução no formulário.Sim


Retorno


Lista de funções executadas na abertura da janela da aplicação

Tipo

Descrição

 ( )

CHAR

Referência da coluna do componente grid do multivalorado em execução no formulário.

(informação) Importante: caso não tenha nenhum multivalorado em execução, este método irá retornar nulo.


Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET lal_multivalued_initcolumn_eventreference = _ADVPL_get_property(l_form_reference,"INIT_EVENTMULTI_VALUED_COLUMN_REFERENCE","cod_item")



Indicador que define se a janela da aplicação está maximizada
Expandir
titleGET MAXIMIZED MULTI_VALUED_TABLE_REFERENCE

Método GET:

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

MULTI_VALUED_TABLE_REFERENCE

Referência do componente grid do multivalorado em execução no formulário.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_reference >,"MAXIMIZEDMULTI_VALUED_TABLE_REFERENCE") ==> Maximizada?Referência


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno


Tipo

Descrição

BOOLEAN

CHAR

Referência do componente grid do multivalorado em execução no formulário.

(informação) Importante: caso não tenha nenhum multivalorado em execução, este método irá retornar nulo.

Exemplo


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



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 

Evento executado quando o usuário fechar a janela de diálogo.

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.