Back to all docs
API Reference / Telerik.WinControls.UI / RadPrintDocument
New to Telerik UI for WinForms? Start a free 30-day trial

RadPrintDocument

Class

Defines a reusable object that sends output to a printer and manages the whole printing process, when printing from an application. Can be associated with any object that implements the IPrintable interface.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:
C#
public class RadPrintDocument : PrintDocument, IComponent, IDisposable

Inheritance: objectMarshalByRefObjectComponentPrintDocumentRadPrintDocument

Implements: IComponentIDisposable

Inherited Members PrintDocument.OnQueryPageSettings(QueryPageSettingsEventArgs)PrintDocument.Print()PrintDocument.ToString()PrintDocument.DefaultPageSettingsPrintDocument.DocumentNamePrintDocument.OriginAtMarginsPrintDocument.PrintControllerPrintDocument.PrinterSettingsPrintDocument.BeginPrintPrintDocument.EndPrintPrintDocument.PrintPagePrintDocument.QueryPageSettingsComponent.Dispose()Component.Dispose(bool)Component.GetService(Type)Component.CanRaiseEventsComponent.EventsComponent.SiteComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)...

Constructors

RadPrintDocument()

Initializes a new instance of the RadPrintDocument class.

C#
public RadPrintDocument()

Fields

DatePrintedString

C#
public const string DatePrintedString = "[Date Printed]"

LogoString

C#
public const string LogoString = "[Logo]"

PageNumberString

C#
public const string PageNumberString = "[Page #]"

TimePrintedString

C#
public const string TimePrintedString = "[Time Printed]"

TotalPagesString

C#
public const string TotalPagesString = "[Total Pages]"

UserNamePrintedString

C#
public const string UserNamePrintedString = "[User Name]"

Properties

AssociatedObject

Gets or sets the IPrintable object associated with this document for printing.

C#
[Browsable(true)]
public IPrintable AssociatedObject { get; set; }
Property Value:

An object that implements IPrintable, or null if no object is associated.

AutoPortraitLandscape

Gets or sets a value indicating whether the orientation should be automatically determined based on the content.

C#
[Browsable(true)]
public bool AutoPortraitLandscape { get; set; }
Property Value:

true to automatically choose between portrait and landscape; otherwise, false.

CurrentPage

Gets or sets the currently selected page. This page will be the first to be printed when the PrintRange is set to Current or Selection.

C#
[Browsable(false)]
public int CurrentPage { get; set; }

FooterFont

Gets or sets the font of the page footer.

C#
[Browsable(true)]
public Font FooterFont { get; set; }

FooterHeight

Gets or sets the height of the footer area in hundredths of an inch.

C#
[Browsable(true)]
public int FooterHeight { get; set; }
Property Value:

An integer representing the footer height.

HeaderFont

Gets or sets the font of the page header.

C#
[Browsable(true)]
public Font HeaderFont { get; set; }

HeaderHeight

Gets or sets the height of the header area.

C#
[Browsable(true)]
public int HeaderHeight { get; set; }

IsPrinting

Indicates whether the printing process is running.

C#
[Browsable(false)]
public bool IsPrinting { get; }

Landscape

Gets or sets a value indicating whether the document should be printed in landscape orientation.

C#
[Browsable(true)]
public bool Landscape { get; set; }
Property Value:

true to print in landscape orientation; otherwise, false for portrait orientation.

LeftFooter

Gets or sets the text that will be printed near the bottom left corner of the page.

C#
[Browsable(true)]
public string LeftFooter { get; set; }

LeftHeader

Gets or sets the text that will be printed near the upper left corner of the page.

C#
[Browsable(true)]
public string LeftHeader { get; set; }

Gets or sets the logo image that will be printed when the [Logo] placeholder is used in headers or footers.

C#
[Browsable(true)]
public Image Logo { get; set; }
Property Value:

An Image representing the logo, or null if no logo is set.

Margins

Gets or sets the margins for the printed page.

C#
[Browsable(true)]
public Margins Margins { get; set; }
Property Value:

A Margins object that represents the page margins, or null to use the default.

MiddleFooter

Gets or sets the text that will be printed at the bottom center of the page.

C#
[Browsable(true)]
public string MiddleFooter { get; set; }

MiddleHeader

Gets or sets the text that will be printed at the top center of the page.

C#
[Browsable(true)]
public string MiddleHeader { get; set; }

PageCount

Gets the total page count. The value is populated when the printing process begins.

C#
[Browsable(false)]
public int PageCount { get; }

PaperSize

Gets or sets the paper size for printing.

C#
[Browsable(true)]
public PaperSize PaperSize { get; set; }
Property Value:

A PaperSize object that represents the size of the paper, or null to use the default.

PaperSource

Gets or sets the paper source (tray) from which to get the paper.

C#
[Browsable(true)]
public PaperSource PaperSource { get; set; }
Property Value:

A PaperSource object that represents the paper source, or null to use the default.

PrintedPage

Gets the number of the page being printed. The value of this property changes during the printing process.

C#
[Browsable(false)]
public int PrintedPage { get; }

