Pagetitle

	LFormMetaData
	LFormMetaData

Classe que permite executar um formulário metadado de cadastro, também chamado de modelo CRUD, que são registrados e mantidos através do programa FRM1002 (Formulário Metadado Cadastral).

Hierarquia

LCOMPONENT
- LMetadata
  - LFormMetadata

Métodos GET

Métodos acessíveis através da função _ADVPL_get_property que permite recuperar e manipular os valores do componente:

Expandir

title	BROWSE_ITEM_COUNT

Método GET: BROWSE_ITEM_COUNT

Quantidade de registros encontrados na operação 'Listar' do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"BROWSE_ITEM_COUNT") => INTEGER

Parâmetros

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

Retorno

Tipo	Descrição
`INTEGER`	Quantidade de registros encontrados na operação 'Listar' do formulário.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_browse_count = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count 
   LET l_cod_item = _ADVPL_get_property(l_form_reference,"BROWSE_VALUE","item","cod_item",l_ind) 
   LET l_den_item = man10021_get_den_item(l_cod_item) 
   CALL _ADVPL_set_property(l_form_reference,"BROWSE_VALUE","item","den_item",l_ind,l_den_item)
END FOR

Expandir

title	BROWSE_VALUE

Método GET: BROWSE_VALUE

Valor de uma determinada linha e coluna da operação 'Listar' do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"BROWSE_VALUE", < l_table >, < l_column >, < l_row >, [ l_alias ]) => VALUE

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual deseja-se retornar o valor,	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual deseja-se retornar o valor.---	Sim
`l_row`	`INTEGER`	Número da linha do grid da operação 'Listar' da qual deseja-se retornar o valor.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual deseja-se retornar o valor.	Não

Retorno

Tipo	Descrição
`VALUE`	Valor de determinada linha e coluna da grid da operação 'Listar' do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_browse_count = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count 
   LET l_cod_item = _ADVPL_get_property(l_form_reference,"BROWSE_VALUE","item","cod_item",l_ind) 
   LET l_den_item = man10021_get_den_item(l_cod_item) 
   CALL _ADVPL_set_property(l_form_reference,"BROWSE_VALUE","item","den_item",l_ind,l_den_item)
END FOR

Expandir

title	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", < l_table >, < l_column >, [ l_alias ]) => CHAR

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual deseja-se retornar o valor,	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual deseja-se retornar o valor.---	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual deseja-se retornar o valor.	Não

Retorno

Tipo	Descrição
`CHAR`	Referência do componente de um campo do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

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

Expandir

title	COMPONENT_IS_ENABLE

Método GET: COMPONENT_IS_ENABLE

