Show / Hide Table of Contents

Class HeaderFooterBandBase

Base class for headers and footers which support the "Keep With Data" and "Repeat on Every Page" features.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
BreakableComponent
BandBase
HeaderFooterBandBase
DataFooterBand
DataHeaderBand
GroupFooterBand
GroupHeaderBand
ReportSummaryBand
Implements
IFRSerializable
IParent
Inherited Members
BandBase.BeforeLayout
BandBase.AfterLayout
BandBase.StartNewPage
BandBase.RepeatBandNTimes
BandBase.FirstRowStartsNewPage
BandBase.PrintOnBottom
BandBase.KeepChild
BandBase.OutlineExpression
BandBase.Child
BandBase.Objects
BandBase.Repeated
BandBase.BeforeLayoutEvent
BandBase.AfterLayoutEvent
BandBase.AbsLeft
BandBase.AbsTop
BandBase.Guides
BandBase.RowNo
BandBase.AbsRowNo
BandBase.IsFirstRow
BandBase.IsLastRow
BandBase.GetChildObjects(ObjectCollection)
BandBase.CanContain(Base)
BandBase.AddChild(Base)
BandBase.RemoveChild(Base)
BandBase.GetChildOrder(Base)
BandBase.SetChildOrder(Base, Int32)
BandBase.UpdateLayout(Single, Single)
BandBase.GetExpressions()
BandBase.SaveState()
BandBase.RestoreState()
BandBase.CalcHeight()
BandBase.Break(BreakableComponent)
BandBase.GetData()
BandBase.InitializeComponent()
BandBase.OnBeforeLayout(EventArgs)
BandBase.OnAfterLayout(EventArgs)
BreakableComponent.CanBreak
BreakableComponent.BreakTo
ReportComponentBase.BeforePrint
ReportComponentBase.AfterPrint
ReportComponentBase.AfterData
ReportComponentBase.Click
ReportComponentBase.Exportable
ReportComponentBase.Border
ReportComponentBase.Fill
ReportComponentBase.FillColor
ReportComponentBase.Bookmark
ReportComponentBase.Hyperlink
ReportComponentBase.CanGrow
ReportComponentBase.CanShrink
ReportComponentBase.GrowToBottom
ReportComponentBase.ShiftMode
ReportComponentBase.Style
ReportComponentBase.EvenStyle
ReportComponentBase.HoverStyle
ReportComponentBase.EvenStylePriority
ReportComponentBase.PrintOn
ReportComponentBase.BeforePrintEvent
ReportComponentBase.AfterPrintEvent
ReportComponentBase.AfterDataEvent
ReportComponentBase.ClickEvent
ReportComponentBase.FlagSimpleBorder
ReportComponentBase.FlagUseBorder
ReportComponentBase.FlagUseFill
ReportComponentBase.FlagPreviewVisible
ReportComponentBase.FlagSerializeStyle
ReportComponentBase.FlagProvidesHyperlinkValue
ReportComponentBase.Cursor
ReportComponentBase.MouseMoveEvent
ReportComponentBase.MouseUpEvent
ReportComponentBase.MouseDownEvent
ReportComponentBase.MouseEnterEvent
ReportComponentBase.MouseLeaveEvent
ReportComponentBase.ApplyStyle(Style)
ReportComponentBase.SaveStyle()
ReportComponentBase.RestoreStyle()
ReportComponentBase.DrawBackground(FRPaintEventArgs)
ReportComponentBase.Draw(FRPaintEventArgs)
ReportComponentBase.IsVisible(FRPaintEventArgs)
ReportComponentBase.Deserialize(FRReader)
ReportComponentBase.OnClick(EventArgs)
ReportComponentBase.OnAfterLoad()
ReportComponentBase.HasClickListeners()
ReportComponentBase.FinalizeComponent()
ReportComponentBase.OnBeforePrint(EventArgs)
ReportComponentBase.OnAfterPrint(EventArgs)
ReportComponentBase.OnAfterData(EventArgs)
ComponentBase.AbsBottom
ComponentBase.AbsBounds
ComponentBase.AbsRight
ComponentBase.Anchor
ComponentBase.Bottom
ComponentBase.Bounds
ComponentBase.ClientSize
ComponentBase.Dock
ComponentBase.GroupIndex
ComponentBase.Height
ComponentBase.Left
ComponentBase.Right
ComponentBase.Tag
ComponentBase.Top
ComponentBase.Visible
ComponentBase.Printable
ComponentBase.Width
Base.Name
Base.Restrictions
Base.Flags
Base.Parent
Base.BaseName
Base.ClassName
Base.Report
Base.Page
Base.ChildObjects
Base.AllObjects
Base.ZOrder
Base.IsAncestor
Base.IsDesigning
Base.IsPrinting
Base.IsRunning
Base.OriginalComponent
Base.SetProp(Base, Base)
Base.FloatDiff(Single, Single)
Base.DeserializeSubItems(FRReader)
Base.ExtractDefaultMacros(String)
Base.Dispose(Boolean)
Base.SetFlags(Flags, Boolean)
Base.SetReport(Report)
Base.SetName(String)
Base.SetParent(Base)
Base.SetParentCore(Base)
Base.FindObject(String)
Base.CreateUniqueName()
Base.Clear()
Base.BaseAssign(Base)
Base.AssignAll(Base)
Base.HasParent(Base)
Base.HasFlag(Flags)
Base.HasRestriction(Restrictions)
Base.InvokeEvent(String, Object)
Base.GetCustomScript()
Base.ExtractMacros()
Base.IsHaveToConvert(Object)
Base.GetConvertedObjects()
Base.ForEachAllConvectedObjects(Object)
Namespace: FastReport
Assembly: FastReport.OpenSource.dll
Syntax
public class HeaderFooterBandBase : BandBase, IFRSerializable, IParent

Properties

KeepWithData

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

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

RepeatOnEveryPage

Gets or sets a value that determines whether to repeat this band on every page.

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

When band is repeated, its Repeated property is set to true. You can use it to show any additional information on the band. To do this, use the PrintOn property which can be set to "Rpeeated". In that case the object will be printed only on the repeated band.

Methods

Assign(Base)

Copies the contents of another, similar object.

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

Source object to copy the contents from.

Overrides
BandBase.Assign(Base)
Remarks

Call Assign to copy the properties from another object of the same type. The standard form of a call to Assign is

destination.Assign(source);

which tells the destination object to copy the contents of the source object to itself. In this method, all child objects are ignored. If you want to copy child objects, use the AssignAll(Base) method.

See Also
AssignAll(Base)

Serialize(FRWriter)

Serializes the object.

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

Writer object.

Overrides
BandBase.Serialize(FRWriter)
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll(Base) methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

Implements

IFRSerializable
IParent
Back to top Generated by DocFX