Pagetitle

	LGX - LZoomMetaData
	LGX - LZoomMetaData

Cria e executa uma tela de zoom cadastrado no metadado. Os eventos que se encontram cadastrados no zoom poderão ser substituídos por outros quando executado os métodos para atribuição destes eventos.

Um zoom pode ser utilizado para obter informações de outra entidade da base de dados ou de outros programas. Por padrão, o zoom sempre é executado ao clicar num botão de lupa ao lado do campo, ou ao acionar a tecla de atalho F4 dentro deste mesmo campo.

Os zooms podem ser utilizados tanto em campos de formulários quanto em colunas de uma grid e, possuem dois métodos de exibição de registros: de seleção única ou de múltipla seleção.

Hierarquia

LComponent

Sintaxe

Informações

icon	false

LET l_zoom_reference = _ADVPL_create_component( NULL, "LZOOMMETADATA" )

Métodos GET

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

Expandir

title	GET ACTIVATE

Método GET: ACTIVATE

Executa um zoom carregado através do método SET ZOOM.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ACTIVATE")

Expandir

title	GET RETURN_BY_TABLE_COLUMN

Método GET: RETURN_BY_TABLE_COLUMN

Retorna o valor de determinado registro do zoom conforme o nome da tabela e coluna informados.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"RETURN_BY_TABLE_COLUMN", < Tabela >, < Coluna >) ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do zoom que será retornado o valor	Sim
Coluna	CHAR	Nome da coluna do zoom que será retornado o valor	Sim

Retorno

Tipo	Descrição
CHAR	Valor do registro da coluna informada.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_value = _ADVPL_get_property( l_form_reference, "RETURN_BY_TABLE_COLUMN", "item","cod_empresa")

Expandir

title	GET ITEM_COUNT

Método GET: ITEM_COUNT

Retorna a quantidade de registros existentes no zoom.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ITEM_COUNT") ==> Quantidade

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 existentes no zoom.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_item_count = _ADVPL_get_property(l_form_reference,"ITEM_COUNT")

Expandir

title	GET INDEX_VALUE

Método GET: INDEX_VALUE

Retorna o valor de determinado registro do zoom conforme o nome da tabela, coluna e linha informadas.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"INDEX_VALUE", < Tabela >, < Coluna >, < Linha > ) ==> Já informou?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim
Tabela	CHAR	Nome da tabela da coluna do zoom que será retornado o valor	Sim
Coluna	CHAR	Nome da coluna do zoom que será retornado o valor	Sim
Linha	INTEGER	Linha da coluna do zoom que será retornado o valor	Sim

Retorno

Tipo	Descrição
CHAR	Valor do registro da coluna informada

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

 LET l_value = _ADVPL_get_property(< l_form_reference >,"INDEX_VALUE","item","cod_empresa","10")

Expandir

title	GET TABLE_REFERENCE

Método GET: TABLE_REFERENCE

Retorna a referência da grid utilizada no zoom.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_grid_reference >,"TABLE_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_grid_reference	CHAR	Referência da grid utilizada no zoom	Sim

Retorno

Tipo	Descrição
CHAR	Referência da grid utilizada no zoom.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_item_count = _ADVPL_get_property( l_grid_reference,"TABLE_REFERENCE")

Expandir

title	GET COMPONENT_REFERENCE

Método GET: COMPONENT_REFERENCE

Retorna a referência de determinada coluna da grid do zoom, conforme nome da tabela e coluna informados.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"COMPONENT_REFERENCE", < Tabela >, < Coluna >) ==> Referência

Parâmetros

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

Retorno

Tipo	Descrição
CHAR	Referência da coluna da grid utilizada no zoom

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

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

Expandir

title	GET ITEM_SELECTED

Método GET: ITEM_SELECTED

Retorna a linha do registro selecionado no zoom.
Quando o zoom é de múltipla seleção, retorna a quantidade de registros selecionados.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ITEM_SELECTED") ==> Referência

Parâmetros

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

Retorno

Tipo	Descrição
INTEGER	Linha do registro selecionado no zoom.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_row_selected = _ADVPL_get_property(l_form_reference,"ITEM_SELECTED")

Expandir

title	GET ZOOM_TYPE

Método GET: ZOOM_TYPE

Retorna o tipo de zoom utilizado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ZOOM_TYPE") ==> Referência

Parâmetros

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

Retorno

Tipo	Descrição
INTEGER	Tipo do zoom utilizado, sendo: 0 - Seleção única e 1 - Múltipla seleção.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_zoom_type = _ADVPL_get_property(l_form_reference,"ZOOM_TYPE")

