HypernovaDesktop Components · docs
Binarymission
WinFormsCombo Box › BinaryComboBoxColumn

BinaryComboBoxColumn

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.ListControls

A specialized column type that uses Binarymission's BinaryComboBox (including its multi-column mode) control as its cell editor.

public class BinaryComboBoxColumn : DataGridViewComboBoxColumn

Inherits from / implements: DataGridViewComboBoxColumn

Members at a glance

BinaryComboBoxColumnInitializes a new instance of the BinaryComboBoxColumn class.
AlphaBlendingfactorForFilterAndGroupingPanelBackColorGets or sets the alpha-blending factor to perform alpha blending of colors as described in the property EnableAlphaBlendingForFilterAndGroupingPanelBackColor.
AutoCompleteBasedOnCompleteMatchWithAnItemInTheListGets or sets whether the auto completion mode is based on complete match with an item in the control's list of available items.
AutoCompleteIsCaseSensitiveGets or sets the dropdown style for the combobox editor.
AutoCompleteModeRefer to AutoCompleteMode for more details.
AutoCompleteSourceRefer to AutoCompleteSource for more details.
CSVFileSaveAsGets or sets the location where the CSV export file will be saved to, when the user requests that a given multi-column view data is saved to a CSV file.
ColumnWidthsGets or sets the column widths of the column headers representing the columns to display from a given DataSource, when displaying a multi-column drop-list.
ColumnsToDisplayGets or sets a list of custom header strings representing the columns to display from a given DataSource, when displaying a multi-column drop-list.
ComboBoxControlFontGets or sets the combo box control font.
ComboBoxControlFontIsSameAsDropListWindowFontWhether the closed control uses the same font as the drop-down list. Set it false to give the two their own fonts.
CustomComparerImplementorGets or sets the custom sorting implementation that you can provide to let the control to sort data in columns (while in multi-column drop list mode).
CustomDropDownWindowLocationPointGets or sets a custom screen coordinate at which to locate the drop-down window.
DropDownStyleGets or sets the dropdown style for the combobox editor.
DropDownWindowBorderColorGets or sets the Window border painting color for the multicolumn drop-down.
DropDownWindowDisplayOrientationGets or sets the drop down window display orientation.
DropDownWindowPaintingColorGets or sets the Window painting color for the multicolumn drop-down.
DropStyleIsMultiColumnGets or sets whether the drop-down data is displayed in a multi-column list style.
EnableAlphaBlendingForFilterAndGroupingPanelBackColorGets or sets whether the color set in FilterAndGroupingPanelBackColor can be alpha-blended with Window, to provide a smooth color for rendering the filter/grouping options panel window.
EnableDrawingHeaderFooterWhenInMultiColumnModeGets or sets whether to render header and footer, for the multi-column drop-down list window.
EnableUserColumnResizingGets or sets whether the user can resize the columns (i.e. the columns of a multi-column drop-list) at run-time.
FilterAndGroupingPanelBackColorGets or sets the color to use for rendering the background for the filter and grouping options panel, in the multicolumn mode.
GroupItemsWhenInMultiColumnDisplayModeGets or sets whether to display the items in multi-column display mode in the "grouped" mode, or to display items using the default tabular / grid mode.
GroupMultiColumnDisplayModeDataBasedOnThisColumnGets or sets the column number to use from the associated DataSource data, to base the data grouping on. Refer to GroupItemsWhenInMultiColumnDisplayMode property for more details on grouping of the data.
HeadersToDisplayGets or sets a list of custom header strings representing the columns to display from a given DataSource, when displaying a multi-column drop-list.
MultiColumnDropDownSizeGets or sets the size of the multi-column drop-down list, in logical (96 DPI) units. The editing combo box scales it to the display and keeps it on the screen; see BinaryTextComboBox.MultiColumnDropDownSize, where an empty size fits the columns.
MultiColumnDropDownWindowConfigurationGets or sets the configuration information for setting up the multi-column combobox control, for the column type BinaryTreeListViewComboBoxColumn.
MultiColumnDropListBackColorGets or sets the backcolor for the Multi-column drop list view.
MultiColumnDropListFontGets or sets whether the Multi-column drop list view has grid lines around cells.
MultiColumnDropListForeColorGets or sets the forecolor for the Multi-column drop list view.
MultiColumnDropListGridLinesGets or sets whether the Multi-column drop list view has grid lines around cells.
MultiColumnDropListHoverSelectionGets or sets whether an item in the multi-column drop list view is automatically selected when the mouse pointer remains over the item for a few seconds.
MultiColumnDropListWindowIsResizableGets or sets whether the multi-column drop list window's border is sizable or not.
ShouldAllowDragDropOfColumnsGets or sets whether to allow users to drag and drop columns in the multi-column drop-list window.
ShowFilterOptionsInMultiColumnModeGets or sets whether to show the "filter and grouping" options window, when in multi-column mode.
CloneCreates a copy of this BinaryComboBoxColumn, carrying across every setting this type adds to the base implementation.
GetOptimumWidthMeasures the widest value in every column of a table, so the drop-down grid can be sized to its content instead of to a guess.

