PrintDocumentEventHandler Delegate

Represents the method that will handle the PrintingSystemBase.StartPrint event.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.1.Core.dll

Declaration

C#

public delegate void PrintDocumentEventHandler(
    object sender,
    PrintDocumentEventArgs e
);

VB.NET

Public Delegate Sub PrintDocumentEventHandler(
    sender As Object,
    e As PrintDocumentEventArgs
)

Parameters

Name	Type	Description
sender	Object	An object of any type that triggers the PrintingSystemBase.StartPrint event.
e	PrintDocumentEventArgs	A PrintDocumentEventArgs object that provides data for the PrintingSystemBase.StartPrint event.

Remarks

When creating an PrintDocumentEventHandler delegate, you identify the method that will handle the corresponding event. To associate an event with your event handler, add a delegate instance to this event. The event handler is called whenever the event occurs unless you remove the delegate. For more information about event handler delegates, see Events and Delegates in MSDN.

Example

The following example demonstrates how to use the PrintDocumentEventArgs object when handling the PrintingSystemBase.StartPrint event. The example below demonstrates how to programmatically select a printer to print a document at runtime.

C#

using System;
using System.Windows.Forms;
using System.Drawing.Printing;
using DevExpress.XtraPrinting;
using DevExpress.Utils;
// ...

// creating a PrintingSystem object
private PrintingSystem printingSystem1 = new PrintingSystem();
//...

private void button1_Click(object sender, System.EventArgs e) {
   // handling the StartPrint event
   printingSystem1.StartPrint += new PrintDocumentEventHandler(printingSystem_StartPrint);

   // printing the document
   printingSystem1.Print();
}

private void printingSystem_StartPrint(object sender, PrintDocumentEventArgs e) {
   // setting the specific printer's name before printing
   e.PrintDocument.PrinterSettings.PrinterName = PrinterSettings.InstalledPrinters[1];
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports System.Drawing.Printing
Imports DevExpress.XtraPrinting
Imports DevExpress.Utils
' ...

' creating a PrintingSystem object
Private WithEvents printingSystem1 As New PrintingSystem()
' ...

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles Button1.Click
   ' printing the document
   printingSystem1.Print()
End Sub

' handling the StartPrint event
Private Sub printingSystem_StartPrint(ByVal sender As System.Object, _
ByVal e As PrintDocumentEventArgs) Handles printingSystem1.StartPrint
   ' setting the specific printer's name before printing
   e.PrintDocument.PrinterSettings.PrinterName = PrinterSettings.InstalledPrinters(1)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PrintDocumentEventHandler delegate.

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_how-to-print-multiple-reports-as-a-single-batch-e1765/CS/BatchPrinting/Form1.cs#L21

ReportPrintTool pt1 = new ReportPrintTool(report1);
pt1.PrintingSystem.StartPrint += new PrintDocumentEventHandler(PrintingSystem_StartPrint);

Reporting_documentpreviewcontrol-how-to-override-the-print-and-printdirect-quick-print-e4631/CS/MinimalisticReportPreviewDemo/MyDocumentPreviewControl.cs#L13

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

Reporting_how-to-programmatically-select-a-printer-e1766/CS/SelectPrinterInCode/Form1.cs#L17

pt.PrintingSystem.StartPrint +=
    new PrintDocumentEventHandler(printingSystem_StartPrint);
pt.Print();

Reporting_how-to-determine-the-settings-of-the-selected-printer-when-the-ok-button-is-pressed-e1767/CS/DeterminePrinterSettings/Form1.cs#L19

((XtraReport1)printTool.Report).PrintingSystem.StartPrint +=
    new PrintDocumentEventHandler(PrintingSystem_StartPrint);

Reporting_how-to-programmatically-print-a-specified-range-of-report-pages-e1768/CS/SpecifyPageRange/Form1.cs#L16

report.PrintingSystem.StartPrint +=
    new PrintDocumentEventHandler(printingSystem_StartPrint);
report.Print();