EPLA

N El

ectri

c P8

aut

omat

isie

ren

Wei

her

Johann Weiher

EPLAN Electric P8 automatisierenGrundlagen und Beispiele zum Erstellen von Scripten in C#

2., überarbeitete Auflage

Mit sofort

einsetzbaren

Scripten

Johann WeiherEPLAN Electric P8 automatisieren

BLEIBEN SIE AUF DEM LAUFENDEN!

Hanser Newsletter informieren Sie regel mäßig über neue Bücher und Termine aus den ver­schiedenen Bereichen der Technik. Profitieren Sie auch von Gewinnspielen und exklusiven Leseproben. Gleich anmelden unterwww.hanser-fachbuch.de/newsletter

Johann Weiher

EPLAN Electric P8 automatisieren

Grundlagen und Beispiele zum Erstellen von Scripten in C#

2., überarbeitete Auflage

Der Autor:Johann Weiher, Dürnhart

Alle in diesem Buch enthaltenen Informationen wurden nach bestem Wissen zusammengestellt und mit Sorgfalt getestet. Dennoch sind Fehler nicht ganz auszuschließen. Aus diesem Grund sind die im vorliegenden Buch enthaltenen Informationen mit keiner Verpflichtung oder Garantie irgendeiner Art verbunden. Autor und Verlag übernehmen infolgedessen keine Verantwortung und werden keine daraus folgende oder sonstige Haftung übernehmen, die auf irgendeine Weise aus der Benutzung dieser Informationen – oder Teilen davon – entsteht, auch nicht für die Verletzung von Patentrechten, die daraus resultieren können.

Ebenso wenig übernehmen Autor und Verlag die Gewähr dafür, dass die beschriebenen Verfahren usw. frei von Schutzrechten Dritter sind. Die Wiedergabe von Gebrauchsnamen, Handelsnamen, Warenbezeichnungen usw. in diesem Werk berechtigt also auch ohne besondere Kennzeichnung nicht zu der Annahme, dass solche Namen im Sinne der Warenzeichen- und Markenschutz- Gesetz-gebung als frei zu betrachten wären und daher von jedermann benützt werden dürften.

Bibliografische Information der deutschen Nationalbibliothek:

Die Deutsche Nationalbibliothek verzeichnet diese Publikation in der Deutschen Nationalbibliografie; detaillierte bibliografische Daten sind im Internet unter http://dnb.d-nb.de abrufbar.

Dieses Werk ist urheberrechtlich geschützt.

Alle Rechte, auch die der Übersetzung, des Nachdruckes und der Vervielfältigung des Buches, oder Teilen daraus, vorbehalten. Kein Teil des Werkes darf ohne schriftliche Genehmigung des Verlages in irgendeiner Form (Fotokopie, Mikrofilm oder ein anderes Verfahren), auch nicht für Zwecke der Unterrichtsgestaltung, reproduziert oder unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt oder verbreitet werden.

ISBN 978-3-446-45492-7E-Book-ISBN 978-3-446-45712-6ePub-ISBN: 978-3-446-45833-8

© 2018 Carl Hanser Verlag MünchenLektorat: Julia SteppHerstellung: Christin JahnUmschlagkonzept: Marc Müller-Bremer, www.rebranding.de, München Umschlagrealisation: Stephan RönigkSatz: le-tex publishing services GmbHDruck und Bindung: Hubert & Co. GmbH & Co. KG BuchPartner, GöttingenPrinted in Germanywww.hanser-fachbuch.de

Inhalt

1 Einführung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1 Toolbars – der erste Schritt zum Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.1.1 Toolbars anpassen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.1.2 Schaltflächen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.1.3 Schaltflächen mit Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.1.4 Schaltflächen mit externen Programmen belegen . . . . . . . . . . . . . 191.1.5 Verschachtelte Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.1.6 Toolbars importieren und exportieren . . . . . . . . . . . . . . . . . . . . . . . 27

1.2 Einführung in die Programmierung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281.2.1 Was ist eine Entwicklungsumgebung? . . . . . . . . . . . . . . . . . . . . . . . 301.2.2 Projekt in Microsoft Visual C# erstellen . . . . . . . . . . . . . . . . . . . . . 33

2 Scriptfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392.1 Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

2.1.1 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402.1.2 DeclareAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512.1.3 DeclareEventHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542.1.4 DeclareRegister und DeclareUnregister . . . . . . . . . . . . . . . . . . . . . . 552.1.5 DeclareMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