Identifica quando um campo do formulário está habilitado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"COMPONENT_IS_ENABLE", < l_table >, < l_column >, [ l_alias ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário que deseja saber se está habilitada ou não,	Sim
`l_column`	`CHAR`	Nome da coluna do formulário que deseja saber se está habilitada ou não,	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário que deseja saber se está habilitada ou não,	Não

Retorno

Tipo	Descrição
`SMALLINT`	Se componente estiver habilitado (ENABLE), retornará TRUE, caso contrário FALSE.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_field_enabled = _ADVPL_get_property(l_form_reference,"COMPONENT_IS_ENABLE","item","cod_item")

Expandir

title	COMPONENT_TYPE

Método GET: COMPONENT_TYPE

Retorna o tipo de componente definido para um campo do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"COMPONENT_TYPE", < l_table >, < l_column >, [ l_alias ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário,	Sim
`l_column`	`CHAR`	Nome da coluna do formulário,	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário,	Não

Retorno

Tipo	Descrição
`CHAR`	Tipo do componente utilizado no formulário para o campo informado.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_component_type = _ADVPL_get_property(l_form_reference,"COMPONENT_TYPE","item","cod_item")

Expandir

title	CONSTRUCT_REFERENCE

Método GET: CONSTRUCT_REFERENCE

Referência do filtro de consulta utilizado na operação de pesquisa do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONSTRUCT_REFERENCE") => CHAR

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 filtro de pesquisa (LConstruct) utilizado na operação padrão de pesquisa do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_construct_reference = _ADVPL_get_property(l_form_reference,"CONSTRUCT_REFERENCE")

Expandir

title	CURRENT_OPERATION

Método GET: CURRENT_OPERATION

Operação atual em execução no formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CURRENT_OPERATION") => CHAR

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 cadastrado no programa "FRM1001 - Barra de Ferramentas".

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_current_operation = _ADVPL_get_property(l_form_reference,"CURRENT_OPERATION")

Expandir

title	EXECUTE_OPERATION

Método GET: EXECUTE_OPERATION

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"EXECUTE_OPERATION") => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_operation`	`CHAR`	Nome da operação do formulário que deseja-se executar, conforme cadastrado no programa "FRM1001 - Barra de Ferramentas".	Sim
`l_where_clause`	`CHAR`	Filtro SQL a ser utilizado caso o parâmetro OPERATION seja pesquisa (FIND), modificação (UPDATE) ou exclusão (DELETE).	Não

Retorno

Tipo	Descrição
SMALLINT	Caso a operação foi executado com sucesso retornará TRUE, caso contrário retornará FALSE. Para a operação FIND, TRUE indica que encontrou registro na pesquisa e FALSE não encontrou registro ou acusou algum erro na pesquisa.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_where_clause = "item.cod_empresa = '01'"
LET l_status = _ADVPL_get_property(l_form_reference,"EXECUTE_OPERATION","find",l_where_clause)

Expandir

title	FORM_NAME

Método GET: FORM_NAME

Nome do formulário

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_NAME") => CHAR

Parâmetros

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

Retorno

Tipo	Descrição
`CHAR`	Nome do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_form_name = _ADVPL_get_property(l_form_reference,"FORM_NAME")

Expandir

title	GROUP_REFERENCE ou CONTAINER_REFERENCE

Método GET: GROUP_REFERENCE ou GET: CONTAINER_REFERENCE

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"GROUP_REFERENCE") => CHAR

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 de um grupo de componentes do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_group_reference = _ADVPL_get_property(l_form_reference,"GROUP_REFERENCE","item","cod_item")

Expandir

title	LABEL_REFERENCE

Método GET: LABEL_REFERENCE

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"LABEL_REFERENCE") => CHAR

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência da descrição.	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual deseja-se recuperar a referência da descrição.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual deseja-se recuperar a referência da descrição.	Não

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

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

Expandir

title	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", < l_operation > ) => CHAR

Parâmetros

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

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

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

Expandir

title	MENUBAR_REFERENCE

Método GET: MENUBAR_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 >,"MENUBAR_REFERENCE") => CHAR

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

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_menubar_reference = _ADVPL_get_property(l_form_reference,"MENUBAR_REFERENCE")

Expandir

title	STATUS_BAR_REFERENCE

Método GET: STATUS_BAR_REFERENCE

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"STATUS_BAR_REFERENCE") => CHAR

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 (LStatusBar).

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_menubar_reference = _ADVPL_get_property(l_form_reference,"STATUS_BAR_REFERENCE")

Expandir

title	TABLE_REFERENCE

Método GET: TABLE_REFERENCE

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"TABLE_REFERENCE", < l_table >, [ l_alias ]) => CHAR

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Nome da tabela do formulário da qual deseja-se recuperar a referência do grid.	Sim
`l_alias`	`CHAR`	Alias da tabela do formulário da qual deseja-se recuperar a referência do grid.	Não

Retorno

Tipo	Descrição
`CHAR`	Referência do componente grid de uma tabela do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_table_reference = _ADVPL_get_property(l_form_reference,"TABLE_REFERENCE","item_man")

Expandir

title	VALUE

Método GET: VALUE

Valor de um determinado campo do formulário.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"VALUE", < l_table >, < l_column>, [ l_row ], [ l_alias ]) => VALUE

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Tabela da coluna do formulário da qual deseja-se retornar o valor.	Sim
`l_column`	`CHAR`	Coluna do formulário da qual deseja-se retornar o valor.	Sim
`l_row`	`INTEGER`	Linha do grid do formulário da qual deseja-se retornar o valor.	Não
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual deseja-se retornar o valor.	Não

Retorno

Tipo	Descrição
`VALUE`	Valor de um determinado campo do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_value = _ADVPL_get_property(l_form_reference,"VALUE","item","cod_item")

Expandir

title	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", < l_table >, [ l_alias ]) => CHAR

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual deseja-se recuperar a referência do botão de zoom.	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual deseja-se recuperar a referência do botão de zoom.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual deseja-se recuperar a referência do botão de zoom.	Não

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

language	ruby
theme	Confluence
linenumbers	true

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

Expandir

title	ZOOM_REFERENCE

Método GET: ZOOM_REFERENCE

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

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ZOOM_REFERENCE", < l_table >, [ l_alias ]) => CHAR

Parâmetros

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

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_zoom_reference = _ADVPL_get_property(l_form_reference,"ZOOM_REFERENCE","item","cod_item")

Métodos SET

Métodos acessíveis através da função _ADVPL_set_property que permite alterar e manipular os valores do componente.

Expandir

title	ACTIVATE

Método SET: ACTIVATE

Inicia ou finaliza o formulário.

Sintaxe

Bloco de código
CALL _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

SMALLINT

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

TRUE - Ativa o formulário

FALSE - Desativa/Fecha o formulário.

Sim

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

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)

Expandir

title	BROWSE_VALUE

Método SET: BROWSE_VALUE

Atribui valor para uma determinada linha e coluna da operação 'Listar' do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"BROWSE_VALUE", < l_table >, < l_column >, < l_row >, < l_value >, [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual terá o valor alterado.	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual terá o alterado.	Sim
`l_row`	`INTEGER`	Número da linha do grid</span> da operação 'Listar' da qual terá o valor alterado.	Sim
`l_value`	`CHAR`	Valor a ser atribuído para a coluna da grid</span> da operação Listar do formulário.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual terá o valor alterado.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_browse_count = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count    
  LET l_cod_item = _ADVPL_get_property(l_form_reference,"BROWSE_VALUE","item","cod_item",l_ind)    
  LET l_den_item = man10021_get_den_item(l_cod_item)        
  CALL _ADVPL_set_property(l_form_reference,"BROWSE_VALUE","item","den_item",l_ind,l_den_item)
END FOR

Expandir

title	CONTAINER_COLUMNS_COUNT

Método SET: CONTAINER_COLUMNS_COUNT

Inicia ou finaliza o formulário.

Sintaxe

Bloco de código
CALL _ADVPL_set_property(< l_form_reference >,"CONTAINER_COLUMNS_COUNT", < l_columns >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_columns`	`SMALLINT`	Quantidade máxima de colunas que irá definir o agrupamento dos grupos de componentes do formulário.	Sim

Este método deve sempre ser chamado uma única vez na função de 'Before Load' do formulário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"CONTAINER_COLUMNS_COUNT",2)

