Export (0) Print
Expand All

DataGridViewComboBoxCell Class

Displays a combo box in a DataGridView control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public class DataGridViewComboBoxCell : DataGridViewCell

The DataGridViewComboBoxCell type exposes the following members.

  NameDescription
Public methodDataGridViewComboBoxCellInitializes a new instance of the DataGridViewComboBoxCell class.
Top

  NameDescription
Public propertyAccessibilityObjectGets the DataGridViewCell.DataGridViewCellAccessibleObject assigned to the DataGridViewCell. (Inherited from DataGridViewCell.)
Public propertyAutoCompleteGets or sets a value indicating whether the cell will match the characters being entered in the cell with a selection from the drop-down list.
Public propertyColumnIndexGets the column index for this cell. (Inherited from DataGridViewCell.)
Public propertyContentBoundsGets the bounding rectangle that encloses the cell's content area. (Inherited from DataGridViewCell.)
Public propertyContextMenuStripGets or sets the shortcut menu associated with the cell. (Inherited from DataGridViewCell.)
Public propertyDataGridViewGets the DataGridView control associated with this element. (Inherited from DataGridViewElement.)
Public propertyDataSourceGets or sets the data source whose data contains the possible selections shown in the drop-down list.
Public propertyDefaultNewRowValueGets the default value for a cell in the row for new records. (Inherited from DataGridViewCell.)
Public propertyDisplayedGets a value that indicates whether the cell is currently displayed on-screen. (Inherited from DataGridViewCell.)
Public propertyDisplayMemberGets or sets a string that specifies where to gather selections to display in the drop-down list.
Public propertyDisplayStyleGets or sets a value that determines how the combo box is displayed when it is not in edit mode.
Public propertyDisplayStyleForCurrentCellOnlyGets or sets a value indicating whether the DisplayStyle property value applies to the cell only when it is the current cell in the DataGridView control.
Public propertyDropDownWidthGets or sets the width of the of the drop-down list portion of a combo box.
Public propertyEditedFormattedValueGets the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell.)
Public propertyEditTypeGets the type of the cell's hosted editing control. (Overrides DataGridViewCell.EditType.)
Public propertyErrorIconBoundsGets the bounds of the error icon for the cell. (Inherited from DataGridViewCell.)
Public propertyErrorTextGets or sets the text describing an error condition associated with the cell. (Inherited from DataGridViewCell.)
Public propertyFlatStyleGets or sets the flat style appearance of the cell.
Public propertyFormattedValueGets the value of the cell as formatted for display. (Inherited from DataGridViewCell.)
Public propertyFormattedValueTypeGets the class type of the formatted value associated with the cell. (Overrides DataGridViewCell.FormattedValueType.)
Public propertyFrozenGets a value indicating whether the cell is frozen. (Inherited from DataGridViewCell.)
Public propertyHasStyleGets a value indicating whether the Style property has been set. (Inherited from DataGridViewCell.)
Public propertyInheritedStateGets the current state of the cell as inherited from the state of its row and column. (Inherited from DataGridViewCell.)
Public propertyInheritedStyleGets the style currently applied to the cell. (Inherited from DataGridViewCell.)
Public propertyIsInEditModeGets a value indicating whether this cell is currently being edited. (Inherited from DataGridViewCell.)
Public propertyItemsGets the objects that represent the selection displayed in the drop-down list.
Public propertyMaxDropDownItemsGets or sets the maximum number of items shown in the drop-down list.
Public propertyOwningColumnGets the column that contains this cell. (Inherited from DataGridViewCell.)
Public propertyOwningRowGets the row that contains this cell. (Inherited from DataGridViewCell.)
Public propertyPreferredSizeGets the size, in pixels, of a rectangular area into which the cell can fit. (Inherited from DataGridViewCell.)
Public propertyReadOnlyGets or sets a value indicating whether the cell's data can be edited. (Inherited from DataGridViewCell.)
Public propertyResizableGets a value indicating whether the cell can be resized. (Inherited from DataGridViewCell.)
Public propertyRowIndexGets the index of the cell's parent row. (Inherited from DataGridViewCell.)
Public propertySelectedGets or sets a value indicating whether the cell has been selected. (Inherited from DataGridViewCell.)
Public propertySizeGets the size of the cell. (Inherited from DataGridViewCell.)
Public propertySortedGets or sets a value indicating whether the items in the combo box are automatically sorted.
Public propertyStateGets the user interface (UI) state of the element. (Inherited from DataGridViewElement.)
Public propertyStyleGets or sets the style for the cell. (Inherited from DataGridViewCell.)
Public propertyTagGets or sets the object that contains supplemental data about the cell. (Inherited from DataGridViewCell.)
Public propertyToolTipTextGets or sets the ToolTip text associated with this cell. (Inherited from DataGridViewCell.)
Public propertyValueGets or sets the value associated with this cell. (Inherited from DataGridViewCell.)
Public propertyValueMemberGets or sets a string that specifies where to gather the underlying values used in the drop-down list.
Public propertyValueTypeGets or sets the data type of the values in the cell. (Overrides DataGridViewCell.ValueType.)
Public propertyVisibleGets a value indicating whether the cell is in a row or column that has been hidden. (Inherited from DataGridViewCell.)
Top

  NameDescription
