ListeInsère (Fonction)

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

Version :

Accueil | Connexion | Français

Aide / WLangage / Fonctions WLangage / Champs, pages et fenêtres / Fonctions Liste

Champ Liste supérieur à 10 000 éléments
Visibilité / Invisibilité des éléments d'un champ Liste ou d'un champ Combo
Personnalisation des éléments d'un champ Liste ou d'un champ Combo
Champ Liste triée/Liste non triée
Tabulations : champ Liste multisélection
Ajout d'un élément sur le navigateur
Divers

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

ListeInsère (Fonction)

En anglais : ListInsert

Insère un élément dans un champ Liste par programmation (y compris Liste image) ou dans un champ Combo par programmation.

Remarques :

Pour ajouter un élément à la fin d'un champ Liste (ou Combo), utilisez la fonction ListeAjoute.
La fonction ListeInsère peut être utilisée indifféremment sur des champs Liste monosélection et multisélection.
Pour gérer le contenu d'un champ Combo placé dans une colonne conteneur d'un champ Table, utilisez la propriété Contenu.

Attention : L'élément sera ajouté uniquement sur la page affichée dans le navigateur. Pour plus de détails, voir les Notes.

Exemple

// Ajoute le nom "Dubois" à l'indice 4 dans le champ Liste "LISTE_ListeClient"
ListeInsère(LISTE_ListeClient, "Dubois", 4)

// Ajoute l'image "C:\MesImages\Gorgones.JPG" à l'indice 5 dans le champ Liste image "LSI_Plongée"
// Cette image aura comme libellé "Très belles gorgones"
ListeInsère(LSI_Plongée, "Très belles gorgones", "C:\MesImages\Gorgones.JPG", 4)

Syntaxe

