[]
        
(Showing Draft Content)

C1.Win.List.C1Combo

C1Combo Class

The C1Combo control is used as a multicolumn drop-down list box.

Namespace: C1.Win.List
Assembly: C1.Win.List.8.dll
Syntax
[ToolboxBitmap(typeof(C1Combo), "C1Combo.png")]
[ComplexBindingProperties("DataSource", "DataMember")]
public class C1Combo : ComboBoxContainer, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISupportInitialize
Remarks

C1Combo is independent of C1List, so it can be used alone or in conjunction with C1List. You can place a C1Combo control on a Visual Basic form at design time as you would a C1List control.

The C1Combo control also supports incremental search.

Constructors

Name Description
C1Combo()

Initialize a new instance of C1Combo control.

Properties

Name Description
AddItemCols

Returns or sets the column number for the AddItem mode.

AddItemSeparator

Determines the separation string for columns when using the AddItem method in AddItem mode.

AllowColMove

Enables/disables interactive column movement.

AllowColSelect

Enables/disables interactive column selection.

AllowDrag

Returns or sets the flag indicating if text can be taken from the editor by drag and drop.

AllowHorizontalSplit

Specifies if a user is allowed to create horizontal splits.

AllowSort

Returns or sets whether or not column sort is allowed.

AllowVerticalSplit

Specifies if a user is allowed to create vertical splits.

AlternatingRows

Determines if a list or split displays odd-numbered rows in one style and even-numbered rows in another.

AutoCompletion

Determines whether matching incremental search values are automatically copied to the text portion of a combo during editing.

AutoDropDown

Determines whether the control automatically opens when the user types a character into a cell.

AutoSelect

Determines whether the combo sets its index to the current position of the datasource when it is firstly filled with data.

BackColor

Controls the background color of the list portion of the control.

Bookmark

Returns or sets the bookmark identifying the current row in the list.

Caption

Returns or sets the caption for list.

CaptionHeight

Returns or sets the height of the list caption area. The default value is -1, which means that actual height is set automatically according to the font size. Set this property to 0 to hide the caption.

CaptionStyle

Returns or sets the Style object that controls the appearance of the caption area.

CaptionVisible

Returns or sets the flag indicating if list's caption is visible.

CellTips

Determines whether the list displays a pop-up text window when the cursor is idle.

CellTipsDelay

Determines the amount of time before the cell tip window is displayed.

CellTipsWidth

Returns or sets the width of the cell tip window.

CharacterCasing

Indicates if all characters should be left alone or converted to uppercase or lowercase.

Col

Returns or sets the column position of the current cell.

ColumnCaptionHeight

Returns or sets the height of the column headers.

ColumnFooterHeight

Returns or sets the height of the column footers.

ColumnFooters

Specifies whether footers are displayed.

ColumnHeaders

Specifies whether headers are displayed.

ColumnWidth

Returns or sets the column width for each column in the control.

Columns

Returns a collection of C1DataColumn objects.

DataMember

Returns or sets the name of the data member used to populate the control.

DataMode

Specifies the normal or additem mode.

DataSource

Specifies the data source object used to bind the control to.

DeadAreaBackColor

Controls the background color of the dead area in the list.

DefColWidth

Specifies column width for auto-created columns.

DisplayMember

Returns or sets the DataSource field used for incremental search.

DragMode

Returns or sets the value that indicates whether the combo box or the programmer handles a drag operation.

DrawMode

Gets or sets a value indicating whether your code or the operating system will handle drawing of elements in the list.

DropMode

Returns or sets a value that indicates how the combo box handles drop operations.

EditorBackColor

Controls the background color of the editor portion of the control.

EditorBorderColor

Controls the border color of the editor portion of the control.

EditorFont

Returns or sets the font associated with the text box portion of a C1Combo control.

EditorForeColor

Controls the foreground color of the editor portion of the control.

EditorHeight

Gets/Sets the editor height.

EmptyRows

Returns or sets a value that determines how the list displays rows below the last data row.

Enabled

Indicates whether the control is enabled.

