XLR8 LabVIEW-Toolkit Schnellanleitung

Transkript

1 XLR8 LabVIEW-Toolkit Schnellanleitung DATA AHEAD XLR8 ist ein Toolkit für NI LabVIEW um Microsoft Excel - Dateien zu lesen, zu bearbeiten und zu schreiben. XLR8 eignet sich sehr gut zum Austausch von Parametern sowie zum Erzeugen, Bearbeiten und Formatieren von Prüfberichten. XLR8 LabVIEW-Toolkit Schnellanleitung... 1 Was ist XLR8?... 2 Unterstützte Funktionalität... 2 Deployment... 3 Anforderungen... 3 Erstellen einer.exe... 3 Sicherheitshinweis... 3 Installation von XLR Kurzbeschreibung des Microsoft Excel Tabellen-Formats... 5 Aktivierung von XLR Erste Schritte... 9 Eine neue xls / xlsx -Datei schreiben... 9 Lesen einer bestehenden Datei... 9 Die XLR8 API Arbeitsmappe (Palette Workbook ) Arbeitsblatt (Palette Sheet ) Lesefunktionen (Palette Read ) Schreibfunktionen (Palette Write ) Formatierungs-Funktionen (Palette Edit Sheet ) Formatting Utilities Anwendungen / Beispiele ( Write to xls file.vi, LabVIEW-Beispielsuche) Support und Feedback VI Übersicht (LabVIEW) XLR8 SCHNELLANLEITUNG 1

2 Was ist XLR8? XLR8 ist eine API ( Application Programming Interface, Programmierschnittstelle), die eine große Zahl von Lese- und Schreibfunktionen für Microsoft Excel -Dateien bietet. Zweck ist der Einsatz in typischen Mess- und Prüfapplikationen. Dazu bietet XLR8 eine nützliche Auswahl von typischen Funktionen einer Tabellenkalkulation. XLR8 nutzt eine vielfach eingesetzte und gut getestete Bibliothek NPOI 2.1 zur Bearbeitung von xls und xlsx -Dateien. Dennoch kann DATA AHEAD keine vollständige Kompatibilität zu beliebigen xls - und xlsx -Dateien gewährleisten. Wie bei jeder handelsüblichen Software, ist der umsichtige Einsatz von XLR8 angeraten, um Datenverlust auszuschließen. Sichern Sie Ihre wichtigen Daten regelmäßig. Für jeglichen Datenverlust, der möglicherweise durch den Einsatz von XLR8 entsteht, kann DATA AHEAD nicht haftbar gemacht werden. Unterstützte Funktionalität - Microsoft Excel XLSX-Dateiformat - Microsoft Excel XLS-Dateiformat - Lesen, Schreiben und Bearbeiten von Dateien - Zell-Typen: Strings, Zahlen, Datum, Formeln - Zell-Formatierungs-Möglichkeiten: o Schriftart (Name, Stil, Farbe) o Zellfarbe o Zellrahmen (Stil, Farbe) o Datentyp (Text, Datum, Zahl) - Arbeitsblatt-Formatierung: o Zeilen / Spalten Breite / Höhe Gruppieren Verbinden Verstecken Zeilen einfügen (inkl. Erhalt der Formatierung) Löschen o Zellen löschen o Arbeitsblätter aufteilen o Zoom, Anzeige der Gitterlinien o Kopfzeile / Fußzeile für den Ausdruck 2 XLR8 SCHNELLANLEITUNG

3 Deployment Anforderungen Folgende Anforderungen sollten vor dem Einsatz des XLR8 gegeben sein: - Zur Verwendung der erstellten.exe wird eine Labview Runtime Engine benötigt, die unter zum Download bereit gestellt ist - Auf dem Zielrechner muss eines der folgenden Betriebssysteme ausgeführt werden o Windows XP SP3 o Windows 7 o Windows 8 - Microsoft.NET Framework 2.0 oder neuer ist erforderlich o Beachten Sie, dass.net 4.0 nicht die Version.NET 2.0 enthält! o Überprüfen Sie bei der.net 3.5 Installation unter Windows XP, dass.net 2.0 mit installiert wird, unter neueren Betriebssystemen wird Erstellen einer.exe XLR8 fügt die Abhängigkeiten der vi.lib automatisch hinzu, überprüfen Sie hierzu ob die benötigten Dateien vorhanden sind - ICSharpCode.SharpZipLib.dll - NPOI.dll - NPOI.OOXML.dll - NPOI.OpenXML4Net.dll - NPOI.OpenXMLFormats.dll - XLR8.lvlib Soll kein Installer erstellt werden, vergewissern Sie sich, dass die Bibliotheksdateien dieses Ordners mit der Application.exe unter C:\Program Files (x86)\national Instruments\LabVIEW xxxx\vi.lib\data AHEAD\XLR8\lib zu finden sind. Sicherheitshinweis Es wird grundsätzlich empfohlen Dateien, die Sie mit XLR8 bearbeiten möchten, zu sichern. Die fehlerhafte Verwendung der XLR8-API oder der Ausfall von Software oder Hardware kann zu korrupten Dateien und Datenverlust führen! XLR8 SCHNELLANLEITUNG 3

