Cómo hacer referencias a NiceLabel .NET API

Para incluir NiceLabel Print Engine en su aplicación, deberá crear una referencia al ensamblado SDK.NET.Interface.dll. Por lo general, el archivo está en la carpeta c:\Program Files\NiceLabel\NiceLabel 10\\bin.net\.

Le recomendamos que mantenga los archivos de NiceLabel .NET API en una carpeta separada del archivo ejecutable de la aplicación. Después de crear la referencia a SDK.NET.Interface.dll, podrá copiar el archivo .dll a la carpeta de la papelera de la aplicación.

Diseño de etiquetas

Los componentes de NiceLabel .NET API no tienen capacidades de diseño de etiquetas ni una interfaz de usuario. NiceLabel .NET API es un motor de impresión que se integra en otras aplicaciones.

Las plantillas de etiquetas, que NiceLabel Print Engine utiliza para imprimir, deben crearse en NiceLabel Desktop Designer. Es la herramienta de diseño de etiquetas que se utiliza para crear el diseño gráfico de las plantillas de etiquetas, y definir las propiedades de los objetos y los campos variables.

Utilice NiceLabel Desktop Designer para crear sus plantillas de etiquetas y use NiceLabel .NET API para combinar datos de usuarios y administrar la impresión de etiquetas.

Tareas típicas del flujo de trabajo

Administración de Print Engine

Todas las funciones de NiceLabel .NET API se exponen mediante la interfaz NiceLabel.SDK.IPrintEngine.

Cuando la aplicación hace referencia al ensamblado SDK.NET.Interface.dll, puede acceder a la clase estática PrintEngineFactory. Antes de utilizar otras propiedades, la aplicación necesita configurar la propiedad SDKFilesPath. Esto es necesario para que la biblioteca acceda a los archivos de NiceLabel .NET API, que pueden encontrarse en otras ubicaciones.

Una vez conocida la ubicación, la aplicación puede recuperar la interfaz de IPrintEngine accediendo a la propiedad PrintEngineFactory.PrintEngine.

Después de recuperar PrintEngine, debe hacerse una llamada al método Initialize() de la instancia de IPrintEngine devuelta.

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

Antes de cerrar la aplicación, debe llamarse al método Shutdown() de la instancia IPrintEngine para liberar todos los recursos usados por la biblioteca.

Administración de plantillas de etiquetas

El método OpenLabel() le permite a su aplicación administrar a qué plantillas pueden acceder sus usuarios. Las plantillas pueden abrirse desde los sistemas de archivos de su cliente o desde los objetos System.IO.Stream para los usuarios que desean implementarlos incrustados en su aplicación o guardados en una base de datos.

Los usuarios de Control Center pueden administrar los archivos de etiquetas en el almacenamiento de documentos.

Administración de impresoras

NiceLabel Print Engine proporciona a sus aplicaciones una lista de controladores de impresoras disponibles localmente y reduce la necesidad de codificación.

La selección de impresoras sigue esta jerarquía:

  1. La propiedad PrinterName.

  2. El nombre de la impresora almacenado en su plantilla de etiqueta.

  3. La impresora predeterminada del sistema.

Nota

Vista previa gráfica y archivado digital

Las aplicaciones basadas en NiceLabel .NET API usan el mismo motor de impresión para la vista previa y la impresión, por lo que las vistas previas gráficas de sus etiquetas son idénticas a las etiquetas impresas.

Con el método GetLabelPreview(), la aplicación puede recuperar una vista previa gráfica de la siguiente etiqueta que se imprimirá.

El método PrintToGraphics() genera una serie de imágenes de todas las etiquetas que se imprimirían. De este modo, usted puede trabajar con pruebas de concepto.

Impresión de etiquetas

La tecnología de NiceLabel le permite imprimir con cualquier impresora con un controlador de Windows. El producto NiceLabel también brinda comandos de impresora para más de 4000 modelos de impresora distintos, lo que le permite utilizar las funciones nativas de impresoras, como códigos de barra, fuentes y contadores internos.

NiceLabel .NET API ofrece tres modos de impresión diferentes:

  • Impresión sincronizada. Este modo mantiene una conexión con el proceso de impresión. En este modo, la aplicación envía datos al proceso de impresión y mantiene la conexión establecida siempre que el proceso de impresión esté ocupado. Al llamar al método Print(), aparecen comentarios sobre el trabajo de impresión.

  • Impresión asincrónica. Este modo procesa el trabajo de impresión en su propio subproceso. Mejora el rendimiento y aumenta el número de trabajos de impresión que pueden procesarse en un plazo determinado. Al utilizar el método PrintAsync(), se notifica al autor de la llamada mediante controladores de eventos cuando cambia el estado del proceso de impresión.

  • Impresión de sesión. Utilice esta opción cuando no quiera interrumpir sus trabajos de impresión o deba imprimir distintas etiquetas en una única página. NiceLabel posibilita esto con la impresión de sesión.

    Todas las etiquetas dentro de una impresión de sesión se envían a la impresora como un trabajo único, lo cual garantiza el orden correcto de la impresión.

    Cada impresión de sesión incluye tres etapas:

    1. StartSessionPrint() comienza una nueva sesión de impresión.

    2. SessionPrint() agrega una solicitud de impresión a la sesión actual y puede llamarse varias veces.

    3. EndSessionPrint() finaliza la sesión actual.

Monitoreo de trabajos de impresión

NiceLabel .NET API le permite monitorear el proceso de impresión a través de actualizaciones de estado de los trabajos de impresión independientemente del modo de impresión de etiquetas que elija. Este acceso detallado al proceso de impresión le permite controlar y responder correctamente ante cualquier situación.

Manejo de excepciones

Todas las excepciones de NiceLabel Print Engine son del tipo SDKException. Esta clase contiene información detallada acerca de los errores que podrían producirse.

Registro de impresión

Los usuarios de Control Center pueden registrar eventos de impresión de cada cliente en la base de datos de Control Center. Usted puede examinar la información recopilada de la interfaz web centralizada de Control Center.

Consulte Referencia de programación de NiceLabel .NET API para obtener más detalles.