EvenRowStyle

Returns or sets the Style object that controls the appearance of an even-numbered row.

ExtendRightColumn

Returns or sets whether the last column will extend to fill the dead area of the list.

FetchRowStyles

Specifies whether the FetchRowStyle event will be fired.

FlatStyle

Determines the appearance of the list.

FocusedSplit

Gets the Split that has focus.

Font

Returns or sets the font associated with the list portion of a C1Combo control.

FooterStyle

Returns the Style object that controls the appearance of column footers.

ForeColor

Controls the foreground color of the list portion of the control.

HScrollBar

Returns the HBar object that controls the appearance of the horizontal scrollbar.

HeadingStyle

Returns the Style object that controls the appearance of column heading.

HighLightRowStyle

Returns the Style object that controls the appearance of hight light row.

IntegralHeight

Controls whether partial rows are displayed.

ItemHeight

Returns or sets the height of all list rows.

KeepForeColor

Determines whether the fore ground color of text box keeps unchanged when the combo is disabled, this only takes effect when the ComboStyle is DropdownList.

LeftCol

Returns or sets the zero-based index of the leftmost column in a list or split.

LimitToList

Determines if users can enter an entry which is not in the list.

ListCount

Returns the total row number for the control.

MatchCol

Specifies the column where the incremental search is performed on.

MatchCompare

Returns or sets the comparing mode for a search.

MatchEntry

Returns or sets a value indicating how the control performs searches based on user's input.

MatchEntryTimeout

Returns or sets a value indicating the timeout, in milliseconds, for incremental searching.

MaxDropDownItems

The maximum number of items of in the drop-down portion of the combo box.

MaxLength

Gets or sets the maximum number of characters allowed in the editable portion of a combo box.

MouseCursor

Determines the style of the mouse cursor when it is over list portion of the control.

OddRowStyle

Returns or sets the Style object that controls the appearance of an odd-numbered row.

PartialRightColumn

True if rightmost column can be clipped to the edge of a split.

PreferredHeight

Gets the preferred height of the item area of the combo box.

ReadOnly

Controls whether the text in the control can be changed or not.

Row

Returns or sets the position of current list row relative to the first displayed row.

RowDivider

Determines the style of the border drawn between list rows.

RowSubDividerColor

Returns or sets the color of a RowSubDivider.

RowTracking

Controls whether rows are automatically highlighted as the mouse is moved over the C1List control.

ScaleChildren
ScrollTips

Determines whether the list displays a pop-up text window when the scrollbar thumb is dragged.

ScrollTrack

Determines whether the list constantly displays information as it scrolls.

SelectedCols

Returns the SelectedColumnCollection object.

SelectedIndex

Returns or sets the bookmark of the currently selected item.

SelectedStyle

Returns the Style object that controls the appearance of selected cells.

SelectedText

Returns or sets the string containing the currently selected text within the combo box editing window.

SelectedValue

Gets or sets the value of the member property specified by the ValueMember property.

SelectionLength

Returns or sets the number of characters selected within the editing window.

SelectionStart

Returns or sets the starting point of the text selection within the editing window.

Split

Returns current split number.

Splits

Returns a Collection of Split objects.

Style

Returns or sets the normal Style object for the list.

Styles

Returns a collection of named Style objects.

SuperBack

Controls the BackSpace behavior when AutoCompletion and LimitToList are set to true.

Text

Returns or sets the text displayed in the editor.

TextAlign

Determines how the text will be aligned within the editor.

TopIndex

Returns or sets a value containing the bookmark for the first visible row in a list or split.

VScrollBar

Returns or sets the VBar object that controls the appearance of the vertical scrollbar.

ValueMember

Specifies the field name for binding purposes.

VerticalAlign

Gets or sets the vertical alignment of the content in the editor. The default is VerticalAlignEnum.Top.

VisibleCols

Returns the number of visible columns in the current split.

VisibleRows

Returns the number of visible rows in the list.

WillChangeToIndex

Returns the bookmark identifying the will-be selected item in a control.

