LISTBOX SELECTIONNER LIGNE

4D v16.3


LISTBOX SELECTIONNER LIGNE ( {* ;} objet ; positionLigne {; action} )

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)
positionLigne	Entier long	Numéro de la ligne à sélectionner
action	Entier long	Action de sélection

Description

La commande LISTBOX SELECTIONNER LIGNE provoque la sélection de la ligne de numéro positionLigne dans 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.

Le paramètre action, s’il est passé, permet de définir l’action de sélection à effectuer lorsqu’une sélection de lignes existe déjà dans la list box. Vous pouvez passer une valeur ou l’une des constantes suivantes, placées dans le thème List box :

Constante	Type	Valeur	Comment
lk ajouter à sélection	Entier long	1	La ligne sélectionnée est ajoutée à la sélection existante. Si la ligne désignée appartient déjà à la sélection existante, la commande ne fait rien.
lk remplacer sélection	Entier long	0	La ligne sélectionnée devient la nouvelle sélection et remplace la sélection existante. La commande produit le même effet qu’un clic de l’utilisateur sur une ligne de la list box (l'événement Sur clic n'est toutefois pas généré). Cette action est effectuée par défaut (lorsque le paramètre action n’est pas passé).
lk supprimer de sélection	Entier long	2	La ligne sélectionnée est supprimée de la sélection existante. Si la ligne désignée n’appartient pas à la sélection existante, la commande ne fait rien.

Lorsque le paramètre positionLigne ne correspond pas strictement à un numéro de ligne existante, la commande agit de la manière suivante :

Si positionLigne est <0, la commande ne fait rien, quelle que soit la valeur du paramètre action.
Si positionLigne vaut 0 et si le paramètre action contient lk remplacer sélection ou est omis, toutes les lignes de la listbox sont sélectionnées. Si le paramètre action contient lk supprimer de sélection, toutes les lignes de la listbox sont désélectionnées.
Si la valeur de positionLigne est supérieure au nombre total de lignes contenues dans la listbox (dans le cas d'une listbox de type tableau uniquement), le tableau booléen associé à la listbox est automatiquement redimensionné et l’action de sélection est effectuée. Ce mécanisme permet d’utiliser LISTBOX SELECTIONNER LIGNE avec des commandes “standard” de gestion de tableaux (telles que AJOUTER A TABLEAU) n’entraînant pas de synchronisation immédiate de la listbox.
A l’issue de l’exécution de la méthode, les tableaux sont synchronisés : si le tableau source de la listbox a effectivement été redimensionné, l’action de sélection est effectuée. Sinon, le tableau booléen associé à la listbox reprend sa taille initiale et la commande ne fait rien.

Notes :

Si vous souhaitez que la list box défile de manière à afficher la ligne nouvellement sélectionnée, utilisez la commande OBJET FIXER DEFILEMENT.
Pour passer une ligne en mode édition (saisie), utilisez la commande EDITER ELEMENT.
Si le numéro passé dans positionLigne correspond à une ligne masquée dans la list box, la ligne est sélectionnée mais n'est pas affichée.

Voir aussi

EDITER ELEMENT
LISTBOX INSERER LIGNES
LISTBOX SELECTIONNER RUPTURE
LISTBOX SUPPRIMER LIGNES
OBJET FIXER DEFILEMENT