0 out of 1 rated this helpful - Rate this topic

PrintControllerWithStatusDialog Class

Controls how a document is printed from a Windows Forms application.

System.Object
  System.Drawing.Printing.PrintController
    System.Windows.Forms.PrintControllerWithStatusDialog

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public class PrintControllerWithStatusDialog : PrintController

The PrintControllerWithStatusDialog type exposes the following members.

  Name Description
Public method PrintControllerWithStatusDialog(PrintController) Initializes a new instance of the PrintControllerWithStatusDialog class, wrapping the supplied PrintController.
Public method PrintControllerWithStatusDialog(PrintController, String) Initializes a new instance of the PrintControllerWithStatusDialog class, wrapping the supplied PrintController and specifying a title for the dialog box.
Top
  Name Description
Public property IsPreview Gets a value indicating this PrintControllerWithStatusDialog is used for print preview. (Overrides PrintController.IsPreview.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method OnEndPage Infrastructure. Completes the control sequence that determines when and how to print a page of a document. (Overrides PrintController.OnEndPage(PrintDocument, PrintPageEventArgs).)
Public method OnEndPrint Infrastructure. Completes the control sequence that determines when and how to print a document. (Overrides PrintController.OnEndPrint(PrintDocument, PrintEventArgs).)
Public method OnStartPage Infrastructure. Begins the control sequence that determines when and how to print a page of a document. (Overrides PrintController.OnStartPage(PrintDocument, PrintPageEventArgs).)
Public method OnStartPrint Infrastructure. Begins the control sequence that determines when and how to print a document. (Overrides PrintController.OnStartPrint(PrintDocument, PrintEventArgs).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

This class implements a PrintController and adds a status dialog box. A print controller specifies how a PrintDocument is printed.

For a list of initial property values for an instance of the PrintControllerWithStatusDialog class, see the PrintControllerWithStatusDialog constructor.

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

The following code example shows how to create a new PrintController and assign it to the PrintController property. The example assumes that you have added the System.Drawing.Printing namespace to the class and that you have created a new instance of a PrintDocument as myDocumentPrinter.


 void myPrint() {
    if (useMyPrintController==true) {
       myDocumentPrinter.PrintController = new myControllerImplementation();     
       if (wantsStatusDialog==true) {
          myDocumentPrinter.PrintController =
            new PrintControllerWithStatusDialog(myDocumentPrinter.PrintController);
       }
    }
    myDocumentPrinter.Print();
 }



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