Class CheckedListBoxControl
Displays a ListBox in which a check box is displayed to the left of each item. Wraps the System.Windows.Forms.CheckedListBox control.
Inheritance
Inherited Members
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class CheckedListBoxControl : ListBoxBaseControl, IComponent, IDisposable, IFRSerializable, IHasEditorConstructors
CheckedListBoxControl()
Initializes a new instance of the CheckedListBoxControl class with default settings.
Declaration
public CheckedListBoxControl()Properties
CheckedIndices
Collection of checked indexes in this CheckedListBox. Wraps the System.Windows.Forms.CheckedListBox.CheckedIndices property.
Declaration
[Browsable(false)]
public CheckedListBox.CheckedIndexCollection CheckedIndices { get; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.CheckedListBox.CheckedIndexCollection |
CheckedItems
Collection of checked items in this CheckedListBox. Wraps the System.Windows.Forms.CheckedListBox.CheckedItems property.
Declaration
[Browsable(false)]
public CheckedListBox.CheckedItemCollection CheckedItems { get; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.CheckedListBox.CheckedItemCollection |
CheckedListBox
Gets an internal CheckedListBox.
Declaration
[Browsable(false)]
public CheckedListBox CheckedListBox { get; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.CheckedListBox |
CheckOnClick
Gets or sets a value indicating whether the check box should be toggled when an item is selected. Wraps the System.Windows.Forms.CheckedListBox.CheckOnClick property.
Declaration
public bool CheckOnClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
DrawMode
This property is not relevant to this class.
Declaration
[Browsable(false)]
public override DrawMode DrawMode { get; set; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.DrawMode |
Overrides
ItemCheckEvent
Gets or sets a script method name that will be used to handle the ItemCheck event.
Declaration
public string ItemCheckEvent { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ItemHeight
This property is not relevant to this class.
Declaration
[Browsable(false)]
public override int ItemHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Overrides
Items
Gets the items of the CheckedListBox. Wraps the System.Windows.Forms.CheckedListBox.Items property.
Declaration
public CheckedListBox.ObjectCollection Items { get; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.CheckedListBox.ObjectCollection |
ItemsText
Gets or sets the string that contains all items text.
Declaration
public override string ItemsText { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
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.
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
Overrides
FillData(DataSourceBase, Column)
Fills the control with data.
Declaration
protected override void FillData(DataSourceBase dataSource, Column column)Parameters
| Type | Name | Description |
|---|---|---|
| DataSourceBase | dataSource | The data source. |
| Column | column | The data column. |
Overrides
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.
OnItemCheck(ItemCheckEventArgs)
This method fires the ItemCheck event and the script code connected to the ItemCheckEvent.
Declaration
public virtual void OnItemCheck(ItemCheckEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.ItemCheckEventArgs | 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
ItemCheck
Occurs after item's check state was changed. Wraps the System.Windows.Forms.CheckedListBox.ItemCheck event.
Declaration
public event ItemCheckEventHandler ItemCheckEvent Type
| Type | Description |
|---|---|
| System.Windows.Forms.ItemCheckEventHandler |