Saltar para o conteúdo principal
Versão: Próximo

LISTBOX Get property

LISTBOX Get property ( {* ;} objeto ; propriedade ) -> Resultado

ParâmetroTipoDescrição
*OperadorSe especificado, objeto é um nome de objeto (string). Se omitido, objeto é uma variável
objetoanyNome objeto (se * for especificado) ou Variável (se * é omitido)
propriedadeIntegerInformação a obter
ResultadoInteger, TextValor atual

Esse comando não é seguro para thread e não pode ser usado em código adequado.

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:

ConstanteValorComentário
lk allow wordwrap14Propriedade Retorno de linha
Aplica a: Coluna*
Valores possíveis:
lk no (0)lk yes (1)
lk auto row height31Propriedade Altura de fila automática.
Aplica a: List box ou coluna
Valores possíveis:lk yes lk no4D View Pro apenas: esta funcionalidade requer uma licença 4D View Pro. Para mais informação, consulte 4D View Pro.
lk background color expression22Propriedade Background Color Expression para list box de tipo seleção
Aplica a: List box ou coluna
lk cell horizontal padding36Padding horizontal da célula em pixels (mesmo valor para a distância da borda ao conteúdo a partir da esquerda ou direita) Se aplica a: list box, coluna, cabeçalho rodapé
lk cell vertical padding37Padding vertical da célula em pixels (mesmo valor para a distância do conteúdo à borda superior ou inferior) Se aplica a: list box, coluna, cabeçalho, rodapé
lk column max width26Propriedade Maximum Width
Aplica a: Coluna*
lk column min width25Minimum Width propriedade
Aplicada a: Coluna*
lk column resizable15Propriedade Resizable
Aplica a: Coluna*
Valores possíveis:
lk no (0)lk yes (1)
lk detail form name19Propriedade Detail Form Name para a seleção de tipo list box
Aplica a: List box
lk display footer80=oculto, 1=mostrado
lk display header00=oculto, 1=mostrado
lk display type21Propriedade Tipo de visualização para colunas numéricas
Aplica a: Coluna*
Valores possíveis:**
**lk numeric format (0): mostra valores em formato numéricolk three states checkbox (1): mostra valores como caixas de seleção de três estados
lk double click on row18Propriedade Duplo clique na linha para os list box de tipo seleção
Aplica a: List box
Valores possíveis:lk do nothing (0): não desencadeia nenhuma ação automáticalk edit record (1): mostra o registro correspondente em modo leitura-escrituralk display record (2): mostra o registro correspondente em modo de apenas leitura
lk extra rows13Propriedade Ocultar linhas vazias finais
Aplica a: List box
Valores possíveis:**
**lk display (0)lk hide (1)
lk font color expression23Propriedade Expressão cor fontepara list box de tipo seleção
Aplica a: List box ou coluna
lk font style expression24Propriedade Expressão estilo para list boxes de tipo seleção e coleção
Aplica a: List box ou coluna
lk hide selection highlight16Propriedade Ocultar ressaltado de seleção
Aplica a: List box
Valores possíveis:**
**lk no (0)lk yes (1)
lk highlight set27Highlight Set propriedade para seleção tipo list box
Aplica a: List box
lk hor scrollbar height3Altura em pixels
lk movable rows35A propriedade Linhas móveis para list box de tipo array
Se aplica a: List box (excluindo o modo hierárquico)
Valores possíveis: lk no (0): as linhas não podem ser movidas o se pueden mover durante execução lk yes (1): as linhas podem ser movidas durante execução (pré-determinado)
lk multi style30Multi-style propriedade
Aplica a: Column*
Valores possíveis:
lk no (0)lk yes (1)
lk named selection28Propriedade Named Selection para list box de tipo seleção
Aplica a: List box
lk resizing mode11Column Auto-Resizing proriedade
Aplica a: List box
Possíveis valores:
lk manual (0)lk automatic (2)
lk row height unit17Unidade de propriedade Row Height
Aplica a: List box
Possíveis valores:**
**lk lines (1)
lk pixels (0)
lk selection mode10Propriedade Selection Mode
Aplica a: List box
Valores possíveis: **
**lk none (0)
lk single (1)
lk multiple (2)
lk single click edit29Propriedade Single-Click Edit
Aplica a: List box
Possíveis valores:
lk no (0)lk yes (1)
lk sortable20Propriedade Sortable
Aplica a: List box
Valores possíveis:**
**lk no (0)lk yes (1)
lk truncate12Propriedade Truncate with ellipsis
Aplica a: List box ou coluna
Valores possiveis:**
**lk without ellipsis (0)lk with ellipsis (1)
lk ver scrollbar width5Largura 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