Aller au contenu principal
Version: 20 R7 BETA

LISTBOX Get property

LISTBOX Get property ( {* ;} objet ; propriété ) : any

ParamètreTypeDescription
*OpérateurSi spécifié, objet est un nom d’objet (chaîne) Si omis, objet est une variable
objetanyNom d’objet (si * est spécifié) ou Variable (si * est omis)
propriétéIntegerPropriété dont vous souhaitez connaître la valeur
RésultatText, IntegerValeur 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 :

ConstanteTypeValeurComment
_o_lk display hor scrollbarEntier long2***Constante obsolète*** Utiliser la commande OBJECT GET SCROLLBAR.
_o_lk display ver scrollbarEntier long4***Constante obsolète*** Utiliser la commande OBJECT GET SCROLLBAR.
_o_lk footer heightEntier long9***Constante obsolète*** Utiliser la commande LISTBOX Get footers height.
_o_lk header heightEntier long1***Constante obsolète*** Utiliser la commande LISTBOX Get headers height.
_o_lk hor scrollbar positionEntier long6***Constante obsolète*** Utiliser la commande OBJECT GET SCROLL POSITION.
_o_lk ver scrollbar positionEntier long7***Constante obsolète*** Utiliser la commande OBJECT GET SCROLL POSITION.
lk allow wordwrapEntier long14Propriété Retour à la ligne
S'applique à : Colonne*
Valeurs possibles :lk non (0)lk oui (1)
lk background color expressionChaîne22Propriété Expression couleur de fond des list box de type sélection
S'applique à : List box ou Colonne
lk column max widthEntier long26Propriété Largeur maxi
S'applique à : Colonne*
lk column min widthEntier long25Propriété Largeur mini
S'applique à : Colonne*
lk column resizableEntier long15Propriété Redimensionnable
S'applique à : Colonne*
Valeurs possibles :
lk no (0)lk yes (1)
lk detail form nameChaîne19Propriété Nom formulaire détaillé pour les list box de type sélection
S'applique à : List box
lk display footerEntier long8Propriété Afficher pieds
S'applique à : List box
Valeurs possibles :
lk no (0) : masquélk yes (1) : affiché
lk display headerEntier long0Propriété **Afficher en-têtes
**S'applique à : List box
Valeurs possibles :
lk no (0) : masquélk yes (1) : affiché
lk display typeEntier long21Proprié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 rowEntier long18Proprié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 automatiquelk modifier enregistrement (1) : affiche l'enregistrement correspondant en mode lecture écriturelk afficher enregistrement (2) : affiche l'enregistrement correspondant en mode lecture seule
lk extra rowsEntier long13Propriété Masquer lignes vides finales
S'applique à : List box
Valeurs possibles :lk display (0)lk hide (1)
lk font color expressionChaîne23Propriété Expression couleur de police des list box de type sélection
S'applique à : List box ou Colonne
lk font style expressionChaîne24Propriété Expression style des list box de type sélection
S'applique à : List box ou Colonne
lk hide selection highlightEntier long16Propriété Masquer surlignage sélection
S'applique à : List box
Valeurs possibles :
lk no (0)lk yes (1)
lk highlight setChaîne27Propriété Ensemble surlignage des list box de type sélection
S'applique à : List box
lk hor scrollbar heightEntier long3Hauteur en pixels
lk multi styleEntier long30Propriété Multistyle
S'applique à : Colonne*
Valeurs possibles :lk no (0)lk yes (1)
lk named selectionChaîne28Nom de la Sélection temporaire pour une list box de type sélection
S'applique à : List box
lk resizing modeEntier long11Propriété Redimensionnement colonnes auto
S'applique à : List box
Valeurs possibles :lk manual (0)lk automatic (1)
lk row height unitEntier long17Unité de la propriété Hauteur des lignes
S'applique à : List box
Valeurs possibles :lk pixels (0)lk lines (1)
lk selection modeEntier long10Propriété Mode de sélection
S'applique à : List box
Valeurs possibles :lk none (0)lk single (1)lk mulltiple (2)
lk single click editEntier long29Propriété Saisie sur clic unique
S'applique à : List box
Valeurs possibles :lk no (0)lk yes (1)
lk sortableEntier long20Propriété Triable
S'applique à : List box
Valeurs possibles :lk no (0)lk yes (1)
lk truncateEntier long12Propriété Tronquer avec ellipse
S'applique à : List box ou Colonne
Valeurs possibles :lk without ellipsis (0)lk with ellipsis (1)
lk ver scrollbar widthEntier long5Largeur 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

Propriétés

Numéro de commande917
Thread safe