LISTBOX Get property
LISTBOX Get property ( {* ;} object ; property ) : any
| Paramètres | Type | Description | |
|---|---|---|---|
| * | Opérateur | → | Si passé, object est un nom d'objet (chaîne de caractères). Si omis, object est une variable |
| object | any | → | Nom de l'objet (si * est spécifié) ou Variable (si * est omis) |
| property | Integer | → | Propriété dont vous voulez obtenir la valeur |
| Résultat | Integer, Text | ← | Valeur courante |
Description
La commande LISTBOX Get property renvoie la valeur de la property de la list box ou de la colonne spécifiée à l'aide des paramètres object et *.
Si vous passez le paramètre facultatif *, vous indiquez que le paramètre object est un nom d'objet (chaîne de caractères). Si vous ne passez pas ce paramètre, vous indiquez que le paramètre object est une variable. Dans ce cas, vous passez une référence de variable au lieu d'une chaîne de caractères. Pour plus d'informations sur les noms d'objets, voir la section Propriétés des objets.
Note: Si la list box ou la colonne spécifiée à l'aide des paramètres object et * n'existe pas, la commande LISTBOX Get property renvoie -1 pour les propriétés numériques, ou une chaîne vide.
Dans le paramètre property, passez une constante indiquant la propriété dont vous voulez obtenir la valeur. Vous pouvez utiliser l'une des constantes suivantes du thème "List Box" :
| Constante | Valeur | Commentaire |
|---|---|---|
| lk allow wordwrap | 14 | Propriété Retour à la ligne S'applique à : Colonne * Valeurs possibles : lk no (0) lk yes (1) |
| lk auto row height | 31 | Propriété Hauteur de ligne automatique pour list box de type tableau S'applique à : List box ou colonne Valeurs possibles : lk no (0) lk yes (1) |
| lk background color expression | 22 | Propriété Expression couleur de fond pour les list box de type sélection d'enregistrements, collection ou entity selection S'applique à : List box ou colonne |
| lk cell horizontal padding | 36 | Propriété Marge horizontale Marge horizontale de la cellule en pixels (même valeur pour les marges gauche et droite) S'applique à : List box, colonne, en-tête, pied de page |
| lk cell vertical padding | 37 | Propriété Marge verticale Marge verticale de la cellule en pixels (même valeur pour les marges haute et basse) S'applique à : List box, colonne, en-tête, pied de page |
| lk column max width | 26 | Propriété Largeur maxi S'applique à : Colonne * |
| lk column min width | 25 | Propriété Largeur mini S'applique à : Colonne * |
| lk column resizable | 15 | Propriété Redimensionnable S'applique à : Colonne * Valeurs possibles : lk no (0) lk yes (1) |
| lk detail form name | 19 | Propriété Nom formulaire détaillé pour list box de type sélection S'applique à : List box |
| lk display footer | 8 | Propriété Afficher pieds S'applique à : List box Valeurs possibles : lk no (0) : caché lk yes (1) : affiché |
| lk display header | 0 | Propriété Afficher en-têtes S'applique à : List box Valeurs possibles : lk no (0) : caché lk yes (1) : affiché |
| lk display type | 21 | Propriété Type d'affichage pour les colonnes numériques S'applique à : Colonne * Valeurs possibles : lk numeric format (0) : affiche les valeurs au format numérique lk three states checkbox (1) : affiche les valeurs sous forme de cases à cocher à trois niveaux |
| lk double click on row | 18 | Propriété Double-clic sur ligne pour list box de type sélection S'applique à : List box Valeurs possibles : lk do nothing (0) : ne déclenche aucune action automatique lk edit record (1) : affiche l'enregistrement correspondant en mode lecture-écriture lk display record (2) : affiche l'enregistrement correspondant en mode lecture seule |
| lk extra rows | 13 | Propriété Masquer lignes vides finales S'applique à : List box Valeurs possibles : lk display (0) lk hide (1) |
| lk font color expression | 23 | Propriété Expression couleur police pour les list box de type sélection d'enregistrements, collection ou entity selection S'applique à : List box ou colonne |
| lk font style expression | 24 | Propriété Expression style pour les list box de type sélection d'enregistrements, collection ou entity selection S'applique à : List box ou colonne |
| lk hide selection highlight | 16 | Propriété Cacher surlignage sélection S'applique à : List box Valeurs possibles : lk no (0) lk yes (1) |
| lk highlight set | 27 | Nom de l'Ensemble surlignage pour list box de type sélection S'applique à : List box |
| lk hor scrollbar height | 3 | Hauteur en pixels |
| lk meta expression | 34 | Propriété Meta Info Expression pour les list box de type collection ou entity selection S'applique à : List box |
| lk movable rows | 35 | Propriété Lignes déplaçables pour les list box de type tableau S'applique à : List box (à l'exception du mode hiérarchique) Valeurs possibles : lk no (0) : Les lignes ne peuvent pas être déplacées lors de l'exécution lk yes (1) : Les lignes peuvent être déplacées lors de l'exécution (valeur par défaut). |
| lk multi style | 30 | Propriété Multistyle S'applique à : Colonne * Valeurs possibles : lk no (0) lk yes (1) |
| lk named selection | 28 | Propriété Named Selection pour list box de type sélection S'applique à : List box |
| lk resizing mode | 11 | Propriété Redimensionnement colonnes auto S'applique à : List box Valeurs possibles : lk manual (0) lk automatic (2) |
| lk row height unit | 17 | Unité de la propriété Hauteur des lignes S'applique à : List box Valeurs possibles : lk lignes (1) lk pixels (0) |
| lk selection mode | 10 | Propriété Mode de sélection S'applique à : List box Valeurs possibles : lk none (0) lk single (1) lk multiple (2) |
| lk single click edit | 29 | Propriété Saisie sur clic unique S'applique à : List box Valeurs possibles : lk no (0) lk yes (1) |
| lk sortable | 20 | Propriété Triable S'applique à : List box Valeurs possibles : lk no (0) lk yes (1) |
| lk truncate | 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 | 5 | Largeur en pixels |
| lk current item expression | 38 | Propriété Élément courant S'applique à : List box (Collection / Entity selection) |
| lk current item pos expression | 39 | Propriété Position élément courant S'applique à : List box (Collection / Entity selection) |
| lk selected items expression | 40 | Propriété Eléments sélectionnés S'applique à : List box (Collection / Entity selection) |
* Ces propriétés ne s'appliquent qu'aux colonnes de la list box ; si vous passez une list box en paramètre avec une de ces propriétés, LISTBOX Get property retourne -1, ou une chaîne vide, selon la property passée.
En général, pour signaler un résultat invalide, LISTBOX Get property renvoie -1 lors de la récupération de propriétés ayant des valeurs numériques, ou une chaîne vide ; cependant, aucune erreur n'est générée. Plus précisément, cela se produit dans les cas suivants :
- Si vous passez une property qui n'existe pas
- Si vous passez une property qui n'est pas disponible pour la list box ou la colonne spécifiée, par exemple si vous passez la propriété lk font color expression avec une list box de type tableau
- Si vous passez une colonne comme paramètre avec une property appliquée à une list box, et vice versa si vous passez une list box comme paramètre avec une property appliquée à une colonne (voir * ci-dessus)
En outre, il n'est pas possible de renvoyer des valeurs provenant de plus d'une colonne à la fois ; si vous essayez d'utiliser le symbole "@" dans le nom d'une colonne pour indiquer plusieurs colonnes avec des noms similaires, LISTBOX Get property renvoie la première valeur correspondante qu'il trouve ; par conséquent, la valeur renvoyée n'a pas de véritable signification.
Note:
- Les constantes lk display footer et lk display header sont utiles pour calculer la taille réelle d'une zone de list box dans un formulaire.
Exemple 1
Soit une list box "MyListbox", si vous exécutez l'instruction suivante :
$Value:=LISTBOX Get property(*;"MyListbox";lk selection mode) // la valeur retournée indique le mode de sélection
Dans ce cas, le résultat retourné indique si plusieurs lignes peuvent être sélectionnées.
Exemple 2
Soit une list box "MyListbox", si vous exécutez l'instruction suivante :
$resizable:=LISTBOX Get property(*;"MyListbox";lk column resizable)
LISTBOX Get property retourne -1 parce que la propriété lk column resizable s'applique aux colonnes et qu'une list box a été passée en paramètre.
Voir également
LISTBOX SET GRID
LISTBOX SET PROPERTY
OBJECT SET SCROLLBAR
Propriétés
| Numéro de commande | 917 |
| Thread safe | ✗ |