expand

Expandir

title	GET ALWAYS_SHOW_FILTER

Método GET: ALWAYS_SHOW_FILTER

Retorna se está parametrizado para sempre exibir a tela de filtro de registros antes da exibição do zoom.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ALWAYS_SHOW_FILTER") ==> Referência

Parâmetros

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

Retorno

Tipo

Descrição

BOOLEAN

Verdadeiro se está parametrizado para sempre exibir o filtro de registros, falso se não está parametrizado.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_show_filter = _ADVPL_get_property(l_form_reference,"ALWAYS_SHOW_FILTER")

Métodos SET

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

Expandir

title	SET ARRAY_RECORD_RETURN

Método SET: ARRAY_RECORD_RETURN

Define um ARRAY OF RECORD do 4GL onde serão carregados os valores selecionados no zoom de múltipla seleção.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_zoom_reference >,"ARRAY_RECORD_RETURN", < r_ArrayRecord >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
r_ArrayRecord	`()`	ARRAY OF RECORD do 4GL onde serão carregados os registros selecionados no zoom	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_zoom_empresa_reference,"ARRAY_RECORD_RETURN",ma_zoom_empresa)

Expandir

title	SET ZOOM_COMPONENT

Método SET: ZOOM_COMPONENT

Integra um componente da tela com o zoom.
Com esta integração, ao executar o zoom, o mesmo irá atribuir o foco e o valor para o campo e também irá efetuar outras validações automaticamente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_zoom_reference >,"ZOOM_COMPONENT",<c_Component>, <n_Type>, <n_Size>, [n_Precision] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Component	`CHAR`	Referência do componente que será integrado com o zoom.	Sim
n_Type	INTEGER	Tipo do componente, sendo: 1–CHAR, 2–SMALLINT, 3–INTEGER, 4–DECIMAL, 5–DATE, 6–DATETIME, 7–VARCHAR, 8–SERIAL e 9–IMAGE.	Sim
n_Size	INTEGER	Tamanho do tipo de dado do componente.	Sim
n_Precision	INTEGER	Precisão do tipo de dado do componente	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property( l_zoom_reference,"ZOOM_COMPONENT","zoom_component",3,10,5)

Expandir

title	SET ZOOM

Método SET: ZOOM

Carrega as informações do zoom informado, cadastrado no metadado.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_zoom_reference >,"ZOOM",< c_Zoom > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Zoom	`CHAR`	Nome do zoom que será carregado, o mesmo deve estar cadastrado no metadado	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property( l_zoom_reference ,"ZOOM","zoom_empresa")

Expandir

title	SET ZOOM_TYPE

Método SET: ZOOM_TYPE

Define o tipo do zoom que será executado, de seleção única ou múltipla seleção.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_zoom_reference >,"ZOOM_TYPE",< n_Type >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_Type	`INTEGER`	Tipo do zoom que será executando, sendo: 0 - Seleção única e 1 - Múltipla seleção	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property( l_zoom_reference,"ZOOM_TYPE",1)

Expandir

title	SET SELECT_ITEM

Método SET: SELECT_ITEM

Marca/desmarca um determinado registro do zoom de múltipla seleção.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_browse_reference >,"SELECT_ITEM", < n_Row >, < n_Status >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_browse_reference	`CHAR`	Referência do formulário.	Sim
n_Row	INTEGER	Número da linha do registro que será selecionado.	Sim
n_Status	`INTEGER`	Verdadeiro para marcar o registro da linha informada, falso para desmarcar.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_browse_filter_reference,"SELECT_ITEM",1,5)

Expandir

title	SET CLEAR_SELECT_ITEM

Método SET: CLEAR_SELECT_ITEM

Desmarca todos registros do zoom de múltipla seleção.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_zoom_reference >,"CLEAR_SELECT_ITEM")

Parâmetros

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

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

title	Código de Exemplo

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

DATABASE logix
 
 DEFINE m_cod_item_reference,
        m_den_item_reference,
        m_count_empresas_reference VARCHAR(10)
 
 DEFINE m_zoom_item_reference,
        m_zoom_empresa_reference VARCHAR(10)
 
 DEFINE mr_tela RECORD
                    cod_item       CHAR(15),
                    den_item       CHAR(76),
                    count_empresas SMALLINT
                END RECORD
 
 DEFINE ma_zoom_empresa ARRAY[1000] OF
                        RECORD
                            cod_empresa CHAR(02),
                            den_empresa CHAR(36)
                        END RECORD
 
#-----------------------#
 FUNCTION zoommetadata()