Expandir

title	DETAIL_WHERE_CLAUSE

Método SET: DETAIL_WHERE_CLAUSE

Filtro de consulta padrão para uma tabela de detalhe. Este filtro será utilizado para cada pesquisa que o usuário executar.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"DETAIL_WHERE_CLAUSE", < l_where_clause >, <l_table >, [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_where_clause`	`CHAR`	Filtro de pesquisa SQL para ser utilizado na operação de pesquisa padrão do formulário.	Sim
`l_table`	`CHAR`	Nome da tabela da qual será definido o filtro.	Sim
`l_alias`	`CHAR`	Alias da tabela da qual será definido o filtro.	Não

Este filtro será utilizado dentro das cláusulas de junção das tabelas no SQL.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

##Definir filtro para a tabela detalhe ITEM_MAN de cardinalidade N..0 que possui junção com uma tabela mestre ITEM
LET l_where_clause = "item_man.cod_item = '8575'"

CALL _ADVPL_set_property(l_form_reference,"DETAIL_WHERE_CLAUSE",l_where_clause,"item_man")

Neste exemplo acima, quando o usuário executar a pesquisa no formulário o filtro SQL será montado da seguinte forma:

 
  FROM item LEFT OUTER JOIN item_man 
         ON item_man.cod_empresa = item.cod_empresa 
        AND item_man.cod_item = item.cod_item
        AND item_man.cod_item = '8575'

Expandir

title	ENABLE_COMPONENTS

Método SET: ENABLE_COMPONENTS

Habilita/desabilita os campos em tela que estiverem registrados no formulário como Editável no cadastro de formulários cadastrais (FRM1002).

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ENABLE_COMPONENTS", < l_status >, [ l_operation ])

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário.

Sim

l_status

SMALLINT

Indicador que define se irá habilitar ou desabilitar os campos da tela para edição.

TRUE - Habilitar campos

FALSE - Desabilitar campos

Sim

l_operation

CHAR/SMALLINT

Quando STATUS (Parâmetro l_status) tiver valor TRUE este parâmetro deve indicar a operação que será utilizada para identificar os campos que devem ou não ser habilitados para edição em tela.

create - Inclusão de dados.
copy - Cópia de dados.
update - Modificação de dados. Não habilita os campos chave.

Se operação não for informada, será considerada a operação create por padrão.

Quando STATUS (Parâmetro l_status) tiver valor FALSE, este parâmetro indicará se para desabilitar a edição dos campos, continuará permitindo que o usuário permita acessar o conteúdo dos campos desabilitados para copiar seu conteúdo ou não.

TRUE - Permitirá copiar conteúdo do campo desabilitado.
FALSE - Não permitirá copiar conteúdo do campo desabilitado.

Quando não for informado, será considerada valor FALSE por padrão.

Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ENABLE_COMPONENTS",TRUE,"update")

CALL _ADVPL_set_property(l_form_reference,"ENABLE_COMPONENTS",FALSE,TRUE)

Expandir

title	ENABLE_VALID_FOREIGN_KEY

Método SET: ENABLE_VALID_FOREIGN_KEY

Habilita/desabilita a validação de chaves estrangeiras para determinada(s) tabelas do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_FOREIGN_KEY", < l_status >, [ l_table ], [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_status`	`SMALLINT`	Indicador que define se será habilitada ou desabilitada a validação de chaves estrangeiras de uma ou mais tabelas do formulário. TRUE - Habilitar validação de chaves estrangeiras. FALSE - Desabilitar validação de chaves estrangeiras.	Sim
`l_table`	`CHAR`	Nome da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves estrangeiras. Quando não for informar a tabela, todas as tabelas do formulário serão afetadas.	Não
`l_alias`	`CHAR`	Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves estrangeiras.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_FOREIGN_KEY",FALSE,"item")

Expandir

title	ENABLE_VALID_NOT_NULL

Método SET: ENABLE_VALID_NOT_NULL

Habilita/desabilita a validação de campos obrigatório para determinada(s) tabelas do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_NOT_NULL", < l_status >, [ l_table ], [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_status`	`SMALLINT`	Indicador que define se será habilitada ou desabilitada a validação de campos obrigatório de uma ou mais tabelas do formulário. TRUE - Habilitar validação de campos obrigatórios. FALSE - Desabilitar validação de campos obrigatórios.	Sim
`l_table`	`CHAR`	Nome da tabela do formulário da qual deseja habilitar/desabilitar a validação de campos obrigatórios. Quando não for informada a tabela, todas as tabelas do formulário serão consideradas.	Não
`l_alias`	`CHAR`	Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de campos obrigatórios.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_NOT_NULL",FALSE,"item")

Expandir

title	ENABLE_VALID_PRIMARY_KEY

Método SET: ENABLE_VALID_PRIMARY_KEY

Habilita/desabilita a validação de chaves primárias para determinada(s) tabelas do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_FOREIGN_KEY", < l_status >, [ l_table ], [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_status`	`SMALLINT`	Indicador que define se será habilitada ou desabilitada a validação de chave primária de uma ou mais tabelas do formulário. TRUE - Habilitar validação de chaves primárias. FALSE - Desabilitar validação de chaves primárias.	Sim
`l_table`	`CHAR`	Nome da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves primárias. Quando não for informar a tabela, todas as tabelas do formulário serão afetadas.	Não
`l_alias`	`CHAR`	Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves primárias.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_PRIMARY_KEY",FALSE,"item")

Expandir

title	FORM

Método SET: FORM

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

Bloco de código
_ADVPL_set_property(< l_form_reference >,"FORM", < l_form_name >, <l_4glRecord1>, < l_4glRecord2 >, ..., <l_4GLrecordNz> )

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário de cadastro (FRM1002)

Sim

l_4glRecord (1,2,..,N)

4GL 
RECORD

Variáveis RECORD ou ARRAY OF RECORD, separadas por vírgula, que irão controlar o conteúdo do formulário, sendo que para cada tabela informada no formulário é necessário uma variável RECORD para tabelas do tipo mestre e ARRAY OF RECORD para as tabelas do tipo detalhe ou mestre-detalhe.

Dica

icon	false

A ordem das variáveis RECORD ou ARRAY OF RECORD deve obedecer a ordem informada no campo "Posição Record 4GL" no cadastro de formulários cadastrais (FRM0002).

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"FORM","man10021",mr_item,ma_item_man)

