New to Telerik UI for WinFormsStart a free 30-day trial

GridViewDataColumn inherits GridViewColumn and is base for all data-bound columns.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

C#
public abstract class GridViewDataColumn : GridViewColumn, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IEditorProvider, INotifyPropertyChangingEx, IContextMenuProvider, IDataConversionInfoProvider, IGridViewEventListener, ITypeDescriptorContext, IServiceProvider

Inheritance: objectDisposableObjectRadObjectGridViewColumnGridViewDataColumn

Derived Classes: GridViewBrowseColumnGridViewCalculatorColumnGridViewCheckBoxColumnGridViewColorColumnGridViewComboBoxColumnGridViewCommandColumnGridViewDateTimeColumnGridViewDecimalColumnGridViewHyperlinkColumnGridViewImageColumnGridViewMaskBoxColumnGridViewRatingColumnGridViewSparklineColumnGridViewTextBoxColumnGridViewTimeSpanColumn...

Implements: IContextMenuProviderICustomTypeDescriptorIDataConversionInfoProviderIDisposableIEditorProviderIGridViewEventListenerINotifyPropertyChangedINotifyPropertyChangingExIServiceProviderITypeDescriptorContext...

Inherited Members GridViewColumn.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.GetDefaultMinWidth()GridViewColumn.IsPropertyCancelable(RadPropertyMetadata)GridViewColumn.ShowContextMenu()GridViewColumn.GetDefaultEditor()GridViewColumn.GetDefaultEditorType()GridViewColumn.InitializeEditor(IInputEditor)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

Initializes a new instance of the GridViewDataColumn.

C#
public GridViewDataColumn()

Initializes a new instance of the GridViewDataColumn.

C#
public GridViewDataColumn(string uniqueName, string fieldName)
Parameters:uniqueNamestring

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

fieldNamestring

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

Initializes a new instance of the GridViewDataColumn.

C#
public GridViewDataColumn(string fieldName)
Parameters:fieldNamestring

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

Fields

C#
public static RadProperty AllowCellMergingProperty
C#
public static RadProperty AllowFilteringProperty
C#
public static RadProperty AllowNaturalSortProperty
C#
public static RadProperty AllowSearchingProperty
C#
public static RadProperty AutoFilterDelayProperty
C#
public static RadProperty DataEditFormatStringProperty
C#
public static RadProperty DataSourceNullValueProperty
C#
public static RadProperty DataTypeConverterProperty
C#
public static RadProperty DataTypeProperty
C#
protected DisplayFormatType? excelFormat
C#
public static RadProperty FormatInfoProperty
C#
public static RadProperty FormatStringProperty
C#
public static RadProperty NullValueProperty
C#
public static RadProperty UseDataTypeConverterWhenSortingProperty

Properties

Gets or sets value indicating whether cells in the column can be merged.

C#
[Browsable(true)]
public virtual bool AllowCellMerging { get; set; }

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

C#
[Browsable(true)]
public virtual bool AllowFiltering { get; set; }

Gets or sets a value indicating whether clicking on the header cell of this column would allow the user to set natural (no) sort.

C#
[Browsable(true)]
public virtual bool AllowNaturalSort { get; set; }

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

C#
[Browsable(true)]
public virtual bool AllowSearching { get; set; }

Gets or set the value in Milliseconds indicating delay between last key press and filtering operation."

C#
[Browsable(true)]
public virtual int AutoFilterDelay { get; set; }

Gets or sets a value to the data source when the user enters a null value into a cell

C#
[Browsable(true)]
public object DataSourceNullValue { get; set; }

Implements: IDataConversionInfoProvider.DataSourceNullValue

Gets or sets the data type of the column.

C#
[Browsable(true)]
[TypeConverter(typeof(DataTypeConverter))]
public virtual Type DataType { get; set; }

Implements: IDataConversionInfoProvider.DataType

Gets or sets the data type converter.

C#
[Browsable(false)]
public TypeConverter DataTypeConverter { get; set; }
Property Value:

The data type converter.

Implements: IDataConversionInfoProvider.DataTypeConverter

Gets the event type(s) this listener needs to process.

C#
public GridEventType DesiredEvents { get; }

Implements: IGridViewEventListener.DesiredEvents

Gets the event process mode for this instance.

C#
public GridEventProcessMode DesiredProcessMode { get; }

Implements: IGridViewEventListener.DesiredProcessMode

Gets the distinct values.

C#
public virtual GridViewColumnValuesCollection DistinctValues { get; }
Property Value:

The distinct values.

Gets the distinct values with filter.

C#
public virtual GridViewColumnValuesCollection DistinctValuesWithFilter { get; }
Property Value:

The distinct values with filter.

