LISTBOX Get information

4D v15.4


LISTBOX Get information ( {* ;} objet ; info ) -> Résultat

Paramètre	Type	Description
*	Opérateur	Si spécifié, objet est un nom d’objet (chaîne) Si omis, objet est une variable
objet	Objet de formulaire	Nom d’objet (si * est spécifié) ou Variable (si * est omis)
info	Entier long	Type d’information à lire
Résultat	Entier long	Valeur courante

Description

La commande LISTBOX Get information permet de récupérer différentes informations concernant la taille et la visibilité des en-têtes, des pieds et des barres de défilement de l’objet list box désigné par les paramètres objet et *.

Si vous passez le paramètre optionnel *, vous indiquez que le paramètre objet est un nom d’objet (une chaîne). Si vous ne passez pas ce paramètre, vous indiquez que le paramètre objet est une variable. Dans ce cas, vous ne passez pas une chaîne mais une référence de variable. Pour plus d'informations sur les noms d’objets, reportez-vous à la section Objets de formulaires.

Passez dans le paramètre info un code correspondant à l’information que vous souhaitez obtenir. Vous pouvez passer une valeur ou l’une des constantes suivantes, placées dans le thème List box :

Constante	Type	Valeur	Comment
Listbox affichage barre déf hor	Entier long	2	0=masquée, 1=affichée
Listbox affichage barre déf ver	Entier long	4	0=masquée, 1=affichée
Listbox affichage entête	Entier long	0	0=masqué, 1=affiché
Listbox affichage pied	Entier long	8	0=masqué, 1=affiché
Listbox hauteur barre déf hor	Entier long	3	Hauteur en pixels
Listbox hauteur entête	Entier long	1	Hauteur en pixels
Listbox hauteur pied	Entier long	9	Hauteur en pixels
Listbox largeur barre déf ver	Entier long	5	Largeur en pixels
Listbox position barre déf hor	Entier long	6	Position du curseur en pixels
Listbox position barre déf ver	Entier long	7	Position du curseur en pixels

Les premières constantes sont utiles pour calculer la taille de la zone de list box affichée dans le formulaire.
Lorsque vous utilisez la constante Listbox hor scrollbar position ou la constante Listbox ver scrollbar position, la commande retourne la position relative du curseur de défilement par rapport à son origine, c’est-à-dire la taille de la partie masquée de la fenêtre, exprimée en pixels. Par défaut, cette position correspond à 0. Combinée par exemple aux informations relatives à la hauteur des lignes, cette valeur permet de connaître le contenu affiché dans la list box.
L'instruction LISTBOX Get information(vLB;Listbox footer height) retourne la même valeur que la commande LISTBOX Get footers height lorsque les pieds sont affichés. Dans le cas contraire, LISTBOX Get information retourne 0 alors que LISTBOX Get footers height retourne toujours la hauteur, dans ce cas théorique, des pieds.

Exemple

Soit une list box contenant des lignes d’une hauteur de 20 pixels chacune. Vous exécutez l’instruction suivante :

$déf:=LISTBOX Get information(*;"Listbox";Listbox ver scrollbar position)

Si, par exemple, $déf retourne 200, vous pouvez en déduire que la 11e ligne est actuellement la première affichée dans la list box (200/20=10, donc 10 lignes sont masquées).

Voir aussi

LISTBOX SET GRID
OBJECT SET SCROLLBAR