Páginas filhas
  • LGX - LParMetaData

Versões comparadas

Chave

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


Pagetitle
LGX - LParMetaData
LGX - LParMetaData
Componente que 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: 


Expandir
titleGET COMPONENT_REFERENCE

Método GET: COMPONENT_REFERENCE

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference 
CHAR

Referência do formulário.

Sim
TabelaCHARNome 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
themeEclipse
linenumberstrue
LET l_component_reference = _ADVPL_get_property(l_form_reference,"COMPONENT_REFERENCE","item","cod_empresa")




Expandir
titleGET CURRENT_OPERATION

Método GET: CURRENT_OPERATION

Operação em execução.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"CURRENT_OPERATION") ==> Operação

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno



Tipo

Descrição

CHAR

Nome da operação que está em execução, conforme cadastrada no programa "FRM0001 - Barra de Ferramentas".

Exemplo



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




Expandir
titleGET EXECUTE_OPERATION

Método GET: EXECUTE_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 >,"EXECUTE_OPERATION", < Operação >) ==> 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_status = _ADVPL_get_property(l_form_reference,"EXECUTE_OPERATION","inform")




Expandir
titleGET INFORMED

Método GET: 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 >,"INFORMED") ==> Já 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_informed = _ADVPL_get_property(l_form_reference,"INFORMED")




Expandir
titleGET ITEM_COUNT

Método GET: ITEM_COUNT

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

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"ITEM_COUNT",  < Associação >) ==> Quantidade


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

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

Exemplo



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




Expandir
titleGET LABEL_REFERENCE

Método GET: LABEL_REFERENCE

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 >,"LABEL_REFERENCE",  < Tabela >, < Coluna >) ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim
TabelaCHARNome da tabela da coluna do formulário da qual deseja-se recuperar a referência da descrição.Sim
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
linenumberstrue
LET l_label_reference = _ADVPL_get_property(l_form_reference,"LABEL_REFERENCE","item","cod_empresa")




Expandir
titleGET MENU_BUTTON_REFERENCE

Método GET: MENU_BUTTON_REFERENCE

Referência de um botão da barra de ferramentas do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"MENU_BUTTON_REFERENCE", < Operação >) ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

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

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
languageruby
themeEclipse
linenumberstrue
LET l_menubutton_reference = _ADVPL_get_property(l_form_reference,"MENU_BUTTON_REFERENCE","inform")




Expandir
titleGET MENUBAR_REFERENCE

Método GET: MENUBAR_REFERENCE

Referência da barra de ferramentas do formulário.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno



Tipo

Descrição

CHAR

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

Exemplo



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




Expandir
titleGET MULTI_VALUED_BUTTON_REFERENCE

Método GET: MULTI_VALUED_BUTTON_REFERENCE 

Referência do componente do botão de multivalorado de um determinado campo do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"MULTI_VALUED_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim
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 do formulário.

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_zoom_button_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_BUTTON_REFERENCE","item","cod_item")




Expandir
titleGET MULTI_VALUED_COLUMN_REFERENCE

Método GET: 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 >,"MULTI_VALUED_COLUMN_REFERENCE",< Coluna >) ==> Referê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



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 l_multivalued_column_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_COLUMN_REFERENCE","cod_item")




Expandir
titleGET MULTI_VALUED_TABLE_REFERENCE

Método GET: 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 >,"MULTI_VALUED_TABLE_REFERENCE") ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno



Tipo

Descrição

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_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_TABLE_REFERENCE")




Expandir
titleGET PROGRESS_BAR_REFERENCE

Método GET: PROGRESS_BAR_REFERENCE

Referência da barra de progresso utilizada na operação de processamento do formulário.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno



Tipo

Descrição

CHAR

Referência da barra de progresso utilizada na operação de processamento do formulário.

(informação) Importante: este método deve ser chamado somente na função da operação padrão process do formulário.

Exemplo



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




Expandir
titleGET PROGRESSSTATUS_BAR_REFERENCE

Método GET:

PROGRESS

STATUS_BAR_REFERENCE

Referência da barra de progresso utilizada na operação de processamento status do formulário.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

Sim

Retorno



Tipo

Descrição

CHAR

Referência da barra de progresso utilizada na operação de processamento do formulário.

(informação) Importante: este método deve ser chamado somente na função da operação padrão process 

status do formulário.

Exemplo



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




Expandir
titleGET ZOOM_BUTTON_REFERENCE

Método GET: ZOOM_BUTTON_REFERENCE

Referência do componente do botão de zoom de um determinado campo do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"ZOOM_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

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

Retorno



Tipo

Descrição

CHAR

Referência do componente do botão de zoom de um campo do formulário.

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_zoom_button_reference = _ADVPL_get_property(l_form_reference,"ZOOM_BUTTON_REFERENCE","item","cod_item")




Expandir
titleGET ZOOM_BUTTON_REFERENCE

Método GET: ZOOM_BUTTON_REFERENCE

Referência do componente do botão de zoom de um determinado campo do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"ZOOM_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> Referência


Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR

Referência do formulário.

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

Retorno



Tipo

Descrição

CHAR

Referência do componente do botão de zoom de um campo do formulário.

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_zoom_button_reference = _ADVPL_get_property(l_form_reference,"ZOOM_BUTTON_REFERENCE","item","cod_item")





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.