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

Class
GridViewCheckBoxColumn

Inherits GridViewDataColumn and presents Boolean values

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

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

Inheritance: objectDisposableObjectRadObjectGridViewColumnGridViewDataColumnGridViewCheckBoxColumn

Implements: IContextMenuProviderICustomTypeDescriptorIDataConversionInfoProviderIDisposableIEditorProviderIGridViewEventListenerINotifyPropertyChangedINotifyPropertyChangingExIServiceProviderITypeDescriptorContext

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.AllowFilteringGridViewDataColumn.AllowSearchingGridViewDataColumn.AllowNaturalSortGridViewDataColumn.DataTypeConverterGridViewDataColumn.UseDataTypeConverterWhenSortingGridViewDataColumn.FilterDescriptorGridViewDataColumn.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.CreateConditionalFormattingForm()GridViewColumn.BestFit()GridViewColumn.Sort(RadSortOrder)GridViewColumn.Sort(RadSortOrder, bool)GridViewColumn.GetDefaultGroupByExpression()GridViewColumn.CanDragToGroup(GridViewTemplate)GridViewColumn.CanDragToGroup()GridViewColumn.IsPropertyCancelable(RadPropertyMetadata)GridViewColumn.ShowContextMenu()GridViewColumn.CreateContextMenuItems(RadDropDownMenu)GridViewColumn.MergeMenus(RadDropDownMenu, params object[])GridViewColumn.MergeMenus(IContextMenuProvider, params object[])GridViewColumn.MergeMenus(IContextMenuManager, params object[])GridViewColumn.ToggleSortOrder()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.AllowGroupGridViewColumn.ReadOnlyGridViewColumn.AllowResizeGridViewColumn.AllowHideGridViewColumn.HeaderTextGridViewColumn.DisableHTMLRenderingGridViewColumn.WrapTextGridViewColumn.AutoEllipsisGridViewColumn.HeaderTextAlignmentGridViewColumn.TextAlignmentGridViewColumn.EventDispatcherGridViewColumn.DpiScaleGridViewColumn.ContextMenuGridViewColumn.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

GridViewCheckBoxColumn()

Initializes a new instance of the GridViewCheckBoxColumn.

Declaration

cs-api-definition
public GridViewCheckBoxColumn()

GridViewCheckBoxColumn(string)

Initializes a new instance of the GridViewComboBoxColumn.

Declaration

cs-api-definition
public GridViewCheckBoxColumn(string fieldName)

Parameters

fieldName

string

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

GridViewCheckBoxColumn(string, string)

Initializes a new instance of the GridViewComboBoxColumn.

Declaration

cs-api-definition
public GridViewCheckBoxColumn(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

CheckedProperty

Declaration

cs-api-definition
public static RadProperty CheckedProperty

Field Value

RadProperty

EnableHeaderCheckBoxProperty

Declaration

cs-api-definition
public static RadProperty EnableHeaderCheckBoxProperty

Field Value

RadProperty

HeaderCheckBoxAlignmentProperty

Declaration

cs-api-definition
public static RadProperty HeaderCheckBoxAlignmentProperty

Field Value

RadProperty

HeaderCheckBoxPositionProperty

Declaration

cs-api-definition
public static RadProperty HeaderCheckBoxPositionProperty

Field Value

RadProperty

ShouldCheckDataRowsProperty

Declaration

cs-api-definition
public static RadProperty ShouldCheckDataRowsProperty

Field Value

RadProperty

ThreeStateProperty

Declaration

cs-api-definition
public static RadProperty ThreeStateProperty

Field Value

RadProperty

Properties

CheckFilteredRows

Gets or sets a value indicating if the hidden rows will be checked by the header check-box.

Declaration

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

Property Value

bool

Checked

Gets a value indicating whether the CheckBox in header cell checked.

Declaration

cs-api-definition
public ToggleState Checked { get; set; }

Property Value

ToggleState

DataType

Gets or sets the data type of the column.

Declaration

cs-api-definition
public override Type DataType { get; set; }

Property Value

Type

Overrides GridViewDataColumn.DataType

EditMode

This property determines whether changing a value of a check box will immediately be send to the cell (OnValueChange) or when the current cell is changed or the grid is being validated (OnCellChangeOrValidating)

Declaration

cs-api-definition
public EditMode EditMode { get; set; }

Property Value

EditMode

EnableHeaderCheckBox

Gets or sets a value indicating whether to show embedded CheckBox in header cell.

Declaration

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

Property Value

bool

HeaderCheckBoxAlignment

Gets or sets a value indicating the alignment of the check box.

Declaration

cs-api-definition
public ContentAlignment HeaderCheckBoxAlignment { get; set; }

Property Value

ContentAlignment

HeaderCheckBoxPosition

Gets or sets a value indicating the position of the CheckBoxElement along with the text.

Declaration

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

Property Value

HorizontalAlignment

ThreeState

Gets or sets a value indicating whether to use a three state checkbox.

Declaration

cs-api-definition
[Browsable(true)]
public bool ThreeState { 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)

GetDefaultEditor()

Declaration

cs-api-definition
public override IInputEditor GetDefaultEditor()

Returns

IInputEditor

Overrides GridViewColumn.GetDefaultEditor()

GetDefaultEditorType()

Declaration

cs-api-definition
public override Type GetDefaultEditorType()

Returns

Type

Overrides GridViewColumn.GetDefaultEditorType()

GetDefaultMinWidth()

Gets the default MinWidth of GridViewCheckBoxColumn (defaults to 20)

Declaration

cs-api-definition
protected override int GetDefaultMinWidth()

Returns

int

Overrides GridViewColumn.GetDefaultMinWidth()

InitializeEditor(IInputEditor)

Declaration

cs-api-definition
public override void InitializeEditor(IInputEditor editor)

Parameters

editor

IInputEditor

Overrides GridViewColumn.InitializeEditor(IInputEditor)

In this article
DefinitionConstructorsGridViewCheckBoxColumn()GridViewCheckBoxColumn(string)GridViewCheckBoxColumn(string, string)FieldsCheckedPropertyEnableHeaderCheckBoxPropertyHeaderCheckBoxAlignmentPropertyHeaderCheckBoxPositionPropertyShouldCheckDataRowsPropertyThreeStatePropertyPropertiesCheckFilteredRowsCheckedDataTypeEditModeEnableHeaderCheckBoxHeaderCheckBoxAlignmentHeaderCheckBoxPositionThreeStateMethodsGetCellType(GridViewRowInfo)GetDefaultEditor()GetDefaultEditorType()GetDefaultMinWidth()InitializeEditor(IInputEditor)
Not finding the help you need?
Contact Support