Public methodAdjustCellBorderStyleModifies the input cell border style according to the specified criteria. (Inherited from DataGridViewCell.)
Protected methodBorderWidthsReturns a Rectangle that represents the widths of all the cell margins. (Inherited from DataGridViewCell.)
Protected methodClickUnsharesRowIndicates whether the cell's row will be unshared when the cell is clicked. (Inherited from DataGridViewCell.)
Public methodCloneCreates an exact copy of this cell. (Overrides DataGridViewCell.Clone().)
Protected methodContentClickUnsharesRowIndicates whether the cell's row will be unshared when the cell's content is clicked. (Inherited from DataGridViewCell.)
Protected methodContentDoubleClickUnsharesRowIndicates whether the cell's row will be unshared when the cell's content is double-clicked. (Inherited from DataGridViewCell.)
Protected methodCreateAccessibilityInstanceCreates a new accessible object for the DataGridViewCell. (Inherited from DataGridViewCell.)
Public methodDetachEditingControlRemoves the cell's editing control from the DataGridView. (Overrides DataGridViewCell.DetachEditingControl().)
Public methodDispose()Releases all resources used by the DataGridViewCell. (Inherited from DataGridViewCell.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the DataGridViewCell and optionally releases the managed resources. (Inherited from DataGridViewCell.)
Protected methodDoubleClickUnsharesRowIndicates whether the cell's row will be unshared when the cell is double-clicked. (Inherited from DataGridViewCell.)
Protected methodEnterUnsharesRowIndicates whether the parent row will be unshared when the focus moves to the cell. (Inherited from DataGridViewCell.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeReleases the unmanaged resources and performs other cleanup operations before the DataGridViewCell is reclaimed by garbage collection. (Inherited from DataGridViewCell.)
Protected methodGetClipboardContentRetrieves the formatted value of the cell to copy to the Clipboard. (Inherited from DataGridViewCell.)
Public methodGetContentBounds(Int32)Returns the bounding rectangle that encloses the cell's content area using a default Graphics and cell style currently in effect for the cell. (Inherited from DataGridViewCell.)
Protected methodGetContentBounds(Graphics, DataGridViewCellStyle, Int32)Returns the bounding rectangle that encloses the cell's content area, which is calculated using the specified Graphics and cell style. (Overrides DataGridViewCell.GetContentBounds(Graphics, DataGridViewCellStyle, Int32).)
Public methodGetEditedFormattedValueReturns the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell.)
Protected methodGetErrorIconBoundsReturns the bounding rectangle that encloses the cell's error icon, if one is displayed. (Overrides DataGridViewCell.GetErrorIconBounds(Graphics, DataGridViewCellStyle, Int32).)
Protected methodGetErrorTextReturns a string that represents the error for the cell. (Inherited from DataGridViewCell.)
Protected methodGetFormattedValueGets the formatted value of the cell's data. (Overrides DataGridViewCell.GetFormattedValue(Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts).)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetInheritedContextMenuStripGets the inherited shortcut menu for the current cell. (Inherited from DataGridViewCell.)
Public methodGetInheritedStateReturns a value indicating the current state of the cell as inherited from the state of its row and column. (Inherited from DataGridViewCell.)
Public methodGetInheritedStyleGets the style applied to the cell. (Inherited from DataGridViewCell.)
Protected methodGetPreferredSizeCalculates the preferred size, in pixels, of the cell. (Overrides DataGridViewCell.GetPreferredSize(Graphics, DataGridViewCellStyle, Int32, Size).)
Protected methodGetSizeGets the size of the cell. (Inherited from DataGridViewCell.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetValueGets the value of the cell. (Inherited from DataGridViewCell.)
Public methodInitializeEditingControlAttaches and initializes the hosted editing control. (Overrides DataGridViewCell.InitializeEditingControl(Int32, Object, DataGridViewCellStyle).)
Protected methodKeyDownUnsharesRowIndicates whether the parent row is unshared if the user presses a key while the focus is on the cell. (Inherited from DataGridViewCell.)
Public methodKeyEntersEditModeDetermines if edit mode should be started based on the given key. (Overrides DataGridViewCell.KeyEntersEditMode(KeyEventArgs).)
Protected methodKeyPressUnsharesRowIndicates whether a row will be unshared if a key is pressed while a cell in the row has focus. (Inherited from DataGridViewCell.)
Protected methodKeyUpUnsharesRowIndicates whether the parent row is unshared when the user releases a key while the focus is on the cell. (Inherited from DataGridViewCell.)
Protected methodLeaveUnsharesRowIndicates whether a row will be unshared when the focus leaves a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMouseClickUnsharesRowIndicates whether a row will be unshared if the user clicks a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMouseDoubleClickUnsharesRowIndicates whether a row will be unshared if the user double-clicks a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMouseDownUnsharesRowIndicates whether a row will be unshared when the user holds down a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMouseEnterUnsharesRowIndicates whether a row will be unshared when the mouse pointer moves over a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMouseLeaveUnsharesRowIndicates whether a row will be unshared when the mouse pointer leaves the row. (Inherited from DataGridViewCell.)
Protected methodMouseMoveUnsharesRowIndicates whether a row will be unshared when the mouse pointer moves over a cell in the row. (Inherited from DataGridViewCell.)
Protected methodMouseUpUnsharesRowIndicates whether a row will be unshared when the user releases a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell.)
Protected methodOnClickCalled when the cell is clicked. (Inherited from DataGridViewCell.)
Protected methodOnContentClickCalled when the cell's contents are clicked. (Inherited from DataGridViewCell.)
Protected methodOnContentDoubleClickCalled when the cell's contents are double-clicked. (Inherited from DataGridViewCell.)
Protected methodOnDataGridViewChangedCalled when the DataGridView property of the cell changes. (Overrides DataGridViewCell.OnDataGridViewChanged().)
Protected methodOnDoubleClickCalled when the cell is double-clicked. (Inherited from DataGridViewCell.)
Protected methodOnEnterCalled when the focus moves to a cell. (Overrides DataGridViewCell.OnEnter(Int32, Boolean).)
Protected methodOnKeyDownCalled when a character key is pressed while the focus is on a cell. (Inherited from DataGridViewCell.)
Protected methodOnKeyPressCalled when a key is pressed while the focus is on a cell. (Inherited from DataGridViewCell.)
Protected methodOnKeyUpCalled when a character key is released while the focus is on a cell. (Inherited from DataGridViewCell.)
Protected methodOnLeaveCalled when the focus moves from a cell. (Overrides DataGridViewCell.OnLeave(Int32, Boolean).)
Protected methodOnMouseClickCalled when the user clicks a mouse button while the pointer is on a cell. (Overrides DataGridViewCell.OnMouseClick(DataGridViewCellMouseEventArgs).)
Protected methodOnMouseDoubleClickCalled when the user double-clicks a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell.)
Protected methodOnMouseDownCalled when the user holds down a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell.)
Protected methodOnMouseEnterCalled when the mouse pointer moves over a cell. (Overrides DataGridViewCell.OnMouseEnter(Int32).)
Protected methodOnMouseLeaveCalled when the mouse pointer leaves the cell. (Overrides DataGridViewCell.OnMouseLeave(Int32).)
Protected methodOnMouseMoveCalled when the mouse pointer moves within a cell. (Overrides DataGridViewCell.OnMouseMove(DataGridViewCellMouseEventArgs).)
Protected methodOnMouseUpCalled when the user releases a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell.)
Protected methodPaintPaints the current DataGridViewComboBoxCell. (Overrides DataGridViewCell.Paint(Graphics, Rectangle, Rectangle, Int32, DataGridViewElementStates, Object, Object, String, DataGridViewCellStyle, DataGridViewAdvancedBorderStyle, DataGridViewPaintParts).)
Protected methodPaintBorderPaints the border of the current DataGridViewCell. (Inherited from DataGridViewCell.)
Protected methodPaintErrorIconPaints the error icon of the current DataGridViewCell. (Inherited from DataGridViewCell.)
Public methodParseFormattedValueConverts a value formatted for display to an actual cell value. (Overrides DataGridViewCell.ParseFormattedValue(Object, DataGridViewCellStyle, TypeConverter, TypeConverter).)
Public methodPositionEditingControlSets the location and size of the editing control hosted by a cell in the DataGridView control. (Inherited from DataGridViewCell.)
Public methodPositionEditingPanelSets the location and size of the editing panel hosted by the cell, and returns the normal bounds of the editing control within the editing panel. (Inherited from DataGridViewCell.)
Protected methodRaiseCellClickRaises the DataGridView.CellClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentClickRaises the DataGridView.CellContentClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentDoubleClickRaises the DataGridView.CellContentDoubleClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellValueChangedRaises the DataGridView.CellValueChanged event. (Inherited from DataGridViewElement.)
Protected methodRaiseDataErrorRaises the DataGridView.DataError event. (Inherited from DataGridViewElement.)
Protected methodRaiseMouseWheelRaises the Control.MouseWheel event. (Inherited from DataGridViewElement.)
Protected methodSetValueSets the value of the cell. (Inherited from DataGridViewCell.)
Public methodToStringReturns a string that describes the current object. (Overrides DataGridViewCell.ToString().)
Top

