CHECKLIST
Voir égalementAccès aux propriétés du contrôle Check-box list.
Support WebVue partiel. Voir le tableau avec la liste des modes ci-dessous. Les modes non supportés renvoient un code d'erreur si exécutés dans ce contexte.
| Mode | Mnémonique | Syntaxe | Support WebVue |
| 1 | COUNT | 1 | Oui |
| 2 | GETSELECTEDINDEX | 1 | Oui |
| 3 | SETSELECTEDINDEX | 2 | Oui |
| 4 | GETTEXT | 4 | Oui |
| 5 | GETUSERDATA | 4 | Oui |
| 6 | GETSTATE | 7 | Oui |
| 7 | SETSTATE | 3 | Oui |
| 8 | LOAD | 5 |
Oui |
| 9 | GETEVENTTYPE | 1 | Oui |
| 10 | INSERT | 6 | Oui |
| 11 | REMOVE | 7 | Oui |
| 12 | SORT | 8 | Non |
| 13 | CLEAR | 1 | Non |
| 14 | SETTEXT | 9 | Non |
| 15 | SETUSERDATA | 9 | Non |
| 16 | SAVE | 5 | Non |
Note importante sur la terminologie utilisée et le fonctionnement du contrôle Check-box list dans le logiciel PcVue:
-
Un élément qui est POSITIONNE (set) est un élément dans lequel le centre du carré correspondant est coché.
-
L'élément qui est SELECTIONNE est celui dont le texte est en surbrillance (changement de couleur d'arrière-plan).
Un élément POSITIONNE n'est pas nécessairement SELECTIONNE (et vice versa). En programmation vous n'êtes normalement intéressés que par les éléments POSITIONNES. L'élément SELECTIONNE a une moindre importance.
Pour plus d'information sur le comportement du contrôle Check-box list, voir l'aide principale du logiciel PcVue.
Arguments communs à plus d'un mode
|
Argument |
Définition |
| Window | Nom de la fenêtre contenant le contrôle de formulaire. Type STR |
| Branch | Branche (si elle existe) de la fenêtre. Utiliser "*" pour indiquer la branche courante du programme. Type STR. |
| Identity | Identifiant du contrôle dans la fenêtre spécifiée. Type STR |
| Index |
Index de l'élément à sélectionner. Type de retour : LONG. |
|
Notify |
Indique si la sélection déclenche l'exécution de la fonction SCADA Basic définie dans la configuration Opérations du contrôle. Type INTEGER |
Syntaxe 1
LongVal = CHECKLIST(Mode, Window, Branch, Identity);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
COUNT |
Retourne le nombre d'éléments. |
| 2 |
GETSELECTEDINDEX |
Retourne l'index de l'élément actuellement sélectionné. |
| 9 | GETEVENTTYPE |
Retourne le type de l'événement le plus récent. Le retour est une valeur de poids binaire. |
| 13 | CLEAR |
Vide le contenu de la liste et toute sélection. Retour : 1 si OK, 0 sinon. |
| Retour : 0 en cas d'erreur. |
Syntaxe 2
LongVal = CHECKLIST(Mode, Window, Branch, Identity, Index[, Notify]);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
|
3 |
SETSELECTEDINDEX |
Sélectionne un élément en fonction de la valeur de l'argument Index. Si l'index est -1 aucun élément n'est sélectionné. Si nécessaire, la fonction fera défiler le contrôle pour afficher l'élément. Retour : 1 si OK, 0 sinon. |
Syntaxe 3
LongVal = CHECKLIST(Mode, Window, Branch, Identity, Index, State[, Notify]);
Type de retour : LONG.
|
Argument |
Définition |
| State | Etat à positionner. La valeur peut être 0 ou 1. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 7 | SETSTATE |
Positionne l'état de l'élément correspondant à l'index fourni. Si nécessaire, la fonction fera défiler le contrôle pour afficher l'élément. Retour : 1 si OK, 0 sinon. |
Syntaxe 4
StrVal = CHECKLIST(Mode, Window, Branch, Identity, Index)
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 4 | GETTEXT | Retourne le Texte de l'élément Index comme défini dans la langue courante en utilisation. |
| 5 | GETUSERDATA | Retourne les données utilisateur associées à l'élément à l'index. |
Syntaxe 5
LongVal = CHECKLIST(Mode, Window, Branch, Identity, FileName);
Type de retour : LONG.
|
Argument |
Définition |
|
FileName |
Nom du fichier contenant les données du contrôle. |
Exécution
|
Mode |
Mnémonique |
Action |
|
8 |
LOAD |
Charge le contenu du fichier de la liste du contrôle des éléments. Retour : 1 si OK (fichier chargé et contrôle de formulaire rempli), sinon 0. |
| 16 | SAVE |
Enregistre la liste des éléments du contrôle de formulaire dans un fichier. La source du contrôle de formulaire doit être définie à Fichier ou l'instruction échouera. Retour : 1 si OK (éléments enregistrés dans un fichier), 0 sinon. |
Syntaxe 6
LongVal = CHECKLIST(Mode, Window, Branch, Identity, Text, Userdata, [Index])
Type de retour : LONG.
|
Argument |
Définition |
| Text | Texte à insérer. Type STR. |
| Userdata | Donnée utilisateur à insérer. Type STR. |
| Index | Index d'un élément dans le contrôle. Type LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
|
10 |
INSERT |
Insère un nouvel élément avec le Text et les Userdata optionnelles dans la liste du contrôle. Si Index est omis, l'élément est inséré à la fin. Sinon, l'élément est inséré à la position indiquée par Index, démarre à 0 pour le premier élément. |
Syntaxe 7
LongVal = CHECKLIST(Mode, Window, Branch, Identity, Index);
Type de retour : LONG.
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | GETSTATE | Retourne l'état de l'élément (coché ou non). |
|
11 |
REMOVE |
Supprime l'élément à l'index du contrôle de formulaire. |
Syntaxe 8
LongVal = CHECKLIST(Mode, Window, Branch, Identity[, Sortorder, Orderby]);
Type de retour : LONG.
|
Argument |
Définition |
| Sortorder | Flag indiquant l'ordre du tri. 0 = ascendant, 1 = descendant. |
| Orderby | Flag indiquant le critère de tri. 0 = champ Texte, 1 = Champ Données utilisateur. |
Exécution
|
Mode |
Mnémonique |
Action |
|
12 |
SORT |
Trie la liste du contrôle en utilisant le critère spécifié. |
Syntaxe 9
LongVal = CHECKLIST(Mode, Window, Branch, Identity[, Index, StrVal]);
Type de retour : LONG
|
Argument |
Définition |
| StrVal | La valeur de la chaîne à définir. |
Exécution
|
Mode |
Mnémonique |
Action |
| 14 | SETTEXT | Définit le texte de l'élément à Index avec la valeur StrVal. |
| 15 | SETUSERDATA | Définit les données utilisateur associées à l'élément à Index avec la valeur StrVal. |
| Retour : 1 si OK, 0 sinon. |
Exemple
Pour un exemple, sélectionnez le lien Exemple ci-dessus.