CancelablePrintEventArgs Class

Event parameters used for initialize print event, and before print event

Syntax

Visual Basic

'Declaration
 
Public Class CancelablePrintEventArgs 
   Inherits System.ComponentModel.CancelEventArgs

C#

public class CancelablePrintEventArgs : System.ComponentModel.CancelEventArgs 

Example

Following code sets some of the properties available in InitializePrint 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.

Visual Basic

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

  Private Sub UltraGrid1_InitializePrint(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs) Handles ultraGrid1.InitializePrint

      ' One could conditionally set Cancel to true to cancel the printing.
      If Me.CheckBox1.Checked Then
          e.Cancel = True
          Return
      End If

      ' 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

C#

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

private void ultraGrid1_InitializePrint(object sender, Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs e)
{

	// One could conditionally set Cancel to true to cancel the printing.
	if ( this.checkBox1.Checked )
	{
		e.Cancel = true;
		return;
	}

	// 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