New to Telerik Reporting? Start a free 30-day trial

PageSettings

Class

Specifies settings that apply to a single, printed page.

Definition

Namespace:Telerik.Reporting.Drawing

Assembly:Telerik.Reporting.dll

Syntax:

[TypeConverter(typeof(PageSettingsConverter))]
public class PageSettings : ReportObject

Inheritance: objectReportObjectPageSettings

Inherited Members ReportObject.ToString(string[])

Constructors

PageSettings()

Internal use only

public PageSettings()

PageSettings(PageSettings, PrinterSettings)

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

public PageSettings(PageSettings pageSettings, PrinterSettings printerSettings)

Parameters:pageSettingsPageSettings

A PageSettings object specifying the landscape and paper kind.

printerSettingsPrinterSettings

A PrinterSettings object specifying the papers size and margins.

Properties

BackgroundColor

Color

Gets or sets the background color of the page.

public Color BackgroundColor { get; set; }

Property Value:

A Color that represents the background color of the page. The default is 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 Color object.

BackgroundImage

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

public BackgroundImage BackgroundImage { get; }

Property Value:

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.

public BorderColor BorderColor { get; }

Property Value:

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 Black by default.

BorderStyle

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

public BorderStyle BorderStyle { get; }

Property Value:

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.

public BorderWidth BorderWidth { get; }

Property Value:

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

int

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

public int ColumnCount { get; set; }

Property Value:

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

Unit

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

public Unit ColumnSpacing { get; set; }

Property Value:

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

bool

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

public bool ContinuousPaper { get; set; }

Property Value:

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

Landscape

bool

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

public bool Landscape { get; set; }

Property Value:

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

Margins

MarginsU

Gets or sets the margins for this page.

public MarginsU Margins { get; set; }

Property Value:

A MarginsU that represents the margins for the page.

PaperKind

Gets or sets the paper kind for the page.

public PaperKind PaperKind { get; set; }

Property Value:

A PaperKind that represents the kind of the paper.

PaperSize

SizeU

Gets or sets the paper size for the page.

public SizeU PaperSize { get; set; }

Property Value:

A SizeU that represents the size of the paper.

Watermarks

WatermarkCollection

Specifies a collection of watermarks for the page.

public WatermarkCollection Watermarks { get; }

Methods

Clone()

object

This member implements Clone()

public object Clone()

Returns:

object

The cloned PageSettings.

ToPageSettings(PrinterSettings)

PageSettings

Returns a PageSettings object based on the given PrinterSettings parameter.

public PageSettings ToPageSettings(PrinterSettings printerSettings)

Parameters:printerSettingsPrinterSettings

A PrinterSettings object from which to create the PageSettings.

Returns:

PageSettings

A PageSettings object initialized from the printerSettings.