Pagetitle

	LGX - LCONSTRUCT
	LGX - LCONSTRUCT

Cria e executa uma tela de pesquisa, onde são informados filtros utilizados na seleção de registros.

As tabelas e colunas que poderão ser filtradas podem ser informadas manualmente ou recuperadas através do conteúdo metadado.

Nesta tela podem ser informados filtros no formato básico (apenas com valores), avançado (utilizando valores e comandos especiais) e também permite definir a ordenação dos registros. Este componente não executa nenhum comando na base de dados, apenas monta um filtro no formato SQL para que seja utilizado em uma pesquisa.

Hierarquia

LCOMPONENT

Sintaxe

Bloco de código
_ADVPL_create_component( NULL, "LCONSTRUCT" )

Métodos GET

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

Expandir

title	GET INIT_CONSTRUCT

Método GET: INIT_CONSTRUCT

Inicia a execução da tela de filtro de pesquisa e retorna se o filtro foi ou não confirmado pelo usuário.

Sintaxe

Bloco de código
_ADVPL_get_property( <cReference>, "INIT_CONSTRUCT" ) => Boolean

Retorno

Tipo	Descrição
`BOOLEAN`	Verdadeiro se o filtro foi confirmado pelo usuário, falso se foi cancelado

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

  LET l_status = _ADVPL_get_property( <cReference>, "INIT_CONSTRUCT" )

Expandir

title	GET WHERE_CLAUSE

Método GET: WHERE_CLAUSE

Retorna o filtro informado na tela de pesquisa, no formato SQL.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "WHERE_CLAUSE" ) => Char

Retorno

Tipo	Descrição
`CHAR`	Filtro informado na tela de pesquisa no formato SQL.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_where_clause = _ADVPL_get_property( <cReference>, "WHERE_CLAUSE" )

Expandir

title	GET WHERE_CLAUSE_TABLE_COLUMN

Método GET: WHERE_CLAUSE_TABLE_COLUMN

Retorna o filtro no formato SQL, informado para determinada coluna da tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "WHERE_CLAUSE_TABLE_COLUMN", <cTable>, <cColumn> ) => Char

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	CHAR	Nome da tabela da coluna.	Sim
cColumn	CHAR	Nome da coluna.	Sim

Retorno

Tipo	Descrição
`CHAR`	Filtro no formato SQL informado para a coluna.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_where_clause = _ADVPL_get_property( <cReference>, "WHERE_CLAUSE_TABLE_COLUMN", <cTable>, <cColumn> )

Expandir

title	GET ORDER_BY

Método GET: ORDER_BY

Retorna a ordenação informada na tela de pesquisa, no formato SQL.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "ORDER_BY") => Char

Retorno

Tipo	Descrição
`CHAR`	Ordenação informada na tela de pesquisa, no formato SQL.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_order_by = _ADVPL_get_property( <cReference>, "ORDER_BY" )

Expandir

title	GET CONSTRUCT_NAME

Método GET: CONSTRUCT_NAME

Retorna o nome identificador definido para o componente.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "CONSTRUCT_NAME") => Char

Retorno

Tipo	Descrição
`CHAR`	Nome identificador definido para o componente.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_construct_name = _ADVPL_get_property( <cReference>, "CONSTRUCT_NAME" )

Expandir

title	GET WHERE_CLAUSE_BY_TABLE

Método GET: WHERE_CLAUSE_BY_TABLE

Retorna o filtro no formato SQL, informado para determinada tabela da tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "WHERE_CLAUSE_BY_TABLE", <cTable>) => Char

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	CHAR	Nome da tabela.	Sim

Retorno

Tipo	Descrição
`CHAR`	Filtro no formato SQL, informado para a tabela.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_where_clause = _ADVPL_get_property( <cReference>, "WHERE_CLAUSE_BY_TABLE", <cTable> )

Expandir

title	GET ORDER_BY_TABLE

Método GET: ORDER_BY_TABLE

Retorna a ordenação no formato SQL, informado para determinada tabela da tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_get_property( < creference >, "ORDER_BY_TABLE", <cTable> ) => Char

