Páginas filhas
  • LGX - LFormMetaData

Versões comparadas

Chave

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

...

Expandir
titleCOMPONENT_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árioSim
l_tableCHARNome da tabela da coluna do formulário que deseja saber se está habilitada ou não,Sim
l_columnCHARNome da coluna do formulário que deseja saber se está habilitada ou não,Sim
l_aliasCHARAlias da tabela com a coluna do formulário que deseja saber se está habilitada ou não,Não

Retorno



Tipo

Descrição

SMALLINTSe componente estiver habilitado (ENABLE), retornará TRUE, caso contrário FALSE.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_field_enabled = _ADVPL_get_property(l_form_reference,"COMPONENT_IS_ENABLE","item","cod_item")




Expandir
titleCONSTRUCTCOMPONENT_REFERENCETYPE

Método GET: 

CONSTRUCT

COMPONENT_

REFERENCE

TYPE

Retorna o tipo de componente definido para um campo

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 >,"COMPONENT_TYPE", < l_table >, < l_form_referencecolumn >,"CONSTRUCT_REFERENCE" [ l_alias ]) => CHARSMALLINT

Parâmetros



Nome

Tipo

Descrição

Obrigatório?

l_form_reference
CHAR
Referência do formulárioSim

Retorno

TipoDescrição
CHARReferência do filtro de pesquisa (LConstruct) utilizado na operação padrão de pesquisa do formulário.
l_tableCHARNome da tabela da coluna do formulário,Sim
l_columnCHARNome da coluna do formulário,Sim
l_aliasCHARAlias da tabela com a coluna do formulário,Não

Retorno



Tipo

Descrição

CHARTipo do componente utilizado no formulário para o campo informado.

Exemplo



Bloco de código

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_constructcomponent_referencetype = _ADVPL_get_property(l_form_reference,"CONSTRUCT_REFERENCECOMPONENT_TYPE","item","cod_item")




Expandir
titleCURRENTCONSTRUCT_OPERATIONREFERENCE

Método GET: 

CURRENT

CONSTRUCT_

OPERATION

REFERENCE

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

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



TipoDescrição
CHAR
Nome da operação que está em execução, conforme cadastrado no programa "FRM1001 - Barra de Ferramentas"
Referência do filtro de pesquisa (LConstruct) utilizado na operação padrão de pesquisa do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_currentconstruct_operationreference = _ADVPL_get_property(l_form_reference,"CURRENTCONSTRUCT_OPERATIONREFERENCE")




Expandir
titleEXECUTECURRENT_OPERATION

Método GET:

EXECUTE

 CURRENT_

OPERATION 

OPERATION

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

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 >,"EXECUTECURRENT_OPERATION OPERATION") => SMALLINTCHAR

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



TipoDescrição
SMALLINT
CHAR
Caso a operação foi executado com sucesso retornará TRUE, caso contrário retornará FALSE
Nome da operação que está em execução, conforme cadastrado no programa "FRM1001 - Barra de Ferramentas".

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_wherecurrent_clauseoperation = "item.cod_empresa = '01'"
LET l_status = _ADVPL_get_property(l_form_reference,"EXECUTECURRENT_OPERATION","find",l_where_clause)




Descrição
Expandir
titleGROUP_REFERENCE ou CONTAINER_REFERENCEEXECUTE_OPERATION

Método GET:

 GROUP

EXECUTE_

REFERENCE

OPERATION 

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

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 >,"GROUPEXECUTE_REFERENCEOPERATION") => CHARSMALLINT

Parâmetros



Tipo
NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim

Retorno

l_operation
CHAR
Referência do componente de um grupo de componentes do formulário.

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_group_reference = _ADVPL_get_property(l_form_reference,"GROUP_REFERENCE","item","cod_item")

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



TipoDescrição
SMALLINTCaso a operação foi executado com sucesso retornará TRUE, caso contrário retornará FALSE.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_where_clause = "item.cod_empresa = '01'"
LET l_status = _ADVPL_get_property(l_form_reference,"EXECUTE_OPERATION","find",l_where_clause)




Retorno

Referência do componente de descrição de um campo
Expandir
titleFORM_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



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



TipoDescrição
CHARNome
Expandir
titleLABEL_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

NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim
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
TipoDescrição
CHAR
do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_labelform_referencename = _ADVPL_get_property(l_form_reference,"LABEL_REFERENCE","item","cod_item"FORM_NAME")




Retorno

Expandir
titleMENUGROUP_BUTTONREFERENCE ou CONTAINER_REFERENCE

Método GET: 

MENU_BUTTON

GROUP_REFERENCE

ou GET: CONTAINER_REFERENCE

Referência de um botão da barra de ferramentas do componente do grupo de componentes de determinado campo do formulário.

Sintaxe



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

Parâmetros



l_operation
NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim

Retorno



TipoDescriçã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
TipoDescrição
CHARReferência de um botão da barra de ferramentas (LMenuButton) correspondente à operação informada como parâmetro.
Referência do componente de um grupo de componentes do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_menubuttongroup_reference = _ADVPL_get_property(l_form_reference,"MENUGROUP_BUTTON_REFERENCE","item","createcod_item")




Expandir
titleMENUBARLABEL_REFERENCE

Método GET: 

MENUBAR

LABEL_REFERENCE

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
Retorno
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
Tipo
Descrição
CHARReferência
da barra de ferramentas (LMenuBar)
do componente de descrição de um campo do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_menubarlabel_reference = _ADVPL_get_property(l_form_reference,"MENUBARLABEL_REFERENCE","item","cod_item")




Expandir
titleSTATUSMENU_BARBUTTON_REFERENCE

Método GET: 

STATUS

MENU_

BAR

BUTTON_REFERENCE

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_operationCHARNome da operação, cadastrada no programa "FRM0001 - Barra de Ferramentas", do formulário da qual deseja-se retornar a referência.Sim

Retorno



TipoDescrição
CHARReferência de um botão da barra de
status do formulário
ferramentas (
LStatusBar)
LMenuButton) correspondente à operação informada como parâmetro.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_menubarmenubutton_reference = _ADVPL_get_property(l_form_reference,"STATUSMENU_BARBUTTON_REFERENCE","create")




Retorno

Expandir
titleTABLEMENUBAR_REFERENCE

Método GET: 

TABLE

MENUBAR_REFERENCE

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

Sintaxe



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

Parâmetros



l_table
NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim

Retorno



TipoDescrição
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
TipoDescrição
CHARReferência do componente grid de uma tabela do formulário.
Referência da barra de ferramentas (LMenuBar) do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumbers

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_tablemenubar_reference = _ADVPL_get_property(l_form_reference,"TABLEMENUBAR_REFERENCE","item_man")




Retorno

Expandir
titleVALUESTATUS_BAR_REFERENCE

Método GET: 

VALUE

STATUS_BAR_REFERENCE

Referência da barra de status 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_line ], [ l_alias ]) => VALUE

Parâmetros

STATUS_BAR_REFERENCE") => CHAR

Parâmetros



l_form_l_table
NomeTipoDescriçãoObrigatório?
l_form_
NomeTipoDescriçãoObrigatório?
reference
CHAR
Referência do formulário.Sim

Retorno



TipoDescrição
CHAR
Tabela
Referência 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_line
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
TipoDescrição
VALUEValor de um determinado campo do formulário.
barra de status do formulário (LStatusBar).

Exemplo



Bloco de código
languageruby
themeConfluence
linenumbers

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_menubar_valuereference = _ADVPL_get_property(l_form_reference,"VALUE","item","cod_itemSTATUS_BAR_REFERENCE")




Expandir
titleZOOM_BUTTONTABLE_REFERENCE

Método GET: 

ZOOM_BUTTON

TABLE_REFERENCE

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

Sintaxe



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

Parâmetros



column
NomeTipoDescriçãoObrigató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 zoomgrid.Sim
l_
CHAR
Nome da coluna do formulário da qual deseja-se recuperar a referência do botão de zoom.Siml_alias
CHAR
Alias da tabela com a coluna do formulário da qual deseja-se recuperar a referência do botão de zoomgrid.Não

Retorno



TipoDescrição
CHARReferência do componente
do botão de zoom de um campo
grid de uma tabela do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_zoom_buttontable_reference = _ADVPL_get_property(l_form_reference,"ZOOM_BUTTONTABLE_REFERENCE","item","cod_itemman")




Expandir
titleZOOM_REFERENCEVALUE

Método GET: 

ZOOM_REFERENCE

