LISTBOX Get property

4D v18


LISTBOX Get property ( {* ;} objeto ; propriedade ) -> 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)
propriedade	Inteiro longo	Informação a obter
Resultado	Inteiro longo, String	Valor atual

Descrição

O comando LISTBOX Get property 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 .

Nota: se o list box ou coluna especificado utilizando os parâmetros objeto e * não existir, o comando LISTBOX Get property devolve -1 para as propriedades numéricas ou uma string vazia.

No parâmetro propriedade, 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
_o_lk display hor scrollbar	Inteiro longo	2	*Constante obsoleta* Utilizar o comando OBJECT GET SCROLLBAR.
_o_lk display ver scrollbar	Inteiro longo	4	*Constante obsoleta* Utilizar o comando OBJECT GET SCROLLBAR.
_o_lk footer height	Inteiro longo	9	*Constante obsoleta* Utilizar o comando LISTBOX Get footers height.
_o_lk header height	Inteiro longo	1
_o_lk hor scrollbar position	Inteiro longo	6	*Constante obsoleta* Utilizar o comando OBJECT GET SCROLL POSITION.
_o_lk ver scrollbar position	Inteiro longo	7	*Constante obsoleta* Utilizar o comando OBJECT GET SCROLL POSITION.
lk allow wordwrap	Inteiro longo	14
lk background color expression	Cadeia	22	Propriedade Background Color Expression para list box de tipo seleção Aplica a: List box ou coluna
lk column max width	Inteiro longo	26	Propriedade Maximum Width Aplica a: Coluna*
lk column min width	Inteiro longo	25	Minimum Width propriedade Aplicada a: Coluna*
lk column resizable	Inteiro longo	15	Propriedade Resizable Aplica a: Coluna* Valores possíveis: lk no (0) lk yes (1)
lk detail form name	Cadeia	19	Propriedade Detail Form Name para a seleção de tipo list box Aplica a: List box
lk display footer	Inteiro longo	8	0=oculto, 1=mostrado
lk display header	Inteiro longo	0	0=oculto, 1=mostrado
lk display type	Inteiro longo	21
lk double click on row	Inteiro longo	18
lk extra rows	Inteiro longo	13
lk font color expression	Cadeia	23
lk font style expression	Cadeia	24
lk hide selection highlight	Inteiro longo	16
lk highlight set	Cadeia	27	Highlight Set propriedade para seleção tipo list box Aplica a: List box
lk hor scrollbar height	Inteiro longo	3	Altura em pixels
lk multi style	Inteiro longo	30	Multi-style propriedade Aplica a: Column* Valores possíveis: lk no (0) lk yes (1)
lk named selection	Cadeia	28	Propriedade Named Selection para list box de tipo seleção Aplica a: List box
lk resizing mode	Inteiro longo	11	Column Auto-Resizing proriedade Aplica a: List box Possíveis valores: lk manual (0) lk automatic (1)
lk row height unit	Inteiro longo	17	Unidade de propriedade Row Height Aplica a: List box Possíveis valores: lk lines (1) lk pixels (0)
lk selection mode	Inteiro longo	10	Propriedade Selection Mode Aplica a: List box Valores possíveis: lk none (0) lk single (1) lk multiple (2)
lk single click edit	Inteiro longo	29	Propriedade Single-Click Edit Aplica a: List box Possíveis valores: lk no (0) lk yes (1)
lk sortable	Inteiro longo	20	Propriedade Sortable Aplica a: List box Valores possíveis: lk no (0) lk yes (1)
lk truncate	Inteiro longo	12	Propriedade Truncate with ellipsis Aplica a: List box ou coluna Valores possiveis: lk without ellipsis (0) lk with ellipsis (1)
lk ver scrollbar width	Inteiro longo	5	Largura em pixels.

*Estas propriedades só se aplicam às colunas list box; se passar um list box como parâmetro com uma destas propriedades, LISTBOX Get property devolve -1, ou uma string vazia, dependendo da propriedade passada.

Em geral, para indicar um resultado não válido LISTBOX Get property devolve -1 ao recuperar as propriedades que têm valores numéricos, ou uma string vazia; Entretanto, não são gerados erros. Mais específicamente, isto ocorre nos seguintes casos:

    Se passar uma propriedade que não existir
    Se passar uma propriedade que não está disponível para a list box ou coluna especificada, por exemplo, pode passar a propriedade lk font color expression com um list box de tipo array
    Se passar uma coluna como parâmetro com uma propriedade que se aplique a um list box, e viceversa, se passar um list box como parâmetro com uma propriedade que se aplique a uma coluna (ver acima *)

Além disso, não é possível devolver valores de mais de uma coluna por vez; se tentar utilizar o símbolo "@" a parte do nome de coluna para indicar várias colunas com nomes similares, LISTBOX Get property devolve o primeiro valor coincidente que encontre; como resultado, o valor devolvido não tem verdadeira importância.

As constantes lk display footer e lk display header 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 property 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. Entretanto, estas constantes são obsoletas e podem ser substituídas pelo comando OBJECT GET SCROLL POSITION.
A declaração LISTBOX Get property(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 property retornas 0 enquanto LISTBOX Get footers height ainda retorna a altura, neste caso teórico, dos rodapés.

Exemplo 1

Dado um listbox"MyListbox", é executada a seguinte instrução:

$Value:=LISTBOX Get property(*;"MyListbox";lk selection mode) // o valor devolvido indica o modo de seleção

Neste caso, o resultado devolvido indica se várias linhas podem ser selecionadas.

Exemplo 2

Dado um list box "MyListbox", é executada a seguinte instrução:

$resizable:=LISTBOX Get property(*;"MyListbox";lk column resizable)

LISTBOX Get property devolve -1 porque a propriedade lk column resizable aplica a colunas e um list box foi passado como parâmetro.

Ver também

LISTBOX SET GRID
LISTBOX SET PROPERTY
OBJECT SET SCROLLBAR