2.2 Actions ausführen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572.2.1 Einzelne Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572.2.2 Mehrere Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602.2.3 Action mit Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642.2.4 Action überladen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

2.3 Klassen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692.3.1 String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702.3.2 Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782.3.3 Float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822.3.4 Fehlerbehandlung – Try und Catch . . . . . . . . . . . . . . . . . . . . . . . . . 84

VI Inhalt

2.3.5 Systemmeldungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882.3.6 Parameterübergabe: String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902.3.7 Parameterübergabe: Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922.3.8 MessageBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932.3.9 Eigene Klasse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

2.4 Programmsteuerung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002.4.1 If-Abfrage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002.4.2 Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052.4.3 Methoden extrahieren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072.4.4 Decider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172.4.5 Action mit Rückgabewert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

2.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242.5.1 String-Setting verändern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242.5.2 Bool-Setting verändern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262.5.3 Integer-Setting verändern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1282.5.4 String-Setting lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1292.5.5 Bool-Setting lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302.5.6 Integer-Setting lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312.5.7 Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322.5.8 Projekteinstellungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

2.6 Menüs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392.6.1 Menüpunkt in Dienstprogramme . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392.6.2 Bestehendes Menü erweitern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422.6.3 Hauptmenü mit einem Untermenüpunkt . . . . . . . . . . . . . . . . . . . . 1442.6.4 Bestehendes Menü mit Popup-Menü erweitern . . . . . . . . . . . . . . . 1452.6.5 Hauptmenü mit Popup-Menü . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1462.6.6 Menüpunkt in Kontextmenü . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

2.7 Progressbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522.7.1 SimpleProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522.7.2 EnhancedProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

2.8 Formulare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1582.8.1 Vorlage erstellen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1582.8.2 Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1642.8.3 Checkbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692.8.4 Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1722.8.5 TabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1732.8.6 Progressbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742.8.7 Mauszeiger ändern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1762.8.8 ListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

2.9 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Inhalt VII

3 Schnittstellen programmierung . . . . . . . . . . . . . . . . . . . . . . . . . . 1993.1 Externe Programme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

3.1.1 Prozess ausführen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993.1.2 Unterschiedliche Prozesse ausführen . . . . . . . . . . . . . . . . . . . . . . . 201

3.2 Dateien und Ordner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2063.2.1 Ordner prüfen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2063.2.2 Dateien prüfen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2073.2.3 Dateien löschen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2093.2.4 Dateien mit Datumsstempel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

3.3 Dateien öffnen und speichern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2113.3.1 SaveFileDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2113.3.2 OpenFileDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2143.3.3 Dateinamen überprüfen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173.3.4 FileSelectDecisionContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

3.4 Dateien schreiben . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223.4.1 Beschriftung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223.4.2 Beschriftung mit Überprüfung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2283.4.3 PDF beim Schließen erzeugen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2343.4.4 Textdatei schreiben . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2393.4.5 XML-Datei schreiben . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

3.5 Dateien lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453.5.1 Textdatei lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453.5.2 XML-Datei lesen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2513.5.3 XML-Datei lesen (eigene Klasse) . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

3.6 Befehlszeile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2603.6.1 Allgemeine Befehlszeilenparameter . . . . . . . . . . . . . . . . . . . . . . . . . 2603.6.2 Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

3.7 EplanRemoteClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

4 Praxisbeispiele . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2694.1 Compress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

4.2 ChangeLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

4.3 Edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

4.4 ExecuteScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

4.5 Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

4.6 ProjectAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

4.7 XEsSetProjectPropertyAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

4.8 Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

VIII Inhalt

4.9 Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

4.10 ProjectManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

4.11 SelectionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

5 Anhang . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2875.1 Daten zum Buch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

5.2 Internetseiten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Liebe Leserinnen und liebe Leser,

mit diesem Buch möchte ich Ihnen einen einfachen und unkomplizierten Einstieg in die Erstellung von Scripten für EPLAN Electric P8 ermöglichen. Das Buch rich-tet sich an alle EPLAN-Anwender, ganz gleich, ob es sich dabei um regelmäßige oder sporadische Konstrukteure handelt, die mithilfe von Scripting ihre Aufgaben automatisieren wollen. Programmierkenntnisse werden nicht vorausgesetzt. Sie werden erstaunt sein, wie schnell dabei ein Resultat zustande kommt, das Sie be-geistert. Schon mit einem kleinen Script, das aus nur ein paar Zeilen besteht, kön-nen Sie viel Zeit bei der Projektierung sparen. Auf Grundlage der im Buch vermit-telten Informationen werden Sie rasch imstande sein, EPLAN-Aktionen zu verwenden und gegebenenfalls zu erweitern. Darüber hinaus lernen Sie auch, ei-gene Erweiterungen zu programmieren. Scripte können ab der Version EPLAN Electric P8 Compact genutzt werden. Das API-Modul ist dafür nicht erforderlich.

