...
| Expandir |
|---|
|
Identifica quando um campo do formulário está habilitado.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"COMPONENT_IS_ENABLE", < l_table >, < l_column >, [ l_alias ]) => SMALLINT |
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 |
Tipo | Descrição |
|---|
SMALLINT | Se componente estiver habilitado (ENABLE), retornará TRUE, caso contrário FALSE. |
| 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 | CONSTRUCTCOMPONENT_REFERENCETYPE |
|---|
|
| CONSTRUCTREFERENCE Retorna o tipo de componente definido para um campo Referência do filtro de consulta utilizado na operação de pesquisa do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"COMPONENT_TYPE", < l_table >, < l_form_referencecolumn >,"CONSTRUCT_REFERENCE" [ l_alias ]) => CHARSMALLINT |
Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário | Sim |
|
| Tipo | Descrição |
|---|
CHAR | Referência do filtro de pesquisa (LConstruct) utilizado na operação padrão de pesquisa do formulário. |
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 |
Tipo | Descrição |
|---|
CHAR | Tipo do componente utilizado no formulário para o campo informado. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
LET l_constructcomponent_referencetype = _ADVPL_get_property(l_form_reference,"CONSTRUCT_REFERENCECOMPONENT_TYPE","item","cod_item") |
| Expandir |
|---|
| title | CURRENTCONSTRUCT_OPERATIONREFERENCE |
|---|
|
| CURRENTOPERATION Referência do filtro de consulta utilizado na operação de pesquisa do formulário Operação atual em execução no formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"CURRENTCONSTRUCT_OPERATIONREFERENCE") => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário | Sim |
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. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| LET l_currentconstruct_operationreference = _ADVPL_get_property(l_form_reference,"CURRENTCONSTRUCT_OPERATIONREFERENCE") |
|
| Expandir |
|---|
| title | EXECUTECURRENT_OPERATION |
|---|
|
| EXECUTEOPERATION 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".
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"EXECUTECURRENT_OPERATION OPERATION") => SMALLINTCHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário | Sim |
SMALLINTCaso 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". |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| LET l_wherecurrent_clauseoperation = "item.cod_empresa = '01'"
LET l_status = _ADVPL_get_property(l_form_reference,"EXECUTECURRENT_OPERATION","find",l_where_clause) |
|
| Expandir |
|---|
| title | GROUP_REFERENCE ou CONTAINER_REFERENCEEXECUTE_OPERATION |
|---|
|
| GROUPREFERENCE Executa uma determinada operação do formulário, conforme cadastrada no programa "FRM1001 - Barra de Ferramentas" Referência do componente do grupo de componentes de determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"GROUPEXECUTE_REFERENCEOPERATION") => CHARSMALLINT |
| Tipo | Descrição| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário. | Sim |
| Referência do componente de um grupo de componentes do formulário. | | 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") |
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 |
| Tipo | Descrição |
|---|
| SMALLINT | Caso a operação foi executado com sucesso retornará TRUE, caso contrário retornará FALSE. |
| 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 |
|---|
|
Nome do formulário
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"FORM_NAME") => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário | Sim |
|
| Expandir |
|---|
|
Referência do componente de descrição de um determinado campo do formulário. | Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"LABEL_REFERENCE") => CHAR |
|
| 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 |
| Tipo | Descrição |
|---|
CHAR | Referência do componente de descrição de um campo
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
LET l_labelform_referencename = _ADVPL_get_property(l_form_reference,"LABEL_REFERENCE","item","cod_item"FORM_NAME") |
| Expandir |
|---|
| title | MENUGROUP_BUTTONREFERENCE ou CONTAINER_REFERENCE |
|---|
|
| MENU_BUTTON Referência de um botão da barra de ferramentas do componente do grupo de componentes de determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"MENU_BUTTONGROUP_REFERENCE", < l_operation > ) => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário. | Sim | l_operation
| Nome da operação, cadastrada no programa "FRM0001 - Barra de Ferramentas", do formulário da qual deseja-se retornar a referência. | Sim | |
| Tipo | Descrição |
|---|
CHAR | Referê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. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
LET l_menubuttongroup_reference = _ADVPL_get_property(l_form_reference,"MENUGROUP_BUTTON_REFERENCE","item","createcod_item") |
| Expandir |
|---|
| title | MENUBARLABEL_REFERENCE |
|---|
|
| MENUBAR Referência do componente de descrição de um botão da barra de ferramentas determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"MENUBARLABEL_REFERENCE") => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário. | Sim |
Retornol_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 |
| Tipo | da barra de ferramentas (LMenuBar) | do componente de descrição de um campo do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| LET l_menubarlabel_reference = _ADVPL_get_property(l_form_reference,"MENUBARLABEL_REFERENCE","item","cod_item") |
|
| Expandir |
|---|
| title | STATUSMENU_BARBUTTON_REFERENCE |
|---|
|
| STATUSBAR Referência de um botão da barra de status ferramentas do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"STATUSMENU_BARBUTTON_REFERENCE", < l_operation > ) => CHAR |
| 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 |
| Tipo | Descrição |
|---|
CHAR | Referência de um botão da barra de | status do formulário LStatusBar)| LMenuButton) correspondente à operação informada como parâmetro. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| LET l_menubarmenubutton_reference = _ADVPL_get_property(l_form_reference,"STATUSMENU_BARBUTTON_REFERENCE","create") |
|
| Expandir |
|---|
| title | TABLEMENUBAR_REFERENCE |
|---|
|
| TABLE Referência de um botão da barra de status ferramentas do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"TABLEMENUBAR_REFERENCE", < l_table >, [ l_alias ]) => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário. | Sim | l_table
| 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 | |
| Tipo | Descrição |
|---|
CHAR | Referência do componente grid de uma tabela do formulário. |
| Referência da barra de ferramentas (LMenuBar) do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers |
|---|
|
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
LET l_tablemenubar_reference = _ADVPL_get_property(l_form_reference,"TABLEMENUBAR_REFERENCE","item_man") |
| Expandir |
|---|
| title | VALUESTATUS_BAR_REFERENCE |
|---|
|
| VALUE Referência da barra de status Valor de um determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"VALUE", < l_table >, < l_column>, [ l_line ], [ l_alias ]) => VALUE |
STATUS_BAR_REFERENCE") => CHAR |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_ | | Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | CHAR
| Referência do formulário. | Sim | l_table |
Tabela 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 | |
| Tipo | Descrição |
|---|
VALUE | Valor de um determinado campo do formulário. |
| barra de status do formulário (LStatusBar). |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers |
|---|
|
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
LET l_menubar_valuereference = _ADVPL_get_property(l_form_reference,"VALUE","item","cod_itemSTATUS_BAR_REFERENCE") |
| Expandir |
|---|
| title | ZOOM_BUTTONTABLE_REFERENCE |
|---|
|
| ZOOM_BUTTON Referência do componente do botão de zoom de um determinado campo da barra de status do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"ZOOM_BUTTONTABLE_REFERENCE", < l_table >, [ l_alias ]) => CHAR |
| 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 zoomgrid. | Sim | l_ | columnCHAR
| 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 zoomgrid. | Não |
| Tipo | Descrição |
|---|
CHAR | Referência do componente | do botão de zoom de um campo | grid de uma tabela do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| LET l_zoom_buttontable_reference = _ADVPL_get_property(l_form_reference,"ZOOM_BUTTONTABLE_REFERENCE","item","cod_itemman") |
|
| Expandir |
|---|
|
| ZOOM_REFERENCE Valor Referência do zoom de um determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_get_property(< l_form_reference >,"ZOOM_REFERENCEVALUE", < l_table >, < l_column>, [ l_line ], [ l_alias ]) => CHARVALUE |
| Nome | Tipo | Descrição | Obrigató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 |
CHARReferência do zoom | Valor de um determinado campo do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| 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.
| Expandir |
|---|
| title | ACTIVATEZOOM_BUTTON_REFERENCE |
|---|
|
| SETACTIVATE Referência do componente do botão de zoom de um determinado campo do Inicia ou finaliza o formulário.
| Bloco de código |
|---|
CALL _ADVPL_setget_property(< l_form_reference >,"ACTIVATEZOOM_BUTTON_REFERENCE", < l_statustable >, [ l_alias ]) => CHAR |
| Nome | Tipo | Descrição | Obrigató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 | Para ativar ou desativar um formulário, deverá ter executado previamente o método "FORM" ou "INIT_FORM" para o mesmo.
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 |
| Tipo | Descrição |
|---|
CHAR | Referência do componente do botão de zoom de um campo do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALLLET l_zoom_button_reference = _ADVPL_setget_property(l_form_reference,"ZOOM_BUTTON_REFERENCE","ACTIVATEitem",TRUE"cod_item") |
|
| Expandir |
|---|
| title | BROWSEZOOM_VALUEREFERENCE |
|---|
|
| SETBROWSEVALUE Referência do zoom de um determinado campo Atribui valor para uma determinada linha e coluna da operação 'Listar' do formulário.
| Bloco de código |
|---|
_ADVPL_setget_property(< l_form_reference >,"BROWSEZOOM_VALUEREFERENCE", < l_table >, < l_column >, < l_line >, < l_value >, [ l_alias ]) => CHAR |
| 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 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_ | linealias | INTEGERCHAR
| 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 |
| Tipo | Descrição |
|---|
CHAR | Referência do zoom de determinado campo do formulário. |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| 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 |
|---|
|
Inicia ou finaliza o formulário.
| 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 |
|---|
| title | CONTAINER_COLUMNS_COUNT |
|---|
|
| 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.
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE) |
|
| Expandir |
|---|
|
Atribui valor para uma determinada linha e coluna da operação 'Listar' do Inicia ou finaliza o formulário.
| Bloco de código |
|---|
CALL _ADVPL_set_property(< l_form_reference >,"CONTAINERBROWSE_COLUMNS_COUNTVALUE", < l_columns >) |
table >, < l_column >, < l_line >, < l_value >, [ l_alias ]) |
| Nome | Tipo | Descrição | Obrigatório? |
|---|
l_form_reference | | Nome | Tipo | Descrição | Obrigató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 | 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALLLET l_ADVPL_set_browse_count = _ADVPL_get_property(l_form_reference,"CONTAINERBROWSE_COLUMNSITEM_COUNT",2) |
|
| Expandir |
|---|
|
Atribui valor para uma determinada linha e coluna da operação 'Listar' do formulário. | 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 ]) |
|
| 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 |
= 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 |
|---|
|
Inicia ou finaliza o formulário.
| Bloco de código |
|---|
CALL _ADVPL_set_property(< l_form_reference >,"CONTAINER_COLUMNS_COUNT", < l_columns >) |
| 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.
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"CONTAINER_COLUMNS_COUNT",2) |
|
| Expandir |
|---|
|
Filtro de consulta padrão para uma tabela de detalhe. Este filtro será utilizado para cada pesquisa que o usuário executar.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"DETAIL_WHERE_CLAUSE", < l_where_clause >, <l_table >, [ l_alias ]) |
| 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.
| 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 |
|---|
|
Habilita/desabilita os campos em tela que estiverem registrados no formulário como Editável no cadastro de formulários cadastrais (FRM1002).
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ENABLE_COMPONENTS", < l_status >, [ l_operation ]) |
| 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
|
Este filtro será utilizado dentro das cláusulas de junção das tabelas no SQL.
| 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,"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 |
|---|
| title | ENABLE_VALID_FOREIGN_COMPONENTSKEY |
|---|
|
| _COMPONENTS 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).
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ENABLE_COMPONENTSVALID_FOREIGN_KEY", < l_status >, [ l_operationtable ], [ l_alias ]) |
| 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 | | 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| Confluence |
|---|
| linenumbers | true |
|---|
| 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 |
|---|
| title | ENABLE_VALID_FOREIGNNOT_KEYNULL |
|---|
|
| FOREIGNKEY Habilita/desabilita a validação de chaves estrangeiras campos obrigatório para determinada(s) tabelas do formulário.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_FOREIGNNOT_KEYNULL", < l_status >, [ l_table ], [ l_alias ]) |
| 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 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. 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_FOREIGNNOT_KEYNULL",FALSE,"item") |
|
| Expandir |
|---|
| title | ENABLE_VALID_NOTPRIMARY_NULLKEY |
|---|
|
| NOTNULL Habilita/desabilita a validação de campos obrigatório chaves primárias para determinada(s) tabelas do formulário.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ENABLE_VALID_NOTFOREIGN_NULLKEY", < l_status >, [ l_table ], [ l_alias ]) |
| 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 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. 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"ENABLE_VALID_NOTPRIMARY_NULLKEY",FALSE,"item") |
|
| Expandir |
|---|
| title | ENABLE_VALID_PRIMARY_KEYFORM |
|---|
|
| ENABLE_VALID_PRIMARY_KEY 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.
| 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> ) |
| 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 | | 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 |
|---|
| | 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 | l_alias | CHAR
| Alias da tabela do formulário da qual deseja habilitar/desabilitar a validação de chaves primárias. | Não |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"FORM","ENABLE_VALID_PRIMARY_KEYman10021",FALSE,"item"mr_item,ma_item_man) |
|
| Expandir |
|---|
|
Junção dos métodos "FORM" e "ACTIVATE" para carregar as informações do formulário e executá-lo em seguida.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"INIT_FORM", < l_form_name >, <l_4glRecord1>, < l_4glRecord2 >, ..., <l_4GLrecordNz> ) |
| 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 |
|---|
| | 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 |
| 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 |
|---|
|
Ordem de consulta padrão para determinado(s) campos do formulário que será utilizada para toda pesquisa executada no formulário.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ORDER_BY", < l_table_alias >, < l_column >, [ l_order ]) |
| 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"ORDER_BY","item","cod_item","DESC") |
|
| Expandir |
|---|
|
Atribui valor para determinado campo do formulário.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"VALUE", < l_table>, < l_column >, < l_value >, [ l_line ], [ l_alias ]) |
| 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_line | 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 |
| Bloco de código |
|---|
| language | ruby |
|---|
| theme | Confluence |
|---|
| linenumbers | true |
|---|
| CALL _ADVPL_set_property(l_form_reference,"VALUE","item","cod_empresa","50") |
|
| Expandir |
|---|
|
Filtro de consulta padrão para o formulário que será utilizado para toda pesquisa realizada.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"WHERE_CLAUSE", < l_where_clause >) |
| 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.
| 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 |
|---|
|
Atribui valor para uma determinada linha e coluna da operação 'Listar' do formulário.
| Bloco de código |
|---|
_ADVPL_set_property(< l_form_reference >,"ZOOM_NAME", < l_zoom_name >, <l_table >, [ l_alias ]) |
| 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 |
| 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") |
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'
|
...
| 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>) |
...
| 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 |
...