4 Installation von XLR8 Die einfachste Art XLR8 zu installieren, ist über das National Instruments Tools Network bzw. den JKI VI Package Manager(Bild 1). Beachten Sie, dass zur Installation über den JKI VI Package Manager die Version erforderlich ist. Suchen Sie nach XLR8 und wählen Sie Install&Upgrade Packages um XLR8 Ihrer LabVIEW-Installation hinzuzufügen. Bild 1: JKI Package Manager zur Installation von XLR8 Nach erfolgter Installation wird eine neue Palette der LabVIEW-Funktionspalette im Blockdiagramm hinzugefügt (Bild 2). Diese ist unter Programmierung zu finden. Bild 1: XLR8 - Palette in "Programmierung" 4 XLR8 SCHNELLANLEITUNG

5 Zudem werden Beispiele installiert und in der LabVIEW-Beispielsuchmaschine integriert. Wählen Sie dazu in LabVIEW das Menü Hilfe -> Beispiele suchen (Bild 3). In der Beispielsuche finden Sie die Programme unter dem Suchbegriff XLR8. Bild 2: XLR8 - Programm-Beispiele in der NI Beispielsuche Kurzbeschreibung des Microsoft Excel Tabellen-Formats = file-name.xlsx Daten Blatt 3 1 Blatte 1 Blatt 1 Arbeitsmappe Bild 4: xlsx-arbeitsmappe Eine Arbeitsmappe ( Workbook ) ist eine Tabellenkalkulationsdatei, die eine Zahl von Arbeitsblättern ( Sheets ) beinhaltet. Im Tabellen- Kalkulations-Programm können Sie zwischen Sheets durch Auswahl des dazugehörigen Reiters wechseln. XLR8 SCHNELLANLEITUNG 5

6 Aktivierung von XLR8 Nach erfolgreicher Installation steht Ihnen der volle Funktionsumfang von XLR8 für 30 Tage zur Verfügung. Nach Ablauf dieser Frist muss XLR8 in LabVIEW aktiviert werden. Die hierfür benötigten Zugangsdaten (License ID und Password) werden Ihnen per mitgeteilt. Um die Aktivierung erfolgreich durchführen zu können wird ein Internetzugang benötigt. Ist auf dem Prüfrechner selbst keine Internetverbindung vorhanden, kann dies über einen anderen Rechner mit Internetzugang und Browser erfolgen (zweite Option in Schritt 3). Schritt 1: Öffnen Sie LabVIEW und gehen Sie in der Menüzeile unter Help auf Activate Add-ons. Bild 5: Aktivierung Schritt 1 Schritt 2: Nun erscheint Ihre XLR8-Installation. Klicken Sie auf DATA AHEAD XLR8 x.x.x.x und anschließend auf Next. Bild 6: Aktivierung Schritt 2 6 XLR8 SCHNELLANLEITUNG

7 Schritt 3: In folgendem Fenster muss die Methode zur Aktivierung gewählt werden. Wenn an dem Rechner ein Internetzugang vorhanden ist, wählen Sie die erste Option und klicken auf Next andernfalls führen Sie Schritt 3 (Alternative) und Schritt 4(Alternative) auf der folgenden Seite aus. Bild 7: Aktivierung Schritt 3 Schritt 4: Abschließend geben Sie die Ihnen per zugesandten Aktivierungsdaten in die dafür vorgesehenen Felder ein und bestätigen mit Activate. Achten Sie hierbei auf Groß- und Kleinschreibung. Bild 8: Aktivierung Schritt 4 XLR8 SCHNELLANLEITUNG 7

