Référencement de NiceLabel .NET API

Pour inclure le moteur d’impression de NiceLabel dans votre application, il faut créer une référence à l’unité SDK.NET.Interface.dll. Le fichier se trouve généralement dans le dossier c:\Program Files\NiceLabel\NiceLabel 10\\bin.net\.

Il est recommandé de garder les fichiers de NiceLabel .NET API dans un dossier distinct du fichier exécutable de votre application. Après avoir fait référence à SDK.NET.Interface.dll, vous pouvez copier le fichier .dll dans la corbeille de votre application.

Création d’étiquettes

Les composants de NiceLabel .NET API n’offrent pas de capacités de conception d’étiquettes et n’ont pas d’interface utilisateur. NiceLabel .NET API est un moteur d’impression qui est intégré dans d’autres applications.

Les modèles d’étiquettes, que le moteur d’impression de NiceLabel utilise pour imprimer, doivent être créés dans NiceLabel Desktop Designer. Cet outil d’édition des étiquettes permet de définir la présentation graphique des modèles d’étiquettes, les propriétés des objets et les champs variables.

Utiliser NiceLabel Desktop Designer pour créer vos modèles d’étiquettes et utiliser NiceLabel .NET API pour fusionner les données d’utilisateur et gérer l’impression des étiquettes.

Flux de travail type

Gestion du moteur d’impression

Toutes les fonctions de NiceLabel .NET API sont disponibles par le biais de l’interface NiceLabel.SDK.IPrintEngine.

Quand elle se réfère à l’unité SDK.NET.Interface.dll, votre application peut accéder à la classe statique printEngineFactory. Avant d’utiliser d’autres propriétés, l’application doit déterminer la propriété SDKFilesPath. C’est indispensable pour que la bibliothèque accède aux fichiers NiceLabel .NET API qui peuvent se trouver à différents endroits.

Une fois leur emplacement connu, l’application peut récupérer l’interface IPrintEngine en accédant à la propriété PrintEngineFactory.PrintEngine.

Après avoir récupéré l’interface PrintEngine, un appel de la méthode Initialize() de l’instance IPrintEngine renvoyée doit être effectué.

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

Avant de terminer l’application, il faut appeler la méthode Shutdown() de l’instance IPrintEngine pour mettre à disposition toutes les ressources utilisées par la bibliothèque.

Gestion des masques d’étiquettes

La méthode OpenLabel() permet à votre application de gérer les modèles auxquels vos utilisateurs peuvent avoir accès. Les modèles peuvent être ouverts à partir du système de fichiers de votre client ou à partir des objets System.IO.Stream pour ceux qui veulent les déployer intégrés dans leur application ou conservés dans une base de données.

Les utilisateurs de Control Center peuvent gérer les fichiers d’étiquettes dans le stockage de documents.

Gestion des imprimantes

Le moteur d’impression de NiceLabel propose une liste des pilotes d’imprimante auxquels vos applications peuvent accéder localement et réduit la nécessité d’un codage.

La sélection de l’imprimante suit la hiérarchie :

  1. La propriété PrinterName.

  2. Le nom d’imprimante stocké dans votre modèle d’étiquette.

  3. L’imprimante par défaut du système.

Note

Prévisualisation graphique et archivage numérique

Comme les applications basées sur NiceLabel .NET API utilisent le même moteur d’impression pour les prévisualisations et les impressions, les prévisualisations graphiques de vos étiquettes sont identiques aux étiquettes imprimées.

Avec la méthode GetLabelPreview(), l’application peut récupérer un aperçu graphique de la prochaine étiquette à imprimer.

La méthode PrintToGraphics() génère une série d’images de toutes les étiquettes à imprimer. Ainsi, vous pouvez travailler avec des preuves de concept.

Impression d’étiquettes

La technologie NiceLabel vous permet d’imprimer vers n’importe quelle imprimante avec un pilote Windows. La sortie NiceLabel propose également des commandes d’imprimante pour plus de 4 000 modèles d’imprimantes différents, ce qui vous permet d’utiliser les fonctions d’imprimantes natives telles que des codes à barres internes, des polices de caractères et des compteurs.

NiceLabel .NET API dispose de trois modes d’impression différents :

  • Impression synchronisée. Ce mode conserve une connexion au processus d’impression. Avec ce mode, l’application envoie les données au processus d’impression et conserve la connexion tant qu’il travaille. Appeler la méthode Print() envoie un retour d’informations sur le travail d’impression.

  • Impression asynchronisée. Ce mode traite le travail d’impression sur sa propre thread. Cela augmente la performance et le nombre de travaux d’impression pouvant être traités en un temps donné. Quand il utilise la méthode PrintAsync(), l’appelant est notifié par le gestionnaire d’événement que l’état du processus d’impression a changé.

  • Session d’impression. Utiliser cette option quand vous ne souhaitez pas interrompre vos travaux d’impression ou si vous devez imprimer différentes étiquettes sur une seule page ; cela est possible avec NiceLabel pour une session d’impression.

    Toutes les étiquettes d’une même session d’impression sont envoyées à l’imprimante dans un même travail, ce qui garantit un ordre correct d’impression.

    Chaque session d’impression comprend trois étapes :

    1. StartSessionPrint() initialise une nouvelle session d’impression.

    2. SessionPrint() ajoute une demande d’impression à la session en cours et il est possible de l’appeler plusieurs fois.

    3. EndSessionPrint() finalise la session en cours.

Contrôle des impressions

NiceLabel .NET API vous permet de contrôler le processus d’impression par des mises à jour de l’état du travail d’impression, quel que soit votre choix de mode d’impression d’étiquettes. Cet accès détaillé aux processus d’impression permet de contrôler et de répondre correctement à toutes les situations.

Contrôle des exceptions

Toutes les exceptions provenant du moteur d’impression de NiceLabel sont de type SDKException. Cette classe contient des informations détaillées sur les erreurs susceptibles d’être rencontrées.

Journal des impressions

Les utilisateurs de Control Center peuvent enregistrer des événements d’impression provenant de chaque client dans la base de données de Control Center. Vous pouvez examiner les informations recueillies depuis l’interface Web centralisée de Control Center.

Pour plus de détails, voir Référence de programmation de NiceLabel .NET API.