Back to all docs
API Reference / Telerik.Windows.Controls / GridViewComboBoxColumn
New to Telerik UI for WPF? Start a free 30-day trial

GridViewComboBoxColumn

Class

GridViewComboBoxColumn provides an easy and fast way to display and edit lookup data. The key properties to set are : valueMemberPath, DisplayMemberPath and ItemsSource.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.GridView.dll

Syntax:
C#
public class GridViewComboBoxColumn : GridViewBoundColumnBase, INotifyPropertyChanged, IDataFieldDescriptor, IFieldDescriptor, IExportableColumn

Inheritance: objectGridViewColumnGridViewBoundColumnBaseGridViewComboBoxColumn

Implements: IDataFieldDescriptorIExportableColumnIFieldDescriptorINotifyPropertyChanged

Inherited Members GridViewBoundColumnBase.IsSearchablePropertyGridViewBoundColumnBase.EditorStylePropertyGridViewBoundColumnBase.ValidatesOnDataErrorsPropertyGridViewBoundColumnBase.DataTypePropertyGridViewBoundColumnBase.DataFormatStringPropertyGridViewBoundColumnBase.RefreshCellElement(FrameworkElement, DependencyProperty)GridViewBoundColumnBase.OnAggregateFunctionsCollectionChanged(NotifyCollectionChangedEventArgs)GridViewBoundColumnBase.CanEdit(object)GridViewBoundColumnBase.OnDataMemberBindingChanged()GridViewBoundColumnBase.CanSort()GridViewBoundColumnBase.CanGroup()GridViewBoundColumnBase.GetValueForItem(object)GridViewBoundColumnBase.GetNewValueFromEditor(object)GridViewBoundColumnBase.UpdateSourceWithEditorValue(GridViewCell)GridViewBoundColumnBase.OnCopyingCellClipboardContent(object)GridViewBoundColumnBase.GetExportCellContent(object)GridViewBoundColumnBase.CanFilter()GridViewBoundColumnBase.ExportedElementWidthGridViewBoundColumnBase.IsSearchableGridViewBoundColumnBase.EditorStyleGridViewBoundColumnBase.ValidatesOnDataErrorsGridViewBoundColumnBase.HeaderGridViewBoundColumnBase.BindingTargetGridViewBoundColumnBase.IsReadOnlyBindingGridViewBoundColumnBase.DataTypeGridViewBoundColumnBase.DataFormatStringGridViewBoundColumnBase.DataMemberBindingGridViewBoundColumnBase.SearchPanelGridViewBoundColumnBase.FilteringDisplayFuncGridViewColumn.TabStopModePropertyGridViewColumn.FooterCellStylePropertyGridViewColumn.GroupFooterCellStylePropertyGridViewColumn.HeaderCellStylePropertyGridViewColumn.EditTriggersPropertyGridViewColumn.IsFrozenPropertyGridViewColumn.CellStylePropertyGridViewColumn.CellTemplateSelectorPropertyGridViewColumn.CellEditTemplateSelectorPropertyGridViewColumn.CellEditTemplatePropertyGridViewColumn.CellTemplatePropertyGridViewColumn.ToolTipTemplatePropertyGridViewColumn.ToolTipTemplateSelectorPropertyGridViewColumn.ShowToolTipOnTrimmedTextPropertyGridViewColumn.ToolTipShowDurationPropertyGridViewColumn.GroupFooterTemplateSelectorPropertyGridViewColumn.GroupFooterTemplatePropertyGridViewColumn.GroupHeaderTemplateSelectorPropertyGridViewColumn.GroupHeaderTemplatePropertyGridViewColumn.SortingStatePropertyGridViewColumn.IsSortablePropertyGridViewColumn.IsResizablePropertyGridViewColumn.IsGroupablePropertyGridViewColumn.IsReorderablePropertyGridViewColumn.SortingStateChangedEventGridViewColumn.IsReadOnlyPropertyGridViewColumn.TextAlignmentPropertyGridViewColumn.HeaderTextAlignmentPropertyGridViewColumn.TextWrappingPropertyGridViewColumn.HeaderTextWrappingPropertyGridViewColumn.FooterPropertyGridViewColumn.HeaderPropertyGridViewColumn.TextDecorationsPropertyGridViewColumn.HeaderTextDecorationsPropertyGridViewColumn.IsCustomSortingEnabledPropertyGridViewColumn.CellStyleSelectorPropertyGridViewColumn.GroupFooterCellStyleSelectorPropertyGridViewColumn.FooterTextAlignmentPropertyGridViewColumn.TextTrimmingPropertyGridViewColumn.HeaderTextTrimmingPropertyGridViewColumn.BackgroundPropertyGridViewColumn.IsVisiblePropertyGridViewColumn.DisplayIndexPropertyGridViewColumn.ShowColumnWhenGroupedPropertyGridViewColumn.SortingIndexPropertyGridViewColumn.IsSelectedPropertyGridViewColumn.IsFilterablePropertyGridViewColumn.ShowDistinctFiltersPropertyGridViewColumn.ShowFieldFiltersPropertyGridViewColumn.ShouldGenerateFieldFilterEditorsPropertyGridViewColumn.ShowFilterButtonPropertyGridViewColumn.FilteringControlStylePropertyGridViewColumn.IsFilteringDeferredPropertyGridViewColumn.FilterMemberTypePropertyGridViewColumn.OptimizeDistinctFilterQueryPropertyGridViewColumn.DistinctValuesDisplayModePropertyGridViewColumn.DistinctValuesSearchModePropertyGridViewColumn.EnableDistinctValuesFilteringPropertyGridViewColumn.WidthPropertyGridViewColumn.MinWidthPropertyGridViewColumn.MaxWidthPropertyGridViewColumn.GetAggregateResults(QueryableCollectionViewGroup)GridViewColumn.OnAggregateFunctionsItemChanged(ItemChangedEventArgs<AggregateFunction>)GridViewColumn.GetGridViewColumn(IFieldDescriptor)GridViewColumn.OnInitialized(EventArgs)GridViewColumn.CreateField()GridViewColumn.CreateFieldFilterEditor()GridViewColumn.CreateColumnFilterDescriptor()GridViewColumn.ClearFilters()GridViewColumn.GetFilteringDisplayString(object)GridViewColumn.SortDistinctValuesByFilteringDisplay(IQueryable)GridViewColumn.OnPropertyChanged(PropertyChangedEventArgs)GridViewColumn.OnPropertyChanged(string)GridViewColumn.IsAutoGeneratedGridViewColumn.TabStopModeGridViewColumn.EditTriggersGridViewColumn.CellTemplateSelectorGridViewColumn.CellEditTemplateSelectorGridViewColumn.CellEditTemplateGridViewColumn.CellTemplateGridViewColumn.ToolTipTemplateGridViewColumn.ToolTipTemplateSelectorGridViewColumn.ShowToolTipOnTrimmedTextGridViewColumn.ToolTipShowDurationGridViewColumn.GroupFooterTemplateSelectorGridViewColumn.GroupFooterTemplateGridViewColumn.GroupHeaderTemplateSelectorGridViewColumn.GroupHeaderTemplateGridViewColumn.AggregateFunctionsGridViewColumn.IsReorderableGridViewColumn.IsFrozenGridViewColumn.IsRightSideFrozenGridViewColumn.IsLeftSideFrozenGridViewColumn.TextDecorationsGridViewColumn.HeaderTextDecorationsGridViewColumn.SortingStateGridViewColumn.IsGroupableGridViewColumn.CellStyleGridViewColumn.CellStyleSelectorGridViewColumn.IsResizableGridViewColumn.IsSortableGridViewColumn.HeaderCellStyleGridViewColumn.FooterCellStyleGridViewColumn.GroupFooterCellStyleGridViewColumn.GroupFooterCellStyleSelectorGridViewColumn.TextAlignmentGridViewColumn.HeaderTextAlignmentGridViewColumn.FooterTextAlignmentGridViewColumn.TextWrappingGridViewColumn.HeaderTextWrappingGridViewColumn.TextTrimmingGridViewColumn.HeaderTextTrimmingGridViewColumn.IsCustomSortingEnabledGridViewColumn.BackgroundGridViewColumn.IsVisibleGridViewColumn.UniqueNameGridViewColumn.SortMemberPathGridViewColumn.GroupMemberPathGridViewColumn.FooterGridViewColumn.IsReadOnlyGridViewColumn.DataControlGridViewColumn.DisplayIndexGridViewColumn.GroupHeaderFormatStringGridViewColumn.ColumnGroupNameGridViewColumn.ItemTypeGridViewColumn.ShowColumnWhenGroupedGridViewColumn.SortingIndexGridViewColumn.IsSelectedGridViewColumn.IsFilterableGridViewColumn.ShowDistinctFiltersGridViewColumn.ShowFieldFiltersGridViewColumn.ShouldGenerateFieldFilterEditorsGridViewColumn.ShowFilterButtonGridViewColumn.FilteringControlStyleGridViewColumn.DistinctValuesDisplayModeGridViewColumn.DistinctValuesSearchModeGridViewColumn.EnableDistinctValuesFilteringGridViewColumn.FilteringControlGridViewColumn.ColumnFilterDescriptorGridViewColumn.IsFilteringDeferredGridViewColumn.FilterMemberPathGridViewColumn.FilterMemberTypeGridViewColumn.OptimizeDistinctFilterQueryGridViewColumn.TargetFiltersGridViewColumn.WidthGridViewColumn.MinWidthGridViewColumn.MaxWidthGridViewColumn.ActualWidthGridViewColumn.SortingStateChangedGridViewColumn.PropertyChanged...

