Class BreakableComponent
Base class for report components that can break across pages.
Inheritance
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public class BreakableComponent : ReportComponentBase, IFRSerializable
Constructors
BreakableComponent()
Initializes a new instance of the BreakableComponent class with default settings.
Declaration
public BreakableComponent()
Properties
BreakTo
Gets or sets a reference to another similar object that will be used for displaying the text that not fit in this object.
Declaration
public BreakableComponent BreakTo { get; set; }
Property Value
Type | Description |
---|---|
BreakableComponent |
CanBreak
Gets or sets a value that determines if the component can break its contents across pages.
Declaration
public bool CanBreak { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
Assign(Base)
Declaration
public override void Assign(Base source)
Parameters
Type | Name | Description |
---|---|---|
Base | source |
Overrides
Break(BreakableComponent)
Breaks the contents of the object.
Declaration
public virtual bool Break(BreakableComponent breakTo)
Parameters
Type | Name | Description |
---|---|---|
BreakableComponent | breakTo | Object to put the part of content to that does not fit in this object. These two objects must have the same type. |
Returns
Type | Description |
---|---|
System.Boolean | true if there is enough space in this object to display at least one text line. |
Remarks
Do not call this method directly, it is used by the report engine. You should override it if you are writing a new FastReport object.
This method must break the contents of the object. The part of content that fit in current object's bounds should remain in this object, the part that does not fit should be transferred to breakTo object.
Break(BreakableComponent, out Single)
Breaks the contents of the object.
Declaration
public virtual bool Break(BreakableComponent breakTo, out float excessiveHeight)
Parameters
Type | Name | Description |
---|---|---|
BreakableComponent | breakTo | Object to put the part of content to that does not fit in this object. These two objects must have the same type. |
System.Single | excessiveHeight | Excessive height that should be moved to the second part. |
Returns
Type | Description |
---|---|
System.Boolean | true if there is enough space in this object to display at least one text line. |
Remarks
Do not call this method directly, it is used by the report engine. You should override it if you are writing a new FastReport object.
This method must break the contents of the object. The part of content that fit in current object's bounds should remain in this object, the part that does not fit should be transferred to breakTo object.
Serialize(FRWriter)
Declaration
public override void Serialize(FRWriter writer)
Parameters
Type | Name | Description |
---|---|---|
FRWriter | writer |