Back to all docs
API Reference / Telerik.WinControls.UI / GridViewCommandColumn

Class
GridViewCommandColumn

Inherits GridViewDataColumn and contains buttons, one per row.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:
cs-api-definition
public class GridViewCommandColumn : GridViewDataColumn, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IEditorProvider, INotifyPropertyChangingEx, IDataConversionInfoProvider, IGridViewEventListener, ITypeDescriptorContext, IServiceProvider

Inheritance: objectDisposableObjectRadObjectGridViewColumnGridViewDataColumnGridViewCommandColumn

Implements: ICustomTypeDescriptorIDataConversionInfoProviderIDisposableIEditorProviderIGridViewEventListenerINotifyPropertyChangedINotifyPropertyChangingExIServiceProviderITypeDescriptorContext

Inherited Members GridViewDataColumn.FormatStringPropertyGridViewDataColumn.DataEditFormatStringPropertyGridViewDataColumn.FormatInfoPropertyGridViewDataColumn.NullValuePropertyGridViewDataColumn.DataSourceNullValuePropertyGridViewDataColumn.UseDataTypeConverterWhenSortingPropertyGridViewDataColumn.DataTypeConverterPropertyGridViewDataColumn.DataTypePropertyGridViewDataColumn.AllowFilteringPropertyGridViewDataColumn.AllowSearchingPropertyGridViewDataColumn.AllowNaturalSortPropertyGridViewDataColumn.AutoFilterDelayPropertyGridViewDataColumn.AllowCellMergingPropertyGridViewDataColumn.excelFormatGridViewDataColumn.GetDefaultDataTypeConverter(Type)GridViewDataColumn.ToString()GridViewDataColumn.GetDistinctValues()GridViewDataColumn.GetDistinctValuesWithFilter()GridViewDataColumn.UpdateDistinctValuesOnAdd(object)GridViewDataColumn.UpdateDistinctValues()GridViewDataColumn.UpdateDistinctValuesWithFilter()GridViewDataColumn.UpdateDistinctValuesOnAddWithFilter(object)GridViewDataColumn.OnNotifyPropertyChanging(PropertyChangingEventArgsEx)GridViewDataColumn.Initialize()GridViewDataColumn.OnPropertyChanged(RadPropertyChangedEventArgs)GridViewDataColumn.GetEventInfo(RadProperty, out GridEventDispatchMode)GridViewDataColumn.PreProcessEvent(GridViewEvent)GridViewDataColumn.ProcessEvent(GridViewEvent)GridViewDataColumn.PostProcessEvent(GridViewEvent)GridViewDataColumn.AnalyzeQueue(List<GridViewEvent>)GridViewDataColumn.CreateSnapshot()GridViewDataColumn.AutoFilterDelayGridViewDataColumn.AllowNaturalSortGridViewDataColumn.DataTypeConverterGridViewDataColumn.UseDataTypeConverterWhenSortingGridViewDataColumn.FilterDescriptorGridViewDataColumn.DataTypeGridViewDataColumn.ExcelExportTypeGridViewDataColumn.ExcelExportFormatStringGridViewDataColumn.FormatInfoGridViewDataColumn.FormatStringGridViewDataColumn.NullValueGridViewDataColumn.DataSourceNullValueGridViewDataColumn.AllowCellMergingGridViewDataColumn.DistinctValuesGridViewDataColumn.DistinctValuesWithFilterGridViewDataColumn.DesiredEventsGridViewDataColumn.PriorityGridViewDataColumn.DesiredProcessModeGridViewColumn.FieldNamePropertyGridViewColumn.NamePropertyGridViewColumn.HeaderTextPropertyGridViewColumn.ExpressionPropertyGridViewColumn.EnableExpressionEditorPropertyGridViewColumn.IsVisiblePropertyGridViewColumn.IsAutoGeneratedPropertyGridViewColumn.VisibleInColumnChooserPropertyGridViewColumn.PinPositionPropertyGridViewColumn.AllowSortPropertyGridViewColumn.AllowGroupPropertyGridViewColumn.ReadOnlyPropertyGridViewColumn.AllowResizePropertyGridViewColumn.AllowHidePropertyGridViewColumn.DisableHTMLRenderingPropertyGridViewColumn.WrapTextPropertyGridViewColumn.TextAlignmentPropertyGridViewColumn.HeaderTextAlignmentPropertyGridViewColumn.HeaderImagePropertyGridViewColumn.HeaderSvgImagePropertyGridViewColumn.ImageLayoutPropertyGridViewColumn.TextImageRelationPropertyGridViewColumn.WidthPropertyGridViewColumn.RenderWidthPropertyGridViewColumn.MinWidthPropertyGridViewColumn.MaxWidthPropertyGridViewColumn.RowSpanPropertyGridViewColumn.StretchVerticallyPropertyGridViewColumn.ShowEditorPropertyGridViewColumn.IsCurrentPropertyGridViewColumn.AutoEllipsisPropertyGridViewColumn.AutoSizeModePropertyGridViewColumn.AllowReorderPropertyGridViewColumn.TagPropertyGridViewColumn.BestFit()GridViewColumn.Sort(RadSortOrder, bool)GridViewColumn.CanDragToGroup(GridViewTemplate)GridViewColumn.CanDragToGroup()GridViewColumn.GetDefaultMinWidth()GridViewColumn.IsPropertyCancelable(RadPropertyMetadata)GridViewColumn.GetDefaultEditor()GridViewColumn.GetDefaultEditorType()GridViewColumn.InitializeEditor(IInputEditor)GridViewColumn.DispatchEvent(KnownEvents, GridEventType, GridEventDispatchMode, object, object[])GridViewColumn.OnNotifyPropertyChanging(string)GridViewColumn.OnPropertyChanging(RadPropertyChangingEventArgs)GridViewColumn.IsFieldNamePathGridViewColumn.HeaderImageGridViewColumn.HeaderSvgImageGridViewColumn.ImageLayoutGridViewColumn.TextImageRelationGridViewColumn.WidthGridViewColumn.MinWidthGridViewColumn.MaxWidthGridViewColumn.RowSpanGridViewColumn.StretchVerticallyGridViewColumn.AutoSizeModeGridViewColumn.TagGridViewColumn.FieldNameGridViewColumn.NameGridViewColumn.SortOrderGridViewColumn.ExpressionGridViewColumn.EnableExpressionEditorGridViewColumn.ConditionalFormattingObjectListGridViewColumn.IndexGridViewColumn.OwnerTemplateGridViewColumn.IsDataBoundGridViewColumn.IsSortedGridViewColumn.IsGroupedGridViewColumn.VisibleInColumnChooserGridViewColumn.IsVisibleGridViewColumn.IsCurrentGridViewColumn.IsPinnedGridViewColumn.PinPositionGridViewColumn.AllowReorderGridViewColumn.AllowSortGridViewColumn.AllowResizeGridViewColumn.AllowHideGridViewColumn.HeaderTextGridViewColumn.DisableHTMLRenderingGridViewColumn.WrapTextGridViewColumn.AutoEllipsisGridViewColumn.HeaderTextAlignmentGridViewColumn.TextAlignmentGridViewColumn.EventDispatcherGridViewColumn.DpiScaleGridViewColumn.PropertyChangingRadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