Constructors

GridViewComboBoxColumn()

C#
public GridViewComboBoxColumn()

Fields

DisplayMemberPathProperty

DependencyProperty

Represents the DisplayMemberPath dependency property.

C#
public static readonly DependencyProperty DisplayMemberPathProperty

EmptyTextProperty

DependencyProperty

Represents the EmptyText dependency property.

C#
public static readonly DependencyProperty EmptyTextProperty

IsComboBoxEditableProperty

DependencyProperty

Represents the IsComboBoxEditable dependency property.

C#
public static readonly DependencyProperty IsComboBoxEditableProperty

IsLightweightModeEnabledProperty

DependencyProperty

Represents the IsLightweightModeEnabled dependency property.

C#
public static readonly DependencyProperty IsLightweightModeEnabledProperty

ItemsSourceProperty

DependencyProperty

Represents the ItemsSource dependency property.

C#
public static readonly DependencyProperty ItemsSourceProperty

ItemTemplateProperty

DependencyProperty

Represents the ItemTemplate dependency property.

C#
public static readonly DependencyProperty ItemTemplateProperty

SelectedValueMemberPathProperty

DependencyProperty

Represents the ValueMemberPath dependency property.

C#
public static readonly DependencyProperty SelectedValueMemberPathProperty

Properties