Expandir

title	GET_FOCUS

Método SET: GET_FOCUS

Forçar o foco do cursor para um determinado campo do formulário, sendo que este apenas obterá foco se permitido.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"GET_FOCUS", < l_table_alias >, < l_column >, [ l_row ], [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Nome da tabela no formulário.	Sim
`l_column`	`CHAR`	Nome da coluna no formulário.	Sim
`l_row`	`INTEGER`	Linha do grid do formulário para qual deseja forçar o foco.	Não
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário para qual deseja forçar o foco.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"GET_FOCUS","item","cod_item")

Expandir

title	HOTKEY

Método SET: HOTKEY

Define uma tecla de atalho para executar uma ação específica no formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"HOTKEY", < l_hotkey >, < l_function >, < l_description >)

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário de cadastro (FRM1002)

Sim

l_hotkey

CHAR

Tecla de atalho.

Informe o código numérico correspondente da tecla desejada ou então o nome da tecla que deve respeitar uma lista pré-definida de nomes previstos no metadado.

Expandir

title	Lista de teclas previstas no metadado

Image Modified

Sim

l_function

CHAR

Nome da função 4GL que será acionada ao invocar o atalho da tecla de atalho.

Sim

l_description

CHAR

Texto de descrição da tecla de atalho.

Nãao

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

 CALL _ADVPL_set_property(m_form, "HOTKEY", "CTRL-H", "xxx9999_funcao_especifica","Executa função específica")

Expandir

title	INIT_FORM

Método SET: INIT_FORM

Junção dos métodos "FORM" e "ACTIVATE" para carregar as informações do formulário e executá-lo em seguida.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"INIT_FORM", < l_form_name >, <l_4glRecord1>, < l_4glRecord2 >, ..., <l_4GLrecordNz> )

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário de cadastro (FRM1002)

Sim

l_4glRecord (1,2,..,N)

4GL 
RECORD

Variáveis RECORD ou ARRAY OF RECORD, separadas por vírgula, que irão controlar o conteúdo do formulário, sendo que para cada tabela informada no formulário é necessário uma variável RECORD para tabelas do tipo mestre e ARRAY OF RECORD para as tabelas do tipo detalhe ou mestre-detalhe.

Dica

icon	false

A ordem das variáveis RECORD ou ARRAY OF RECORD deve obedecer a ordem informada no campo "Posição Record 4GL" no cadastro de formulários cadastrais (FRM0002).

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"INIT_FORM","man10021",mr_item,ma_item_man)

Expandir

title	PROPERTY

Método SET: PROPERTY

Ajustar o valor de uma propriedade de um campo do formulário antes que ele seja carregado em memória (evento BEFORE_LOAD), para que ele passe a respeitar o valor da propriedade durante a carga da tela.

Esta ação somente é válida quando acionada no evento BEFORE_LOAD do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"PROPERTY", < l_property >, < l_value_property >, < l_table >, < l_column > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_property`	`CHAR`	Nome da propriedade do componente da coluna do formulário.	Sim
`l_value_property`	`CHAR`	Valor a ser atribuído para a propriedade informada.	Sim
`l_table`	`CHAR`	Nome da tabela no formulário.	Sim
`l_column`	`CHAR`	Nome da coluna no formulário.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

 CALL _ADVPL_set_property(m_form_reference,"PROPERTY","IS_VISIBLE",FALSE,"empresa","rastreada","a")

Expandir

title	ORDER_BY

Método SET: ORDER_BY

Ordem de consulta padrão para determinado(s) campos do formulário que será utilizada para toda pesquisa executada no formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ORDER_BY", < l_table_alias >, < l_column >, [ l_order ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table_alias`	`CHAR`	Nome da tabela OU alias. Ccaso a tabela tenha alias definido no formulário, deverá ser informado apenas o alias para definir a ordenação a ser utilizada na operação de pesquisa padrão do formulário.	Sim
`l_column`	`CHAR`	Nome da coluna da qual deseja definir a ordenação para ser utilizada na operação de pesquisa padrão do formulário.	Sim
`l_order`	`CHAR`	Ordenação da coluna a ser respeitada. ASC - ordenação crescente. DESC - ordenação decrescente. Quando não informado irá assumir automaticamente a ordenação como ASC.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ORDER_BY","item","cod_item","DESC")

Expandir

title	VALUE

Método SET: VALUE

Atribui valor para determinado campo do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"VALUE", < l_table>, < l_column >, < l_value >, [ l_row ], [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_table`	`CHAR`	Tabela da coluna do formulário da qual terá o valor alterado.	Sim
`l_column`	`CHAR`	Coluna do formulário da qual terá o alterado.	Sim
`l_value`	`-`	Qualquer valor a ser atribuído para a coluna do formulário, respeitando o tipo de dado.	Sim
`l_row`	`INTEGER`	Linha do grid do formulário da qual terá o valor alterado	Não
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual terá o valor alterado.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"VALUE","item","cod_empresa","50")

Expandir

title	WHERE_CLAUSE

Método SET: WHERE_CLAUSE

Filtro de consulta padrão para o formulário que será utilizado para toda pesquisa realizada.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"WHERE_CLAUSE", < l_where_clause >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_where_clause`	`CHAR`	Filtro de pesquisa SQL para ser utilizado na operação de pesquisa padrão do formulário.	Sim

Este filtro será utilizado no filtro WHERE do SQL padrão do metadado.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#Definir um filtro para uma tabela mestre (item):
LET l_where_clause = "item.cod_empresa = '50'"

CALL _ADVPL_set_property(l_form_reference,"WHERE_CLAUSE",l_where_clause)

Neste exemplo acima, quando o usuário executar a pesquisa, este filtro será montado da seguinte forma:


   FROM item WHERE item_man.cod_empresa = '50'

Expandir

title	REFRESH_COMPONENTS

Método SET: REFRESH_COMPONENTS

Força atualização da exibição de todos campos do formulário.

Sintaxe

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

Parâmetros

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

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"REFRESH_COMPONENTS")

Expandir

title	ZOOM_NAME

Método SET: ZOOM_NAME

Atribui valor para uma determinada linha e coluna da operação 'Listar' do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ZOOM_NAME", < l_zoom_name >, <l_table >, [ l_alias ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`l_zoom_name`	`CHAR`	Nome do novo zoom que será atribuído para o campo. Este zoom deve estar cadastrado no programa "FRM1008 - Zoom".	Sim
`l_table`	`CHAR`	Nome da tabela da coluna do formulário da qual terá o zoom alterado.	Sim
`l_column`	`CHAR`	Nome da coluna do formulário da qual terá o zoom alterado.	Sim
`l_alias`	`CHAR`	Alias da tabela com a coluna do formulário da qual terá o zoom alterado.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ZOOM_NAME","zoom_item_man","item","cod_item")

Sintaxe

Bloco de código
LET m_form_reference = _ADVPL_create_component(NULL,"LFORMMETADATA") CALL _ADVPL_set_property(m_form_reference,"INIT_FORM",<form_name>,<4GLrecord1>,<4GLrecord2>,...,<4GLrecordN>)

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

DATABASE logix 

GLOBALS     
	DEFINE p_user        LIKE usuarios.cod_usuario     
	DEFINE p_cod_empresa LIKE empresa.cod_empresa 
END GLOBALS 

DEFINE mr_item           RECORD LIKE item.* 

DEFINE ma_item_man       ARRAY[100] OF RECORD LIKE item_man.* 

DEFINE m_form_reference  VARCHAR(10)

#-------------------# 
 FUNCTION man10021()
#-------------------#     
	# Verifica permissão para o usuário conforme módulo do programa.     

	IF  LOG_initApp("PADRAO") <> 0 THEN         
		RETURN     
	END IF     

	INITIALIZE mr_item.*, ma_item_man TO NULL     
	LET m_form_reference = _ADVPL_create_component(NULL,"LFORMMETADATA")     
	CALL _ADVPL_set_property(m_form_reference,"INIT_FORM","man10021",mr_item,ma_item_man) 
END FUNCTION

Image Modified

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 32

Nova versão 33

Chave

Métodos GET

Método GET: BROWSE_ITEM_COUNT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: BROWSE_VALUE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_IS_ENABLE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_TYPE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CONSTRUCT_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CURRENT_OPERATION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: EXECUTE_OPERATION

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_NAME

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: GROUP_REFERENCE ou GET: CONTAINER_REFERENCE

Sintaxe

Parâmetros

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

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: TABLE_REFERENCE

Sintaxe

Parâmetros