Im Script, wie in der Programmierung selbst, ist vieles, wenn nicht sogar alles, mög-lich. Deshalb stellt sich die Frage, in welchem Umfang dieses Buch das Themenfeld abdecken kann. Die Sprache C#, die ich zum Erstellen der Scripte verwende, ist sehr komplex und mit ihrer Beschreibung allein könnte man mehrere Tausend Seiten füllen, ohne irgendeine EPLAN-Funktion zu erklären. Aus diesem Grund beschränke ich mich darauf, die Grundlagen von C# zu vermitteln, die notwendig sind, um neue Scripte zu erstellen oder bestehende zu erweitern bzw. zu verändern. Auch auf die wichtigsten Erweiterungen durch eigenen Programmcode gehe ich ein.

Alle EPLAN-Aktionen werden anhand von praxisnahen Beispielen beschrieben und erklärt. Viele der Beispiele werden Ihren Workflow beschleunigen. Hinzu kommt, dass mehr Zeit für die wesentlichen Aufgaben, nämlich die der Konstruk-tion, bleibt. Jeder kennt die wiederkehrenden, monotonen Aufgaben, die z. B. beim Projektabschluss anstehen. Viele Auswertungen und Beschriftungen müssen er-zeugt werden, zusätzlich muss der Plan als PDF erstellt werden. All dies können Sie per Knopfdruck erledigen. Wie? Das wird Schritt für Schritt im Buch erklärt.

Vorwort

2 Vorwort

Auf der Internetseite https://eep8a.de finden Sie das komplette Projekt mit allen Beispielen und fertigen Scripten, welche Sie direkt in EPLAN verwen­den können.

An dieser Stelle möchte ich mich recht herzlich bei allen bedanken, die mir gehol-fen haben, dieses Buch zu schreiben.

Allen voran danke ich meiner Frau Daniela für die Motivation, das Buch zu schreiben, und die Unterstützung, um genügend Zeit zu finden. Vielen Dank auch an meine wundervollen Töchter Leni & Fina für die erfreulichen Unterbrechungen und Ablenkungen beim Schreiben.

Großer Dank geht an meinen Chef, Kollegen und Freund Michael Kastl für die Frei-heit, dieses Buch zu schreiben. Es macht einfach Spaß, mit dir zu arbeiten.

Ein besonderer Dank gilt Florian Reiter – hier ist aus einem Berater ein Freund geworden. Ein großes Lob möchte ich auch Herrn Andreas Krämer für die immer sehr guten Hilfestellungen aussprechen.

Zu guter Letzt möchte ich mich bei Julia Stepp vom Carl Hanser Verlag für die Hilfe und Unterstützung bedanken.

Johann Weiher

Dürnhart, im Mai 2018

Was ist Scripting?Scripting bezeichnet die Möglichkeit, einzelne Befehle bzw. Programmcode in EPLAN auszuführen. Dies geschieht über die sogenannte API (Application Program-ming Interface, dt. Programmierschnittstelle). Hinter der EPLAN-API verbergen sich alle Funktionen, die in der Plattform (Electric P8, Fluid, Pro-Panel usw.) vorhanden sind. Diese Programme bauen alle auf dem gleichen Programmcode auf und sind dadurch untereinander kompatibel. In den verschiedenen Applikationen sind ähnli-che bzw. gleiche Funktionen enthalten, z. B. kann man Beschriftungen sowohl in Fluid als auch in Electric P8 erzeugen. Einziger Unterschied ist der Inhalt.

Diese Abläufe werden in EPLAN Actions (Aktionen) genannt. Ihnen ist Ab-schnitt 2.2, „Actions ausführen“, gewidmet, da es mehrere Wege gibt, solche Ac-tions auszuführen. Das Wort Scripting bezieht sich meistens nur auf Scripte, die Sie ab der Ausbaustufe EPLAN Electric P8 Compact nutzen können. Um weitere Befehle oder Funktionen ausführen zu können, benötigen Sie das API-Modul von EPLAN. In diesem Buch gehe ich aber ausschließlich auf den Standardumfang der Compact-Version ein.

