Back to all docs
API Reference / Telerik.Windows.Controls / GridViewComboBoxColumn

Class
GridViewComboBoxColumn

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:
cs-api-definition
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.IsFilterablePropertyGridViewColumn.ShowDistinctFiltersPropertyGridViewColumn.ShowFieldFiltersPropertyGridViewColumn.ShouldGenerateFieldFilterEditorsPropertyGridViewColumn.ShowFilterButtonPropertyGridViewColumn.FilteringControlStylePropertyGridViewColumn.IsFilteringDeferredPropertyGridViewColumn.FilterMemberTypePropertyGridViewColumn.OptimizeDistinctFilterQueryPropertyGridViewColumn.DistinctValuesDisplayModePropertyGridViewColumn.DistinctValuesSearchModePropertyGridViewColumn.EnableDistinctValuesFilteringPropertyGridViewColumn.WidthPropertyGridViewColumn.MinWidthPropertyGridViewColumn.MaxWidthPropertyGridViewColumn.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.CreateFieldFilterEditor()GridViewColumn.CreateColumnFilterDescriptor()GridViewColumn.ClearFilters()GridViewColumn.GetFilteringDisplayString(object)GridViewColumn.SortDistinctValuesByFilteringDisplay(IQueryable)GridViewColumn.OnPropertyChanged(PropertyChangedEventArgs)GridViewColumn.OnPropertyChanged(string)GridViewColumn.GetAggregateResults(QueryableCollectionViewGroup)GridViewColumn.OnAggregateFunctionsItemChanged(ItemChangedEventArgs<AggregateFunction>)GridViewColumn.GetGridViewColumn(IFieldDescriptor)GridViewColumn.OnInitialized(EventArgs)GridViewColumn.CreateField()GridViewColumn.IsFilterableGridViewColumn.ShowDistinctFiltersGridViewColumn.ShowFieldFiltersGridViewColumn.ShouldGenerateFieldFilterEditorsGridViewColumn.ShowFilterButtonGridViewColumn.FilteringControlStyleGridViewColumn.DistinctValuesDisplayModeGridViewColumn.DistinctValuesSearchModeGridViewColumn.EnableDistinctValuesFilteringGridViewColumn.FilteringControlGridViewColumn.ColumnFilterDescriptorGridViewColumn.IsFilteringDeferredGridViewColumn.FilterMemberPathGridViewColumn.FilterMemberTypeGridViewColumn.OptimizeDistinctFilterQueryGridViewColumn.TargetFiltersGridViewColumn.WidthGridViewColumn.MinWidthGridViewColumn.MaxWidthGridViewColumn.ActualWidthGridViewColumn.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.PropertyChangedGridViewColumn.SortingStateChanged

Constructors

GridViewComboBoxColumn()

Declaration

cs-api-definition
public GridViewComboBoxColumn()

Fields

DisplayMemberPathProperty

Represents the DisplayMemberPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DisplayMemberPathProperty

Field Value

DependencyProperty

EmptyTextProperty

Represents the EmptyText dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty EmptyTextProperty

Field Value

DependencyProperty

IsComboBoxEditableProperty

Represents the IsComboBoxEditable dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsComboBoxEditableProperty

Field Value

DependencyProperty

IsLightweightModeEnabledProperty

Represents the IsLightweightModeEnabled dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsLightweightModeEnabledProperty

Field Value

DependencyProperty

ItemTemplateProperty

Represents the ItemTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemTemplateProperty

Field Value

DependencyProperty

ItemsSourceProperty

Represents the ItemsSource dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsSourceProperty

Field Value

DependencyProperty

SelectedValueMemberPathProperty

Represents the ValueMemberPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedValueMemberPathProperty

Field Value

DependencyProperty

Properties

DisplayMemberPath

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

Declaration

cs-api-definition
public string DisplayMemberPath { get; set; }

Property Value

string

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.

Declaration

cs-api-definition
public string EmptyText { get; set; }

Property Value

string

IsComboBoxEditable

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

Declaration

cs-api-definition
public bool IsComboBoxEditable { get; set; }

Property Value

bool

