3 out of 5 rated this helpful - Rate this topic

DataGridComboBoxColumn Class

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

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Controls.DataGridColumn
        System.Windows.Controls.DataGridComboBoxColumn

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
public class DataGridComboBoxColumn : DataGridColumn
<DataGridComboBoxColumn .../>

The DataGridComboBoxColumn type exposes the following members.

  Name Description
Public method DataGridComboBoxColumn Initializes a new instance of the DataGridComboBoxColumn class.
Top
  Name Description
Public property ActualWidth Gets the current width of the column, in device-independent units (1/96th inch per unit). (Inherited from DataGridColumn.)
Public property 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.)
Public property CanUserResize Gets or sets a value that indicates whether the user can adjust the column width by using the mouse. (Inherited from DataGridColumn.)
Public property CanUserSort Gets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn.)
Public property CellStyle Gets or sets the style that is used to render cells in the column. (Inherited from DataGridColumn.)
Public property ClipboardContentBinding Gets or sets the binding object to use when getting or setting cell content for the clipboard. (Overrides DataGridColumn.ClipboardContentBinding.)
Protected property DataGridOwner Gets the DataGrid control that contains this column. (Inherited from DataGridColumn.)
Public property Static member DefaultEditingElementStyle Gets the default value of the EditingElementStyle property.
Public property Static member DefaultElementStyle Gets the default value of the ElementStyle.
Public property DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property DisplayIndex Gets or sets the display position of the column relative to the other columns in the DataGrid. (Inherited from DataGridColumn.)
Public property DisplayMemberPath Gets or sets a path to a value on the source object to provide the visual representation of the object.
Public property DragIndicatorStyle Gets or sets the style object to apply to the column header during a drag operation. (Inherited from DataGridColumn.)
Public property EditingElementStyle Gets or sets the style that is used when rendering the element that the column displays for a cell in editing mode.
Public property 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.
Public property Header Gets or sets the content of the column header. (Inherited from DataGridColumn.)
Public property HeaderStringFormat Gets or sets the format pattern to apply to the content of the column header. (Inherited from DataGridColumn.)
Public property HeaderStyle Gets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn.)
Public property HeaderTemplate Gets or sets the template that defines the visual representation of the column header. (Inherited from DataGridColumn.)
Public property HeaderTemplateSelector Gets or sets the object that selects which template to use for the column header. (Inherited from DataGridColumn.)
Public property IsAutoGenerated Gets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn.)
Public property IsFrozen Gets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn.)
Public property IsReadOnly Gets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn.)
Public property IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property ItemsSource Gets or sets a collection that is used to generate the content of the combo box control.
Public property MaxWidth Gets or sets the maximum width constraint of the column. (Inherited from DataGridColumn.)
Public property MinWidth Gets or sets the minimum width constraint of the column. (Inherited from DataGridColumn.)
Public property SelectedItemBinding Gets or sets the binding for the currently selected item.
Public property SelectedValueBinding Gets or sets the value of the selected item, obtained by using SelectedValuePath.
Public property SelectedValuePath Gets or sets the path that is used to get the SelectedValue from the SelectedItem.
Public property SortDirection Gets or sets the sort direction (ascending or descending) of the column. (Inherited from DataGridColumn.)
Public property 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.)
Public property TextBinding Gets or sets the binding for the text in the text box portion of the ComboBox control.
Public property Static member TextBlockComboBoxStyleKey Gets the resource key for the style to apply to a read-only combo box.
Public property Visibility Gets or sets the visibility of the column. (Inherited from DataGridColumn.)
Public property Width Gets or sets the column width or automatic sizing mode. (Inherited from DataGridColumn.)
Top
  Name Description
Protected method CancelCellEdit Causes the cell being edited to revert to the original, unedited value. (Inherited from DataGridColumn.)
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method CoerceValue 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.)
Protected method CommitCellEdit Performs any required validation before exiting cell editing mode. (Inherited from DataGridColumn.)
Public method Equals Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GenerateEditingElement Gets a combo box control that is bound to the column's SelectedItemBinding, SelectedValueBinding, and TextBinding values. (Overrides DataGridColumn.GenerateEditingElement(DataGridCell, Object).)
Protected method GenerateElement Gets a read-only combo box control that is bound to the column's SelectedItemBinding, SelectedValueBinding, and TextBinding values. (Overrides DataGridColumn.GenerateElement(DataGridCell, Object).)
Public method GetCellContent(DataGridRow) Retrieves the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn.)
Public method 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.)
Public method GetHashCode Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumerator Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidateProperty Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method NotifyPropertyChanged Notifies the DataGrid that contains this column that a column property has changed. (Inherited from DataGridColumn.)
Protected method OnCoerceIsReadOnly Determines the value of the IsReadOnly property based on property rules from the DataGrid that contains this column. (Overrides DataGridColumn.OnCoerceIsReadOnly(Boolean).)
Public method OnCopyingCellClipboardContent Raises the CopyingCellClipboardContent event. (Inherited from DataGridColumn.)
Public method OnPastingCellClipboardContent Raises the PastingCellClipboardContent event. (Inherited from DataGridColumn.)
Protected method OnPropertyChanged 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.)
Protected method OnSelectedItemBindingChanged Notifies the DataGrid when the SelectedItemBinding property changes.
Protected method OnSelectedValueBindingChanged Notifies the DataGrid when the SelectedValueBinding property changes.
Protected method OnTextBindingChanged Notifies the DataGrid when the TextBinding property changes.
Protected method PrepareCellForEdit Called when a cell in the column enters editing mode. (Overrides DataGridColumn.PrepareCellForEdit(FrameworkElement, RoutedEventArgs).)
Public method ReadLocalValue Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected method RefreshCellContent Refreshes the contents of a cell in the column in response to a binding change. (Overrides DataGridColumn.RefreshCellContent(FrameworkElement, String).)
Public method SetCurrentValue Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public method SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method 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.)
Protected method ShouldSerializeProperty Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  Name Description
Public event CopyingCellClipboardContent Occurs after the cell clipboard content is prepared. (Inherited from DataGridColumn.)
Public event PastingCellClipboardContent Occurs before the clipboard content is moved to the cell. (Inherited from DataGridColumn.)
Top
  Name Description
Public field Static member DisplayMemberPathProperty Identifies the DisplayMemberPath dependency property.
Public field Static member EditingElementStyleProperty Identifies the EditingElementStyle dependency property.
Public field Static member ElementStyleProperty Identifies the ElementStyle dependency property.
Public field Static member ItemsSourceProperty Identifies the ItemsSource dependency property.
Public field Static member SelectedValuePathProperty Identifies the SelectedValuePath dependency property.
Top

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.

A DataGridComboBoxColumn

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

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.

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
{


...


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;

}


...


//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; }

}


...


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


.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