Constructors

BinaryComboBoxColumn

public BinaryComboBoxColumn() : base()

Initializes a new instance of the BinaryComboBoxColumn class.

Properties

AlphaBlendingfactorForFilterAndGroupingPanelBackColor

public int AlphaBlendingfactorForFilterAndGroupingPanelBackColor

Gets or sets the alpha-blending factor to perform alpha blending of colors as described in the property EnableAlphaBlendingForFilterAndGroupingPanelBackColor.

The default value is 150.
This property is applicable only when in multi-column mode.

AutoCompleteBasedOnCompleteMatchWithAnItemInTheList

public bool AutoCompleteBasedOnCompleteMatchWithAnItemInTheList

Gets or sets whether the auto completion mode is based on complete match with an item in the control's list of available items.

AutoCompleteIsCaseSensitive

public bool AutoCompleteIsCaseSensitive

Gets or sets the dropdown style for the combobox editor.

The default value is false

AutoCompleteMode

public AutoCompleteMode AutoCompleteMode

Refer to AutoCompleteMode for more details.

AutoCompleteSource

public AutoCompleteSource AutoCompleteSource

Refer to AutoCompleteSource for more details.

CSVFileSaveAs

public string CSVFileSaveAs

Gets or sets the location where the CSV export file will be saved to, when the user requests that a given multi-column view data is saved to a CSV file.

The user will not be able to specify the file location himself, when in multi-column view mode, and hence the developer will have to supply this file save location ahead of time - i.e. before the user gets into the multi-column mode.

ColumnWidths

public int[] ColumnWidths

Gets or sets the column widths of the column headers representing the columns to display from a given DataSource, when displaying a multi-column drop-list.

ColumnsToDisplay

public string[] ColumnsToDisplay

Gets or sets a list of custom header strings representing the columns to display from a given DataSource, when displaying a multi-column drop-list.

ComboBoxControlFont

public Font ComboBoxControlFont

Gets or sets the combo box control font.

ComboBoxControlFontIsSameAsDropListWindowFont

public bool ComboBoxControlFontIsSameAsDropListWindowFont

Whether the closed control uses the same font as the drop-down list. Set it false to give the two their own fonts.

CustomComparerImplementor

public IComparer CustomComparerImplementor

Gets or sets the custom sorting implementation that you can provide to let the control to sort data in columns (while in multi-column drop list mode).

CustomDropDownWindowLocationPoint

public Point CustomDropDownWindowLocationPoint

Gets or sets a custom screen coordinate at which to locate the drop-down window.

Ensure you set a coordinate relative to the screen.

DropDownStyle

public ComboBoxStyle DropDownStyle

Gets or sets the dropdown style for the combobox editor.

The default value is false

DropDownWindowBorderColor

public Color DropDownWindowBorderColor

Gets or sets the Window border painting color for the multicolumn drop-down.

DropDownWindowDisplayOrientation

public Binarymission.WinForms.Controls.ListControls.DropDownWindowDisplayOrientation DropDownWindowDisplayOrientation

Gets or sets the drop down window display orientation.

DropDownWindowPaintingColor

public Color DropDownWindowPaintingColor

Gets or sets the Window painting color for the multicolumn drop-down.

DropStyleIsMultiColumn

public bool DropStyleIsMultiColumn

Gets or sets whether the drop-down data is displayed in a multi-column list style.

EnableAlphaBlendingForFilterAndGroupingPanelBackColor

public bool EnableAlphaBlendingForFilterAndGroupingPanelBackColor

Gets or sets whether the color set in FilterAndGroupingPanelBackColor can be alpha-blended with Window, to provide a smooth color for rendering the filter/grouping options panel window.

This property is applicable only when in multi-column mode.
The default value is false .

EnableDrawingHeaderFooterWhenInMultiColumnMode

