Verwendung von NiceLabel .NET API

NiceLabel .NET API referenzieren

Um die NiceLabel Druck-Engine in Ihre Anwendung einzubinden, müssen Sie einen Verweis auf die Assembly SDK.NET.Interface.dll erstellen. Die Datei befindet sich normalerweise im Ordner c:\Program Files\NiceLabel\NiceLabel 10\\bin.net\.

Wir empfehlen Ihnen, die Dateien von NiceLabel .NET API in einem anderen Ordner zu speichern als die ausführbare Datei Ihrer Anwendung. Nachdem Sie den Verweis auf SDK.NET.Interface.dll erstellt haben, können Sie die .dll-Datei in den bin-Ordner Ihrer Anwendung kopieren.

Etikettendesign

NiceLabel .NET API Komponenten haben keine Etikettendesign-Funktionen und keine Benutzeroberfläche. NiceLabel .NET API ist ein Druckmodul, das in andere Anwendungen eingebettet wird.

Die Etikettenvorlagen, welche die NiceLabel Druck-Engine zum Drucken verwendet, müssen in NiceLabel erstellt werden Desktop Designer. Dabei handelt es sich um das Etikettendesign-Tool, um das grafische Layout von Etikettenvorlagen, Objekteigenschaften und variablen Feldern zu erstellen.

Verwenden Sie NiceLabel Desktop Designer, um Ihre Etikettenvorlagen zu erstellen, und verwenden Sie NiceLabel .NET API, um Benutzerdaten zusammenzuführen und den Etikettendruck zu verwalten.

Typische Aufgaben im Rahmen des Workflows

Druck-Engine-Management

Alle Funktionen von NiceLabel .NET API werden über die NiceLabel.SDK.IPrintEngine-Schnittstelle freigelegt.

Wenn Ihre Anwendung auf die Assembly SDK.NET.Interface.dll verweist, kann die Anwendung auf die statische Klasse PrintEngineFactory zugreifen. Bevor andere Eigenschaften verwendet werden können, muss die Anwendung die Eigenschaft SDKFilesPath einstellen. Das ist notwendig, damit die Bibliothek auf die NiceLabel .NET API Dateien zugreifen kann, die sich an verschiedenen Speicherorten befinden können.

Nachdem der Speicherort bekannt ist, kann die Anwendung die IPrintEngine-Schnittstelle durch Zugriff auf die Eigenschaft PrintEngineFactory.PrintEngine abrufen.

Nach Abruf der PrintEngine muss ein Aufruf der Initialize()-Methode der ausgegebenen IPrintEngine-Instanz durchgeführt werden.

IPrintEngine printEngine = PrintEngineFactory.PrintEngine;
printEngine.Initialize();

Vor dem Beenden der Anwendung sollte die Shutdown()-Methode der IPrintEngine-Instanz aufgerufen werden, um alle von der Bibliothek verwendeten Ressourcen freizugeben.

Etikettenvorlagen-Management

Mit der Methode OpenLabel() kann Ihre Anwendung verwalten, auf welche Vorlagen Ihre Benutzer zugreifen können. Vorlagen können aus dem Dateisystem Ihrer Clients oder aus System.IO.Stream Objekten für Benutzer geöffnet werden, die sie in ihre Anwendung einbetten oder in einer Datenbank verwalten möchten.

Control Center Benutzer können Etikettendateien im Dokumentenspeicher verwalten.

Druckermanagement

Die NiceLabel Druck-Engine stellt Ihren Anwendungen eine Liste lokal verfügbarer Druckertreiber zur Verfügung und reduziert den Programmieraufwand.

Die Druckerauswahl folgt der Hierarchie:

  1. Die Eigenschaft Druckername.

  2. Der in Ihrer Etikettenvorlage gespeicherte Druckername.

  3. Der Standard-Systemdrucker.

Anmerkung

Grafische Vorschau und digitale Archivierung

NiceLabel .NET API-basierte Anwendungen verwenden die gleiche Druck-Engine für die Vorschau und den Druck, so dass die grafische Vorschau Ihrer Etiketten identisch mit den gedruckten Etiketten ist.

Mit der GetLabelPreview()-Methode kann Ihre Anwendung eine grafische Vorschau des nächsten zu druckenden Etiketts abrufen.

Die PrintToGraphics()-Methode erzeugt eine Reihe von Bildern aller Etiketten, die gedruckt werden sollen. Auf diese Weise können Sie mit Konzeptproben arbeiten.

Etikettendruck

Mit der NiceLabel Technologie können Sie auf jedem Drucker mit einem Windows-Treiber drucken. Die NiceLabel Druckausgabe bietet außerdem Druckerbefehle für mehr als 4000 verschiedene Druckermodelle, so dass Sie native Druckerfunktionen wie interne Barcodes, Schriftarten und Zähler nutzen können.

NiceLabel .NET API bietet drei verschiedene Druckmodi:

  • Synchrones Drucken. Dieser Modus hält eine Verbindung zum Druckvorgang aufrecht. In diesem Modus sendet die Anwendung Daten an den Druckprozess und hält die Verbindung so lange aufrecht, wie der Druckprozess aktiv ist. Ein Aufruf der Print()-Methode gibt Feedback zum Druckauftrag aus.

  • Asynchrones Drucken. Dieser Modus verarbeitet den Druckauftrag in seinem eigenen Thread. Dies steigert die Leistung und die Anzahl von Druckaufträgen, die in einem bestimmten Zeitraum verarbeitet werden können. Wenn Sie die PrintAsync()-Methode verwenden, wird der aufrufende Benutzer nicht anhand von Event-Handlern informiert, wenn sich der Status des Druckvorgangs ändert.

  • Sitzungsdruck. Verwenden Sie diese Option, wenn Sie Ihre Druckaufträge nicht unterbrechen wollen oder wenn Sie verschiedene Etiketten auf einer einzigen Seite drucken wollen. NiceLabel ermöglicht dies mit dem Sitzungsdruck.

    Alle Etiketten innerhalb einer Sitzung werden als einzelner Druckauftrag an den Drucker gesendet, um die richtige Druckreihenfolge zu garantieren.

    Jede Drucksitzung besteht aus drei Phasen:

    1. StartSessionPrint() initialisiert eine neue Drucksitzung.

    2. SessionPrint() fügt eine Druckanforderung zur aktuellen Sitzung hinzu und kann mehrfach aufgerufen werden.

    3. EndSessionPrint() beendet die aktuelle Sitzung.

Druckauftragsüberwachung

Mit NiceLabel .NET API können Sie den Druckvorgang durch Aktualisierungen des Druckauftragsstatus überwachen, unabhängig von dem von Ihnen gewählten Etikettendruckmodus. Dank dieses umfassenden Zugriffs auf Ihren Druckvorgang können Sie auf jede Situation angemessen reagieren.

Ausnahmebehandlung

Alle Ausnahmen von der NiceLabel Druck-Engine sind vom Typ SDKException. Diese Klasse enthält detaillierte Informationen über eventuell auftretende Fehler.

Druckprotokollierung

Control Center Benutzer können Druckereignisse von jedem Client in der Datenbank von Control Center protokollieren. Sie können die gesammelten Informationen über die zentrale Weboberfläche von Control Center überprüfen.

Weitere Details finden Sie in der NiceLabel .NET API Programmier-Referenz.