24C# PDF

Télécharger au format pdf ou txt
Télécharger au format pdf ou txt
Vous êtes sur la page 1sur 154

Manuel de zenon

Interfaces de
programmation
v.8.10
© 2019 Ing. Punzenberger COPA-DATA GmbH

Tous droits réservés.

La distribution et/ou reproduction de ce document ou partie de ce document, sous n'importe quelle


forme, n'est autorisée qu'avec la permission écrite de la société COPA-DATA. Les données techniques
incluses ne sont fournies qu'à titre d'information et ne présentent aucun caractère légal. Document sujet
aux changements, techniques ou autres.
Contenu

1 Bienvenue dans l’aide de COPA-DATA ................................................................................................. 6

2 Interfaces de programmation ................................................................................................................. 6

3 Modules ........................................................................................................................................................ 9
3.1 Connaissances requises ...............................................................................................................................10
3.2 Terminologie ....................................................................................................................................................11
3.3 Limitations.........................................................................................................................................................12
3.4 Créer un module.............................................................................................................................................12
3.4.1 Notions fondamentales ...................................................................................................................................... 13
3.4.2 Types d'extensions ............................................................................................................................................... 17
3.4.3 Contenu des packages de modules .............................................................................................................. 20
3.4.4 Microsoft Visual Studio ...................................................................................................................................... 21
3.4.5 SharpDevelop ......................................................................................................................................................... 28
3.4.6 Administration du code source ....................................................................................................................... 31
3.4.7 Utilitaire d'analyse et de créations de packages de modules (AddInUtility)................................. 32
3.4.8 Action en cas de rechargement ...................................................................................................................... 33
3.4.9 Isolation .................................................................................................................................................................... 34
3.5 Utilisation de modules dans Editor et le Runtime .............................................................................34
3.5.1 Activation de modules dans zenon ............................................................................................................... 36
3.5.2 Action durant l'installation ................................................................................................................................ 36
3.5.3 Nœud des modules dans le gestionnaire de projet ............................................................................... 37
3.5.4 Utilisation dans zenon Editor ........................................................................................................................... 38
3.5.5 Utilisation dans le Runtime de zenon ........................................................................................................... 43
3.5.6 Dépannage .............................................................................................................................................................. 46
3.6 Fonctions de zenon .......................................................................................................................................47
3.6.1 Afficher la boîte de dialogue Gestion des services du Runtime ........................................................ 47
3.6.2 Exécuter l'extension Project Wizard .............................................................................................................. 49
3.7 Changement/conversion depuis VSTA ..................................................................................................51

4 Liste de macros ......................................................................................................................................... 53


4.1 Vue de détail de la barre d’outils et du menu contextuel VBA ....................................................54
4.2 VBA sur les systèmes 64 bits ......................................................................................................................56
4.3 Notions fondamentales ...............................................................................................................................57
4.3.1 Les propriétés des objets ................................................................................................................................... 57
4.3.2 Les méthodes des objets ................................................................................................................................... 58
4.3.3 Les événements des objets ............................................................................................................................... 58
4.3.4 Structure d'objet VBA dans zenon ................................................................................................................. 58
4.3.5 Comment utiliser les macros VBA .................................................................................................................. 60
4.3.6 Comment insérer un élément ActiveX dans zenon ? ............................................................................. 61
4.3.7 Accès depuis un programme externe ........................................................................................................... 63
4.3.8 Fonctionnalité des variables en ligne ........................................................................................................... 64
4.3.9 List of status bits ................................................................................................................................................... 65
4.3.10 Lasso de sélection d’éléments dynamiques dans le Runtime ............................................................. 69
4.4 Macros dans Editor ........................................................................................................................................70
4.4.1 Barre d’outils Liste des macros ........................................................................................................................ 71
4.4.2 Affectation de macros ......................................................................................................................................... 72
4.5 Fonctions dans zenon...................................................................................................................................74
4.5.1 Exécuter macro VBA ............................................................................................................................................ 75
4.6 Développement d’assistants dans VBA..................................................................................................76
4.6.1 Utilisation d’un assistant .................................................................................................................................... 77
4.6.2 Structure d’un assistant ...................................................................................................................................... 78
4.6.3 Intégration dans VBA .......................................................................................................................................... 78
4.6.4 Développement d’un assistant ........................................................................................................................ 79
4.6.5 Mise à jour des assistants .................................................................................................................................. 84
4.7 Foire aux questions........................................................................................................................................84
4.7.1 Pourquoi le bouton reste-t-il enfoncé ? ...................................................................................................... 84
4.7.2 La macro n’est pas exécutée avec le premier clic .................................................................................... 84
4.7.3 Les macros ne fonctionnent plus dans le Runtime ? .............................................................................. 85
4.7.4 Windows CE et VBA ............................................................................................................................................. 85
4.8 Exemples ............................................................................................................................................................85
4.8.1 Initialisation de MouseEvents et du contrôle ActiveX ............................................................................ 85
4.8.2 Afficher les informations d’une variable ...................................................................................................... 86
4.8.3 Lire et écrire des valeurs de variable ............................................................................................................. 87
4.8.4 Lire et écrire des variables et déployer les variables en ligne ............................................................. 88
4.8.5 Utiliser une boîte de dialogue plusieurs fois ............................................................................................. 90
4.8.6 Alarme – Événements et gestion des contrôles ActiveX ....................................................................... 91
4.8.7 Accès aux alarmes ................................................................................................................................................ 94
4.8.8 Définition d’un interrupteur (utilisation de variables de procédé) ................................................... 95

5 VSTA ............................................................................................................................................................ 98
5.1 Notions fondamentales ............................................................................................................................ 100
5.1.1 Configuration de l’environnement VSTA .................................................................................................. 100
5.1.2 Accès au modèle d'objet zenon.................................................................................................................... 101
5.1.3 Fonctions dans zenon ....................................................................................................................................... 103
5.1.4 Débogage d’une macro complémentaire VSTA ..................................................................................... 105
5.1.5 Événements dans VSTA .................................................................................................................................... 105
5.1.6 Créer une sauvegarde de projets VSTA ..................................................................................................... 106
5.2 Créer un projet VSTA ................................................................................................................................. 106
5.2.1 Projets VSTA dans Editor ................................................................................................................................. 107
5.2.2 Projets VSTA dans le Runtime ....................................................................................................................... 108
5.2.3 Développement d’assistants dans VSTA ................................................................................................... 109
5.3 Exemples ......................................................................................................................................................... 109
5.3.1 Création de variables dans zenon Editor ................................................................................................... 110
5.3.2 Écriture des informations du projet dans la fenêtre de sortie zenon. ........................................... 113
5.3.3 Acquisition des variables dans zenon par le biais d’expressions régulières ............................... 115
5.3.4 Conversion des couleurs entre .NET et zenon ........................................................................................ 118

6 PCE : Process Control Engine............................................................................................................... 122


6.1 L’éditeur PCE ................................................................................................................................................. 123
6.1.1 Le gestionnaire de tâches ................................................................................................................................ 123
6.1.2 La zone d’édition ................................................................................................................................................ 124
6.1.3 La fenêtre de sortie ............................................................................................................................................ 124
6.1.4 Les menus de l’éditeur PCE............................................................................................................................. 124
6.1.5 La barre de boutons de l’éditeur PCE ......................................................................................................... 127
6.2 Suite des actions.......................................................................................................................................... 128
6.2.1 Créer une tâche ................................................................................................................................................... 128
6.2.2 Entrer le code ....................................................................................................................................................... 130
6.2.3 Fonction Visualiser PCE .................................................................................................................................... 132
6.2.4 Exécuter des tâches............................................................................................................................................ 132
6.3 VBScript - Introduction ............................................................................................................................. 133
6.3.1 Type de données ................................................................................................................................................ 133
6.3.2 Variables ................................................................................................................................................................. 135
6.3.3 Constantes ............................................................................................................................................................. 138
6.3.4 Opérateurs ............................................................................................................................................................. 138
6.3.5 Déclarations conditionnelles .......................................................................................................................... 140
6.3.6 Utilisation de boucles de code ...................................................................................................................... 142
6.3.7 Types de procédures ......................................................................................................................................... 147
6.3.8 Conventions de codage ................................................................................................................................... 149

7 Modèle d'objet........................................................................................................................................ 154


Bienvenue dans l’aide de COPA-DATA

1 Bienvenue dans l’aide de COPA-DATA

TUTORIELS VIDÉO DE ZENON.


