Histórico da Página
Pagetitle | ||||
---|---|---|---|---|
|
Atualmente estes formulários são cadastrados utilizando o programa "FRM0003 - FORMULÁRIOS DE PARÂMETROS/PROCESSAMENTO".
Métodos GET
Métodos acessíveis utilizando a função _ADVPL_get_property,
que permite recuperar e manipular os valores do componente:
Expandir | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método GET: COMPONENT_REFERENCEReferência do componente de um determinado campo do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: CURRENT_OPERATIONOperação em execução. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método GET: EXECUTE_OPERATIONExecuta uma determinada operação do formulário, conforme cadastrada no programa "FRM0001 - Barra de Ferramentas". Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: INFORMEDVerificação se os parâmetros do formulário já foram informados ou não no formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método GET: ITEM_COUNTQuantidade de linhas de um determinado multivalorado do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método GET: LABEL_REFERENCEReferência do componente da descrição de um determinado campo do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método GET: MENU_BUTTON_REFERENCEReferência de um botão da barra de ferramentas do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: MENUBAR_REFERENCEReferência da barra de ferramentas do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método GET: MULTI_VALUED_BUTTON_REFERENCEReferência do componente do botão de multivalorado de um determinado campo do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método GET: MULTI_VALUED_COLUMN_REFERENCEReferência de uma determinada coluna do componente grid do multivalorado em execução no formulário. Sintaxe
Parâmetros
Retorno
Importante: caso não tenha nenhum multivalorado em execução, este método irá retornar nulo. Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: MULTI_VALUED_TABLE_REFERENCEReferência do componente grid do multivalorado em execução no formulário. Sintaxe
Parâmetros
Retorno
Importante: caso não tenha nenhum multivalorado em execução, este método irá retornar nulo. Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: PROGRESS_BAR_REFERENCEReferência da barra de progresso utilizada na operação de processamento do formulário. Sintaxe
Parâmetros
Retorno
Importante: este método deve ser chamado somente na função da operação padrão process do formulário. Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: STATUS_BAR_REFERENCEReferência da barra de status do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método GET: ZOOM_BUTTON_REFERENCEReferência do componente do botão de zoom de um determinado campo do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Expandir | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método GET: ZOOM_REFERENCEReferência do zoom de um determinado campo do formulário. Sintaxe
Parâmetros
Retorno
Exemplo
|
Métodos SET
Métodos acessíveis utilizando a função _ADVPL_set_property
que permite alterar e manipular os valores do componente.
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: ACTIVATEAtiva/Desativa a janela da aplicação. Sintaxe
Parâmetros
Para Importante: para ativar ou desativar um formulário, deverá ter executado previamente o método "FORMPARAMETER" ou "INIT_FORMPARAMETER" para o mesmo. Exemplo
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET:CENTERCentraliza a janela da aplicação na área de trabalho do usuárioENABLE_VALID_DUPLICATE_VALUESHabilita/desabilita a validação de valores duplicados no(s) multivalorado(s) do formulário. Sintaxe
Parâmetros
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
|
Expandir | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET:CENTEREDINFORMEDDefine se a tela abrirá no centro da área de trabalho.Força a definição da verificação se os parâmetros do formulário já foram informados ou não no formulário. Utilizados em casos e que o formulário é carregado manualmente. Sintaxe
Parâmetros
Exemplo
|
Expandir | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Método SET:ENABLEINIT_ESC_CLOSEDefine se habilita o encerramento da janela com a tecla ESCPARAMETERJunção dos métodos "PARAMETER" e "ACTIVATE", carrega as informações do formulário e executa-o em seguida. Sintaxe
Parâmetros
| |||||||||||||||||||||||||
Expandir | |||||||||||||||||||||||||
|
Bloco de código |
---|
_ADVPL_set_property(< l_form_reference >,"FORM_INFO",< informação >) |
Parâmetros
l_form_reference
CHAR
informação
CHAR
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"FORM_INFO","Formulário de manutenção de usuário Logix.") |
title | SET 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
l_form_reference
CHAR
informação
CHAR
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"FORM_MODIFICATION","01") |
title | SET 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
l_form_name
CHAR
formulário
CHAR
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_name,"FORM_NAME","LOG5500") |
title | SET 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
l_form_reference
CHAR
release
CHAR
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"FORM_RELEASE","02") |
title | SET 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
l_form_reference
CHAR
versao
CHAR
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"FORM_VERSION","10") |
title | SET 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
l_form_reference
CHAR
CHAR
RECORD | Variável RECORD que irá controlar o conteúdo dos campos monovalorados do formulário. | Sim | |
Array of Record | ARRAY OF RECORD | Variável ARRAY OF RECORD que irá controlar o conteúdo dos campos multivalorados do formulário. | Sim |
Importante: para ativar ou desativar um formulário, deverá ter executado previamente o método "PARAMETER" ou "INIT_PARAMETER" para o mesmo.
Exemplo
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
DATABASE logix GLOBALS
DEFINE p_user
LIKE usuarios.cod_usuario
DEFINE p_cod_empresa LIKE empresa.cod_empresa END GLOBALS DEFINE mr_tela
RECORD
cod_empresa LIKE empresa.cod_empresa,
den_empresa LIKE empresa.den_empresa
END RECORD DEFINE ma_tela
ARRAY[100] OF
RECORD
cod_item LIKE item.cod_item,
den_item LIKE item.den_item
END RECORD DEFINE m_form_reference
VARCHAR(100)
#--------------------#
FUNCTION man100220()
#--------------------#
# Verifica o acesso do usuário conforme módulo do programa.
IF LOG_initApp("PADRAO") <> 0 THEN
RETURN
END IF
INITIALIZE mr_tela.*, ma_tela TO NULL
LET l_form_reference = _ADVPL_create_component(NULL,"LPARMETADATA")
CALL _ADVPL_set_property(l_form_reference,"INIT_PARAMETER","man100220",mr_tela,ma_tela)
END FUNCTION
|
Expandir | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método SET: ITEM_COUNTQuantidade de linhas de um determinado multivalorado do formulário |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"HOTKEY","CTRL-I","Incluir um novo registro.",l_menubutton_reference,FALSE) |
title | SET 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
l_form_reference
CHAR
função
CHAR
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.
title | SET MAXIMIZED |
---|
Método SET: MAXIMIZED
Define se a tela abrirá maximizada.
Sintaxe
Bloco de código |
---|
_ADVPL_set_property(< l_form_reference_form_reference >,"ITEM_COUNT", < Associação >,"MAXIMIZED", < statusQuantidade >) |
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
l_form_reference |
| Referência do formulário. | Sim |
Associação |
| Nome da associação do multivalorado do formulário. | Sim |
status Quantidade | BOOLEAN INTEGER | Indicador que define se a janela abrirá maximizadaNúmero de linhas que será atribuído para um determinado multivalorado do formulário. | 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 caso o multivalorado possua apenas um campo e não possua associação, deverá ser passado no primeiro parâmetro o nome do campo multivalorado.
Exemplo
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"MAXIMIZED",FALSE) |
title | SET TITLE |
---|
| ||||||
CALL |
Método SET: MAXIMIZED
Título da janela.
Sintaxe
Bloco de código |
---|
_ADVPL_set_property(< l_form_reference >,"ITEM_COUNT"," TITLE item",< título>10) |
Expandir | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
Método SET: PARAMETERCarrega as informações do formulário, mas não o executa. Utilizado em casos em que é necessário carregar o formulário e após isso executar diretamente uma operação do mesmo. Sintaxe
| Tipo | Descrição | Obrigatório? | |||||||||||||||||||||||||||||
l_form_reference |
| Referência do formulário. | Sim | |||||||||||||||||||||||||||||
título |
| Título da janela. | Sim |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(< l_form_reference >,"TITLE","Central do Usuário") |
title | SET VALID |
---|
PARAMETER",< Formulário >, [ Record ], [ Array of Record ]) |
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
l_fFormulárioorm_reference |
| Referência do formulário. | Sim |
Formulário |
| Nome do formulário cadastrado no programa "FRM0003 - Formulários de Parâmetros/Processamento". | Sim |
Record | RECORD | Variável RECORD que irá controlar o conteúdo dos campos monovalorados do formulário. | Não |
Array of Record | ARRAY OF RECORD | Variável ARRAY OF RECORD que irá controlar o conteúdo dos campos multivalorados do formulário. | Não |
Importante: a ordem das variáveis deve ser sempre a mesma, independente do formulário ter ou não campos monovalorados ou multivalorados, primeiro o RECORD para os campos monovalorados e depois o ARRAY OF RECORD para os campos multivalorados.
Exemplo
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(l_form_reference,"PARAMETER","man10022",mr_tela,ma_tela) |
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
função
CHAR
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.