DisplayMemberPath

Gets or sets the path to the property containing the data to display.

C#
public string DisplayMemberPath { get; set; }
Property Value:

The display member path.

EmptyText

Gets or sets a string that should be displayed in the GridViewCell element when there is no selection in the GridViewComboBoxColumn. This is a dependency property.

C#
public string EmptyText { get; set; }

IsComboBoxEditable

Gets or sets a value indicating whether the user can edit text in the text box portion of the ComboBox editor.

C#
public bool IsComboBoxEditable { get; set; }

IsLightweightModeEnabled

Gets or sets a value indicating whether the LightweightMode of the ComboBoxColumn is enabled.

C#
public bool IsLightweightModeEnabled { get; set; }

ItemsSource

Gets or sets the the list of items used in the column to display lookup data. The ComboBox editor will also attach to this ItemsSource.

C#
public IEnumerable ItemsSource { get; set; }
Property Value:

The items source.

ItemsSourceBinding

Binding

Gets or sets the Binding for the ComboBoxEditor ItemsSource. This is a dependency property.

C#
public Binding ItemsSourceBinding { get; set; }
Property Value:

The default value is null

ItemTemplate

DataTemplate

Gets or sets the item template used to represent the selected item in cells.

C#
public DataTemplate ItemTemplate { get; set; }
Property Value:

