Version

InitializePrintPreview Event

Occurs when a print preview is first initiated by invoking the PrintPreview method.
Syntax
'Declaration
 
Public Event InitializePrintPreview As InitializePrintPreviewEventHandler
public event InitializePrintPreviewEventHandler InitializePrintPreview
Event Data

The event handler receives an argument of type CancelablePrintPreviewEventArgs containing data related to this event. The following CancelablePrintPreviewEventArgs properties provide information specific to this event.

PropertyDescription
Cancel (Inherited from System.ComponentModel.CancelEventArgs) 
DefaultLogicalPageLayoutInfo (Inherited from Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs)The default layout info, for all logical pages
PrintDocument (Inherited from Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs)The print document (read-only)
PrintLayout (Inherited from Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs)Returns the print layout.
PrintPreviewSettings Settings used to alter the print preview dialog
Remarks

The InitializePrintPreview event occurs when the print job is first initiated via the PrintPreview method. It gives you the opportunity to set the default parameters for the print preview (level of zoom, preview window title and icon) and to apply default print job settings (such as page header and footer, margins, etc.) to the data being previewed. You use the PrintInfo object passed to the event via the printinfo parameter to apply these settings.

After you have set up the default print settings in the InitializePrintPreview event, the Print Preview screen will be displayed to the end user, previewing what the print job will look like using the settings you have specified. The user can view different parts of the report or change the settings of the print job by interacting directly with the provided interface. They can also choose to print directly from the preview screen, which will trigger the InitializePrint event. depending on how the PrintPreview method was invoked, the Print dialog may also be displayed.

The PrintInfo object is only accessible during this event, the BeforePrint event, the InitializePrint event and the InitializeLogicalPrintPage event.

Example
Following code sets some of the properties available in InitializePrintPreview event.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub UltraGrid1_InitializePrintPreview(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.CancelablePrintPreviewEventArgs) Handles ultraGrid1.InitializePrintPreview

      ' Set the zomm level to 100 % in the print preview.
      e.PrintPreviewSettings.Zoom = 1.0

      ' Set the location and size of the print preview dialog.
      e.PrintPreviewSettings.DialogLeft = SystemInformation.WorkingArea.X
      e.PrintPreviewSettings.DialogTop = SystemInformation.WorkingArea.Y
      e.PrintPreviewSettings.DialogWidth = SystemInformation.WorkingArea.Width
      e.PrintPreviewSettings.DialogHeight = SystemInformation.WorkingArea.Height

      ' Horizontally fit everything in a signle page.
      e.DefaultLogicalPageLayoutInfo.FitWidthToPages = 1

      ' Set up the header and the footer.
      e.DefaultLogicalPageLayoutInfo.PageHeader = "Title"
      e.DefaultLogicalPageLayoutInfo.PageHeaderHeight = 40
      e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.FontData.SizeInPoints = 14
      e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.TextHAlign = HAlign.Center
      e.DefaultLogicalPageLayoutInfo.PageHeaderBorderStyle = UIElementBorderStyle.Solid

      ' Use <#> token in the string to designate page numbers.
      e.DefaultLogicalPageLayoutInfo.PageFooter = "Page <#>."
      e.DefaultLogicalPageLayoutInfo.PageFooterHeight = 40
      e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.TextHAlign = HAlign.Right
      e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.FontData.Italic = DefaultableBoolean.True
      e.DefaultLogicalPageLayoutInfo.PageFooterBorderStyle = UIElementBorderStyle.Solid

      ' Set the ClippingOverride to Yes.
      e.DefaultLogicalPageLayoutInfo.ClippingOverride = ClippingOverride.Yes

      ' Set the document name through the PrintDocument which returns a PrintDocument object.
      e.PrintDocument.DocumentName = "Document Name"

  End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void ultraGrid1_InitializePrintPreview(object sender, Infragistics.Win.UltraWinGrid.CancelablePrintPreviewEventArgs e)
{

	// Set the zomm level to 100 % in the print preview.
	e.PrintPreviewSettings.Zoom = 1.0;

	// Set the location and size of the print preview dialog.
	e.PrintPreviewSettings.DialogLeft = SystemInformation.WorkingArea.X;
	e.PrintPreviewSettings.DialogTop = SystemInformation.WorkingArea.Y;
	e.PrintPreviewSettings.DialogWidth = SystemInformation.WorkingArea.Width;
	e.PrintPreviewSettings.DialogHeight  = SystemInformation.WorkingArea.Height;

	// Horizontally fit everything in a signle page.
	e.DefaultLogicalPageLayoutInfo.FitWidthToPages = 1;

	// Set up the header and the footer.
	e.DefaultLogicalPageLayoutInfo.PageHeader = "Title";
	e.DefaultLogicalPageLayoutInfo.PageHeaderHeight = 40;
	e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.FontData.SizeInPoints = 14;
	e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.TextHAlign = HAlign.Center;
	e.DefaultLogicalPageLayoutInfo.PageHeaderBorderStyle = UIElementBorderStyle.Solid;
	
	// Use <#> token in the string to designate page numbers.
	e.DefaultLogicalPageLayoutInfo.PageFooter = "Page <#>.";
	e.DefaultLogicalPageLayoutInfo.PageFooterHeight= 40;
	e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.TextHAlign = HAlign.Right;
	e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.FontData.Italic = DefaultableBoolean.True;
	e.DefaultLogicalPageLayoutInfo.PageFooterBorderStyle = UIElementBorderStyle.Solid;

	// Set the ClippingOverride to Yes.
	e.DefaultLogicalPageLayoutInfo.ClippingOverride = ClippingOverride.Yes;

	// Set the document name through the PrintDocument which returns a PrintDocument object.
	e.PrintDocument.DocumentName = "Document Name";

}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also