LISTBOX Get property

4D v20 R7


LISTBOX Get property ( {* ;} objet ; propriété ) -> 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)
propriété	Entier long	Propriété dont vous souhaitez connaître la valeur
Résultat	Entier long, Chaîne	Valeur courante

Description

La commande LISTBOX Get property retourne la valeur courante de la propriété de list box ou de colonne de list box désignée 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.

Note : Si la list box ou la colonne de list box désignée par les paramètres objet et * n'existe pas, la commande LISTBOX Get property retourne -1 pour les propriétés numériques ou une chaîne vide.

Passez dans le paramètre propriété une constante indiquant la propriété à lire. Vous pouvez passer l’une des constantes suivantes, placées dans le thème List box :

Constante	Type	Valeur	Comment
_o_lk display hor scrollbar	Entier long	2	*Constante obsolète* Utiliser la commande OBJECT GET SCROLLBAR.
_o_lk display ver scrollbar	Entier long	4	*Constante obsolète* Utiliser la commande OBJECT GET SCROLLBAR.
_o_lk footer height	Entier long	9	*Constante obsolète* Utiliser la commande LISTBOX Get footers height.
_o_lk header height	Entier long	1	*Constante obsolète* Utiliser la commande LISTBOX Get headers height.
_o_lk hor scrollbar position	Entier long	6	*Constante obsolète* Utiliser la commande OBJECT GET SCROLL POSITION.
_o_lk ver scrollbar position	Entier long	7	*Constante obsolète* Utiliser la commande OBJECT GET SCROLL POSITION.
lk allow wordwrap	Entier long	14	Propriété Retour à la ligne S'applique à : Colonne* Valeurs possibles : lk non (0) lk oui (1)
lk background color expression	Chaîne	22	Propriété Expression couleur de fond des list box de type sélection S'applique à : List box ou Colonne
lk column max width	Entier long	26	Propriété Largeur maxi S'applique à : Colonne*
lk column min width	Entier long	25	Propriété Largeur mini S'applique à : Colonne*
lk column resizable	Entier long	15	Propriété Redimensionnable S'applique à : Colonne* Valeurs possibles : lk no (0) lk yes (1)
lk detail form name	Chaîne	19	Propriété Nom formulaire détaillé pour les list box de type sélection S'applique à : List box
lk display footer	Entier long	8	Propriété Afficher pieds S'applique à : List box Valeurs possibles : lk no (0) : masqué lk yes (1) : affiché
lk display header	Entier long	0	Propriété Afficher en-têtes S'applique à : List box Valeurs possibles : lk no (0) : masqué lk yes (1) : affiché
lk display type	Entier long	21	Propriété Type d'affichage pour les colonnes numériques S'applique à : Colonne* Valeurs possibles : lk numeric format (0) lk three states checkbox (1)
lk double click on row	Entier long	18	Propriété Double-clic sur ligne des list box de type sélection S'applique à : List box Valeurs possibles : lk ne rien faire (0) : n'effectue aucune action automatique lk modifier enregistrement (1) : affiche l'enregistrement correspondant en mode lecture écriture lk afficher enregistrement (2) : affiche l'enregistrement correspondant en mode lecture seule
lk extra rows	Entier long	13	Propriété Masquer lignes vides finales S'applique à : List box Valeurs possibles : lk display (0) lk hide (1)
lk font color expression	Chaîne	23	Propriété Expression couleur de police des list box de type sélection S'applique à : List box ou Colonne
lk font style expression	Chaîne	24	Propriété Expression style des list box de type sélection S'applique à : List box ou Colonne
lk hide selection highlight	Entier long	16	Propriété Masquer surlignage sélection S'applique à : List box Valeurs possibles : lk no (0) lk yes (1)
lk highlight set	Chaîne	27	Propriété Ensemble surlignage des list box de type sélection S'applique à : List box
lk hor scrollbar height	Entier long	3	Hauteur en pixels
lk multi style	Entier long	30	Propriété Multistyle S'applique à : Colonne* Valeurs possibles : lk no (0) lk yes (1)
lk named selection	Chaîne	28	Nom de la Sélection temporaire pour une list box de type sélection S'applique à : List box
lk resizing mode	Entier long	11	Propriété Redimensionnement colonnes auto S'applique à : List box Valeurs possibles : lk manual (0) lk automatic (1)
lk row height unit	Entier long	17	Unité de la propriété Hauteur des lignes S'applique à : List box Valeurs possibles : lk pixels (0) lk lines (1)
lk selection mode	Entier long	10	Propriété Mode de sélection S'applique à : List box Valeurs possibles : lk none (0) lk single (1) lk mulltiple (2)
lk single click edit	Entier long	29	Propriété Saisie sur clic unique S'applique à : List box Valeurs possibles : lk no (0) lk yes (1)
lk sortable	Entier long	20	Propriété Triable S'applique à : List box Valeurs possibles : lk no (0) lk yes (1)
lk truncate	Entier long	12	Propriété Tronquer avec ellipse S'applique à : List box ou Colonne Valeurs possibles : lk without ellipsis (0) lk with ellipsis (1)
lk ver scrollbar width	Entier long	5	Largeur en pixels

*Cette propriété est applicable aux colonnes de list box uniquement ; si vous passez une list box en paramètre, LISTBOX Get property retournera -1 ou une chaîne vide, suivant la propriété.

En général, pour signaler un résultat invalide LISTBOX Get property retournera -1 pour les propriétés à valeur numérique, ou une chaîne vide pour les autres. Aucune erreur n'est générée. Cela peut se produire notamment dans les cas suivants :

Si vous passez une propriété qui n'existe pas
Si vous passez une propriété qui n'est pas disponible pour la list box ou la colonne spécifiée (par exemple lk font color expression appliquée à une list box de type tableau)
Si vous passez une colonne en paramètre avec une propriété de list box ou inversement (voir * ci-dessus).

De plus, il n'est pas possible de retourner des valeurs pour plus d'une colonne à la fois. Si vous utilisez le caractère "@" afin de désigner plusieurs colonnes, LISTBOX Get property retournera la première valeur correspondante trouvée, elle ne sera donc pas significative.

Notes :

Les constantes lk display footer et lk display header sont utiles pour calculer la taille de la zone de list box affichée dans le formulaire.
Lorsque vous utilisez la constante _o_lk hor scrollbar position ou _o_lk 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. Ces constantes sont désormais obsolètes et pourront être avantageusement remplacées par la commande OBJECT GET SCROLL POSITION.
L'instruction LISTBOX Get property(vLB;_o_lk 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 property retourne 0 alors que LISTBOX Get footers height retourne toujours la hauteur, dans ce cas théorique, des pieds.

Exemple 1

Soit une list box "MyListbox", si vous exécutez l’instruction suivante :

$selMode:=LISTBOX Get property(*;"MyListbox";lk selection mode)

$selMode vaut 0, 1 ou 2 suivant le mode de sélection courant de la list box.

Exemple 2

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";lk 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
LISTBOX SET PROPERTY
OBJECT SET SCROLLBAR