Share via


PrintForm Class

Enables printing an image of a Windows Form at run time.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.VisualBasic.PowerPacks.Printing.PrintForm

Namespace:  Microsoft.VisualBasic.PowerPacks.Printing
Assembly:  Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

Syntax

'Declaration
<ToolboxBitmapAttribute(GetType(PrintForm), "Microsoft.VisualBasic.PowerPacks.Printing.PrintForm.bmp")> _
Public Class PrintForm _
    Inherits Component
[ToolboxBitmapAttribute(typeof(PrintForm), "Microsoft.VisualBasic.PowerPacks.Printing.PrintForm.bmp")]
public class PrintForm : Component
[ToolboxBitmapAttribute(typeof(PrintForm), L"Microsoft.VisualBasic.PowerPacks.Printing.PrintForm.bmp")]
public ref class PrintForm : public Component
[<ToolboxBitmapAttribute(typeof(PrintForm), "Microsoft.VisualBasic.PowerPacks.Printing.PrintForm.bmp")>]
type PrintForm =  
    class 
        inherit Component 
    end
public class PrintForm extends Component

The PrintForm type exposes the following members.

Constructors

  Name Description
Public method PrintForm() Initializes a new instance of the PrintForm class.
Public method PrintForm(IContainer) Initializes a new instance of the PrintForm class, specifying the IContainer in which it will be parented.
Public method PrintForm(Form) Initializes a new instance of the PrintForm class, specifying the Form where it will be parented.

Top

Properties

  Name Description
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property DocumentName Gets or sets the document name to display (for example, in a print status dialog box or printer queue) while printing the document.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property Form Gets or sets the form to be printed.
Public property PrintAction Gets or sets a value indicating whether the output is directed to a printer, to a print preview window, or to a file.
Public property PrinterSettings Gets or sets a PrinterSettings object that you can use to specify various properties of a printer.
Public property PrintFileName Gets or sets the file name of an Encapsulated PostScript file and the path to which the file will be saved when the PrintAction property is set to PrintToFile.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)

Top

Methods

  Name Description
Public method CreateObjRef Security Critical. Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by a PrintForm component and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetLifetimeService Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnBeginPrint Raises the BeginPrint event.
Protected method OnEndPrint Raises the EndPrint event.
Protected method OnQueryPageSettings Raises the QueryPageSettings event.
Public method Print() Sends an image of a Windows Form to the destination specified by the PrintAction property.
Public method Print(Form, PrintForm.PrintOption) Sends an image of a Windows Form to the destination specified by the PrintAction property, specifying the form and printing options
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

  Name Description
Public event BeginPrint Occurs when the Print method is called, before the first page of the document prints.
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event EndPrint Occurs when the last page of the document has printed.
Public event QueryPageSettings Occurs immediately before each page is printed.

Top

Remarks

The PrintForm component enables you to print an image of a form to a printer, to a print preview window, or to a file at run time. Its behavior replaces that of the PrintForm method in earlier versions of Visual Basic.

Examples

The following example shows a common use of the PrintForm component.

Dim pf As New PrintForm
pf.Form = Me
pf.PrintAction = PrintToPrinter
pf.Print()

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualBasic.PowerPacks.Printing Namespace

Other Resources

PrintForm Component (Visual Basic)

How to: Print a Form by Using the PrintForm Component (Visual Basic)

How to: Print the Client Area of a Form (Visual Basic)

How to: Print Client and Non-Client Areas of a Form (Visual Basic)

How to: Print a Scrollable Form (Visual Basic)

Deploying Applications That Reference the PrintForm Component (Visual Basic)