StandardPrintController.OnStartPrint(PrintDocument, PrintEventArgs) Method

Definition

Begins the control sequence that determines when and how to print a document.

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

Parameters

document
PrintDocument

A PrintDocument that represents the document being printed.

e
PrintEventArgs

A PrintEventArgs that contains data about how to print the document.

Exceptions

The printer settings are not valid.

The native Win32 Application Programming Interface (API) could not start a print job.

Remarks

OnStartPrint is called immediately after PrintDocument raises the BeginPrint event.

OnStartPrint creates the Graphics object used in printing. After OnStartPrint is called, the OnStartPage method sets the Graphics object to a graphic of a single page. The OnEndPage method clears the Graphics object, while the OnEndPrint method deallocates the object.

OnStartPrint verifies that the printer settings are valid.

Applies to

See also