VALUE

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

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"ZOOM_REFERENCEVALUE", < l_table >, < l_column>, [ l_line ], [ l_alias ]) => CHARVALUE

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_table
CHAR
Nome da tabela Tabela da coluna do formulário da qual deseja-se recuperar a referência do zoomretornar o valor.Sim
l_column
CHAR
Coluna do formulário da qual deseja-se retornar o valor.Sim
l_line
INTEGER
Linha do grid Nome da coluna do formulário da qual deseja-se recuperar a referência do zoomretornar o valor.SimNão
l_alias
CHAR
Alias da tabela com a coluna do formulário da qual deseja-se recuperar a referência do zoomretornar o valor.Não

Retorno



TipoDescrição
CHAR
VALUE
Referência do zoom
Valor de um determinado campo do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_zoom_referencevalue = _ADVPL_get_property(l_form_reference,"ZOOM_REFERENCEVALUE","item","cod_item")

...

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




(informação) Para ativar ou desativar um formulário, deverá ter executado previamente o método "FORM" ou "INIT_FORM" para o mesmo.

Expandir
titleACTIVATEZOOM_BUTTON_REFERENCE

Método

SET

GET: 

ACTIVATE

ZOOM_BUTTON_REFERENCE

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

Sintaxe



Bloco de código
CALL _ADVPL_setget_property(< l_form_reference >,"ACTIVATEZOOM_BUTTON_REFERENCE", < l_statustable >, [ l_alias ]) => CHAR

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_
status
table
SMALLINT

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

   TRUE - Ativa o formulário

   FALSE - Desativa/Fecha o formulário.

Sim
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



TipoDescrição
CHARReferência do componente do botão de zoom de um campo do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALLLET l_zoom_button_reference = _ADVPL_setget_property(l_form_reference,"ZOOM_BUTTON_REFERENCE","ACTIVATEitem",TRUE"cod_item")




Expandir
titleBROWSEZOOM_VALUEREFERENCE

Método

SET

GET

BROWSE

ZOOM_

VALUE

REFERENCE

Referência do zoom de um determinado campo

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

Sintaxe



Bloco de código
_ADVPL_setget_property(< l_form_reference >,"BROWSEZOOM_VALUEREFERENCE", < l_table >, < l_column >, < l_line >, < l_value >, [ l_alias ]) => CHAR

Parâmetros



lineINTEGER
NomeTipoDescriçãoObrigató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 alteradodeseja-se recuperar a referência do zoom.Sim
l_column
CHAR
Nome da coluna do formulário da qual terá o alteradodeseja-se recuperar a referência do zoom.Sim
l_alias
CHAR
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
Alias da tabela com a coluna do formulário da qual deseja-se recuperar a referência do zoom.Não

Retorno



TipoDescrição
CHARReferência do zoom de determinado campo do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_browsezoom_countreference = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count    
  LET l_cod_item = _ADVPL_get_property(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
titleACTIVATE

Método SET: ACTIVATE

Inicia ou finaliza o formulário.

Sintaxe



Bloco de código
CALL _ADVPL_set_property(< l_form_reference >,"BROWSE_VALUEACTIVATE","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
titleCONTAINER_COLUMNS_COUNT
 < 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
titleBROWSE_VALUE

Método SET: BROWSE_VALUE

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

Método SET: CONTAINER_COLUMNS_COUNT

Inicia ou finaliza o formulário.

Sintaxe



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

Parâmetros

table >, < l_column >, < l_line >, < l_value >, [ l_alias ])

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_
columns
table
SMALLINT

Quantidade máxima de colunas que irá definir o agrupamento dos grupos de componentes do formulário.

Sim

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

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_line
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
languageruby
themeConfluence
linenumberstrue
CALLLET l_ADVPL_set_browse_count = _ADVPL_get_property(l_form_reference,"CONTAINERBROWSE_COLUMNSITEM_COUNT",2)
Expandir
titleDETAIL_WHERE_CLAUSE

Método SET: DETAIL_WHERE_CLAUSE

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

Sintaxe

Bloco de código
_ADVPL_set_property(< )

FOR l_ind = 1 TO l_browse_count    
  LET l_cod_item = _ADVPL_get_property(l_form_reference >,"DETAIL_WHERE_CLAUSE", <BROWSE_VALUE","item","cod_item",l_ind)    
  LET l_whereden_clauseitem >, <l_table >, [ l_alias ])

Parâmetros

NomeTipoDescriçãoObrigatório?l_form_reference
CHAR
Referência do formulário.Siml_where_clause
CHAR
Filtro de pesquisa SQL para ser utilizado na operação de pesquisa padrão do formulário.Siml_table
CHAR
Nome da tabela da qual será definido o filtro.Siml_alias
CHAR
Alias da tabela da qual será definido o filtro.Não
= 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
titleCONTAINER_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



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
l_columnsSMALLINT

Quantidade máxima de colunas que irá definir o agrupamento dos grupos de componentes do formulário.

Sim

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


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"CONTAINER_COLUMNS_COUNT",2)




