Class CheckBoxControl

Represents a Windows CheckBox. Wraps the System.Windows.Forms.CheckBox control.

Inheritance
System.Object
Base
ComponentBase
DialogComponentBase
DialogControl
DataFilterBaseControl
ButtonBaseControl
CheckBoxControl
Implements
Inherited Members
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class CheckBoxControl : ButtonBaseControl, IDisposable, IFRSerializable

Constructors

CheckBoxControl()

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

Declaration
public CheckBoxControl()

Properties

Appearance

Gets or sets the value that determines the appearance of a CheckBox control. Wraps the System.Windows.Forms.CheckBox.Appearance property.

Declaration
public Appearance Appearance { get; set; }
Property Value
Type Description
System.Windows.Forms.Appearance

CheckAlign

Gets or sets the horizontal and vertical alignment of the check mark on a CheckBox control. Wraps the System.Windows.Forms.CheckBox.CheckAlign property.

Declaration
public ContentAlignment CheckAlign { get; set; }
Property Value
Type Description
System.Drawing.ContentAlignment

CheckBox

Gets an internal CheckBox.

Declaration
[Browsable(false)]
public CheckBox CheckBox { get; }
Property Value
Type Description
System.Windows.Forms.CheckBox

Checked

Gets or set a value indicating whether the CheckBox is in the checked state. Wraps the System.Windows.Forms.CheckBox.Checked property.

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

CheckedChangedEvent

Gets or sets a script method name that will be used to handle the CheckedChanged event.

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

CheckState

Gets or sets the state of the CheckBox. Wraps the System.Windows.Forms.CheckBox.CheckState property.

Declaration
public CheckState CheckState { get; set; }
Property Value
Type Description
System.Windows.Forms.CheckState

ThreeState

Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. Wraps the System.Windows.Forms.CheckBox.ThreeState property.

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

Methods

AttachEvents()

Attaches Control events to its event handlers.

Declaration
protected override void AttachEvents()
Overrides
Remarks

Override this method if your custom control has own events.

DetachEvents()

Detaches Control events from its event handlers.

Declaration
protected override void DetachEvents()
Overrides
Remarks

Override this method if your custom control has own events. In this method, you should detach control's events that were attached in the AttachEvents() method.

GetValue()

Returns value entered in the control.

Declaration
protected override object GetValue()
Returns
Type Description
System.Object

The value of type supported by this control.
Overrides
Remarks

This method must return a value entered by the user. For example, TextBox control must return its Text property value. If this control supports multi-selection, return selected values in an array, for example string[] array for CheckedListBox.

OnCheckedChanged(EventArgs)

This method fires the CheckedChanged event and the script code connected to the CheckedChangedEvent.

Declaration
public virtual void OnCheckedChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Event data.

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

Events

CheckedChanged

Occurs when the value of the Checked property changes. Wraps the System.Windows.Forms.CheckBox.CheckedChanged event.

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

Implements