WillChangeToText

Returns the string identifying the text for the item to be selected.

WillChangeToValue

Returns the object identifying the value to be selected.

Methods

Name Description
AddCellStyle(CellStyleFlag, Style)

Controls the font and color of cells within a list, column, or split according to value.

AddItem(string)

Add a new item to the end in the AddItem mode.

AddItemBegin()

Please use SuspendBinding(), this method will be removed in next release.

AddItemEnd()
AddItemF(string)
AddItemTitles(string)

Sets the column titles in the AddItem mode.

AddRegexCellStyle(CellStyleFlag, Style, string)

Controls the font and color of cells within a list, column, or split according to their contents.

BeginInit()

Signals the object that initialization is starting.

CaptureImage()

Returns an image of the drop down list control.

CellContaining(int, int, out int, out int)

Returns the cell position for a set of coordinates.

ClearCellStyle(CellStyleFlag)

Removes a cell condition established with a previous call to the AddCellStyle method.

ClearFields()

Restores the default list layout.

ClearItems()

Clear all of the items in the AddItem mode.

ClearRegexCellStyle(CellStyleFlag)

Removes a cell condition established with a previous call to the AddRegexCellStyle(CellStyleFlag, Style, string) method.

ClearRegexCellStyle(CellStyleFlag, string)

Removes a cell condition established with a previous call to the AddRegexCellStyle(CellStyleFlag, Style, string) method.

ClearSelCols()

Deselects all selected columns in the current split.

ClearSelected()

Clears all selected rows.

CloseCombo()

Closes the dropdown list of the combo.

ColContaining(int)

Returns the column index containing the specified coordinate.

CreateAccessibilityInstance()

Creates a new accessibility object for the control.

Dispose(bool)

Releases the unmanaged resources used by the object and optionally releases the managed resources.

EndInit()

Signals the object that initialization is complete.

FindString(string)

Finds the first row index such that the cell text starts with string s in the column specified by the DisplayMember property.

FindString(string, int)

Finds the first row index after startIndex such that the cell text starts with string s in the column specified by the DisplayMember property.

FindString(string, int, int)

Finds the first row index after startIndex such that the cell text starts with string s in the given column.

FindString(string, int, string)

Finds the first row index after startIndex such that the cell text starts with string s in the given column.

FindStringExact(string)

Finds the first row index such that the cell text is exactly same with string s in the column specified by the DisplayMember property.

FindStringExact(string, int)

Finds the first row index after startIndex such that the cell text is exactly same with string s in the column specified by the DisplayMember property.

FindStringExact(string, int, int)

Finds the first row index after startIndex such that the cell text is exactly same with string s in the given column.

FindStringExact(string, int, string)

Finds the first row index after startIndex such that the cell text is exactly same with string s in the given column.

GetItemText(int, int)

Get the cell text for C1Combo.

GetItemText(int, string)

Gets the cell text for any cell.

HoldFields()

Holds the current column/field layout.

InsertHorizontalSplit(int)

Inserts a horizontal split at the specified index.

InsertItem(string, int)

Inserts a new item at the index position in the AddItem mode.

InsertVerticalSplit(int)

Inserts a vertical split at the specified index.

LoadLayout(Stream)

Loads a saved layout from the given stream.

LoadLayout(string)

Loads a saved layout from the given file.

OnAfterSort(FilterEventArgs)

Raises the AfterSort event.

OnBindingContextChanged(EventArgs)
OnChange(EventArgs)

Raises the Change event.

OnColFootClick(ColEventArgs)

Raises the ColFootClick event.

OnColHeadClick(ColEventArgs)

Raises the ColHeadClick event.

OnColMove(ColMoveEventArgs)

Raises the ColMove event.

OnColResize(ColResizeEventArgs)

Raises the ColResize event.

OnComboBoxStyleChange(EventArgs)
OnComboBoxStyleChanged(EventArgs)
OnDataSourceChanged(EventArgs)

Raises the DataSourceChanged event.

OnDisplayMemberChanged(EventArgs)

