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

L Form

Métodos GET

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

GET COMPONENT_REFERENCE

Método GET: COMPONENT_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"COMPONENT_REFERENCE", < Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência do componente.	Sim
Coluna	CHAR	Nome 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

LET l_component_reference = _ADVPL_get_property(l_form_reference,"COMPONENT_REFERENCE","item","cod_empresa")

GET CURRENT_OPERATION

Método GET: CURRENT_OPERATION

Operação em execução.

Sintaxe

_ADVPL_get_property(< l_form_reference >,"CURRENT_OPERATION") ==> Operação

Parâmetros

Nome	Tipo	Descrição	Obrigató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

LET l_current_operation = _ADVPL_get_property(l_form_reference,"CURRENT_OPERATION")

GET EXECUTE_OPERATION

Método GET: EXECUTE_OPERATION

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"EXECUTE_OPERATION", < Operação >) ==> Situação

Parâmetros

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

LET l_status = _ADVPL_get_property(l_form_reference,"EXECUTE_OPERATION","inform")

GET INFORMED

Método GET: INFORMED

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"INFORMED") ==> Já informou?

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 os parâmetros do formulário já foram informados ou não no formulário.

Exemplo

LET l_informed = _ADVPL_get_property(l_form_reference,"INFORMED")

GET ITEM_COUNT

Método GET: ITEM_COUNT

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"ITEM_COUNT",  < Associação >) ==> Quantidade

Parâmetros

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

LET l_item_count = _ADVPL_get_property(l_form_reference,"ITEM_COUNT","item")

GET LABEL_REFERENCE

Método GET: LABEL_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"LABEL_REFERENCE",  < Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência da descrição.	Sim
Coluna	CHAR	Nome 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

LET l_label_reference = _ADVPL_get_property(l_form_reference,"LABEL_REFERENCE","item","cod_empresa")

GET MENU_BUTTON_REFERENCE

Método GET: MENU_BUTTON_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"MENU_BUTTON_REFERENCE", < Operação >) ==> Referência

Parâmetros

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

LET l_menubutton_reference = _ADVPL_get_property(l_form_reference,"MENU_BUTTON_REFERENCE","inform")

GET MENUBAR_REFERENCE

Método GET: MENUBAR_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"MENUBAR_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigató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

LET l_menubar_reference = _ADVPL_get_property(l_form_reference,"MENUBAR_REFERENCE")

GET 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

