SyntaxConstructors   PageSettings()  PageSettings(PageSettings, PrinterSettings)Properties   BackgroundColor  BackgroundImage  BorderColor  BorderStyle  BorderWidth  ColumnCount  ColumnSpacing  ContinuousPaper  Landscape  Margins  PaperKind  PaperSize  WatermarksMethods   Clone()  ToPageSettings(PrinterSettings)

Class PageSettings

Specifies settings that apply to a single, printed page.

Inheritance

System.Object

ReportObject

PageSettings

Inherited Members

ReportObject.ToString(String[])

Namespace: Telerik.Reporting.Drawing

Assembly: Telerik.Reporting.dll

Syntax

public class PageSettings : ReportObject, ICloneable

Remarks

The PageSettings class is used to specify settings that modify the way a page will be printed.

Constructors

PageSettings()

Declaration

public PageSettings()

PageSettings(PageSettings, PrinterSettings)

Initializes a new instance of the PageSettings class with the specified System.Drawing.Printing.PageSettings and System.Drawing.Printing.PrinterSettings.

Declaration

public PageSettings(PageSettings pageSettings, PrinterSettings printerSettings)

Parameters

System.Drawing.Printing.PageSettings pageSettings A System.Drawing.Printing.PageSettings object specifying the landscape and paper kind.

System.Drawing.Printing.PrinterSettings printerSettings A System.Drawing.Printing.PrinterSettings object specifying the papers size and margins.

Properties

BackgroundColor

Gets or sets the background color of the page.

Declaration

public Color BackgroundColor { get; set; }

Property Value

System.Drawing.Color A System.Drawing.Color that represents the background color of the page. The default is System.Drawing.Color.Empty, which indicates that this property is not set.

Remarks

Use the BackgroundColor property to specify the background color of the page. This property is set using a System.Drawing.Color object.

BackgroundImage

Gets a BackgroundImage object that controls the image displayed in the background of the page.

Declaration

public BackgroundImage BackgroundImage { get; }

Property Value

BackgroundImage An BackgroundImage that represents the image to display in the background of the report item. Report items have no background image by default.

BorderColor

Gets a BorderColor object used to define the page border color.

Declaration

public BorderColor BorderColor { get; }

Property Value

BorderColor A BorderColor representing the page border color.

Remarks

You can set the page border color by using the properties Default, Left, Right, Top, and Bottom. The Default property is used to set all borders colors at once. All borders are System.Drawing.Color.Black by default.

BorderStyle

Gets a BorderStyle object used to define the page border style.

Declaration

public BorderStyle BorderStyle { get; }

Property Value

BorderStyle A BorderStyle representing the page border style.

Remarks

You can set the page border style by using the properties Default, Left, Right, Top, and Bottom. The Default property is used to set all borders styles at once. All borders are BorderType.None by default.

BorderWidth

Gets a BorderWidth object used to define the page border width.

Declaration

public BorderWidth BorderWidth { get; }

Property Value

BorderWidth A BorderWidth representing the page border width.

Remarks

You can set the page border width by using the properties Default, Left, Right, Top, and Bottom. The Default property is used to set all borders widths at once. All borders are 1pt wide by default.

ColumnCount

Gets or sets a value that specifies how many columns are present in the DetailSection of the report.

Declaration

public int ColumnCount { get; set; }

Property Value

System.Int32 An integer value specifying the number of columns. The value should be equal to or greater than 1. The default is 1.

Remarks

Column widths are calculated based on the following rule: DetailWidth = ColumnWidth * ColumnCount + ColumSpacing * (ColumnCount - 1)

Multi-column reports are primarily used for printing labels.

ColumnSpacing

Gets or sets a value indicating the space in Units between two adjacent columns.

Declaration

public Unit ColumnSpacing { get; set; }

Property Value

Unit A Unit value specifying the space between two adjacent columns. The value should be a non-negative Unit. The default is Zero

Remarks

This property should be used when there should be some blank space left between adjacent columns.

ContinuousPaper

Gets or sets a value indicating whether the report is printed without being paginated (as one long page).

Declaration

public bool ContinuousPaper { get; set; }

Property Value

System.Boolean true if the report should be printed as one page; otherwise, false. The default value is false

Landscape

Gets or sets a value indicating whether the page is printed in landscape or portrait orientation.

Declaration

public bool Landscape { get; set; }

Property Value

System.Boolean true if the page should be printed in landscape orientation; otherwise, false.

Margins

Gets or sets the margins for this page.

Declaration

public MarginsU Margins { get; set; }

Property Value

MarginsU A MarginsU that represents the margins for the page.

PaperKind

Gets or sets the paper kind for the page.

Declaration

public PaperKind PaperKind { get; set; }

Property Value

System.Drawing.Printing.PaperKind A System.Drawing.Printing.PaperKind that represents the kind of the paper.

PaperSize

Gets or sets the paper size for the page.

Declaration

public SizeU PaperSize { get; set; }

Property Value

SizeU A SizeU that represents the size of the paper.

Watermarks

Specifies a collection of watermarks for the page.

Declaration

public WatermarkCollection Watermarks { get; }

Property Value

WatermarkCollection

Methods

Clone()

This member implements System.ICloneable.Clone

Declaration

public object Clone()

Returns

System.Object The cloned PageSettings.

ToPageSettings(PrinterSettings)

Returns a System.Drawing.Printing.PageSettings object based on the given System.Drawing.Printing.PrinterSettings parameter.

Declaration

public PageSettings ToPageSettings(PrinterSettings printerSettings)

Parameters

System.Drawing.Printing.PrinterSettings printerSettings A System.Drawing.Printing.PrinterSettings object from which to create the System.Drawing.Printing.PageSettings.

Returns

System.Drawing.Printing.PageSettings A System.Drawing.Printing.PageSettings object initialized from the printerSettings.