8 Schritt 3 (Alternative): Soll XLR8 an einem Rechner ohne bestehender Internetverbindung aktiviert werden wählen Sie die aufgeführte Option aus. Führen Sie die nächsten Schritte an einem Computer mit bestehender Internetverbindung aus. Hier werden Sie direkt zur National Instruments Aktivierungs-Webseite weitergeleitet. Auf dieser Webseite müssen Sie unter anderem die angezeigten User Codes, welche in diesem LabVIEW Dialog angezeigt werden, einfügen. Bild 9: Aktivierung Schritt 3, Option 2: Aktivierung mittels Browser LabVIEW Dialog Schritt 4 (Alternative): Öffnen Sie die Webseite auf einem Computer mit Internetzugang. Geben Sie den User Code 1 und User Code 2 ein. Diese Usercodes werden in dem LabVIEW Dialog in Schritt 3 (alternative) angezeigt. Geben Sie die License ID und das Passwort ein, welches Ihnen in der Aktivierung- zu gesendet wurde. Nachdem Sie die Eingaben vorgenommen haben, klicken Sie auf Continue. Die Aktivierungscodes 1 und 2 werden nun generiert und angezeigt. Um die Aktivierung abzuschließen, geben Sie diese Aktivierungscodes im LabVIEW Dialog ein und bestätigen Sie mit Activate. Bild 10: Aktivierung Schritt 3, Option 2 Aktivierung mittels Browser Webseite 8 XLR8 SCHNELLANLEITUNG

9 Erste Schritte Die mitgelieferten Beispiele erleichtern den Einstieg in die Nutzung der XLR8 - API. Sämtliche Beispiele werden mit einer Kurzbeschreibung ausgeliefert und beinhalten Kommentare zu den jeweiligen API-Funktionsaufrufen. Eine neue xls / xlsx -Datei schreiben Um eine einfache Datei im xls / xlsx -Format zu schreiben, öffnen Sie bitte das Beispiel exmpl_wr_new_wb_basic_data.vi (Front Panel und Code s. Bild 5). Wählen Sie eine vorhandene xls / xlsx -Datei oder starten Sie das Programm einfach und legen Sie zur Laufzeit eine neue Datei an. Im Anschluss nutzen Sie Microsoft Excel oder ein kompatibles Tabellenkalkulations- Programm um den Dateiinhalt zu überprüfen. Bild 11: Beispiel für einfaches Schreiben Lesen einer bestehenden Datei Grundlegende Funktionen zum Lesen von Dateiinhalten aus xls -und xlsx -Dateien werden im Beispiel exmpl_r_several_reads.vi gezeigt. Das Beispiel öffnet eine mitgelieferte Datei, die im Ordner <LabVIEW>\examples\XLR8 abgelegt ist. Führen Sie das Beispiel aus und betrachten Sie die Funktionen im Quellcode (Bild 6). Bild 10: Einfaches Lese-Beispiel Die weiteren Beispiele zeigen verschiedene grundlegende sowie fortgeschrittene Funktionen der XLR8 API. Weitere Informationen zu diesen finden Sie in den jeweiligen VI-Beschreibungen. XLR8 SCHNELLANLEITUNG 9

