Voir également Exemple Infos complémentaires
Modification des caractéristiques d'une animation contrôle grid.
Support WebVue - Non. Renvoie un code d'erreur si exécuté dans ce contexte.
Lors de l'utilisation de régions multiples, vous devez positionner la région avant l'exécution d'instructions qui interagissent avec l'IHM. Pour plus d'informations, voir la rubrique REGION.
Numérotation des lignes et colonnes dans un Contrôle Grid
Les lignes et colonnes de données sont numérotées à partir de 0.
Les entêtes de lignes et de colonnes (Lignes/Colonnes fixes dans la boîte de dialogue des propriétés du Contrôle Grid) sont numérotées à partir de -1. Voir l'image
Modes
|
Mode |
Mnémonique |
Syntaxe |
| 1 | GETNBLINE | 1 |
| 2 | GETNBCOL | 1 |
| 3 | GETCELL | 2 |
| 4 | GETLINE | 3 |
| 5 | GETCOL | 4 |
| 6 | GETARRAY | 5 |
| 7 | PUTCELL | 6 |
| 8 | PUTLINE | 3 |
| 9 | PUTCOL | 4 |
| 10 | PUTARRAY | 5 |
| 11 | SCROLL | 7 |
| 12 | GETLISTART | 1 |
| 13 | GETNBLINEMAX | 1 |
| 14 | VARIABLE | 9 |
| 15 | VARMODE | 10 |
| 16 | SELECTLINE | 1 |
| 17 | SELECTCOL | 1 |
| 18 | SELECTMODE | 7 |
| 19 | SFIRSTCELL | 1 |
| 20 | SNEXTCELL | 1 |
| 21 | ALLSELOFF | 1 |
| 22 | CLICKCELL | 16 |
| 23 | GETSEL | 16 |
| 24 | SELPROG | 11 |
| 25 | INPUTPROG | 11 |
| 26 | CLEAR | 1 |
| 27 | SETNBLINE | 8 |
| 28 | GETLASTCELL | 1 |
| 30 | SORT | 12 |
| 31 | GETCELLBACKCOLOR | 13 |
| 32 | GETCELLTEXTCOLOR | 13 |
| 33 | PUTBACKCOLOR | 14 |
| 34 | PUTTEXTCOLOR | 14 |
| 35 | GETVARNAME | 15 |
| 36 | HISTORICAL | Voir la rubrique SELECTOR mode HISTORICAL |
| 37 | SETSELECTEDQUERYINDEX | 17 |
| 38 | GETSELECTEDQUERYINDEX | 1 |
| 39 | EXECQUERY | 1 |
| 40 | GETSELECTEDQUERYSYNTAX | 19 |
| 41 | SETCYCLICEXECPERIOD | 18 |
Les instructions suivantes sont conçues pour et ne peuvent être utilisées qu'avec le contrôle grid Sql :
-
SETSELECTEDQUERYINDEX
-
GETSELECTEDQUERYINDEX
-
EXECQUERY
-
GETSELECTEDQUERYSYNTAX
-
SETCYCLICEXECPERIOD
Toutes les syntaxes
|
Argument |
Définition |
|
Window |
Nom de la fenêtre contenant le contrôle grid à utiliser. Type STR. |
|
Branch |
Branche de la fenêtre (si nécessaire). L'utilisation d'une "*" signifie la branche courante du programme. Type STR. |
|
Identity |
Identifiant du contrôle grid dans la fenêtre spécifiée. Type STR. |
Syntaxe 1
IntVal = SELECTOR(Mode, Window, Branch, Identity);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
GETNBLINE |
Renvoie le nombre de lignes affichables (selon la dimension du rectangle support). |
|
2 |
GETNBCOL |
Renvoie le nombre de colonnes. |
|
12 |
GETLISTART |
Renvoie l'index de la première ligne visible en haut du contrôle grid. |
|
13 |
GETNBLINEMAX |
Renvoie le nombre total de lignes en mémoire. |
|
16 |
SELECTLINE |
Renvoie l'index de la ligne de la cellule sélectionnée. - 1 si aucune cellule n'est sélectionnée. |
|
17 |
SELECTCOL |
Renvoie l'index de la colonne de la cellule sélectionnée. - 1 si aucune cellule n'est sélectionnée. |
|
19 |
SFIRSTCELL |
Multisélection uniquement : Trouve la première cellule sélectionnée à partir du début du tableau (0,0). Utilisez les modes 16 (SELECTLINE) et 17 (SELECTCOL) pour obtenir respectivement la ligne et la colonne de la cellule trouvée. Renvoie 1 si une cellule a été trouvée, 0 sinon. |
|
20 |
SNEXTCELL |
Multisélection uniquement : Trouve la prochaine cellule sélectionnée à partir de la dernière cellule trouvée par cette même fonction ou par le mode 19 ( SFIRSTCELL). Utilisez les modes 16 (SELECTLINE) et 17 (SELECTCOL) pour obtenir respectivement la ligne et la colonne de la cellule trouvée. L'ordre de balayage s'effectue de gauche à droite puis de haut en bas. Renvoie 1 si une cellule a été trouvée, 0 sinon. |
|
21 |
ALLSELOFF |
Permet de désélectionner toutes les cellules sélectionnées d'un tableau. |
|
26 |
CLEAR |
Permet de vider tout le tableau. Les cellules sont réinitialisées. |
|
28 |
GETLASTCELL |
Renvoie le nombre de lignes rempli dans le tableau. |
| 38 | GETSELECTEDQUERYINDEX |
Renvoie l'index de la requête Sql sélectionnée. Retourne -1 si aucune requête n'est sélectionnée. |
| 39 | EXECQUERY |
Exécute la requête Sql sélectionnée. Retour : 1 si OK, 0 sinon. |
| Tous les modes renvoient 0 en cas d'erreur (paramètre erroné ou exécuté en contexte WebVue). |
Syntaxe 2
StrVal = SELECTOR(Mode, Window, Branch, Identity, Line, Column);
Type de retour : STR.
|
Argument |
Définition |
|
Line |
Index d'une ligne. Type INTEGER. |
|
Column |
Index d'une colonne. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
3 |
GETCELL |
Renvoie le contenu de la cellule pointée par ligne et colonne. Les index de ligne et de colonne commencent tous les deux à 0. Retour : Une chaîne vide en cas d'erreur (paramètre erroné ou exécuté en contexte WebVue). |
Syntaxe 3
LongVal = SELECTOR(Mode, Window, Branch, Identity, Line, Hbuf, Csepa);
Type de retour : LONG.
|
Argument |
Définition |
|
Hbuf |
Emplacement (handle) du buffer mémoire retourné par ALLOC_BUFFER. Type : LONG. |
|
Csepa |
Caractère utilisé comme délimiteur pour le texte dans chaque colonne. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
4 |
GETLINE |
Récupère le contenu de la ligne Line et le stocke dans le buffer Hbuf. |
|
8 |
PUTLINE |
Remplit la ligne Line avec le contenu du buffer Hbuf. |
| Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 4
LongVal = SELECTOR(Mode, Window, Branch, Identity, Col, Hbuf, Lsepa);
Type de retour : LONG.
|
Argument |
Définition |
|
Hbuf |
Emplacement (handle) du buffer mémoire retourné par ALLOC_BUFFER. Type LONG. |
|
Lsepa |
Caractère utilisé comme délimiteur de fin de ligne. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
5 |
GETCOL |
Récupère le contenu de la colonne Col et le stocke dans le buffer Hbuf. |
|
9 |
PUTCOL |
Remplit la colonne Col avec le contenu du buffer Hbuf. |
| Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 5
LongVal = SELECTOR(Mode, Window, Branch, Identity, Hbuf, StartLine, StartCol, EndLine, EndCol, CLsepa);
Type de retour : LONG.
|
Argument |
Définition |
|
Hbuf |
Emplacement (handle) du buffer mémoire retournée par ALLOC_BUFFER. Type LONG. |
|
StartLine |
Index d'une ligne. Type INTEGER. |
|
StartCol |
Index d'une colonne. Type INTEGER. |
|
EndLine |
Index d'une ligne. Type INTEGER. |
|
EndCol |
Index d'une colonne. Type INTEGER. |
|
CLsepa |
Caractère utilisé comme délimiteur pour le texte dans chaque colonne et ligne. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
6 |
GETARRAY |
Récupère le contenu de la plage de cellules délimitée par StartLine, StartCol, EndLine etEndCol et le stocke dans le buffer Hbuf. |
|
10 |
PUTARRAY |
Remplit la plage de cellules délimitée par StartLine, StartCol, EndLineetEndCol avec le contenu du buffer Hbuf. |
| Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Dans les deux modes, les deux caractères fournis par CLsepa sont utilisés comme délimiteurs de colonne et de ligne.
Syntaxe 6
IntVal = SELECTOR(Mode, Window, Branch, Identity, Line, Column, Chain);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Line |
Index d'une ligne. Type INTEGER. |
|
Column |
Index d'une colonne. Type INTEGER. |
|
Chain |
Chaîne de caractères. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
7 |
PUTCELL |
Remplit la cellule définie par Line et Column avec le contenu de la chaîne Chain. Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 7
IntVal = SELECTOR(Mode, Window, Branch, Identity, OpMode [, LineNb]);
Type de retour : INTEGER.
|
Argument |
Définition |
|
OpMode |
Nombre indiquant le mode opérationnel du contrôle grid. |
|
LineNb |
Nombre indiquant une ligne spécifique. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
|
11 |
SCROLL |
Fait défiler le contenu du contrôle grid. Le paramètre OpMode définit le mode de défilement : 1 TOBEGIN |
|
|
18 |
SELECTMODE |
Permet de changer dynamiquement le comportement face aux actions opérateurs dans les cellules. L'argument OpMode définit le comportement : 0 OFF |
|
|
|
|
Retour : 1 si OK, 0 sinon (paramètre erroné ou exécuté en contexte WebVue). |
|
Syntaxe 8
IntVal = SELECTOR(Mode, Window, Branch, Identity, LineNb);
Type de retour : INTEGER.
|
Argument |
Définition |
|
LineNb |
Nombre indiquant une ligne spécifique. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
27 |
SETNBLINE |
Permet de définir la dernière ligne qui être rendue visible par défilement. Si les lignes visibles sont au-delà de la nouvelle valeur LineNb, le tableau se positionne sur cette dernière ligne. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre erroné ou exécuté en contexte WebVue). |
Syntaxe 9
IntVal = SELECTOR(Mode, Window, Branch, Identity, Filter, VarType);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Filter |
Filtre, appliqué au nom de la variable, pour les variables affichées. Selon la configuration du contrôle Grid, le filtre est défini par :
|
|
VarType |
Entier définissant le type de variable : 1 Etats |
Il est possible de combiner les types entre eux. Si l'on veut les alarmes et les états, VARTYPE = 1 + 2 = 3.
Exécution
|
Mode |
Mnémonique |
Action |
|
14 |
VARIABLE |
Affiche une liste de variables et leurs valeurs temps réel dans 2 colonnes du contrôle Grid. Les variables affichées sont filtrées en fonction des paramètres Filter et VarType. |
|
|
|
Retour : 1 si OK, sinon 0 (paramètre incorrect, erreur de syntaxe dans le filtre, contrôle grid pas en mode suivi variable, ou exécuté dans le contexte WebVue). |
Pour utiliser ce mode, la propriété Suivi de variables du contrôle grid doit être positionnée d'abord.
Les fonds de texte des valeurs sont affichés avec la couleur de sélection du tableau si ces variables sont commandables. Un clic sur la valeur fait apparaître une boîte de dialogue identique à celle qui est utilisée pour les Forçages.
Lors de l'utilisation d'un contrôle grid pour afficher les valeurs de variables, seules les variables de la zone visible du contrôle grid sont abonnées et ont des valeurs temps-réel tenues à jour.
Syntaxe 10
IntVal = SELECTOR(Mode, Window, Branch, Identity, VarType);
Type de retour : INTEGER.
|
Argument |
Définition |
|
VarType |
Un INTEGER indiquant quelles informations afficher : 0 Nom des variables |
Exécution
|
Mode |
Mnémonique |
Action |
|
15 |
VARMODE |
Affiche une liste de variables et leurs propriétés en fonction du paramètre VarType. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 11
IntVal = SELECTOR(Mode, Window, Branch, Identity, Program, Branch, Function [Farg]);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Program |
Nom de programme. Type STR. |
|
Branch |
Nom de branche. Type STR. |
|
Function |
Nom de fonction. Type STR. |
|
Farg |
Facultatif. Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des "," (virgule). Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG. |
Exécution
|
Mode |
Mnémonique |
Action |
|
24 |
SELPROG |
Permet de spécifier une fonction qui sera exécutée dès qu'une cellule du tableau sera cliquée. Le tableau doit être en mode MONO ou MULTI. |
|
25 |
INPUTPROG |
Permet de spécifier une fonction qui sera exécutée dès qu'une cellule du tableau sera cliquée. Une boîte de dialogue donne à l'opérateur la possibilité de confirmer ou annuler. Le tableau doit être en mode INPUT. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 12
IntVal = SELECTOR(Mode, Window, Branch, Identity, Column, Flag);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Column |
Numéro de colonne. Type INTEGER. |
|
Flag |
Indicateur de l'ordre de tri. Type INTEGER. 0 ou supérieur : croissant inférieur à 0 : décroissant. |
Exécution
|
Mode |
Mnémonique |
Action |
|
30 |
SORT |
Le contenu de la Grid est trié en fonction du contenu de la colonne Column. Le tri est effectué en fonction des codes ASCII des chaînes dans chaque cellule. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 13
Color = SELECTOR(Mode, Window, Branch, Identity, Line, Column);
Type de retour : LONG.
|
Argument |
Définition |
|
Line |
Index d'une ligne. Type INTEGER. |
|
Column |
Index d'une colonne. Type INTEGER. |
| Color | Une couleur sous la forme d'une valeur d'octets pondérés pour coder en RGB. Rouge est l'octet 0, vert l'octet 1 et bleu l'octet 2. Par exemple, rouge est 255, vert 65280 et jaune (rouge + vert) 65535. Type LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
|
31 |
GETCELLBACKCOLOR |
Retourne la couleur de fond d'une cellule sous la forme d'une valeur sur 3 octets. |
|
32 |
GETCELLTEXTCOLOR |
Retourne la couleur du texte d'une cellule sous la forme d'une valeur sur 3 octets. |
| Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 14
IntVal = SELECTOR(Mode, Window, Branch, Identity, StartLine, StartCol, EndLine, EndCol, Color);
Type de retour : INTEGER.
|
Argument |
Définition |
|
StartLine |
Index d'une ligne. Type INTEGER. |
|
StartCol |
Index d'une colonne. Type INTEGER. |
|
EndLine |
Index d'une ligne. Type INTEGER. |
|
EndCol |
Index d'une colonne. Type INTEGER. |
|
Color |
Couleur sous la forme d'une valeur d'octets pondérés. Type LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
| 33 |
PUTBACKCOLOR |
Modifie la couleur de fond d'une plage de cellules par la couleur donnée par le paramètre Color. La plage de cellules est définie par les paramètres StartLine, StartCol, EndLine, EndCol. |
| 34 |
PUTTEXTCOLOR |
Modifie la couleur du texte d'une plage de cellules par la couleur donnée par le paramètre Color. La plage de cellules est définie par les paramètres StartLine, StartCol, EndLine, EndCol. |
| Retour : 1 si OK, 0 sinon (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 15
StrVal = SELECTOR(Mode, Window, Branch, Identity, LineNb);
Type de retour : STR.
|
Argument |
Définition |
|
LineNb |
Index d'une ligne. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
35 |
GETVARNAME |
Retourne le nom de la variable à la ligne spécifiée lorsque le contrôle grid est en mode suivi de variable. Retour : 0 en cas d'erreur (paramètre erroné ou exécuté en contexte WebVue). |
Syntaxe 16
IntVal = SELECTOR(Mode, Window, Branch, Identity, Line, Column);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Line |
Index d'une ligne. Type INTEGER. |
|
Column |
Index d'une colonne. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
22 |
CLICKCELL |
Simule une action de clic souris sur la cellule spécifiée par les index Line et Column. Retour : 1 si OK, 0 sinon. |
|
23 |
GETSEL |
Vérifier si une cellule est sélectionnée. Renvoie 1 si elle est sélectionnée, 0 sinon. |
| Retour : 0 en cas d'erreur (paramètre erroné ou exécution en contexte WebVue). |
Syntaxe 17
IntVal = SELECTOR(Mode, Window, Branch, Identity, Index);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
37 |
SETSELECTEDQUERYINDEX |
Définit la requête Sql à l'index comme sélectionnée pour l'exécution. Retour : 1 si OK, 0 sinon. |
Syntaxe 18
IntVal = SELECTOR(Mode, Window, Branch, Identity, Hours, Minutes, Seconds);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
37 |
SETCYCLICEXECPERIOD |
Modifie la valeur du timer pour déclencher cycliquement la requête Sql sélectionnée. Retour : 1 si OK, 0 sinon. |
Syntaxe 19
StrVal = SELECTOR(Mode, Window, Branch, Identity);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 40 | GETSELECTEDQUERYSYNTAX |
Renvoie la syntaxe de la requête Sql sélectionnée. Retourne une chaîne vide en cas d'erreur (paramètre erroné ou exécuté en contexte WebVue). |
Exemple
Pour un exemple, sélectionnez le lien exemple ci-dessus.