LISTBOX Get information

4D v16.3


LISTBOX Get information ( {* ;} objeto ; info ) -> Resultado

Parâmetro	Tipo	Descrição
*	Operador	Se especificado, objeto é um nome de objeto (string). Se omitido, objeto é uma variável
objeto	Objeto de formulário	Nome objeto (se * for especificado) ou Variável (se * é omitido)
info	Inteiro longo	Informação a obter
Resultado	Inteiro longo	Valor atual

Descrição

O comando LISTBOX Get information devolve diferente informação relacionada com o tamanho e a visibilidade dos títulos e as barras de rolagem do objeto list box designado usandoos parâmetros objeto e *.

Se passa o parâmetro opcional *, indica que o parâmetro objeto é um nome de objeto (string). Se omitir este parâmetro, indica que o parâmetro objeto é uma variável. Nesse caso, não passa uma string, mas uma referência de variável. Para maior informação sobre nomes de objetos, consulte a seção Propriedades dos objetos .

No parâmetro info, passe um valor indicando o tipo de informação que queira obter. Pode utilizar um valor ou uma das seguintes constantes do tema List box:

Constante	Tipo	Valor	Comentário
lk display footer	Inteiro longo	8	0=oculto, 1=mostrado
lk display header	Inteiro longo	0	0=oculto, 1=mostrado
lk display hor scrollbar	Inteiro longo	2	0=oculto, 1=mostrado
lk display ver scrollbar	Inteiro longo	4
lk footer height	Inteiro longo	9	Altura em pixels
lk header height	Inteiro longo	1	Altura em pixels
lk hor scrollbar height	Inteiro longo	3	Altura em pixels
lk hor scrollbar position	Inteiro longo	6	Posição do cursor em pixels
lk ver scrollbar position	Inteiro longo	7	Posição do cursor em pixels.
lk ver scrollbar width	Inteiro longo	5	Largura em pixels.

As primeiras constantes são úteis para calcular o tamanho de uma área de list box em um formulário.
Quando utilize as constantes lk hor scrollbar position ou lk ver scrollbar position, o comando LISTBOX Get information devolve a posição do cursor de rolagem em relação com sua posição original, ou seja, o tamanho da parte oculta da janela, expresso em píxels. Como padrão, esta posição corresponde a 0. Combinando, por exemplo, com informação relativa à altura da fila, este valor lhe permite encontrar o conteúdo mostrado no listbox.
A declaração LISTBOX Get information(vLB;lk footer height) retorna o mesmo valor que o comando LISTBOX Get footers height quando rodapés são exibidos. No entanto, se rodapés não são exibidos, LISTBOX Get information retornas 0 enquanto LISTBOX Get footers height ainda retorna a altura, neste caso teórico, dos rodapés.

Exemplo

Dado uma list box que contenha filas com uma altura de 20 píxels cada uma. Se executar a seguinte instrução:

$scroll:=LISTBOX Get information(*;"Listbox";lk ver scrollbar position)

Se, por exemplo, $scroll devolve 200, pode concluir que a décima-primeira fila é atualmente a primeira mostrada no list box (200/20=10, portanto 10 filas estão ocultas).

Ver também

LISTBOX SET GRID
OBJECT SET SCROLLBAR