Class ContainerObject

Container object that may contain child objects.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
ContainerObject
RFIDLabel
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public class ContainerObject : ReportComponentBase, IDisposable, IFRSerializable, IParent

Constructors

ContainerObject()

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

Declaration
public ContainerObject()

Properties

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 container layouts its child objects.

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

Objects

Gets the collection of child objects.

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

Methods

AddChild(Base)

Adds a child object to this object's childs.

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

Object to add.

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
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 method.

See Also

CalcHeight()

Calculates the object's height.

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

Actual object's height, in pixels.
Overrides
Remarks

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed to display all the text lines.

CanContain(Base)

Gets a value indicating that this object can contain the specified child object.

Declaration
public virtual bool CanContain(Base child)
Parameters
Type Name Description
Base child

Child object.
Returns
Type Description
System.Boolean

true if this object can contain the specified child object; otherwise, false.

Draw(FRPaintEventArgs)

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

GetChildObjects(ObjectCollection)

Gets a list of child objects.

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

List to fill with values.

GetChildOrder(Base)

Returns z-order of the specified child object.

Declaration
public virtual int GetChildOrder(Base child)
Parameters
Type Name Description
Base child

Child object.
Returns
Type Description
System.Int32

Z-order of the specified object.
Remarks

This method must return the index of a specified child object in the internal child list.

GetData()

Gets the data from a datasource that the object is connected to.

Declaration
public override void GetData()
Overrides
Remarks

This method is called by the report engine before processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should get the data from a datasource that the object is connected to.

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

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)

Removes a specified object from this object's childs.

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

RestoreState()

Restores the object's state after printing it.

Declaration
public override void RestoreState()
Overrides
Remarks

This method is called by the report engine after processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should restore the object properties that were saved by the SaveState() method.

SaveState()

Saves the object's state before printing it.

Declaration
public override void SaveState()
Overrides
Remarks

This method is called by the report engine before processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should save any object properties that may be changed during the object printing. The standard implementation saves the object's bounds, visibility, bookmark and hyperlink.

Serialize(FRWriter)

Serializes the object.

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

Writer object.
Overrides
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 methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

SetChildOrder(Base, Int32)

Sets the z-order of the specified object.

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

Child object.
System.Int32 order

New Z-order.
Remarks

This method must place the specified child object at the specified position in the internal child list.

UpdateLayout(Single, Single)

Updates the children layout when the size of this object is changed by dx, dy values.

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

X delta.
System.Single dy

Y delta.
Remarks

This method must update positions/sizes of child objects whose Dock or Anchor properties are set to non-default values.

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 container layouts its child objects.

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

Implements