PrintingSystemBase.PrintProgress Event

The event is raised before a document page is sent to a printer. The event is not raised in non-Windows environments.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public event PrintProgressEventHandler PrintProgress

VB.NET

Public Event PrintProgress As PrintProgressEventHandler

Event Data

The PrintProgress event's data class is PrintProgressEventArgs. The following properties provide information specific to this event:

Property	Description
PageIndex	Gets the index of the current page that should be sent to a printer, next.
PageSettings	Gets or sets the page settings of the current page that should be sent to a printer, next.
PrintAction	Gets a value indicating what type of print operation is occurring.

Remarks

The PrintProgress event allows you to indicate the current print progress and execute custom code before a page is sent to the printer.

To indicate the current print progress, add a DevExpress.XtraEditors.ProgressBarControl to the application and set its Position property to the e.PageIndex value.

The PrintProgress event allows you to use the e.PageSettings property to specify page settings.

Print operations run in a non-UI thread. Therefore, you should make thread-safe calls to your controls if you handle the PrintProgress event. For more information on standard thread-safe call techniques, review the following help topics:

• How to: Make Thread-Safe Calls to Windows Forms Controls
• DevExpress WinForms Best Practices - Update and Load Data from non UI Threads, and Deal with Frequently Updated Data

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PrintProgress event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-wpf-override-print-commands/CS/MinimalisticReportPreviewDemo/MyDocumentPreviewControl.cs#L9

pt.PrintingSystem.StartPrint += new PrintDocumentEventHandler(PrintingSystem_StartPrint);
pt.PrintingSystem.PrintProgress += new PrintProgressEventHandler(PrintingSystem_PrintProgress);
pt.PrintDialog();

VB.NET

reporting-wpf-override-print-commands/VB/MinimalisticReportPreviewDemo/MyDocumentPreviewControl.vb#L16

AddHandler pt.PrintingSystem.StartPrint, AddressOf PrintingSystem_StartPrint
AddHandler pt.PrintingSystem.PrintProgress, AddressOf PrintingSystem_PrintProgress
pt.PrintDialog()