Class
GridViewDataColumn

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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
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

GridViewDataColumn()

Initializes a new instance of the GridViewDataColumn.

Declaration

cs-api-definition
public GridViewDataColumn()

GridViewDataColumn(string)

Initializes a new instance of the GridViewDataColumn.

Declaration

cs-api-definition
public GridViewDataColumn(string fieldName)

Parameters

fieldName

string

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

GridViewDataColumn(string, string)

Initializes a new instance of the GridViewDataColumn.

Declaration

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

AllowCellMergingProperty

Declaration

cs-api-definition
public static RadProperty AllowCellMergingProperty

Field Value

RadProperty

AllowFilteringProperty

Declaration

cs-api-definition
public static RadProperty AllowFilteringProperty

Field Value

RadProperty

AllowNaturalSortProperty

Declaration

cs-api-definition
public static RadProperty AllowNaturalSortProperty

Field Value

RadProperty

AllowSearchingProperty

Declaration

cs-api-definition
public static RadProperty AllowSearchingProperty

Field Value

RadProperty

AutoFilterDelayProperty

Declaration

cs-api-definition
public static RadProperty AutoFilterDelayProperty

Field Value

RadProperty

DataEditFormatStringProperty

Declaration

cs-api-definition
public static RadProperty DataEditFormatStringProperty

Field Value

RadProperty

DataSourceNullValueProperty

Declaration

cs-api-definition
public static RadProperty DataSourceNullValueProperty

Field Value

RadProperty

DataTypeConverterProperty

Declaration

cs-api-definition
public static RadProperty DataTypeConverterProperty

Field Value

RadProperty

DataTypeProperty

Declaration

cs-api-definition
public static RadProperty DataTypeProperty

Field Value

RadProperty

FormatInfoProperty

Declaration

cs-api-definition
public static RadProperty FormatInfoProperty

Field Value

RadProperty

FormatStringProperty

Declaration

cs-api-definition
public static RadProperty FormatStringProperty

Field Value

RadProperty

NullValueProperty

Declaration

cs-api-definition
public static RadProperty NullValueProperty

Field Value

RadProperty

UseDataTypeConverterWhenSortingProperty

Declaration

cs-api-definition
public static RadProperty UseDataTypeConverterWhenSortingProperty

Field Value

RadProperty

excelFormat

Declaration

cs-api-definition
protected DisplayFormatType? excelFormat

Field Value

DisplayFormatType?

Properties

AllowCellMerging

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

Declaration

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

Property Value

bool

AllowFiltering

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

Declaration

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

Property Value

bool

AllowNaturalSort

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

Declaration

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

Property Value

bool

AllowSearching

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

Declaration

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

Property Value

bool

AutoFilterDelay

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

Declaration

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

Property Value

int

DataSourceNullValue

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

Declaration

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

Property Value

object

Implements IDataConversionInfoProvider.DataSourceNullValue

DataType

Gets or sets the data type of the column.

Declaration

cs-api-definition
[Browsable(true)]
[TypeConverter(typeof(DataTypeConverter))]
public virtual Type DataType { get; set; }

Property Value

Type

Implements IDataConversionInfoProvider.DataType

DataTypeConverter

Gets or sets the data type converter.

Declaration

cs-api-definition
[Browsable(false)]
public TypeConverter DataTypeConverter { get; set; }

Property Value

TypeConverter

The data type converter.

Implements IDataConversionInfoProvider.DataTypeConverter

DesiredEvents

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

Declaration

cs-api-definition
public GridEventType DesiredEvents { get; }

Property Value

GridEventType

Implements IGridViewEventListener.DesiredEvents

DesiredProcessMode

Gets the event process mode for this instance.

Declaration

cs-api-definition
public GridEventProcessMode DesiredProcessMode { get; }

Property Value

GridEventProcessMode

Implements IGridViewEventListener.DesiredProcessMode

DistinctValues

Gets the distinct values.

Declaration

cs-api-definition
public virtual GridViewColumnValuesCollection DistinctValues { get; }

Property Value

GridViewColumnValuesCollection

The distinct values.

DistinctValuesWithFilter

Gets the distinct values with filter.

Declaration

cs-api-definition
public virtual GridViewColumnValuesCollection DistinctValuesWithFilter { get; }

Property Value

GridViewColumnValuesCollection

The distinct values with filter.

ExcelExportFormatString

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

Declaration

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

Property Value

string

The excel export format string.

ExcelExportType

Gets or sets the type of the excel export.

Declaration

cs-api-definition
public virtual DisplayFormatType ExcelExportType { get; set; }

Property Value

DisplayFormatType

The type of the excel export.

FilterDescriptor

Gets or sets the filter descriptor.

