Class BandBase
Base class for all bands.
Inheritance
System.Object
BandBase
Assembly: FastReport.Base.dll
Syntax
public abstract class BandBase : BreakableComponent, IFRSerializable, IParent
Constructors
BandBase()
Initializes a new instance of the BandBase class with default settings.
Declaration
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
Remarks
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
Guides
Gets or sets collection of guide lines for this band.
Declaration
public FloatCollection Guides { get; set; }
Property Value
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
OutlineExpression
Gets or sets an outline expression.
Declaration
public string OutlineExpression { get; set; }
Property Value
Type |
Description |
System.String |
|
Remarks
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
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
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
Methods
AddChild(Base)
Declaration
public virtual void AddChild(Base child)
Parameters
Type |
Name |
Description |
Base |
child |
|
Declaration
public void AddLastToFooter(BreakableComponent breakTo)
Parameters
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
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
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
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
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
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