Class BusinessObjectDataSource

Represents a datasource based on business object of IEnumerable type.

Inheritance
System.Object
Base
DataComponentBase
Column
DataSourceBase
BusinessObjectDataSource
Implements
Inherited Members
Namespace: FastReport.Data
Assembly: FastReport.dll
Syntax
public class BusinessObjectDataSource : DataSourceBase, IDisposable, IFRSerializable, IParent
Remarks

Do not use this class directly. To register a business object, use the Report.RegisterData method.

Methods

Deserialize(FRReader)

Deserializes the object.

Declaration
public override void Deserialize(FRReader reader)
Parameters
Type Name Description
FRReader reader

Reader 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 restore the state. It may happen when:

  • loading the report from a file or stream;
  • loading the report from the designer's undo buffer;
  • assigning another object to this object using the Assign(Base) or AssignAll methods;
  • loading the object from the designer's clipboard;
  • loading the object from the preview pages.

GetValue(Column)

Gets data stored in a specified column.

Declaration
protected override object GetValue(Column column)
Parameters
Type Name Description
Column column

The column.
Returns
Type Description
System.Object

An object that contains the data.
Overrides

GetValue(String)

Gets data stored in a specified column.

Declaration
protected override object GetValue(string alias)
Parameters
Type Name Description
System.String alias

The column alias.
Returns
Type Description
System.Object

An object that contains the data.
Overrides

InitSchema()

Initializes the datasource schema.

Declaration
public override void InitSchema()
Overrides
Remarks

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

InitSchemaAsync(CancellationToken)

Declaration
public override Task InitSchemaAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
Overrides

LoadData(ArrayList)

Loads the datasource with data.

Declaration
public override void LoadData(ArrayList rows)
Parameters
Type Name Description
System.Collections.ArrayList rows

Rows to fill with data.
Overrides
Remarks

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

LoadDataAsync(ArrayList, CancellationToken)

Declaration
public override Task LoadDataAsync(ArrayList rows, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Collections.ArrayList rows
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Events

LoadBusinessObject

Occurs when FastReport engine loads data source with data from a business object.

Declaration
public event LoadBusinessObjectEventHandler LoadBusinessObject
Event Type
Type Description
LoadBusinessObjectEventHandler
Remarks

Use this event if you want to implement load-on-demand. Event handler must load the data into your business object.

Implements