PrintController Class

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Package:

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

Source:

PrintController.cs

Controls how a document is printed, when printing from a Windows Forms application.

public ref class PrintController abstract

public abstract class PrintController

type PrintController = class

Public MustInherit Class PrintController

Inheritance

Object

PrintController

Derived

System.Drawing.Printing.PreviewPrintController

System.Drawing.Printing.StandardPrintController

System.Windows.Forms.PrintControllerWithStatusDialog

Remarks

Note

In .NET 6 and later versions, the System.Drawing.Common package, which includes this type, is only supported on Windows operating systems. Use of this type in cross-platform apps causes compile-time warnings and run-time exceptions. For more information, see System.Drawing.Common only supported on Windows.

When implemented in a derived class, PrintController controls how a PrintDocument is printed. PrintDocument.Print invokes the print controller's OnStartPrint, OnEndPrint, OnStartPage, and OnEndPage methods, which in turn tell the printer how to print the document. Print preview uses a specialized PrintController. For an example of a print controller that is specialized for print preview, see the PreviewPrintController.

PrintController is used by PrintDocument, and not typically used directly.

The .NET Framework includes three print controllers that are derived from PrintController that help accomplish common tasks. The StandardPrintController prints a document to a printer. The PreviewPrintController generates a preview of what the document will look like when printed and is used by the PrintPreviewControl and PrintPreviewDialog classes. The PrintControllerWithStatusDialog provides a printing status dialog during the printing process.

For more information about printing with Windows Forms, see the System.Drawing.Printing namespace overview. If you wish to print from a Windows Presentation Foundation application, see the System.Printing namespace.

Constructors

PrintController()

Initializes a new instance of the PrintController class.

Properties

IsPreview

Gets a value indicating whether the PrintController is used for print preview.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnEndPage(PrintDocument, PrintPageEventArgs)	When overridden in a derived class, completes the control sequence that determines when and how to print a page of a document.
OnEndPrint(PrintDocument, PrintEventArgs)	When overridden in a derived class, completes the control sequence that determines when and how to print a document.
OnStartPage(PrintDocument, PrintPageEventArgs)	When overridden in a derived class, begins the control sequence that determines when and how to print a page of a document.
OnStartPrint(PrintDocument, PrintEventArgs)	When overridden in a derived class, begins the control sequence that determines when and how to print a document.
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• PrintDocument
• StandardPrintController