public bool EnableDrawingHeaderFooterWhenInMultiColumnMode

Gets or sets whether to render header and footer, for the multi-column drop-down list window.

EnableUserColumnResizing

public bool EnableUserColumnResizing

Gets or sets whether the user can resize the columns (i.e. the columns of a multi-column drop-list) at run-time.

Default value is true. If you want to disable user column resizing, set this property to false.

FilterAndGroupingPanelBackColor

public Color FilterAndGroupingPanelBackColor

Gets or sets the color to use for rendering the background for the filter and grouping options panel, in the multicolumn mode.

GroupItemsWhenInMultiColumnDisplayMode

public bool GroupItemsWhenInMultiColumnDisplayMode

Gets or sets whether to display the items in multi-column display mode in the "grouped" mode, or to display items using the default tabular / grid mode.

The default value is false

GroupMultiColumnDisplayModeDataBasedOnThisColumn

public int GroupMultiColumnDisplayModeDataBasedOnThisColumn

Gets or sets the column number to use from the associated DataSource data, to base the data grouping on. Refer to GroupItemsWhenInMultiColumnDisplayMode property for more details on grouping of the data.

HeadersToDisplay

public string[] HeadersToDisplay

Gets or sets a list of custom header strings representing the columns to display from a given DataSource, when displaying a multi-column drop-list.

MultiColumnDropDownSize

public Size MultiColumnDropDownSize

Gets or sets the size of the multi-column drop-down list, in logical (96 DPI) units. The editing combo box scales it to the display and keeps it on the screen; see BinaryTextComboBox.MultiColumnDropDownSize, where an empty size fits the columns.

MultiColumnDropDownWindowConfiguration

public MultiColumnDropDownWindowConfiguration MultiColumnDropDownWindowConfiguration

Gets or sets the configuration information for setting up the multi-column combobox control, for the column type BinaryTreeListViewComboBoxColumn.

MultiColumnDropListBackColor

public Color MultiColumnDropListBackColor

Gets or sets the backcolor for the Multi-column drop list view.

This feature works only if the current drop style is set to Multi-column view. Refer DropStyleIsMultiColumn property for more details.

MultiColumnDropListFont

public Font MultiColumnDropListFont

Gets or sets whether the Multi-column drop list view has grid lines around cells.

This feature works only if the current drop style is set to Multi-column view. Refer DropStyleIsMultiColumn property for more details.

MultiColumnDropListForeColor

public Color MultiColumnDropListForeColor

Gets or sets the forecolor for the Multi-column drop list view.

This feature works only if the current drop style is set to Multi-column view. Refer DropStyleIsMultiColumn property for more details.

MultiColumnDropListGridLines

public bool MultiColumnDropListGridLines

Gets or sets whether the Multi-column drop list view has grid lines around cells.

This feature works only if the current drop style is set to Multi-column view. Refer DropStyleIsMultiColumn property for more details.

MultiColumnDropListHoverSelection

public bool MultiColumnDropListHoverSelection

Gets or sets whether an item in the multi-column drop list view is automatically selected when the mouse pointer remains over the item for a few seconds.

This feature works only if the current drop style is set to Multi-column view. Refer DropStyleIsMultiColumn property for more details.

MultiColumnDropListWindowIsResizable

public bool MultiColumnDropListWindowIsResizable

Gets or sets whether the multi-column drop list window's border is sizable or not.

The default value is true.

ShouldAllowDragDropOfColumns

public bool ShouldAllowDragDropOfColumns

Gets or sets whether to allow users to drag and drop columns in the multi-column drop-list window.

Note: There is a trade-off with this property. If you want to enable the drag-and-drop of columns by user, then then the out-of-the-box fix provided in the control for removing the last blank column header in the multi-column drop-list window will not be available (this is a standard bug in the Windows Listview control).

ShowFilterOptionsInMultiColumnMode

public bool ShowFilterOptionsInMultiColumnMode

Gets or sets whether to show the "filter and grouping" options window, when in multi-column mode.


This property is applicable only when in multi-column mode.

Methods

Clone

public override object Clone()

Creates a copy of this BinaryComboBoxColumn, carrying across every setting this type adds to the base implementation.

GetOptimumWidth

public Size GetOptimumWidth(DataTable theTable)

Measures the widest value in every column of a table, so the drop-down grid can be sized to its content instead of to a guess.

theTable
The data the grid will show.

Returns. The size the grid needs. Empty when the table is null.