Edit

PrintControllerWithStatusDialog.OnStartPage Method

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

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

public:
 override System::Drawing::Graphics ^ OnStartPage(System::Drawing::Printing::PrintDocument ^ document, System::Drawing::Printing::PrintPageEventArgs ^ e);
public override System.Drawing.Graphics OnStartPage (System.Drawing.Printing.PrintDocument document, System.Drawing.Printing.PrintPageEventArgs e);
public override System.Drawing.Graphics? OnStartPage (System.Drawing.Printing.PrintDocument document, System.Drawing.Printing.PrintPageEventArgs e);
override this.OnStartPage : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintPageEventArgs -> System.Drawing.Graphics
Public Overrides 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 object that represents a page from a PrintDocument.

Remarks

The PrintControllerWithStatusDialog class calls the PrintController.OnStartPage method on the encapsulated PrintController.

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

The OnStartPrint method creates the Graphics object that is sent to the printer. After OnStartPrint is called, OnStartPage 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.

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

Applies to