<Résultat> = ListeInsère(<Champ Liste> , <Élément> [, <Image> [, <Indice de l'élément>]])

<Résultat> : Booléen

Vrai si l'élément a été inséré,
Faux dans le cas contraire.
La fonction ListeInsère ne retourne pas de résultat.

<Champ Liste> : Nom de champ

Nom du champ Liste par programmation ou du champ Combo par programmation à manipuler.
Si ce paramètre correspond à une chaîne vide (""), l'élément est inséré dans le champ Liste ou Combo auquel le traitement en cours appartient.
Le nom du champ Liste ou Combo à manipuler doit obligatoirement être spécifié.

<Élément> : Chaîne de caractères

Élément à insérer dans le champ Liste (ou Combo) par programmation spécifié.
Ce paramètre peut contenir :
des caractères Retour Chariot (RC) pour ajouter plusieurs lignes. Dans ce cas :
si le paramètre <Indice de l'élément> n'est pas précisé, les éléments sont effectivement ajoutés.
si le paramètre <Indice de l'élément> est précisé, seul le premier élément sera ajouté.
des tabulations (TAB) pour obtenir un champ Liste multi-éléments (voir Notes).
Dans le cas d'un champ Liste image, ce paramètre correspond au libellé de l'image. Ce paramètre peut contenir des caractères Retour Chariot (RC) pour ajouter plusieurs éléments. Dans ce cas :
si les paramètres <Image> et <Indice de l'élément> ne sont pas précisés, les éléments ajoutés seront associés à l'image par défaut (définie dans l'onglet "Détail" de la fenêtre de description du champ).
si le paramètre <Image> et le paramètre <Indice de l'élément> sont précisés, seul le premier élément sera ajouté. Cet élément sera associé à l'image par défaut (définie dans l'onglet "Détail" de la fenêtre de description du champ).
si le paramètre <Image> est précisé et si le paramètre <Indice de l'élément> n'est pas précisé, seul le premier élément sera ajouté. Cet élément sera associé à l'image spécifiée.
Les caractères Retour Chariot (RC) et les tabulations (TAB) ne sont pas supportés.
Pour ajouter plusieurs espaces consécutifs, il est nécessaire d'utiliser des espaces insécables : Caract(160).

<Image> : Chaîne de caractères optionnelle

Nom et chemin de l'image à ajouter dans un champ Liste image. Ce paramètre est pris en compte uniquement dans le cas d'un champ Liste image, affichée en mode Liste image. Si ce paramètre n'est pas spécifié, l'image utilisée est l'image par défaut (définie dans l'onglet "Détail" de la fenêtre de description du champ).
Ce paramètre n'est pas disponible.

<Indice de l'élément> : Entier optionnel

Indice de l'élément à insérer.
Si ce paramètre :
n'est pas précisé, l'élément est inséré :
avant l'élément en cours dans le cas d'un champ Liste monosélection. Si aucun élément n'est en cours, l'élément est inséré à la fin du champ Liste (ou Combo) par programmation.
à la fin du champ Liste (ou Combo) par programmation dans le cas d'un champ Liste multisélection.
est supérieur au nombre d'éléments présents dans le champ Liste (ou Combo), l'élément est inséré à la fin du champ Liste (ou Combo) par programmation. Le nombre d'éléments présents dans un champ Liste (ou Combo) peut être obtenu avec la fonction ListeOccurrence.
est égal à 0, l'élément est ajouté au début du champ Liste (ou Combo) par programmation.

Remarques

Champ Liste supérieur à 10 000 éléments

Le nombre maximum d'éléments pouvant être contenus dans un champ Liste n'est limité que par la mémoire vive disponible (maximum théorique : 2 milliards de lignes). Néanmoins, le fait de remplir un champ Liste avec un très grand nombre d'éléments (plus de 10 000) est pénalisant en termes de performance.
Pour ajouter un grand nombre d'éléments dans un champ Liste, il est conseillé d'utiliser un champ Liste fichier (c'est-à-dire un champ Liste directement reliée à un fichier de données HFSQL).

Visibilité / Invisibilité des éléments d'un champ Liste ou d'un champ Combo

Pour rendre un élément d'un champ Liste ou d'un champ Combo invisible, utilisez la fonction gValeurMémorisée.

Personnalisation des éléments d'un champ Liste ou d'un champ Combo

Pour personnaliser les éléments présents dans un champ Liste ou dans un champ Combo (couleur de fond, image, dessin, etc), utilisez les Fonctions de gestion des chaînes graphiques.

Champ Liste triée/Liste non triée

Si le champ Liste est trié, le nouvel élément est inséré à l'emplacement courant sans trier le champ Liste.
Si le champ Liste n'est pas trié, le nouvel élément est ajouté :
- à l'<Indice de l'élément> si le paramètre <Indice de l'élément> est spécifié.
- avant l'élément en cours dans le cas d'un champ Liste monosélection si le paramètre <Indice de l'élément> n'est pas spécifié. Si aucun élément n'est en cours, l'élément est inséré à la fin du champ Liste (ou Combo) par programmation.
- à la fin du champ Liste (ou Combo) par programmation dans le cas d'un champ Liste multisélection si le paramètre <Indice de l'élément> n'est pas spécifié.

Le type du champ Liste (trié ou non) est choisi lors de la description du champ (onglet "Détail").

La fonction ListeAjoute doit être préférée à la fonction ListeInsère pour ajouter un élément dans un champ Liste trié.

Que le champ Liste soit trié ou non, l'élément est ajouté à la fin du champ.

Tabulations : champ Liste multisélection

Pour gérer des tabulations dans un champ Liste (alignement de colonnes), utilisez la constante TAB. Par exemple :

ListeInsère(LISTE_Client, Nom + TAB + Prénom)

Dans cet exemple, tous les prénoms commencent à la même position et sont alignés les uns sous les autres.

Remarque : Le premier appel à la fonction ListeInsère fixe la position des tabulations. Ces positions serviront de référence pour toutes les valeurs ajoutées par la suite. De même, si des valeurs ont été saisies sous l'éditeur, les positions de ces valeurs sont prises comme référence. Il est donc conseillé, lors du premier appel à la fonction ListeInsère, de fixer la largeur des colonnes avec la fonction Complète. Par exemple, pour fixer la largeur des colonnes de "LISTE_Client" à 10 caractères :

ListeInsère(LISTE_Client, Complète(Nom, 10) + TAB + Complète(Prénom, 10))

Ajout d'un élément sur le navigateur

Lors de l'ajout d'un élément en code navigateur, cet élément est ajouté uniquement sur la page affichée dans le navigateur. Pour que cet élément soit également ajouté sur le serveur, il est nécessaire d'exécuter la fonction ListeInsère sur le serveur.

L'utilisation de la fonction ListeInsère en code navigateur est intéressante lors de l'utilisation de la technologie AJAX, en mode "AJAX Programmé" (utilisation de la fonction AJAXExécute ou AJAXExécuteAsynchrone).

Rappel : En mode "AJAX automatique et immédiat", il suffit de passer le traitement serveur contenant la fonction ListeInsère en mode AJAX automatique. Rien de plus ! Aucune programmation supplémentaire n'est nécessaire. Pour plus de détails, consultez AJAX.

Divers

Pour insérer un élément dans un champ Table, utilisez la fonction TableInsère.
La fonction ListeInsère peut être utilisée sur une colonne de type "Combo" dans un champ Table.

Composante : wd300obj.dll

Voir Aussi

Version minimum requise

Version 9

Documentation également disponible pour…

Commentaires

Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 25/05/2022

Signaler une erreur ou faire une suggestion | Aide en ligne locale