WINDOW

Ouvre et ferme une fenêtre.

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
0	CLOSE	1	Oui
1	OPEN	1, 2, 5	Oui
2	IS_OPEN	1	Oui
3	SHOW	1	Non
4	HIDE	1	Non
5	CHANGE	10	Non
6	CLOSEUNDER	1	Oui
7	PRELOAD	1, 5	Oui
8	CLOSEALL	6	Oui
9	MAIN	3	Non
10	CURRENTNAME	7	Oui
11	CURRENTBRANCH	7	Oui
12	CAPTION	8	Non
13	REFSET	9	Non
14	CURRENTREF	6	Non
15	POPUPCLOSE	6	Oui
16	ACCESSLEVEL	1	Oui
17	OPENNEW	1, 2, 5	Oui
18	PRINT	1	Non
19	ZOOM	11	Non
20	GETREGION	1	Non
21	GETSUBWINDOW	12	Non
22	GETSUBBRANCH	12	Non
23	SETPREVIOUS	6	Non
24	LAYER	13	Oui
25	HARDCOPY	14	Non
26	SAVE	15	Non
27	SELECTTAB	16	Non
28	GETCOLLECTION	17	Oui
29	GETSELECTEDTAB	18	Non
30	GETTAB	19	Non

Arguments communs à plus d'un mode

Argument	Définition
WinName	Nom d'une fenêtre. Type STR
Branch	Nom d'une branche. Type STR.
Refset	Mode de fonctionnement d'une fenêtre : 0 ou MODE_REALTIME - Mode temps réel. 1 ou MODE_REF1 - Mode REF1. 2 ou MODE_REF2 - Mode REF2. 3 ou MODE_TEST -Mode TEST. Quand un synoptique utilise un jeu de référence (Ref Set 1 ou Ref Set 2), il reçoit les valeurs relues à partir d'un rapport stocké, pas à partir des variables en temps réel.

Syntaxe 1

IntVal = WINDOW( Mode, WinName, Branch [, Refset]);

Type de retour : INTEGER

Exécution

Mode	Mnémonique	Action
0	CLOSE	Ferme la fenêtre. L'exécution échouera, renverra 0 et la fenêtre ne sera pas fermée si une boîte de dialogue est ouverte pour une animation au sein du synoptique en exploitation, par exemple, une confirmation d'un envoi de commande.
1	OPEN	Ouvre la fenêtre. La fenêtre est automatiquement mise en avant-plan et le focus lui est donnée, même si elle était déjà ouverte avant cet appel.
2	IS_OPEN	Teste si la fenêtre est ouverte ou non.
3	SHOW	Montre la fenêtre, la positionne en avant plan.
4	HIDE	Cache la fenêtre. La fenêtre n'est pas fermée et reste active en arrière-plan.
6	CLOSEUNDER	Fermer toutes les fenêtres qui intersectent WinName, que ce soit au premier plan ou en arrière-plan.
7	PRELOAD	Charge la fenêtre en cache, mais ne l'affiche pas.
16	ACCESSLEVEL	Renvoie le niveau d'accès de la fenêtre, ou 0 en cas d'erreur.
17	OPENNEW	Ouvre la fenêtre. Si la fenêtre est déjà ouverte, aucune action n'est réalisée.
18	PRINT	Imprime la fenêtre sur l'imprimante par défaut du système. Le fonctionnement correct des modes HARDCOPY et PRINT dépendent du système d'exploitation.
20	GETREGION	Renvoie la région (dans un système multiécrans) dans laquelle la fenêtre est ouverte, ou 0 en cas d'erreur.
		Retour : 1 si OK, 0 sinon pour tous les modes exceptés 16 & 20.

Syntaxe 2

IntVal = WINDOW(Mode, Child, Branch, Parent[, ParentBranch]);

Type de retour : INTEGER

Argument	Définition
Child	Nom d'une fenêtre enfant. Type STR.
Branch	Branche de la fenêtre enfant. Type STR.
Parent	Nom de la fenêtre parent. Type STR.
ParentBranch	Branche de la fenêtre parent. Type STR.

Exécution