Was sind Scripte?Scripte sind kleine Programmcodes. In EPLAN können diese in zwei Programmier-sprachen erstellt werden:

� Microsoft C# (C-Sharp) � Microsoft VB.NET (Visual Basic.NET)

Ich werde in den folgenden Kapiteln nur Beispiele in C# bereitstellen, da EPLAN mit dieser Sprache fertigen Code generiert und dadurch eine optimale Vorlage lie-fert. Ein Script ist nicht alleine ausführbar. Es muss in Verbindung mit EPLAN ge-startet werden.

1 Einführung

4 1 Einführung

Was können Scripte?Scripte können vieles, aber nicht alles. EPLAN stellt eine Reihe von Befehlen be-reit, schränkt diese aber auf einen überschaubaren Bereich ein. Dadurch wird dem Anwender der Einstieg enorm erleichtert. Auf diese Weise wird auch sichergestellt, dass keine ungewollten Aktionen, z. B. auf das Projekt, ausgeführt werden.

Sicherlich kennen Sie die wiederkehrende Aufgabe, Beschriftungen auszugeben. Je Projekt sind mehrere Exporte nötig. Jedes Mal muss das Beschriftungsschema neu ausgewählt, zusätzlich der Ordner benannt und ein Dateiname vergeben werden. Mit einem Script können Sie all diese Arbeitsschritte zusammenfassen und z. B. auf einen Menüpunkt legen. Sie können über diese Funktion auch mehrere Be-schriftungen nacheinander erzeugen. Auch der PDF-Export kann automatisiert werden. Möchten Sie z. B. beim Schließen des Projekts automatisch ein PDF zur Änderungsverfolgung erzeugen? Mit einem Script lässt sich dies problemlos reali-sieren. Sie wollen Schnittstellen schaffen und Informationen außerhalb von EPLAN, z. B. in Ihrem ERP-System, nutzen? Gar kein Problem! Über die Möglich-keiten im Scripting geht das auf Knopfdruck. Oft muss zwischen verschiedenen Einstellungen hin und her gewechselt werden. Das Suchen in den unzähligen Ein-stellungen in EPLAN ist mühselig. Schreiben Sie stattdessen ein Script für Ihre Konfigurationen und erledigen Sie dies unter der Projektierung.

Dies ist eine kleine Auflistung der Möglichkeiten, die mit Scripten realisiert wer-den können:

� Beschriftungen automatisieren � PDF-Export � Backup � Eigene Menüs/Toolbars erstellen � Grafische Formulare, z. B. mit Buttons, Checkboxen und Auswahldialogen, erstel-len

� Eigenschaften verändern � Projekteigenschaften � Seiteneigenschaften

� Einstellungen � Lesen � Schreiben

51.1 Toolbars – der erste Schritt zum Script

Und das sind noch längst nicht alle Funktionen! Durch das Erweitern des Pro-grammcodes können noch mehr Funktionen hinzugefügt werden.

Was kann das API-Modul im Vergleich zum Scripting?Um den Unterschied etwas deutlicher zu machen, finden Sie im Folgenden eine kleine Auflistung der wichtigsten Merkmale des API-Moduls in EPLAN:

� Zugriff auf das komplette EPLAN-Datenmodell � Einfacheres Lesen von Objekten � Zugriff auf mehr Objekte � Direkter Zugriff auf Projekteigenschaften/Projekteinstellungen � Lesen/Schreiben von Daten in der Artikeldatenbank � Mehr verfügbare Actions

 � 1.1 Toolbars – der erste Schritt zum Script

1.1.1 Toolbars anpassen

In EPLAN gibt es die Möglichkeit, eigene Toolbars zu erstellen. Doch was hat das mit Scripting zu tun? Ein Script ist eigentlich eine Erweiterung der Funktionalität einer Symbolleiste. In einer benutzerdefinierten Toolbar können vordefinierte Be-fehle ausgeführt werden. Dies sind alle von EPLAN offiziell unterstützten Actions, welche zudem in der Hilfe dokumentiert sind. Einen Verweis zur Hilfe finden Sie in Kapitel 5. Diese Befehle werden auch in einem Script verwendet. Ein Vorteil des Scripts gegenüber der klassischen Toolbar ist, dass mehrere Actions ausgeführt werden können. In der Symbolleiste müsste man mehrere Schaltflächen erstellen, um zum gleichen Ergebnis zu kommen. Bei der Menge an Möglichkeiten wird der Arbeitsbereich schnell unübersichtlich.

