LISTBOX Lire propriete

4D v20 R7


LISTBOX Lire propriete ( {* ;} 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 Lire propriete 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 Lire propriete 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	Valeur	Comment
lk affichage entête	0	Propriété Afficher en-têtes S'applique à : List box Valeurs possibles : lk non (0) : masqué lk oui (1) : affiché
lk affichage pied	8	Propriété Afficher pieds S'applique à : List box Valeurs possibles : lk non (0) : masqué lk oui (1) : affiché
lk cell horizontal padding	36	Padding horizontal de la cellule en pixels (même valeur pour le padding gauche et droit) S'applique à : List box, colonne, en-tête, pied de page
lk cell vertical padding	37	Padding vertical de la cellule en pixels (même valeur pour le padding haut et bas) S'applique à : List box, colonne, en-tête, pied de page
lk colonne largeur max	26	Propriété Largeur maxi S'applique à : Colonne*
lk colonne largeur min	25	Propriété Largeur mini S'applique à : Colonne*
lk colonne redimensionnable	15	Propriété Redimensionnable S'applique à : Colonne* Valeurs possibles : lk non (0) lk oui (1)
lk double clic sur ligne	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 ensemble surlignage	27	Propriété Ensemble surlignage des list box de type sélection S'applique à : List box
lk expression couleur de fond	22	Propriété Expression couleur de fond des list box de type sélection, collection ou entity selection. S'applique à : List box ou Colonne
lk expression couleur de police	23	Propriété Expression couleur de police des list box de type sélection, collection ou entity selection. S'applique à : List box ou Colonne
lk expression style de police	24	Propriété Expression style des list box de type sélection, collection ou entity selection S'applique à : List box ou Colonne
lk hauteur barre déf hor	3	Hauteur en pixels
lk hauteur ligne auto	31	Propriété Hauteur de ligne automatique des list box de type tableau S'applique à : List box ou Colonne Valeurs possibles : lk non (0) lk oui (1) 4D View Pro : Cette fonction nécessite une licence 4D View Pro. Pour plus d'informations, veuillez vous reporter à la section 4D View Pro.
lk largeur barre déf ver	5	Largeur en pixels
lk ligne déplaçable	35	La propriété Lignes Déplaçables pour list box de type tableau S'applique à : List box (hors mode hiéarchique) Valeurs possibles : lk non (0) : Les lignes ne peuvent pas être déplacées à l'exécution) lk oui (1) : Les lignes peuvent être déplacées à l'exécution (par défaut)
lk lignes vides finales	13	Propriété Masquer lignes vides finales S'applique à : List box Valeurs possibles : lk afficher (0) lk masquer (1)
lk masquer surlignage sélection	16	Propriété Masquer surlignage sélection S'applique à : List box Valeurs possibles : lk non (0) lk oui (1)
lk mode de sélection	10	Propriété Mode de sélection S'applique à : List box Valeurs possibles : lk aucun (0) lk ligne unique (1) lk multilignes (2)
lk mode redimensionnement	11	Propriété Redimensionnement colonnes auto S'applique à : List box Valeurs possibles : lk manuel (0) lk automatique (2)
lk multistyle	30	Propriété Multistyle S'applique à : Colonne* Valeurs possibles : lk non (0) lk oui (1)
lk nom formulaire détaillé	19	Propriété Nom formulaire détaillé pour les list box de type sélection S'applique à : List box
lk retour à la ligne	14	Propriété Retour à la ligne S'applique à : Colonne* Valeurs possibles : lk non (0) lk oui (1)
lk saisie sur clic unique	29	Propriété Saisie sur clic unique S'applique à : List box Valeurs possibles : lk non (0) lk oui (1)
lk sélection temporaire	28	Nom de la Sélection temporaire pour une list box de type sélection S'applique à : List box
lk triable	20	Propriété Triable S'applique à : List box Valeurs possibles : lk non (0) lk oui (1)
lk tronquer	12	Propriété Tronquer avec ellipse S'applique à : List box ou Colonne Valeurs possibles : lk sans ellipse (0) lk avec ellipse (1)
lk type affichage	21	Propriété Type d'affichage pour les colonnes numériques S'applique à : Colonne* Valeurs possibles : lk format numérique (0) lk case à cocher trois états (1)
lk unité hauteur lignes	17	Unité de la propriété Hauteur des lignes S'applique à : List box Valeurs possibles : lk pixels (0) lk lignes (1)

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

En général, pour signaler un résultat invalide LISTBOX Lire propriete 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 expression syle de police 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 Lire propriete retournera la première valeur correspondante trouvée, elle ne sera donc pas significative.

Notes :

Les constantes lk affichage entête et lk affichage pied sont utiles pour calculer la taille de la zone de list box affichée dans le formulaire.
Lorsque vous utilisez la constante _O_lk position barre déf hor ou la constante _O_lk position barre déf ver, 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 OBJET LIRE DEFILEMENT.
L'instruction LISTBOX Lire propriete(vLB;_O_lk hauteur pied) retourne la même valeur que la commande LISTBOX Lire hauteur pieds lorsque les pieds sont affichés. Dans le cas contraire, LISTBOX Lire propriete retourne 0 alors que LISTBOX Lire hauteur pieds 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 Lire propriete(*;"MyListbox";lk mode de sélection)

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

Exemple 2

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

$resizable:=LISTBOX Lire propriete(*;"MyListbox";lk colonne redimensionnable)

LISTBOX Lire propriete retourne -1 car une list box est passée en paramètre alors que la propriété lk colonne redimensionnable s'applique aux colonnes.

Voir aussi

LISTBOX FIXER GRILLE
LISTBOX FIXER PROPRIETE
OBJET FIXER BARRES DEFILEMENT