Expandir
titleDETAIL_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



NomeTipoDescriçãoObrigató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

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

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
##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
titleENABLE_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



NomeTipoDescriçãoObrigató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.

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

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

Não

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue

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

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
##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,"DETAILENABLE_WHERE_CLAUSECOMPONENTS",l_where_clauseTRUE,"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'
update")

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




Expandir
titleENABLE_VALID_FOREIGN_COMPONENTSKEY

Método SET: ENABLE

_COMPONENTS

_VALID_FOREIGN_KEY

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

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_COMPONENTSVALID_FOREIGN_KEY", < l_status >, [ l_operationtable ], [ l_alias ])

Parâmetros



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.

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

   (ideia) Quando não for informado, será considerada valor FALSE por padrão
NomeTipoDescriçãoObrigató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.

(informação) 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
NomeTipoDescriçãoObrigató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
.Não


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
Confluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ENABLE_COMPONENTS",TRUE,"update")

CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_FOREIGN_COMPONENTSKEY",FALSE,TRUE"item")




Expandir
titleENABLE_VALID_FOREIGNNOT_KEYNULL

Método SET: ENABLE_VALID_

FOREIGN

NOT_

KEY

NULL

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigató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 campos obrigatório de uma ou mais tabelas do formulário.

TRUE - Habilitar validação de chaves estrangeirascampos obrigatórios.

FALSE - Desabilitar validação de chaves estrangeirasDesabilitar 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 chaves estrangeirascampos obrigatórios.

(informação) Quando não for informar informada a tabela, todas as tabelas do formulário serão afetadasconsideradas. 

Não
l_alias
CHAR
Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves estrangeirascampos obrigatórios.Não

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_FOREIGNNOT_KEYNULL",FALSE,"item")




Expandir
titleENABLE_VALID_NOTPRIMARY_NULLKEY

Método SET: ENABLE_VALID_

NOT

PRIMARY_

NULL

KEY

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigató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 chave primária de uma ou mais tabelas do formulário.

TRUE - Habilitar validação de campos obrigatórioschaves primárias.

FALSE - Desabilitar validação de campos obrigatóriosDesabilitar 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 campos obrigatórioschaves primárias.

(informação) Quando não for informada informar a tabela, todas as tabelas do formulário serão consideradasafetadas. 

Não
l_alias
CHAR
Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de campos obrigatórioschaves primárias.Não

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_NOTPRIMARY_NULLKEY",FALSE,"item")




Expandir
titleENABLE_VALID_PRIMARY_KEYFORM

Método SET: 

ENABLE_VALID_PRIMARY_KEY

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 mesmoHabilita/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,"FORM", < l_form_statusname >, <l_4glRecord1>, [< l_table4glRecord2 ]>, [ l_alias ]..., <l_4GLrecordNz> )

Parâmetros



Não
NomeTipoDescriçãoObrigató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.

(informação) Quando não for informar a tabela, todas as tabelas do formulário serão afetadas. 

Não
TipoDescriçãoObrigató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
iconfalse
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).
Siml_alias
CHAR
Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves primárias.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"FORM","ENABLE_VALID_PRIMARY_KEYman10021",FALSE,"item"mr_item,ma_item_man)




Expandir
titleINIT_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



NomeTipoDescriçãoObrigató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
iconfalse
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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"INIT_FORM","man10021",mr_item,ma_item_man)




Expandir
titleORDER_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



NomeTipoDescriçãoObrigató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.

(informação) Quando não informado irá assumir automaticamente a ordenação como ASC.

Não

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ORDER_BY","item","cod_item","DESC")




Expandir
titleVALUE

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_line ], [ l_alias ])

Parâmetros



NomeTipoDescriçãoObrigató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_line
INTEGER
Linha do grid do formulário da qual terá o valor alteradoNã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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"VALUE","item","cod_empresa","50")




Expandir
titleWHERE_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



NomeTipoDescriçãoObrigató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

(informação) Este filtro será utilizado no filtro WHERE do SQL padrão do metadado.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
#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
titleZOOM_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



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ZOOM_NAME","zoom_item_man","item","cod_item")

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'





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
languageruby
themeConfluence
linenumberstrue
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

...