Cómo administrar trabajos de impresión en una aplicación de dispositivo para UWP
En Windows 8.1, las aplicaciones de dispositivos para UWP para impresoras pueden administrar trabajos de impresión. En este tema se usa la versión de C# del ejemplo Administración de trabajos de impresión y mantenimiento de impresoras para mostrar cómo crear una vista de trabajos de impresión, supervisar esos trabajos y, si es necesario, cancelar un trabajo. Para obtener más información sobre las aplicaciones de dispositivos para UWP en general, consulte Conocer las aplicaciones de dispositivos para UWP.
La versión de C# del ejemplo Administración de trabajos de impresión y mantenimiento de impresoras muestra el mantenimiento de la impresora con el archivo DeviceMaintenance.xaml.cs en el proyecto DeviceAppForPrinters2. Para trabajar con bidi, el ejemplo usa la biblioteca de extensiones de impresora del proyecto PrinterExtensionLibrary. La biblioteca de extensiones de impresora proporciona una manera cómoda de acceder a las interfaces de extensión de impresora del controlador de impresión v4. Para obtener más información, consulte Información general sobre la biblioteca de extensiones de impresora.
Los ejemplos de código que se muestran en este tema se basan en la versión de C# del ejemplo Administración de trabajos de impresión y mantenimiento de impresoras. Este ejemplo también está disponible en JavaScript y C++. Tenga en cuenta que, dado que C++ puede acceder directamente a COM, la versión de C++ del ejemplo no incluye proyectos de biblioteca de código. Descargue los ejemplos para ver las versiones más recientes del código.
Administración de trabajos de impresión
Windows 8.1 presenta nuevas interfaces de extensión de impresora en el controlador de impresora v4 que puede usar para administrar trabajos de impresión: IPrinterQueue2, IPrinterQueueView, IPrinterQueueViewEvent, IPrintJob y IPrintJobCollection. Estas interfaces permiten supervisar y cancelar trabajos de impresión. Para obtener más información, consulte Administración de trabajos de impresión (controlador de impresora v4) .
Las aplicaciones de C# y JavaScript no pueden trabajar directamente con las API COM. Si está escribiendo una aplicación de dispositivo para UWP de C# o JavaScript, use la biblioteca de extensiones de impresora para acceder a estas interfaces (como se muestra en este tema).
Requisitos previos
Antes de comenzar:
Asegúrese de que la impresora esté instalada con un controlador de impresión v4. Para obtener más información, consulte Desarrollo de controladores de impresión v4.
Configure su equipo de desarrollo. Consulte Introducción para obtener información sobre cómo descargar las herramientas y crear una cuenta de desarrollador.
Asocie la aplicación con la tienda. Consulte Creación de una aplicación de dispositivo para UWP para obtener información.
Cree metadatos de dispositivo para la impresora que la asocien con la aplicación. Consulte Creación de metadatos de dispositivo para obtener más información.
Cree la interfaz de usuario para la página principal de la aplicación. Todas las aplicaciones de dispositivos para UWP se pueden iniciar desde Inicio, donde se mostrarán a pantalla completa. Use la experiencia de Inicio para resaltar el producto o los servicios de forma que coincida con la personalización de marca y las características específicas de los dispositivos. No hay restricciones especiales en cuanto al tipo de controles de interfaz de usuario que puede usar. Para empezar a trabajar con el diseño de la experiencia a pantalla completa, consulte los Principios de diseño de Microsoft Store.
Si está escribiendo su aplicación con C# o JavaScript, agregue el proyecto PrinterExtensionLibrary a su solución de aplicación de dispositivos para UWP. Puede encontrar este proyecto en el ejemplo Administración de trabajos de impresión y mantenimiento de impresoras.
Dado que C++ puede acceder directamente a COM, las aplicaciones de C++ no requieren una biblioteca independiente para trabajar con el contexto del dispositivo de impresora basado en COM.
Paso 1: Búsqueda de la impresora
Para que la aplicación pueda administrar trabajos de impresión, primero debe localizar la impresora que tiene los trabajos de impresión. Para ello, el ejemplo Administración de trabajos de impresión y mantenimiento de impresoras incluye una clase útil denominada PrinterEnumeration (en el archivo PrinterEnumeration.cs). Esta clase busca todas las impresoras asociadas a la aplicación a través de metadatos del dispositivo y devuelve una lista de objetos PrinterInfo, que contiene los nombres y los identificadores de dispositivo de cada impresora.
En este ejemplo se muestra el método EnumeratePrinters_Click en el archivo PrintJobManagement.xaml.cs. Muestra cómo el ejemplo usa la clase PrinterEnumeration para obtener una lista de impresoras asociadas.
private async void EnumeratePrinters_Click(object sender, RoutedEventArgs e)
{
try
{
rootPage.NotifyUser("Enumerating printers. Please wait", NotifyType.StatusMessage);
// Retrieve the running app's package family name, and enumerate associated printers.
string currentPackageFamilyName = Windows.ApplicationModel.Package.Current.Id.FamilyName;
// Enumerate associated printers.
PrinterEnumeration pe = new PrinterEnumeration(currentPackageFamilyName);
List<PrinterInfo> associatedPrinters = await pe.EnumeratePrintersAsync();
// Update the data binding source on the combo box that displays the list of printers.
PrinterComboBox.ItemsSource = associatedPrinters;
if (associatedPrinters.Count > 0)
{
PrinterComboBox.SelectedIndex = 0;
rootPage.NotifyUser(associatedPrinters.Count + " printers enumerated", NotifyType.StatusMessage);
}
else
{
rootPage.NotifyUser(DisplayStrings.NoPrintersEnumerated, NotifyType.ErrorMessage);
}
}
catch (Exception exception)
{
rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
}
}
Para obtener más información sobre las clases PrinterEnumeration y PrinterInfo, consulte el archivo PrinterEnumeration.cs.
Paso 2: Obtención de la cola de impresoras
Una vez que haya identificado la impresora que tiene los trabajos de impresión que desea administrar, cree una vista de los trabajos de impresión, con el objeto basado en la interfaz IPrinterQueueView (definida en el archivo PrinterExtensionTypes.cs del proyecto PrinterExtensionLibrary). En el ejemplo Administración de trabajos de impresión y mantenimiento de impresoras, este objeto se denomina currentPrinterQueueView y se vuelve a crear cada vez que cambia la selección de la impresora.
En el método Printer_SelectionChanged, el ejemplo usa primero un objeto PrinterInfo para crear un objeto de contexto de extensión de impresora denominado context. A continuación, usa el método GetPrinterQueueView en context para crear el objeto currentPrinterQueueView. Por último, se agrega un controlador de eventos para controlar el evento OnChanged de currentPrinterQueueView.
En este ejemplo se muestra el método Printer_SelectionChanged en el archivo PrintJobManagement.xaml.cs. Muestra cómo crear un objeto de vista de cola de impresora basado en IPrinterQueueView.
private void Printer_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
try
{
// Remove the current printer queue view (if any) before displaying the new view.
if (currentPrinterQueueView != null)
{
currentPrinterQueueView.OnChanged -= OnPrinterQueueViewChanged;
currentPrinterQueueView = null;
}
// Retrieve a COM IPrinterExtensionContext object, using the static WinRT factory.
// Then instantiate one "PrinterExtensionContext" object that allows operations on the COM object.
PrinterInfo queue = (PrinterInfo)PrinterComboBox.SelectedItem;
Object comContext = Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId(queue.DeviceId);
PrinterExtensionContext context = new PrinterExtensionContext(comContext);
// Display the printer queue view.
const int FirstPrintJobEnumerated = 0;
const int LastPrintJobEnumerated = 10;
currentPrinterQueueView = context.Queue.GetPrinterQueueView(FirstPrintJobEnumerated, LastPrintJobEnumerated);
currentPrinterQueueView.OnChanged += OnPrinterQueueViewChanged;
}
catch (Exception exception)
{
rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
}
}
Además, siempre que haya un cambio en la vista de los trabajos de impresión, un controlador de eventos llama al método OnPrinterQueueViewChanged. Este método se encarga de volver a enlazar el PrintJobListBox con una colección IEnumerable de objetos IPrintJob. La colección se transfiere al método a través del objeto PrinterQueueViewEventArgs, que se define en el archivo PrinterExtensionTypes.cs.
En este ejemplo se muestra el método OnPrinterQueueViewChanged en el archivo PrintJobManagement.xaml.cs.
private async void OnPrinterQueueViewChanged(object sender, PrinterQueueViewEventArgs e)
{
await Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
{
// Update the data binding on the ListBox that displays print jobs.
PrintJobListBox.ItemsSource = e.Collection;
if (PrintJobListBox.Items.Count > 0)
{
// If there are print jobs in the current view, mark the first job as selected.
PrintJobListBox.SelectedIndex = 0;
}
});
}
Paso 3: Visualización del estado del trabajo de impresión
Dado que PrintJobListBox está enlazado a una colección de objetos IPrintJob, mostrar el estado de un trabajo es bastante sencillo. El trabajo de impresión seleccionado se proyecta como un objeto IPrintJob y, a continuación, las propiedades de ese objeto se usan para rellenar el cuadro de texto PrintJobDetails.
En el ejemplo Administración de trabajos de impresión y mantenimiento de impresoras, el estado del trabajo de impresión se muestra cada vez que se selecciona un trabajo de impresión diferente. De esta actualización se encarga el método PrintJob_SelectionChanged.
En este ejemplo se muestra el método PrintJob_SelectionChanged en el archivo PrintJobManagement.xaml.cs. Muestra cómo presentar el estado de un trabajo de impresión, en función de un objeto IPrintJob.
private void PrintJob_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
try
{
// Display details of the selected print job.
IPrintJob job = (IPrintJob)PrintJobListBox.SelectedItem;
if (job != null)
{
PrintJobDetails.Text =
"Details of print job: " + job.Name + "\r\n" +
"Pages printed: " + job.PrintedPages + "/" + job.TotalPages + "\r\n" +
"Submission time: " + job.SubmissionTime + "\r\n" +
"Job status: " + DisplayablePrintJobStatus.ToString(job.Status);
}
else
{
PrintJobDetails.Text = "Please select a print job";
}
}
catch (Exception exception)
{
rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
}
}
Para ayudar a mostrar la descripción del estado del trabajo de impresión, el método PrintJob_SelectionChanged usa un diccionario estático, denominado printJobStatusDisplayNames, para ayudar a mostrar las descripciones de estado del trabajo que se encuentran en un formato de texto descriptivo.
En este ejemplo se muestra la clase DisplayablePrintJobStatus en el archivo PrintJobManagement.xaml.cs. Esta clase contiene los miembros estáticos que utiliza PrintJob_SelectionChanged
internal class DisplayablePrintJobStatus
{
/// <summary>
/// Converts the PrintJobStatus bit fields to a display string.
/// </summary>
internal static string ToString(PrintJobStatus printJobStatus)
{
StringBuilder statusString = new StringBuilder();
// Iterate through each of the PrintJobStatus bits that are set and convert it to a display string.
foreach (var printJobStatusDisplayName in printJobStatusDisplayNames)
{
if ((printJobStatusDisplayName.Key & printJobStatus) != 0)
{
statusString.Append(printJobStatusDisplayName.Value);
}
}
int stringlen = statusString.Length;
if (stringlen > 0)
{
// Trim the trailing comma from the string.
return statusString.ToString(0, stringlen - 1);
}
else
{
// If no print job status field was set, display "Not available".
return "Not available";
}
}
/// <summary>
/// Static constructor that initializes the display name for the PrintJobStatus field.
/// </summary>
static DisplayablePrintJobStatus()
{
printJobStatusDisplayNames = new Dictionary<PrintJobStatus, string>();
printJobStatusDisplayNames.Add(PrintJobStatus.Paused, "Paused,");
printJobStatusDisplayNames.Add(PrintJobStatus.Error, "Error,");
printJobStatusDisplayNames.Add(PrintJobStatus.Deleting, "Deleting,");
printJobStatusDisplayNames.Add(PrintJobStatus.Spooling, "Spooling,");
printJobStatusDisplayNames.Add(PrintJobStatus.Printing, "Printing,");
printJobStatusDisplayNames.Add(PrintJobStatus.Offline, "Offline,");
printJobStatusDisplayNames.Add(PrintJobStatus.PaperOut, "Out of paper,");
printJobStatusDisplayNames.Add(PrintJobStatus.Printed, "Printed,");
printJobStatusDisplayNames.Add(PrintJobStatus.Deleted, "Deleted,");
printJobStatusDisplayNames.Add(PrintJobStatus.BlockedDeviceQueue, "Blocked device queue,");
printJobStatusDisplayNames.Add(PrintJobStatus.UserIntervention, "User intervention required,");
printJobStatusDisplayNames.Add(PrintJobStatus.Restarted, "Restarted,");
printJobStatusDisplayNames.Add(PrintJobStatus.Complete, "Complete,");
printJobStatusDisplayNames.Add(PrintJobStatus.Retained, "Retained,");
}
/// <summary>
/// Private constructor to prevent default instantiation.
/// </summary>
private DisplayablePrintJobStatus() { }
/// <summary>
/// Contains the mapping between PrintJobStatus fields and display strings.
/// </summary>
private static Dictionary<PrintJobStatus, string> printJobStatusDisplayNames;
}
Paso 4: Cancelación del trabajo de impresión
De forma similar a mostrar el estado del trabajo de impresión, la cancelación de un trabajo de impresión es bastante sencilla cuando tiene un objeto IPrintJob. La clase IPrintJob proporciona un método RequestCancel que inicia la cancelación del trabajo de impresión correspondiente. Esto se muestra en el método CancelPrintJob_Click del ejemplo.
En este ejemplo se muestra el método CancelPrintJob_Click en el archivo PrintJobManagement.xaml.cs.
private void CancelPrintJob_Click(object sender, RoutedEventArgs e)
{
try
{
IPrintJob job = (IPrintJob)PrintJobListBox.SelectedItem;
job.RequestCancel();
}
catch (Exception exception)
{
rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
}
}
Prueba
Para poder probar la aplicación de dispositivo para UWP, debe estar vinculada a la impresora mediante metadatos del dispositivo.
Necesita una copia del paquete de metadatos del dispositivo para la impresora, para agregarle la información de la aplicación del dispositivo. Si no tiene metadatos de dispositivo, puede crearlos mediante el Asistente para creación de metadatos de dispositivo, tal como se describe en el tema Creación de metadatos de dispositivo para la aplicación de dispositivo para UWP.
Para usar el Asistente para creación de metadatos de dispositivo, debe instalar Microsoft Visual Studio Professional, Microsoft Visual Studio Ultimate o el SDK independiente para Windows 8.1, antes de completar los pasos de este tema. La instalación de Microsoft Visual Studio Express para Windows instala una versión del SDK que no incluye el asistente.
Los pasos siguientes permiten crear la aplicación e instalar los metadatos del dispositivo.
Habilite la firma de pruebas.
Inicie el Asistente para creación de metadatos de dispositivo desde %ProgramFiles(x86)%\Windows Kits\8.1\bin\x86, haciendo doble clic en DeviceMetadataWizard.exe
En el menú Herramientas, seleccione Habilitar firma de pruebas.
Reinicie el equipo.
Cree la solución abriendo el archivo de solución (.sln). Pulse F7 o vaya a Crear->Crear solución en el menú superior después de cargar el ejemplo.
Desconecte y desinstale la impresora. Este paso es necesario para que Windows lea los metadatos del dispositivo actualizado la próxima vez que se detecte el dispositivo.
Edite y guarde los metadatos del dispositivo. Para vincular la aplicación de dispositivo al dispositivo, debe asociar la aplicación de dispositivo al dispositivo.
Si aún no ha creado los metadatos del dispositivo, consulte Creación de metadatos de dispositivo para la aplicación de dispositivo para UWP.
Si el Asistente para creación de metadatos de dispositivo todavía no está abierto, inícielo desde %ProgramFiles(x86)%\Windows Kits\8.1\bin\x86, haciendo doble clic en DeviceMetadataWizard.exe.
Haga clic en Editar metadatos del dispositivo. Esto le permitirá editar el paquete de metadatos del dispositivo existente.
En el cuadro de diálogo Abrir, busque el paquete de metadatos del dispositivo asociado a la aplicación de dispositivo para UWP. (Tiene una extensión de archivo devicemetadata-ms).
En la página Especificar información de la aplicación de dispositivo para UWP, escriba la información de la aplicación de Microsoft Store en el cuadro Aplicación de dispositivo para UWP. Haga clic en Importar archivo de manifiesto de aplicación para UWP para introducir automáticamente el Nombre del paquete, el Nombre del publicador y el Identificador de la aplicación para UWP.
Si la aplicación está registrada para recibir notificaciones de impresora, rellene el cuadro Controladores de notificaciones. En Identificador de evento, escriba el nombre del controlador de eventos de impresión. En Recurso de evento, escriba el nombre del archivo donde reside ese código.
Cuando haya terminado, haga clic en Siguiente hasta llegar a la página Finalizar.
En la página Revisar el paquete de metadatos del dispositivo, asegúrese de que toda la configuración sea correcta y active la casilla Copiar el paquete de metadatos del dispositivo en el almacén de metadatos del equipo local. A continuación, haga clic en Save(Guardar).
Vuelva a conectar la impresora para que Windows lea los metadatos del dispositivo actualizados cuando se conecte el dispositivo.
Temas relacionados
Administración de trabajos (controlador de impresora v4)
Desarrollo de controladores de impresión v4
Comunicaciones bidireccionales
Introducción a las aplicaciones para UWP
Creación de una aplicación de dispositivo para UWP (guía paso a paso)
Creación de metadatos de dispositivo para una aplicación de dispositivo para UWP (guía paso a paso)
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de