Im Folgenden wollen wir eine neue Toolbar erstellen. Dazu führen wir einen Rechtsklick auf die grafische Oberfläche aus und wählen den Punkt Anpassen … im Kontextmenü an (Bild 1.1).

6 1 Einführung

Bild 1.1  Die Anpassung der Symbolleiste über das Kontextmenü

Nun erscheint das Formular zum Editieren der Toolbars. Im ersten Tab Symbolleis-ten werden alle bestehenden Toolbars aufgelistet. Mit der Checkbox wird ange-zeigt, ob die Toolbar sichtbar ist oder nicht (Bild 1.2).

Deklaration von Steuerelementen:

� Tab: Karteikarte (auch Reiter genannt) � Checkbox: Kästchen, das „an-/abgehakt“ werden kann � Button: Schaltfläche in einem Fenster-Dialog � Toolbar: Symbolleiste

� Icons: Bild-Schaltflächen auf einer Toolbar

71.1 Toolbars – der erste Schritt zum Script

Bild 1.2  Dialog Symbolleisten anpassen

Zusätzlich gibt es Anzeigeeinstellungen:

� Flache Schaltflächen gibt an, wie die einzelnen Icons dargestellt werden. Da sich diese Option in Windows 7/8/10 fast nicht sichtlich auswirkt, stammen die hier gezeigten Icons aus Windows XP:

� Flache Schaltflächen aktiviert

� Flache Schaltflächen deaktiviert � QuickInfo ist der Infotext, der erscheint, wenn man die Maus über die Schaltfläche bewegt. Bei Windows-Programmen wird hier auch oft von Tooltip gesprochen.

Toolbar erstellenZum Erstellen einer Toolbar klicken Sie auf den Button Neu … (Bild 1.3).

Bild 1.3  Neue Toolbar erstellen

Im darauffolgenden Dialog können Sie einen Namen frei vergeben. Ich empfehle immer, die Kundenkennung (KK) voranzustellen, um schnell zu unterscheiden, welche Toolbar selbst erstellt wurde und welche von EPLAN im Standardliefer-umfang enthalten ist (Bild 1.4).

8 1 Einführung

Bild 1.4  Neue Symbolleiste erstellen

Bestätigen Sie den Dialog mit OK, wird die Toolbar im grafischen Editor und in der Liste angezeigt (Bild 1.5).

Bild 1.5  Toolbar ein-/ausblenden

Toolbar löschenIst eine selbst erstellte Toolbar in der Liste selektiert, wird die Funktion Löschen ak-tiviert. Durch einen Klick darauf wird die Toolbar unwiderruflich gelöscht (Bild 1.6).

Bild 1.6  Toolbar löschen

Arbeitsbereich speichernAlle Fensterpositionen und Symbolleisten werden über den sogenannten Arbeits-bereich gespeichert. Hier können Sie, wie gewohnt in EPLAN, verschiedene Schemata anlegen (Bild 1.8). Sie finden den Dialog unter Ansicht > Arbeitsbereich … (Bild 1.7).

Bild 1.7  Arbeitsbereiche verwalten

91.1 Toolbars – der erste Schritt zum Script

Bild 1.8  Dialog Arbeitsbereich

Tabelle 1.1 zeigt, welche Funktionen möglich sind.

Tabelle 1.1 Arbeitsbereich Steuerelemente – Funktionsübersicht

Arbeitsbereich bearbeiten

Neuen Arbeitsbereich anlegen

Arbeitsbereich speichern

Arbeitsbereich kopieren

Arbeitsbereich löschen

Arbeitsbereich importieren

Arbeitsbereich exportieren

Toolbar zurücksetzenIst eine EPLAN-Toolbar selektiert, so wird die Funktion Zurücksetzen aktiv (Bild 1.9). Durch einen Klick hierauf werden alle Schaltflächen entfernt, die nicht in der vordefinierten Toolbar enthalten waren. Zusätzlich werden die vormals gelöschten Schaltflächen wieder hinzugefügt. Diese Funktion ist nur bei EPLAN-Toolbars ver-fügbar.

Bild 1.9  Toolbar zurücksetzen

10 1 Einführung

1.1.2 Schaltflächen