Mode	Mnémonique	Action
1	OPEN	Ouvre une fenêtre incrustée Child avec la branche Branch dans la fenêtre Parent (ouverte avec la branche ParentBranch). La position de la fenêtre enfant est par rapport à l'origine de la fenêtre parente. L'instance de Child et Branch n'est ouverte que dans le parent si elle n'existe pas déjà dans l'espace de travail ou une autre fenêtre. Le focus est transféré à la fenêtre incrustée même si celle-ci était déjà ouverte.
17	OPENNEW	Ouvre une fenêtre incrustée Child avec la branche Branch dans la fenêtre Parent (ouverte avec la branche ParentBranch). La position de la fenêtre enfant est par rapport à l'origine de la fenêtre parente. L'instance de la fenêtre Child et Branch n'est ouverte que dans le cadre parent si elle n'existe pas déjà dans l'espace de travail ou une autre fenêtre. La focalisation n'est transférée à la fenêtre enfant que si elle n'est pas encore ouverte.
		Retour : 1 si OK, 0 sinon.

La fenêtre parent doit être ouverte. La fenêtre incrustée ne peut être déplacée que dans les limites de la fenêtre parent. Si la fenêtre parent est fermée, alors la fenêtre incrustée l'est également.

Syntaxe 3

IntVal = WINDOW(Mode, X, Y, Width, Height);

Type de retour : INTEGER

Argument	Définition
X, Y	Coordonnées du point en haut à gauche exprimées en pixels. Type INTEGER
Width	Largeur de la fenêtre exprimée en pixels. Type INTEGER
Height	Hauteur de la fenêtre exprimée en pixels. Type INTEGER

Exécution

Mode

Mnémonique

Action

MAIN

Change la taille et la position de la fenêtre principale de l'espace de travail.

Retour : 1 si Ok, 0 sinon.

Syntaxe 5

IntVal =WINDOW(Mode, Child, ChildBranch, Parent, ParentBranch, dX, dY);

Type de retour : INTEGER

Argument	Définition
Child, ChildBranch, Parent, ParentBranch	Voir ci-dessous.
dX, dY	Coordonnées relatives X et Y.

Exécution

Mode	Mnémonique	Action
1	OPEN	Ouvre une fenêtre incrustée Child avec la branche Branch dans la fenêtre Parent (ouverte avec la branche ParentBranch) en utilisant les coordonnées fournies. La position de la fenêtre enfant, par rapport à l'origine de la fenêtre parente, est calculé en utilisant la position configurée de la fenêtre enfant plus les coordonnées X et Y relatives. L'instance de la fenêtre Child et Branch n'est ouverte que dans le cadre parent si elle n'existe pas déjà dans l'espace de travail ou une autre fenêtre. La focalisation est transférée à la fenêtre enfant même si elle est déjà ouverte.
7	PRELOAD	Charge la fenêtre en cache en utilisant les coordonnées fournies, mais ne l'affiche pas.
17	OPENNEW	Ouvre une fenêtre Child avec la branche Branchcomme enfant d'une autre fenêtreParent (ouvrir avec la branche ParentBranch) en utilisant les coordonnées fournies. La position de la fenêtre enfant, par rapport à l'origine de la fenêtre parente, est calculé en utilisant la position configurée de la fenêtre enfant plus les coordonnées X et Y relatives. La focalisation est transférée à la fenêtre enfant seulement si elle est pas déjà ouverte.
		Retour : 1 si OK, 0 sinon.

Pour les modes 1 et 17, la fenêtre parent doit être ouverte. La fenêtre incrustée ne peut être déplacée que dans les limites de la fenêtre parent. Si la fenêtre parent est fermée, alors la fenêtre incrustée l'est également.La fenêtre contenant les liens doit être ouverte.

Syntaxe 6

IntVal = WINDOW(Mode);

Type de retour : INTEGER

Exécution

Mode	Mnémonique	Action
8	CLOSEALL	Ferme toutes les fenêtres y compris les fenêtres en cache (non affichées). Est équivalent à l'action du menu Fichier.Fermer tout. Retour : 1 si OK, 0 sinon.
15	POPUPCLOSE	Ferme toute fenêtre incrustée. Retour : 1 si OK, 0 sinon.
23	SETPREVIOUS	Enlève, de la pile des fenêtres, la fenêtre que l'on obtiendrait si on faisait un chaînage avec #P (fenêtre précédente). Retour : 1 si OK, 0 sinon.
14	CURRENTREF	Renvoie 1 si la fenêtre courante est sur le jeu de référence, sinon 0. Renvoie 0 en cas d'erreur.

Syntaxe 7

StrVal = WINDOW(Mode);

Type de retour : STR

Exécution

