Edit

PrintController.OnStartPrint(PrintDocument, PrintEventArgs) Method

  • Reference

Definition

Namespace:
System.Drawing.Printing
Assembly:
System.Drawing.Common.dll
Assembly:
System.Drawing.dll
Package:
System.Drawing.Common v6.0.0
Package:
System.Drawing.Common v7.0.0
Package:
System.Drawing.Common v8.0.0
Package:
System.Drawing.Common v9.0.0-preview.2.24128.3
Source:
PrintController.cs
Source:
PrintController.cs
Source:
PrintController.cs

When overridden in a derived class, begins the control sequence that determines when and how to print a document.

public:
 virtual void OnStartPrint(System::Drawing::Printing::PrintDocument ^ document, System::Drawing::Printing::PrintEventArgs ^ e);
public virtual void OnStartPrint (System.Drawing.Printing.PrintDocument document, System.Drawing.Printing.PrintEventArgs e);
abstract member OnStartPrint : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintEventArgs -> unit
override this.OnStartPrint : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintEventArgs -> unit
Public Overridable Sub OnStartPrint (document As PrintDocument, e As PrintEventArgs)

Parameters

document
PrintDocument

A PrintDocument that represents the document currently being printed.

e
PrintEventArgs

A PrintEventArgs that contains the event data.

Remarks

OnStartPrint is called immediately after the PrintDocument raises the BeginPrint event.

Use the OnStartPrint method to determine when and how to print a document. For example, you can delay printing for 30 minutes or adjust the printer settings for the document. OnStartPrint creates the Graphics that is sent to the printer. After OnStartPrint is called, the OnStartPage method sets the Graphics to one of a single page. The OnEndPage method clears the Graphics, while the OnEndPrint method deallocates the object.

The OnStartPrint method is a good place to verify that PrinterSettings are valid.

Applies to

See also