Declaration

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

Property Value

FilterDescriptor

The filter descriptor.

FormatInfo

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

Declaration

cs-api-definition
[Browsable(true)]
[SerializationConverter(typeof(FormatInfoSerializationCoverter))]
public CultureInfo FormatInfo { get; set; }

Property Value

CultureInfo

Implements IDataConversionInfoProvider.FormatInfo

FormatString

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

Declaration

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

Property Value

string

Implements IDataConversionInfoProvider.FormatString

NullValue

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

Declaration

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

Property Value

object

Implements IDataConversionInfoProvider.NullValue

Priority

Gets the priority of the current instance.

Declaration

cs-api-definition
public EventListenerPriority Priority { get; }

Property Value

EventListenerPriority

Implements IGridViewEventListener.Priority

UseDataTypeConverterWhenSorting

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

Declaration

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

Property Value

bool

Methods

AnalyzeQueue(List<GridViewEvent>)

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

Declaration

cs-api-definition
public bool AnalyzeQueue(List<GridViewEvent> events)

Parameters

events

List<GridViewEvent>

Returns

bool

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

Implements IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

CreateSnapshot()

Creates the snapshot.

Declaration

cs-api-definition
public void CreateSnapshot()

GetCellType(GridViewRowInfo)

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

Declaration

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

Parameters

row

GridViewRowInfo

The specified row.

Returns

Type

The type of the cell to be created.

Overrides GridViewColumn.GetCellType(GridViewRowInfo)

GetDefaultDataTypeConverter(Type)

Gets the default data type converter.

Declaration

cs-api-definition
protected virtual TypeConverter GetDefaultDataTypeConverter(Type type)

Parameters

type

Type

The type.

Returns

TypeConverter

GetDistinctValues()

Gets the distinct values.

Declaration

cs-api-definition
protected virtual GridViewColumnValuesCollection GetDistinctValues()

Returns

GridViewColumnValuesCollection

GetDistinctValuesWithFilter()

Gets the distinct values with filter.

Declaration

cs-api-definition
protected virtual GridViewColumnValuesCollection GetDistinctValuesWithFilter()

Returns

GridViewColumnValuesCollection

GetEventInfo(RadProperty, out GridEventDispatchMode)

Gets the event info.

Declaration

cs-api-definition
protected override GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)

Parameters

property

RadProperty

The property.

dispatchMode

GridEventDispatchMode

The dispatch mode.

Returns

GridEventType

Overrides GridViewColumn.GetEventInfo(RadProperty, out GridEventDispatchMode)

Initialize()

Initializes the column.

Declaration

cs-api-definition
protected override void Initialize()

Overrides GridViewColumn.Initialize()

Remarks

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

OnNotifyPropertyChanging(PropertyChangingEventArgsEx)

Declaration

cs-api-definition
protected override void OnNotifyPropertyChanging(PropertyChangingEventArgsEx e)

Parameters

e

PropertyChangingEventArgsEx

Overrides GridViewColumn.OnNotifyPropertyChanging(PropertyChangingEventArgsEx)

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Declaration

cs-api-definition
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

e

RadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides GridViewColumn.OnPropertyChanged(RadPropertyChangedEventArgs)

PostProcessEvent(GridViewEvent)

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

Declaration

cs-api-definition
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

Implements IGridViewEventListener.PostProcessEvent(GridViewEvent)

PreProcessEvent(GridViewEvent)

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

Declaration

cs-api-definition
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

Implements IGridViewEventListener.PreProcessEvent(GridViewEvent)

ProcessEvent(GridViewEvent)

Core entry point for receiving and processing an event.

Declaration

cs-api-definition
public GridViewEventResult ProcessEvent(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

Implements IGridViewEventListener.ProcessEvent(GridViewEvent)

ToString()

Returns a string representation of the column.

Declaration

cs-api-definition
public override string ToString()

Returns

string

The string representation for the column.

Overrides GridViewColumn.ToString()

UpdateDistinctValues()

Updates the distinct values.

Declaration

cs-api-definition
protected virtual void UpdateDistinctValues()

UpdateDistinctValuesOnAdd(object)

Updates the distinct values on add.

Declaration

cs-api-definition
protected virtual void UpdateDistinctValuesOnAdd(object value)

Parameters

value

object

The value.

UpdateDistinctValuesOnAddWithFilter(object)

Updates the distinct values on add with filter.

Declaration

cs-api-definition
protected virtual void UpdateDistinctValuesOnAddWithFilter(object value)

Parameters

value

object

The value.

UpdateDistinctValuesWithFilter()

Updates the distinct values with filter.

Declaration

cs-api-definition
protected virtual void UpdateDistinctValuesWithFilter()