PrintDocumentEventArgs.PrintDocument Property

Gets the object that sends the document’s output to a printer.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public PrintDocument PrintDocument { get; }

VB.NET

Public ReadOnly Property PrintDocument As PrintDocument

Property Value

Type	Description
PrintDocument	A PrintDocument object representing the printing settings of the document.

Remarks

Use this property to set the printing options that describe how to print the document. Handle the PrintingSystemBase.StartPrint event where you can specify all these options.

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 PrintDocument property.

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-dynamically-select-the-paper-source-and-set-the-printer-resolution-e332/CS/SelectPaperSource/Form1.cs#L22

private void printingSystem_StartPrint(object sender, PrintDocumentEventArgs e) {
    for (int i = 0; i < e.PrintDocument.PrinterSettings.PaperSources.Count; i++)
        if (e.PrintDocument.PrinterSettings.PaperSources[i].Kind ==

Reporting_how-to-print-multiple-reports-as-a-single-batch-e1765/CS/BatchPrinting/Form1.cs#L37

void PrintingSystem_StartPrint(object sender, PrintDocumentEventArgs e) {
    prnSettings = e.PrintDocument.PrinterSettings;
}

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

// Set the page range.
e.PrintDocument.PrinterSettings.FromPage = 1;
e.PrintDocument.PrinterSettings.ToPage = 3;

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

// Set the printer name.
e.PrintDocument.PrinterSettings.PrinterName =
    PrinterSettings.InstalledPrinters[0];

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

private void PrintingSystem_StartPrint(object sender, PrintDocumentEventArgs e) {
    e.PrintDocument.BeginPrint +=
        new PrintEventHandler(PrintDocument_BeginPrint);

VB.NET

Reporting_how-to-dynamically-select-the-paper-source-and-set-the-printer-resolution-e332/VB/SelectPaperSource/Form1.vb#L23

Private Sub printingSystem_StartPrint(ByVal sender As Object, ByVal e As PrintDocumentEventArgs)
    For i As Integer = 0 To e.PrintDocument.PrinterSettings.PaperSources.Count - 1
        If e.PrintDocument.PrinterSettings.PaperSources(i).Kind = PaperSourceKind.TractorFeed Then

Reporting_how-to-print-multiple-reports-as-a-single-batch-e1765/VB/BatchPrinting/Form1.vb#L42

Private Sub PrintingSystem_StartPrint(ByVal sender As Object, ByVal e As PrintDocumentEventArgs)
    prnSettings = e.PrintDocument.PrinterSettings
End Sub

Reporting_how-to-programmatically-print-a-specified-range-of-report-pages-e1768/VB/SpecifyPageRange/Form1.vb#L23

' Set the page range.
e.PrintDocument.PrinterSettings.FromPage = 1
e.PrintDocument.PrinterSettings.ToPage = 3

Reporting_how-to-programmatically-select-a-printer-e1766/VB/SelectPrinterInCode/Form1.vb#L24

    ' Set the printer name.
    e.PrintDocument.PrinterSettings.PrinterName = PrinterSettings.InstalledPrinters(0)
End Sub

Reporting_how-to-determine-the-settings-of-the-selected-printer-when-the-ok-button-is-pressed-e1767/VB/DeterminePrinterSettings/Form1.vb#L28

Private Sub PrintingSystem_StartPrint(ByVal sender As Object, ByVal e As PrintDocumentEventArgs)
    AddHandler e.PrintDocument.BeginPrint, AddressOf PrintDocument_BeginPrint
End Sub