Raises the DisplayMemberChanged event.

OnDragDrop(DragEventArgs)
OnDragEnter(DragEventArgs)
OnDragOver(DragEventArgs)
OnDrawItem(OwnerDrawCellEventArgs)

Raises the DrawItem event.

OnError(ErrorEventArgs)

Raises the Error event.

OnFetchCellStyle(FetchCellStyleEventArgs)

Raises the FetchCellStyle event.

OnFetchCellTips(FetchCellTipsEventArgs)

Raises the FetchCellTips event.

OnFetchRowStyle(FetchRowStyleEventArgs)

Raises the FetchRowStyle event.

OnFetchScrollTips(FetchScrollTipsEventArgs)

Raises the FetchScrollTips event.

OnFontChanged(EventArgs)
OnFormatText(FormatTextEventArgs)

Raises the FormatText event.

OnGotFocus(EventArgs)
OnItemChanged(EventArgs)

Raises the ItemChanged event.

OnKeyDown(KeyEventArgs)
OnKeyPress(KeyPressEventArgs)
OnLeftColChange(SplitEventArgs)

Raises the LeftColChange event.

OnLostFocus(EventArgs)
OnMismatch(MismatchEventArgs)

Raises the Mismatch event.

OnMouseDown(MouseEventArgs)
OnMouseWheel(MouseEventArgs)
OnNotInList(NotInListEventArgs)

Raises the NotInList event.

OnReadOnlyChanged()

Raises the ReadOnlyChanged event.

OnRowChange(EventArgs)

Raises the RowChange event.

OnRowResize(CancelEventArgs)

Raises the RowSize event.

OnScroll(CancelEventArgs)

Raises the Scroll event.

OnSelChange(CancelEventArgs)

Raises the SelChange event.

OnSelectedValueChanged(EventArgs)

Raises the SelectedValueChanged event.

OnSelectionChangeCommitted(EventArgs)

Raises the SelectionChangeCommitted event.

OnSelectionChanging(CancelEventArgs)

Raises the OnSelectionChanging event.

OnTopIndexChange(SplitEventArgs)

Raises the TopIndexChange event.

OnUnboundColumnFetch(UnboundColumnFetchEventArgs)

Raises the UnboundColumnFetch

OnValueMemberChanged(EventArgs)
OpenCombo()

Drops down the list of the combo.

PerformCloseUp()
PointAt(int, int)

Returns one of the PointAtEnum constants, which indicates the kind of list element beneath the specified coordinate pair.

Rebind()

Re-establishes the connection with the bound data source.

Rebind(bool)

Re-establishes the connection with the bound data source.

RemoveHorizontalSplit(int)

Removes a horizontal split at the specified index.

RemoveItem(int)

Removes the item at the given position in the AddItem mode.

RemoveVerticalSplit(int)

Removes a vertical split at the specified index.

ResetCaptionHeight()

Restore the CaptionHeight property to its default value.

ResetColumnCaptionHeight()

Restore the CaptionHeight property to its default value.

ResetColumnFooterHeight()

Restore the ColumnFooterHeight property to its default value.

ResetEditorBackColor()

Restore the EditorBackColor property to its default value.

ResetEditorBorderColor()

Restore the EditorBorderColor property to its default value.

ResetEditorFont()

Restore the EditorFont property to its default value.

ResetEditorForeColor()

Restore the EditorForeColor property to its default value.

ResetEditorHeight()

Restore the EditorHeight property to its default value.

ResetItemHeight()

Restore the ItemHeight property to its default value.

ResetVerticalAlign()

Restores the default value of the VerticalAlign property.

ResumeBinding()

Resumes data binding notification from the datasource.

RowContaining(int)

Returns the zero-based index of the display row containing the specified coordinate.

RowTop(int)

Returns the Y coordinate of the top of a visible row.

SaveLayout(Stream)

Saves the grid's layout.

SaveLayout(Stream, bool)

Saves the grid's layout.

SaveLayout(string, bool)

Saves the grid's layout.

ScrollCtl(int, int)