IsLightweightModeEnabled

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

Declaration

cs-api-definition
public bool IsLightweightModeEnabled { get; set; }

Property Value

bool

ItemTemplate

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

Declaration

cs-api-definition
public DataTemplate ItemTemplate { get; set; }

Property Value

DataTemplate

The item template.

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.

Declaration

cs-api-definition
public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable

The items source.

ItemsSourceBinding

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

Declaration

cs-api-definition
public Binding ItemsSourceBinding { get; set; }

Property Value

Binding

The default value is null

LookupValueConverter

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

Declaration

cs-api-definition
public IValueConverter LookupValueConverter { get; set; }

Property Value

IValueConverter

The lookup value converter.

SelectedValueMemberPath

Gets or sets the value member path.

Declaration

cs-api-definition
public string SelectedValueMemberPath { get; set; }

Property Value

string

The value member path.

Methods

CopyPropertiesFrom(GridViewColumn)

Copy properties from source column.

Declaration

cs-api-definition
public override void CopyPropertiesFrom(GridViewColumn source)

Parameters

source

GridViewColumn

Overrides GridViewBoundColumnBase.CopyPropertiesFrom(GridViewColumn)

CreateCellEditElement(GridViewCell, object)

Creates the element for the cell in edit mode.

Declaration

cs-api-definition
public override FrameworkElement CreateCellEditElement(GridViewCell cell, object dataItem)

Parameters

cell

GridViewCell

dataItem

object

Returns

FrameworkElement

Overrides GridViewColumn.CreateCellEditElement(GridViewCell, object)

CreateCellElement(GridViewCell, object)

Creates the element for the cell in view mode.

Declaration

cs-api-definition
public override FrameworkElement CreateCellElement(GridViewCell cell, object dataItem)

Parameters

cell

GridViewCell

dataItem

object

Returns

FrameworkElement

Overrides GridViewBoundColumnBase.CreateCellElement(GridViewCell, object)

GetCellContent(object)

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

Declaration

cs-api-definition
protected override object GetCellContent(object item)

Parameters

item

object

The data item.

Returns

object

Cell content.

Overrides GridViewBoundColumnBase.GetCellContent(object)

GetDisplayCellContent(object)

Generates the cell content of GridViewBoundColumnBase.

Declaration

cs-api-definition
protected override object GetDisplayCellContent(object item)

Parameters

item

object

Returns

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.

Declaration

cs-api-definition
public override void OnPastingCellClipboardContent(object item, object value)

Parameters

item

object

The data context for the selected element.

value

object

The clipboard data for the selected cell.

Overrides GridViewBoundColumnBase.OnPastingCellClipboardContent(object, object)

PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

Prepares GridViewCell for edit.

Declaration

cs-api-definition
protected override object PrepareCellForEdit(FrameworkElement editingElement, RoutedEventArgs editingEventArgs)

Parameters

editingElement

FrameworkElement

The editing element.

editingEventArgs

RoutedEventArgs

The RoutedEventArgs instance containing the event data.

Returns

object

Overrides GridViewBoundColumnBase.PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

Refresh()

Refresh this column cells.

Declaration

cs-api-definition
protected override void Refresh()

Overrides GridViewColumn.Refresh()

SortDistinctValues(IQueryable)

Sorts the distinct values.

Declaration

cs-api-definition
protected override IQueryable SortDistinctValues(IQueryable source)

Parameters

source

IQueryable

The unsorted distinct values.

Returns

IQueryable

The sorted distinct values.

Overrides GridViewColumn.SortDistinctValues(IQueryable)

In this article
DefinitionConstructorsGridViewComboBoxColumn()FieldsDisplayMemberPathPropertyEmptyTextPropertyIsComboBoxEditablePropertyIsLightweightModeEnabledPropertyItemTemplatePropertyItemsSourcePropertySelectedValueMemberPathPropertyPropertiesDisplayMemberPathEmptyTextIsComboBoxEditableIsLightweightModeEnabledItemTemplateItemsSourceItemsSourceBindingLookupValueConverterSelectedValueMemberPathMethodsCopyPropertiesFrom(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