The item template.

LookupValueConverter

IValueConverter

Gets or sets the lookup value converter used to convert value member value to display value.

C#
public IValueConverter LookupValueConverter { get; set; }
Property Value:

The lookup value converter.

SelectedValueMemberPath

Gets or sets the value member path.

C#
public string SelectedValueMemberPath { get; set; }
Property Value:

The value member path.

Methods

CopyPropertiesFrom(GridViewColumn)

Copy properties from source column.

C#
public override void CopyPropertiesFrom(GridViewColumn source)
Parameters:sourceGridViewColumn

Overrides: GridViewBoundColumnBase.CopyPropertiesFrom(GridViewColumn)

CreateCellEditElement(GridViewCell, object)

FrameworkElement

Creates the element for the cell in edit mode.

C#
public override FrameworkElement CreateCellEditElement(GridViewCell cell, object dataItem)
Parameters:cellGridViewCelldataItemobjectReturns:

FrameworkElement

Overrides: GridViewColumn.CreateCellEditElement(GridViewCell, object)

CreateCellElement(GridViewCell, object)

FrameworkElement

Creates the element for the cell in view mode.

C#
public override FrameworkElement CreateCellElement(GridViewCell cell, object dataItem)
Parameters:cellGridViewCelldataItemobjectReturns:

FrameworkElement

Overrides: GridViewBoundColumnBase.CreateCellElement(GridViewCell, object)

GetCellContent(object)

Gets the content of a cell that is associated with this column.

C#
protected override object GetCellContent(object item)
Parameters:itemobject

The data item.

Returns:

object

Cell content.

Overrides: GridViewBoundColumnBase.GetCellContent(object)

GetDisplayCellContent(object)

Generates the cell content of GridViewBoundColumnBase.

C#
protected override object GetDisplayCellContent(object item)
Parameters:itemobjectReturns:

object

Overrides: GridViewBoundColumnBase.GetDisplayCellContent(object)

OnPastingCellClipboardContent(object, object)

This method is called for each selected cell to replace the cell content with data from the clipboard.

C#
public override void OnPastingCellClipboardContent(object item, object value)
Parameters:itemobject

The data context for the selected element.

valueobject

The clipboard data for the selected cell.

Overrides: GridViewBoundColumnBase.OnPastingCellClipboardContent(object, object)

PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

Prepares GridViewCell for edit.

C#
protected override object PrepareCellForEdit(FrameworkElement editingElement, RoutedEventArgs editingEventArgs)
Parameters:editingElementFrameworkElement

The editing element.

editingEventArgsRoutedEventArgs

The RoutedEventArgs instance containing the event data.

Returns:

object

Overrides: GridViewBoundColumnBase.PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

Refresh()

Refresh this column cells.

C#
protected override void Refresh()

Overrides: GridViewColumn.Refresh()

SortDistinctValues(IQueryable)

Sorts the distinct values.

C#
protected override IQueryable SortDistinctValues(IQueryable source)
Parameters:sourceIQueryable

The unsorted distinct values.

Returns:

IQueryable

The sorted distinct values.

Overrides: GridViewColumn.SortDistinctValues(IQueryable)

In this article
DefinitionConstructorsGridViewComboBoxColumn()FieldsDisplayMemberPathPropertyEmptyTextPropertyIsComboBoxEditablePropertyIsLightweightModeEnabledPropertyItemsSourcePropertyItemTemplatePropertySelectedValueMemberPathPropertyPropertiesDisplayMemberPathEmptyTextIsComboBoxEditableIsLightweightModeEnabledItemsSourceItemsSourceBindingItemTemplateLookupValueConverterSelectedValueMemberPathMethodsCopyPropertiesFrom(GridViewColumn)CreateCellEditElement(GridViewCell, object)CreateCellElement(GridViewCell, object)GetCellContent(object)GetDisplayCellContent(object)OnPastingCellClipboardContent(object, object)PrepareCellForEdit(FrameworkElement, RoutedEventArgs)Refresh()SortDistinctValues(IQueryable)
Not finding the help you need?
Contact Support