Jetzt haben wir zwar unsere erste Toolbar, aber diese ist noch leer. Wechseln Sie nun in den zweiten Tab Befehle, um die Toolbar zu befüllen (Bild 1.10).

Bild 1.10  Befehle für Symbolleisten

Unter dem Punkt Standard finden Sie fertige Schaltflächen, die sogar eine Bilddatei enthalten, da diese schon in EPLAN-Toolbars enthalten sind. Ziehen Sie die Schalt-fläche Einstellungen (Schraubenschlüssel) mit Drag & Drop auf die noch leere Tool-bar. Es erscheint das für Einstellungen bekannte Icon. Nach Schließen des Dialogs mit OK können Sie diese Action auch per Knopfdruck ausführen. Nun erscheint der gewohnte Dialog der Einstellungen (Bild 1.11).

111.1 Toolbars – der erste Schritt zum Script

Bild 1.11  Einstellungen über die Toolbar öffnen

In EPLAN gibt es unzählige Menüs und Untermenüs. Das viele Klicken kostet Zeit. Wollen Sie eine Funktion, die häufiger benutzt wird, auf die oberste Ebene von EPLAN (Toolbars) setzen, gehen Sie wie folgt vor: Öffnen Sie erneut den Dialog Toolbar anpassen und wechseln in den Tab Befehle. Hier markieren Sie den Listen-eintrag Menü. In der Liste auf der rechten Seite (Schaltflächen) werden nun alle verfügbaren Untermenüpunkte angezeigt.

HINWEIS: Menüpunkte sind abhängig vom Lizenz­ und Modulumfang. Sind Sie z. B. nicht im Besitz des Moduls Revisionsverwaltung, werden die enthal­tenen Menüpunkte nicht angezeigt.

Wenn Sie wissen, wie die Liste aufgebaut ist, finden Sie sich schnell zurecht. In unserer Beispieltoolbar wollen wir die Action Projektdaten > SPS > Adressieren … hinzufügen (Bild 1.12).

12 1 Einführung

Bild 1.12  SPS Adressieren über die Menüleiste

Als Erstes merken wir uns die Menüstruktur in der Menüleiste in EPLAN. Nun muss man sich den Menüpunkt als Pfad vorstellen. Dieser ist in der Liste Schaltflä-chen vorhanden. Am schnellsten erreichen Sie den Eintrag durch Tippen der Buch-staben auf der Tastatur. Dazu markieren Sie einen beliebigen Eintrag in der Liste und tippen „projektdaten“ (Groß- und Kleinschreibung wird nicht beachtet). Die Markierung der Liste springt gleich zum ersten Eintrag (in alphanumerischer Rei-henfolge) des Menüs Projektdaten. Jetzt suchen Sie das Untermenü SPS. Dort fin-den Sie den Menüpunkt Projektdaten:SPS:Adressieren (Bild 1.13).

Bild 1.13  Aktion SPS Adressieren

Die geschachtelten Menüs werden durch einen Doppelpunkt getrennt. Der Name des Eintrags setzt sich wie folgt zusammen:

Menü : Untermenü-1 : Untermenü-2 : Untermenü-n : MenüpunktWie im Beispiel zuvor ziehen wir den Eintrag per Drag & Drop in unsere Toolbar. Je nachdem, ob Sie den Mauszeiger links oder rechts von der bestehenden Schaltflä-che loslassen, wird dieser auch an der jeweiligen Stelle abgesetzt. Anders als zuvor erscheint nun ein weiterer Dialog namens Schaltfläche einstellen (Bild 1.14).

131.1 Toolbars – der erste Schritt zum Script

Bild 1.14  Schaltfläche einstellen

Wir bestätigen beide Dialoge mit OK. Jetzt befindet sich eine zweite Schaltfläche auf unserer Toolbar. Wenn Sie die Maus über das Symbol bewegen, wird die Qui-ckInfo SPS adressieren angezeigt. Dieser Text ist in EPLAN schon vorhanden, da die Action bereits bekannt und fest vergeben ist.

Die Schaltfläche besteht jedoch nur aus dem EPLAN-Logo . Grund dafür ist, dass EPLAN keine Bilddatei für diese Action bekannt ist. Damit es bei mehreren eige-nen Schaltflächen nicht unübersichtlich wird, legen wir eine Bilddatei fest. Dazu öffnen Sie erneut den Dialog Toolbar anpassen und führen einen Doppelklick auf der neu hinzugefügten Schaltfläche aus. Im Dialog Schaltfläche einstellen drücken Sie auf den More-Button (3-Punkte-Knopf). Es öffnet sich ein Dialog zum Aus-wählen eines Bildes. Diese Datei muss folgende Kriterien erfüllen:

� Dateiformate: JPG/BMP � Bildgröße: 16 × 16 Pixel

Bei einer lokalen Installation von EPLAN befinden sich die Bilddateien im Ver-zeichnis C:\Benutzer\Öffentlich\EPLAN\Data\Bilder\KK (Bild 1.15).

Bild 1.15  EPLAN-Stammdaten

14 1 Einführung

Sie können auch schnell ins Standardverzeichnis wechseln, indem Sie einen Rechtsklick auf den Pfad ausführen und auf Auf Standard zurücksetzen klicken (Bild 1.16).

Bild 1.16  Auf Standard zurücksetzen

In den Stammdaten der EPLAN-Installation befindet sich die Bilddatei 0.bmp. Diese wählen Sie mit einem Doppelklick aus oder bestätigen den Dialog mit Öffnen (Bild 1.17).

Bild 1.17  Bilddatei auswählen

Nach Schließen der weiteren Dialoge mit OK sehen Sie nun ein neues Bild in der Toolbar (Bild 1.18). Falls Sie ein anderes Bild wünschen, gibt es im Internet viele Portale mit frei verfügbaren Bildern.

151.1 Toolbars – der erste Schritt zum Script

Bild 1.18  Eigene Toolbar

TrennzeichenIn EPLAN gibt es die Möglichkeit, Trennzeichen in Toolbars einzufügen (Bild 1.19). Dies steigert die Übersichtlichkeit erheblich, da Sie auf diese Weise mehrere Schalt-flächen zusammenfassen können, ohne dafür eigene Toolbars erstellen zu müssen.

Bild 1.19  Eigene Toolbar mit Trennzeichen

Öffnen Sie hierfür den Dialog Toolbar anpassen, und ziehen Sie per Drag & Drop eine Schaltfläche etwas von der nebenan liegenden weg. Sie müssen dabei jedoch mit dem Cursor über der Symbolleiste bleiben, da sonst das Icon in eine andere Toolbar geraten kann. Möchten Sie das Trennzeichen wieder entfernen, machen Sie genau das Gegenteil: Sie ziehen die Schaltfläche näher zur nebenan liegenden.

1.1.3 Schaltflächen mit Parameter

Nun wollen wir uns ein bisschen steigern und fügen eine weitere Aktion hinzu – und zwar Aktionen > Gerät einfügen (Bild 1.20).

Bild 1.20  Action Gerät einfügen

16 1 Einführung

Daraufhin erscheint der schon bekannte Dialog Schaltfläche einstellen. Als Bild wählen wir die Datei 1.bmp. Jetzt sind die beiden weiteren Textfelder QuickInfo und Befehlszeile freigeschaltet (Bild 1.21).

Bild 1.21  Vergeben von QuickInfo- und Befehlszeilentext im Dialog Schaltfläche einstellen

Hinweise

� QuickInfo: Es handelt sich hierbei um einen freien Beschreibungstext für die Schaltfläche. Dieser wird, wie schon aus dem Beispiel SPS Adressieren bekannt, beim Bewegen der Maus über der Schaltfläche angezeigt.

� Befehlszeile: Es handelt sich um den Namen der Action mit Parametern. Der Ausdruck Befehlszeile wird uns das ganze Buch lang begleiten. Er be­zeichnet die Schnittstelle, mit deren Hilfe wir später unseren Programm­code ausführen.

Schauen wir uns das Textfeld Befehlszeile mal etwas genauer an. Auf den ersten Blick steht hier ein sehr kryptischer Text mit vielen Zeichen:

XDLInsertDeviceAction /PartNr:? /PartVariant:1

Aufgeteilt wird die Befehlszeile in zwei Bereiche:

� Actionname: Der Actionname steht immer am Anfang ohne Sonderzeichen. � Parameter: Für eine Aktion kann es einen oder mehrere Parameter geben. Ein Parameter gibt eine Eigenschaft an, die beschreibt, wie die Action ausgeführt werden soll.

171.1 Toolbars – der erste Schritt zum Script

Aufbau der Befehlszeile:

Actionname /Parameter-1:Wert1 /Parameter-2:Wert2 /Parameter-n:Wert-n