Retorno

Tipo	Descrição
`CHAR`	Ordenação no formato SQL informado para a tabela.

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	CHAR	Nome da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

LET l_order_by = _ADVPL_get_property( <cReference>, "ORDER_BY", <cTable> )

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 TEXT ADD_TABLE

Método SET:

TEXT

ADD_TABLE

Adiciona uma tabela, cadastrada no metadado, na tela de pesquisaTexto descritivo criado à direita do componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_checkbox_referencecReference >,"TEXTADD_TABLE",< TextocTable >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`Texto` cTable	CHARTexto	que descreve o componente, criado à direita do componenteNome da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_checkbox_reference,"TEXT","Permite valor nulo?" <cReference>, "ADD_TABLE", <cTable> )

Expandir

title	SET VALUEADD_CHECKEDCOLUMN

Método SET:

VALUE

ADD_

CHECKED

COLUMN

Valor quando a caixa de seleção estiver assinalada.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_checkbox_referencecReference >,"VALUEADD_CHECKED",< valor >COLUMN",, <cTable>, <cColumn>, [cParent], [cZoom])

Parâmetros

Sim

Nome	Tipo	Descrição	Obrigatório?	`valor`
cTable	`CHAR`	Nome da tabela da coluna.	Sim
cColumn	`CHAR`	Nome da coluna.	Sim
cParent	`CHAR`	Nome do objeto pai da coluna (para colunas virtuais).	opcional, padrão: NULL
cZoom	`CHAR`	Nome do zoom da coluna.	opcional, padrão: NULL	`QUALQUER`	Valor que a variável do componente receberá quando a caixa de seleção estiver assinalada.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_checkbox_reference,"VALUE_CHECKED","S" <cReference>, "ADD_COLUMN", <cTable>, <cColumn>, [cParent], [cZoom] )

Expandir

title	SET VALUEADD_VIRTUAL_NCHECKEDTABLE

Método SET:

VALUE

ADD_VIRTUAL_

NCHECKED

TABLE

Adiciona uma tabela na tela de pesquisa

Valor quando a caixa de seleção NÃO estiver assinalada.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_checkbox_reference >,"VALUE_NCHECKED",< valor > <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`valor`cTable	`QUALQUER`	`CHAR`	Nome da tabelaValor que a variável do componente receberá quando a caixa de seleção NÃO estiver assinalada.	Sim

No Logix, por padrão, quando criado um componente deste tipo, a descrição em tela deve ser criado à direita do componente através do método TEXT.


cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#--------------------# FUNCTION LCheckBox()#--------------------#
   CALL  DEFINE l_dialog_reference   VARCHAR(10)
     DEFINE l_checkbox_reference VARCHAR(10)

     LET l_dialog_reference = _ADVPL_create_component(NULL,"LDIALOG")
     CALL _ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Expandir

title	SET ADD_VIRTUAL_COLUMN

Método SET: ADD_VIRTUAL_COLUMN

