Class DataSelectorControl
Represents the control with two lists (available items and selected items).
Inheritance
Inherited Members
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class DataSelectorControl : DataFilterBaseControl, IComponent, IDisposable, IFRSerializable, IHasEditor
Remarks
The control allows to select one or several items and then filter the datasource which it is connected to. All you need is to setup the DataColumn property.
Constructors
DataSelectorControl()
Initializes a new instance of the DataSelectorControl class with default settings.
Declaration
public DataSelectorControl()
Properties
AutoFill
This property is not relevant to this class.
Declaration
[Browsable(false)]
public bool AutoFill { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AutoFilter
This property is not relevant to this class.
Declaration
[Browsable(false)]
public bool AutoFilter { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Height
Gets or sets the height of the object.
Declaration
public override float Height { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Overrides
Remarks
This property value is measured in the screen pixels. Use Units class to convert a value to desired units.
Sorted
Gets or sets a value indicating that the items must be sorted.
Declaration
public bool Sorted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Width
Gets or sets the width of the object.
Declaration
public override float Width { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Overrides
Remarks
This property value is measured in the screen pixels. Use Units class to convert a value to desired units.
Methods
Draw(FRPaintEventArgs)
Draws the object.
Declaration
public override void Draw(FRPaintEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
FRPaintEventArgs | e | Paint event args. |
Overrides
Remarks
This method is widely used in the FastReport. It is called each time when the object needs to draw or print itself.
In order to draw the object correctly, you should multiply the object's bounds by the scale parameter.
cache parameter is used to optimize the drawing speed. It holds all items such as pens, fonts, brushes, string formats that was used before. If the item with requested parameters exists in the cache, it will be returned (instead of create new item and then dispose it).
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.
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).