PrintController.OnStartPage(PrintDocument, PrintPageEventArgs) Method

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v9.0.0-rc.2.24474.1

Source:

PrintController.cs

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

public:
 virtual System::Drawing::Graphics ^ OnStartPage(System::Drawing::Printing::PrintDocument ^ document, System::Drawing::Printing::PrintPageEventArgs ^ e);

public virtual System.Drawing.Graphics? OnStartPage (System.Drawing.Printing.PrintDocument document, System.Drawing.Printing.PrintPageEventArgs e);

abstract member OnStartPage : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintPageEventArgs -> System.Drawing.Graphics
override this.OnStartPage : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintPageEventArgs -> System.Drawing.Graphics

Public Overridable Function OnStartPage (document As PrintDocument, e As PrintPageEventArgs) As Graphics

Parameters

document

PrintDocument

A PrintDocument that represents the document currently being printed.

e

PrintPageEventArgs

A PrintPageEventArgs that contains the event data.

Returns

Graphics

A Graphics that represents a page from a PrintDocument.

Remarks

OnStartPage is called immediately before the PrintDocument raises the PrintPage event.

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

Use the OnStartPage method to set how to print a page in a document. For example, you can adjust page settings separately for each page.

See also

• OnEndPage(PrintDocument, PrintPageEventArgs)
• OnEndPrint(PrintDocument, PrintEventArgs)
• OnStartPrint(PrintDocument, PrintEventArgs)
• PrintPageEventArgs