Des exemples concrets de configurations de projets dans zenon sont disponibles sur notre chaîne
YouTube (https://www.copadata.com/tutorial_menu). Les tutoriels sont regroupés par sujet et proposent
un aperçu de l’utilisation des différents modules de zenon. Les tutoriels sont disponibles en anglais.

AIDE GÉNÉRALE
Si vous ne trouvez pas certaines informations dans ce chapitre de l’aide ou si vous souhaitez nous
suggérer d’intégrer un complément d’information, veuillez nous contacter par e-mail :
[email protected].

ASSISTANCE PROJET
Si vous avez besoin d’aide dans le cadre d’un projet, n’hésitez pas à adresser un e-mail à notre service
d’assistance : [email protected]

LICENCES ET MODULES
Si vous vous rendez compte que vous avez besoin de licences ou de modules supplémentaires,
veuillezcontacter l’équipe commerciale par e-mail : E-mail [email protected].

2 Interfaces de programmation
Différentes interfaces d'intégration de vos programmes ou d'automatisation des plannings sont
disponibles dans zenon :
 Liste des macros (à la page 53) (VBA)
 VSTA (à la page 98)

 Add-In (à la page 34) (Add-Ins)

 Process Control Engine (PCE)


À partir de la version 7.20, le module PCE n'est plus pris en charge et ne sera plus affiché dans

6 | 154
Interfaces de programmation

l'arborescence des modules de zenon. Lors de la conversion de projets contenant des tâches
PCE depuis des versions antérieures à la version 7.20, le nœud PCE sera affiché pour ces
projets. PCE ne fera plus l'objet de développements ou de documentations ultérieurs.
Recommandation : Veuillez utiliser zenon Logic, plutôt que PCE

MENU CONTEXTUEL
Élément de menu Action

Ouvrir l’éditeur VBA Ouvre l’éditeur VBA.

Ouvrir l'éditeur VSTA avec Ouvre l'éditeur VSTA.


Projectaddin

Aide Opens online help.

Information
Vous trouverez des informations concernant la création et la mise en œuvre
des contrôles (ActiveX, .NET, WPF) dans le manuel Contrôles.
Vous trouverez des informations concernant le développement et l'utilisation de
l'interface SAP au chapitre Interface SAP.

OUVRIR LES ÉDITEURS

MODULES

Pour ouvrir l'éditeur de Add-In :


1. Cliquez sur le menu Outils dans zenon Editor.
2. Sélectionnez l'entrée Ouvrir l'éditeur de modules

Vous pouvez également procéder ainsi : Appuyez sur les touches Ctrl+F9.
Pour ouvrir l'éditeur dans le Runtime :
 En sélectionnant, dans Startup Tool, sous Tools, le lien SharpDevelop IDE.

ÉDITEUR VBA POUR LA LISTE DES MACROS

VBA démarre le même environnement de développement pour Espace de travail et le projet.


Pour ouvrir l’éditeur VBA :
1. Dans zenon Editor, accédez au nœud Interface de programmation.

7 | 154
Interfaces de programmation

2. Pour développer l’affichage de ce nœud, cliquez sur [+].


La vue du nœud est développée.
3. Cliquez avec le bouton droit sur Liste de macros.
4. Sélectionnez Ouvrir l’éditeur VSTA dans le menu contextuel.

Vous pouvez également procéder ainsi : Appuyez sur les touches Ctrl+F11.

VSTA DANS L’ÉDITEUR

VSTA comporte des environnements de développement distincts pour l’Espace de travail et le projet.
Vous ne pouvez en utiliser qu’un à la fois. Au démarrage, tous les autres environnements de
développement VSTA ouverts seront fermés.

Pour ouvrir l’éditeur VSTA pour l’espace de travail :


1. Utilisez le raccourci-clavier Alt+F10.
Une boîte de dialogue d'information s'affiche.
Le code correspondant à l’espace de travail et à tous les projets chargés est affiché

Pour ouvrir l’éditeur VSTA pour le projet actuellement chargé :


1. Accédez au nœud Script.
2. Pour développer l’affichage de ce nœud, cliquez sur [+].
La vue du nœud est développée.
3. Cliquez avec le bouton droit sur VSTA.
4. Dans le menu contextuel, sélectionnez Ouvrir l'éditeur VSTA avec ProjectAddin.
Une boîte de dialogue d'information s'affiche.
Cliquez sur le bouton OK pour poursuivre la configuration du projet VSTA.
L'éditeur VSTA démarre pour le projet actuellement chargé.

REMARQUE SUR L'API À PARTIR DE LA VERSION 7.10


Pour utiliser les interfaces de programmation de zenon, les considérations suivantes sont applicables à
partir de zenon 7.10 :
 VSTA/.NET: .NET Framework 3.5 doit être disponible.
 VBA : Si, dans le code VBA, des fonctions de l'API Windows ou d'autres fichiers DLL importés
sont utilisés, ces exécutions doivent être adaptées à l'environnement 64 bits. En règle générale,
les dispositions suivantes s’appliquent : Un fichier VBA créé avec une version 32 bits ne peut
pas être utilisé sans modification dans une version 64 bits de VBA.

8 | 154
Modules

Attention
Les erreurs dans les applications telles que ActiveX, PCE, VBA, VSTA, WPF et les
applications externes accédant à zenon via l'API peuvent également influencer la
stabilité du Runtime.

3 Modules
Les Add-Ins offrent la possibilité d'étendre les fonctionnalités de zenon dans Editor et le Runtime, grâce
à différents environnements de développement.
Les ressources suivantes permettent de créer des Add-Ins :
 Microsoft Visual Studio (à la page 21)
 SharpDevelop (inclus dans le package d'installation) (à la page 28)

Les Add-Ins peuvent être créés dans tous les langages de programmation .NET. La prise en charge
d'IDE est disponible dans les langages de programmation C# et Visual Basic.NET.

Remarque : Pour définir l'environnement de développement utilisé, cliquez sur Ouvrir l'éditeur de
modules dans les paramètres du menu Extras de zenon, sous Paramètres..., sur l'onglet Add-Ins.
Remarque :
 Toutes les listes et interfaces sont compatibles avec IEnumerable.
Référence : https://msdn.microsoft.com/de-de/library/9eekhta0(v=vs.110).aspx
(https://msdn.microsoft.com/de-de/library/9eekhta0(v=vs.110).aspx)
 Une Language Integrated Query LINQ peut être utilisée.
Référence : https://msdn.microsoft.com/en-us/library/mt693024.aspx
(https://msdn.microsoft.com/en-us/library/mt693024.aspx)

Attention
Pour les Add-Ins, les .NET Naming Guidelines sont appliquées.

À cette fin, les noms d'objets précédemment utilisés dans VSTA et VBA sont
modifiés. Dans VSTA et VBA, les noms précédents restent identiques, pour des
raisons de compatibilité. Pour les Add-Ins, l'attribution des noms tient compte
des Naming Guidelines .NET.

Une vue d'ensemble des différents noms d'objet est disponible dans le fichier
Excel API_Naming_Conversion.xlsx. Le fichier se trouve dans le répertoire
d'installation de zenon, dans le dossier \HELP\AddIns.

9 | 154
Modules

FONCTIONNALITÉS
Les Add-Ins offrent les fonctionnalités suivantes, entre autres :
 Ils fournissent une assistance à la configuration de projets (par exemple, des assistants)
 Ils fournissent des fonctionnalités supplémentaires, permettant d'améliorer le projet dans le
Runtime

Les Add-Ins sont accessibles aux emplacements suivants :


 Dans Editor, dans le menu Extras, sous les entrées suivantes :
 Gestion des Add-Ins d'Editor
 Démarrer un assistant d'Editor
 Gérer les services d'Editor...

 Dans le Runtime, dans le nœud Interfaces de programmation - Add-Ins.

COMPATIBILITÉ
Les add-ins zenon sont compatibles en avant et en arrière.

RÉTROCOMPATIBILITÉ

Les Add-Ins sont également compatibles avec les versions récentes de zenon. Si, par exemple, un
Add-In est compilé pour la version 7.60, il peut également être exécuté dans la version 8.00.

RÉTROCOMPATIBILITÉ

Les Add-Ins peuvent être compilés pour les versions antérieures de zenon . Par exemple, un Add-In
avec zenon 8.00 peut être créé pour zenon 7.60.

OUTILS ET ASSISTANCE
Les ressources suivantes proposent des outils et de l'assistance :
 Outils pour développeurs Visual Studio : marketplace.visualstudio.com
(https://marketplace.visualstudio.com)
 Forum des utilisateurs de COPA-DATA : forum.copadata.com (https://forum.copadata.com/)

3.1 Connaissances requises


À l'instar de la création d'autres composants logiciels, le développement de Add-Ins pour zenon exige
un certain niveau de connaissances.

Ces connaissances incluent notamment :

10 | 154
Modules

 Une connaissance de la programmation en C# ou VB.NET (en fonction des exigences et de la


complexité des Add-Ins développés)
 Bonne connaissance de zenon

Les connaissances suivantes sont également recommandées :


 Expérience de l'utilisation des environnements de développement professionnels (tels que
Microsoft Visual Studio)
 Utilisation d'un système de gestion des versions pour le développement (TFS, SVN, GIT)

3.2 Terminologie
Termes spécialisés et signification au regard des Add-Ins.
Terme Signification

Add-In Une collection d'Extensions est fournie dans le package du


module. Un Add-In peut contenir plusieurs Extensions.

Add-In Assembly La bibliothèque compilée (*.dll), qui contient les Extensions.

Add-In Package Un fichier .zip (*.scadaAddIn), qui contient les métadonnées


et les bibliothèques, ainsi que leurs dépendances.

Une Add-In Package inclut un Add-In Assembly

Extension Les Extensions sont des classes pouvant être dérivées d'une
interface, à l'aide d'une ou plusieurs méthodes. Elles
constituent des points d'entrée du Add-In Package.

Chaque classe représentant une Extension est marquée avec


un attribut .NET.

Il existe deux types d'Extensions (à la page 17) : une pour


Editor et une pour le Runtime.
 Wizard Extensions (assistants)

 Service Extensions (services)

IDE Environnement de développement intégré. Acronyme


d'Integrated Development Environment.

Project Add-In Management Composants d'Editor et du Runtime de zenon qui gèrent les
Project Add-In Packages.

Service Extension Mise en œuvre d'une Extension représentant un Service.

Services :

11 | 154
Modules

Terme Signification
 S'exécutent en tâche de fond
 Sont démarrés automatiquement ou manuellement
 Restent en mémoire jusqu'à ce qu'ils soient arrêtés

Wizard Extension Mise en œuvre d'une Extension représentant un assistant.

Assistants :

 Permettent d'accomplir une tâche particulière


 Sont effacés de la mémoire lors de la fermeture

Remarque : les termes spécialisés sont exclusivement utilisés en anglais dans la documentation des
Add-Ins.

3.3 Limitations
Les limitations suivantes s’appliquent aux Add-Ins :
 zenon Web Client prend en charge l'exécution des Add-Ins, cependant, sans prise en charge
d'IDE.
Par conséquent, il est impossible d'effectuer le débogage local des Add-Ins dans zenon Web
Client ; le débogage à l'aide d'outils de débogage à distant est pris en charge.
 L'exécution des Add-Ins n'est pas prise en charge dans le moteur Web HTML.

3.4 Créer un module

INFORMATIONS GÉNÉRALES
Les Add-Ins sont identifiés au moyen d'un Add-In ID. Celui-ci est utilisé lors de l'installation et de
l'importation.

Un Add-In ID est constitué d'un Namespace facultatif et d'un ID local, l'namespace.localId. L'Local ID
identifie un Add-In ; l'Namespace attribue un Add-In à une organisation. Les deux fragments
d'informations sont définis avec l'attribut .NET Mono.AddIn.AddInAttribute. Pour que le nom d'un
Add-In Package reste unique au-delà des limites d'une organisation, l'Namespace du projet du Add-In
est utilisé dans l'ID.
Exemple d'Add-In ID complet : com.organisation.importwizard.

L'attribution d'Namespaces est facultative.


Recommandation : Utilisez les Namespaces. Ceci permet de garantir l'unicité au-delà des limites de
votre organisation. Il est recommandé d'utiliser l'URL de votre organisation, dans l'ordre inverse.
Par exemple : Pour www.example.com, utilisez com.example en tant qu'Namespace.

12 | 154
Modules

Les Namespaces peuvent être ensuite répartis au sein d'une organisation, par exemple, par équipe,
service ou projet.

Les ressources suivantes permettent de créer des Add-Ins :


 Microsoft Visual Studio (à la page 21)
 SharpDevelop (inclus dans le package d'installation) (à la page 28)

Les Add-Ins peuvent être créés dans tous les langages de programmation .NET. La prise en charge
d'IDE est disponible dans les langages de programmation C# et Visual Basic.NET.

Remarque : Pour définir l'environnement de développement utilisé, cliquez sur Ouvrir l'éditeur de
modules dans les paramètres du menu Extras de zenon, sous Paramètres..., sur l'onglet Add-Ins.

3.4.1 Notions fondamentales


Différentes Extensions sont disponibles pour zenon Editor et le Runtime de zenon. Selon l'application,
une Extension correspondante peut être sélectionnée.

Toutes les interfaces nécessaires au développement de Add-Ins sont définies dans l'ensemble
Scada.AddIn.Contracts.

Un Add-In Package peut contenir une ou plusieurs Extensions .

13 | 154
Modules

TYPES D'EXTENSIONS - INTERFACES

Une distinction est établie entre les Extensions suivantes :

EXTENSION D'ASSISTANT D'EDITOR - IEDITORWIZARDEXTENSION (À LA PAGE 17)


 L'exécution est déclenchée par l'utilisateur depuis la boîte de dialogue Extras -> Assistants
d'Editor Wizards... dans zenon Editor.

 Met en œuvre la méthode Run pour exécuter une Wizard Extension dans zenon Editor.

EXTENSION DE SERVICE D'EDITOR - IEDITORSERVICEEXTENSION (À LA PAGE 18)


 L'exécution a lieu automatiquement au démarrage d'Editor, en fonction du paramètre
DefaultStartMode.

Remarque : Pour un démarrage automatique, l'attribut


DefaultStartMode=DefaultStartupModes.Auto doit être défini dans l'Extension. Le mode de
démarrage peut également être modifié depuis la boîte de dialogue Gérer les services
d'Editor... (à la page 41).

 L'administration s'effectue depuis la boîte de dialogue Extras -> Gérer les services d'Editor...
dans zenon Editor.
 Met en œuvre les méthodes Start et Stop pour exécuter une Service Extension dans zenon
Editor.

EXTENSION D'ASSISTANT DE PROJET - IPROJECTWIZARDEXTENSION (À LA PAGE 19)


 L'exécution est déclenchée par l'utilisateur, via la fonction Exécuter l'extension du wizard
project de zenon.
 Met en œuvre la méthode Run pour exécuter une Wizard Extension dans le Runtime de zenon.

EXTENSION DE SERVICE DE PROJET - IPROJECTSERVICEEXTENSION (À LA PAGE 19)


 L'exécution a lieu automatiquement au démarrage du projet dans le Runtime, en fonction du
paramètre DefaultStartMode.
Remarque : Pour un démarrage automatique, l'attribut
DefaultStartMode=DefaultStartupModes.Auto doit être défini dans l'Extension. Le mode de
démarrage peut également être modifié depuis la boîte de dialogue Gérer les services
d'Editor... (à la page 41).

 L'administration s'effectue au moyen de la fonction Gestion des services du Runtime de


zenon.
 Met en œuvre les méthodes Start et Stop pour exécuter une Service Extension dans le Runtime
de zenon.

14 | 154
Modules

ATTRIBUTS DE L'EXTENSION

Les métadonnées suivantes sont définies à l'aide de l'attribut .NET avec le nom AddInExtension.
Propriété Description IEditorWi IEditorSe IProjectWi IProjectS
zardExte rviceExte zardExten erviceExt
nsion nsion sion ension

Name Nom affiché dans les boîtes X X X X


de dialogue.

Information : Correspond
au nom de l'assistant ou du
service dans zenon.

Description Description de l'affichage X X X X


dans les boîtes de dialogue.

Information : Correspond à
la description de l'assistant ou
du service dans zenon.

Category Catégorie utilisée pour le X -- X --


groupement dans les boîtes
de dialogue.

Information : Utilisé pour


catégoriser les assistants dans
la boîte de dialogue
Assistants d'Editor... dans
zenon Editor.

DefaultStartMo Décrit le comportement de -- X -- X


de démarrage par défaut des
extensions de modules de
service après leur installation.
 Manual : L'extension
doit être exécutée
manuellement par
l’utilisateur.
 Auto : L'extension est
exécutée lors du
chargement de
l'espace de travail dans
Editor ou le projet
dans le Runtime.

15 | 154
Modules

Propriété Description IEditorWi IEditorSe IProjectWi IProjectS


zardExte rviceExte zardExten erviceExt
nsion nsion sion ension

S/O : L'option Manual est


utilisée.

Information : Correspond
au type de démarrage du
service dans zenon.

Touche :
 X : vrai

 -- : pas vrai

ATTRIBUTS DU MODULE

Un Add-In Assembly nécessite plusieurs attributs .NET, définis dans le fichier AddInInfo.cs.

Les attributs les plus important et indispensables à l'utilisation du module dans zenon sont les suivants :
Nom de l'attribut Obligatoire Description Exemples

Addin X Identifiant et version du Exemple 1 :


Add-In.
[assembly:
Information : La Addin("AddInIdentifier",
version correspond à la "1.0",
colonne Version dans la Namespace="com.exampl
boîte de dialogue e")]
d'administration du
Exemple 2:
Add-In dans zenon
[assembly:
Editor.
Addin("MultitouchAddIn",
"1.0")]

Exemple 3:
[assembly:
Addin("ProjectCreation",
"1.0")]

AddinDependency X Définit une dépendance [assembly:


sur le système zenon. AddinDependency("scada"
Cette valeur est , "1.0")]
constante ; elle est
nécessaire pour que le
Add-In soit utilisable

16 | 154
Modules

Nom de l'attribut Obligatoire Description Exemples


avec zenon.

AddinName -- Nom du Add-In. [assembly:


AddinName("Editor Add-In
Information : Demo")]
Correspond à la colonne
Nom dans la boîte de
dialogue
d'administration du
Add-In dans zenon
Editor.

AddinDescription -- Description du Add-In. [assembly:


AddinDescription("Demon
Information : strates an Add-In with a
Correspond à la colonne Wizard and a Service
Description dans la boîte extension.")]
de dialogue
d'administration du
Add-In dans zenon
Editor.

Touche :
 X : vrai

 -- : pas vrai

3.4.2 Types d'extensions

3.4.2.1 Assistant dans Editor - Extension d'assistant d'Editor


Les Editor Wizard Extensions sont utilisées pour intégrer des assistants ou d'autres processus d'API
contrôlés par l'utilisateur dans Editor.
 L'exécution est déclenchée par l'utilisateur depuis la boîte de dialogue Extras -> Assistants
d'Editor Wizards... dans zenon Editor.

 Met en œuvre la méthode Run pour exécuter une Wizard Extension dans zenon Editor.

EXEMPLE DE CODE (C#)


[AddInExtension("Nom de l'extension d'assistant", "Description de l'extension d'assistant",
"Catégorie de l'extension d'assistant")]

public class WizardExtension : IEditorWizardExtension

17 | 154
Modules

public void Run(IEditorApplication context, IBehavior behavior)

// Configurer la fonction ici...


}

3.4.2.2 Services dans Editor - Extension d'assistant d'Editor


Les Editor Service Extensions sont utilisées pour mettre en œuvre automatiquement des processus d'API
dans Editor.
 L'exécution a lieu automatiquement au démarrage d'Editor, en fonction du paramètre
DefaultStartMode.

Remarque : Pour un démarrage automatique, l'attribut


DefaultStartMode=DefaultStartupModes.Auto doit être défini dans l'Extension. Le mode de
démarrage peut également être modifié depuis la boîte de dialogue Gérer les services
d'Editor... (à la page 41).

 L'administration s'effectue depuis la boîte de dialogue Extras -> Gérer les services d'Editor...
dans zenon Editor.
 Met en œuvre les méthodes Start et Stop pour exécuter une Service Extension dans zenon
Editor.

EXEMPLE DE CODE (C#)


[AddInExtension("Nom de l'extension de service", "Description de l'extension de service",
"Catégorie de l'extension de service", DefaultStartMode=DefaultStartupModes.Auto)]

public class ServiceExtension : IEditorServiceExtension

public void Start(IEditorApplication context, IBehavior behavior)

// Code de démarrage ici


}

public void Stop()

// Code d'arrêt ici


}

18 | 154
Modules

3.4.2.3 Assistant dans le Runtime - Extension d'assistant de projet


Les Project Wizard Extensions sont utilisées pour mettre en œuvre des assistants ou d'autres processus
d'API contrôlés par l'utilisateur dans le Runtime.
 L'exécution est déclenchée par l'utilisateur, via la fonction Exécuter l'extension du wizard
project de zenon.
 Met en œuvre la méthode Run pour exécuter une Wizard Extension dans le Runtime de zenon.

EXEMPLE DE CODE (C#)


[AddInExtension("Nom de l'extension d'assistant", "Description de l'extension d'assistant",
"Catégorie de l'extension d'assistant")]

public class WizardExtension : IProjectWizardExtension

public void Run(IProject context, IBehavior behavior)

// Configurer la fonction ici...


}

3.4.2.4 Service dans le Runtime - Extension de service de projet


Les Runtime Service Extensions sont utilisées pour mettre en œuvre des tâches de fond dans le Runtime.
 L'exécution a lieu automatiquement au démarrage du projet dans le Runtime, en fonction du
paramètre DefaultStartMode.
Remarque : Pour un démarrage automatique, l'attribut
DefaultStartMode=DefaultStartupModes.Auto doit être défini dans l'Extension. Le mode de
démarrage peut également être modifié depuis la boîte de dialogue Gérer les services
d'Editor... (à la page 41).

 L'administration s'effectue au moyen de la fonction Gestion des services du Runtime de


zenon.
 Met en œuvre les méthodes Start et Stop pour exécuter une Service Extension dans le Runtime
de zenon.

EXEMPLE DE CODE (C#)


[AddInExtension("Nom de l'extension de service", "Description de l'extension de service",
"Catégorie de l'extension de service", DefaultStartMode=DefaultStartupModes.Auto)]

public class ServiceExtension : IProjectServiceExtension

19 | 154
Modules

public void Start(IProject context, IBehavior behavior)

// Code de démarrage ici


}

public void Stop()

// Code d'arrêt ici


}

3.4.3 Contenu des packages de modules


Les Add-In Packages sont des fichiers .zip contenant l'extension de nom de fichier .scadaAddIn. Ils
contiennent des données binaires et des métadonnées. Les fichiers binaires doivent être présents et
peuvent être enregistrés dans un fichier .zip spécifique dans le Add-In Package.
Les Packages peuvent être créés avec Add-In Utility (à la page 32). Les environnements de
développement SharpDevelop et Microsoft Visual Studio sont utilisés pour créer les Packages
automatiquement, lors de la compilation.

Recommandation : Ne modifiez pas les fichiers manuellement ; utilisez toujours Add-In Utility.

CONTENU DU PACKAGE DE MODULE


Le Add-In Package contient :
 Content.xml : Fichier de métadonnées XML décrivant le contenu du package.

 Binary.zip : Fichier .zip contenant les fichiers binaires.

FICHIER XML
Le contenu d'un Add-In Package est indiqué dans son propre fichier XML (Content.xml).

FICHIERS BINAIRES
Les fichiers binaires sont enregistrés dans leur propre fichier ZIP. Ce fichier doit contenir tous les
composants nécessaires pour exécuter le Add-In sur un autre système. Références directes et indirectes
aux .NET Assemblies. Ici, seuls les Assemblies sont inclus. Assemblies ne formant pas partie de .NET
Framework Class Library ou installés lors de l'installation de zenon.

Attention : Assurez-vous de disposer de toutes les licences requises à cette fin.

20 | 154
Modules

Remarque : .NET Assemblies chargés dynamiquement ne sont pas inclus dans les métadonnées des
.NET Assemblies.

Information
COPA-DATA n'accepte aucune responsabilité concernant les Libraries externes
et n'offre aucune assistance technique à ce sujet.

3.4.4 Microsoft Visual Studio


Dans cette section, vous trouverez des informations concernant la création et l'administration des
Add-Ins dans Microsoft Visual Studio.
Les modules peuvent-être créés avec les applications suivantes :
 MS Visual Studio 2015 (Community, Professional, Enterprise)
 MS Visual Studio 2017 (Community, Professional, Enterprise)

3.4.4.1 COPA-DATA Developer Tools


COPA-DATA Developer Tools fournit des outils pour la création de modules pour zenon Editor et le
Runtime, sous forme d'assistants ou de services.

MODULES ZENON
COPA-DATA Developer Tools permet aux utilisateurs de créer et déboguer rapidement et facilement
zenon Add-Ins avec Microsoft Visual Studio. Ils fournissent des modèles de projet pour zenon Editor et
le Runtime. Des modèles pour les services et assistants sont (extensions) sont disponibles pour les deux
applications.

COPA-DATA Developer Tools est compatible avec :


 C#
 VB.NET

Avec COPA-DATA Developer Tools, des Add-In packages sont créés lors du développement de Add-Ins.
Le déploiement et le débogage de Add-In packages sont intégrés. Ceci signifie : Si le débogage est
lancé, les Add-Ins sont déployés et l'outil de débogage est automatiquement lié à zenon Editor ou au
Runtime.

CONDITIONS REQUISES
Pour utiliser COPA-DATA Developer Tools, vous devez disposer de :

21 | 154
Modules

 Visual Studio 2015 (Community, Professional or Enterprise) ou une version supérieure


 zenon 7.60

NOUVEAUTÉ DE LA VERSION 8.00


Nouvelles fonctionnalités et changements pour COPA-DATA Developer Tools dans zenon 8.00 :
 Les modules peuvent être créés pour zenon 7.60 et versions supérieures.
 Prise en charge de Microsoft Visual Studio 2017 (Community, Professional, Enterprise).
 Fournit des modèles de projet pour les assistants WPF pour le Runtime de zenon et pour zenon
Editor.

PREMIERS PAS AVEC COPA-DATA DEVELOPER TOOLS


COPA-DATA Developer Tools vous permet de créer, déboguer et déployer facilement des assistants et
des services.

CRÉATION DU PROJET

Pour créer un nouveau projet, utilisez la boîte de dialogue New Project.

22 | 154
Modules

Une classe d'extension vide est créée lorsque le projet a été créé :

DÉBOGAGE

Pour effectuer le débogage, sélectionnez une cible dans les propriétés du projet :

23 | 154
Modules

DÉPLOIEMENT

Pour effectuer le déploiement, utilisez la commande Deploy du menu Build :

Remarque : Si le débogage est lancé directement, le déploiement démarre directement, lui aussi.
Pendant le déploiement et le débogage, la catégorie SCADA affiche des informations détaillées dans la
fenêtre de résultats.

DOCUMENTATION ET ASSISTANCE
la documentation de COPA-DATA Developer Tools est disponible sous forme d'aide intégrée dans
Visual Studio. Appuyez simplement sur la touche F1 dans l'application pour afficher une aide
contextuelle. En outre, vous pouvez également obtenir de l'assistance sur le site Web de COPA-DATA :
 Utilisez le forum pour obtenir des informations sur les nouvelles fonctionnalités et demander de
l'aide aux autres utilisateurs :

24 | 154
Modules

https://forum.copadata.com/forumdisplay.php?45-Programming-Interface-API
(https://forum.copadata.com/forumdisplay.php?45-Programming-Interface-API)
 Pour accéder à l'assistance de COPA-DATA, contactez notre service d'assistance :
https://www.copadata.com/en/support-services/
(https://www.copadata.com/en/support-services/)

3.4.4.2 Créer un package de module avec Visual Studio


Pour créer un Add-In Package avec Visual Studio :
1. Démarrez Microsoft Visual Studio.
Ou : En sélectionnant l'option de menu Extras -> Ouvrir l'éditeur de modules... dans zenon
Editor.
Remarque : Dans le menu Extras => Paramètres => Modules, vérifiez si Visual Studio est
prédéfini comme environnement de développement.
2. Installez Visual Studio Developer Tools.
Remarque : Cette suite est disponible en téléchargement sur Visual Studio Marketplace
https://marketplace.visualstudio.com/.
3. Sélectionnez File -> New Project..
4. Sélectionnez un modèle correspondant sous Templates -> Visual C# -> SCADA Add-Ins or
Templates -> Visual Basic -> SCADA Add-Ins.

5. Créez un nouveau projet sur cette base :


 Extension de service d'Editor (à la page 18)
 Extension d'assistant d'Editor (à la page 17)
 Extension de service de projet (à la page 19)
 Extension d'assistant de projet (à la page 19)
Remarque : Tous les exemples utilisés dans ce chapitre reposent sur le langage C#.
6. À vous d'ajouter votre code, vos références, etc.
7. Créez le projet.
8. Le Add-In Package avec le suffixe de fichier *.scadaAddIn est automatiquement créé dans le
dossier de sortie du projet (...bin\Debug\ ou ...bin\Release\, en fonction de la configuration).
9. Importez le package du module dans Editor ; pour cela, reportez-vous aux sections suivantes :
 Installation et gestion des modules pour Editor (à la page 38)
 Installation et gestion des modules pour le Runtime (à la page 44)

25 | 154
Modules

DÉFINISSEZ LA VERSION DE ZENON


Pour chaque Add-In, vous devez définir la version de zenon pour laquelle il doit être compilé.
Pour définir la version :
1. Dans l'environnement de programmation, accédez à Add-In Framework Settings.
2. Ouvrez la propriété Minimal Scada Version.
3. Sélectionnez la version souhaitée dans la liste déroulante.
Latest Version : la compilation est exécutée pour la version de zenon actuellement enregistrée.

Pour vérifier la version pour laquelle la compilation est exécutée dans zenon Editor :
1. Cliquez sur le Add-In.
2. Ouvrez le groupe de propriétés Général.
3. Cochez la case de la propriété Version minimale.

3.4.4.3 Déploiement et débogage des modules


Les Add-Ins peuvent être débogués dans Editor et le Runtime.

Remarque : Lors de l'arrêt du débogage, vous pouvez :


 Séparer l'outil de débogage du processus (Detach) : L'exécution d'Editor ou du Runtime
continue.
 Terminer le processus : Editor ou le Runtime sont arrêtés.

DÉBOGAGE DANS EDITOR

Pour déboguer un Add-In dans Editor, suivez ces instructions :


1. Démarrez zenon Editor.
2. Pour commencer le débogage dans Visual Studio, appuyez sur F5 ou sélectionnez Debug ->
Start Debugging.

3. Le projet de Add-In est compilé et déployé dans Editor.


Remarque : Lors de cette procédure, le Add-In est copié vers le répertoire
%ProgramData%\COPA-DATA\zenon810\EditorAddInCache.
Pour le supprimer d'Editor, suivez les instructions fournies au chapitre Installation et gestion des
Add-Ins dans Editor (à la page 38).
4. Déboguez le Add-In.

26 | 154
Modules

Information
En guise d'alternative à la méthode fournie, vous pouvez également déboguer
vos Add-Ins en sélectionnant Debug -> Attach to Process. Dans ce cas, vous
devez connecter le projet de Add-In correspondant dans Visual Studio au
processus de zenon Editor.

Type d'outil de débogage recommandé (Debugger Type) : Managed mit CLR


4.0

DÉBOGAGE DANS LE RUNTIME

Pour déboguer un Add-In dans le Runtime, effectuez les opérations suivantes :


1. Compilez le Add-In et importez-le conformément aux indications du chapitre Installation et
gestion des Add-Ins dans le Runtime (à la page 44).
2. Démarrez le Runtime de zenon
3. Sélectionnez le projet dans Visual Studio, sous Debug Target.
L'instance correspondante doit être en cours d'exécution à cet instant.
4. Pour commencer le débogage, appuyez sur F5 ou sélectionnez Debug -> Run.
5. Le projet Add-In est compilé, puis déployé.
En cas de nouveau déploiement, assurez-vous que l'assistant ou le service n'est pas en cours
d'exécution.
6. Déboguez le Add-In.

Information
En guise d'alternative aux méthodes fournies, vous pouvez également déboguer
vos Add-Ins en sélectionnant Debug -> Attach to Process. Ensuite, sélectionnez
le processus du Runtime de zenon (Zenrt32.exe), puis cliquez sur Attach

3.4.4.4 Fonction de recherche et introduction à la documentation de l'API


zenon
Depuis Visual Studio, vous pouvez accéder directement à la documentation de l'API zenon en appuyant
sur la touche F1, si le pointeur se trouve sur le contenu d'un environnement de module.

Si le pointeur se trouve sur un autre mot-clé, la documentation de MSDN s'affiche.

L'accès à la documentation de l'API zenon est pris en charge dans les versions suivantes de zenon :
 7.60

27 | 154
Modules

 8,00

Et pour les versions suivantes de Visual Studio :


 2015
 2017

Lors de l'ouverture de la documentation de l'API, la version ouverte dans la solution Visual Studio est
prise en compte.

Si aucune version de zenon n'est détectée, la documentation de la version la plus récente de l'API
zenon est ouverte.

Les possibilités d'accès suivantes peuvent être sélectionnées pour la version correspondante de zenon :
 Documentation de l'API du module
 Documentation de l'API Com

Cependant, vous pouvez également rechercher du contenu dans la documentation de l'API zenon :
 Saisie du terme recherché dans l'interface utilisateur de Visual Studio en fonction du contenu
de la documentation de l'environnement du module et la documentation de l'API Com
 Si vous saisissez @zenoncom et le terme recherché dans la barre de recherche de l'interface
utilisateur de Visual Studio, le contenu est recherché dans la documentation Com.
Exemple : @zenoncom Alarme
Saisissez le terme recherché dans la barre de recherche, puis confirmez votre sélection en appuyant sur
la touche Entrée.

Depuis le résultat de la recherche, vous pouvez à nouveau accéder directement à la documentation de


l'API zenon.

3.4.5 SharpDevelop
SharpDevelop (également appelé #develop) est un environnement de développement ouvert reposant
sur la plate-forme Microsoft .NET. SharpDevelop est fourni avec zenon et est installé lors de l'installation
de zenon.
Remarque : La version actuelle et la documentation officielle de SharpDevelop sont disponibles en
ligne, à l'adresse : www.icsharpcode.net/opensource/sd/ (http://www.icsharpcode.net/opensource/sd/).

3.4.5.1 Créer un package de module avec SharpDevelop


Pour créer un Add-In Package avec SharpDevelop :
1. Démarrez SharpDevelop :

28 | 154
Modules

 En sélectionnant l'option de menu Extras -> Ouvrir l'éditeur de modules... dans zenon
Editor,
Ou
 En sélectionnant, dans Startup Tool, sous Tools, le lien SharpDevelop IDE.
Conseil : Dans le menu Extras => Paramètres => Modules, vérifiez si Visual Studio est
prédéfini comme environnement de développement.
2. Sélectionnez File -> New Solution..
3. Sélectionnez un modèle correspondant sous C# -> SCADA Add-Ins or VB -> SCADA Add-Ins.
4. Créez un nouveau projet sur cette base :
 Extension de service d'Editor (à la page 18)
 Extension d'assistant d'Editor (à la page 17)
 Extension de service de projet (à la page 19)
 Extension d'assistant de projet (à la page 19)
Remarque : Tous les exemples utilisés dans ce chapitre reposent sur le langage C#.
5. À vous d'ajouter votre code, vos références, etc.
6. Compilez le projet.
Le Add-In Package (sans suffixe de fichier *.scadaAddIn) est créé dans la fenêtre de sortie du
projet.
Il est nommé, en fonction de la configuration, ...bin\Debug\ ou ...bin\Release\.
7. Importez le package du module dans Editor ; pour cela, reportez-vous aux sections suivantes :
 Installation et gestion des modules pour Editor (à la page 38)
 Installation et gestion des modules pour le Runtime (à la page 44)

DÉFINISSEZ LA VERSION DE ZENON


Pour chaque Add-In, vous devez définir la version de zenon pour laquelle il doit être compilé.
Pour définir la version :
1. Dans l'environnement de programmation, accédez à Add-In Framework Settings.
2. Ouvrez la propriété Minimal Scada Version.
3. Sélectionnez la version souhaitée dans la liste déroulante.
Latest Version : la compilation est exécutée pour la version de zenon actuellement enregistrée.

Pour vérifier la version pour laquelle la compilation est exécutée dans zenon Editor :
1. Cliquez sur le Add-In.
2. Ouvrez le groupe de propriétés Général.

29 | 154
Modules

Cochez la case de la propriété Version minimale.

3.4.5.2 Déploiement et débogage des modules


Les Add-Ins peuvent être débogués dans Editor et le Runtime.

Remarque : Lors de l'arrêt du débogage, vous pouvez :


 Séparer l'outil de débogage du processus (Detach) : L'exécution d'Editor ou du Runtime
continue.
 Terminer le processus : Editor ou le Runtime sont arrêtés.

DÉBOGAGE DANS EDITOR

Pour déboguer un Add-In dans Editor :


1. Démarrez zenon Editor.
2. Démarrez SharpDevelop :
 En sélectionnant l'option de menu Extras -> Ouvrir l'éditeur de modules... dans zenon
Editor,
Ou
 En sélectionnant, dans Startup Tool, sous Tools, le lien SharpDevelop IDE.
3. Ouvrez le projet.
4. Dans les paramètres du projet dans SharpDevelop, accédez à l'onglet Add-In.
5. Sous Debug Target, sélectionnez Editor.
6. Pour commencer le débogage, appuyez sur F5 ou sélectionnez Debug -> Run.
7. Le projet de Add-In est compilé et déployé dans Editor.
Remarque : Lors de cette procédure, le Add-In est copié vers le répertoire
%ProgramData%\COPA-DATA\zenon810\EditorAddInCache.
Pour le supprimer d'Editor, suivez les instructions fournies au chapitre Installation et gestion des
Add-Ins dans Editor (à la page 38).
Si un Add-In comportant le même ID est déjà présent, celui-ci est remplacé.
8. Déboguez le Add-In.

30 | 154
Modules

DÉBOGAGE DANS LE RUNTIME

Le débogage est effectué projet par projet dans le Runtime.


Pour déboguer un Add-In dans le Runtime :
1. Démarrez le Runtime de zenon
2. Démarrez SharpDevelop..
Pour cela, sélectionnez zenon Startup Tool et, sous Tools, sélectionnez le lien SharpDevelop
IDE.

3. Ouvrez le projet.
4. Dans les paramètres du projet dans SharpDevelop, accédez à l'onglet Add-In.
5. Sous Debug Target, sélectionnez le projet dans le Runtime dans lequel vous souhaitez
déboguer le Add-In.
L'instance correspondante doit être en cours d'exécution.
6. Pour commencer le débogage, appuyez sur F5 ou sélectionnez Debug -> Run.
7. Le projet de Add-In est compilé et temporairement déployé dans le projet zenon sélectionné.
En cas de nouveau déploiement, assurez-vous que l'assistant ou le service n'est pas en cours
d'exécution.
Attention : Lors de cette procédure, le Add-In est temporairement copié vers le dossier :
...\RT\FILES\zenon\system\AddInCache\...
Il est à nouveau supprimé après la fermeture du Runtime.
Pour installer un Add-In de façon permanente, importez-le en suivant les instructions fournies à
la section Installation et gestion des Add-Ins dans le Runtime (à la page 44).
8. Déboguez le Add-In.

Information
En guise d'alternative aux méthodes fournies, vous pouvez également déboguer
vos Add-Ins en sélectionnant Debug -> Attach to Process. Dans ce cas, vous
devez connecter le projet de Add-In correspondant dans SharpDevelop au
processus dans Editor ou le Runtime de zenon.

3.4.6 Administration du code source


L'utilisation d'un système de contrôle des versions, tel que TFS, GIT ou SVN est recommandée pour
l'administration du code source.

31 | 154
Modules

Attention
Contrairement à VSTA et VBA, l'enregistrement et l'administration du Source
Code des Add-Ins ne se déroulent pas dans le projet zenon.

3.4.7 Utilitaire d'analyse et de créations de packages de modules


(AddInUtility)
L'utilitaire AddInUtility démarre automatiquement lors d ela compilation des Add-Ins ; il permet
d'exécuter les tâches suivantes :
 Analyse des dépendances
 Package de Add-Ins

Un package contient l'Add-In Assembly et un fichier XML avec le suffixe de fichier *.scadaAddin, dans
lequel se trouvent les métadonnées du Add-In.

3.4.7.1 Outil de ligne de commande AddInUtility.exe


L'utilitaire AddInUtility permet de créer des packages de Add-Ins à l'aide de la ligne de commande.

Syntaxe : AddInUtility.exe [-[shortTerm] or [/ or --][longTerm] [argument value]] ...


 Les arguments ne sont pas sensibles à la casse.
 Les valeurs sont sensibles à la casse si elles sont signalées ainsi.
 Les arguments peuvent être déclarés dans l'ordre choisi.
Argument Description

--action Action devant être exécutée (obligatoire).


(-a) Valeurs possibles :
 BuildPackage
 GetPackageInfo

--path Chemin (obligatoire).


(-p)
Argument nécessaire pour :
 action = BuildPackage

32 | 154
Modules

Argument Description
Chemin du fichier de l'ensemble de modules.

ou
 action = GetPackageInfo
Chemin du fichier Add-In Package.

--targetDir Dossier cible.


(-t)
Information obligatoire pour :
 action = BuildPackage
Chemin du dossier dans lequel est créé le package du
module..

Par défaut : Dossier actuel

Exemples
 Crée un Add-In Package (arguments complets) :
AddInUtility.exe --action BuildPackage --path C:\Addin.dll --targetDir C:\Directory\

 Crée un Add-In Package (arguments abrégés) :


AddInUtility.exe -a BuildPackage -p C:\Addin.dll -t C:\Directory\

 Renvoie des informations concernant le Add-In Package indiqué :


AddInUtility.exe -a GetPackageInfo -p C:\Directory\Addin.scadaAddIn

3.4.8 Action en cas de rechargement


zenon propose une fonction de rechargement pour les projets compatibles avec la fonction de
connexion à chaud ou la mise à jour des fichiers de projet dans le Runtime. Selon les fonctions
déclenchées du Add-Ins, la séquence des activités dans VSTA et VBA est la suivante :
1. Pre-reload VSTA
2. Stop of Service Extensions
3. Reload VBA
4. Start of Service Extensions
5. Post-reload VSTA

Les Add-Ins se comportent comme VSTA et offrent des fonctions de Pre-reload- et de Post-reload-.
Elles sont utilisées après la fonction de Pre-reload de VSTA et avant la fonction de rechargement de
VSTA, et servent de Wrapper pour la fonction de rechargement de VBA. Le rechargement est retardé
jusqu'à ce que l'exécution des Wizard Extensions soit terminée.
Recommandations : Si vous souhaitez utiliser la fonctionnalité de rechargement, évitez les
Wizard-Extensions qui entraînant de longues périodes de blocage ou d'exécution.

33 | 154
Modules

En cas de rechargement, toutes les extensions de services sont redémarrées. Les extensions de services
nouvellement installées sont démarrées après le redémarrage, si le paramètre DefaultStartMode est
défini sur Automatique.

3.4.9 Isolation
Tous les Add-Ins sont exécutés dans une zone isolée de la mémoire (App-Domain). Par conséquent,
différentes versions des mêmes Assemblies peuvent être chargées simultanément.

3.5 Utilisation de modules dans Editor et le Runtime


Les Add-Ins fournissent une aide à la configuration de projet dans zenon Editor, et complètent les
fonctionnalités de zenon dans le Runtime.

Les Add-Ins sont accessibles aux emplacements suivants :


 Dans Editor, dans le menu Extras, sous les entrées suivantes :
 Gestion des Add-Ins d'Editor
 Démarrer un assistant d'Editor
 Gérer les services d'Editor...

 Dans le Runtime, dans le nœud Interfaces de programmation - Add-Ins.

MODULES DANS EDITOR ET LE RUNTIME


 Add-Ins destinés à Editor (à la page 38) :
Les Add-Ins sont importés, installés et peuvent être utilisés dans Editor.
L'administration (à la page 38) se déroule à l'aide des entrées du menu Outils.
 Add-Ins destinés au Runtime (à la page 43) :
Les Add-Ins sont importés ; au démarrage du Runtime, ils sont activés automatiquement et
peuvent ensuite être utilisés.
L'administration (à la page 44) se déroule dans la vue détaillée de l'interface de programmation,
dans le nœud Add-Ins de l'arborescence du projet.

Les Add-Ins sont disponibles sous les formes suivantes :


 Assistant : Appelé par l'utilisateur, puis refermé une fois que la tâche correspondante est
terminée.
Pour plus de détails concernant les assistants fournis avec zenon, veuillez vous reporter au
manuel Assistants.
 Service : Peut être démarré automatiquement ou manuellement ; s'exécute en tâche de fond.

Les Add-Ins peuvent :


 Être fournis avec zenon

34 | 154
Modules

 Être développés par les intégrateurs et fournis à leurs clients


 Être développés par les clients eux-mêmes

PROPRIÉTÉS

Si un Add-In est sélectionné dans Editor, ses propriétés sont affichées dans le nœud Général :
 Nom : Nom du Add-In.
 Description : Description du Add-In.
 Version : Numéro de version du Add-In.
 Code source : Indique si le code source est inclus dans le package.
 Version minimale : La version de zenon la plus basse dans laquelle peut être utilisé leAdd-In.
Elle est définie lors de la création du Add-In pour :
 Microsoft Visual Studio (à la page 25)
 SharpDevelop (à la page 28)

Ces propriétés ne peuvent pas être modifiées dans le Runtime. Elles sont uniquement fournies à titre
d'information.
Les mêmes propriétés sont également affichées dans la vue détaillée pour tous les modules.

FILTRAGE ET TRI DE LA LISTE DE MODULES


Pour filtrer une liste dans la vue détaillée ou une boîte de dialogue :
1. Cliquez sur la ligne de filtre de la courbe souhaitée.
2. Saisissez les critères de filtre.
Des opérateurs peuvent être utilisés.
 ? : Opérateur correspondant à un caractère exactement.
 * : Opérateur correspondant à autant de caractères qu'on le souhaite.
3. Plusieurs filtres peuvent être associés.

Remarque : Pour supprimer tous les filtres, cliquez sur le symbole correspondant dans la barre d'outils.
Pour trier la liste :
1. Cliquez sur l'intitulé de la colonne selon laquelle est triée la liste.
Le symbole représentant des jumelles indique la colonne selon laquelle la liste est triée.
La liste est triée en fonction de cette colonne.
Une flèche indique si l'ordre du tri est ascendant ou descendant.
2. Pour modifier l'ordre de tri, cliquez à nouveau sur l'intitulé de la colonne.

35 | 154
Modules

SAUVEGARDE ET RESTAURATION
Les considérations suivantes s'appliquent à la sauvegarde et la restauration de Add-Ins :
 En cas d'utilisation d'un espace de travail sécurisé, les Add-Ins d'Editor ne sont pas enregistrés.
Remarque : Les Add-Ins installés pour Editor se trouvent dans le dossier
%ProgramData%\COPA-DATA\zenon810\EditorAddInStore. Ils peuvent être sauvegardés
manuellement, si nécessaire.
 Les Add-In Packages de projets sont également sauvegardés lors de la création de sauvegardes
de projets et d'espaces de travail, puis sont restaurés lors de la réimportation.

HISTORIQUE DES MODIFICATIONS


Si l'historique des modifications a été activé pour le projet, les entrées de l'historique des modifications
sont générées dans le projet lors de l'installation et de la désinstallation de Add-In Packages.

3.5.1 Activation de modules dans zenon


L'utilisation de Add-Ins doit être activée dans le fichier zenon6.ini. L'entrée suivante doit être présente :

[AddIns]

ON=1

Cette entrée est activée par défaut après l'installation de zenon.

3.5.2 Action durant l'installation


Les Add-Ins peuvent être utilisés dans Editor ou dans le Runtime.
Les considérations suivantes s'appliquent lors de l'installation de Add-Ins :
1. Nouvelle installation :
Le Package sélectionné est enregistré dans le dossier AddInStore.
 Dossier d'installation dans Editor (à la page 38) :
%ProgramData%\COPA-DATA\zenon810\EditorAddInStore
 Dossier d'installation dans le Runtime (à la page 44) :
...\RT\FILES\zenon\system\AddInStore\...
L'identifiant de Add-In est utilisé en tant que nom de fichier, et le suffixe de fichier .scadaAddIn
est ajouté.
2. Nouvelle installation avec le même identifiant :
Le Add-In existant est remplacé.

36 | 154
Modules

3. Pendant l'installation, les fichiers existants d'autres versions (antérieures ou ultérieures) sont
remplacés.

Information
L'Add-In ID est unique pour chaque Add-In et est défini par un attribut .NET
dans le fichier AddInInfo.cs.

Exemple (Add-In ID = AddInProject) :

// Déclare que cet ensemble est un module


[assembly: Addin("AddInProject", "1.0")]

3.5.3 Nœud des modules dans le gestionnaire de projet


Dans l'arborescence de projet du gestionnaire de projet, des modules peuvent être importés depuis le
nœud Interfaces de programmation. Vous trouvez plus de détails au chapitre Menu contextuel de
l'arborescence du projet. (à la page 37)

3.5.3.1 Menu contextuel de l'arborescence du projet


Cliquez avec le bouton droit sur le symbole Add-Ins dans le nœud Interfaces de programmation de
l'arborescence du projet pour ouvrir un menu contextuel :
Entrée Description

Importer un Add-In ... Ouvre la boîte de dialogue d'importation d'un Add-In


Package destiné à être utilisé dans le Runtime.
Remarque : Le package est uniquement importé, pas
installé. L'installation est effectuée dans le Runtime.

Profil Editor Opens the drop-down list with predefined editor profiles.

Aide Opens online help.

37 | 154
Modules

3.5.3.2 Vue de détail de la barre d'outils et du menu contextuel


Dans la vue détaillée du nœud Add-In de l'arborescence de projet, les Add-Ins utilisés dans le Runtime
sont affichés ; l'administration s'effectue au moyen d'une barre d'outils et d'un menu contextuel.

Entrées du menu contextuel et signification des symboles, de gauche à droite :


Symbole/Entrée Description

Importer un Add-In Ouvre la boîte de dialogue d'importation d'un Add-In


Package destiné à être utilisé dans le Runtime.
Remarque : Le package est uniquement importé, pas
installé. L'installation est effectuée dans le Runtime.

Supprimer Désinstalle et supprime le Add-In après une demande de


confirmation.

Supprimer tous les filtres Supprime tous les filtres actuellement appliqués dans la liste
de Add-Ins.

Propriétés Ouvre la fenêtre de Propriétés.

Aide Opens online help.

3.5.4 Utilisation dans zenon Editor


Il est possible d'utiliser des Add-Ins dans zenon Editor.

Les modules pour Editor peuvent contenir les éléments suivants :


 Editor Wizard Extensions (à la page 17) : pour les démarrer manuellement, sélectionnez Extras
-> Assistants d'Editor.

 Les extensions de service d'Editor (à la page 18) sont démarrées si l'espace de travail est chargé
et son mode de démarrage est configuré sur Automatique. Elles sont arrêtées dès que l'espace
de travail est fermé.

Les Add-Ins pour Editor sont enregistrés sous :


%ProgramData%\COPA-DATA\zenon810\EditorAddInStore

3.5.4.1 Installation et gestion des modules pour Editor


L'importation, l'installation et l'administration des Add-Ins peuvent être effectuées dans zenon Editor.

38 | 154
Modules

Remarque : Seuls les Add-Ins avec des Editor Extensions peuvent être importés et installés. Si des
Editor Extensions ne sont pas détectées durant l'importation, un avertissement correspondant s'affiche.

IMPORTATION ET INSTALLATION DE MODULES


Pour importer et installer un Add-In :
1. Ouvrez le menu Outils.
2. Sélectionnez l'entrée Gérer les Add-Ins d'Editor.
La boîte de dialogue de gestion des Add-Ins s'affiche.
3. Cliquez sur le symbole Importer et installer, sélectionnez l'entrée dans le menu contextuel ou
appuyez sur la touche Insér..
La boîte de dialogue (à la page 40) de sélection d'un Add-In s'affiche à l'écran.
4. Sélectionnez le Add-In de votre choix.
5. Cliquez sur l’option Ouvrir.
Le Add-In est importé et installé.
6. Cliquez sur Fermer pour fermer la boîte de dialogue.

DÉSINSTALLER ET SUPPRIMER UN MODULE


Désinstaller et supprimer un Add-In :
1. Ouvrez le menu Outils.
2. Sélectionnez l'entrée Gérer les entrées d'Editor.
La boîte de dialogue de gestion des Add-Ins s'affiche.
3. Sélectionnez un Add-In.
4. Cliquez sur le symbole Désinstaller et supprimer, sélectionnez l'entrée dans le menu contextuel
ou appuyez sur la touche Suppr..
Une boîte de dialogue de demande de confirmation s'affiche.
5. Confirmez cette sélection lorsque le programme vous invite à le faire.
Le Add-In est désinstallé et supprimé.

39 | 154
Modules

3.5.4.1.1 Boîte de dialogue de gestion des modules d'Editor

Option Description

Barre d’outils Contient des symboles permettant :


 D'importer, d'installer et de supprimer des Add-Ins
 De supprimer le filtre
 D'afficher l'aide

Liste des Add-Ins Affiche la liste de tous les Add-Ins installés.


Les informations suivantes sont affichées :
 Nom
 Description
 Version
 Présence de code source.

Les éléments peuvent être filtrés et triés.

Fermer Ferme la boîte de dialogue.

Aide Opens online help.

BARRE D'OUTILS ET MENU CONTEXTUEL

40 | 154
Modules

Signification des entrées du menu contextuel et des symboles, de gauche à droite :


Symbole Description

Importer et installer Ouvre la boîte de dialogue de sélection de Add-Ins. Le


module peut ensuite être importé et installé.

Désinstaller et supprimer Désinstalle et supprime le Add-In après une demande de


confirmation.

Supprimer tous les filtres Supprime tous les filtres actuellement appliqués dans la liste
de Add-Inss.

Aide Opens online help.

3.5.4.1.2 Gestion des services de l'éditeur


Les Add-In Extensions exécutées en tant que services dans Editor sont gérées depuis une boîte de
dialogue dédiée.

Gestion des services d'Editor


1. Ouvrez le menu Outils
2. Sélectionnez l'option Gérer les services d'Editor....
La boîte de dialogue de gestion des services s'ouvre.

41 | 154
Modules

BOÎTE DE DIALOGUE GÉRER LES SERVICES D'EDITOR

Option Description

Barre d’outils Contient des symboles permettant :


 De démarrer et d'arrêter le Runtime
 Configuration du type de démarrage
Automatique
Manuel
 De supprimer le filtre
 D'afficher l'aide

Liste des services Affiche la liste de tous les Services installés. Les informations
suivantes sont affichées :
 Nom
 Description
 Type de démarrage
 États

Les éléments peuvent être filtrés et triés.

Fermer Ferme la boîte de dialogue.

Aide Opens online help.

42 | 154
Modules

Remarque : Cette boîte de dialogue est également accessible dans le Runtime (à la page 47), via la
fonction Afficher la boîte de dialogue "Gérer les services runtime".

BARRE D'OUTILS ET MENU CONTEXTUEL

Signification des entrées du menu contextuel et des symboles, de gauche à droite :


Symbole Description

Démarrer le service Démarre le service sélectionné.

Arrêter le service Arrête le service sélectionné.

Démarrer manuellement Définit le type de démarrage du service sélectionné sur


Manuel.

Démarrer automatiquement Définit le type de démarrage du service sélectionné sur


Automatique.

Supprimer tous les filtres Supprime tous les filtres actuellement appliqués dans la liste
de services.

Aide Opens online help.

COMPORTEMENT DE DÉMARRAGE ET D'ARRÊT


Si le mode de démarrage Automatique a été sélectionné pour un Workspace Service Add-In, il est
chargé avant l'Event OnWorkspaceStartup lors du démarrage d'Editor. Lorsqu'Editor est fermé, il est
arrêté avant l'événement OnWorkspaceExit. Le module peut ainsi réagir aux événements (Events) de
zenon.

3.5.5 Utilisation dans le Runtime de zenon


L'importation et l'administration des modules destinés à être utilisés dans le Runtime de zenon
s'effectue dans Editor. Ils sont installés automatiquement au démarrage du Runtime, afin de pouvoir être
exécutés dans le Runtime. Chaque projet zenon gère ses propres modules.
 Les Add-Ins sont copiés vers le dossier suivant lors de la création des fichiers de Runtime pour
un projet : ...\RT\FILES\zenon\system\AddInStore\...
 Les Add-Ins sont installés dans le dossier suivant lors du démarrage du Runtime
:...\RT\FILES\zenon\system\AddInCache\...
Par ailleurs :

43 | 154
Modules

 Les Add-In Packages modifiés sont mis à jour.


La synchronisation est effectuée en fonction de la date de modification du Add-In
Packages.
 Les Add-Ins qui ne sont plus présents sont supprimés.
 Les Project Service Extensions (à la page 19) dont le mode de démarrage est défini sur
Automatique sont instanciées et démarrées automatiquement.
 Les Project Wizard Extensions (à la page 19) peuvent être exécutées à l'aide de la fonction
Exécuter l'extension du wizard project de zenon.

Hint
Vous pouvez accéder rapidement au dossier du projet en sélectionnant le projet
dans Editor, puis en appuyant sur la combinaison de touches Ctrl+Alt+R.

3.5.5.1 Installation et gestion des modules pour le Runtime


Les Add-Ins pour le Runtime sont importés dans Editor et sont installés automatiquement au démarrage
du Runtime. L'importation s'effectue depuis le menu contextuel ou la barre d'outils dans la vue de détail.

IMPORTER UN MODULE
Pour importer un Add-in :
1. Dans Editor, ouvrez la vue détaillée des Add-Ins dans l'arborescence du projet.
2. Cliquez sur le symbole Importer un Add-In, sélectionnez l'entrée dans le menu contextuel ou
appuyez sur la touche Insér.
La boîte de dialogue de sélection d'un Add-In s'affiche à l'écran.
3. Sélectionnez le Add-In de votre choix.
4. Cliquez sur l’option Ouvrir.
Le Add-in est importé.
Information :
 Le Add-In n'est enregistré avec les fichiers du Runtime qu'après la création de ces derniers.
Dossier d'enregistrement :...\RT\FILES\zenon\system\AddInStore\...
 Lors du démarrage ou du rechargement du Runtime, il est installé, modifié ou mis à jour
dans le dossier suivant :
...\RT\FILES\zenon\system\AddInCache\...

44 | 154
Modules

Pendant la modification, la synchronisation est effectuée en fonction des informations


d'horodatage du Add-In Package.
5. Cliquez sur Fermer pour fermer la boîte de dialogue.

Remarque : Seuls les Add-Ins avec des Project Extensions peuvent être importés et installés. Si des
Project Extensions ne sont pas détectées durant l'importation, un avertissement correspondant s'affiche.

INSTALLATION ET DÉSINSTALLATION DE MODULES


Les Add-Ins sont installés ou mis à jour automatiquement lors du démarrage du Runtime.

Procédure :
 Lorque le Runtime est démarré, les Packages installés pour le projet sont comparés à ceux dans
Editor.
 Cette opération est effectuée en fonction des informations d'horodatage.
 En présence d'informations d'horodatage différentes ou de nouveaux Packages, le Package est
installé. Tout Package existant avec le même nom est remplacé.
 Si un Package n'est plus présent dans Editor, mais est présent dans le Runtime, il est également
supprimé du Runtime.

RECHARGER UN MODULE
Les modules modifiés et nouveaux peuvent être rechargés dans le Runtime.
Avant le rechargement, une vérification est effectuée pour déterminer si le Add-In Cache et le Add-In
Store sont différents. Le rechargement est redémarré si des différences sont détectées.

Procédure :
1. Tous les services de Add-In sont arrêtés.
2. L'état est enregistré.
3. Le Cache est mis à jour avec le contenu du Store.
4. Les états de tous les services existants avant le rechargement sont restaurés.
5. Les nouveaux services ajoutés sont démarrés avec le type de démarrage Automatique.

Remarque : Avec les assistants, le rechargement n'est déclenché que si un assistant en cours
d'exécution a été fermé.

SUPPRIMER UN MODULE
Pour supprimer un Add-In :
1. Dans Editor, ouvrez la vue détaillée des Add-Ins dans l'arborescence du projet.

45 | 154
Modules

2. Sélectionnez un Add-In.
3. Cliquez sur le symbole Supprimer ou appuyez sur la touche Suppr..
Une boîte de dialogue de demande de confirmation s'affiche.
4. Confirmez cette sélection lorsque le programme vous invite à le faire.
Le Add-In est supprimé.
La prochaine fois que les fichiers du Runtime auront été compilés, le module sera désinstallé
lors du rechargement ou du redémarrage du Runtime.

DÉMARRAGE D'ASSISTANTS ET ADMINISTRATION DE SERVICES


Les assistants peuvent être démarrés et les services peuvent être administrés dans le Runtime.
Utilisez les fonctions de zenon pour cela. Vous pouvez les configurer dans Editor et les appeler dans le
Runtime.
Pour plus détails concernant les fonctions disponibles et leur configuration, reportez-vous au chapitre
Fonctions de zenon (à la page 47).

3.5.6 Dépannage

EXTENSION .SCADAADDIN DÉSACTIVÉE


Il peut arriver que l'extension .scadaAddIn soit désactivée dans Visual Studio.

Dans ce cas, l'extension peut être activée manuellement et sera disponible après un redémarrage.
Toutefois, après la fermeture de Visual Studio, l'extension reste désactivée jusqu'à sa prochaine
ouverture.

Des informations détaillées sont disponibles :


https://github.com/madskristensen/BundlerMinifier/issues/214
(https://github.com/madskristensen/BundlerMinifier/issues/214)

SOLUTION :

Pour modifier cela de façon permanente :


1. Désinstallez les SCADA Add-Ins de COPA-DATA.
2. Utilisez DuplicateExtensiuonFinder pour supprimer tous les fichiers restants de l'installation.
L'application est disponible à l'adresse suivante :
https://github.com/remcoros/DuplicateExtensionFinder
(https://github.com/remcoros/DuplicateExtensionFinder)
3. Installez à nouveau le SCADA Add-In de COPA-DATA.

46 | 154
Modules

3.6 Fonctions de zenon


zenon dispose de fonctions dédiées aux Add-Ins :
 Afficher la boîte de dialogue "Gérer les services Runtime » (à la page 47) : Ouvre la boîte de
dialogue de gestion des services dans le Runtime.
 Exécuter l'extension Project Wizard (à la page 49) : Sélection d'un assistant exécuté dans le
Runtime.

3.6.1 Afficher la boîte de dialogue Gestion des services du Runtime


Cette fonction permet d'appeler la boîte de dialogue Gestion des services dans le Runtime. Tous les
services d'extension installés sont disponibles et peuvent être gérés.
Vous pouvez effectuer les opérations suivantes :
 Démarrer et arrêter les services
 Configurer le démarrage automatique ou manuel d'un service

DÉVELOPPEMENT DE FONCTION
Étapes de création de la fonction :
1. Créez une nouvelle fonction :
Dans la barre d'outils ou le menu contextuel du nœud Fonctions, sélectionnez Nouvelle
fonction.
La boîte de dialogue de sélection d'une fonction s'affiche à l'écran.
2. Accédez au nœud Add-in.
3. Sélectionnez la fonction Afficher la boîte de dialogue "Gérer les services runtime".
La boîte de dialogue est fermée.
4. Name the function in the Nom property.

47 | 154
Modules

COMPORTEMENT DANS LE RUNTIME


Dans le Runtime, l'exécution de la fonction ouvre la boîte de dialogue Gestion des services du Runtime :

Option Description

Barre d’outils Contient des symboles permettant :


 De démarrer et d'arrêter le Runtime
 Configuration du type de démarrage :
Automatique
Manuel
 De supprimer le filtre

Liste des services Affiche la liste de tous les Services installés. Les informations
suivantes sont affichées :
 Nom
 Description
 Type de démarrage
 États

Les éléments peuvent être filtrés et triés.

Les actions associées aux éléments affichés peuvent être


exécutées depuis la barre d'outils ou le menu contextuel.

Fermer Ferme la boîte de dialogue.

48 | 154
Modules

BARRE D'OUTILS ET MENU CONTEXTUEL

Entrées du menu contextuel et signification des symboles (de gauche à droite) :


Symbole Description

Démarrer le service Démarre le service sélectionné.

Arrêter le service Arrête le service sélectionné.

Démarrer manuellement Définit le type de démarrage du service sélectionné sur


Manuel.

Démarrer automatiquement Définit le type de démarrage du service sélectionné sur


Automatique.

Supprimer tous les filtres Supprime tous les filtres actuellement appliqués dans la liste
de services.

3.6.2 Exécuter l'extension Project Wizard


La fonction Exécuter l'extension du wizard project permet d’exécuter un assistant dans le Runtime.
Pour exécuter le module, celui-ci doit être configuré dans Editor et appelé dans le Runtime. L'assistant
devant être lié doit déjà avoir été importé dans Editor.

DÉVELOPPEMENT DE FONCTION
Étapes de création de la fonction :
1. Créez une nouvelle fonction :
Dans la barre d'outils ou le menu contextuel du nœud Fonctions, sélectionnez Nouvelle
fonction.
La boîte de dialogue de sélection d'une fonction s'affiche à l'écran.
2. Accédez au nœud Add-in.
3. Sélectionnez la fonction Exécuter l'extension du wizard project.
La boîte de dialogue de sélection d'un assistant s’affiche à l’écran.
4. Sélectionnez l'assistant souhaité.
5. Fermez la boîte de dialogue en cliquant sur OK.
6. Name the function in the Nom property.

49 | 154
Modules

EXÉCUTER LA BOÎTE DE DIALOGUE DE L'EXTENSION PROJECT WIZARD :

Option Description

Liste des assistants Affiche tous les assistants trouvés dans l'arborescence
du projet dans le nœud Interface de
programmation/Add-Ins.

Les éléments affichés peuvent être filtrés et triés.


Critères :
 Nom
 Description
 Catégorie

Un seul assistant peut être sélectionné.

Ligne d'état Affichage :


 nombre total d'assistants
 nombre d'assistants filtrés
 Nombre d'assistants sélectionnés

Afficher cette boîte de dialogue Active: When calling up the function in the Runtime, this
dans le Runtime dialog is opened and the user can amend the
configuration before execution.

The dialog is displayed on the current computer in the

50 | 154
Modules

Option Description
Runtime. During network operation when activating the
client the dialog is also displayed on the client

FERMER BOÎTE DE DIALOGUE


Option Description

OK Applique les paramètres et ferme la boîte de dialogue.

Annuler Annule toutes les modifications et ferme la boîte de


dialogue.

Aide Opens online help.


Disponible uniquement dans Editor.

COMPORTEMENT DANS LE RUNTIME


Dans le Runtime, cliquer sur un élément lié à la fonction exécute l'assistant configuré.
Si l’option Afficher cette boîte de dialogue dans le Runtime est activée, la boîte de dialogue de
sélection d'assistant s’affiche avant qu'un assistant ne soit sélectionné. L'assistant devant être exécuté
peut être resélectionné.

Aucun assistant n'est exécuté si le bouton Annuler est sélectionné dans la boîte de dialogue dans le
Runtime.

3.7 Changement/conversion depuis VSTA

EDITOR
Pour convertir une fonctionnalité VSTA existante depuis Editor, suivez ces instructions.

FONCTIONNALITÉS D'ASSISTANTS

Une fonctionnalité mise en œuvre à l'aide d'un assistant VSTA peut uniquement être mise an œuvre au
moyen d'Editor Wizard Extensions (à la page 17).

Copiez le code existant vers une Editor Wizard Extension, puis apportez les modifications requises au
code.

Démarrez l'assistant depuis la boîte de dialogue Assistants d'Editor....

51 | 154
Modules

FONCTIONNALITÉS D'ÉVÉNEMENTS VSTA

Une fonctionnalité exécutée de manière événementielle (par exemple, via .OnElementCreated,


.OnPreBuild) peut maintenant être mise en œuvre à l'aide d'Editor Service Extensions (à la page 18).

Pour cela, copiez le code d'initialisation du gestionnaire d'événements vers la méthode de Start de
l'Editor Service Extension. Copiez ensuite le code destiné à l'exécution vers la méthode d'Stop.

Remarque : Pour un démarrage automatique, l'attribut DefaultStartMode=DefaultStartupModes.Auto


doit être défini dans l'Extension. Le mode de démarrage peut également être modifié depuis la boîte de
dialogue Gérer les services d'Editor... (à la page 41).

FONCTIONNALITÉS DE MACROS VSTA.

Une fonctionnalité exécutée depuis la zone de liste déroulante Exécuter une macro VBA/VSTA peut
maintenant être mise en œuvre à l'aide d'Editor Wizard Extensions (à la page 17).

Pour cela, copiez le code issu de votre macro VSTA existante vers la méthode d'Run de l'Editor Wizard
Extension, puis modifiez le code si nécessaire.

Exécutez le code depuis la boîte de dialogue Assistants d'Editor....

RUNTIME
Pour convertir une fonctionnalité VSTA existante depuis le Runtime, suivez ces instructions.

FONCTIONNALITÉS DE MACROS VSTA.

Une fonctionnalité exécutée au moyen de la fonction Exécuter macro VSTA peut maintenant être mise
en œuvre à l'aide des Project Wizard Extensions (à la page 19).

Pour cela, copiez le code issu de votre macro VSTA existante vers la méthode d'Run de l'Project Wizard
Extension, puis modifiez le code si nécessaire.

Pour démarrer l'Project Wizard Extension, utilisez la fonction Exécuter l'extension du wizard project
de zenon.

FONCTIONNALITÉS D'ÉVÉNEMENTS VSTA

Une fonctionnalité exécutée de manière événementielle (par exemple, via .DynPictures().Open,


.Alarm().AlarmComes) peut maintenant être mise en œuvre à l'aide d'Project Service Extensions (à la
page 19).

Pour cela, copiez le code d'initialisation du gestionnaire d'événements vers la méthode de Start de
l'Project Service Extension. Copiez ensuite le code destiné à l'exécution vers la méthode d'Stop.

52 | 154
Liste de macros

Remarque : Pour un démarrage automatique, l'attribut DefaultStartMode=DefaultStartupModes.Auto


doit être défini dans l'Extension.

4 Liste de macros
Vous pouvez utiliser le VBA et VSTA pour étendre les fonctions de zenon. L’utilisation de macros avec
zenon est décrite.

MENU CONTEXTUEL
Élément de menu Action

Ouvrir l’éditeur VBA Ouvre l’éditeur VBA.

Exporter VBE tous Ouvre la boîte de dialogue de sélection du répertoire de


stockage des données VBE exportées.

Importer VBE Ouvre la boîte de dialogue de sélection du fichier


d’importation de données VBE.

Profils Editor Ouvre la liste déroulante contenant les profils Editor prédéfinis.

Aide Ouvre l’aide en ligne.

Information
Si des macros VBA sont modifiées dans Editor,
 Les fichiers de Runtime sont compilés et transférés vers le Runtime
 Le Runtime est actualisé
 Les éléments VSTA sont également actualisés, même si aucune modification
n’a été effectuée dans VSTA

VBA démarre le même environnement de développement pour Espace de travail et le projet.


Pour ouvrir l’éditeur VBA :
1. Dans zenon Editor, accédez au nœud Interface de programmation.
2. Pour développer l’affichage de ce nœud, cliquez sur [+].
La vue du nœud est développée.
3. Cliquez avec le bouton droit sur Liste de macros.
4. Sélectionnez Ouvrir l’éditeur VSTA dans le menu contextuel.

53 | 154
Liste de macros

Vous pouvez également procéder ainsi : Appuyez sur les touches Ctrl+F11.

4.1 Vue de détail de la barre d’outils et du menu contextuel VBA

BARRE D’OUTILS

Élément de menu Action

Nouvelle macro VBA Crée une nouvelle macro et ouvre l’éditeur de macros.

Ouvrir l’éditeur VBA Ouvre l’éditeur VBA.

Enregistrer Enregistre les macros.

Supprimer Supprime l’élément sélectionné.

Exporter VBE tous Ouvre la boîte de dialogue de sélection du répertoire de


stockage des données VBE exportées.

Importer VBE Ouvre la boîte de dialogue de sélection du fichier


d’importation de données VBE.

Renommer Permet de renommer la macro sélectionnée.

Aide Ouvre l’aide en ligne.

MENU CONTEXTUEL MODULE


Élément de menu Action

Ouvrir l’éditeur VBA Ouvre l’éditeur VBA.

Enregistrer Enregistre les macros.

Exporter VBE tous Ouvre la boîte de dialogue de sélection du répertoire de


stockage des données VBE exportées.

Importer VBE Ouvre la boîte de dialogue de sélection du fichier


d’importation de données VBE.

Aide Ouvre l’aide en ligne.

54 | 154
Liste de macros

MENU CONTEXTUEL MODULE


Élément de menu Action

Nouvelle macro VBA Crée une nouvelle macro et ouvre l’éditeur VBA.

Aide Ouvre l’aide en ligne.

MENU CONTEXTUEL MACRO


Élément de menu Action

Édition Ouvre une macro dans Editor pour l’édition.

Alternative : Touche Entrée ou double-clic.

Supprimer Supprime la macro.

Alternative : touche Suppr.

Renommer Ouvre les éléments de liste pour l’édition.

Alternative : La touche F2

Aide Ouvre l’aide en ligne.

BARRE D’OUTILS EDITOR


Les macros créées en langage VBA peuvent être gérées via l’élément de barre d’outils Liste de macros.

Si un filtre est sélectionné, cette sélection est également visible dans la barre d’outils.

Symbole Description

Recharger la liste des macros Charge toutes les macros Public Sub Name () incluses dans
VBA/VSTA myWorkspace et les modules dans la liste déroulante de la
barre d’outils.

Rechercher une macro Vous pouvez rechercher des macros par l’intermédiaire d’un
champ de saisie ou d’une liste déroulante. La largeur de la
liste déroulante est déterminée en fonction de l’élément le
plus large.

Liste déroulante Macros Contient toutes les macros chargées et vous permet de les
sélectionner.

Exécuter la macro sélectionnée Exécute la macro sélectionnée dans la liste déroulante.

55 | 154
Liste de macros

Symbole Description

Exécuter la macro associée n° <x> Exécute la macro associée au symbole.

Associer des macros Ouvre la boîte de dialogue d’association de macros. Jusqu’à


5 macros peuvent être associées aux symboles 1 à 5.

VBA Filtres pour les macros VBA. Seules les macros VBA sont
affichées.

VSTA Filtres pour les macros VSTA. Seules les macros VSTA sont
affichées.

ALL Annule le filtre actuel et affiche toutes les macros.

AZ Trie les macros par ordre croissant, de 0 à 9 et de A à Z.

ZA Trie les macros par ordre décroissant, de Z à A et de 9 à 0.

Options pour la barre d’outils Cliquez sur la flèche pour ouvrir le sous-menu :

Active : la barre d’outils est affichée.

Si la barre d’outils n’est pas affichée, elle peut être activée


en sélectionnant le menu Options -> Barre d’outils.

Remarque : Si la barre d’outils est positionnée librement


(c’est-à-dire dissociée d’Editor), les options ne sont pas
affichées. Pour fermer la barre d’outils, cliquez sur le bouton
X.

Information
Si la boîte de dialogue d’association de macros ne contient pas toutes les
macros de myWorkspace, exécutez la fonction Recharger la liste des macros VBA
dans la barre d’outils.

4.2 VBA sur les systèmes 64 bits


zenon est compatible avec les systèmes 64 bits depuis la version 7.10. La version de VBA utilisée est
désormais la version 7.1. zenon est également disponible dans une version 64 bits. Si, dans le code VBA,
des fonctions de Windows API ou d'autres fichiers DLL importés sont utilisées, ces exécutions doivent
être adaptées à la version 64 bits. En règle générale, les dispositions suivantes s’appliquent : Un fichier
VBA créé pour une version 32 bits ne peut pas être utilisé sans modification dans une-version 64 bits.

56 | 154
Liste de macros

Certaines définitions/fonctions sont disponibles dans VBA, permettant ainsi de créer du code compatible
32 bits et 64 bits. Par exemple :
#if Win64 then
Declare PtrSafe Function MyMathFunc Lib "User32" (ByVal N As LongLong) As LongLong
#else
Declare Function MyMathFunc Lib "User32" (ByVal N As Long) As Long
#end if
#if VBA7 then
Declare PtrSafe Sub MessageBeep Lib "User32" (ByVal N AS Long)
#else
Declare Sub MessageBeep Lib "User32" (ByVal N AS Long)
#end if

Vous pouvez également consulter des notes utiles concernant le portage de code VBA 32 bits en code
VBA 64 bits de Microsoft :
 Microsoft Office 2010, notes on porting: http://msdn.microsoft.com/en-us/library/ee691831.aspx
(http://msdn.microsoft.com/en-us/library/ee691831.aspx) : Microsoft Office 2010, notes
concernant le portage :
 Déclarations 32 bits et 64 bits pour appels API :
http://www.jkp-ads.com/articles/apideclarations.as
(http://www.jkp-ads.com/articles/apideclarations.as)p

4.3 Notions fondamentales


Décrit les notions fondamentales du langage de programmation VBA (Visual Basic for Applications)

4.3.1 Les propriétés des objets


Une propriété d’objet est un attribut de l’objet. Dans le cas de l’objet Variable, c’est par exemple, la
valeur, le nom ou l’identification. Dans le cas d’un cercle, ce sera la position ou la couleur du cercle dans
le synoptique. Chaque objet a au moins une propriété (généralement plus), chaque propriété ayant une
certaine valeur. La propriété Name est un texte, la propriété Value est une valeur entre 0 et 1000, par
exemple.

La particularité des propriétés est que si on change leur valeur par un programme VBA, alors on change
le comportement ou l’apparence de l’objet. Si vous modifiez, par exemple, la propriété Value d’un objet
Variable, la variable actuellement sélectionnée reçoit cette nouvelle valeur. Vous ne pouvez pas toujours
changer la valeur d’une propriété. La propriété Count de l’objet variable ne peut pas être modifiée, car
elle représente le nombre de variables créées. Vous ne pouvez pas ajouter des variables en changeant
la valeur de la propriété Count. Ainsi certaines propriétés ont l’attribut 'lecture seule', c’est-à-dire
qu’elles ne sont accessibles qu’en lecture.

57 | 154
Liste de macros

4.3.2 Les méthodes des objets


En plus des propriétés, chaque objet peut avoir des méthodes. Une méthode n’est pas un attribut, mais
une requête sur l’objet pour faire quelque chose. Un formulaire comporte une méthode Show (Afficher).
Qu’est-ce que cela fait ? Cela demande au 'form' de s’afficher à l’écran. De façon similaire, le formulaire
disparaît si l’on utilise la méthode globale Unload.

L’avantage des méthodes est que le programmeur n’a pas à connaître la structure de l’objet, et
par-dessus tout, il n’a pas la possibilité de changer les données internes de l’objet.

L’exécution de la méthode Show (Afficher) ou Unload (Masquer) fonctionne de la façon suivante :

frmSollwert.Show ou Unload frmSollwert

Si vous voulez ouvrir un autre 'form', la méthode est la même, vous avez juste à changer le nom du
'form' (nom de l’objet).

frmChange.Show ou Unload frmChange

Donc une seule et même méthode peut être utilisée pour chacun des objets. Mais tous les objets n’ont
pas des méthodes.

4.3.3 Les événements des objets


Pour 90% des choses que vous aurez à faire avec les objets, vous utiliserez les propriétés et les
méthodes, mais il y a aussi un troisième type d’attribut que les objets peuvent avoir : les événements.
Certains objets du système de contrôle peuvent réagir à des événements. Les événements se produisent
de manière indépendante durant l’utilisation de zenon.

Exemple
Lorsqu’un synoptique est ouvert, un événement d’ouverture est déclenché sur
l’objet synoptique correspondant. En tant que programmeur, vous pouvez
ajouter des commandes dans la procédure d’événement (procédure exécutée
lorsque l’événement survient), qui définissent ce qui doit arriver dans ce cas. Un
exemple lors du changement de la valeur d’une variable. Vous pouvez créer un
événement qui réagit au changement de valeurs d’une variable.

4.3.4 Structure d'objet VBA dans zenon


En termes simples, il existe une liste d’objets et des occurrences multiples d’objets dans la structure du
projet.

Exemple :

58 | 154
Liste de macros

Projets – Projet

Variables – Variable

Éléments – Élément

Vous pouvez obtenir davantage d’informations concernant le modèle d’objet :


 Dans l’aide de VBA

 Dans la présentation graphique, dont vous pouvez obtenir l’impression intégrale auprès de
COPA-DATA.

 Dans le navigateur d’objets de VBA

59 | 154
Liste de macros

4.3.5 Comment utiliser les macros VBA


Pour créer une nouvelle macro dans la fenêtre Project info de la page de propriétés Macro Browser,
sélectionnez l’événement auquel la nouvelle macro doit être exécutée.

Cliquez avec le bouton droit de la souris sur cet événement pour ouvrir un menu.

Sélectionnez l’entrée 'Nouvelle macro...' zenon génère alors une procédure :


Public Sub LeftClickUp_Sollwert(obElem As Element)
End Sub

Si une macro existe déjà, elle peut être éditée, supprimée ou renommée en cliquant dessus avec le
bouton droit de la souris.

Attention
Si vous sélectionnez l’élément de menu Renommer la macro, faites attention à
ne pas modifier le nom de l’événement, par exemple LeftClickUp_. Sinon cette
fonction ne sera pas exécutée. De plus, vous devez modifier à la main le nom de
la macro dans l’éditeur VBA.

Après avoir codé le code source à exécuter dans la procédure générée par zenon, la macro doit être
liée à l’élément.

Sélectionnez l’élément dans le synoptique pour afficher ses propriétés.

Dans les propriétés VBA / Événements ..., la macro peut être liée à l’élément graphique.

Dans le Runtime, lorsque l’utilisateur clique avec le bouton gauche de la souris sur l’élément,
l’événement LeftClickDown est exécuté et s’il y a une macro associée, elle est exécutée.

60 | 154
Liste de macros

4.3.5.1 Insérer des macros existantes


Pour insérer des macros existantes dans un autre projet, vous pouvez suivre les instructions suivantes :
1. Dans l’éditeur VBA, exportez tous les 'forms' et 'modules' et importez-les dans l’autre projet.
2. Les macros en fonction des événements, dans ModuleElement.bas, ne sont pas, pour le
moment, affichées dans l’explorateur de macros. Donc ces macros doivent être créées dans
l’explorateur de macros.
Le moyen le plus facile est d’utiliser le nom de la macro existante.
Par exemple :
LeftClickUp_ DateSet2
LeftClickUp_ DateSet4
LeftClickUp_ TimeSet
Draw_ Date2
Draw_ Date4
Draw_ Time
3. Lors de la création de macros, zenon génère des procédures avec le même nom que les
macros existantes. Vous devez détruire ces macros générées.
4. Connectez les macros à un élément dynamique comme vous le faites habituellement.

4.3.6 Comment insérer un élément ActiveX dans zenon ?


Un élément ActiveX est dessiné dans le synoptique comme tous les autres éléments dynamiques ; une
boîte de dialogue s’ouvre, dans laquelle vous sélectionnez le contrôle ActiveX que vous désirez utiliser.

61 | 154
Liste de macros

 Après avoir sélectionné l’élément dans la liste, vous pouvez lui associer des variables. Pour cela,
cliquez sur le bouton Variable et sélectionnez une variable ou créez-en une nouvelle.
 Dans l’étape suivante, nous donnons un nom d’objet à l’élément ActiveX pour pouvoir y
accéder en VBA.
 Dans notre exemple, nous lui donnons le nom d’objet Slide6_DW18, car c’est un ActiveX de
type Slider lié à la variable Doubleword18.
 Maintenant l’élément Slider doit être activé et édité dans l’éditeur VBA.
 Pour cela, nous créons une nouvelle macro, comme indiqué au chapitre Comment utiliser les
macros VBA (à la page 60).

La macro Init_Slider passe l’élément à initialiser au sous-programme Init_Slider de l’objet thisProject qui
contient les données du projet courant.
Public SubInit_Slider(obElem AsElement)
thisProject. Init _ Slider obElem
End Sub

Comme pour la macro Init_Slider, la macro Draw_Slider passe l’élément au sous-programme


Draw_Slider de thisProject.
Public Sub Draw_SliderValue (obElem As Element, ByVal hdc As OLE _ HANDLE )
thisProject.Draw_Slider obElem
obElem.Draw hdc
End Sub

Le code suivant est ajouté dans la partie thisProject.


Public Declarations
Public WithEvents obSlider As Slider
Public obSliderPV As Variable
Public Sub Init_Slider (obElem As Element)
Set obSlider = obElem.ActiveX
'ActiveX existe
If obSlider Is Nothing Then
Exit Sub
End If
Set obSliderPV = obElem . ItemVariable(0)
'La variable existe
If obSliderPV Is Nothing Then
Exit Sub
End If
obSlider.Max = obSliderPV.RangeMax
obSlider.Min = obSliderPV.RangeMin
obSlider.TickFrequency = 1000
obSlider.LargeChange = 25
obSlider.SmallChange = 1
obSlider.Value = obSliderPV.Value
End Sub

Public Sub Draw _ Slider ( obElem As Element )


Dim vVar As Variant
Dim obDynPic As DynPicture

62 | 154
Liste de macros

Set obSliderPV = obElem.ItemVariable ( 0 )


Set obDynPic = thisProject.DynPictures. Item (BILD_1)
'variable exists
If obSliderPV Is Nothing Then
Exit Sub
End If

4.3.7 Accès depuis un programme externe


Pour accéder aux données de zenon depuis un programme externe, par exemple, un programme en
Visual Basic, l’interface COM est utilisée. L’interface COM est aussi utilisée par VBA. Donc il n’y a que
quelques petites différences auxquelles il faut faire attention.

4.3.7.1 Visual Basic 6


De façon à pouvoir accéder à l’interface COM, vous devez implémenter :

Avec ce type de librairie, vous pouvez accéder aux objets de l’application dans zenon (le Runtime).

Comme dans ce cas, il n’y pas d’objet thisProject, il doit être créé pour pouvoir accéder aux données.
Dim obProject As zenon.Project
Set obProject = zenon.Application.Projects.Item(PROJEKTNAME)

Si le projet VB doit être compatible avec tous les projets zenon (indépendamment du nom du projet), il
peut être défini comme suit :
Set obProject = zenon.Application.Projects.Item(0)

Après la création de l’objet projet (thisProject), vous pouvez par exemple accéder aux variables en
lecture ou en écriture.

Lecture :
Value = obProject.Variables.Item(Variablenname).Value

Écriture :

63 | 154
Liste de macros

obProject.Variables.Item(Variablenname).Value = Value

4.3.8 Fonctionnalité des variables en ligne


Vous pouvez imaginer les variables en ligne de VBA : OnlineVariable comme un container qui peut
contenir les variables du système de contrôle (elles doivent être ajoutées dans le container). Si la valeur
d’une des variables du container change, un événement est déclenché.

4.3.8.1 Fonctionnalité de l’événement


Si le conteneur est activé (Container.Define), toutes les variables du conteneur sont forcées une fois, de
façon à ce que la valeur courante des variables soit connue. La procédure Container_VariableChange
est donc exécutée pour chaque variable du container. Dès que toutes les variables ont été initialisées,
cet événement survient toujours si une des variables du container a sa valeur qui change.

On évite qu’une valeur soit lue si ce n’est pas sa valeur courante.

4.3.8.2 Définir et créer un conteneur


Définition :
Public WithEvents Container As OnlineVariable

Avec cette ligne de code, le container est défini.

Créer :
Set Container = thisProject . OnlineVariables. CreateOnlineVariables (nom du conteneur)

4.3.8.3 Placer des variables dans le conteneur


Container . Add Variablenname1
Container . Add Variablenname2
Container . Add Variablenname3
Container . Add Variablenname4
...

Répéter cette ligne pour toutes les variables à ajouter au container.

4.3.8.4 Créer un événement


Private Sub Container_VariableChange(ByVal obVar As zenon.IVariable)
...
End Sub

Cet événement est créé automatiquement, lorsque le container est sélectionné dans la liste de gauche
en haut de l’éditeur VBA (liste des objets). La procédure ci-dessus est alors ajoutée au code source.

64 | 154
Liste de macros

obVar permet de transmettre la variable dont la valeur a changé. Lorsque cet événement survient, la
valeur actuelle de la variable (obVar.Value) peut être lue. Référez-vous à la documentation sur la
hiérarchie des objets VBA pour voir les propriétés et les valeurs qui peuvent être utilisées sur les
variables.

4.3.8.5 Activer un événement


Container.Define

Cette ligne active la surveillance des variables dans le container. Lorsque vous exécutez la commande
Define, le conteneur est actif.

4.3.8.6 Désactiver l’événement


Container.Undefine

Cette commande permet de désactiver la surveillance dans le conteneur. L’événement (VariableChange)


n’est plus exécuté.

4.3.8.7 Suppression lors de la fermeture


De façon à ne pas laisser des éléments en mémoire lors de la fermeture du Runtime, le container doit
être supprimé juste avant la fermeture du Runtime.
thisProject. OnlineVariables. DeleteOnlineVariables (nom du conteneur)

Tant que ce conteneur n’a pas été supprimé, il est impossible de créer un conteneur portant le même
nom.

4.3.9 List of status bits


Bit Short term Long name zenon Logic long name
number

0 M1 User status 1; for Command _VSB_ST_M1


Processing: Action type "Block";
Service Tracking
(Main.chm::/IEC850.chm::/11728
1.htm) of the IEC 850 driver

1 M2 User status2 _VSB_ST_M2

2 M3 User status3 _VSB_ST_M3

3 M4 User status4 _VSB_ST_M4

65 | 154
Liste de macros

Bit Short term Long name zenon Logic long name


number

4 M5 User status5 _VSB_ST_M5

5 M6 User status6 _VSB_ST_M6

6 M7 User status7 _VSB_ST_M7

7 M8 User status8 _VSB_ST_M8

8 NET_SEL Select in the network _VSB_SELEC

9 REVISION Revision _VSB_REV

10 PROGRESS In operation _VSB_DIREC

11 TIMEOUT Command "Timeout exceeded" _VSB_RTE


(command runtime exceeded)

12 MAN_VAL Manual value _VSB_MVALUE

13 M14 User status14 _VSB_ST_14

14 M15 User status15 _VSB_ST_15

15 M16 User status16 _VSB_ST_16

16 GI General query _VSB_GR

17 SPONT Spontaneous _VSB_SPONT

18 INVALID Invalid _VSB_I_BIT

19 T_STD_E External standard time _VSB_SUWI


(standard time)

Caution: up to version 7.50,


this was the status bit T_CHG_A

20 OFF Switched off _VSB_N_UPD

21 T_EXTERN Real time - external time stamp _VSB_RT_E

22 T_INTERN Internal time stamp _VSB_RT_I

23 N_SORTAB Not sortable _VSB_NSORT

24 FM_TR Error message transformer _VSB_DM_TR


value

25 RM_TR Working message transformer _VSB_RM_TR

66 | 154
Liste de macros

Bit Short term Long name zenon Logic long name


number
value

26 INFO Information for the variable _VSB_INFO

27 ALT_VAL Alternate value _VSB_AVALUE

28 RES28 Reserved for internal use (alarm _VSB_RES28


flashing)

29 N_UPDATE Not updated (zenon network) _VSB_ACTUAL

30 T_STD Internal standard time _VSB_WINTER

31 RES31 Reserved for internal use (alarm _VSB_RES31


flashing)

32 COT0 Cause of transmission bit 1 _VSB_TCB0

33 COT1 Cause of transmission bit 2 _VSB_TCB1

34 COT2 Cause of transmission bit 3 _VSB_TCB2

35 COT3 Cause of transmission bit 4 _VSB_TCB3

36 COT4 Cause of transmission bit 5 _VSB_TCB4

37 COT5 Cause of transmission bit 6 _VSB_TCB5

38 N_CONF Negative confirmation of _VSB_PN_BIT


command by device (IEC 60870
[P/N])

39 TEST Test bit (IEC870 [T]) _VSB_T_BIT

40 WR_ACK Writing acknowledged _VSB_WR_ACK

41 WR_SUC Writing successful _VSB_WR_SUC

42 NORM Normal status _VSB_NORM

43 N_NORM Deviation normal status _VSB_ABNORM

44 BL_870 IEC 60870 Status: blocked _VSB_BL_BIT

45 SB_870 IEC 60870 Status: substituted _VSB_SP_BIT

46 NT_870 IEC 60870 Status: not topical _VSB_NT_BIT

47 OV_870 IEC 60870 Status: overflow _VSB_OV_BIT

67 | 154
Liste de macros

Bit Short term Long name zenon Logic long name


number

48 SE_870 IEC 60870 Status: select _VSB_SE_BIT

49 T_INVAL External time stamp invalid not defined

50 CB_TRIP Breaker tripping detected not defined

51 CB_TR_I Breaker tripping detection not defined


inactive

52 OR_DRV Value out of the valid range not defined


(IEC 61850)

53 T_UNSYNC ClockNotSynchronized (IEC not defined


61850)

54 PR_NR Not recorded in the Process not defined


Recorder

55 RES55 reserved not defined

56 RES56 reserved not defined

57 RES57 reserved not defined

58 RES58 reserved not defined

59 RES59 reserved not defined

60 RES60 reserved not defined

61 RES61 reserved not defined

62 RES62 reserved not defined

63 RES63 reserved not defined

Information
In formulas all status bits are available. For other use the availability can be
limited.

You can read details on status processing in the Status processing chapter.

68 | 154
Liste de macros

4.3.10 Lasso de sélection d’éléments dynamiques dans le Runtime


Les éléments dynamiques liés à une variable ou une fonction peuvent être présélectionnés à l’aide du
lasso dans le Runtime et être utilisés pour des événements.

Exemple : Avec le lasso, vous pouvez sélectionner des éléments dynamiques dans la barre de
navigation et les insérer dans la courbe Extended Trend en effectuant un glisser-déposer. Faites glisser
les éléments affichés en surbrillance dans la zone du diagramme ETM ou la liste des courbes ETM. Les
courbes correspondantes sont ensuite créées automatiquement pour ces éléments dynamiques.

Remarque : Avec les éléments dynamiques qui comportent plus d'une variable, seule la variable
principale est utilisée pour la fonction glisser-déposer.

Avec la méthode SelElements, l’utilisateur peut identifier les éléments dynamiques sélectionnés tels qu’ils
ont été sélectionnés dans le Runtime. Ces éléments DynPicture.SelElements peuvent ensuite utilisés pour
des événements tels que glisser-déposer.

SÉLECTION AVEC LE LASSO


Les éléments suivants doivent être présents pour pouvoir sélectionner des éléments avec le lasso dans le
Runtime :
 La propriété Sélection multiple en runtime (lasso) doit être activée dans les propriétés du
projet, sous Interaction.
Par défaut : désactivée
 La propriété sélectionnable avec le lasso doit être activée dans les propriétés de l'élément
dynamique, sous Runtime
Par défaut : activée
 La propriété Déplacer le gabarit avec la souris doit être désactivée dans les synoptiques
souhaités, sous Interaction.
Par défaut : désactivée

Plusieurs méthodes de sélection d’éléments sont disponibles dans le Runtime, en fonction des
paramètres de fonctionnement tactile :
 Fonctionnement tactile désactivé ou Windows 7 (propriété Reconnaissance désactivée ou
Windows 7) :
 Clic gauche + déplacement : Une nouvelle sélection est effectuée.
 Clic gauche + touche Ctrl + déplacement : La sélection est étendue.
 Fonctionnement tactile natif de Windows 8 actif (propriété Reconnaissance sous Windows 8) :
 Clic gauche + déplacement : Le synoptique est déplacé.
 Clic gauche + touche Ctrl + déplacement : Le synoptique est déplacé.

69 | 154
Liste de macros

 Clic gauche + touche Maj + déplacement : Une nouvelle sélection est effectuée.
 Clic gauche + touche Ctrl + touche Maj + déplacement : La sélection est étendue.

Règles :
 Seuls les éléments visibles peuvent être sélectionnés.
 Si un bouton est sélectionné et vous cliquez dessus, la fonction correspondante est exécutée.
 Si l'utilisateur clique sur un bouton sélectionné, puis déplace la souris avant de relâcher le
bouton de la souris, la fonction correspondante n'est pas exécutée.
 Annuler la sélection : Cliquez avec le bouton gauche de la souris dans une zone à l'extérieur de
la sélection.

4.4 Macros dans Editor


Les macros peuvent être exécutées à l’aide d’une barre d’outils (à la page 71) configurable dans Editor.
À cette fin, les macros sont liées (à la page 72) avec les boutons de la barre d’outils VBA.

En outre, les macros peuvent être exécutées manuellement à l’aide de l’éditeur VBA.

Grâce aux assistants, les tâches de développement répétitives peuvent être exécutées, ou des projets
entiers peuvent être créés d’un simple clic sur un bouton. Quelques exemples d’assistants sont déjà
fournis dans zenon. Ces assistants peuvent être améliorés et complétés, si nécessaire. Ils sont utiles lors
de la création d’un projet, lors de l’importation et l’exportation, lors de la création de variables, etc. Vous
trouvez plus de détails au chapitre Assistants.

ÉVÉNEMENTS DANS EDITOR


Les événements dans Editor forment partie de l’espace de travail VBA et permettent de réagir à des
événements lors de la programmation de l’espace de travail, par exemple pour des assistants ou lors de
l’utilisation de la fonction de transport distant. Par exemple :
 OnElementCreated
 OnElementDeleted
 OnElementDoubleClicked
 OnObjectCreated
 ...

Vous trouverez des informations concernant tous les événements dans la rubrique d’aide du chapitre
Objet Modèle (à la page 154).

70 | 154
Liste de macros

4.4.1 Barre d’outils Liste des macros


Les macros créées en langage VBA peuvent être gérées via l’élément de barre d’outils Liste de macros.

Si un filtre est sélectionné, cette sélection est également visible dans la barre d’outils.

Symbole Description

Recharger la liste des macros Charge toutes les macros Public Sub Name () incluses dans
VBA/VSTA myWorkspace et les modules dans la liste déroulante de la
barre d’outils.

Rechercher une macro Vous pouvez rechercher des macros par l’intermédiaire d’un
champ de saisie ou d’une liste déroulante. La largeur de la
liste déroulante est déterminée en fonction de l’élément le
plus large.

Liste déroulante Macros Contient toutes les macros chargées et vous permet de les
sélectionner.

Exécuter la macro sélectionnée Exécute la macro sélectionnée dans la liste déroulante.

Exécuter la macro associée n° <x> Exécute la macro associée au symbole.

Associer des macros Ouvre la boîte de dialogue d’association de macros. Jusqu’à


5 macros peuvent être associées aux symboles 1 à 5.

VBA Filtres pour les macros VBA. Seules les macros VBA sont
affichées.

VSTA Filtres pour les macros VSTA. Seules les macros VSTA sont
affichées.

ALL Annule le filtre actuel et affiche toutes les macros.

AZ Trie les macros par ordre croissant, de 0 à 9 et de A à Z.

ZA Trie les macros par ordre décroissant, de Z à A et de 9 à 0.

Options pour la barre d’outils Cliquez sur la flèche pour ouvrir le sous-menu :

Active : la barre d’outils est affichée.

Si la barre d’outils n’est pas affichée, elle peut être activée


en sélectionnant le menu Options -> Barre d’outils.

Remarque : Si la barre d’outils est positionnée librement


(c’est-à-dire dissociée d’Editor), les options ne sont pas

71 | 154
Liste de macros

Symbole Description
affichées. Pour fermer la barre d’outils, cliquez sur le bouton
X.

Information
Si la boîte de dialogue d’association de macros ne contient pas toutes les
macros de myWorkspace, exécutez la fonction Recharger la liste des macros VBA
dans la barre d’outils.

4.4.2 Affectation de macros


Les macros peuvent être invoquées par l’intermédiaire d’un bouton de la barre d’outils. Cinq macros
maximum peuvent être liées de cette manière. Le bouton Attribuer des macros permet d’ouvrir la boîte
de dialogue d’attribution de macros.

Option Description

No. de macro Le numéro de macro correspond au numéro du bouton de la barre


d’outils.

Cliquez sur le bouton ... pour ouvrir la boîte de dialogue de


sélection de macros.

OK Crée des liens avec les boutons et ferme la boîte de dialogue.

Annuler Annule toutes les modifications et ferme la boîte de dialogue.

Aide Ouvre l’aide en ligne.

72 | 154
Liste de macros

4.4.2.1 Sélection de macros pour l'affectation


Paramètre Description

No. de macro Le numéro de macro correspond au numéro du bouton de la barre


d’outils.

Cliquez sur le bouton ... pour ouvrir la boîte de dialogue de sélection


de macros.

OK Crée des liens avec les boutons et ferme la boîte de dialogue.

Annuler Annule toutes les modifications et ferme la boîte de dialogue.

Aide Ouvre l’aide en ligne.

Paramètre Description

Sélection existante Liste des macros pouvant être liées.

Aucune sélection Supprime l’attribution existante pour le bouton.

OK Attribue la macro sélectionnée au bouton.

Annuler Annule toutes les modifications et ferme la boîte


de dialogue.

Aide Ouvre l’aide en ligne.

73 | 154
Liste de macros

4.4.2.2 Sélection de macros pour les éléments


Les éléments de synoptiques peuvent être liés avec les macros VBA. Pour cela, une boîte de dialogue
s'affiche.

Paramètre Description

Liste de macros Liste des macros pouvant être liées.

OK Attribue la macro sélectionnée au bouton.

Annuler Annule toutes les modifications et ferme la boîte de dialogue.

Aide Ouvre l’aide en ligne.

4.5 Fonctions dans zenon


Dans la boîte de dialogue Sélectionner une fonction, vous trouverez les fonctions suivantes sous
l’élément VBA.
Fonction Description

Ouvrir l’éditeur PCE Cette fonction ouvre l’éditeur du module optionnel


Process Control Engine (PCE)

Ouvrir l’éditeur VBA Ouvre l’éditeur VBA.

Exécuter macro VBA Exécute une macro VBA sélectionnée.


Attention : L’événement VBA projet inactif est
exécuté par le script AUTO_END_xxx. Par
conséquent, la fonction Exécuter macro VBA de
zenon n’est plus exécutée dans les scripts, car VBA
n’est pas en cours d’exécution à ce stade.

74 | 154
Liste de macros

Fonction Description

Montrer la boîte de dialogue des macros Ouvre la boîte de dialogue de macros VBA.
VBA

4.5.1 Exécuter macro VBA


Si vous sélectionnez la fonction Exécuter macro VBA, la boîte de dialogue suivante s’affiche.

Les paramètres suivants sont disponibles :


Paramètres : Description

Sélection de Ouvre la boîte de dialogue de sélection des macros (voir également


macros Sélection des macros (à la page 76))

Conseil : Affiche uniquement la liste des macros VBA correspondant au


nombre de paramètres définis dans la fonction Paramètre (voir
ci-dessous).

Paramètres Saisissez la valeur souhaitée (chaîne) pour un paramètre.

Nouveau Cliquez sur ce bouton pour appliquer la valeur au paramètre dans la liste
des paramètres disponibles.

Supprimer Cliquez sur ce bouton pour supprimer l’entrée sélectionnée de la liste des
paramètres disponibles. Vous ne pouvez supprimer qu’une entrée à la
fois.

Vers le haut Cliquez sur ce bouton pour remonter l’entrée sélectionnée d’une place.
Dans l’ordre des paramètres, l’entrée est déplacée d’une place vers
l’avant.

75 | 154
Liste de macros

Paramètres : Description

Vers le bas Cliquez sur ce bouton pour descendre l’entrée sélectionnée d’une place.
Dans l’ordre des paramètres, l’entrée est déplacée d’une place vers
l’arrière.

Il est possible d’ajouter des chaînes aux macros créées avec des paramètres. Ces chaînes sont
transférées sous forme de paramètres individuels dans le Runtime lors de l’exécution de la macro.

Information
Vous devez vous assurer que le nombre de paramètres de la macro liée
correspond au nombre de paramètres créés.

4.5.1.1 Sélectionner la macro


Lorsque vous cliquez sur le bouton ..., la boîte de dialogue suivante s’affiche.

Sélectionnez la macro souhaitée parmi les macros disponibles, puis cliquez sur OK.

4.6 Développement d’assistants dans VBA


Depuis la version 6, il est possible d’automatiser des projets d’ingénierie à l’aide d’assistants. Ainsi, les
tâches récurrentes peuvent être confiées à un assistant qui exécute les actions souhaitées, telles que la
création d’un projet ou la création de cadres et de synoptiques conformément à un standard prédéfini.

Un autre domaine d’application des assistants est l’automatisation des modifications dans les projets
existants, par exemple la modification des propriétés d’éléments dynamiques dans tous les synoptiques
d’un projet existant.

76 | 154
Liste de macros

La base des assistants est le langage Microsoft Visual Basic for Applications (VBA) et le modèle d’objet
de zenon.

À l’heure actuelle, les assistants suivants sont disponibles :


 Project Wizard (Assistant Projet)
 Assistant d’importation
 Assistant Vue globale
 Assistant de recherche de texte VBA
 Assistant de création de mots-clés
 Assistant de traduction de mots-clés
 Assistant de création de variables

Les assistants sont disponibles sous forme de code source VBA sur le support d’installation. Les
nouveaux assistants peuvent être mis en œuvre dans l’environnement VBA.

4.6.1 Utilisation d’un assistant


L’entrée de menu Assistants d’Editor dans le menu Outils permet d’accéder à la sélection des assistants.
Dans cette boîte de dialogue, tous les assistants disponibles sont affichés en fonction de leur catégorie.
Si les assistants ne contiennent pas une catégorie, une entrée Non lié est automatiquement créée. Dans
cette catégorie, tous les assistants non liés sont affichés.

Lorsque l’utilisateur sélectionne un assistant et clique sur le bouton OK, l’assistant sélectionné est
exécuté.

77 | 154
Liste de macros

Information
Les assistants ne sont pas compatibles avec les projets multi-utilisateurs.

4.6.2 Structure d’un assistant


Un assistant est un formulaire UserForm conservé dans le nœud spécifique à l’application du
programme. En règle générale, le formulaire UserForm est constitué d’un élément multi-pages affichant
les différentes étapes de l’assistant.

Le bouton Suivant permet d’afficher la page suivante de l’élément multi-pages. Toutes les entrées
devant être conservées temporairement (par exemple, la création d’objets tels que les cadres, les
synoptiques, etc.) sont déterminées lorsque l’utilisateur clique sur le bouton Terminer de l’assistant.

Information
Les formulaires UserForms utilisés en tant qu’assistant doivent contenir des
méthodes publiques fournissent des informations concernant l’assistant au
système de contrôle. Si ces routines sont manquantes dans un formulaire
UserForm, celui-ci n’est pas considéré comme un assistant.

4.6.3 Intégration dans VBA


Les assistants sont conservés dans un nœud spécifique de l’application, ZWorkspace. Cet objet
représente l’espace de travail actuellement chargé dans Editor, et est uniquement disponible dans
zenon Editor.

Tous les objets dans ce projet VBA peuvent accéder à l’espace de travail actuel par le biais de l’objet
MyWorkspace. Celui-ci est toujours lié au projet actuellement actif, accessible à l’aide de la propriété
ActiveDocument.

Le contenu de l’objet ZWorkspace est conservé dans le fichier ZenWorkspace.vba. Celui-ci est copié
dans le répertoire d’installation lors de la première installation de la version 6. Ce fichier n’est pas
remplacé lors des mises à jour ultérieures. Vous trouverez plus d’informations concernant la mise à jour
des assistants à la fin de ce didacticiel.

78 | 154
Liste de macros

4.6.4 Développement d’un assistant


Ce didacticiel décrit le développement d’un assistant permettant de créer des variables pour un driver
sélectionné.

Démarrez l’environnement VBA depuis zenon Editor, puis accédez au dossier ZWorkspace/Forms. Ce
fichier contient les éléments de base nécessaires au développement d’un assistant. Modifiez le nom du
formulaire UserForm.

Si le dossier indiqué ci-dessus n’est pas disponible, vous pouvez l’importer à l’aide de Importez la
commande Importer fichier.

Information
Le développement d’un assistant nécessite des connaissances concernant le
modèle d’objet de zenon et le langage VBA. Ces rubriques ne sont pas
couvertes dans ce didacticiel.

79 | 154
Liste de macros

Créez la surface affichée ci-dessus. Ensuite, basculez vers le module de codage du formulaire UserForm,
puis faites défiler le fichier jusqu’à la fin. C’est là que vous trouverez les méthodes suivantes.

 Public Function GetWizardName () As String


Renvoie le nom unique de l’assistant. Modifiez le contenu en Assistant de création de variables.
 Public Function GetWizardInfo () As String
Renvoie une brève description dans la sélection d’assistants. Modifiez le contenu en Assistant
de création de variables pour un driver sélectionné.
 Public Function GetWizardCategory () As String
Renvoie la catégorie de l’assistant. Dans la sélection d’assistants, les assistants sont affichés sous
forme d’arborescence des catégories. Modifiez le contenu en Variables.
 Public Function IsZenOnWizard () As Boolean
Affichage de l’assistant dans la sélection d’assistants. Si cette méthode renvoie la valeur False,
l’assistant n’est pas affiché, par exemple parce qu’il n’est pas encore terminé. Modifiez le type
de retour en True.

Ces méthodes fournissent les informations concernant l’assistant demandées par le système de contrôle.
Gardez à l’esprit que l’assistant est uniquement affiché dans la sélection d’assistants si la méthode
IsZenOnWizard renvoie True.

80 | 154
Liste de macros

Basculez vers l’événement Initialize du formulaire UserForm, puis modifiez le contenu de la table de
chaînes m_strCaption. Dans la mesure où cet assistant ne comporte que deux étapes, il est possible de
supprimer les autres attributions.

Ajoutez les définitions suivantes à la partie supérieure du module de code :


Private m_obDriver As Driver
Private m_obVarType As VarType
Private m_nChannelType As Integer

Créez une méthode d’initialisation de la zone de liste modifiable des drivers. Cette routine a pour
objectif d’afficher tous les drivers chargés du projet actuel dans une zone de liste modifiable.
cbDriver.Clear
Dim nIndex As Long
For nIndex = 0 To MyWorkspace.ActiveDocument.Drivers.Count - 1
Dim obDriver As Driver
Set obDriver = MyWorkspace.ActiveDocument.Drivers.Item(nIndex)
If (Not obDriver Is Nothing) Then
cbDriver.AddItem
obDriver.Name
End If
Next nIndex
If (cbDriver.ListCount > 0) Then
cbDriver.ListIndex = 0
End If

En outre, une autre routine doit être définie pour afficher, dans une zone de liste modifiable, tous les
types de variables définis dans le projet.
If (Not m_obDriver Is Nothing) Then
cbVarType.Clear
Dim nIndex As Long , nSelect As Integer
For nIndex = 0 To MyWorkspace.ActiveDocument.VarTypes.Count - 1
Dim obVarType As VarType
Set obVarType = MyWorkspace.ActiveDocument.VarTypes.Item(nIndex)
If ( Not obVarType Is Nothing And obVarType.IsSimple = True) Then
cbVarType.AddItem
obVarType.Name
If (obVarType.Name = INT) Then
nSelect = nIndex
End If
End If
Next nIndex
cbVarType.ListIndex = nSelect
End If

Lors de l’ouverture de l’assistant, toutes les variables existantes sont contrôlées, afin d’identifier un offset
de départ libre pour la création des nouvelles variables. Pour cela, la méthode suivante est appliquée.

81 | 154
Liste de macros

Private Function FindHighestOffsetVar() As Long


On Error GoTo Error
Dim nIndex As Long, nOffset As Long
For nIndex = 0 To MyWorkspace.ActiveDocument.Variables.Count - 1
Dim obVar As Variable
Set obVar = MyWorkspace.ActiveDocument.Variables.Item(nIndex)
If ( Not obVar Is Nothing) Then
If (obVar.Offset > nOffset) Then
nOffset = obVar.Offset
End If
End If
Next nIndex
FindHighestOffsetVar = nOffset
Exit Function
Error : MsgBox
Error occurs: + Err.Description + Source + Err.Source
End Function

Basculez vers l’événement Initialize du formulaire UserForm, puis ajoutez les lignes suivantes à cette
méthode :
txtStart.Value = CStr(FindHighestOffsetVar + 1)
InitializeDriver

L’attribution à txtStart définit l’offset de départ pour la création des variables. La méthode
InitializeDriver renseigne la zone de liste modifiable avec les drivers existants.

Créez un événement Change pour la zone de liste modifiable de drivers et ajoutez-y le code suivant
Une fois le driver sélectionné, les types de variables sont obtenus. L’objet de driver sélectionné est
stocké dans la variable m_obDriver pour être utilisé ultérieurement.
Private Sub cbDriver_Change()
cmdNext.Enabled = True
Set m_obDriver = MyWorkspace.ActiveDocument.Drivers.Item(cbDriver.Value)
If ( Not m_obDriver Is Nothing) Then
InitializeVarType
End If
End Sub

Créez un événement Change pour la zone de liste modifiable de variables et ajoutez-y le code suivant
Le type de variable sélectionné est stocké dans la variable m_obVarType pour être utilisé ultérieurement.
Private Sub cbVarType_Change()
Set m_obVarType = MyWorkspace.ActiveDocument.VarTypes.Item(cbVarType.Value)
End Sub

Il ne reste maintenant plus qu’à créer la routine d’événement de création des variables avec les
paramètres définis. Pour cela, il est nécessaire de cliquer sur le bouton Terminer.

82 | 154
Liste de macros

Private Sub cmdFinish_Click()


On Error GoTo Error
If (cbVarType.ListIndex = -1) Then
MsgBox 'Veuillez sélectionner un type de variable'
cbVarType.SetFocus
Exit Sub
End If
If (txtStart.Value = Or txtCount.Value = Or txtStep.Value = ) Then
MsgBox 'Veuillez saisir l'offset de départ', 'décompte de création de variables et étape'
txtStart.SetFocus
End If
If (m_obVarType Is Nothing) Then
MsgBox 'Type de variable + cbVarType.Name + n'existe pas !'
Exit Sub
End If
Dim nPrvMousePtr As Integer
nPrvMousePtr = MousePointer
MousePointer = fmMousePointerHourGlass
DoEvents
Dim strName As String
Dim nIndex As Long , nVarIndex As Integer
Dim nStartOff As Long , nStep As Integer
nVarIndex = 1
nStartOff = CLng (txtStart.Value)
nStep = CLng (txtStep.Value)
For nIndex = 0 To CLng (txtCount.Value - 1)
Dim obVar As Variable
strName = txtName.Value + _ + CStr (nIndex + 1)
'*** Guaranteeing uniqueness of the variable name
Dim bResult As Boolean
bResult = False
Do
Set obVar = MyWorkspace.ActiveDocument.Variables.Item(strName)
If (obVar Is Nothing) Then
bResult = True
Else
nVarIndex = nVarIndex + 1
strName = txtName.Value + _ + CStr (nVarIndex)
End If
Loop While
bResult = False
'*** Create variable
Set obVar = MyWorkspace.ActiveDocument.Variables.CreateVar (strName, m_obDriver, tpSPSMerker,
m_obVarType)
If ( Not obVar Is Nothing) Then
obVar.Offset = nStartOff
nStartOff = nStartOff + nStep
End If
Next nIndex
MousePointer = nPrvMousePtr
Unload Me
Exit Sub
Error :
MousePointer = nPrvMousePtr
MsgBox Error occurs: + Err.Description + Source + Err.Source
End Sub

À la fin de l’assistant, la validité des paramètres définis est contrôlée. Si ce n’est pas le cas, un message
est affiché et l’utilisateur est invité à corriger les entrées concernées.

83 | 154
Liste de macros

Si les paramètres définis sont valides, les variables sont créées. Les variables reçoivent un nom et un
indice. Si une variable portant le même nom existe déjà dans le projet, l’indice disponible suivant est
utilisé. Dans notre exemple de code, une variable contenant le marqueur d’automate associé au type de
canal est créée. À chaque cycle, l’offset de la variable augmente.

4.6.5 Mise à jour des assistants


Pour mettre à jour les assistants :
1. Dans le menu Extras, sélectionnez l’entrée Mettre à jour les modules d’Editor.
Une boîte de dialogue permettant de mettre à jour les assistants disponibles s’affiche.
2. Sélectionnez les assistants souhaités.
3. Démarrez la mise à jour en cliquant sur Démarrer la mise à jour.

Si un assistant ou une classe existe déjà dans l’espace de travail, un message d’avertissement est affiché.

Attention
Les assistants existants sont remplacés durant la mise à jour. Les modifications
individuelles apportées à un assistant sont perdues.

4.7 Foire aux questions


Ce chapitre fournit des réponses à des questions fréquentes. Vous trouverez d’autres solutions en ligne,
dans le forum des utilisateurs (http://www.copadata.com/forums/) de COPA-DATA.

4.7.1 Pourquoi le bouton reste-t-il enfoncé ?


Si une macro est liée à l’événement LeftClickUp sur un bouton, alors à la fin de la macro il faut exécuter
le LeftClickUp.
Public Sub LeftClickUp_Schalter(obElem As Element)
frmSchalter.Show
obElem.LeftClickUp
End Sub

4.7.2 La macro n’est pas exécutée avec le premier clic


La solution correspond à la réponse fournie à la question : Pourquoi le bouton reste-t-il enfoncé ? (à la
page 84) :

84 | 154
Liste de macros

Si une macro est liée à l’événement LeftClickUp sur un bouton, alors à la fin de la macro il faut exécuter
le LeftClickUp.
Public Sub LeftClickUp_Schalter(obElem As Element)
frmSchalter.Show

obElem.LeftClickUp
End Sub

4.7.3 Les macros ne fonctionnent plus dans le Runtime ?


Cela peut arriver si l’éditeur VBA est ouvert dans le Runtime et que la fonction Stop/Start est
sélectionnée pour arrêter/démarrer VBA Dans ce cas, les objets (OnlineVariables, ScreenObjects, etc.)
deviennent non valides, car ils perdent leur lien dans le cas d’une nouvelle initialisation.

4.7.4 Windows CE et VBA


Dans Editor, VBA peut être utilisé pour les assistants. Il ne peut pas être utilisé dans le Runtime. Pour des
informations détaillées concernant Editor, reportez-vous au chapitre Comment faire un projet CE.

4.8 Exemples
Vous trouverez ici quelques exemples de code VBA :

4.8.1 Initialisation de MouseEvents et du contrôle ActiveX


Option Explicit

Public Sub Init_ActiveX(obElem As Element)


'Initialisation d’ActiveX...
thisProject.Init_MSChart_AX obElem
End Sub

Public Sub LeftClickUp_Sample1(obElem As Element)


'Initialisation du formulaire Userform...
frmSample1.InitForm obElem
'Affichage du formulaire Userform
frmSample1.Show
End Sub

Public Sub LeftClickUp_Sample2(obElem As Element)


'Initialisation du formulaire Userform...

85 | 154
Liste de macros

frmSample2.InitForm obElem
'Affichage du formulaire Userform
frmSample2.Show
End Sub

Public Sub LeftClickUp_Sample3(obElem As Element)


'Initialisation du formulaire Userform...
frmSample3.InitForm obElem
'Affichage du formulaire Userform
frmSample3.Show
End Sub

Public Sub LeftClickUp_Sample4(obElem As Element)


Dim NewForm As New frmSample4
'Initialisation du nouveau formulaire Userform...
NewForm.InitForm obElem
'Affichage du nouveau formulaire Userform
NewForm.Show (0)
End Sub

4.8.2 Afficher les informations d’une variable


Afficher le nom de la variable correspondant à l’élément sur lequel vous avez cliqué :

Option Explicit

Dim obVar As Variable

'Procédure publique d’initialisation d’objets définie par l’utilisateur

Public Sub InitForm(obElem As Element)


'Définit l’objet variable sous forme de variable liée de l’élément
Set obVar = obElem.ItemVariable(0)
'Écrit la variable dans le champ de texte
txtVarName.Text = obVar.Name
End Sub

86 | 154
Liste de macros

Private Sub cmdExit_Click()


'Ferme le formulaire Userform
Unload Me
End Sub

4.8.3 Lire et écrire des valeurs de variable


Lire la valeur de la variable et la réécrire :

Option Explicit

Dim obVar As Variable

'Procédure publique d’initialisation d’objets définie par l’utilisateur

Public Sub InitForm(obElem As Element)


'Définit l’objet variable sous forme de variable liée de l’élément
Set obVar = obElem.ItemVariable(0)
'Écrit la variable dans le champ de texte
txtVarName.Text = obVar.Name
End Sub

Private Sub cmdExit_Click()


'Ferme le formulaire Userform
Unload Me
End Sub

Private Sub cmdRead_Click()


'Lire la valeur de la variable et l’écrire dans le champ de texte :
txtValue.Text = obVar.Value
End Sub

Private Sub cmdWrite_Click()


'Écrire le texte sous forme de valeur dans la variable
obVar.Value = txtValue.Text
'Ou changer le texte en valeur avant l’écriture...

87 | 154
Liste de macros

obVar.Value = Val(txtValue.Text)
End Sub

4.8.4 Lire et écrire des variables et déployer les variables en ligne


Lire les informations de la variable, écrire les valeurs et déployer les variables en ligne :

Option Explicit

Dim obVar As Variable


Dim WithEvents zOnlineVariable As OnlineVariable

'Procédure publique d’initialisation d’objets définie par l’utilisateur

Public Sub InitForm(obElem As Element)


'Définir l’objet variable sous forme de variable liée de l’élément
Set obVar = obElem.ItemVariable(0)
'Écrire la variable dans le champ de texte
txtVarName.Text = obVar.Name
'Créer un conteneur OnlineVariable
Set zOnlineVariable = thisProject.OnlineVariables.CreateOnlineVariables("OLV")
'Ajouter les variables au conteneur (selon le nom de la variable)
zOnlineVariable.Add obVar.Name
End Sub

Private Sub cmdExit_Click()


'Fermer le formulaire Userform
Unload Me
End Sub

Private Sub cmdRead_Click()


'Lire la valeur de la variable et l’écrire dans le champ de texte :
txtValue.Text = obVar.Value
End Sub

88 | 154
Liste de macros

Private Sub cmdWrite_Click()


'Écrire le texte sous forme de valeur dans la variable
obVar.Value = txtValue.Text
'Ou changer le texte en valeur avant l’écriture...
obVar.Value = Val(txtValue.Text)
End Sub

Private Sub cmdOLV_Start_Click()


'Démarrer la variable OnlineVariable - Define
'L’événement VariableChange sera exécuté
zOnlineVariable.Define
End Sub

Private Sub cmdOLV_Stop_Click()


'Arrêter la variable OnlineVariable - UnDefine
'L’événement VariableChange sera arrêté
zOnlineVariable.Undefine
End Sub

Private Sub zOnlineVariable_VariableChange(ByVal obVar As IVariable)


'Écrire la valeur réelle dans le champ de texte
txtOLV.Text = obVar.Value
End Sub

Private Sub UserForm_Terminate()


'L’événement VariableChange sera arrêté s’il est en cours d’exécution
zOnlineVariable.Undefine
'Supprimer le conteneur OnlineVariable
thisProject.OnlineVariables.DeleteOnlineVariables ("OLV")
End Sub

89 | 154
Liste de macros

4.8.5 Utiliser une boîte de dialogue plusieurs fois


Les formulaires Userform peuvent être utilisés à plusieurs reprises.

Option Explicit
Dim obVar As Variable
Dim WithEvents zOnlineVariable As OnlineVariable
Dim strOLVName As String

Public Sub InitForm(obElem As Element)


'Définir l’objet variable sous forme de variable liée de l’élément
Set obVar = obElem.ItemVariable(0)
'Écrire la variable dans le champ de texte
txtVarName.Text = obVar.Name
'Créer le nom du conteneur en ligne
strOLVName = "OLV_" & obElem.Name
'Obtenir le conteneur en ligne existant
Set zOnlineVariable = thisProject.OnlineVariables.Item(strOLVName)
'Vérifier si le conteneur en ligne existe
If zOnlineVariable Is Nothing Then
'Créer un conteneur OnlineVariable
Set zOnlineVariable = thisProject.OnlineVariables.CreateOnlineVariables(strOLVName)
'Ajouter les variables au conteneur (selon le nom de la variable)
zOnlineVariable.Add obVar.Name
End If
End Sub

Private Sub cmdExit_Click()


Unload Me 'close Userform
End Sub

Private Sub cmdRead_Click()


'Lire la valeur de la variable et l’écrire dans le champ de texte :
txtValue.Text = obVar.Value

90 | 154
Liste de macros

End Sub

Private Sub cmdWrite_Click()


'Écrire le texte sous forme de valeur dans la variable
obVar.Value = txtValue.Text
'Ou changer le texte en valeur avant l’écriture...
obVar.Value = Val(txtValue.Text)
End Sub

Private Sub cmdOLV_Start_Click()


'L’événement VariableChange sera exécuté
zOnlineVariable.Define
End Sub

Private Sub cmdOLV_Stop_Click()


'L’événement VariableChange sera arrêté
zOnlineVariable.Undefine
End Sub

Private Sub zOnlineVariable_VariableChange(ByVal obVar As IVariable)


'Écrire la valeur réelle dans le champ de texte
txtOLV.Text = obVar.Value
End Sub

Private Sub UserForm_Terminate()


'L’événement VariableChange sera arrêté s’il est en cours d’exécution
zOnlineVariable.Undefine
'Supprimer le conteneur OnlineVariable
thisProject.OnlineVariables.DeleteOnlineVariables (strOLVName)
End Sub

4.8.6 Alarme – Événements et gestion des contrôles ActiveX


Option Explicit

Dim WithEvents obChart As MSChart


Dim WithEvents zOLV As OnlineVariable

91 | 154
Liste de macros

Dim WithEvents zAlarm As Alarm

'La procédure est exécutée au démarrage du Runtime zenon

Private Sub Project_Active()


'Initialiser l’objet alarme pour les événements
Set zAlarm = thisProject.Alarm
End Sub

'La procédure est exécutée lorsqu’une alarme est activée


Private Sub zAlarm_AlarmComes(ByVal obItem As IAlarmItem)
Dim strInfo As String
'Écrire les informations spécifiques concernant l’alarme dans une variable StringVariable
strInfo = obItem.Text & " - " & obItem.Name
thisProject.Variables.Item("Var_Comes").Value = strInfo
End Sub

'La procédure est exécutée lorsqu’une alarme est désactivée


Private Sub zAlarm_AlarmGoes(ByVal obItem As IAlarmItem)
Dim strInfo As String
'Écrire les informations spécifiques concernant l’alarme dans une variable StringVariable
strInfo = obItem.Text & " - " & obItem.Name
thisProject.Variables.Item("Var_Goes").Value = strInfo
End Sub

'La procédure est exécutée lorsqu’une alarme a été acquittée par un utilisateur
Private Sub zAlarm_AlarmAcknowledged(ByVal obItem As IAlarmItem)
Dim strInfo As String
'Écrire les informations spécifiques concernant l’alarme dans une variable StringVariable
strInfo = obItem.Text & " - " & obItem.Name
thisProject.Variables.Item("Var_Acknowledged").Value = strInfo
End Sub

'La procédure est exécutée lors de l’arrêt du Runtime zenon


Private Sub Project_Inactive()
'Libérer l’objet Alarme
Set zAlarm = Nothing
'Supprimer la variable OnlineVariable pour actualiser la fonction Chart...
thisProject.OnlineVariables.DeleteOnlineVariables "CHART"

92 | 154
Liste de macros

End Sub

'Procédure d’initialisation du contrôle ActiveX MSChart...


Public Sub Init_MSChart_AX(YourAX As Element)
Set obChart = YourAX.AktiveX
obChart.RowCount = 3
obChart.ColumnCount = 1
Set zOLV = thisProject.OnlineVariables.Item("CHART")
'Est-ce que la variable OnlineVariable actuelle existe ?
If zOLV Is Nothing Then
'Si ce n’est pas le cas, la créer...
Set zOLV = thisProject.OnlineVariables.CreateOnlineVariables("CHART")
zOLV.Add "Internal_UINT_001"
zOLV.Add "Internal_UINT_002"
zOLV.Add "Internal_UINT_003"
End If
zOLV.Undefine 'En cas d’arrêt, l’actualisation est impossible
'START - début de la surveillance des variables...
zOLV.Define
End Sub

'Événement en cas de modification de la variable - actualisation du diagramme....


Private Sub zOLV_VariableChange(ByVal obVar As IVariable)
'Configuration des valeurs à afficher dans le contrôle du diagramme
Select Case obVar.Name
Case "Internal_UINT_001"
obChart.Row = 1
obChart.RowLabel = "Var1"
obChart.Data = obVar.Value
Case "Internal_UINT_002"
obChart.Row = 2
obChart.RowLabel = "Var2"
obChart.Data = obVar.Value
Case "Internal_UINT_003"
obChart.Row = 3
obChart.RowLabel = "Var3"
obChart.Data = obVar.Value
End Select
End Sub

93 | 154
Liste de macros

'Événement du contrôle ActiveX Chart...


Private Sub obChart_DblClick()
MsgBox "Vous avez double-cliqué sur le contrôle ActiveX !"
End Sub

4.8.7 Accès aux alarmes

DESCRIPTION :

Dans la boîte de dialogue (form) frmAlarm, une alarme en mémoire peut être sélectionnée dans un
combobox. Après la sélection, toutes les données de l’alarme sont écrites dans les champs texte
ci-dessous (groupe, classe, variable, etc.).

On utilise une macro indépendante des événements pour afficher le frmAlarm, car on ne la lie pas à un
élément.
Sub Alarm ()
frmAlarm.Show
End Sub
'La macro est exécutée avec la fonction Exécuter macro.
'À l’ouverture, la boîte de dialogue (form) est initialisée et donc la procédure suivante est
exécutée.Cette procédure s’occupe d’écrire toutes les alarmes en mémoire dans le combobox (liste de
choix) dans la boîte de dialogue (form).

Private Sub UserForm _ Initialize ()

'fill combobox with all AlarmItems


Dim i As Integer
Dim obAlarmItems As AlarmItems
Dim obAlarm As Alarm

Set obAlarm = thisProject.Alarm


Set obAlarmItems = obAlarm.AlarmItems (*)

If obAlarmItems.Count = 0 Then
MsgBox (# Alarms = 0 )

94 | 154
Liste de macros

Exit Sub
End If

For i = 0 To obAlarmItems.Count - 1
cmbAlarmItems.AddItem obAlarmItems.Item ( i ). Name
Next i

txtAktiv.Text = obAlarm.Aktiv
cmbAlarmItems.Text = cmbAlarmItems.List ( 0 )
End Sub

'Lorsqu’une alarme est sélectionnée dans la zone de liste, l’événement Modifier de la zone de liste
réagit.
Private Sub cmbAlarmItems _ Change ()

'Insérer les propriétés actuelles de l’élément AlarmItem dans des zones de texte
Dim obAlarmItems As AlarmItems
Dim obAlar As Alarm

Set obAlarm = thisProject.Alarm


Set obAlarmItems = obAlarm.AlarmItems (*)
txtComputer.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Computer
txtCountreactivated.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Countreactivated
txtName.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ). Name
txtProjectname.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Projectname
txtStatus.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Status
txtStatusreactivated.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Statusreactivated
txtTagname.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Tagname
txtTimecomes.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Timecomes
txtTimegoes.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Timegoes
txtTimequitted.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Timequitted
txtTimereactivated.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Timereactivated
txtUser.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).User
txtUsertext.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Usertext
txtValue.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).Value
tbGroup.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).AlarmGroup
tbClass.Text = obAlarmItems.Item ( cmbAlarmItems.ListIndex ).AlarmClass
End Sub

4.8.8 Définition d’un interrupteur (utilisation de variables de procédé)

Dans cet exemple, on dessine une pompe qui est constituée d’un cercle et d’un triangle. Définissez le
triangle en tant que symbole. Par dessus, dessinez une combinaison multiple et liez-la à trois variables
booléennes.

95 | 154
Liste de macros

De plus, définissez la couleur que le triangle doit prendre selon les valeurs de ces variables.

D’abord, nous combinons la combinaison multiple avec une macro qui ouvre un 'form' VBA de nom
frmSwitch.

Dans la boîte de dialogue (le 'form' VBA), nous pouvons modifier les valeurs des trois booléens.

Information
Seule une des trois variables peut avoir la valeur 1. (c’est-à-dire si une des
variables est mise à 1, les deux autres sont mises à 0).

Pour pouvoir utiliser cette macro plusieurs fois dans le projet avec différentes variables, les variables liées
à la combinaison multiple peuvent contenir dans leur nom l’état de la pompe qu’elle contrôle.

Par exemple :
Variable_Auto
Variable_Hand
Variable_Revi

Information
Les suffixes _Auto, _Hand et _Revi sont définis de façon fixe dans le code source
de l’exemple.

Avec les suffixes de 5 caractères des noms de variables, on définit quelle variable est mise à 1 ou à 0 en
cliquant sur un bouton de bascule.

Dans la macro LeftClickUp_Switch un sous-programme FindVariable est appelé dans le 'form' frmSwitch
qui récupère l’élément qui a été sélectionné dans obElem.
Public Sub LeftClickUp_Schalter (obElem As Element)
frmSchalter.FindVariable obElem
position (pixel en points = (pixel * 0,75))
frmSchalter.Top = obElem.Bottom * 0.75
frmSchalter.Left = obElem.Left * 0.75
frmSchalter.Show
obElem.LeftClickUp
End Sub

Déclaration des variables globales :


Dim cmdLast As ToggleButton
Dim strHand As String
Dim strAuto As String

96 | 154
Liste de macros

Dim strRevi As String


Dans le sous-programme FindVariable, toutes les variables liées à l’élément passé sont contrôlées.

Selon le suffixe (_Auto, _Hand or _Revi), les noms des variables sont assignés aux variables string
déclarées ci-dessus.

De plus, les états des variables sont déterminés et dépendent de la valeur (1 ou 0) du bouton
d’activation correspondant (enfoncé ou pas).

Lors de l’ouverture de la boîte de dialogue frmSwitch, le nom du bouton de bascule actuellement


actionné est écrit dans une variable string. Dans le cas où l’utilisateur décide d’annuler cette action, les
valeurs originales sont restaurées.
Public Sub FindVariable (obElem As Element)
Dim i As Integer
Dim obVariable As Variable

For i = 0 To obElem . CountVariable - 1


Select Case Right $( obElem. ItemVariable ( i ). Name , 5 )
Case _ Auto
strAuto = obElem . ItemVariable ( i ). Name

Case _ Hand
strHand = obElem . ItemVariable ( i ). Name

Case _ Revi
strRevi = obElem . ItemVariable ( i ). Name
End Select
Next i

Set obVariable = thisProject . Variables . Item ( strHand )


If obVariable . Value = 1 Then
tbHand . Value = True
Set cmdLast = tbHand
End If

Set obVariable = thisProject . Variables . Item ( strAuto )


If obVariable . Value = 1 Then
tbAuto . Value = True
Set cmdLast = tbAuto
End If

Set obVariable = thisProject . Variables . Item ( strRevi )


If obVariable . Value = 1 Then
tbRev . Value = True
Set cmdLast = tbRev
End If

If tbHand . Value = False And tbAuto . Value = False And tbRev . Value = False Then
tbOff . Value = True
Set cmdLast = tbOff
End If
End Sub

La fonction créée automatiquement VarExists vérifie seulement si les variables liées existent réellement.
Si ce n’est pas le cas, un message d’erreur est affiché. La variable n’existe pas.
Function VarExists ()

Dim obVariable As Variable

97 | 154
VSTA

Set obVariable = thisProject . Variables . Item (strHand)

If obVariable Is Nothing Then


MsgBox (Variable doesnt extist)
VarExists = False
Exit Function
End If

Set obVariable = thisProject . Variables . Item (strAuto)


If obVariable Is Nothing Then
MsgBox (La variable n’existe pas)
VarExists = False
Exit Function
End If

Set obVariable = thisProject . Variables . Item (strRev)


If obVariable Is Nothing Then
MsgBox ( Variable doesnt exist )
VarExitsts = False
Exit Function
End If

VarExists = True
End Function

Si l’utilisateur clique sur Annuler (Cancel), la modification de valeur est annulée et la valeur originale est
restaurée.
Private Sub cmdExit _ Click ()
cmdLast.Value = True
Unload Me
End Sub

Private Sub cmdOk _ Click ()


Unload Me
End Sub

Si un bouton de bascule est cliqué, aucun autre bouton de bascule ne peut être sélectionné.
Private Sub tbAuto_Change ()
If tbAuto. Value = False And tbHand.Value = False And tbRev . Value = False Then
tbOff . Value = True
End Sub

Dans l’événement clic de chaque bouton de bascule, on vérifie si il est enfoncé et si la variable existe. Si
les deux conditions sont vraies, alors les valeurs sont envoyées vers les variables liées.

5 VSTA
Visual Studio Tools for Applications (VSTA) permet d’améliorer de manière autonome les fonctionnalités
de zenon Editor et du Runtime grâce à la programmation dans .NET.

98 | 154
VSTA

Attention
Veuillez noter que dans VSTA, seuls les Assemblies (fichiers DLL) créés dans une
version de .NET Framework jusqu’à la version 3.5 peuvent être inclus.

VSTA est également disponible dans zenon Web Client (avec certaines restrictions).

VSTA comporte des environnements de développement distincts pour l’Espace de travail et le projet.
Vous ne pouvez en utiliser qu’un à la fois. Au démarrage, tous les autres environnements de
développement VSTA ouverts seront fermés.

Pour ouvrir l’éditeur VSTA pour l’espace de travail :


1. Utilisez le raccourci-clavier Alt+F10.
Une boîte de dialogue d'information s'affiche.
Le code correspondant à l’espace de travail et à tous les projets chargés est affiché

Pour ouvrir l’éditeur VSTA pour le projet actuellement chargé :


1. Accédez au nœud Script.
2. Pour développer l’affichage de ce nœud, cliquez sur [+].
La vue du nœud est développée.
3. Cliquez avec le bouton droit sur VSTA.
4. Dans le menu contextuel, sélectionnez Ouvrir l'éditeur VSTA avec ProjectAddin.
Une boîte de dialogue d'information s'affiche.
Cliquez sur le bouton OK pour poursuivre la configuration du projet VSTA.
L'éditeur VSTA démarre pour le projet actuellement chargé.

Information
Si des macros VBA sont modifiées dans Editor,
 Les fichiers de Runtime sont compilés et transférés vers le Runtime
 Le Runtime est actualisé
 Les éléments VSTA sont également actualisés, même si aucune modification
n’a été effectuée dans VSTA

99 | 154
VSTA

BOÎTE DE DIALOGUE D'AVERTISSEMENT

Une boîte de dialogue d'avertissement s'affiche avant l'ouverture de l'éditeur VSTA dans zenon. Cliquez
sur le bouton OK pour ouvrir l'éditeur VSTA.

5.1 Notions fondamentales


VSTA est un environnement de développement Microsoft reposant sur la technologie .NET. Il est
nécessaire de disposer d’une connaissance des principes de la programmation orientée objet, de .NET
et de C#/Visual Basic.NET pour le comprendre.

Attention
Remarque concernant le Runtime : Les fichiers DLL référencés ne peuvent pas
être remplacés s’ils sont chargés. Pour mettre à jour un fichier de référence,
vous devez arrêter le Runtime.

5.1.1 Configuration de l’environnement VSTA


La prise en charge de VSTA est déjà activée par défaut dans zenon. Lors de la désactivation de la prise
en charge de VBA, l’environnement VSTA n’est également plus disponible.

L’environnement VSTA peut être activé ou désactivé manuellement, en insérant l’entrée suivante dans le
fichier zenon6.ini :
Activer VSTA Désactiver VSTA

[VSTA] [VSTA]

ON=1 ON=0

La prise en charge de VBA est activée ou désactivée comme suit :


Activer VBA Désactiver VBA

[VBA] [VBA]

EIN=1 EIN=0

100 | 154
VSTA

L’environnement de développement pour VSTA dans zenon est alors disponible.

Information
VSTA autorise le développement de projets dans les langages de
programmation C# et Visual Basic .NET. C# est considéré comme le langage
standard des projets VSTA dans Editor Le langage peut être changé en Visual
Basic.NET avec l’entrée suivante :

[VSTA]

CSHARP=0

5.1.2 Accès au modèle d'objet zenon


Le modèle d’objet zenon utilisé dans VBA est également accessible dans VSTA. Le modèle d’objet offre
des fonctionnalités identiques dans les deux environnements de développement.

Attention
Certaines modifications apportées au modèle d’objet ont été réalisées en raison
des limites inhérentes à la dénomination d’objets VSTA. Vous les trouverez dans
le tableau ci-dessous.

Ancienne propriété Nouvelle propriété

IDriver.Name IDriver.Identification

IDriver.Driver IDriver.Name
Ancien événement Nouvel événement

IApplication.Close IApplication.OnClose

IZenWorkspace.Startup IZenWorkspace.OnStartup

IZenWorkspace.Exit IZenWorkspace.OnExit

L’accès dans VSTA est autorisé via l’objet this, qui remplace l’objet MyWorkspace dans VBA. Les
méthodes et objets suivants sont identiques. Dans la méthode suivante, un gabarit portant le nom
TemplateName est créé dans zenon.
public void Macro1()
{
this.ActiveDocument.Templates().Create("TemplateName", true);

101 | 154
VSTA

Information
Contrairement à VBA, l’utilisation des lettres majuscules et minuscules après les
noms de fonctions est importante dans VSTA.

Pour accéder aux méthodes dans zenon, vous devez enregistrer et compiler le projet en procédant
comme suit :
1. Cliquez sur Fichier -> Enregistrer MyWorkspace.cs pour enregistrer le projet.
2. Cliquez sur Fichier -> Construire WorkspaceAddin pour compiler le projet.

La méthode est ensuite disponible en tant que macro dans la barre d’outils Macro VBA de zenon Editor.
Si la boîte de dialogue d’affectation des macros n’affiche pas toutes les macros de MyWorkspace,
exécutez la fonction Recharger la liste des macros VBA depuis la barre d’outils.

Information
Les macros VSTA comportant des paramètres, par exemple Public void
MacroWithParam(string mString), ne sont pas prises en charge et ne sont pas
disponibles dans la barre d’outils de macros.

102 | 154
VSTA

5.1.3 Fonctions dans zenon


Pour VSTA, de fonctions ont été créées dans zenon. Elles sont incluses dans le nœud VSTA.

Parallèlement aux fonctions VBA existantes, des fonctions semblables ont été mises en œuvre pour
VSTA :
Nom fonction Description

Ouvrir l’éditeur VSTA Ouvre l’éditeur VSTA dans le Runtime.

Exécuter une VSTA Une macro VSTA peut être sélectionnée dans Editor ;
elle sera démarrée lors de l’exécution de la fonction
dans le Runtime.

Remarque : Les macros VSTA comportant des


paramètres, par exemple Public void
MacroWithParam(string mString), ne sont pas prises en
charge. Elles ne sont pas non plus disponibles aux fins
du développement dans Editor, ni au démarrage de la
fonction dans le Runtime.

Afficher la boîte de dialogue des Une boîte de dialogue est affichée dans le Runtime ; elle
macros VSTA contient une liste des macros VSTA existantes, que vous

103 | 154
VSTA

Nom fonction Description


pouvez sélectionner et exécuter à votre convenance.

5.1.3.1 Exécuter macro VSTA


Boîte de dialogue de configuration de la fonction Exécuter macro VSTA.

Paramètres : Description

Macros existantes

Liste des macros VSTA Affiche la liste de toutes les macros VSTA existantes.
Pour sélectionner une macro dans la liste, cliquez dessus.

Remarque : Un double-clic permet d’exécuter la macro


sélectionnée.

Aucun utilisateur sélectionné Annule la sélection et ferme la boîte de dialogue.

OK Exécute la macro sélectionnée et ferme la boîte de dialogue.

Annuler Annule la sélection et ferme la boîte de dialogue.

Aide Opens online help.

104 | 154
VSTA

5.1.4 Débogage d’une macro complémentaire VSTA


Il est possible de déboguer les macros complémentaires que vous avez créées dans l’éditeur VSTA. À
cette fin, notez que les macros complémentaires du projet peuvent uniquement être déboguées dans le
Runtime zenon, et que les macros complémentaires de l’espace de travail peuvent uniquement être
déboguées dans zenon Editor.

Pour démarrer une session de débogage, sélectionnez Débogage -> Démarrer le débogage. Vous
pouvez insérer des points d’interruption de la même manière que dans l’éditeur VBA, en cliquant avec
le bouton gauche dans la barre d’outils de points d’interruption grise, près de la marge gauche
adjacente à la cellule correspondante.

Information
Lors du débogage de macros complémentaires du Runtime, tenez compte des
aspects suivants :

Les fichiers de Runtime modifiés dans zenon doivent être recréés avant le
débogage.

5.1.5 Événements dans VSTA


Une macro complémentaire se termine lors de la compilation d’un code modifié et du démarrage ou de
l’arrêt d’une session de débogage ; aussi, de nouveaux événements ont été mis en œuvre dans VSTA. Ils
permettent par exemple d’évaluer et d’approuver la référence d’un objet, ainsi que d’enregistrer les
données existantes.

Deux événements sont associés à chaque fin. Le premier événement démarre peu de temps avant la fin,
et le deuxième démarre après le démarrage d’une nouvelle session d’une macro complémentaire.
Événement Description

OnPreVSTADebugStart est déclenchée peu de temps avant le démarrage


d’une session de débogage. Lors du démarrage
d’une session de débogage, une macro
complémentaire active est supprimée ; les
références doivent être approuvées et les données
existantes doivent être enregistrées, le cas échéant.

OnVSTADebugStart est déclenchée peu de temps après le démarrage


d’une session de débogage.

OnPreVSTADebugStop est déclenchée peu de temps avant l’arrêt d’une


session de débogage. Lors de l’arrêt d’une session
de débogage, une macro complémentaire active

105 | 154
VSTA

Événement Description
est supprimée ; les références doivent être
approuvées et les données existantes doivent être
enregistrées, le cas échéant.

OnVSTADebugStopped est déclenchée peu de temps après l’arrêt d’une


session de débogage.

OnPreVSTAUpdate est déclenchée avant la suppression de la macro


complémentaire, si une nouvelle version de la
macro complémentaire a été créée avec succès.

OnPostVSTAUpdate est déclenchée lorsqu’une nouvelle version de la


macro complémentaire est chargée.

5.1.6 Créer une sauvegarde de projets VSTA


Les projets VSTA dans le Runtime sont automatiquement enregistrés sous forme d'archive zip lors de la
création du fichier Runtime, puis intégrés aux enregistrements de l'espace de travail.

En revanche, les projets VSTA dans Editor doivent être enregistrés manuellement.
Les projets de l’éditeur VSTA se trouvent dans le dossier
C:\ProgramData\COPA-DATA\*version*\VSTAWorkspace\.

5.2 Créer un projet VSTA


À l’instar de VBA, VSTA offre la possibilité de créer des projets (améliorations) pour Editor et le Runtime.
En principe, les projets dans Editor sont mis en œuvre dans le langage de programmation C#. Pour le
Runtime et Editor, C# et Visual Basic.NET sont tous deux disponibles.

Attention
Veuillez noter que dans VSTA, seuls les Assemblies (fichiers DLL) créés dans une
version de .NET Framework jusqu’à la version 3.5 peuvent être inclus.

Information
Un seul projet peut être affiché à la fois dans l’éditeur VSTA. En outre, une seule
instance de l’éditeur VSTA peut être active. Lors du démarrage de l’éditeur
VSTA, toute instance en cours d’exécution est fermée.

106 | 154
VSTA

5.2.1 Projets VSTA dans Editor


Lors de la création d’un projet pour zenon Editor, une macro complémentaire VSTA pour l’espace de
travail est chargée. Pour modifier la macro complémentaire, vous devez ouvrir l’éditeur VSTA en
cliquant sur Fichier - Ouvrir l'éditeur VSTA.... L’interface utilisateur de l’éditeur VSTA est identique à
l’environnement de développement Visual Studio de Microsoft.

Information
Vous pouvez accéder à l’aide de l’éditeur VSTA en sélectionnant le menu Aide
-> Contenu. Cette aide fournit un aperçu général des fonctions de l’éditeur, des
fonctions de l’infrastructure .NET Framework et de la programmation en Visual
Basic.NET et C#.

Le module VSTA est essentiellement constitué de la classe MyWorkspace.Vous pouvez maintenant


étendre cette classe avec vos propres méthodes. Par défaut, la classe accepte les deux méthodes
suivantes :
Fonction Description
MyWorkspace_Startup
Exécutée automatiquement au démarrage de
zenon, après la création d’une version et au
démarrage d’une session de débogage.
MyWorkspace_Shutdown
Exécutée automatiquement au démarrage de
zenon, après la création d’une version et au
démarrage d’une session de débogage.

Attention
Les noms de méthodes peuvent uniquement commencer par Macro (par
exemple Macro1, MacroVSTA) ; ils ne doivent pas contenir de paramètres et
doivent être définis comme publics. En outre, les noms de classes et d’autres
méthodes et événements créés par VSTA ne peuvent pas être modifiés.

Pour accéder aux méthodes dans zenon, vous devez enregistrer et compiler le projet en procédant
comme suit :
1. Cliquez sur Fichier -> Enregistrer MyWorkspace.cs pour enregistrer le projet.
2. Cliquez sur Fichier -> Construire WorkspaceAddin pour compiler le projet.

La méthode est ensuite disponible en tant que macro dans la barre d’outils Macro VBA de zenon Editor.
Si la boîte de dialogue d’affectation des macros n’affiche pas toutes les macros de MyWorkspace,
exécutez la fonction Recharger la liste des macros VBA depuis la barre d’outils.

107 | 154
VSTA

5.2.2 Projets VSTA dans le Runtime


Pour créer un projet VSTA pour le Runtime, l’environnement VSTA doit être démarré.
Procédez comme suit :
1. Ouvrez le nœud Interface de programmation dans le gestionnaire de projets.
2. Ouvrez le menu contextuel VSTA.
3. Cliquez sur Ouvrir l’éditeur VSTA...
Remarque : Une boîte de dialogue de sélection est affichée lorsqu’il est ouvert la première fois.
Dans celle-ci, sélectionnez le langage de programmation souhaité.
Un projet est ensuite créé dans le langage de programmation sélectionné.

Information
Le langage de programmation ne peut pas être modifié par la suite. Cette boîte
de dialogue n’est donc affichée que lors de la première ouverture du nœud.

Dans ce projet, une classe appelée ThisProject est créée par zenon ; elle accepte les deux méthodes
suivantes :
Fonction Description
ThisProject_Startup
Exécutée automatiquement au démarrage du
Runtime.
ThisProject_Shutdown
Exécutée automatiquement à l’arrêt du Runtime.

Vous pouvez maintenant étendre la classe avec vos propres méthodes.

Attention
Les noms de méthodes peuvent uniquement commencer par Macro (par
exemple Macro1, MacroVSTA) ; ils ne doivent pas contenir de paramètres et
doivent être définis comme publics. En outre, les noms de classes et d’autres
méthodes et événements créés par VSTA ne peuvent pas être modifiés.

Il est possible d’accéder à toutes les fonctionnalités du Runtime via le modèle d’objet zenon. Les
fonctions spécifiques à Editor ne peuvent pas être utilisées comme dans VBA.

Le Runtime zenon démarre automatiquement au démarrage du programme de débogage. Vous


trouverez d’autres informations au chapitre relatif audébogage d’une macro complémentaire VSTA (à la
page 105).

108 | 154
VSTA

Information
Vous pouvez accéder à l’aide de l’éditeur VSTA en sélectionnant le menu Aide
-> Contenu. Cette aide fournit un aperçu général des fonctions de l’éditeur, des
fonctions de l’infrastructure .NET Framework et de la programmation en Visual
Basic.NET et C#.

5.2.3 Développement d’assistants dans VSTA


L’environnement VSTA, à l’image de VBA (à la page 76), offre la possibilité de développer vos propres
assistants.

Pour pouvoir accéder à un formulaire dans le modèle d’objet zenon, vous devez copier une référence à
celui-ci dans le formulaire. Pour cela, créez une méthode dans la classe MyWorkspace. Dans l’exemple
suivant, une instance de formulaire est créée avec le nom Wizard (Assistant) et la méthode
ZenonInstance, avec une référence au modèle d’objet zenon invoquée en tant que paramètre. Pour
afficher le formulaire Wizard, sélectionnez ShowDialog().
public void Macro1()
{
Form1 Wizard = new Form1();
Wizard.ZenonInstance(this.Application);
Wizard.ShowDialog();
}

Une variable membre reconnaissant le modèle d’objet zenon doit être créée dans le code du formulaire.
public zenOn.IApplication m_Zenon=null;

Enfin, la méthode ZenonInstance est créée. Cette méthode insère la référence du modèle d’objet dans
l’objet m_Zenon.
public void ZenonInstance(zenOn.IApplication app)
{
m_Zenon = app;
}

Vous pouvez maintenant développer, dans le formulaire, vos propres classes et méthodes employant le
modèle d’objet. Tous les objets, méthodes et attributs sont accessibles via l’objet m_Zenon.

5.3 Exemples
Ici, vous trouverez des exemples de l’utilisation de VSTA, dans le Runtime et dans Editor.

109 | 154
VSTA

5.3.1 Création de variables dans zenon Editor


Dans cet exemple, un fichier texte est ouvert et le contenu de ce fichier est utilisé pour créer les variables
dans zenon Editor. Le fichier texte peut contenir autant de lignes que vous le souhaitez. Chaque ligne
inclut le nom et le type de données d’une variable ; ces informations sont séparées par une virgule
(exemple : Variable1,BOOL).

La méthode Macro1 recherche d’abord le driver interne dans zenon Editor. L’utilisateur voit ensuite
s’afficher une boîte de dialogue de sélection de fichier, dans laquelle il doit sélectionner le fichier texte.
La méthode lit ensuite le fichier texte et crée les variables. La méthode GetDataType est ensuite requise
pour déterminer et attribuer le type de données associé lors de la création des variables.
C# code
using System;
using System.Windows.Forms;
using System.IO;
using zenOn;

namespace WorkspaceAddin
{
[System.AddIn.AddIn("MyWorkspace", Version = "1.0", Publisher = "", Description = "")]
public partial class MyWorkspace
{
private void MyWorkspace_Startup(object sender, EventArgs e)
{
}
private void MyWorkspace_Shutdown(object sender, EventArgs e)
{
}
public IVarType GetDataType(string vType)
{
//obtient les types correspondants pour les variables bool, int, real et string
IVarType retType;
switch (vType)
{
case "BOOL":
retType = this.ActiveDocument.VarTypes().Item("BOOL");
break;
case "INT":
retType = this.ActiveDocument.VarTypes().Item("INT");
break;

110 | 154
VSTA

C# code
case "REAL":
retType = this.ActiveDocument.VarTypes().Item("REAL");
break;
case "STRING":
retType = this.ActiveDocument.VarTypes().Item("STRING");
break;
par défaut :
retType = this.ActiveDocument.VarTypes().Item("INT");
break;
}
return retType;
}

//Lit un fichier texte défini et crée les variables correspondantes sur le driver interne de
zenon
public void MacroCreateVariablesFromFile()
{

//crée des objets qui prendront le driver interne et le type de variable


IDriver zenonInternDriver = null;
//Rechercher le driver interne et lancer l’exception si aucun pilote n’a été trouvé
try
{
for (int driverCount = 0; driverCount < this.ActiveDocument.Drivers().Count; driverCount+
+)
{
if (this.ActiveDocument.Drivers().Item(driverCount).Name == "Intern")
{
zenonInternDriver = this.ActiveDocument.Drivers().Item(driverCount);
break;
}
}
}
catch (Exception driverEx)
{
MessageBox.Show("Impossible de trouver le driver zenon
'Intern'.Erreur : " + driverEx.Message);
throw;
}

111 | 154
VSTA

C# code
this.ActiveDocument.Variables().DoAutoSave(false);
try
{
OpenFileDialog varFileSelect = new OpenFileDialog();
String[] varLine = new String[2];

//afficher la boîte de dialogue de sélection de fichiers


if (varFileSelect.ShowDialog() == DialogResult.OK)
{
string line = string.Empty;
//ouvrir le nouveau lecteur de flux avec le fichier sélectionné
StreamReader importReader = new StreamReader(varFileSelect.FileName, System.Text.Encoding
.Default);

//acquérir les données ligne par ligne, scinder les lignes à chaque ',' et créer les variables
while ((line = importReader.ReadLine()) != null)
{
varLine = line.Split(new Char[] { ',' });
this.ActiveDocument.Variables().CreateVar(varLine[0], zenonInternDriver, tpKanaltypes.tpS
ystemVariable, GetDataType(varLine[1]));
}
importReader.Close();
}
}
catch (Exception fileEx)
{
MessageBox.Show("An error occurred while opening the file: " + fileEx.Message);
throw;
}
this.ActiveDocument.Variables().DoAutoSave(true);
}
#region Code généré par VSTA
private void InternalStartup()
{
this.Startup += new System.EventHandler(MyWorkspace_Startup);
this.Shutdown += new System.EventHandler(MyWorkspace_Shutdown);
}
#endregion

112 | 154
VSTA

C# code
}
}

5.3.2 Écriture des informations du projet dans la fenêtre de sortie zenon.


Dans cet exemple, nous allons démontrer comment accéder à la fenêtre de sortie de zenon Editor à
l’aide de VSTA. La méthode nommée Macro1 lit les synoptiques de procédé créés dans le projet à cette
fin, identifie le gabarit concerné et tous les drivers disponibles, ainsi que leurs intitulés.
C# code
using System;

namespace WorkspaceAddin
{
[System.AddIn.AddIn("MyWorkspace", Version = "1.0", Publisher = "", Description = "")]
public partial class MyWorkspace
{
private void MyWorkspace_Startup(object sender, EventArgs e)
{

private void MyWorkspace_Shutdown(object sender, EventArgs e)


{

public void MacroPrintDebugInformation()


{
string picName = string.Empty;
string corTemp = string.Empty;
string driverName = string.Empty;
string driverDescription = string.Empty;

//imprimer la chaîne de démarrage dans la fenêtre de sortie

this.Application.DebugPrint(" --------------START--------------", zenOn.tpDebugPrintStyle

113 | 154
VSTA

C# code
.tpMsg);

//parcourir tous les synoptiques et imprimer le nom et le modèle utilisé dans la fenêtre de
sortie

for (int i = 0; i < this.ActiveDocument.DynPictures().Count; i++)


{
picName = this.ActiveDocument.DynPictures().Item(i).Name;
corTemp = this.ActiveDocument.DynPictures().Item(i).get_DynProperties("Template").ToStrin
g();
this.Application.DebugPrint("' Picture '" + picName + "' uses Template '" + corTemp + "'"
, zenOn.tpDebugPrintStyle.tpMsg);
}

//imprimer la chaîne de caractères de séparation dans la fenêtre de résultats

this.Application.DebugPrint(" ------------------------------", zenOn.tpDebugPrintStyle.tp


Msg);

//parcourir tous les drivers et imprimer le nom et la description dans la fenêtre de sortie

for (int i = 0; i < this.ActiveDocument.Drivers().Count; i++)


{
driverName = this.ActiveDocument.Drivers().Item(i).Name;
driverDescription = this.ActiveDocument.Drivers().Item(i).Identification;
this.Application.DebugPrint("' Driver '" + driverName + "' has description '" + driverDes
cription + "'", zenOn.tpDebugPrintStyle.tpMsg);
}
//imprimer la chaîne de fin dans la fenêtre de sortie
this.Application.DebugPrint(" ---------------END---------------", zenOn.tpDebugPrintStyle
.tpMsg);
}

#region Code généré par VSTA

private void InternalStartup()


{
this.Startup += new System.EventHandler(MyWorkspace_Startup);
this.Shutdown += new System.EventHandler(MyWorkspace_Shutdown);
}

114 | 154
VSTA

C# code
#endregion
}
}

5.3.3 Acquisition des variables dans zenon par le biais d’expressions


régulières
Dans l’exemple suivant, les variables de zenon sont lues dans un projet de Runtime et enregistrées dans
un fichier texte local.

Avec les expressions régulières, les variables sont uniquement lues si leurs noms commencent par 3
chiffres suivis d’un tiret bas (par exemple, 001_var ou 234_xyz). L’utilisateur doit alors sélectionner un
dossier. Un fichier texte comportant un nom défini en fonction de l’heure est créé dans ce dossier. Dans
ce fichier, les noms, intitulés et valeur actuelle de doutes les variables concernées sont enregistrés,
séparés par un point-virgule.

Information
Il est possible que des références manuelles doivent être ajoutées pour exécuter
l’exemple dans le Runtime zenon Runtime. Pour cela, ouvrez le menu contextuel
dans l’Project Explorer, puis cliquez sur Add Reference...
Les références requises dans cet exemple sont les suivantes :
 Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0
 System
 System.AddIn
 System.Data
 System.Windows.Forms
 System.Xml
 zenonVSTAProxy6500

C# code
using System;
using System.Text.RegularExpressions;
using System.IO;
using System.Windows.Forms;

namespace ProjectAddin

115 | 154
VSTA

C# code
{
[System.AddIn.AddIn("ThisProject", Version = "1.0", Publisher = "", Description = "")]
public partial class ThisProject
{
private void ThisProject_Startup(object sender, EventArgs e)
{
}
private void ThisProject_Shutdown(object sender, EventArgs e)
{
}
public void MacroGetFilteredVariables()
{
string filename = string.Empty;
string name = string.Empty;
string description = string.Empty;
string value = string.Empty;

//définir le modèle d’expression régulière


Regex match = new Regex("^([0-9]){3}[_]");
try
{
filename = FolderSelection("Sélectionnez l’emplacement auquel vous souhaitez conserver les
informations sur les variables");

//créer le StreamWriter dans le fichier .txt


StreamWriter matchedVariables = new StreamWriter(filename, true);
//parcourir toutes les variables dans zenon
for (int i = 0; i < this.Variables().Count; i++)
{
//si le nom de la variable correspond au modèle, obtenir le nom, le nom de la balise et la
valeur actuelle
if (match.IsMatch(this.Variables().Item(i).Name))
{
name = this.Variables().Item(i).Name;
description = this.Variables().Item(i).Tagname;
value = this.Variables().Item(i).get_Value(0).ToString();
//écrire les informations dans le fichier .txt
matchedVariables.WriteLine(name + ";" + description + ";" + value);

116 | 154
VSTA

C# code
}
}
//fermer le flux
matchedVariables.Close();
}
catch (Exception ex)
{

MessageBox.Show("Une erreur s’est produite -> " + ex.Message);


throw;
}
}
private string FolderSelection(String caption)
{
string selectedPath = string.Empty;
//créer une boîte de dialogue de sélection du dossier de sortie
FolderBrowserDialog folderSelect = new FolderBrowserDialog();
folderSelect.Description = caption;
try
{
if (folderSelect.ShowDialog() == DialogResult.OK)
{
//si la sélection était valide, obtenir la date actuelle et la convertir au format de date
du fichier
//ensuite, créer un fichier .txt avec le nom zenonVar et l’état correspondant
DateTime currentTime = DateTime.Now;
selectedPath = folderSelect.SelectedPath + "\\zenonVar" + currentTime.ToFileTime() + ".tx
t";
}
}
catch (Exception ex)
{
MessageBox.Show("Une erreur est survenue : " + ex.Message);
throw;
}
return selectedPath;
}
#region Code généré par VSTA

117 | 154
VSTA

C# code
private void InternalStartup()
{
this.Startup += new System.EventHandler(ThisProject_Startup);
this.Shutdown += new System.EventHandler(ThisProject_Shutdown);
}
#endregion
}
}

5.3.4 Conversion des couleurs entre .NET et zenon


Les couleurs dans l’API zenon sont enregistrées sous forme de données de type numérique. Vous
pouvez utiliser les exemples de code suivants pour effectuer une conversion aux couleurs .NET (ou
inversement) via VSTA ; par ailleurs, l’utilisation des palettes de couleurs est affichée.

CLASSE HELPER POUR CONVERTIR LES COULEURS .NET EN COULEURS ZENON ET


INVERSEMENT
C# code
namespace WorkspaceAddin
{
class ZenonColorHelper
{
// convertir une couleur .NET en couleur d’API zenon
public static uint Color2Api(System.Drawing.Color color)
{
// zenon enregistre au format ABGR, où A est le bit significatif le plus élevé
return (uint)((color.A << 24) | (color.B << 16) | (color.G << 8) | (color.R << 0));
}

// convertir une couleur d’API zenon en couleur .NET


public static System.Drawing.Color Api2Color(uint apiColor)
{
// zenon enregistre au format ABGR, où A est le bit significatif le plus élevé
byte a = (byte)(apiColor >> 24);
byte b = (byte)(apiColor >> 16);
byte g = (byte)(apiColor >> 8);
byte r = (byte)(apiColor >> 0);

118 | 154
VSTA

C# code

return System.Drawing.Color.FromArgb(a, r, g, b);


}

// convertir une chaîne hex de couleur (#FFFFFF) en couleur d’API zenon


public static uint ColorString2Api(string colorString)
{
System.Drawing.Color color = System.Drawing.ColorTranslator.FromHtml(colorString);
return Color2Api(color);
}

// convert une couleur d’API zenon en chaîne hex de couleur (#FFFFFF)


public static string Api2ColorString(uint apiColor)
{
System.Drawing.Color color = Api2Color(apiColor);
return System.Drawing.ColorTranslator.ToHtml(color);
}

// extrait l’indice dans la palette de couleurs, qui est encodée dans la couleur d’API zenon
// renvoie -1 si la couleur donnée ne représente pas un indice de palette de couleurs
public static int GetColorPaletteIndex(uint apiColor)
{
System.Drawing.Color color = Api2Color(apiColor);
if (color.A == 128) // alpha value == 128 -> ind from color palette
{
// G définit le numéro de blocs 8 bits, R est l’indice
return color.G * 256 + color.R;
}

return -1;
}

// encode l’indice conformément à la palette de couleurs de l’API zenon


public static uint EncodeColorPaletteIndex(int index)
{
int chunks = (int)(index / 256.0);
int idx = (int)(index % 256);

119 | 154
VSTA

C# code
System.Drawing.Color color = System.Drawing.Color.FromArgb(128, idx, chunks, 0);
return Color2Api(color);
}
}
}

EXEMPLE POUR L’UTILISATION DE LA CLASSE HELPER


C# code
using zenOn;

public void Macro_ColorHandlingSample()


{
// D’abord, il nous faut un projet avec lequel travailler

IProject project = Application.MyWorkspace.ActiveDocument;


if (null == project)
{
System.Diagnostics.Debug.Print("Erreur !Aucun projet chargé/activé");
return;
}

// Créer un exemple d’image contenant un rectangle rempli (couleur définie directement dans
l’élément)

// Créer un exemple de cadre pour l’image s’il n’existe pas encore


if (null == project.Templates().Item("SampleFrame"))
project.Templates().Create("SampleFrame", false);

// Supprimer et recréer un exemple d’image ou créer une nouvelle image si elle n’existe pas
encore
IDynPicture pic = null;
IDynPictures pictures = project.DynPictures();
for (int i = 0; i < pictures.Count; i++)
{
IDynPicture picture = pictures.Item(i);
if (picture.get_DynProperties("Title").ToString() == "SamplePicture")
{
pic = picture;

120 | 154
VSTA

C# code
break;
}
}
if (null != pic)
{
pic.Save();
pictures.Delete(pic.Name);
}
pic = project.DynPictures().Create("SamplePicture", "SampleFrame",
tpDynPicturesTypes.tpStandard);

// Créer un rectangle pour la démo et lui assigner une couleur d’arrière-plan

IElement ele = pic.Elements().Create("Rectangle", tpElementTypes.tpRectangle);


ele.BackColor = ZenonColorHelper.Color2Api(System.Drawing.Color.Aqua);

System.Diagnostics.Debug.Print("zenon color: " + ele.BackColor);


System.Diagnostics.Debug.Print("As Html:" +
ZenonColorHelper.Api2ColorString(ele.BackColor));

System.Drawing.Color color = ZenonColorHelper.Api2Color(ele.BackColor);


System.Diagnostics.Debug.Print("As Color: r" + color.R + " g" + color.G + " b" + color.B +
" a" + color.A);

// Créer un rectangle rempli (couleur définie directement à partir d’une palette de couleurs)

// Rechercher la palette de couleurs existante dans le projet actuel ou en créer une nouvelle
IColorPalettes palettes = project.ColorPalettes();
int nrOfPalettes = (int)palettes.get_DynProperties("Palette");
if (0 == nrOfPalettes)
{
//Créer une nouvelle palette
palettes.CreateDynProperty("Palette");
//Définir une couleur dans la nouvelle palette
String htmlColor = "#00FFFF"; // System.Drawing.Color.Aqua
palettes.set_DynProperties("Palette[0].PaletteColors", htmlColor);
}

// lier l’entrée de la palette de couleurs à la couleur d’arrière-plan de l’élément

121 | 154
PCE : Process Control Engine

C# code
ele.BackColor = ZenonColorHelper.EncodeColorPaletteIndex(0);
System.Drawing.Color index = ZenonColorHelper.Api2Color(ele.BackColor);
System.Diagnostics.Debug.Print("Index encoded in color: r" + index.R + " g" + index.G + "
b" + index.B + " a" + index.A);
System.Diagnostics.Debug.Print("Palette index:" +
ZenonColorHelper.GetColorPaletteIndex(ele.BackColor));

// Affichage de l’exemple :
//
// couleur zenon : 4294967040
// En HTML : #00FFFF
// En couleur : r0 g255 b255 a255
//
// Indice encodé en couleur : r0 g0 b0 a128
// Indice de la palette : 0
}

6 PCE : Process Control Engine


Attention
À partir de la version 7.20, le module PCE n’est plus pris en charge et ne sera
plus affiché dans l’arborescence des modules de zenon. Lors de la conversion
de projets contenant des tâches PCE depuis des versions antérieures à la version
7.20, le nœud PCE sera affiché pour ces projets. PCE ne fera plus l’objet de
développements ou de documentations ultérieurs.

Recommandation : Veuillez utiliser zenon Logic, plutôt que PCE

122 | 154
PCE : Process Control Engine

6.1 L’éditeur PCE


L’éditeur PCE est accessible dans le gestionnaire de projet, sous l’entrée Interfaces de programmation.
Pour ouvrir l’éditeur PCE, sélectionner l’entrée Ouvrir l’éditeur PCE dans le menu contextuel.

6.1.1 Le gestionnaire de tâches


Le gestionnaire de tâches de l’éditeur PCE liste les tâches existantes et les variables liées.

Un double-clic sur une tâche, l’ouvre dans la zone d’édition. Un menu contextuel est affiché en cliquant
sur la tâche avec le bouton droit de la souris.

Le menu contextuel d’une tâche a les quatre entrées suivantes :


Paramètres : Description

Propriétés de la tâche... Ouvre la boîte de dialogue des propriétés de la tâche.

Variables de la tâche... Ouvre la boîte de sélection des variables. Vous pouvez ainsi

123 | 154
PCE : Process Control Engine

Paramètres : Description
ajouter de nouvelles variables à la tâche.

Supprimer la tâche Supprime la tâche sans confirmation.

Compiler une tâche Compile la tâche.

6.1.2 La zone d’édition


Dans la zone d’édition de l’éditeur PCE, le code des tâches est saisi en VB Script ou Java Script.

6.1.3 La fenêtre de sortie

6.1.4 Les menus de l’éditeur PCE

6.1.4.1 Menu Fichier


Le menu Fichier contient les commandes suivantes :
Paramètres : Description

Enregistrer Enregistre les nouvelles tâches et les


tâches modifiées.

Imprimer Imprime la tâche actuelle.

Fermer Ferme l’éditeur PCE.

6.1.4.2 Menu Édition


Le menu Édition contient les commandes suivantes :
Paramètre Description

Annuler Annule la dernière action.

124 | 154
PCE : Process Control Engine

Paramètre Description

Répéter Refait la dernière action annulée.

Couper Déplace le texte sélectionné vers le presse-papiers de


Windows.

Copier Copie le texte sélectionné vers le presse-papiers de


Windows.

Paste Insère le texte présent dans le presse-papiers de


Windows à la position du curseur.

Supprimer

Sélectionner tout Sélectionne le texte complet de la tâche.

Rechercher Recherche un texte dans la tâche actuelle.

Rechercher le suivant Recherche l’occurrence suivante du texte recherché.

Rechercher le précédent Recherche l’occurrence précédente du texte


recherché.

Remplacer... Remplace un texte par un autre dans la tâche actuelle.

Signets Gestion des signets dans le code de la tâche actuelle.

- Spécifier un signet Positionne un signet à la ligne sélectionnée dans le


code.

- Signet suivant Accède au signet suivant dans le code.

- Signet précédent Accède au signet précédent dans le code.

- Supprimer tous les signets Supprime tous les signets dans le code.

6.1.4.3 Menu Exécuter


Le menu Exécuter contient les commandes suivantes :
Enregistrer toutes les tâches et redémarrer

Compiler une tâche Compile la tâche.

125 | 154
PCE : Process Control Engine

6.1.4.4 Menu Options


Le menu Options contient les commandes suivantes :
Paramètres : Description

Options Ouvre la boîte de paramétrage de l’éditeur PCE.

Gestionnaire de Ouvre / ferme le gestionnaire de tâches.


tâches

Affichage des Ouvre / ferme la fenêtre de suivi (sortie).


résultats

Barre d’état Ouvre / ferme la barre d’état.

6.1.4.5 Menu Fenêtre


Le menu Fenêtre contient les commandes suivantes :
Fermer

Organiser

Mosaïque

Aligner les symboles

Liste des fenêtres ouvertes

6.1.4.6 Menu Aide


Le menu Aide contient les commandes suivantes :
Commande Action

Aide Ouvre l’aide en ligne.

À propos… Ouvre une fenêtre contenant des informations sur zenon :


 Numéro de série
 TAGs couverts par la licence
 Module couvert par la licence

Un curseur permet de parcourir le contenu de la fenêtre d’informations.


Cliquez sur la fenêtre ou appuyez sur la touche Échap pour fermer la

126 | 154
PCE : Process Control Engine

Commande Action
fenêtre d’informations.

6.1.5 La barre de boutons de l’éditeur PCE


Les commandes principales de l’éditeur PCE peuvent aussi être exécutées depuis la barre de boutons.

Les fonctions suivantes sont disponibles :


Paramètres : Description

Fermer Ferme l’éditeur PCE.

Enregistrer tout Enregistre les nouvelles tâches et les tâches modifiées.

Imprimer le synoptique Imprime la tâche actuelle.

Couper Déplace le texte sélectionné vers le presse-papiers de


Windows.

Copier Copie le texte sélectionné vers le presse-papiers de


Windows.

Paste Insère le texte présent dans le presse-papiers de


Windows à la position du curseur.

Annuler Annule la dernière action.

Répéter Refait la dernière action annulée.

Rechercher Recherche un texte dans la tâche actuelle.

Rechercher le suivant Recherche l’occurrence suivante du texte recherché.

Rechercher le précédent Recherche l’occurrence précédente du texte


recherché.

Remplacer... Remplace un texte par un autre dans la tâche actuelle.

Sauver et redémarrer

Démarrer le débogage

Signet suivant Accède au signet suivant dans le code.

Spécifier un signet Positionne un signet à la ligne sélectionnée dans le

127 | 154
PCE : Process Control Engine

Paramètres : Description
code.

Signet précédent Accède au signet précédent dans le code.

Supprimer tous les signets Supprime tous les signets dans le code.

6.2 Suite des actions

6.2.1 Créer une tâche


Avec le menu contextuel du gestionnaire de tâche, une nouvelle tâche peut être créée.

6.2.1.1 Propriétés de la tâche


Après la création d’une tâche, la boîte de dialogue des propriétés de la nouvelle tâche s’ouvre
automatiquement.

Les propriétés suivantes peuvent être définies :


Paramètre Description

Nom Nom unique de la tâche.

Type Les tâches peuvent être exécutées de manière cyclique ou une fois
seulement.
Cyclique : la tâche est exécutée cycliquement dans l'intervalle défini sous
Temps de cycle à atteindre.
Une fois : la tâche est exécutée une seule fois.

Priorité Priorités du procédé pour les systèmes multithread (inactif, basse, normal,
haute, la plus haute, critique (temps)).

128 | 154
PCE : Process Control Engine

Paramètre Description
Par défaut : Normal
Processus principal : la tâche s’exécute dans le même thread que le
Runtime. Si la tâche rentre dans une boucle d’attente ou si elle 'plante',
cela influence aussi le Runtime.

Fichier script Sélection du fichier script : Fichiers VB (*.vbs) pour les scripts VB ou
Fichiers JS (*.js) pour les scripts Java.
Le fichier correspondant est créé lorsque la tâche est ouverte dans la
zone d’édition pour la première fois.

Type de Démarrage du système : démarrage automatique, en même temps que le


démarrage Runtime. (C'est la seule façon disponible si vous utilisez le PCE sous
Windows CE, car Windows CE ne supporte pas le VBA).
Événementiel : la tâche est démarrée dans une macro VBA avec la syntaxe
suivante : thisProject.Tasks.Item("nom de la tâche").Run.

Temps de cycle à Pour les tâches cycliques, c’est le temps qui doit être atteint par la tâche
atteindre en millisecondes.
Si ce temps de cycle n’est pas respecté, la tâche est exécutée aussi vite
que possible.

Pour des modifications ultérieures des propriétés, cette boîte de dialogue peut être ouverte par le menu
contextuel de la tâche et l’entrée Propriétés de la tâche.

6.2.1.2 Variables de la tâche


Une fois les propriétés définies, la boîte de dialogue de sélection de variables s’ouvre automatiquement.
Dans cette boîte de dialogue, vous pouvez sélectionner les variables devant être traitées dans la tâche.

Toutes les variables lues ou écrites dans la tâche doivent être liées ici. Il est également possible
d’accéder à une variable via l’objet de la variable, mais seules les valeurs directement liées à la tâche
concernée sont automatiquement mises à jour lors de l’initialisation de la tâche, avant son exécution.

La variable doit avoir le format :

Task.Value('Nom de la variable')=123

Si vous souhaitez modifier la sélection de la variable ultérieurement, il est également possible d’ouvrir
cette boîte de dialogue en affichant le menu contextuel de la tâche et en sélectionnant l’entrée Tâche
variables…

129 | 154
PCE : Process Control Engine

6.2.2 Entrer le code


Double-cliquer sur une tâche dans le gestionnaire de tâche ouvre celle-ci dans la zone d’édition. Le
fichier VBS ou JS correspondant est créé lorsque la tâche est ouverte pour la première fois.

Quatre procédures sont créées automatiquement :


Paramètres : Description

Task_Init() Cette procédure est exécutée automatiquement lorsque la tâche


est démarrée.

Task_Main() Cette procédure est exécutée soit une seule fois (type Une seule
fois) ou cycliquement (type Cyclique).

Task_Exit() Cette procédure est exécutée automatiquement lorsque la tâche


est terminée.

Task_Timer(lTimerId) Cette procédure est exécutée cycliquement tant que le Timer


correspondant tourne. Le temps de cycle est défini en tant que
paramètre lors du démarrage du Timer.

De façon générale, le PCE utilise le même modèle d’objet que le VBA (voir les guides VBA). Lorsque
vous utilisez des objets VBA (sauf l’objet Task) le multithreading est perdu, car ces objets ne peuvent
être utilisés que depuis le thread principal.

Attention
Dans l’interface COM, les fonctions ne bénéficient pas toutes de la possibilité de
multithreading et si ce n’est pas le cas, alors elles ne peuvent être utilisées que
dans le contexte du thread principal. Si une propriété différente de "processus
principal" est définie pour une tâche PCE, il ne doit alors pas y avoir d’accès
depuis le PCE vers le thread principal. Dans le cas où il y a un quand même un
accès à l’interface COM, ceci peut conduire à des états système indéterminés,
par exemple, un blocage du Runtime.

La collection Tasks et l’objet Task sont donc d’une importance spéciale.

6.2.2.1 La collection Tasks


Nom
bre

Produ

130 | 154
PCE : Process Control Engine

Nom
bre
it

Paren
t

6.2.2.2 L’objet Task


ActualCycleTime Propriété Temps de cycle courant de la tâche

CountVariable Propriété Nombre de variables liées à la tâche

CycleTime Propriété Temps de cycle défini pour la tâche

DynProperties Propriété

ErrorNumber Propriété

ErrorString Propriété

Exit Événement

Init Événement

ItemVariable Méthode

Main Événement

MemValue Propriété Avec "Task.MemValue("Nom")=valeur" une variable


interne est créée et une valeur lui ait assignée. Il n’y a pas
besoin de déclarer la variable au préalable.

Cette variable peut aussi être utilisée depuis les autres


tâches. Cela permet ainsi d’échanger des valeurs entre les
tâches.

Nom Propriété Nom de la tâche courante

Parent Propriété La collection Tasks

Priorité Propriété Priorité de la tâche courante

Run Méthode Démarre une tâche

Sleep Méthode Suspend une tâche

StartTimer Méthode La méthode "StartTimer" démarre un timer pour la tâche.

131 | 154
PCE : Process Control Engine

ActualCycleTime Propriété Temps de cycle courant de la tâche

État Propriété

Stop Méthode Arrête une tâche

StopTimer Méthode La méthode "StopTimer" arrête le timer de la tâche.

Timer Événement

Type Propriété

Valeur Propriété Avec "Task.Value("nom de la variable liée")=valeur" une


variable du projet prend une nouvelle valeur.

6.2.3 Fonction Visualiser PCE


La fonction Visualiser PCE de zenon permet d’ouvrir l’éditeur PCE depuis le Runtime.

6.2.4 Exécuter des tâches


Les tâches peuvent être exécutées lors du démarrage du système, ou peuvent être déclenchées par un
événement.

6.2.4.1 Exécution de tâches au démarrage du système


Dans la configuration de la tâche, si e paramètre Type de démarrage est défini sur Démarrage du
système , la tâche est automatiquement démarrée avec le Runtime.

C’est la seule façon disponible si vous utilisez le PCE sous Windows CE, car Windows CE ne supporte
pas le VBA.

6.2.4.2 Exécuter des tâches déclenchées par un événement

6.2.4.2.1 Sur un PC
Une tâche peut aussi être démarrée selon un événement. Dans ce cas, le type de démarrage doit
être Selon événement. Maintenant, la tâche n’est pas démarrée automatiquement avec le Runtime.

132 | 154
PCE : Process Control Engine

Une macro VBA doit être créée, afin d’exécuter la tâche lors de la sélection d’un bouton ou en cas de
dépassement de valeur limite, ou suivant n’importe quel autre événement. L’instruction VBA suivante
permet de démarrer la tâche : thisProject.Tasks.Item(Taskname).Run
La tâche est démarrée automatiquement dans son propre thread si la propriété Processus principal n’a
pas été activée.

Avec l'instruction VBA suivante la tâche peut être arrêtée à tout moment :
thisProject.Tasks.Item("Taskname").Stop

Remarque : Pour exécuter une tâche plusieurs fois, celle-ci doit être explicitement arrêtée après qu’elle
se soit terminée, pour ensuite pouvoir être redémarrée.
Instruction : thisProject.Tasks.Item(Nom de la tâche).Stop
Elle peut être redémarrée après avoir été correctement arrêtée.

6.2.4.2.2 Sur un terminal CE


Puisque Windows CE n’offre pas de prise en charge de VBA, la procédure d’exécution sur un PC ne peut
pas être mise en œuvre sur un terminal CE. Mais il y a, ici aussi, la possibilité d’exécuter des tâches
déclenchées selon des événements.

Une tâche avec le type de démarrage System start est créée. Cette tâche est démarrée
automatiquement avec le Runtime. Et cette tâche a la priorité PROCESSUS PRINCIPAL pour qu’elle
tourne dans le même thread que le Runtime. Maintenant, des variables 'bit' sont liées à cette tâche, et
exécuteront d’autres tâches déclenchées selon un événement. Avec l’instruction suivante, la tâche peut
être démarrée : Parent.Item(Taskname).Run
La tâche est démarrée automatiquement dans son propre Thread si la propriété Processus principal n’a
pas été activée.

Avec l’instruction suivante, la tâche peut être arrêtée à tout moment : Parent.Item("Taskname").Stop

6.3 VBScript - Introduction

6.3.1 Type de données

6.3.1.1 Variant
VBScript comporte un seul type de données, appelé Variant. Un Variant est un type de données
spécial, qui peut contenir différentes sortes d'informations, en fonction de son utilisation. Parce que le
type de données Variant est l'unique type de données disponible dans VBScript, il s'agit également du
type de données renvoyé par toutes les fonctions dans VBScript.

Dans sa forme la plus simple, un Variant peut contenir des informations numérique ou de chaîne. Un
Variant se comporte comme un nombre lorsqu'il est utilisé dans un contexte numérique, et se

133 | 154
PCE : Process Control Engine

comporte comme une chaîne lorsqu'il est utilisé dans une chaîne de texte. Concrètement, si vous utilisez
des données qui ressemblent à des nombres, VBScript suppose qu’il s’agit de nombres et traite ces
données de la manière la plus appropriée. Vous pouvez toujours utiliser des nombres comme des
chaînes de caractères en les saisissant entre des guillemets (" "). Si vous utilisez des données pouvant
uniquement être interprétées comme des chaînes, c’est ainsi que ces données seront interprétées par
VBScript.

6.3.1.2 Sous-type Variant


En plus des classifications simples numériques ou chaîne, un Variant peut rajouter une distinction sur la
nature spécifique d’une information numérique. Par exemple, vous pouvez avoir une information
numérique qui représente une date ou une heure. Si on l’utilise avec une autre date ou heure, le résultat
sera toujours exprimé comme une date ou une heure. Vous avez aussi une grande variété d’information
numérique allant de valeurs booléennes jusqu’aux énormes nombres flottants (réels). Ces différentes
catégories qui peuvent être contenues dans un élément Variant sont appelées sous-types. La plupart
du temps, vous pouvez mettre le type de données que vous souhaitez dans un élément Variant ; cet
élément se comporte de la façon la plus appropriée par rapport aux données qu'il contient.

Le récapitulatif suivant présente les sous-types de données que peut contenir un élément Variant.
Sous-type Signification

Empty Le variant n’est pas initialisé. La valeur est 0 pour les variables numériques et
une chaîne de longueur nulle ("") pour les variables chaîne.

Null Le variant ne contient intentionnellement aucune donnée valide.

Boolean Contient soit TRUE soit FALSE.

Byte Contient un entier dans la plage de 0 à 255.

Integer Contient un entier dans la plage de -32 768 à 32 767.

Currency -922,337,203,685,477.5808 bis 922,337,203,685,477.5807.

Long Contient un entier dans la plage de -2 147 483 648 à 2 147 483 647.

Single Contient un nombre flottant (réel) simple précision dans la plage -3.402823E38
à -1.401298E-45 pour les valeurs négatives; 1.401298E-45 à 3.402823E38 pour
les valeurs positives.

Double Contient un nombre flottant (réel) double précision dans la plage


-1.79769313486232E308 à -4.94065645841247E-324 pour les valeurs négatives;
4.94065645841247E-324 à 1.79769313486232E308 pour les valeurs positives.

Date (Time) Contient un nombre qui représente une date entre le 1er janvier 100 jusqu’au 31
décembre 9999.

134 | 154
PCE : Process Control Engine

Sous-type Signification

String Contient une variable chaîne qui peut contenir jusqu’à 2 milliards de caractères.

Object Contient un objet.

Error Contient un numéro d’erreur.

6.3.2 Variables
Une variable est un opérateur très utile, qui fait référence à un emplacement dans la mémoire de
l’ordinateur dans lequel vous pouvez conserver des informations du programme susceptibles d’évoluer
durant l’exécution de votre script. Par exemple, vous pouvez créer une variable appelée ClickCount pour
mémoriser le nombre de fois qu’un utilisateur clique sur un objet sur une page Web particulière.
L’emplacement auquel la variable est conservée dans la mémoire de l’ordinateur est sans importance.
Ce qui est important, c’est que pour afficher ou modifier la valeur d’une variable, il suffit de la désigner
par son nom. Dans VBScript, les variables appartiennent toujours à un type de données fondamental,
Variant.

6.3.2.1 Declaring Variables


You declare variables explicitly in your script using the Dim statement, the Public statement, and the
Private statement. Example:
Dim DegreesFahrenheit

You declare multiple variables by separating each variable name with a comma. Example:
Dim Top, Bottom, Left, Right

6.3.2.2 Restrictions concernant les noms


Les noms de variable suivent les conventions de nommage du VBScript. Un nom de variable :
 doit commencer par une lettre.
 ne peut pas contenir un point.
 ne doit pas excéder 255 caractères.
 doit être unique dans la portée dans laquelle il est déclaré.

135 | 154
PCE : Process Control Engine

6.3.2.3 Portée et durée de vie des variables


Lorsque vous déclarez une variable dans une procédure, seul le code de la procédure peut lire ou
modifier la valeur de cette variable. Elle a une portée locale et est une variable de niveau procédure.

Si vous déclarez une variable en dehors d’une procédure, elle sera accessible par toutes les procédures
du script. C’est une variable de niveau script et à une portée de niveau script.

La durée de vie d’une variable correspond au temps pendant lequel elle existe. La vie d’une variable de
niveau script démarre au moment où elle est déclarée jusqu’au moment où le script s’arrête. Une
variable locale à une procédure n’existe que tant qu’on se trouve dans la procédure. Lorsqu’on sort de
la procédure, la variable est supprimée.

Les variables locales sont idéales pour stocker des données temporaires uniquement nécessaires dans la
procédure. Vous pouvez avoir des variables locales de même nom dans différentes procédures car
chacune d’elles n’est connue que dans la procédure dans laquelle elle est déclarée.

6.3.2.4 Attribution de valeurs à des variables


Pour attribuer des valeurs à des variables, on crée une expression comme suit : la variable est insérée à
gauche de l’expression, tandis que la valeur que vous souhaitez attribuer à la variable se trouve à droite.
Exemple :
B = 200

6.3.2.5 Variables scalaires et variables de tableau


Dans la plupart des cas, il n’est nécessaire d’attribuer qu’une seule valeur à une variable que vous avez
déclarée. Une variable contenant une valeur unique est une variable scalaire. Dans certains cas, il est
pratique de pouvoir assigner plus d’une valeur à une seule variable. Dans ce cas, vous créez une
variable contenant une série de valeurs. Ce type de variable est appelé "variable de tableau". Les
variables tableaux sont déclarées presque comme les variables scalaires. La seule différence est
l’utilisation des parenthèses après leurs noms. Dans l’exemple suivant, une variable de tableau à une
dimension contenant 11 éléments est déclarée :
Dim A(10)

Bien que le nombre indiqué entre parenthèses soit 10, tous les tableaux dans VBScript possèdent une
base zéro, ce qui signifie que ce tableau comporte en réalité 11 éléments. Dans un système où le
premier élément est à l’indice 0, le nombre d’éléments d’un tableau est le nombre indiqué entre
parenthèses + 1. Ce type de tableau est appelé "tableau à taille fixe".

136 | 154
PCE : Process Control Engine

On utilise un index spécifique au tableau pour attribuer des données à chacun des éléments du tableau.
En commençant à zéro et en finissant à 10, il est possible d’attribuer des données aux éléments d’un
tableau comme indiqué ici :
A(0) = 256
A(1) = 324
A(2) = 100
. . .
A(10) = 55

De même, les données peuvent être extraites de chaque élément à l’aide d’un index spécifique à
l’élément concerné du tableau de votre choix. Exemple :
. . .
SomeVariable = A(8)
. . .

Les tableaux ne sont pas limités à une dimension. Ils peuvent comporter jusqu’à 60 dimensions, bien
que la plupart des utilisateurs ne puissent appréhender plus de trois ou quatre dimensions. Vous pouvez
déclarer plusieurs dimensions en séparant les nombres définissant la taille d’un tableau (spécifiés entre
parenthèses) par des virgules. Dans l’exemple suivant, la variable MyTable est un tableau à deux
dimensions constitué de 6 lignes et 11 colonnes :
Dim MyTable(5, 10)

Dans un tableau à deux dimensions, le premier nombre représente toujours le nombre de lignes ; le
deuxième nombre représente le nombre de colonnes.

Vous pouvez également déclarer un tableau dont la taille évolue durant l’exécution de votre script. Ce
type de tableau est appelé "tableau dynamique". Le tableau est initialement déclaré dans une
procédure, à l’aide de la déclaration Dim ou ReDim. Toutefois, pour un tableau dynamique, aucune
indication de taille ou de nombre de dimensions n’est insérée entre les parenthèses. Exemple :
(Dim AnArray()
ReDim AnotherArray()

Pour utiliser un tableau dynamique, vous devez ensuite utiliser la déclaration ReDim pour déterminer le
nombre de dimensions et la taille de chaque dimension. Dans l’exemple suivant, ReDim définit la taille
initiale du tableau dynamique sur 25. Une déclaration ReDim ultérieure redimensionne le tableau à 30,
mais utilise le mot-clé Preserve pour préserver le contenu du tableau lors du redimensionnement.
ReDim MyArray(25)
. . .
ReDim Preserve MyArray(30)

137 | 154
PCE : Process Control Engine

6.3.3 Constantes
Une constante est un nom significatif qui remplace un nombre ou une chaîne de caractères et qui ne
change jamais. Le VBScript définit un nombre de constantes intrinsèques. Vous pouvez obtenir des
informations sur ces constantes intrinsèques à partir de la référence du langage VBScript.

Vous pouvez créer des constantes utilisateur en VBScript en utilisant le mot-clé Const. Vous pouvez
ainsi donner un nom significatif pour les constantes textuelles ou numériques. Vous leur assignez leur
valeur et ensuite, vous les utilisez dans un script.

Remarque à l'attention des programmeurs


Const MaChaine = "Ceci est une chaîne de caractères."
Const MonAge = 49

La chaîne est entourée par des guillemets (par exemple, "exemple de texte"). Les guillemets sont le
moyen le plus évident pour différentier les valeurs de chaînes de caractères des valeurs numériques. La
représentation des dates (type Date) et heures (type Time) sont encadrées par le signe dièse (#).

Remarque à l'attention des programmeurs

Const deadline = #6-1-97#

Vous pouvez définir une convention de nommage pour différentier les constantes des variables. Ceci
vous permettra d’éviter d’assigner une valeur dans une constante dans vos scripts. Par exemple, vous
pouvez utiliser les préfixes "vb" sur vos variables ou "cste" sur vos constantes ; vous pouvez aussi choisir
d’écrire vos constantes en majuscules. Mais assurez-vous que les constantes et les variables peuvent
bien être distinguées. Vous éviterez ainsi quelques problèmes lors de l’écriture de scripts complexes.

6.3.4 Opérateurs
VBScript comporte une vaste gamme d’opérateurs, et notamment des opérateurs arithmétiques, des
opérateurs de comparaison, des opérateurs de concaténation et des opérateurs logiques.

6.3.4.1 Priorité des opérateurs


Si plusieurs opérateurs apparaissent dans un énoncé, chaque partie est évaluée selon un ordre
prédéfini. Cet ordre est appelé la priorité des opérateurs. Vous pouvez utiliser des parenthèses pour
changer l’ordre des priorités et forcer des parties d’une expression à être évaluées avant d’autres. Les
opérations entre parenthèses sont toujours exécutées avant les opérations en dehors des parenthèses.
Entre les parenthèses, cependant, la priorité des opérateurs est prise en compte.

Lorsque des expressions contiennent des opérateurs de plus d’une catégorie, les opérateurs
arithmétiques sont évalués en premier, puis les opérateurs de comparaison, et les opérateurs logiques
sont évalués en dernier. Les opérateurs de comparaison sont d’égales priorités, et sont donc évalués de
gauche à droite. Les opérateurs arithmétiques et logiques sont évalués dans l’ordre suivant.

138 | 154
PCE : Process Control Engine

6.3.4.2 Opérateurs arithmétiques


Description Symb
ole

Mise en exposant ^

Négation unaire -

Multiplication *

Division /

Division entière /

Modulo Mod

Addition +

Soustraction -

Concaténation de chaînes

6.3.4.3 Opérateurs de comparaison


Description Symbole

Égalité =

Inégalité <>

Inférieur à <

Supérieur à >

Inférieur ou égal <=


à

Supérieur ou égal >=


à

Équivalence Is
d’objet

139 | 154
PCE : Process Control Engine

6.3.4.4 Opérateurs logiques


Si plusieurs opérateurs apparaissent dans un énoncé, chaque partie est évaluée selon un ordre
prédéfini. Cet ordre est appelé la priorité des opérateurs. Vous pouvez utiliser des parenthèses pour
changer l’ordre des priorités et forcer des parties d’une expression à être évaluées avant d’autres. Les
opérations entre parenthèses sont toujours exécutées avant les opérations en dehors des parenthèses.
Entre les parenthèses, cependant, la priorité des opérateurs est prise en compte.

Lorsque des expressions contiennent des opérateurs de plus d’une catégorie, les opérateurs
arithmétiques sont évalués en premier, puis les opérateurs de comparaison, et les opérateurs logiques
sont évalués en dernier. Les opérateurs de comparaison sont d’égales priorités, et sont donc évalués de
gauche à droite. Les opérateurs arithmétiques et logiques sont évalués dans l’ordre suivant.

6.3.5 Déclarations conditionnelles


Vous pouvez contrôler le déroulement de votre script au moyen de déclarations conditionnelles et de
déclarations en boucle. À l’aide de déclarations conditionnelles, vous pouvez rédiger un code VBScript
qui prend des décisions et répète des actions.

6.3.5.1 Prise de décisions avec la déclaration If...Then...Else


La déclaration If...Then...Else est utilisée pour évaluer si une condition est True (vraie) ou False (fausse) et,
en fonction du résultat, pour spécifier une ou plusieurs déclarations à exécuter. Habituellement, la
condition est une expression qui utilise un opérateur de comparaison pour comparer une valeur ou une
variable avec une autre. Pour plus d’informations concernant les opérateurs de comparaison,
reportez-vous à la section Opérateurs de comparaison. Les déclarations If...Then...Else peuvent être
imbriquées à autant de niveaux différents que nécessaire.

6.3.5.1.1 Exécuter des traitements si une condition est vraie


Pour n’exécuter qu’une seule instruction si une condition est vraie, utilisez la syntaxe sur une seule ligne
pour If...Then...Else. L’exemple suivant illustre la syntaxe avec une seule ligne. Dans cet exemple, le
mot-clé Else est omis.
Sub FixDate()
Dim myDate
myDate = #2/13/95#
If myDate < Now Then myDate = Now
End Sub

Pour exécuter plus qu’une ligne de code, vous devez utiliser la syntaxe correspondante. Cette syntaxe
inclut l’instruction End If, comme montré dans l’exemple suivant :
Sub AlertUser(value)
If value = 0 Then
AlertLabel.ForeColor = vbRed
AlertLabel.Font.Bold = True

140 | 154
PCE : Process Control Engine

AlertLabel.Font.Italic = True
End If
End Sub

Pour n’exécuter qu’une seule instruction si une condition est vraie, utilisez la syntaxe sur une seule ligne
pour If...Then...Else. L’exemple suivant illustre la syntaxe avec une seule ligne. Dans cet exemple, le
mot-clé Else est omis.
Sub FixDate()
Dim myDate
myDate = #2/13/95#
If myDate < Now Then myDate = Now
End Sub

Pour exécuter plus qu’une ligne de code, vous devez utiliser la syntaxe correspondante. Cette syntaxe
inclut l’instruction End If, comme montré dans l’exemple suivant :
Sub AlertUser(value)
If value = 0 Then
AlertLabel.ForeColor = vbRed
AlertLabel.Font.Bold = True
AlertLabel.Font.Italic = True
End If
End Sub

6.3.5.1.2 Exécute certains traitements si une condition est vraie et d’autres


traitements si la condition est fausse.
Vous pouvez utiliser une déclaration If...Then...Else pour définir deux blocs de déclarations exécutables :
un bloc à exécuter si la condition est True, et un autre bloc à exécuter si la condition est False.
Sub AlertUser(value)
If value = 0 Then
AlertLabel.ForeColor = vbRed
AlertLabel.Font.Bold = True
AlertLabel.Font.Italic = True
Else
AlertLabel.Forecolor = vbBlack
AlertLabel.Font.Bold = False
AlertLabel.Font.Italic = False
End If
End Sub

6.3.5.1.3 Décider entre plusieurs alternatives


Une variante d’If...Then...Else permet de choisir entre plusieurs alternatives. En ajoutant le mot-clé ElseIf
on étend les possibilités d’If...Then...Else pour orienter le flux du programme selon diverses conditions.
Exemple :
Sub ReportValue(value)
If value = 0 Then
MsgBox value
ElseIf value = 1 Then
MsgBox value
ElseIf value = 2 then

141 | 154
PCE : Process Control Engine

Msgbox value
Else
Msgbox Walue out of range!
End If

6.3.5.2 Prise de décisions avec la déclaration Select Case


La structure Select Case fournit une alternative à If...Then...ElseIf pour exécuter un bloc d’instructions ou
un autre parmi plusieurs blocs d’instructions. Une déclaration Select Case fournit une capacité semblable
à la déclaration If...Then...Else, mais elle rend le code plus efficace et lisible.

Un Select Case marche avec une expression simple qui n’est évaluée qu’une fois au début de la
structure. Le résultat de l’expression est alors comparé avec les valeurs de chaque Case à l’intérieur de la
structure. En cas de correspondance, le bloc de déclarations associé à la déclaration Case est exécuté,
comme dans l’exemple suivant.
Select Case Document.Form1.CardType.Options(SelectedIndex).Text
Case MasterCard
DisplayMCLogo
ValidateMCAccount
Case Visa
DisplayVisaLogo
ValidateVisaAccount
Case American Express
DisplayAMEXCOLogo
ValidateAMEXCOAccount
Case Else
DisplayUnknownImage
PromptAgain
End Select

6.3.6 Utilisation de boucles de code


L’utilisation de boucles vous permet d’exécuter un groupe de déclarations à plusieurs reprises. Certaines
boucles répètent des déclarations jusqu’à ce qu’une condition soit False (fausse) ; d’autres répètent des
déclarations jusqu’à ce qu’une condition soit True (vraie). Il existe également des boucles qui répètent
des déclarations un nombre spécifique de fois.

Les déclarations en boucle suivantes sont disponibles dans VBScript :


Paramètres : Description

Utilisation de boucles Do (à la exécute une boucle pendant ou jusqu’à ce qu’une condition soit True (vraie).
page 143) :

Utilisation de boucles exécute une boucle pendant qu’une condition est True (vraie).
While...Wend (à la page 145) :

Utilisation de boucles For...Next utilise un compteur pour exécuter des déclarations un certain nombre de fois.
(à la page 145) :

142 | 154
PCE : Process Control Engine

Paramètres : Description

Utilisation de boucles For répète un groupe de déclarations pour chaque article d’une collection ou chaqu
Each...Next (à la page 146) :

6.3.6.1 Utilisation des déclarations Do... Loop


Vous pouvez utiliser des déclarations Do...Loop pour exécuter un bloc de déclarations autant de fois que
vous le souhaitez. Les déclarations sont répétées lorsqu’une condition est True (vraie) ou jusqu’à ce
qu’une condition devienne True (vraie).

6.3.6.1.1 Répéter des déclarations lorsqu’une condition est True (vraie)


Utilisez le mot-clé While pour vérifier une condition dans une déclaration Do...Loop. Vous pouvez
contrôler la condition avant de définir la boucle (comme indiqué dans l’exemple ChkFirstWhile
ci-dessous), ou vous pouvez la contrôler après une exécution au moins de la boucle (comme indiqué
dans l’exemple ChkLastWhile). Dans la procédure ChkFirstWhile, si monNum est défini sur 9 au lieu de
20, les déclarations à l’intérieur de la boucle ne s’exécuteront jamais. Dans la procédure ChkLastWhile,
les déclarations à l’intérieur de la boucle s’exécutent une fois seulement, car la condition est déjà False
(fausse).
Sub ChkFirstWhile()
Dim counter, myNum
counter = 0
monNum = 20
Do While monNum > 10
monNum = monNum - 1
compteur = compteur + 1
Loop
MsgBox 'La boucle a fait ' & compteur & ' répétitions.'
End Sub

Sub ChkLastWhile()
Dim compteur, monNum
compteur = 0
monNum = 9
Do
myNum = myNum - 1
counter = counter + 1
Loop While monNum > 10
MsgBox 'La boucle a fait ' & compteur & ' répétitions.'

143 | 154
PCE : Process Control Engine

End Sub

6.3.6.1.2 Répéter une déclaration jusqu’à ce qu’une condition devienne True


(vraie)

Il existe deux manières d’utiliser le mot-clé Until pour vérifier une condition dans une déclaration
Do...Loop. Vous pouvez contrôler la condition avant de définir la boucle (comme indiqué dans l’exemple
ChkFirstUntil ci-dessous), ou vous pouvez la contrôler après une exécution au moins de la boucle
(comme indiqué dans l’exemple ChkLastUntil). Tant que la condition est False, la boucle s’exécute.
Sub ChkFirstUntil()
Dim compteur, monNum
compteur = 0
monNum = 20
Do Until monNum = 10
monNum = monNum - 1
compteur = compteur + 1
Loop
MsgBox 'La boucle a fait ' & compteur & ' répétitions.'
End Sub

Sub ChkLastUntil()
Dim compteur, monNum
compteur = 0
monNum = 1
Th
monNum = monNum - 1
compteur = compteur + 1
Loop Until monNum = 10
MsgBox 'La boucle a fait ' & compteur & ' répétitions.'
End Sub

6.3.6.1.3 Exiting a Do...Loop Statement from Inside the Loop

You can exit a Do...Loop by using the Exit Do statement. Because you usually want to exit only in certain
situations, such as to avoid an endless loop, you should use the Exit Do statement in the True statement
block of an If...Then...Else statement. If the condition is False, the loop runs as usual.

144 | 154
PCE : Process Control Engine

In the following example, myNum is assigned a value that creates an endless loop. The If...Then...Else
statement checks for this condition, preventing the endless repetition.
Sub ExitExample()
Dim counter, myNum
counter = 0
myNum = 9
Do Until myNum = 10
myNum = myNum - 1
counter = counter + 1
If myNum < 10 Then Exit Do
Loop
MsgBox 'The loop made ' & counter & ' repetitions.'
End Sub

6.3.6.2 Utilisation de boucles While...Wend


La déclaration While...Wend est incluse dans VBScript à l’intention des développeurs familiarisés avec son
utilisation. Toutefois, en raison du manque de flexibilité inhérent aux déclarations While...Wend, nous
vous recommandons d’utiliser les déclarations Do...Loop à leur place.

6.3.6.3 Utilisation des déclarations For...Next


Vous pouvez utiliser des déclarations For...Next pour exécuter un bloc de déclarations un nombre
spécifique de fois. Pour les boucles, utilisez un compteur de variables dont la valeur augmente ou
diminue à chaque répétition de la boucle.

L’exemple suivant déclenche 50 exécutions d’une procédure appelée MyProc. La déclaration For spécifie
le compteur de variables x et ses valeurs de début et de fin. La déclaration Next augmente la variable
du compteur de 1.
Sub DoMyProc50Times()
Dim x
For x = 1 To 50
MyProc
Next
End Sub

À l’aide du mot-clé Step, vous pouvez augmenter ou diminuer la variable du compteur selon la valeur
spécifiée. Dans l’exemple suivant, la variable du compteur j est augmentée de 2 à chaque réinitialisation
de la boucle. Lorsque la boucle est terminée, le total est la somme de 2, 4, 6, 8 et 10.
Sub DoMyProc50Times()
Dim x

145 | 154
PCE : Process Control Engine

For x = 1 To 50
MyProc
Next
End Sub

Pour diminuer la variable du compteur, utilisez une valeur Step négative. Vous devez spécifier une
valeur de fin inférieure à la valeur de début. Dans l’exemple suivant, la variable du compteur monNum
est diminuée de 2 à chaque réinitialisation de la boucle. Lorsque la boucle est terminée, le total est la
somme de 16, 14, 12, 10, 8, 6, 4 et 2.
Sub NewTotal()
Dim monNum, total
For monNum = 16 To 2 Step -2
total = total + monNum
Next
MsgBox 'Le total est de ' & total
End Sub

6.3.6.4 Utilisation de boucles For Each...Next


Une boucle For Each...Next est semblable à une boucle For...Next. Au lieu de répéter les déclarations un
nombre de fois, une boucle For Each...Next répète un groupe de déclarations pour chaque élément
d’une collection d’objets ou pour chaque élément d’un tableau. Cette déclaration s’avère
particulièrement utile si vous ne savez pas combien d’éléments comporte une collection.

Dans l’exemple de code HTML suivant, le contenu d’un objet Dictionary est utilisé pour insérer du texte
dans plusieurs zones de texte.
<HTML>

<HEAD><TITLE>Formulaires et éléments</TITLE></HEAD>

<SCRIPT LANGUAGE='VBScript'>

<!--

Sub cmdChange_OnClick
Dim d 'Créer une variable

Set d = CreateObject('Scripting.Dictionary')

d.Add '0', 'Athen' 'Add some keys and items

d.Add '1', 'Belgrade'


d.Add '2', 'Le Caire'

For Each I in d

Document.frmForm.Elements(I).Value = D.Item(I)
Next

146 | 154
PCE : Process Control Engine

End Sub

-->

</SCRIPT>

<BODY>

<CENTER>
<FORM NAME='frmForm'

<Input Type = 'Text'><p>

<Input Type = 'Text'><p>


<Input Type = 'Text'><p>

<Input Type = 'Text'><p>

<Input Type = 'Button' NAME='cmdChange' VALUE='Cliquez ici'><p>

</FORM>
</CENTER>

</BODY>

</HTML>

6.3.7 Types de procédures

6.3.7.1 Procédures Sub


Une procédure Sub est une série de déclarations VBScript (délimitée par des déclarations Sub et End
Sub) qui exécutent des actions, mais ne renvoient aucune valeur. Une procédure Sub peut avoir des
arguments (constantes, variables ou expressions qui lui sont passées par la procédure appelante). Si une
procédure Sub n’a pas d’argument, sa déclaration Sub doit inclure une parenthèse ouvrante et une
parenthèse fermante ().

La procédure Sub suivante utilise deux fonctions VBScript intrinsèques (ou intégrées), MsgBox et
InputBox, pour inviter l’utilisateur à saisir des informations. Elle affiche ensuite les résultats d’un calcul
basé sur ces informations. Le calcul est exécuté dans la procédure Function créée à l’aide de VBScript. La
procédure Function est sera présentée après l’exposé suivant.
Sub ConvertTemp()
temp = InputBox('Veuillez entrer la température en degrés F.', 1)
MsgBox 'La température est de ' & Celsius(temp) & ' degrés C.'
End Sub

6.3.7.2 Les procédures 'Function'

147 | 154
PCE : Process Control Engine

Une procédure Function est une série d’instructions VBScript inclue entre les mots-clés Function et End
Function. Une procédure Function est similaire à une procédure Sub mais en plus elle renvoie une
valeur. Une procédure Function peut avoir des arguments (constantes, variables ou expressions qui lui
sont passées par la procédure appelante). Si une procédure Function n’a pas d’argument, sa déclaration
Function doit inclure une parenthèse ouvrante et une parenthèse fermante. Une Function renvoie une
valeur en affectant une valeur directement dans le nom de la fonction dans une instruction de la
procédure. Le type de la valeur renvoyée par une Function est toujours un Variant.

Dans l’exemple suivant, la fonction Celsius fait la conversion en degrés Celsius d’une valeur en degrés
Fahrenheit. Lorsque la fonction est appelée depuis la procédure ConvertTemp Sub, une variable
contenant la valeur de l'argument est transmise à la fonction.Le résultat du calcul est renvoyé à la
procédure appelante et affiché dans une zone de message.
Sub ConvertTemp()
temp = InputBox('Veuillez entrer la température en degrés F.', 1)
MsgBox 'La température est de ' & Celsius(temp) & ' degrés C.'
End Sub

Function Celsius(fDegres)
Celsius = (fDegres - 32) * 5 / 9
End Function

6.3.7.3 Insertion ou extraction de données dans les procédures

Chaque fragment de données est transmis à vos procédures à l’aide d’un argument. Les arguments
servent d’opérateurs pour les données que vous souhaitez intégrer à votre procédure. Lorsque vous
créez une procédure à l’aide de la déclaration Sub ou de la déclaration Function, vous devez inclure des
parenthèses après le nom de la procédure. Les éventuels arguments doivent être insérés entre ces
parenthèses, séparés par des virgules. Par exemple, dans l’exemple suivant, fDegrees est un opérateur
représentant la valeur transmise à la fonction Celsius aux fins de la conversion.
Function Celsius(fDegres)
Celsius = (fDegres - 32) * 5 / 9
End Function

6.3.7.4 Utilisation des procédures Sub et Function dans le code

Dans du code, une procédure Function doit toujours être insérée à droite d’une attribution de variable
ou dans une expression.

Exemples :

148 | 154
PCE : Process Control Engine

Temp = Celsius(fDegrees)

ou
MsgBox 'La température est de ' & Celsius(temp) & ' degrés C.'

Pour appeler une procédure Sub depuis une autre procédure, saisissez le nom de la procédure avec des
valeurs pour les éventuels arguments nécessaires, en séparant chaque valeur par une virgule. La
déclaration Call n’est pas requise, mais si vous l’utilisez, vous devez insérer les éventuels arguments
entre parenthèses.

L’exemple suivant présente deux appels de procédure MyProc. Dans un cas, la déclaration Call est
insérée dans le code, mais pas dans l’autre. Les deux appels renvoient le même résultat.
Call MyProc(premierarg, secondarg)
MyProc premierarg, secondarg

6.3.8 Conventions de codage


Les conventions de codage sont des suggestions destinées à vous aider dans l’écriture de vos scripts
utilisant Microsoft Visual Basic Scripting Edition.

Les conventions de codage peuvent inclure les points suivants :


Conventions de nommage des objets, variables, et
procédures

Conventions pour les commentaires

Formatage du texte et règles d’indentation

La raison principale pour l’utilisation d’un jeu de conventions cohérent est de standardiser la structure et
le style du codage pour un script ou un groupe de scripts de façon à ce que vous et d’autres personnes
puissiez lire et comprendre le code facilement. Utiliser de bonnes conventions de codage permet d’avoir
un code source clair, précis et lisible, qui est cohérent avec les conventions d’autres langages et intuitif.

6.3.8.1 Conventions de nommage constantes


Les versions antérieures de VBScript ne comportaient aucun mécanisme autorisant la création de
constantes définies par l’utilisateur. Les constantes, le cas échéant, étaient mises en œuvre sous forme
de variables et se distinguaient des autres variables par l’utilisation de caractères en majuscules.
Plusieurs mots étaient séparés à l’aide du caractère "tiret bas" (_).

Exemples :

USER_LIST_MAX
NEW_LINE

149 | 154
PCE : Process Control Engine

Bien que cette manière de nommer les constantes fonctionne toujours, vous pouvez utiliser une autre
méthode de dénomination. Vous pouvez créer des constantes réelles à l’aide de l’instruction Const.
Cette convention utilise un format à casse mixte, dans lequel les noms de constantes comportent le
préfixe "con".

Par exemple :

conYourOwnConstant

6.3.8.2 Conventions de nommage des variables


Pour améliorer la lisibilité et la cohérence de vos scripts, utilisez le récapitulatif suivant et des noms
descriptifs pour les variables de votre code VBScript.
Sous-type Préfixe Exemple

Booléen bln blnTrouve

Octet byt bytDonneeBrute

Date (Time) dtm dtmDebut

Double dbl dblTolerance

Erreur err errNumOrdre

Entier int intQuantite

Long lng lngDistance

Objet obj objCourant

Single sng sngMoyenne

Chaîne str strPrenom

6.3.8.3 Portée des variables


Les variables doivent toujours être définies avec la plus petite portée possible. Les variables des scripts
VB peuvent avoir les portées suivantes.
Plage valide Déclaration Visibilité

Niveau procédure Event, Function ou Sub. Visible dans la procédure dans


laquelle elle est déclarée.

Niveau script Section HEAD d’une page HTML, Visible dans chaque procédure du

150 | 154
PCE : Process Control Engine

Plage valide Déclaration Visibilité


en dehors de toute procédure. script.

6.3.8.3.1 Préfixes des portées des variables


Lorsque vos scripts grossissent, il peut devenir difficile de différentier rapidement la portée des variables
utilisées. Une lettre préfixe, identifiant la portée et précédant le préfixe concernant le type, peut être
utilisée, sans augmenter trop la longueur des noms de variables.
Plage valide Préfixe Exemple

Niveau procédure Aucun( dblVitesse


e)

Niveau script s sblnCalcEnCours

6.3.8.4 Noms de variables et de procédures


Dans les noms de variable ou de procédure, les majuscules peuvent être utilisées. Le nom doit être
assez long pour décrire l’utilisation de la variable. En plus, les noms de procédure devraient commencer
par un verbe, par exemple, InitTableau ou FermerDialogue.

Pour les termes fréquemment utilisés ou les termes longs, des abréviations standard sont
recommandées pour garder une longueur de nom raisonnable. En général, les noms de variable
supérieurs à 32 caractères sont difficiles à lire. Si vous utilisez des abréviations, faites en sorte d’utiliser
toujours les mêmes et de façon cohérente dans tout le script. Par exemple, utiliser tantôt Cnt ou tantôt
Count dans un même script peut engendrer une certaine confusion.

6.3.8.5 Conventions de nommage des objets


La table suivante liste les conventions recommandées pour les objets lors de la programmation en
VBScript.
Type d’objet Préfixe Exemple

Panel 3D pnl pnlGroup

Bouton animé ani aniboîteMail

Check box chk chkLectureSeule

Combo box, liste déroulante cbo cboAnglais

151 | 154
PCE : Process Control Engine

Type d’objet Préfixe Exemple

Bouton commande cmd cmdQuitter

Dialogue dlg dlgOuvertureFichier

Cadre fra fraLangue

Barre de défilement horizontale (scrollbar) hsb hsbVolume

Image img imgIcone

Intitulé lbl lblMessageAide

Ligne lin linVerticale

Liste lst lstCodes

Spin spn spnPages

Texte txt txtNom

Barre de défilement verticale (scrollbar) vsb vsbTaux

Réglette sld sldEchelle

6.3.8.6 Conventions pour commenter le code


Chaque procédure devrait commencer par un bref commentaire décrivant le but de la procédure. Cette
description ne doit pas entrer dans les détails de la mise en œuvre (comment les opérations sont
exécutées), car ceux-ci peuvent éventuellement évoluer avec le temps. Ceci pourrait engendrer des
efforts de maintenance sur les commentaires et - pire encore - conduire à des commentaires faux. Le
code lui-même et des commentaires entre les lignes de code décrivent l’implémentation.

Les arguments passés à une procédure doivent être décrits lorsque leur rôle n’est pas évident et lorsque
la procédure s’attend à ce qu’ils soient dans une plage de valeurs spécifique. Les valeurs renvoyées par
les fonctions et les variables qui sont modifiées par une procédure, particulièrement avec des arguments
passés par référence, doivent aussi être décrites au début de la procédure.

Les commentaires en en-tête de procédure doivent inclure les sections suivantes. Par exemple, voir la
section "Formater votre code" qui suit.
Section en-tête Commentaire

But Ce que fait la procédure (et non pas comment elle le fait).

Hypothèses Liste des effets de la procédure sur chaque variable externe,


contrôle ou autre élément.

152 | 154
PCE : Process Control Engine

Section en-tête Commentaire

Effets Liste des effets de la procédure sur chaque variable externe,


contrôle ou autre élément.

Entrées Explication de chaque argument qui n’est pas évident. Chaque


argument doit apparaître sur une ligne différente.

Valeurs renvoyées Explication de la valeur renvoyée.

Points à se rappeler :
Chaque variable importante doit contenir un commentaire sur son utilisation dans sa
ligne de déclaration.

Les variables, contrôles et procédures doivent être nommés clairement de façon à fournir une
auto-documentation ; ainsi seuls les éléments complexes nécessitent un commentaire détaillé.

Au début du script, vous devriez inclure un descriptif global, énumérant les objets, procédures,
algorithmes, boîtes de dialogue et dépendances système. Parfois, quelques lignes de
pseudocode peuvent aider à comprendre un algorithme.

6.3.8.6.1 Mise en forme du code


L’espace écran doit être économisé autant que possible, mais tout en permettant que le formatage du
code reflète la structure logique et l’imbrication. Voici quelques suggestions :
 Indenter les blocs imbriqués de 4 espaces.
 Indenter les commentaires généraux des procédures de 1 espace.
 Les instructions du niveau le plus haut, suivant directement le commentaire général, doivent
être indentées de 4 espaces. Chaque bloc imbriqué suivant doit, à son tour, être indenté de 4
espaces.

Exemple :

Le code suivant respecte les conventions de codage du VB script.


 ' But : Recherche la 1ère occurrence de l’utilisateur donné dans UserList.
 Entrées : strUserList() : liste d’utilisateurs dans laquelle il faut chercher.
 strZielUser : nom de l’utilisateur recherché.
 Valeurs retournées : Index de la première occurrence de strTargetUser dans strUserList.
Si l’utilisateur recherché n’est pas trouvé, retourne -1. -1/
Function intFindUser (strUserList(), strTargetUser)
Dim i ' Compteur de boucles.

153 | 154
Modèle d'objet

Dim blnFound ' Drapeau 'cible trouvée'.


intFindUser = -1
i = 0 ' Initialiser le compteur de boucles
Do While i <= Ubound(strUserList) and Not blnFound
If strUserList(i) = strTargetUser Then
blnFound = True ' Définir le drapeau surTrue
intFindUser = i ' Définir la valeur renvoyée sur le nombre de boucles
End If
i = i + 1 ' Increment loop counter
Loop
End Function

7 Modèle d'objet
Ici, vous trouverez les guides de zenon Object Model. Ils sont disponibles pour les Add-Ins, ainsi que
pour VBA, VSTA et l'interface COM externe.

La toute dernière version est disponible en ligne à l'adresse : https://onlinehelp.copadata.com


(https://onlinehelp.copadata.com).

154 | 154

Vous aimerez peut-être aussi