ReverseFooterOnEvenPages

Gets or sets a value indicating whether the left and right footer positions should be reversed on even pages.

C#
[Browsable(true)]
public bool ReverseFooterOnEvenPages { get; set; }
Property Value:

true to reverse the footer positions on even pages; otherwise, false.

ReverseHeaderOnEvenPages

Gets or sets a value indicating whether the left and right header positions should be reversed on even pages.

C#
[Browsable(true)]
public bool ReverseHeaderOnEvenPages { get; set; }
Property Value:

true to reverse the header positions on even pages; otherwise, false.

RightFooter

Gets or sets the text that will be printed near the bottom right corner of the page.

C#
[Browsable(true)]
public string RightFooter { get; set; }

RightHeader

Gets or sets the text that will be printed near the upper right corner of the page.

C#
[Browsable(true)]
public string RightHeader { get; set; }

SelectionLength

Gets or sets the count of the selected pages. This indicates how many pages will be printed when the PrintRange is set to Selection.

C#
[Browsable(false)]
public int SelectionLength { get; set; }

Watermark

Gets or sets the watermark settings for the printed pages.

C#
[Browsable(true)]
public RadPrintWatermark Watermark { get; set; }
Property Value:

A RadPrintWatermark object that defines the watermark properties, or null if no watermark is used.

Methods

HasLogoInHeaderFooterString(string)

Determines whether the specified string contains the logo placeholder token.

C#
protected bool HasLogoInHeaderFooterString(string s)
Parameters:sstring

The string to check for the logo placeholder.

Returns:

bool

true if the string contains the logo placeholder; otherwise, false.

OnAssociatedObjectChanged()

Called when the associated printable object has changed.

C#
protected virtual void OnAssociatedObjectChanged()

OnBeginPrint(PrintEventArgs)

Handles the beginning of the print job by initializing the page count and setting up print parameters.

C#
protected override void OnBeginPrint(PrintEventArgs e)
Parameters:ePrintEventArgs

A PrintEventArgs that contains the event data.

Overrides: PrintDocument.OnBeginPrint(PrintEventArgs)

OnEndPrint(PrintEventArgs)

Handles the end of the print job by finalizing the printing process and cleaning up resources.

C#
protected override void OnEndPrint(PrintEventArgs e)
Parameters:ePrintEventArgs

A PrintEventArgs that contains the event data.

Overrides: PrintDocument.OnEndPrint(PrintEventArgs)

OnPrintPage(PrintPageEventArgs)

Handles the printing of each page by coordinating the watermark, content, header, and footer rendering.

C#
protected override void OnPrintPage(PrintPageEventArgs e)
Parameters:ePrintPageEventArgs

A PrintPageEventArgs that contains the event data.

Overrides: PrintDocument.OnPrintPage(PrintPageEventArgs)

ParseHeaderFooterString(string)

Parses a header or footer string by replacing placeholder tokens with their actual values.

C#
protected string ParseHeaderFooterString(string s)
Parameters:sstring

The string containing placeholder tokens to be replaced.

Returns:

string

The parsed string with placeholders replaced by actual values.

PrintFooter(PrintPageEventArgs)

Prints the footer part of the page.

C#
protected virtual void PrintFooter(PrintPageEventArgs args)
Parameters:argsPrintPageEventArgs

The printing arguments.

PrintHeader(PrintPageEventArgs)

Prints the header part of the page.

C#
protected virtual void PrintHeader(PrintPageEventArgs args)
Parameters:argsPrintPageEventArgs

The printing arguments.

PrintLogo(Graphics, Rectangle)

Renders the logo image within the specified rectangle.

C#
protected virtual void PrintLogo(Graphics g, Rectangle rect)
Parameters:gGraphics

The Graphics object to draw on.

rectRectangle

The Rectangle area where the logo should be drawn.

PrintWatermark(PrintPageEventArgs)

Prints the watermark of the page.

C#
protected virtual void PrintWatermark(PrintPageEventArgs args)
Parameters:argsPrintPageEventArgs

The printing arguments.

In this article
DefinitionConstructorsRadPrintDocument()FieldsDatePrintedStringLogoStringPageNumberStringTimePrintedStringTotalPagesStringUserNamePrintedStringPropertiesAssociatedObjectAutoPortraitLandscapeCurrentPageFooterFontFooterHeightHeaderFontHeaderHeightIsPrintingLandscapeLeftFooterLeftHeaderMarginsMiddleFooterMiddleHeaderPageCountPaperSizePaperSourcePrintedPageReverseFooterOnEvenPagesReverseHeaderOnEvenPagesRightFooterRightHeaderSelectionLengthWatermarkMethodsHasLogoInHeaderFooterString(string)OnAssociatedObjectChanged()OnBeginPrint(PrintEventArgs)OnEndPrint(PrintEventArgs)OnPrintPage(PrintPageEventArgs)ParseHeaderFooterString(string)PrintFooter(PrintPageEventArgs)PrintHeader(PrintPageEventArgs)PrintLogo(Graphics, Rectangle)PrintWatermark(PrintPageEventArgs)
Not finding the help you need?
Contact Support