GridViewCommandColumn()

Initializes a new instance of the GridViewCommandColumn.

Declaration

cs-api-definition
public GridViewCommandColumn()

GridViewCommandColumn(string)

Initializes a new instance of the GridViewCommandColumn.

Declaration

cs-api-definition
public GridViewCommandColumn(string fieldName)

Parameters

fieldName

string

A string value referring to the unique name of the column.

GridViewCommandColumn(string, string)

Initializes a new instance of the GridViewCommandColumn.

Declaration

cs-api-definition
public GridViewCommandColumn(string uniqueName, string fieldName)

Parameters

uniqueName

string

A string value referring to the unique name of the column.

fieldName

string

A string value referring to the field name to which the column is bound.

Fields

DefaultTextProperty

Declaration

cs-api-definition
public static RadProperty DefaultTextProperty

Field Value

RadProperty

ImageAlignmentProperty

Declaration

cs-api-definition
public static RadProperty ImageAlignmentProperty

Field Value

RadProperty

ImageProperty

Declaration

cs-api-definition
public static RadProperty ImageProperty

Field Value

RadProperty

UseDefaultTextProperty

Declaration

cs-api-definition
public static RadProperty UseDefaultTextProperty

Field Value

RadProperty

Properties

AllowFiltering

Gets or sets a value indicating whether the user can filter by this column.

Declaration

cs-api-definition
[Browsable(true)]
public override bool AllowFiltering { get; set; }

Property Value

bool

Overrides GridViewDataColumn.AllowFiltering

AllowGroup

Declaration

cs-api-definition
[Browsable(true)]
public override bool AllowGroup { get; set; }

Property Value

bool

Overrides GridViewColumn.AllowGroup

Remarks

This property is overriden to always return false since grouping by this column is not allowed.

AllowSearching

Gets or sets a value indicating whether the user can search by this column.

Declaration

cs-api-definition
[Browsable(true)]
public override bool AllowSearching { get; set; }

Property Value

bool

Overrides GridViewDataColumn.AllowSearching

DefaultText

Gets or sets the default text displayed on the button cell.

Declaration

cs-api-definition
[Browsable(true)]
public virtual string DefaultText { get; set; }

Property Value

string

Image

Gets or sets the default text displayed on the button cell.

Declaration

cs-api-definition
[Browsable(true)]
[TypeConverter(typeof(ImageTypeConverter))]
public Image Image { get; set; }

Property Value

Image

ImageAlignment

Gets or sets the image layout of the image inside the cells.

Declaration

cs-api-definition
[Browsable(false)]
public virtual ContentAlignment ImageAlignment { get; set; }

Property Value

ContentAlignment

ReadOnly

Declaration

cs-api-definition
[Browsable(true)]
public override bool ReadOnly { get; set; }

Property Value

bool

Overrides GridViewColumn.ReadOnly

Remarks

This property is overriden to always return true since Command column cannot be edited.

UseDefaultText

Gets or sets a value indicating whether the default text or the value as text will appear on the button displayed by the cell.

Declaration

cs-api-definition
[Browsable(true)]
public bool UseDefaultText { get; set; }

Property Value

bool

Methods

GetCellType(GridViewRowInfo)

Gets the type of the cell.

Declaration

cs-api-definition
public override Type GetCellType(GridViewRowInfo row)

Parameters

row

GridViewRowInfo

The row.

Returns

Type

Overrides GridViewDataColumn.GetCellType(GridViewRowInfo)

GetDefaultGroupByExpression()

Declaration

cs-api-definition
public override string GetDefaultGroupByExpression()

Returns

string

string.Empty

Overrides GridViewColumn.GetDefaultGroupByExpression()

Remarks

Grouping by this type of column cannot be performed. That method returns string.empty

In this article
DefinitionConstructorsGridViewCommandColumn()GridViewCommandColumn(string)GridViewCommandColumn(string, string)FieldsDefaultTextPropertyImageAlignmentPropertyImagePropertyUseDefaultTextPropertyPropertiesAllowFilteringAllowGroupAllowSearchingDefaultTextImageImageAlignmentReadOnlyUseDefaultTextMethodsGetCellType(GridViewRowInfo)GetDefaultGroupByExpression()
Not finding the help you need?
Contact Support