Scrolls the list data area by the specified number of rows and columns.

Select()

Activates the control.

Select(int, int)

Selects specified text in a combo box's text box.

SelectAll()

Selects all of the text in a combo box's text box.

SetAddItemData(int, int, string)

Updates the cell data for the AddItem mode.

ShouldSerializeCaptionHeight()

Indicates whether the CaptionHeight has a default value.

ShouldSerializeColumnCaptionHeight()

Indicates whether the ColumnCaptionHeight has a default value.

ShouldSerializeColumnFooterHeight()

Indicates whether the ColumnFooterHeight has a default value.

ShouldSerializeEditorBackColor()

Indicates whether the EditorBackColor has a default value.

ShouldSerializeEditorBorderColor()

Indicates whether the EditorBorderColor has a default value.

ShouldSerializeEditorFont()

Indicates whether the EditorFont has a default value.

ShouldSerializeEditorForeColor()

Indicates whether the EditorForeColor has a default value.

ShouldSerializeEditorHeight()

Indicates whether the EditorHeight has a default value.

ShouldSerializeItemHeight()

Indicates whether the ItemHeight has a default value.

ShouldSerializeVerticalAlign()

Indicates whether the VerticalAlign has a default value.

Sort(int, SortDirEnum)

Sorts a specific column for the control.

Sort(string, SortDirEnum)

Sorts a specific column for the control.

SplitContaining(int, int)

Returns the Index value of the split containing the specified coordinate pair.

SuspendBinding()

Temporary suspension of data binding notifications from the datasource.

Events

Name Description
AfterSort

Fires after a column is sorted by clicking the column header.

Change

Fires only if the ComboStyle property is set to 0-Dropdown Combo or 1-Simple Combo, and the user changes the text by typing into the text box portion of the C1Combo control.

ColFootClick

Fires when the footer of the control is clicked.

ColHeadClick

Fires when the headers of the control is clicked.

ColMove

Fires when the user has finished moving the selected columns.

ColResize

Fires after the user has finished resizing a column.

DataSourceChanged

Fires when a bound data source is changed or requeried.

DisplayMemberChanged

Occurs when the DisplayMember property changes.

DrawItem

Fires when any cell is required to be redrawn and DrawMode is set to OwnerDrawFixed or OwnerDrawVariable.

Error

Fires when a data access error occurs.

FetchCellStyle

Fires when the list is about to display cell data in a column whose FetchStyle property is set to True.

FetchCellTips

Fires when the control has focus and the cursor is idle for a small amount of time (defined by the CellTipsDelay property) over a data cell, column header, column footer, split header or control caption bar.

FetchRowStyle

Fires whenever the list is about to display a row of data and the FetchRowStyles property is True.

FetchScrollTips

Fires whenever the list has focus and the scrollbar thumb is moved using the mouse.

FormatText

Fires when the list is about to display cell data in a column whose NumberFormat property is set.

ItemChanged

Fires when the contents of the text box portion of a combo box and the current row in the list portion change simultaneously.

LeftColChange

Fires when the first visible column of a list or split is changed.

Mismatch

Fires when the user enters a value in the text portion of a combo box that is not found in the list portion.

NotInList

Fires when the user enters a value in the text portion of a combo box that is not found in the list portion.

ReadOnlyChanged

Occurs when the ReadOnly property changes.

RowChange

Fires when the user changes a row in the list.

RowResize

Fires when the user has finished resizing a list row.

Scroll

Fires when the user scrolls the control horizontally or vertically using the scroll bars.

SelChange

Fires when the user selects a different range of rows or columns.

SelectedValueChanged

Occurs when the SelectedValue property changes.

SelectionChangeCommitted

Fires when the selected item has changed and that change is displayed in the C1Combo.

SelectionChanging

Fires when the user is being selects a different range of rows or columns.

TopIndexChange

Fires when the first displayed row of a control or split is changed.

UnboundColumnFetch

Fires when the control needs to display the value of a cell in an unbound column.

ValueMemberChanged

Occurs when the ValueMember property changes.