Class DataComponentBase

The base class for all data components such as data sources, columns.

Inheritance
System.Object
Base
DataComponentBase
Column
CubeSourceBase
DataConnectionBase
Relation
Implements
Inherited Members
Namespace: FastReport.Data
Assembly: FastReport.Base.dll
Syntax
public class DataComponentBase : Base, IDisposable, IFRSerializable

Constructors

DataComponentBase()

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

Declaration
public DataComponentBase()

Properties

Alias

Gets or sets alias of this object.

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

Alias is a human-friendly name of this object. It may contain any symbols (including spaces and national symbols).

Enabled

Gets or sets a value indicates that object is enabled and thus can be used in a report.

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

This property is used to hide an object from the Data Dictionary window. Hidden objects are still accessible in the "Data|Choose Data Source..." menu.

IsAliased

Gets a value indicates that this object has an alias.

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

Reference

Gets or sets a reference to the data object.

Declaration
public object Reference { get; set; }
Property Value
Type Description
System.Object
Remarks

This property is used to support FastReport.Net infrastructure. Do not use it directly.

ReferenceName

Gets or sets a name of the data object.

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

This property is used to support FastReport.Net infrastructure. Do not use it directly.

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

InitializeComponent()

Initializes the object before running a report.

Declaration
public virtual void InitializeComponent()
Remarks

This method is used by the report engine, do not call it directly.

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

SetName(String)

Sets the object's name.

Declaration
public override void SetName(string value)
Parameters
Type Name Description
System.String value

New name.
Overrides
Remarks

This method is for internal use only. It just sets a new name without any checks (unlike the Name property setter).

See Also

Implements