Mode	Mnémonique	Action
10	CURRENTNAME	Renvoie le nom de la fenêtre courante.
11	CURRENTBRANCH	Renvoie la branche de la fenêtre courante.

Syntaxe 8

IntVal = WINDOW(Mode, WinName, Branch, TitleLang1 [,TitleLang2]);

Type de retour : INTEGER

Argument	Définition
TitleLang1	Nouveau titre de la fenêtre en Langue 1. Longueur maximum : 40 caractères.
TitleLang2	Nouveau titre de la fenêtre en Langue 2. Optionnel. Longueur maximum : 40 caractères.

Exécution

Mode

Mnémonique

Action

CAPTION

Modifie le titre de la fenêtre.

Il est possible d'utiliser les caractères de substitution suivants :

#D - Date in DD/MM/YY format.
#h - The time in HH:MM:SS format.
#B - Window's Branch.
#N - Current user name.

Retour : 1 si OK, 0 sinon.

Syntaxe 9

IntVal = WINDOW(Mode, WinName, Branch, OldMode, NewMode);

Type de retour : INTEGER

Argument	Définition
OldMode	Mode courant de la fenêtre (0, 1, 2, ou 3) (Voir RefSet). Type INTEGER
NewMode	Nouveau mode de la fenêtre (0, 1, 2, ou 3) (Voir RefSet). Type INTEGER

Exécution

Mode

Mnémonique

Action

REFSET

Modifie le jeu de référence de la fenêtre identifiée par WinName, Branch et OldMode (son jeu de référence courant).

Retour : 1 si OK, 0 sinon.

Syntaxe 10

IntVal = WINDOW(Mode, WinName, Branch, RefSet, X, Y, W, H);

Type de retour : INTEGER.

Argument	Définition
X, Y	Coordonnées du coin en haut à gauche de la fenêtre. Type INTEGER
W, H	Largeur et hauteur de la fenêtre. Type INTEGER

Exécution

Mode

Mnémonique

Action

CHANGE

Modifie la position et la taille d'une fenêtre.

Retour : 1 si OK, 0 sinon.

Cette instruction ne fonctionne pas si la fenêtre contient une fenêtre de tendances, d'alarmes ou de consignations ou l'animation contrôle grid.

Syntaxe 11

IntVal = WINDOW(Mode, WinName, Branch, X, Y, Zoom);

Type de retour : INTEGER

Argument	Définition
WinName	Nom de la fenêtre.
Branch	Nom de la branche.
X, Y	Les coordonnées du point central de la zone affichée. Type INTEGER
Zoom	Valeur de zoom absolu exprimé en %. Type INTEGER

Exécution

Mode

Mnémonique

Action

ZOOM

Modifie la position et la taille d'une fenêtre.