The DataGridViewComboBoxCell class is a specialized type of DataGridViewCell used to display a combo box control, which is an editing field combined with a list selection field. The currently selected DataGridViewComboBoxCell hosts a DataGridViewComboBoxEditingControl in which the user can change the cell's value, assuming the cell's ReadOnly property is set to false.

Unlike the ComboBox control, the DataGridViewComboBoxCell does not have SelectedIndex and SelectedValue properties. Instead, selecting a value from a drop-down list sets the cell Value property.

The DataGridViewComboBoxColumn is the column type specialized to hold cells of this type. By default, the DataGridViewComboBoxColumn.CellTemplate is initialized to a new DataGridViewComboBoxCell. To pattern the cells within a column after an existing DataGridViewComboBoxCell, set the column's CellTemplate property to the cell to use as a pattern.

The cell-related properties of the column are wrappers for the similarly-named properties of the template cell. Changing the property values of the template cell will affect only cells based on the template that are added after the change. Changing the cell-related property values of the column, however, will update the template cell and all other cells in the column, and refresh the column display if necessary.

You will typically work with the DataGridViewComboBoxColumn type unless you want to override column values for specific cells. The guidelines described in the DataGridViewComboBoxColumn class overview topic for populating the drop-down list applies to both cell and column instances.

Notes to Inheritors

