Class CheckBoxObject

Represents a check box object.

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

Constructors

CheckBoxObject()

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

Declaration
public CheckBoxObject()

Properties

CheckColor

Gets or sets a color of the check symbol.

Declaration
public Color CheckColor { get; set; }
Property Value
Type Description
Color

Checked

Gets or set a value indicating whether the check box is in the checked state.

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

CheckedSymbol

Gets or sets a symbol that will be displayed when the check box is in the checked state.

Declaration
public CheckedSymbol CheckedSymbol { get; set; }
Property Value
Type Description
CheckedSymbol

CheckWidthRatio

Gets or sets the check symbol width ratio.

Declaration
public float CheckWidthRatio { get; set; }
Property Value
Type Description
System.Single
Remarks

Valid values are from 0.2 to 2.

DataColumn

Gets or sets a data column name bound to this control.

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

Value must be in the form "[Datasource.Column]".

Editable

Gets or sets editable for pdf export

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

Expression

Gets or sets an expression that determines whether to show a check.

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

HideIfUnchecked

Gets or sets a value determines whether to hide the checkbox if it is in the unchecked state.

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

UncheckedSymbol

Gets or sets a symbol that will be displayed when the check box is in the unchecked state.

Declaration
public UncheckedSymbol UncheckedSymbol { get; set; }
Property Value
Type Description
UncheckedSymbol

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

Draw(FRPaintEventArgs)

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

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

GetExpressions()

Gets all expressions contained in the object.

Declaration
public override string[] GetExpressions()
Returns
Type Description
System.String[]

Array of expressions or null if object contains no expressions.
Overrides
Remarks

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

This method is called by FastReport each time before run a report. FastReport do this to collect all expressions and compile them. For example, GetExpressions method of the TextObject class parses the text and returns all expressions found in the text.

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

Implements