10 Die XLR8 API Arbeitsmappe (Palette Workbook ) Diese VIs beziehen sich auf die Arbeitsmappe, d.h. die *.xls/*.xlsx Tabellen-Datei. Folgende Funktionalität ist abgebildet: VI Name und Beschreibung (Mehr Informationen in der Kontexthilfe) Open Create Workbook.vi Öffnet eine bestehende oder erstellt eine neue Arbeitsmappe. Protect Workbook.vi Schützt eine Arbeitsmappe mit einem Passwort. Save Workbook.vi Speichert eine Arbeitsmappe. Close Workbook.vi Schließt eine Arbeitsmappe. Speichert die Arbeitsmappe optional. Tabelle 1: Funktionen zur Arbeitsmappe Arbeitsblatt (Palette Sheet ) Diese VIs beziehen sich auf das ausgewählte ( current ) Arbeitsblatt, d.h. der Reiter, der im Tabellenkalkulationsprogramm gerade betrachtet wird. Bitte beachten Sie zu diesen Funktionen das Beispiel exmpl_wr_sheet_operations.vi. Create Sheet.vi Erstellt ein neues Arbeitsblatt in der Arbeitsmappe. Copy Sheet.vi Klont das aktuelle ( current ) Arbeitsblatt. Edit Sheet Name.vi Benennt das aktuelle Arbeitsblatt um. Delete Current Sheet.vi Löscht das aktuelle Arbeitsblatt. Get Sheet Names.vi Gibt eine Liste aller Arbeitsblätter der Arbeitsmappe zurück. Hide Sheet.vi Versteckt das aktuelle Arbeitsblatt. Set Current Sheet.vi Legt das aktuelle ( current ) Arbeitsblatt fest. Alle Lese- und Schreib- Operationen beziehen sich grundsätzlich auf das aktuelle Arbeitsblatt Set Sheet Order.vi Platziert das aktuelle ( current ) Arbeitsblatt an eine neue Position in der Arbeitsmappe Tabelle 2: Funktionen zum Arbeitsblatt 10 XLR8 SCHNELLANLEITUNG

11 Lesefunktionen (Palette Read ) Verwenden Sie diese VIs um Daten aus einem bestehenden Arbeitsblatt in einer Arbeitsmappe zu lesen. Abhängig von den gewünschten Daten, wählen Sie eine der folgenden Funktionen. Sehen Sie hierzu auch die Beispiel die mit exmpl_r_... beginnen. Diese nutzen die verschiedenen Lesefunktionen. Read Cell.vi (Polymorphic: Number / Date / String) Liest eine Zelle im gewählten Format. Read Area.vi (Polymorphic: Number / Date / String) Liest einen Bereich im gewählten Format. Read Area (All Types).vi Liest einen Bereich mit beliebigen Daten und liefert Strings zurück. Read Current Sheet.vi Liest ein ausgewähltes Arbeitsblatt vollständig und liefert ein String-Array. Read All Sheets.vi Liest alle Arbeitsblätter der aktuellen Arbeitsmappe vollständig und liefert ein Array von String-Array-Clustern. Read Named Range.vi (Polymorphic: Number / Date / String) Liest einen Namensbereich eines angegeben Layouts aus. Tabelle 3: Lesefunktionen Schreibfunktionen (Palette Write ) Verwenden Sie diese VIs um Daten in bestehende Arbeitsblätter einer Arbeitsmappe einzutragen. Beispiele, die mit exmpl_wr_... beginnen, zeigen verschiedene Schreibfunktionen. Write Cell.vi (Polymorphic: Number / Date / String) Schreibt Daten im gewählten Format in eine Zelle. (Clear Sheet and) Write Area.vi (Polymorphic: Number / Date / String) Löscht optional das Arbeitsblatt. Schreibt einen Datenblock im gewählten Format in den angegebenen Bereich in das Arbeitsblatt. Append Area.vi (Polymorphic: Number / Date / String) Fügt im Arbeitsblatt einen Datenblock im gewünschten Format nach der letzten bestehenden Zeile ein. Write Hyperlink.vi Schreibt einen Hyperlink in eine gewählte Zelle. Write Formula Cell.vi Schreibt eine Formel in eine gewählte Zelle. Write Formula Area.vi Schreibt Formeln in einen angegebenen Bereich von Zellen Append Formula Area.vi Fügt einen Block von Formeln nach der letzten Zeile im Arbeitsblatt hinzu. Write To Named Range.vi (Polymorphic: Number / Date / String) Schreibt in einen angegebenen Namensbereich eines Layouts. Tabelle 4: Schreibfunktionen XLR8 SCHNELLANLEITUNG 11

12 Formatierungs-Funktionen (Palette Edit Sheet ) Verwenden Sie diese VIs um Zelleigenschaften anzupassen, Eigenschaften von Bereichen ( areas ) oder bestimmte Arbeitsblatt-Eigenschaften. Formatting Font Cell.vi Legt die Schriftart und deren Eigenschaften für eine Zelle fest. Font Area.vi Legt die Schriftart für einen Bereich von Zellen fest. Color Cell.vi Legt die Hintergrundfarbe einer Zelle fest. Color Area.vi Legt die Hintergrundfarbe für einen Zell-Bereich fest. Borders Cell.vi Legt die Eigenschaften eines Zellrahmens fest. Borders Area.vi Legt die Eigenschaften von Zellrahmen für einen Zellbereich fest. Frame Area.vi Zieht einen Rahmen um einen ausgewählten Bereich Data Format.vi Legt das Datenformat einer Zelle fest z.b. Zahlendarstellung, Prozent, etc. Data Format Area.vi Legt das Datenformat für einen Zellbereich fest. Row Height.vi Passt die Zeilenhöhe einer bestimmten Zeile fest. Group Row.vi Gruppiert mehrere Zeilen. Hide Row.vi Versteckt die ausgewählte Zeile. Column Width.vi Legt die Breite einer Spalte fest. Group Column.vi Gruppiert mehrere Spalten. Hide Column.vi Versteckt die ausgewählte Spalte. Autosize Column.vi Legt die automatische Breite einer Spalte fest. Wrap Text.vi Umbricht den Text einer gewählten Zelle um die Spaltenbreite einzuhalten. 12 XLR8 SCHNELLANLEITUNG

13 Utilities Merge Cells.vi Verbindet mehrere Zellen zu einer Zelle. Delete Cell.vi Löscht eine Zelle. Erhält auf Wunsch - die Formatierung Insert Row.vi Fügt eine oder mehrere Zeilen ein. Erhält - auf Wunsch - die Formatierung Delete Row.vi Entfernt eine oder mehrere Zeilen. Get Last Row.vi Liefert die letzte Zeilennummer des aktuellen Arbeitsblatts (Null-indexiert) Zoom.vi Zoomt das aktuelle Arbeitsblatt auf die ausgewählte Stufe (z.b. 300%) Display Gridline.vi Schaltet die Anzeige von Gitterlinien um. Pane Freeze.vi Legt die Fenster-Teilung an gewissen Spalten / Zeilen fest. Footer and Header.vi Bearbeitet Fuß- und Kopfzeilen für den Ausdruck. Wipe Area.vi Ersetzt einen Bereich von Zellen durch leere Zellen. Wipe Sheet.vi Löscht alle Daten in einem bestehenden Arbeitsblatt. Create Named Range.vi Erstellt einen Namensbereich auf dem aktuellen Arbeitsblatt Get Named Ranges.vi Liefert alle Namensbereiche als String-Array des aktuellen Arbeitsblatts Insert Image.vi Fügt ein Bild auf dem aktuellen Arbeitsblatt und einer angegebenen Zelle hinzu. Unterstützte Formate: PNG, JPG, EMF, WMF, PICT, DIB XLR8 SCHNELLANLEITUNG 13

14 Anwendungen / Beispiele ( Write to xls file.vi, LabVIEW-Beispielsuche) XLR8 wird mit einer Reihe von funktionsfähigen Beispielen geliefert, die Sie in der LabVIEW-Beispielsuche finden können: LabVIEW: Hilfe -> Beispiele suchen... Suchbegriff XLR8 Write to xls File.vi (Polymorphic: Double / Integer / String) Ersetzt mit gleicher Schnittstelle die Funktionen Write to spreadsheet file bzw. In Tabellenkalkulationsdatei schreiben -VIs der Datei-Palette. exmpl_r_several_reads.vi Diese VI zeigt einige Lesefunktionen. exmpl_r_read_entire_spreadsheet.vi Dieses VI zeigt wie eine vollständige xls/xlsx-datei gelesen wird. exmpl_wr_new_wb_basic_data.vi Dieses VI zeigt übliche API-Aufrufe um eine neue xls/xlsx-datei zu erstellen. exmpl_wr_sheet_operations.vi Dieses VI führt eine Reihe von Arbeitsblatt-Operationen durch. exmpl_wr_cell_writes.vi Dieses VI führt eine Reihe von Schreiboperationen mit verschiedenen Datentypen durch. exmpl_wr_log_time_and_data.vi Dieses VI zeigt wie eine einfache Log-Datei erzeugt werden kann - mithilfe einer Spalte für Zeitinformationen und eines Bereichs für Messdaten. exmpl_wr_template_results.vi Dieses VI zeigt wie eine bestehende Vorlage geladen, ausgefüllt und als Bericht abgespeichert werden kann. Tabelle 5: Anwendungen und Beispiele Support und Feedback Kontaktieren Sie uns unter xlr8@dataahead.de Neuigkeiten und Unterstützung zu unseren Toolkits finden Sie hier: DATA AHEAD GmbH Prinzregentenufer Nürnberg Germany Copyright 2014, DATA AHEAD Microsoft Excel ist ein eingetragenes Warenzeichen von Microsoft 14 XLR8 SCHNELLANLEITUNG

15 VI Übersicht (LabVIEW) XLR8 SCHNELLANLEITUNG 15