Adiciona uma coluna da tabela na tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_set_property( <cReference>, "ADD_VIRTUAL_COLUMN", <cTable>, <cColumn>, <cLabel>, <nType>, <nSize>, [nPrecision], [cZoom], [cPicture] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela da coluna.	Sim
cColumn	`CHAR`	Nome da coluna.
cLabel	`CHAR`	Descrição da tabela.	Sim
nType	`INTEGER`	Tipo de dado da coluna, sendo: 1–CHAR, 2–SMALLINT, 3–INTEGER, 4–DECIMAL, 5–DATE, 6–DATETIME, 7–VARCHAR, 8–SERIAL e 9–IMAGE	Sim
nSize	`INTEGER`	Tamanho da coluna.	Sim
nPrecision	`INTEGER`	Precisão da coluna.	opcional, padrão: 0
cZoom	`CHAR`	Nome do zoom da coluna.	opcional, padrão: NULL
cPicture	`CHAR`	Máscara de edição da coluna * válido a partir do pacote Logix 12.1.15 *	opcional, padrão: NULL

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property( <cReference>, "ADD_VIRTUAL_COLUMN", <cTable>, <cColumn>, <cLabel>, <nType>, <nSize>, [nPrecision], [cZoom], [cPicture] )

Expandir

title	SET VISIBLE_ORDER_BY

Método SET: VISIBLE_ORDER_BY

Habilita/desabilita a aba de ordenação de registros.

Sintaxe

Bloco de código
_ADVPL_set_property(l <cReference>, "VISIBLE_ORDER_BY", <nVisible>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
nVisible	`BOOLEAN`	Verdadeiro para habilitar a aba de ordenação, falso para desabilitar.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

    _dialog_reference,"SIZE",160,120)
     CALL _ADVPL_set_property(l_dialog_reference, <cReference>, "VISIBLE_ORDER_BY", <nVisible> )

Expandir

title	SET ADD_VIRTUAL_TABLE

Método SET: A

Adiciona uma tabela na tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela.	Sim
cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

"TITLE","Ex.: LCHECKBOX")
     CALL _ADVPL_set_property(l_dialog_reference,"BACKGROUND_ <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Expandir

title	SET ADD_VIRTUAL_TABLE

Método SET: A

Adiciona uma tabela na tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela.	Sim
cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

COLOR",210,210,210)

     LET l_checkbox_reference = _ADVPL_create_component(NULL,"LCHECKBOX",l_dialog_reference)

     CALL _ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Expandir

title	SET ADD_VIRTUAL_TABLE

Método SET: A

Adiciona uma tabela na tela de pesquisa.

Sintaxe

Bloco de código
l_checkbox_reference,"POSITION",05,05) CALL _ADVPL_set_property(l_checkbox_ <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela.	Sim
cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

reference,"VALUE_CHECKED","S")
     CALL _ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Expandir

title	SET ADD_VIRTUAL_TABLE

Método SET: A

Adiciona uma tabela na tela de pesquisa.

Sintaxe

Bloco de código
_l_checkbox_reference,"VALUE_NCHECKED","N") CALL _ADVPL_set_property(l_checkbox_reference," <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela.	Sim
cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

TEXT","Permite valor nulo?")
     CALL _ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Expandir

title	SET ADD_VIRTUAL_TABLE

Método SET: A

Adiciona uma tabela na tela de pesquisa.

Sintaxe

Bloco de código
_ADVPL_set_property( <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cTable	`CHAR`	Nome da tabela.	Sim
cLabel	CHAR	Descrição da tabela.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

l_dialog_reference,"MAXIMIZED",FALSE)
     CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE) END FUNCTION <cReference>, "ADD_VIRTUAL_TABLE", <cTable>, <cLabel> )

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Hierarquia

Sintaxe

Métodos GET

Método GET: INIT_CONSTRUCT

Sintaxe

Retorno

Exemplo

Método GET: WHERE_CLAUSE

Sintaxe

Retorno

Exemplo

Método GET: WHERE_CLAUSE_TABLE_COLUMN

Sintaxe

Parâmetros

Método GET: ORDER_BY

Sintaxe

Retorno

Método GET: CONSTRUCT_NAME

Sintaxe

Retorno

Exemplo

Método GET: WHERE_CLAUSE_BY_TABLE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ORDER_BY_TABLE

Sintaxe

Retorno

Parâmetros

Exemplo

Métodos SET

Método SET:

ADD_TABLE

Sintaxe

Parâmetros

Exemplo

Método SET:

ADD_

COLUMN

Sintaxe

Parâmetros

Exemplo

Método SET:

ADD_VIRTUAL_

TABLE

Sintaxe

Parâmetros

Exemplo

Método SET: ADD_VIRTUAL_COLUMN

Sintaxe

Parâmetros

Exemplo

Método SET: VISIBLE_ORDER_BY

Sintaxe

Parâmetros

Exemplo

Método SET: A

Sintaxe

Parâmetros

Exemplo

Método SET: A

Sintaxe

Parâmetros

Exemplo

Método SET: A

Sintaxe

Parâmetros

Exemplo

Método SET: A

Sintaxe

Parâmetros

Exemplo

Método SET: A