Class DataLookupEdit

CurrencyEdit class encapsulates a CurrencyTextBox control and adds the ability to drop down a popup calculator

Inheritance
System.Object
ButtonEdit
DataLookupEdit
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class DataLookupEdit : ButtonEdit, IEditControlsEmbed, IButtonEditParent, IPopupParent, IPopupItem, IThemedControl, ISupportInitialize, INonClientPaintingSupport, IThemeProvider, IVisualStyle, IDataListViewOwner

Constructors

DataLookupEdit()

Initializes a new instance of the DataLookupEdit class.

Declaration
public DataLookupEdit()

Properties

Columns

Gets or sets the columns that will be displayed in the popup control when the AutoCompleteMode is set to AutoSuggest. The Columns property is a collection of AutoCompleteDataColumnInfo objects that specify the attributes of a column.

Declaration
public AutoCompleteDataColumnInfoCollection Columns { get; set; }
Property Value
Type
AutoCompleteDataColumnInfoCollection
See Also

DataListView

Gets or sets DataListview

Declaration
public DataListView DataListView { get; set; }
Property Value
Type
DataListView

DataSource

Gets or sets the datasource for the DataButtonEdit.

Declaration
public object DataSource { get; set; }
Property Value
Type
System.Object

DropDownList

Gets or sets the drop down list displaying the matches.

Declaration
public DataListView DropDownList { get; set; }
Property Value
Type
DataListView

ImageList

Gets or sets the ImageList that will specify the images that will be used by the popup control when in AutoSuggest Mode.

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

ListView

Gets or sets DataList view

Declaration
public DataListView ListView { get; set; }
Property Value
Type
DataListView

Methods

CloseDataList()

Closes the popup calculator if it is displayed.

Declaration
public void CloseDataList()

DisplayDataListView()

Displays the calculator.

Declaration
public void DisplayDataListView()

Dispose(Boolean)

Cleans up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

bool disposing
Overrides

GetColumns()

Get the AutoComplete DataColumnInfoCollection

Declaration
public AutoCompleteDataColumnInfoCollection GetColumns()
Returns
Type Description
AutoCompleteDataColumnInfoCollection

Returns AutoComplete DataColumnInfoCollection

GetColumnWidth(Int32)

This method implements IDataViewListOwner.GetColumnWidth.

Declaration
public int GetColumnWidth(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

The index of the column for which to return the width.
Returns
Type Description
System.Int32

The width of the column.

GetImageColumnIndex()

This method implements IDataViewListOwner.GetImageColumnIndex.

Declaration
public int GetImageColumnIndex()
Returns
Type Description
System.Int32

The index of the column in the data source that provides the index of images in the assigned image list.

InitializeDropDown()

Initialize the dropdown

Declaration
protected virtual bool InitializeDropDown()
Returns
Type Description
System.Boolean

Returns true if the the dropdown is initialized.

OnBeforeDataListPopupDisplay(CancelEventArgs)

Invokes the BeforeCalculatorPopupDisplay event.

Declaration
protected virtual bool OnBeforeDataListPopupDisplay(CancelEventArgs args)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs args

A BeforeCalculatorPopupDisplayEventArgs that contains the event data.
Returns
Type Description
System.Boolean

Returns true if evet is cancelled.
Remarks

The OnBeforeCalculatorPopupDisplay method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

note

Inheritors: When overriding OnBeforeCalculatorPopupDisplay in a derived class, be sure to call the base class's OnBeforeCalculatorPopupDisplay method so that registered delegates receive the event.

RaiseBeforeDataListPopupDisplayEvent()

Raise Before DataListPopupDisplay Event

Declaration
protected bool RaiseBeforeDataListPopupDisplayEvent()
Returns
Type Description
System.Boolean

Returns true if Datalistpopup display

ShowDataListView(Point)

Shows the calculator at the specified location.

Declaration
public void ShowDataListView(Point location)
Parameters
Type Name Description
System.Drawing.Point location

Location of the Popup.

WireEvents()

Wire events.

Declaration
protected virtual void WireEvents()

Events

BeforeDataListPopupDisplay

Event raised before the calculator popup is displayed.

Declaration
public event CancelEventHandler BeforeDataListPopupDisplay
Event Type
Type
System.ComponentModel.CancelEventHandler

Implements

System.ComponentModel.ISupportInitialize