DataGridComboBoxColumn Class

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Represents a DataGrid column that hosts ComboBox controls in its cells.

public ref class DataGridComboBoxColumn : System::Windows::Controls::DataGridColumn

public class DataGridComboBoxColumn : System.Windows.Controls.DataGridColumn

type DataGridComboBoxColumn = class
    inherit DataGridColumn

Public Class DataGridComboBoxColumn
Inherits DataGridColumn

Inheritance

Object

DispatcherObject

DependencyObject

DataGridColumn

DataGridComboBoxColumn

Examples

The following example shows how to populate the drop-down list for each ComboBox in the column with the values of an enumeration. The selected item in the drop-down list is bound by setting the SelectedItemBinding property to the property of the object displayed in each row.

<NavigationWindow x:Class="DataGrid_CustomColumns.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:core="clr-namespace:System;assembly=mscorlib"
    xmlns:local="clr-namespace:DataGrid_CustomColumns"
    Title="Customers" Height="300" Width="300" ShowsNavigationUI="False"  >
    
<NavigationWindow.Resources>
    <!--Create list of enumeration values-->
    <ObjectDataProvider x:Key="myEnum" MethodName="GetValues" ObjectType="{x:Type core:Enum}">
        <ObjectDataProvider.MethodParameters>
            <x:Type Type="local:OrderStatus"/>
        </ObjectDataProvider.MethodParameters>
    </ObjectDataProvider>
    <!--Create an instance of the converter for Email-->
    <local:EmailConverter x:Key="EmailConverter" />
</NavigationWindow.Resources>
<NavigationWindow.Content>  
    
<Grid>
    <DataGrid Name="DG1" ItemsSource="{Binding}" AutoGenerateColumns="False" >
        <DataGrid.Columns>

                <DataGridComboBoxColumn Header="Order Status"  SelectedItemBinding="{Binding Status}" ItemsSource="{Binding Source={StaticResource myEnum}}" />
            </DataGrid.Columns>
        </DataGrid>
    </Grid>
    </NavigationWindow.Content>
</NavigationWindow>

public partial class Window1 : NavigationWindow
{

Class Window1

public Window1()
{
    InitializeComponent();

    //GetData() creates a collection of Customer data from a database
    ObservableCollection<Customer> custdata = GetData();
    
    //Bind the DataGrid to the customer data
    DG1.DataContext = custdata;
}

Public Sub New()
    ' This call is required by the Windows Form Designer.
    InitializeComponent()
    ' Add any initialization after the InitializeComponent() call.

    'GetData() creates a collection of Customer data from a database
    Dim custdata As ObservableCollection(Of Customer) = GetData()

    'Bind the DataGrid to the customer data
    DG1.DataContext = custdata

End Sub

//Defines the customer object
public class Customer
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public Uri Email { get; set; }
    public bool IsMember { get; set; }
    public OrderStatus Status { get; set; }
}

'Defines the customer object
Public Class Customer
    Public Property FirstName() As String
    Public Property LastName() As String
    Public Property Email() As Uri
    Public Property IsMember() As Boolean
    Public Property Status() As OrderStatus
End Class

public enum OrderStatus { None, New, Processing, Shipped, Received };

Public Enum OrderStatus
    None
    [New]
    Processing
    Shipped
    Received
End Enum

Remarks

Use DataGridComboBoxColumn to display data where there is a set of items to choose from, such as an enumeration. DataGridComboBoxColumn allows users to select an item from a drop-down list. The following illustration shows a DataGridComboBoxColumn.

To populate the drop-down list, first set the ItemsSource property for the ComboBox by using one of the following options:

• A static resource. For more information, see StaticResource Markup Extension.

• An x:Static code entity. For more information, see x:Static Markup Extension.

• An inline collection of ComboBoxItem types.

Once the ItemsSource is set, bind the selected item in the ComboBox to the data item for the row that the cell is in. You can set the binding by using one of the following properties:

Property	Description
TextBinding	Sets the binding path of the text for the currently selected item.
SelectedItemBinding	Sets the binding path of the object that is currently selected.
SelectedValueBinding	Sets the binding path to the value of the selected item specified by the SelectedValuePath property.

When the IsReadOnly property is set to true, users cannot edit the column and they will not be able to see the drop-down list.

If you want to display other types of data, DataGrid provides the following column types:

Column Type	Data Display
DataGridHyperlinkColumn	Use to display URI data.
DataGridCheckBoxColumn	Use to display Boolean data.
DataGridTextColumn	Use to display text.

If you want to use other controls in your DataGrid, you can create your own column types by using DataGridTemplateColumn.

Constructors

DataGridComboBoxColumn()

Initializes a new instance of the DataGridComboBoxColumn class.

Fields

DisplayMemberPathProperty	Identifies the DisplayMemberPath dependency property.
EditingElementStyleProperty	Identifies the EditingElementStyle dependency property.
ElementStyleProperty	Identifies the ElementStyle dependency property.
ItemsSourceProperty	Identifies the ItemsSource dependency property.
SelectedValuePathProperty	Identifies the SelectedValuePath dependency property.

Properties