_ADVPL_get_property(< l_form_reference >,"MULTI_VALUED_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência do botão de multivalorado.	Sim
Coluna	CHAR	Nome 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

LET l_zoom_button_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_BUTTON_REFERENCE","item","cod_item")

GET 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

_ADVPL_get_property(< l_form_reference >,"MULTI_VALUED_COLUMN_REFERENCE",< Coluna >) ==> Referência

Parâmetros

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

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

Exemplo

LET l_multivalued_column_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_COLUMN_REFERENCE","cod_item")

GET 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

_ADVPL_get_property(< l_form_reference >,"MULTI_VALUED_TABLE_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigató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.

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

Exemplo

LET l_multivalued_table_reference = _ADVPL_get_property(l_form_reference,"MULTI_VALUED_TABLE_REFERENCE")

GET 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

_ADVPL_get_property(< l_form_reference >,"PROGRESS_BAR_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigató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.

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

Exemplo

LET l_progressbar_reference = _ADVPL_get_property(l_form_reference,"PROGRESS_BAR_REFERENCE")

GET STATUS_BAR_REFERENCE

Método GET: STATUS_BAR_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"STATUS_BAR_REFERENCE") ==> Referência

Parâmetros

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

Retorno

Tipo	Descrição
CHAR	Referência da barra de status do formulário.

Exemplo

LET l_statusbar_reference = _ADVPL_get_property(l_form_reference,"STATUS_BAR_REFERENCE")

GET 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

_ADVPL_get_property(< l_form_reference >,"ZOOM_BUTTON_REFERENCE",< Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência do botão de zoom.	Sim
Coluna	CHAR	Nome 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

LET l_zoom_button_reference = _ADVPL_get_property(l_form_reference,"ZOOM_BUTTON_REFERENCE","item","cod_item")

GET ZOOM_REFERENCE

Método GET: ZOOM_REFERENCE

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

Sintaxe

_ADVPL_get_property(< l_form_reference >,"ZOOM_REFERENCE",< Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência do zoom.	Sim
Coluna	CHAR	Nome da coluna do formulário da qual deseja-se recuperar a referência do zoom.	Sim

Retorno

Tipo	Descrição
CHAR	Referência do zoom de determinado campo do formulário.

Exemplo

LET l_zoom_reference = _ADVPL_get_property(l_form_reference,"ZOOM_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.

SET ACTIVATE

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

BOOLEAN

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

TRUE - Ativa o formulário

FALSE - Desativa/Fecha o 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

CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)

SET ENABLE_VALID_DUPLICATE_VALUES

Método SET: ENABLE_VALID_DUPLICATE_VALUES

Habilita/desabilita a validação de valores duplicados no(s) multivalorado(s) do formulário.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_DUPLICATE_VALUES",< Habilita? >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
Habilita?	BOOLEAN	Indicador que define se será habilitada ou desabilitada a validação de valores duplicados no(s) multivalorado(s) do formulário.	Sim

Exemplo

CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_DUPLICATE_VALUES",FALSE)

SET INFORMED

Método SET: INFORMED

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

_ADVPL_set_property(< l_form_reference >,"INFORMED",< Já informou?>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
Já informou?	`BOOLEAN`	Indicador que força a definição de verificação se os parâmetros foram ou não informados no formulário.	Sim

Exemplo

CALL _ADVPL_set_property(l_form_reference,"INFORMED",TRUE)

SET INIT_PARAMETER

Método SET: INIT_PARAMETER

Junção dos métodos "PARAMETER" e "ACTIVATE", carrega as informações do formulário e executa-o em seguida.

Sintaxe

_ADVPL_set_property(< l_form_reference >,"INIT_PARAMETER",< Formulário >, [ Record ], [ Array of Record ])

Parâmetros

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

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

SET ITEM_COUNT

Método SET: ITEM_COUNT

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

Sintaxe

_ADVPL_set_property(< l_form_reference >,"ITEM_COUNT", < Associação >, < Quantidade >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
Associação	`CHAR`	Nome da associação do multivalorado do formulário.	Sim
Quantidade	INTEGER	Número de linhas que será atribuído para um determinado multivalorado do formulário.	Sim

Importante: 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

CALL _ADVPL_set_property(l_form_reference,"ITEM_COUNT","item",10)

SET PARAMETER

Método SET: PARAMETER

Carrega 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

_ADVPL_set_property(< l_form_reference >,"PARAMETER",< Formulário >, [ Record ], [ Array of Record ])

Parâmetros

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

CALL _ADVPL_set_property(l_form_reference,"PARAMETER","man10022",mr_tela,ma_tela)

Páginas filhas

LGX - LParMetaData

Hierarquia

Métodos GET

Método GET: COMPONENT_REFERENCE

Sintaxe

Parâmetros

Exemplo

Método GET: CURRENT_OPERATION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: EXECUTE_OPERATION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: INFORMED

Sintaxe

Retorno

Exemplo

Método GET: ITEM_COUNT

Sintaxe

Retorno

Exemplo

Método GET: LABEL_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MENU_BUTTON_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MENUBAR_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MULTI_VALUED_BUTTON_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: MULTI_VALUED_COLUMN_REFERENCE

Sintaxe

Parâmetros

Exemplo

Método GET: MULTI_VALUED_TABLE_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: PROGRESS_BAR_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: STATUS_BAR_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ZOOM_BUTTON_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ZOOM_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Métodos SET

Método SET: ACTIVATE

Sintaxe

Parâmetros

Exemplo