Le centre du zoom est le point (X,Y) qui est exprimé en coordonnées relatives dans la fenêtre (et non absolus dans l'espace de travail).

Retour : 1 si OK, 0 sinon.

Syntaxe 12

StrVal = WINDOW(Mode, Substitution[, MyWindow[, MyWindowBranch]]);

Type de retour : STR

Argument	Définition
Substitution	Une des substitutions utilisées avec l'animation Ouverture Fenêtre. Type STR.
MyWindow	(pour le type de substitution #Mx) Fenêtre contenant les liens. Type STR.
MyWindowBranch	(pour le type de substitution #Mx) La branche (si elle existe) de cette fenêtre. Type STR.

Exécution

Mode	Mnémonique	Action
21	GETSUBWINDOW	Renvoie le nom de la fenêtre associée à la chaîne de substitution Substitution: #P renvoie le nom de la fenêtre précédemment ouverte.#U renvoie le nom de la fenêtre principale de l'utilisateur. #I renvoie la première fenêtre ouverte au lancement du projet. #Mx renvoie le nom d'une des fenêtres (x = 1 à 10) du tableau d'incrustation des fenêtres, s’effectue avec les paramètres de la fenêtre mère.
22	GETSUBBRANCH	Renvoie le nom de la branche de la fenêtre associée à la chaîne de substitution Substitution.
		Retour: Une chaîne vide en cas d'erreur.

Ces instructions permettent d'utiliser les substitutions #P, #U, #I et #Mx dans les programmes.
La récupération des substitutions #Mx nécessite que la fenêtre contenant les liens soit ouverte et que son nom et sa branche soient passés en paramètres (MyWindow et MyWindowBranch).
Dans le cas d'une fenêtre incrustée, les substitutions #Mx s'effectuent avec les paramètres de la fenêtre mère.

Syntaxe 13

IntVal = WINDOW(Mode, WinName, Branch, Refset, Layer, LayerMode);

Type de retour : INTEGER

Argument	Définition
Layer	Niveau de couche (0 à 15). Type INTEGER
LayerMode	Mode l'opération (0, 1 ou 2). Type INTEGER.

Exécution

Mode

Mnémonique

Action

LAYER

Change le statut de visibilité du couche dans la fenêtre spécifiée, selon LayerMode :

0 = Masquer.

1 = Afficher.

2 Inverser la visibilité.

Retour : 1 si OK, 0 sinon.

Syntaxe 14

IntVal = WINDOW(Mode, WinName, Branch [, Refset[, PrintMode]]);

Type de retour : INTEGER

Argument

Définition

PrintMode

Option d'impression. Type INTEGER

0 Imprimer sans les bordures (par défaut).
1 Imprimer avec les bordures.

Exécution

Mode

Mnémonique

Action

HARDCOPY

Imprime la fenêtre spécifiée sur l'imprimante par défaut du système d'exploitation. La fenêtre doit être ouverte ou bien dans le cache.

Retour : 1 si OK, 0 sinon.

Le fonctionnement correct des modes HARDCOPY et PRINT dépendent du système d'exploitation.

Syntaxe 15

IntVal = WINDOW(Mode, WinName, Branch, Format);

Type de retour : INTEGER

Argument

Définition

Format

Format de sauvegarde de la fenêtre. Type STR.

"NATIVE" - Format courant.
"BINARY" - Format binaire.
"ASCII32" - Format ASCII.

Exécution

Mode

Mnémonique

Action

SAVE

Enregistre la fenêtre au Format choisi.

0 Cacher.

Syntaxe 16

IntVal = WINDOW(Mode, WinName, Branch, TabIndex);

Type de retour : INTEGER.

Argument	Définition
TabIndex	Index de l'onglet à afficher. Type STR.

Exécution

Mode

Mnémonique

Action

SELECTTAB

Pour une fenêtre utilisant des onglets, sélectionne l'onglet correspondant à TabIndex.

Retour : 1 si OK, 0 sinon.

Syntaxe 17

IntVal = WINDOW(Mode, Namespace);

Type de retour : INTEGER

Argument	Définition
Namespace	Identifiant du fragment XML de sortie. Type STR.

Exécution

Mode

Mnémonique

Action

GETCOLLECTION

Récupère la collection des fenêtres ouvertes sous forme d'un fragment XML identifié par Namespace. Pour plus d'informations, voir l'exemple ci-dessous et XMLPATH.

Retour : 1 si OK, 0 sinon.

Syntaxe 18

IntVal = WINDOW(Mode, WinName, Branch);

Type de retour : INTEGER

Exécution

Mode	Mnémonique	Action
29	GETSELECTEDTAB	Renvoie l'index de l'onglet sélectionné/actif. Le premier onglet est 1 etc. Renvoie 0 si aucun onglet n'est sélectionné.

Syntaxe 19

StrVal = WINDOW(Mode, SubMode, WinName, Branch[, TabIndex]);

Type de retour : STRING

Argument	Description
SubMode	Chaîne énumérée, soit "NOM", "BRANCH" ou "CAPTION". Non sensible à la casse. Type STR.
TabIndex	L'index basé sur 1 de l'onglet ciblé, ou 0 pour traiter celui actif / sélectionné (par défaut).

Exécution

Mode	Mnémonique	Action
30	GETTAB	Renvoie le nom du synoptique, la branche ou la légende de l'onglet à l'index TabIndex.

Exemple

Pour un exemple, sélectionnez le lien Exemple ci-dessus.

WINDOW

Arguments communs à plus d'un mode

Syntaxe 1

Exécution

Syntaxe 2

Exécution

Syntaxe 3

Exécution

Syntaxe 5

Exécution

Syntaxe 6

Exécution

Syntaxe 7

Exécution

Syntaxe 8

Exécution

Syntaxe 9

Exécution

Syntaxe 10

Exécution

Syntaxe 11

Exécution

Syntaxe 12

Exécution

Syntaxe 13

Exécution

Syntaxe 14

Exécution

Syntaxe 15

Exécution

Syntaxe 16

Exécution

Syntaxe 17

Exécution

Syntaxe 18

Exécution

Syntaxe 19

Exécution

Exemple

Envoyez-nous vos commentaires