ActualWidth	Gets the current width of the column, in device-independent units (1/96th inch per unit). (Inherited from DataGridColumn)
CanUserReorder	Gets or sets a value that indicates whether the user can change the column display position by dragging the column header. (Inherited from DataGridColumn)
CanUserResize	Gets or sets a value that indicates whether the user can adjust the column width by using the mouse. (Inherited from DataGridColumn)
CanUserSort	Gets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn)
CellStyle	Gets or sets the style that is used to render cells in the column. (Inherited from DataGridColumn)
ClipboardContentBinding	Gets or sets the binding object to use when getting or setting cell content for the clipboard.
DataGridOwner	Gets the DataGrid control that contains this column. (Inherited from DataGridColumn)
DefaultEditingElementStyle	Gets the default value of the EditingElementStyle property.
DefaultElementStyle	Gets the default value of the ElementStyle.
DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
DisplayIndex	Gets or sets the display position of the column relative to the other columns in the DataGrid. (Inherited from DataGridColumn)
DisplayMemberPath	Gets or sets a path to a value on the source object to provide the visual representation of the object.
DragIndicatorStyle	Gets or sets the style object to apply to the column header during a drag operation. (Inherited from DataGridColumn)
EditingElementStyle	Gets or sets the style that is used when rendering the element that the column displays for a cell in editing mode.
ElementStyle	Gets or sets the style that is used when rendering the element that the column displays for a cell that is not in editing mode.
Header	Gets or sets the content of the column header. (Inherited from DataGridColumn)
HeaderStringFormat	Gets or sets the format pattern to apply to the content of the column header. (Inherited from DataGridColumn)
HeaderStyle	Gets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn)
HeaderTemplate	Gets or sets the template that defines the visual representation of the column header. (Inherited from DataGridColumn)
HeaderTemplateSelector	Gets or sets the object that selects which template to use for the column header. (Inherited from DataGridColumn)
IsAutoGenerated	Gets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn)
IsFrozen	Gets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn)
IsReadOnly	Gets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn)
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)
ItemsSource	Gets or sets a collection that is used to generate the content of the combo box control.
MaxWidth	Gets or sets the maximum width constraint of the column. (Inherited from DataGridColumn)
MinWidth	Gets or sets the minimum width constraint of the column. (Inherited from DataGridColumn)
SelectedItemBinding	Gets or sets the binding for the currently selected item.
SelectedValueBinding	Gets or sets the value of the selected item, obtained by using SelectedValuePath.
SelectedValuePath	Gets or sets the path that is used to get the SelectedValue from the SelectedItem.
SortDirection	Gets or sets the sort direction (ascending or descending) of the column. (Inherited from DataGridColumn)
SortMemberPath	Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by. (Inherited from DataGridColumn)
TextBinding	Gets or sets the binding for the text in the text box portion of the ComboBox control.
TextBlockComboBoxStyleKey	Gets the resource key for the style to apply to a read-only combo box.
Visibility	Gets or sets the visibility of the column. (Inherited from DataGridColumn)
Width	Gets or sets the column width or automatic sizing mode. (Inherited from DataGridColumn)

Methods

CancelCellEdit(FrameworkElement, Object)	Causes the column cell being edited to revert to the specified value.
CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject)
CommitCellEdit(FrameworkElement)	Performs any required validation before exiting the editing mode.
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
GenerateEditingElement(DataGridCell, Object)	Gets a combo box control that is bound to the column's SelectedItemBinding, SelectedValueBinding, and TextBinding values.
GenerateElement(DataGridCell, Object)	Gets a read-only combo box control that is bound to the column's SelectedItemBinding, SelectedValueBinding, and TextBinding values.
GetCellContent(DataGridRow)	Retrieves the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn)
GetCellContent(Object)	Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item. (Inherited from DataGridColumn)
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
NotifyPropertyChanged(String)	Notifies the DataGrid that contains this column that a column property has changed. (Inherited from DataGridColumn)
OnCoerceIsReadOnly(Boolean)	Determines the value of the IsReadOnly property based on property rules from the DataGrid that contains this column.
OnCopyingCellClipboardContent(Object)	Raises the CopyingCellClipboardContent event. (Inherited from DataGridColumn)
OnPastingCellClipboardContent(Object, Object)	Raises the PastingCellClipboardContent event. (Inherited from DataGridColumn)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject)
OnSelectedItemBindingChanged(BindingBase, BindingBase)	Notifies the DataGrid when the SelectedItemBinding property changes.
OnSelectedValueBindingChanged(BindingBase, BindingBase)	Notifies the DataGrid when the SelectedValueBinding property changes.
OnTextBindingChanged(BindingBase, BindingBase)	Notifies the DataGrid when the TextBinding property changes.
PrepareCellForEdit(FrameworkElement, RoutedEventArgs)	Called when a cell in the column enters editing mode.
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
RefreshCellContent(FrameworkElement, String)	Refreshes the contents of a cell in the column in response to a binding change.
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)

Events

CopyingCellClipboardContent	Occurs after the cell clipboard content is prepared. (Inherited from DataGridColumn)
PastingCellClipboardContent	Occurs before the clipboard content is moved to the cell. (Inherited from DataGridColumn)