#-----------------------#
     DEFINE l_dialog_reference,
            l_panel_reference,
            l_layout_reference,
            l_label_reference,
            l_component_reference,
            l_imagebutton_reference VARCHAR(10)
 
     INITIALIZE mr_tela.*,ma_zoom_empresa TO NULL
 
     #Conecta ao banco de dados
     CALL LOG_connectDatabase("DEFAULT")
 
     LET l_dialog_reference = _ADVPL_create_component(NULL,"LDIALOG")
     CALL _ADVPL_set_property(lm_browse_dialogfilter_reference,"SIZE",400,200)
     CALL CLEAR_SELECT_ITEM")

Expandir

title	SET SELECT_ITEM_ALL

Método SET: SELECT_ITEM_ALL

Marca/desmarca todos os registros do zoom de múltipla seleção.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_dialogzoom_reference >,"TITLESELECT_ITEM_ALL",< n_Select >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_Select	INTEGER	Verdadeiro para marcar todos os registros do zoom, falso para desmarcar.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

"Exemplo de Utilização: LZOOMMETADATA")
 
     LET l_panel_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(lm_browse_panelfilter_reference,"ALIGN","CENTER")
 
     LET l_layout_SELECT_ITEM_ALL",1)

Expandir

title	SET BEFORE_LOAD_EVENT

Método SET: BEFORE_LOAD_EVENT

Define um evento que será executado após o carregamento do zoom, porém antes de sua abertura.
A função cadastrada para este método deve retornar verdadeiro ou falso para continuar ou interromper a abertura do zoom.

Sintaxe

Bloco de código

reference = _ADVPL_create_component(NULL,"LLAYOUTMANAGER",l_panel_reference)
     CALL _ADVPL_set_property(l_layout_reference,"COLUMNS_COUNT",4)
     CALL _ADVPL_set_property(l< m_layoutzoom_reference >,"MARGINBEFORE_LOAD_EVENT",< c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada antes da abertura do zoom	Sim

Ao utilizar este método, se houver uma função cadastrada no Before Load no metadado do zoom, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

TRUE)
 
     LET l_label_reference = _ADVPL_create_component(NULL,"LLABEL",l_layout_reference)
     CALL _ADVPL_set_property(lm_browse_labelfilter_reference,"TEXTSELECT_ITEM_ALL","Item: ")
 
     LET m_cod_item_reference = _zoom_metadata_execute_zoom")

Expandir

title	SET AFTER_LOAD_EVENT

Método SET: AFTER_LOAD_EVENT

Define um evento que será executado na abertura do zoom.

Sintaxe

Bloco de código
_ADVPL_create_component(NULL,"LTEXTFIELD",l_layout_reference) CALL _ADVPL_set_property(< m_cod_itemzoom_reference >,"ENABLEAFTER_LOAD_EVENT",FALSE) < c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada na abertura do zoom	Sim

Ao utilizar este método, se houver uma função cadastrada no After Load no metadado do zoom, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_   CALL _ADVPL_set_property(m_codbrowse_itemfilter_reference,"LENGTHAFTER_LOAD_EVENT","zoom_metadata_execute_zoom")

Expandir

title	SET CONFIRM_EVENT

Método SET: CONFIRM_EVENT

Define um evento que será executado ao confirmar a seleção dos registros no zoom.
A função cadastrada para este método deve retornar verdadeiro ou falso para continuar ou interromper a confirmação do zoom.

Sintaxe

Bloco de código
15) CALL _ADVPL_set_property(< m_codzoom_item_reference >,"PICTURECONFIRM_EVENT","< c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada na confirmação do zoom.	Sim

Ao utilizar este método, se houver uma função cadastrada no Confirm no metadado do zoom, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

@!")
     CALL _ADVPL_set_property(m_cod_item_reference,"VARIABLE",mr_tela,"cod_item")
     CALL _ADVPL_set_property(m_codbrowse_itemfilter_reference,"WIDTH",50)
CONFIRM_EVENT","zoom_metadata_execute_zoom")

Expandir

title	SET CANCEL_EVENT

Método SET: CANCEL_EVENT

Define um evento que será executado ao cancelar a seleção dos registros no zoom.
A função cadastrada para este método deve retornar verdadeiro ou falso para continuar ou interromper o cancelamento do zoom.

Sintaxe

Bloco de código
LET l_imagebutton_reference = _ADVPL_create_component(NULL,"LIMAGEBUTTON",l_layout_reference) CALL _ADVPL_set_property(l< m_imagebuttonzoom_reference >,"CLICKCANCEL_EVENT","< c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada no cancelamento do zoom.	Sim

Ao utilizar este método, se houver uma função cadastrada no Cancel no metadado do zoom, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALLzoommetadata_execute_zoom_item")
     CALL _ADVPL_set_property(l_imagebutton_reference,"IMAGE","BTPESQ")
     CALL _ADVPL_set_property(lm_browse_imagebuttonfilter_reference,"SIZE",24,20)CANCEL_EVENT","zoom_metadata_execute_zoom")

Expandir

title	SET BEFORE_ZOOM_EVENT

Método SET: BEFORE_ZOOM_EVENT

Define um evento que será executado antes do carregamento e da abertura do zoom.
A função cadastrada para este método deve retornar verdadeiro ou falso para continuar ou interromper a abertura do zoom.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_zoom_reference >,"BEFORE_ZOOM_EVENT",< c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada antes da abertura do zoom.	Sim

Ao utilizar este método, se houver uma função cadastrada no Before Zoom no metadado do formulário, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true


 
     LET m_den_item_reference = _ADVPL_create_component(NULL,"LTEXTFIELD",l_layout_reference)
     CALL _ADVPL_set_property(m_den_item_reference,"ENABLE",FALSE)
     CALL _ADVPL_set_property(m_den_item_reference,"LENGTH",76)
     CALL _ADVPL_set_property(m_denbrowse_itemfilter_reference,"PICTURE","@!")
     CALL BEFORE_ZOOM_EVENT","zoom_metadata_execute_zoom")

Expandir

title	SET AFTER_ZOOM_EVENT

Método SET: AFTER_ZOOM_EVENT

Define um evento que será executado após a finalização do zoom.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_denzoom_item_reference >,"AFTER_ZOOM_EVENT",< c_Event >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
c_Event	( )	Função 4GL que será executada após a finalização do zoom.	Sim

Ao utilizar este método, se houver uma função cadastrada no After Zoom no metadado do formulário, a mesma será desconsiderada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

VARIABLE",mr_tela,"den_item")
     CALL _ADVPL_set_property(m_den_item_reference,"WIDTH",200)
 
     LET l_label_reference = _ADVPL_create_component(NULL,"LLABEL",l_layout_reference)
     CALL _ADVPL_set_property(lm_browse_labelfilter_reference,"TEXTAFTER_ZOOM_EVENT","Empresas:zoom_metadata_execute_zoom")

Expandir

title	SET SELECTED

Método SET: SELECTED

Define a quantidade de registros pré-selecionados no zoom de múltipla seleção.

Sintaxe

Bloco de código
_ ") LET m_count_empresas_reference = _ADVPL_create_component(NULL,"LNUMERICFIELD",l_layout_reference) CALL _ADVPL_set_property(< m_count_empresaszoom_reference >,"ENABLESELECTED",< n_Selected >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_Selected	INTEGER	Quantidade de registros pré-selecionados no zoom.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

FALSE)
     CALL _ADVPL_set_property(m_countbrowse_empresasfilter_reference,"LENGTHSELECTED",04)
     CALL 10)

Expandir

title	SET CAN_EDIT

Método SET: CAN_EDIT

Habilita/desabilita a edição dos registros do zoom, caso o mesmo possua um formulário cadastrado para edição.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_countzoom_empresas_reference >,"VARIABLECAN_EDIT",< n_Edit >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_Edit	INTEGER	Verdadeiro para habilitar a edição dos registros do zoom, falo para desabilitar.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALLmr_tela,"count_empresas")
     CALL _ADVPL_set_property(m_countbrowse_empresasfilter_reference,"WIDTHCAN_EDIT",50)
 
     LET l_imagebutton10)

Expandir

title	SET CAN_FILTER

Método SET: CAN_FILTER

Habilita/desabilita filtrar os registros do zoom.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_zoom_reference >,"CAN_FILTER",< n_Filter >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_Filter	INTEGER	Verdadeiro para habilitar filtrar os registros do zoom, falso para desabilitar	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

_reference = _ADVPL_create_component(NULL,"LIMAGEBUTTON",l_layout_reference)
     CALL _ADVPL_set_property(l_imagebutton_reference,"CLICK_EVENT","zoommetadata_execute_zoom_empresa")
     CALL _ADVPL_set_property(lm_browse_imagebuttonfilter_reference,"IMAGECAN_FILTER","BTPESQ")
     CALL _ADVPL_1)

Expandir

title	SET ALWAYS_SHOW_FILTER

Método SET: ALWAYS_SHOW_FILTER

Habilita/desabilita a exibição do filtro de registros antes da exibição do zoom.

Sintaxe

Bloco de código

set_property(l_imagebutton_reference,"SIZE",24,20)
 
     CALL _ADVPL_set_property(l< m_layoutzoom_reference >,"ADDALWAYS_EMPTYSHOW_COLUMNFILTER")
 
     CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE)
 END FUNCTION
 
#-----------------------------------------#
 FUNCTION zoommetadata_execute_zoom_item()
#-----------------------------------------#
     DEFINE l_cod_item CHAR(15),
            l_den_item CHAR(76)
 
     #Carrega o zoom de itens, se o mesmo ainda não foi carregado
     IF ,< n_ShowFilter >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
m_zoom_reference	`CHAR`	Referência do formulário.	Sim
n_ShowFilter	INTEGER	Verdadeiro para habilitar a exibição do filtro de registros antes da exibição do zoom, falo para desabilitar.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_browse_filter_reference,"ALWAYS_SHOW_FILTER",1)

Exemplo

Clique no link na lateral direita para expandir o código de exemplo.

Métodos SET

Métodos acessíveis utilizando a função

Bloco de código

language	ruby
theme	Eclipse
title	Exemplos de uso do componente LZoomMetadata
linenumbers	true
collapse	true

DATABASE logix
 
 DEFINE m_cod_item_reference,
        m_den_item_reference,
        m_count_empresas_reference VARCHAR(10)
 
 DEFINE m_zoom_item_reference

IS NULL THEN

LET

m_zoom_

item

empresa_reference

= _ADVPL_create_component(NULL,"LZOOMMETADATA"

VARCHAR(10)
 
 DEFINE mr_tela RECORD

CALL

_ADVPL_set_property(m_zoom_item_reference,"ZOOM","zoom_item")

END

IF

#Ativa

o

cod_item

zoom

de

itens

CALL _ADVPL_get_property(m_zoom_item_reference,"ACTIVATE")

CHAR(15),

#Recupera

os

valores

selecionados

no

zoom

LET

l

den_

cod_

item

= _ADVPL_get_property(m_zoom_item_reference,"RETURN_BY_TABLE_COLUMN","item","cod_item")

      CHAR(76),

LET l_den_item = _ADVPL_get_property(m_zoom_item_reference,"RETURN_BY_TABLE_COLUMN","item","den_item_reduz")

IF

l_cod_item IS NOT NULL OR l_den_item IS NOT NULL THEN

count_empresas SMALLINT
                END RECORD

LET

DEFINE

mr

ma_

tela.cod

zoom_

item = l_cod_item

empresa ARRAY[1000] OF

LET mr_tela.den_item = l_den_item

             RECORD

END IF

CALL

_ADVPL_set_property(m_cod_item_reference,"VALUE",mr_tela.cod_item)

CALL

_ADVPL_set_property(m_den_item_reference,"VALUE",mr_tela.den_item) END FUNCTION

cod_empresa CHAR(02),
                            den_empresa CHAR(36)
                        END RECORD
 
#-----------------------

---------------------#

#
 FUNCTION zoommetadata

_execute_zoom_empresa

()
#-----------------------

---------------------

#Carrega o zoom de empresas, se o mesmo ainda não foi carregado

DEFINE l_dialog_reference,

IF m_zoom_empresa

l_panel_reference,

IS

NULL

THEN

LET m

l_

zoom

layout_

empresa_

reference,

=

_ADVPL_create_component(NULL,"LZOOMMETADATA")

CALL

l_

ADVPL_set_property(m_zoom_empresa_reference,"ZOOM","zoom_empresa")

label_reference,

CALL

_ADVPL_set_property(m_zoom_empresa

l_component_reference,

"ZOOM_TYPE",1)

CALL

l_

ADVPL_set_property(m_zoom_empresa_reference,"ARRAY_RECORD_RETURN",

imagebutton_reference VARCHAR(10)
 
     INITIALIZE mr_tela.*,ma_zoom_empresa

)

END IF

TO NULL

#Ativa

#Conecta

o

ao

zoom

banco de

empresas

dados
     CALL LOG_

ADVPL_get_property(m_zoom_empresa_reference,"ACTIVATE

connectDatabase("DEFAULT")

#Recupera a quantidade de registros selecionados no zoom

LET l_dialog_reference = _ADVPL_create_component(NULL,"LDIALOG")

LET

CALL

mr

tela.count_empresas = _

ADVPL_

get

set_property(

m

l_

zoom

dialog_

empresa_

reference,"

RETURN

SIZE",400,200)
     CALL _ADVPL_set_property(

m

l_

count_empresas

dialog_reference,"

VALUE",mr_tela.count_empresas) END FUNCTION

Cleane → Verificar ↓

TITLE","Exemplo de Utilização: LZOOMMETADATA")
 
     LET l_panel_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property

que permite alterar e manipular os valores do componente.

(l_panel_reference,"ALIGN","CENTER")
 
     LET l_layout_reference = _ADVPL_create_component(NULL,"LLAYOUTMANAGER",l_panel_reference)
     CALL _ADVPL_set_property(

< m

l_

zoom

layout_reference

>

,"

ARRAY

COLUMNS_

RECORD_RETURN

COUNT",4)

<

r_ArrayRecord >)

Parâmetros

Exemplo

   CALL _ADVPL_set_property(

m

l_

zoom_empresa

layout_reference,"

ARRAY_RECORD_RETURN",ma_zoom_empresa)

Exemplo

MARGIN",TRUE)
 
     LET l_label_reference = _ADVPL_create_component(NULL,"LLABEL",l_layout_reference)
     CALL _ADVPL_set_property(l_label_reference,"TEXT","Item: ")
 
     LET m_cod_item_reference = _ADVPL_create_component(NULL,"LTEXTFIELD",l_layout_reference)
     CALL _ADVPL_set_property(m_cod_item_reference,"ENABLE",FALSE)
     CALL _ADVPL_set_property(

l_zoom

m_cod_item_reference,"

ZOOM_COMPONENT","zoom_component",3,10,5)

LENGTH",15)
     CALL _ADVPL_set_property(

< l_zoom

m_cod_item_reference

>

,"

ZOOM

PICTURE",

< c_Zoom > )

Parâmetros

Exemplo

CALL _

"@!")
     CALL _ADVPL_set_property(

l_zoom

m_cod_item_reference

,"

ZOOM

VARIABLE",mr_tela,"

zoom

cod_

empresa")_

item")
     CALL _ADVPL_set_property(

< l_form

m_cod_item_reference

>

,"

INIT_PARAMETER

WIDTH",

<

50)

Formulário

>,

[

Record

],

[ Array of Record ])

Parâmetros

Importante: para ativar ou desativar um formulário, deverá ter executado previamente o método "PARAMETER" ou "INIT_PARAMETER" para o mesmo.

Exemplo

DATABASE logix GLOBALS DEFINE p_user

LET l_imagebutton_reference = _ADVPL_create_component(NULL,"LIMAGEBUTTON",l_layout_reference)
     CALL _ADVPL_set_property(l_imagebutton_reference,"CLICK_EVENT","zoommetadata_execute_zoom_item")
     CALL _ADVPL_set_property(l_imagebutton_reference,"IMAGE","BTPESQ")
     CALL

LIKE usuarios.cod_usuario

_ADVPL_set_property(l_imagebutton_reference,"SIZE",24,20)

DEFINE

LET

p

m_

cod

den_item_

empresa

reference

LIKE empresa.cod_empresa END GLOBALS DEFINE mr_tela

= _ADVPL_create_component(NULL,"LTEXTFIELD",l_layout_reference)
     CALL _ADVPL_set_property(m_den_item_reference,"ENABLE",FALSE)

RECORD

CALL _ADVPL_set_property(m_den_item_reference,"LENGTH",76)
     CALL _ADVPL_set_property(m_den_item_reference,"PICTURE","@!")
     CALL _ADVPL_set_property(m_den_item_reference,"VARIABLE",mr_tela,"den_item")
     CALL _ADVPL_set_property(m_den_item_reference,"WIDTH",200)

cod_empresa LIKE empresa.cod_empresa,

LET l_label_reference = _ADVPL_create_component(NULL,"LLABEL",l_layout_reference)
     CALL _ADVPL_set_property(l_label_reference,"TEXT","Empresas: ")
 
     LET m_count_empresas_reference = _ADVPL_create_component(NULL,"LNUMERICFIELD",l_layout_reference)
     CALL _ADVPL_set_property(m_count_empresas_reference,"ENABLE",FALSE)

den_empresa LIKE empresa.den_empresa

CALL _ADVPL_set_property(m_count_empresas_reference,"LENGTH",04)
     CALL _ADVPL_set_property(m_count_empresas_reference,"VARIABLE",mr_tela,"count_empresas")

END RECORD DEFINE ma_tela

CALL _ADVPL_set_property(m_count_empresas_reference,"WIDTH",50)
 
     LET l_imagebutton_reference

ARRAY[100] OF

= _ADVPL_create_component(NULL,"LIMAGEBUTTON",l_layout_reference)

CALL _ADVPL_set_property(l_imagebutton_reference,"CLICK_EVENT","zoommetadata_execute_zoom_empresa")
     CALL _ADVPL_set_property(l_imagebutton_reference,"IMAGE","BTPESQ")
     CALL

RECORD

_ADVPL_set_property(l_imagebutton_reference,"SIZE",24,20)

CALL _ADVPL_set_property(l_layout_reference,"ADD_EMPTY_COLUMN")

cod_item LIKE item.cod_item, den_item LIKE item.den_item END RECORD DEFINE m_form_reference VARCHAR(100) #

CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE)
 END FUNCTION
 
#------------------------------

# FUNCTION man100220() #

-----------#
 FUNCTION zoommetadata_execute_zoom_item()
#-----------------------------------------#

# Verifica o acesso do usuário conforme módulo do programa.

DEFINE l_cod_item CHAR(15),

IF

LOG_initApp("PADRAO") <> 0 THEN

l_den_item CHAR(76)
 
     #Carrega o zoom de itens, se

RETURN

o mesmo ainda não foi

END IF

carregado

INITIALIZE mr_tela.*, ma_tela TO NULL

IF  m_zoom_item_reference IS NULL THEN
         LET

l

m_zoom_

form

item_reference = _ADVPL_create_component(NULL,"

LPARMETADATA

LZOOMMETADATA")
         CALL _ADVPL_set_property(

l

m_zoom_

form

item_reference,"

INIT_PARAMETER

ZOOM","

man100220",mr_tela,ma_tela

zoom_item")
     END

FUNCTION

IF

Método SET: ITEM_COUNT

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

Sintaxe

Expandir

title	SET ARRAY_RECORD_RETURN

Método SET: ARRAY_RECORD_RETURN

Define um ARRAY OF RECORD do 4GL onde serão carregados os valores selecionados no zoom de múltipla seleção.

Sintaxe

Bloco de código

Nome Tipo Descrição Obrigatório?

m_zoom_reference

CHAR

Referência do formulário.

Sim

r_ArrayRecord

()

ARRAY OF RECORD do 4GL onde serão carregados os registros selecionados no zoom

Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

Expandir

title	SET ZOOM_COMPONENT

Método SET: ZOOM_COMPONENT

Integra um componente da tela com o zoom.
Com esta integração, ao executar o zoom, o mesmo irá atribuir o foco e o valor para o campo e também irá efetuar outras validações automaticamente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_zoom_reference >,"ZOOM_COMPONENT",<c_Component>, <n_Type>, <n_Size>, [n_Precision] )

Parâmetros

Nome Tipo Descrição Obrigatório?

l_zoom_reference

CHAR

Referência do formulário.

Sim

c_Component CHAR Referência do componente que será integrado com o zoom. Sim

n_Type INTEGER Tipo do componente, sendo: 1–CHAR, 2–SMALLINT, 3–INTEGER, 4–DECIMAL, 5–DATE, 6–DATETIME, 7–VARCHAR, 8–SERIAL e 9–IMAGE. Sim

n_Size INTEGER Tamanho do tipo de dado do componente. Sim

n_Precision INTEGER Precisão do tipo de dado do componente Não

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

Expandir

title	SET ZOOM

Método SET: ZOOM

Carrega as informações do zoom informado, cadastrado no metadado.

Sintaxe

Bloco de código

Nome Tipo Descrição Obrigatório?

l_zoom_reference

CHAR

Referência do formulário.

Sim

c_Zoom

CHAR

Nome do zoom que será carregado, o mesmo deve estar cadastrado no metadado

Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

Expandir

title	SET INIT_PARAMETER

Método SET: INIT_PARAMETER

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

Sintaxe

Bloco de código

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário.

Sim

Formulário

CHAR

Nome do formulário cadastrado no programa "FRM0003 - Formulários de Parâmetros/Processamento".

Sim

Record RECORD Variável RECORD que irá controlar o conteúdo dos campos monovalorados do formulário. Sim

Array of Record ARRAY OF RECORD Variável ARRAY OF RECORD que irá controlar o conteúdo dos campos multivalorados do formulário. Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

Expandir

title	SET ITEM_COUNT

Bloco de código
_ADVPL_set_property(< l_form_reference >,"ITEM_COUNT", < Associação >, < Quantidade >)

Parâmetros

NomeTipoDescriçãoObrigatório?l_form_reference

CHAR

Referência do formulário.Sim Associação

CHAR

Nome da associação do multivalorado do formulário.SimQuantidadeINTEGERNúmero de linhas que será atribuído para um determinado multivalorado do formulário.Sim

Importante: caso o multivalorado possua apenas um campo e não possua associação, deverá ser passado no primeiro parâmetro o nome do campo multivalorado.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

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

Expandir

title	SET PARAMETER

Método SET: PARAMETER

Carrega as informações do formulário, mas não o executa. Utilizado em casos em que é necessário carregar o formulário e após isso executar diretamente uma operação do mesmo.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"PARAMETER",< Formulário >, [ Record ], [ Array of Record ])

Parâmetros

NomeTipoDescriçãoObrigatório?l_fFormulárioorm_reference

CHAR

Referência do formulário.SimFormulário

CHAR

Nome do formulário cadastrado no programa "FRM0003 - Formulários de Parâmetros/Processamento".SimRecordRECORDVariável RECORD que irá controlar o conteúdo dos campos monovalorados do formulário.NãoArray of RecordARRAY OF RECORDVariável ARRAY OF RECORD que irá controlar o conteúdo dos campos multivalorados do formulário.Não

Importante: a ordem das variáveis deve ser sempre a mesma, independente do formulário ter ou não campos monovalorados ou multivalorados, primeiro o RECORD para os campos monovalorados e depois o ARRAY OF RECORD para os campos multivalorados.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

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

 
     #Ativa o zoom de itens
     CALL _ADVPL_get_property(m_zoom_item_reference,"ACTIVATE")
 
     #Recupera os valores selecionados no zoom
     LET l_cod_item = _ADVPL_get_property(m_zoom_item_reference,"RETURN_BY_TABLE_COLUMN","item","cod_item")
     LET l_den_item = _ADVPL_get_property(m_zoom_item_reference,"RETURN_BY_TABLE_COLUMN","item","den_item_reduz")
 
     IF  l_cod_item IS NOT NULL OR l_den_item IS NOT NULL THEN
         LET mr_tela.cod_item = l_cod_item
         LET mr_tela.den_item = l_den_item
     END IF
 
     CALL _ADVPL_set_property(m_cod_item_reference,"VALUE",mr_tela.cod_item)
     CALL _ADVPL_set_property(m_den_item_reference,"VALUE",mr_tela.den_item)
 END FUNCTION
 
#--------------------------------------------#
 FUNCTION zoommetadata_execute_zoom_empresa()
#--------------------------------------------#
     #Carrega o zoom de empresas, se o mesmo ainda não foi carregado
     IF  m_zoom_empresa_reference IS NULL THEN
         LET m_zoom_empresa_reference = _ADVPL_create_component(NULL,"LZOOMMETADATA")
         CALL _ADVPL_set_property(m_zoom_empresa_reference,"ZOOM","zoom_empresa")
         CALL _ADVPL_set_property(m_zoom_empresa_reference,"ZOOM_TYPE",1)
         CALL _ADVPL_set_property(m_zoom_empresa_reference,"ARRAY_RECORD_RETURN",ma_zoom_empresa)
     END IF
 
     #Ativa o zoom de empresas
     CALL _ADVPL_get_property(m_zoom_empresa_reference,"ACTIVATE")
 
     #Recupera a quantidade de registros selecionados no zoom
     LET mr_tela.count_empresas = _ADVPL_get_property(m_zoom_empresa_reference,"RETURN")
     CALL _ADVPL_set_property(m_count_empresas_reference,"VALUE",mr_tela.count_empresas)
 END FUNCTION

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Hierarquia

Sintaxe

Métodos GET

Método GET: ACTIVATE

Sintaxe

Método GET: RETURN_BY_TABLE_COLUMN

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ITEM_COUNT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: INDEX_VALUE

Sintaxe

Retorno

Exemplo

Método GET: TABLE_REFERENCE

Sintaxe

Retorno

Exemplo

Método GET: COMPONENT_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ITEM_SELECTED

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ZOOM_TYPE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ALWAYS_SHOW_FILTER

Sintaxe

Parâmetros

Retorno

Exemplo

Métodos SET

Método SET: ARRAY_RECORD_RETURN

Sintaxe

Parâmetros

Método SET: ZOOM_COMPONENT

Sintaxe

Parâmetros

Exemplo

Método SET: ZOOM

Sintaxe

Parâmetros

Método SET: ZOOM_TYPE

Sintaxe

Parâmetros

Método SET: SELECT_ITEM

Sintaxe

Parâmetros

Exemplo

Método SET: CLEAR_SELECT_ITEM

Sintaxe

Parâmetros

Exemplo

Método SET: SELECT_ITEM_ALL

Sintaxe

Parâmetros

Exemplo

Método SET: BEFORE_LOAD_EVENT

Sintaxe

Parâmetros

Exemplo

Método SET: AFTER_LOAD_EVENT