PrintForm Class

Article
10/02/2013

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
	PrintForm()	Initializes a new instance of the PrintForm class.
	PrintForm(IContainer)	Initializes a new instance of the PrintForm class, specifying the IContainer in which it will be parented.
	PrintForm(Form)	Initializes a new instance of the PrintForm class, specifying the Form where it will be parented.

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	DocumentName	Gets or sets the document name to display (for example, in a print status dialog box or printer queue) while printing the document.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Form	Gets or sets the form to be printed.
	PrintAction	Gets or sets a value indicating whether the output is directed to a printer, to a print preview window, or to a file.
	PrinterSettings	Gets or sets a PrinterSettings object that you can use to specify various properties of a printer.
	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.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)

Top

Methods

	Name	Description
	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.)
	Dispose()	Releases all resources used by the Component. (Inherited from Component.)
	Dispose(Boolean)	Releases the unmanaged resources used by a PrintForm component and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService	Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnBeginPrint	Raises the BeginPrint event.
	OnEndPrint	Raises the EndPrint event.
	OnQueryPageSettings	Raises the QueryPageSettings event.
	Print()	Sends an image of a Windows Form to the destination specified by the PrintAction property.
	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
	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
	BeginPrint	Occurs when the Print method is called, before the first page of the document prints.
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	EndPrint	Occurs when the last page of the document has printed.
	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.

Share via