HINWEIS: Bitte beachten Sie die genaue Schreibweise! Bei Parameterwer­ten mit Leerzeichen muss der Parameterwert in Anführungszeichen (“ ”) geschrieben werden. Auch die Leerzeichen zwischen den Parametern müs­sen genau eingehalten werden.

� Action: XDLInsertDeviceActionHinter diesem Text verbirgt sich die Funktion, in EPLAN Geräte einzufügen.

� Parameter-1: PartNrDieser Parameter ist für EPLAN erforderlich, da bekannt sein muss, welche Arti-kelnummer eingefügt werden soll.

� Parameter-2: PartVariantDer zweite Parameter gibt an, in welcher Variante der Artikel eingefügt wird (standardmäßig wird dieser Wert auf „1“ gesetzt).

Wir suchen uns ein Beispielgerät, in diesem Falle einen Motorschutzschalter, aus der Artikeldatenbank aus (Bild 1.22). In der EPLAN Beispieldatenbank finden Sie die Artikelnummer SIE.3RV2011-1EA25-0BA0.

Bild 1.22  Beispielgerät Motorschutzschalter in der Artikeldatenbank

18 1 Einführung

Diese Artikelnummer ist nur in einer Variante vorhanden, somit ist PartVariant:1 schon mal richtig. Die Artikelnummer fügen Sie als Wert zum Parameter PartNr: hinzu. Unsere fertige Befehlszeile lautet wie folgt:

XDLInsertDeviceAction /PartNr:“SIE.3RV2011-1EA25-0BA0” /PartVariant:1

Die Anführungszeichen wären nicht nötig, sind aber zu empfehlen, wenn Leerzei-chen möglich sind. Beim Kopieren dieser Befehlszeile können somit Fehler im Vor-feld vermieden werden.

Nach Betätigen der Schaltfläche ist unser eingestellter Motorschutzschalter am Cursor angeheftet und kann nun platziert werden (Bild 1.23).

Bild 1.23  Motorschutzschalter über die Toolbar einfügen

Wurde eine Artikelnummer angegeben, die nicht existiert, erscheint eine entspre-chende Hinweismeldung (Bild 1.24).

Bild 1.24  Fehlermeldung: Artikelnummer nicht gefunden

191.1 Toolbars – der erste Schritt zum Script

1.1.4 Schaltflächen mit externen Programmen belegen

Es gibt auch die Möglichkeit, externe Programme in EPLAN zu integrieren. Dazu öffnen Sie die Einstellung über Optionen > Externe Programme (Bild 1.25).

Bild 1.25  Externe Programme

Im Dialog fügen Sie nun ein neues Programm hinzu. Daraufhin werden mehrere Textfelder freigeschaltet (Bild 1.26). Als Erstes vergeben wir einen Namen für das Programm. Wir möchten die Zeichentabelle von Windows fest in EPLAN einbin-den. Dies erweist sich als praktisch, wenn Sie Sonderzeichen in den Schaltplan einfügen wollen. Zunächst ersetzen Sie (new tool) durch Zeichentabelle. Im darauf-folgenden Textfeld Befehl hinterlegen Sie das Programm (der Name Befehl ist hier unglücklich gewählt, da es sich in den meisten Fällen um ein Programm handelt).

20 1 Einführung

Bild 1.26  Einstellungen Externe Programme

Über den More-Button öffnet sich ein Dialog zum Auswählen der Datei. Hier wäh-len Sie die Datei charmap.exe unter C:\Windows\System32\ aus (Bild 1.27).

Bild 1.27  Zeichentabelle

Im Feld Argumente könnten Sie Parameter des Programmes festlegen, welche wir aber für die Zeichentabelle nicht benötigen. Manche Programme müssen in einem anderen Ordner ausgeführt werden, dies ist aber selten der Fall. Deswegen lassen

211.1 Toolbars – der erste Schritt zum Script

wir das Feld Startverzeichnis auch frei (Bild 1.26). Am Ende muss der Dialog wie in Bild 1.28 aussehen.

Bild 1.28  Fertiges externes Programm Zeichentabelle

Durch das Bestätigen mit OK fügen Sie einen neuen Punkt zum Menü Optionen hinzu (Bild 1.29).

Bild 1.29  Neuer Menüpunkt Zeichentabelle

Nach Betätigen des Menüeintrages wird die Zeichentabelle von Windows geöffnet. Nun ist zwar ein neuer Menüpunkt verfügbar, aber leider noch nicht in der Tool-bar. Darum fügen Sie eine weitere Schaltfläche hinzu (Bild 1.30).