When you derive from DataGridViewComboBoxCell and add new properties to the derived class, be sure to override the Clone method to copy the new properties during cloning operations. You should also call the base class's Clone method so that the properties of the base class are copied to the new cell.

The following code example demonstrates the DataGridViewComboBoxColumn class, which makes use of the DataGridViewComboBoxCell class. You can set the cell DataSource, ValueMember, and DisplayMember properties in the same way that the corresponding column properties are set in this example. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.


private DataGridViewComboBoxColumn CreateComboBoxColumn()
{
    DataGridViewComboBoxColumn column =
        new DataGridViewComboBoxColumn();
    {
        column.DataPropertyName = ColumnName.TitleOfCourtesy.ToString();
        column.HeaderText = ColumnName.TitleOfCourtesy.ToString();
        column.DropDownWidth = 160;
        column.Width = 90;
        column.MaxDropDownItems = 3;
        column.FlatStyle = FlatStyle.Flat;
    }
    return column;
}

private void SetAlternateChoicesUsingDataSource(DataGridViewComboBoxColumn comboboxColumn)
{
    {
        comboboxColumn.DataSource = RetrieveAlternativeTitles();
        comboboxColumn.ValueMember = ColumnName.TitleOfCourtesy.ToString();
        comboboxColumn.DisplayMember = comboboxColumn.ValueMember;
    }
}

private DataTable RetrieveAlternativeTitles()
{
    return Populate("SELECT distinct TitleOfCourtesy FROM Employees");
}

string connectionString =
    "Integrated Security=SSPI;Persist Security Info=False;" +
    "Initial Catalog=Northwind;Data Source=localhost";

private DataTable Populate(string sqlCommand)
{
    SqlConnection northwindConnection = new SqlConnection(connectionString);
    northwindConnection.Open();

    SqlCommand command = new SqlCommand(sqlCommand, northwindConnection);
    SqlDataAdapter adapter = new SqlDataAdapter();
    adapter.SelectCommand = command;

    DataTable table = new DataTable();
    table.Locale = System.Globalization.CultureInfo.InvariantCulture;
    adapter.Fill(table);

    return table;
}

// Using an enum provides some abstraction between column index
// and column name along with compile time checking, and gives
// a handy place to store the column names.
enum ColumnName
{
    EmployeeId,
    LastName,
    FirstName,
    Title,
    TitleOfCourtesy,
    BirthDate,
    HireDate,
    Address,
    City,
    Region,
    PostalCode,
    Country,
    HomePhone,
    Extension,
    Photo,
    Notes,
    ReportsTo,
    PhotoPath,
    OutOfOffice
};


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft