Class BandBase

Base class for all bands.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
BreakableComponent
BandBase
ChildBand
ColumnFooterBand
ColumnHeaderBand
DataBand
HeaderFooterBandBase
OverlayBand
PageFooterBand
PageHeaderBand
ReportTitleBand
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public abstract class BandBase : BreakableComponent, IDisposable, IFRSerializable, IParent

Constructors

BandBase()

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

Declaration
public BandBase()

Properties

AbsLeft

Declaration
public override float AbsLeft { get; }
Property Value
Type Description
System.Single
Overrides

AbsRowNo

Gets an absolute row number (the same value returned by the "AbsRow#" system variable).

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

AbsTop

Declaration
public override float AbsTop { get; }
Property Value
Type Description
System.Single
Overrides

AfterLayoutEvent

Gets or sets a script event name that will be fired after the child objects layout was finished.

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

BeforeLayoutEvent

Gets or sets a script event name that will be fired before the band layouts its child objects.

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

Child

Gets or sets a child band that will be printed right after this band.

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

Typical use of child band is to print several objects that can grow or shrink. It also can be done using the shift feature (via ShiftMode property), but in some cases it's not possible.

FirstRowStartsNewPage

Gets or sets a value indicating that the first row can start a new report page.

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

Use this property if StartNewPage is set to true. Normally the new page is not started when printing the first data row, to avoid empty first page.

Guides

Gets or sets collection of guide lines for this band.

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

IsFirstRow

Gets a value indicating that this is the first data row.

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

IsLastRow

Gets a value indicating that this is the last data row.

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

KeepChild

Gets or sets a value indicating that the band should be printed together with its child band.

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

Objects

Gets a collection of report objects belongs to this band.

Declaration
public ReportComponentCollection Objects { get; }
Property Value
Type Description
ReportComponentCollection

OutlineExpression

Gets or sets an outline expression.

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

Outline is a tree control displayed in the preview window. It represents the prepared report structure. Each outline node can be clicked to navigate to the item in the prepared report.

To create the outline, set this property to any valid expression that represents the outline node text. This expression will be calculated when band is about to print, and its value will be added to the outline. Thus, nodes' hierarchy in the outline is similar to the bands' hierarchy in a report. That means there will be the main and subordinate outline nodes, corresponding to the main and subordinate bands in a report (a report with two levels of data or with groups can exemplify the point).

PrintOnBottom

Gets or sets a value indicating that the band should be printed on the page bottom.

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

RepeatBandNTimes

Gets or sets a value that determines the number of repetitions of the same band.

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

Repeated

Gets a value indicating that band is reprinted on a new page.

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

This property is applicable to the DataHeaderBand and GroupHeaderBand only. It returns true if its RepeatOnAllPages property is true and band is reprinted on a new page.

RowNo

Gets a row number (the same value returned by the "Row#" system variable).

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

This property can be used when running a report. It may be useful to print hierarchical row numbers in a master-detail report, like this:

1.1

1.2

2.1

2.2

To do this, put the Text object on a detail data band with the following text in it:

[Data1.RowNo].[Data2.RowNo]

StartNewPage

Gets or sets a value indicating that the band should be printed from a new page.

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

New page is not generated when printing very first group or data row. This is made to avoid empty first page.

Methods

AddChild(Base)

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

AddLastToFooter(BreakableComponent)

Declaration
public void AddLastToFooter(BreakableComponent breakTo)
Parameters
Type Name Description
BreakableComponent breakTo

Assign(Base)

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

Break(BreakableComponent)

Declaration
public override bool Break(BreakableComponent breakTo)
Parameters
Type Name Description
BreakableComponent breakTo
Returns
Type Description
System.Boolean
Overrides

CalcHeight()

Declaration
public override float CalcHeight()
Returns
Type Description
System.Single
Overrides

CanContain(Base)

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

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

GetData()

Declaration
public override void GetData()
Overrides

GetDataAsync(CancellationToken)

Declaration
public override async Task GetDataAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
Overrides

GetExpressions()

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

InitializeComponent()

Declaration
public override void InitializeComponent()
Overrides

OnAfterLayout(EventArgs)

This method fires the AfterLayout event and the script code connected to the AfterLayoutEvent.

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

Event data.

OnBeforeLayout(EventArgs)

This method fires the BeforeLayout event and the script code connected to the BeforeLayoutEvent.

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

Event data.

RemoveChild(Base)

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

RestoreState()

Declaration
public override void RestoreState()
Overrides

SaveState()

Declaration
public override void SaveState()
Overrides

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

UpdateLayout(Single, Single)

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

Validate()

Declaration
public override List<ValidationError> Validate()
Returns
Type Description
System.Collections.Generic.List<ValidationError>
Overrides

Events

AfterLayout

This event occurs after the child objects layout was finished.

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

BeforeLayout

This event occurs before the band layouts its child objects.

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

Implements