Histórico da Página

...

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.

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")

...

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 29

Nova versão 30

Chave

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