Class ReportPage

Represents a report page.

Inheritance
System.Object
Base
ComponentBase
PageBase
ReportPage
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public class ReportPage : PageBase, IDisposable, IFRSerializable, IParent
Remarks

To get/set a paper size and orientation, use the PaperWidth, PaperHeight and Landscape properties. Note that paper size is measured in millimeters.

Report page can contain one or several bands with report objects. Use the ReportTitle, ReportSummary, PageHeader, PageFooter, ColumnHeader, ColumnFooter, Overlay properties to get/set the page bands. The Bands property holds the list of data bands or groups. Thus you may add several databands to this property to create master-master reports, for example.

caution

Report page can contain bands only. You cannot place report objects such as TextObject on a page.

Examples

This example shows how to create a page with one ReportTitleBand and DataBand bands and add it to the report.

ReportPage page = new ReportPage();
// set the paper in millimeters
page.PaperWidth = 210;
page.PaperHeight = 297;
// create report title
page.ReportTitle = new ReportTitleBand();
page.ReportTitle.Name = "ReportTitle1";
page.ReportTitle.Height = Units.Millimeters * 10;
// create data band
DataBand data = new DataBand();
data.Name = "Data1";
data.Height = Units.Millimeters * 10;
// add data band to the page
page.Bands.Add(data);
// add page to the report
report.Pages.Add(page);

Constructors

ReportPage()

Initializes a new instance of the ReportPage class with default settings.

Declaration
public ReportPage()

Properties

BackPage

Uses this page as a back page for previously printed pages.

Declaration
public bool BackPage { get; set; }
Property Value
Type Description
System.Boolean

Bands

Gets the collection of data bands or group header bands.

Declaration
public BandCollection Bands { get; }
Property Value
Type Description
BandCollection
Remarks

The Bands property holds the list of data bands or group headers. Thus you may add several databands to this property to create master-master reports, for example.

Border

Gets or sets the page border that will be printed inside the page printing area.

Declaration
public Border Border { get; set; }
Property Value
Type Description
Border

BottomMargin

Gets or sets the bottom page margin, in millimeters.

Declaration
public float BottomMargin { get; set; }
Property Value
Type Description
System.Single

ColumnFooter

Gets or sets a column footer band.

Declaration
public ColumnFooterBand ColumnFooter { get; set; }
Property Value
Type Description
ColumnFooterBand

ColumnHeader

Gets or sets a column header band.

Declaration
public ColumnHeaderBand ColumnHeader { get; set; }
Property Value
Type Description
ColumnHeaderBand

Columns

Gets the page columns settings.

Declaration
public PageColumns Columns { get; }
Property Value
Type Description
PageColumns

CreatePageEvent

Gets or sets a script event name that will be fired when the report engine create new page. On this stage can be modified page properties.

Declaration
public string CreatePageEvent { get; set; }
Property Value
Type Description
System.String

Duplex

Gets or sets the printer duplex mode that will be used when printing this page.

Declaration
public Duplex Duplex { get; set; }
Property Value
Type Description
Duplex

ExportAlias

Gets or sets the page name on export

Declaration
public string ExportAlias { get; set; }
Property Value
Type Description
System.String

ExtraDesignWidth

Gets or sets a value indicating whether the page has extra width in the report designer.

Declaration
public bool ExtraDesignWidth { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property may be useful if you work with such objects as Matrix and Table.

Fill

Gets or sets the page background fill.

Declaration
public FillBase Fill { get; set; }
Property Value
Type Description
FillBase

FinishPageEvent

Gets or sets a script event name that will be fired when the report engine finished this page.

Declaration
public string FinishPageEvent { get; set; }
Property Value
Type Description
System.String

FirstPageSource

Gets or sets the paper source for the first printed page.

Declaration
public int FirstPageSource { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property represents the paper source (printer tray) that will be used when printing the first page. To set the source for other pages, use LastPageSource and OtherPagesSource properties.

Note: This property uses the raw number of the paper source.

Guides

Gets or sets the page guidelines.

Declaration
public FloatCollection Guides { get; set; }
Property Value
Type Description
FloatCollection
Remarks

This property hold all vertical guidelines. The horizontal guidelines are owned by the bands (see Guides property).

HeightInPixels

Gets the current page height in pixels.

Declaration
public float HeightInPixels { get; }
Property Value
Type Description
System.Single

Landscape

Gets or sets a value indicating that page should be in landscape orientation.

Declaration
public bool Landscape { get; set; }
Property Value
Type Description
System.Boolean
Remarks

When you change this property, it will automatically swap paper width and height, as well as paper margins.

LastPageSource

Gets or sets the paper source for the last printed page.

Declaration
public int LastPageSource { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property represents the paper source (printer tray) that will be used when printing the last page. To set the source for other pages, use FirstPageSource and OtherPagesSource properties.

Note: This property uses the raw number of the paper source.

LeftMargin

Gets or sets the left page margin, in millimeters.

Declaration
public float LeftMargin { get; set; }
Property Value
Type Description
System.Single

LinkToPage

Get or set a link to the page.

Declaration
public ReportPage.PageLink LinkToPage { get; set; }
Property Value
Type Description
ReportPage.PageLink

ManualBuildEvent

Gets or sets a script event name that will be fired when the report engine is about to print databands in this page.

Declaration
public string ManualBuildEvent { get; set; }
Property Value
Type Description
System.String

MirrorMargins

Gets or sets a value indicating that even pages should swap its left and right margins when previewed or printed.

Declaration
public bool MirrorMargins { get; set; }
Property Value
Type Description
System.Boolean

OtherPagesSource

Gets or sets the paper source for all printed pages except the first one.

Declaration
public int OtherPagesSource { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property represents the paper source (printer tray) that will be used when printing all pages except the first one and the last one. To set source for first and last pages, use FirstPageSource and LastPageSource properties.

Note: This property uses the raw number of the paper source.

OutlineExpression

Gets or sets an outline expression.

Declaration
public string OutlineExpression { get; set; }
Property Value
Type Description
System.String
Remarks

For more information, see OutlineExpression property.

Overlay

Gets or sets an overlay band.

Declaration
public OverlayBand Overlay { get; set; }
Property Value
Type Description
OverlayBand

Gets or sets a page footer band.

Declaration
public PageFooterBand PageFooter { get; set; }
Property Value
Type Description
PageFooterBand

PageHeader

Gets or sets a page header band.

Declaration
public PageHeaderBand PageHeader { get; set; }
Property Value
Type Description
PageHeaderBand

PaperHeight

Gets or sets a height of the paper, in millimeters.

Declaration
public float PaperHeight { get; set; }
Property Value
Type Description
System.Single

PaperWidth

Gets or sets a width of the paper, in millimeters.

Declaration
public float PaperWidth { get; set; }
Property Value
Type Description
System.Single

PrintOnPreviousPage

Gets or sets a value indicating whether to start to print this page on a free space of the previous page.

Declaration
public bool PrintOnPreviousPage { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property can be used if you have two or more pages in the report template.

PrintOnRollPaper

Gets or sets the value indicating whether the unlimited page should be printed on roll paper.

Declaration
public bool PrintOnRollPaper { get; set; }
Property Value
Type Description
System.Boolean

RawPaperSize

Gets or sets the raw index of a paper size.

Declaration
public int RawPaperSize { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property stores the RawKind value of a selected papersize. It is used to distinguish between several papers with the same size (for ex. "A3" and "A3 with no margins") used in some printer drivers.

It is not obligatory to set this property. FastReport will select the necessary paper using the PaperWidth and PaperHeight values.

ReportSummary

Gets or sets a report summary band.

Declaration
public ReportSummaryBand ReportSummary { get; set; }
Property Value
Type Description
ReportSummaryBand

ReportTitle

Gets or sets a report title band.

Declaration
public ReportTitleBand ReportTitle { get; set; }
Property Value
Type Description
ReportTitleBand

ResetPageNumber

Gets or sets a value indicating that FastReport engine must reset page numbers before printing this page.

Declaration
public bool ResetPageNumber { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property can be used if you have two or more pages in the report template.

RightMargin

Gets or sets the right page margin, in millimeters.

Declaration
public float RightMargin { get; set; }
Property Value
Type Description
System.Single

StartOnOddPage

Gets or sets a value indicating whether this page will start on an odd page only.

Declaration
public bool StartOnOddPage { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property is useful to print booklet-type reports. Setting this property to true means that this page will start to print on an odd page only. If necessary, an empty page will be added to the prepared report before this page will be printed.

StartPageEvent

Gets or sets a script event name that will be fired when the report engine starts this page.

Declaration
public string StartPageEvent { get; set; }
Property Value
Type Description
System.String

Subreport

Gets or sets the reference to a parent SubreportObject that owns this page.

Declaration
public SubreportObject Subreport { get; set; }
Property Value
Type Description
SubreportObject
Remarks

This property is null for regular report pages. See the SubreportObject for details.

TitleBeforeHeader

Gets or sets a value indicating that ReportTitle band should be printed before the PageHeader band.

Declaration
public bool TitleBeforeHeader { get; set; }
Property Value
Type Description
System.Boolean

TopMargin

Gets or sets the top page margin, in millimeters.

Declaration
public float TopMargin { get; set; }
Property Value
Type Description
System.Single

UnlimitedHeight

Gets or sets a value indicating whether the page has unlimited height.

Declaration
public bool UnlimitedHeight { get; set; }
Property Value
Type Description
System.Boolean

UnlimitedHeightValue

Get or set the current height of unlimited page.

Declaration
public float UnlimitedHeightValue { get; set; }
Property Value
Type Description
System.Single

UnlimitedWidth

Gets or sets a value indicating whether the page has unlimited width.

Declaration
public bool UnlimitedWidth { get; set; }
Property Value
Type Description
System.Boolean

UnlimitedWidthValue

Get or set the current width of unlimited page.

Declaration
public float UnlimitedWidthValue { get; set; }
Property Value
Type Description
System.Single

Watermark

Gets or sets the page watermark.

Declaration
public Watermark Watermark { get; set; }
Property Value
Type Description
Watermark
Remarks

To enabled watermark, set its Enabled property to true.

WidthInPixels

Gets the current page width in pixels.

Declaration
public float WidthInPixels { get; }
Property Value
Type Description
System.Single

Methods

AddChild(Base)

Declaration
public virtual void AddChild(Base child)
Parameters
Type Name Description
Base child

Assign(Base)

Declaration
public override void Assign(Base source)
Parameters
Type Name Description
Base source
Overrides

CanContain(Base)

Declaration
public virtual bool CanContain(Base child)
Parameters
Type Name Description
Base child
Returns
Type Description
System.Boolean

Deserialize(FRReader)

Declaration
public override void Deserialize(FRReader reader)
Parameters
Type Name Description
FRReader reader
Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

Draw(FRPaintEventArgs)

Declaration
public override void Draw(FRPaintEventArgs e)
Parameters
Type Name Description
FRPaintEventArgs e

ExtractMacros()

Declaration
public override void ExtractMacros()
Overrides

GetChildObjects(ObjectCollection)

Declaration
public virtual void GetChildObjects(ObjectCollection list)
Parameters
Type Name Description
ObjectCollection list

GetChildOrder(Base)

Declaration
public virtual int GetChildOrder(Base child)
Parameters
Type Name Description
Base child
Returns
Type Description
System.Int32

GetExpressions()

Declaration
public override string[] GetExpressions()
Returns
Type Description
System.String[]
Overrides

OnCreatePage(EventArgs)

This method fires the CreatePage event and the script code connected to the CreatePageEvent.

Declaration
public void OnCreatePage(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnFinishPage(EventArgs)

This method fires the FinishPage event and the script code connected to the FinishPageEvent.

Declaration
public void OnFinishPage(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnManualBuild(EventArgs)

This method fires the ManualBuild event and the script code connected to the ManualBuildEvent.

Declaration
public void OnManualBuild(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnStartPage(EventArgs)

This method fires the StartPage event and the script code connected to the StartPageEvent.

Declaration
public void OnStartPage(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

RemoveChild(Base)

Declaration
public virtual void RemoveChild(Base child)
Parameters
Type Name Description
Base child

Serialize(FRWriter)

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer
Overrides

SetChildOrder(Base, Int32)

Declaration
public virtual void SetChildOrder(Base child, int order)
Parameters
Type Name Description
Base child
System.Int32 order

UpdateBandsWidth()

Updates width of all bands on this page according to page's paper settings.

Declaration
public void UpdateBandsWidth()

UpdateLayout(Single, Single)

Declaration
public virtual void UpdateLayout(float dx, float dy)
Parameters
Type Name Description
System.Single dx
System.Single dy

Events

CreatePage

This event occurs when the report engine create new page. On this stage can be modified page properties.

Declaration
public event EventHandler CreatePage
Event Type
Type Description
System.EventHandler

FinishPage

This event occurs when the report engine finished this page.

Declaration
public event EventHandler FinishPage
Event Type
Type Description
System.EventHandler

ManualBuild

This event occurs when the report engine is about to print databands in this page.

Declaration
public event EventHandler ManualBuild
Event Type
Type Description
System.EventHandler

StartPage

This event occurs when the report engine starts this page.

Declaration
public event EventHandler StartPage
Event Type
Type Description
System.EventHandler

Implements