Gets or sets the excel export format string. Note that this format is considered only if ExcelExportType property is set to Custom.

C#
[Browsable(true)]
public string ExcelExportFormatString { get; set; }
Property Value:

The excel export format string.

Gets or sets the type of the excel export.

C#
public virtual DisplayFormatType ExcelExportType { get; set; }
Property Value:

The type of the excel export.

Gets or sets the filter descriptor.

C#
[Browsable(true)]
public virtual FilterDescriptor FilterDescriptor { get; set; }
Property Value:

The filter descriptor.

Gets or sets the culture info used when formatting cell values.

C#
[Browsable(true)]
[SerializationConverter(typeof(FormatInfoSerializationCoverter))]
public CultureInfo FormatInfo { get; set; }

Implements: IDataConversionInfoProvider.FormatInfo

Gets or sets the format string applied to the textual content of each cell in the column.

C#
[Browsable(true)]
public string FormatString { get; set; }

Implements: IDataConversionInfoProvider.FormatString

Gets or sets the cell display value corresponding to a cell value of System.DBNull or null

C#
[Browsable(true)]
public object NullValue { get; set; }

Implements: IDataConversionInfoProvider.NullValue

Gets the priority of the current instance.

C#
public EventListenerPriority Priority { get; }

Implements: IGridViewEventListener.Priority

Gets or sets a value indicating whether the data type converter of this column should be used when sorting.

C#
[Browsable(true)]
public bool UseDataTypeConverterWhenSorting { get; set; }

Methods

Allows a listener to examine events queue and optionally to remove/add events.

C#
public bool AnalyzeQueue(List<GridViewEvent> events)
Parameters:eventsList<GridViewEvent>Returns:

bool

True if the listener has actually modified the queue, false otherwise.

Implements: IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

Creates the snapshot.

C#
public void CreateSnapshot()

Returns the type of cell element to be created for the specified row.

C#
public override Type GetCellType(GridViewRowInfo row)
Parameters:rowGridViewRowInfo

The specified row.

Returns:

Type

The type of the cell to be created.

Overrides: GridViewColumn.GetCellType(GridViewRowInfo)

Gets the default data type converter.

C#
protected virtual TypeConverter GetDefaultDataTypeConverter(Type type)
Parameters:typeType

The type.

Returns:

TypeConverter

Gets the distinct values.

C#
protected virtual GridViewColumnValuesCollection GetDistinctValues()
Returns:

GridViewColumnValuesCollection

Gets the distinct values with filter.

C#
protected virtual GridViewColumnValuesCollection GetDistinctValuesWithFilter()
Returns:

GridViewColumnValuesCollection

Gets the event info.

C#
protected override GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)
Parameters:propertyRadProperty

The property.

dispatchModeGridEventDispatchMode

The dispatch mode.

Returns:

GridEventType

Overrides: GridViewColumn.GetEventInfo(RadProperty, out GridEventDispatchMode)

Initializes the column.

C#
protected override void Initialize()

Overrides: GridViewColumn.Initialize()

Remarks:

This method is called when the column is associated with GridViewTemplate.

C#
protected override void OnNotifyPropertyChanging(PropertyChangingEventArgsEx e)
Parameters:ePropertyChangingEventArgsEx

Overrides: GridViewColumn.OnNotifyPropertyChanging(PropertyChangingEventArgsEx)

Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.

C#
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters:eRadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides: GridViewColumn.OnPropertyChanged(RadPropertyChangedEventArgs)

Allows additional processing of an event that has been just dispatched.

C#
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Parameters:eventDataGridViewEventReturns:

GridViewEventResult

Implements: IGridViewEventListener.PostProcessEvent(GridViewEvent)

Allows previewing of an event that is about to be dispatched.

C#
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Parameters:eventDataGridViewEventReturns:

GridViewEventResult

Implements: IGridViewEventListener.PreProcessEvent(GridViewEvent)

Core entry point for receiving and processing an event.

C#
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Parameters:eventDataGridViewEventReturns:

GridViewEventResult

Implements: IGridViewEventListener.ProcessEvent(GridViewEvent)

Returns a string representation of the column.

C#
public override string ToString()
Returns:

string

The string representation for the column.

Overrides: GridViewColumn.ToString()

Updates the distinct values.

C#
protected virtual void UpdateDistinctValues()

Updates the distinct values on add.

C#
protected virtual void UpdateDistinctValuesOnAdd(object value)
Parameters:valueobject

The value.

Updates the distinct values on add with filter.

C#
protected virtual void UpdateDistinctValuesOnAddWithFilter(object value)
Parameters:valueobject

The value.

Updates the distinct values with filter.

C#
protected virtual void UpdateDistinctValuesWithFilter()