Class GridViewDataColumn

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

Inheritance
System.Object
DisposableObject
RadObject
GridViewColumn
GridViewDataColumn
GridViewBrowseColumn
GridViewCalculatorColumn
GridViewCheckBoxColumn
GridViewColorColumn
GridViewComboBoxColumn
GridViewCommandColumn
GridViewDateTimeColumn
GridViewDecimalColumn
GridViewHyperlinkColumn
GridViewImageColumn
GridViewMaskBoxColumn
GridViewRatingColumn
GridViewSparklineColumn
GridViewTextBoxColumn
GridViewTimeSpanColumn
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

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

Constructors

GridViewDataColumn()

Initializes a new instance of the GridViewDataColumn.

Declaration
public GridViewDataColumn()

GridViewDataColumn(String)

Initializes a new instance of the GridViewDataColumn.

Declaration
public GridViewDataColumn(string fieldName)
Parameters
System.String fieldName

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

GridViewDataColumn(String, String)

Initializes a new instance of the GridViewDataColumn.

Declaration
public GridViewDataColumn(string uniqueName, string fieldName)
Parameters
System.String uniqueName

A string value referring to the unique name of the column.
System.String fieldName

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

Fields

AllowCellMergingProperty

Declaration
public static RadProperty AllowCellMergingProperty
Field Value
RadProperty

AllowFilteringProperty

Declaration
public static RadProperty AllowFilteringProperty
Field Value
RadProperty

AllowNaturalSortProperty

Declaration
public static RadProperty AllowNaturalSortProperty
Field Value
RadProperty

AllowSearchingProperty

Declaration
public static RadProperty AllowSearchingProperty
Field Value
RadProperty

AutoFilterDelayProperty

Declaration
public static RadProperty AutoFilterDelayProperty
Field Value
RadProperty

DataEditFormatStringProperty

Declaration
public static RadProperty DataEditFormatStringProperty
Field Value
RadProperty

DataSourceNullValueProperty

Declaration
public static RadProperty DataSourceNullValueProperty
Field Value
RadProperty

DataTypeConverterProperty

Declaration
public static RadProperty DataTypeConverterProperty
Field Value
RadProperty

DataTypeProperty

Declaration
public static RadProperty DataTypeProperty
Field Value
RadProperty

excelFormat

Declaration
protected DisplayFormatType? excelFormat
Field Value
System.Nullable<DisplayFormatType>

FormatInfoProperty

Declaration
public static RadProperty FormatInfoProperty
Field Value
RadProperty

FormatStringProperty

Declaration
public static RadProperty FormatStringProperty
Field Value
RadProperty

NullValueProperty

Declaration
public static RadProperty NullValueProperty
Field Value
RadProperty

UseDataTypeConverterWhenSortingProperty

Declaration
public static RadProperty UseDataTypeConverterWhenSortingProperty
Field Value
RadProperty

Properties

AllowCellMerging

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

Declaration
public virtual bool AllowCellMerging { get; set; }
Property Value
System.Boolean

AllowFiltering

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

Declaration
public virtual bool AllowFiltering { get; set; }
Property Value
System.Boolean

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
public virtual bool AllowNaturalSort { get; set; }
Property Value
System.Boolean

AllowSearching

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

Declaration
public virtual bool AllowSearching { get; set; }
Property Value
System.Boolean

AutoFilterDelay

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

Declaration
public virtual int AutoFilterDelay { get; set; }
Property Value
System.Int32

DataSourceNullValue

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

Declaration
public object DataSourceNullValue { get; set; }
Property Value
System.Object

Implements

DataType

Gets or sets the data type of the column.

Declaration
public virtual Type DataType { get; set; }
Property Value
System.Type

Implements

DataTypeConverter

Gets or sets the data type converter.

Declaration
public TypeConverter DataTypeConverter { get; set; }
Property Value
System.ComponentModel.TypeConverter

The data type converter.
Implements

DesiredEvents

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

Declaration
public GridEventType DesiredEvents { get; }
Property Value
GridEventType

Implements

DesiredProcessMode

Gets the event process mode for this instance.

Declaration
public GridEventProcessMode DesiredProcessMode { get; }
Property Value
GridEventProcessMode

Implements

DistinctValues

Gets the distinct values.

Declaration
public virtual GridViewColumnValuesCollection DistinctValues { get; }
Property Value
GridViewColumnValuesCollection

The distinct values.

DistinctValuesWithFilter

Gets the distinct values with filter.

Declaration
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
public string ExcelExportFormatString { get; set; }
Property Value
System.String

The excel export format string.

ExcelExportType

Gets or sets the type of the excel export.

Declaration
public virtual DisplayFormatType ExcelExportType { get; set; }
Property Value
DisplayFormatType

The type of the excel export.

FilterDescriptor

Gets or sets the filter descriptor.

Declaration
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
[SerializationConverter(typeof(FormatInfoSerializationCoverter))]
public CultureInfo FormatInfo { get; set; }
Property Value
System.Globalization.CultureInfo

Implements

FormatString

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

Declaration
public string FormatString { get; set; }
Property Value
System.String

Implements

NullValue

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

Declaration
public object NullValue { get; set; }
Property Value
System.Object

Implements

Priority

Gets the priority of the current instance.

Declaration
public EventListenerPriority Priority { get; }
Property Value
EventListenerPriority

Implements

UseDataTypeConverterWhenSorting

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

Declaration
public bool UseDataTypeConverterWhenSorting { get; set; }
Property Value
System.Boolean

Methods

AnalyzeQueue(List<GridViewEvent>)

Declaration
public bool AnalyzeQueue(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

Returns
System.Boolean

Implements

CreateSnapshot()

Creates the snapshot.

Declaration
public void CreateSnapshot()

GetCellType(GridViewRowInfo)

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

Declaration
public override Type GetCellType(GridViewRowInfo row)
Parameters
GridViewRowInfo row

The specified row.
Returns
System.Type

The type of the cell to be created.
Overrides

GetDefaultDataTypeConverter(Type)

Gets the default data type converter.

Declaration
protected virtual TypeConverter GetDefaultDataTypeConverter(Type type)
Parameters
System.Type type

The type.
Returns
System.ComponentModel.TypeConverter

GetDistinctValues()

Gets the distinct values.

Declaration
protected virtual GridViewColumnValuesCollection GetDistinctValues()
Returns
GridViewColumnValuesCollection

GetDistinctValuesWithFilter()

Gets the distinct values with filter.

Declaration
protected virtual GridViewColumnValuesCollection GetDistinctValuesWithFilter()
Returns
GridViewColumnValuesCollection

GetEventInfo(RadProperty, out GridEventDispatchMode)

Gets the event info.

Declaration
protected override GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)
Parameters
RadProperty property

The property.
GridEventDispatchMode dispatchMode

The dispatch mode.
Returns
GridEventType

Overrides

Initialize()

Initializes the column.

Declaration
protected override void Initialize()
Overrides
Remarks

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

OnNotifyPropertyChanging(PropertyChangingEventArgsEx)

Declaration
protected override void OnNotifyPropertyChanging(PropertyChangingEventArgsEx e)
Parameters
PropertyChangingEventArgsEx e

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

PostProcessEvent(GridViewEvent)

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

Declaration
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

PreProcessEvent(GridViewEvent)

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

Declaration
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

ProcessEvent(GridViewEvent)

Core entry point for receiving and processing an event.

Declaration
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

ToString()

Returns a string representation of the column.

Declaration
public override string ToString()
Returns
System.String

The string representation for the column.
Overrides

UpdateDistinctValues()

Updates the distinct values.

Declaration
protected virtual void UpdateDistinctValues()

UpdateDistinctValuesOnAdd(Object)

Updates the distinct values on add.

Declaration
protected virtual void UpdateDistinctValuesOnAdd(object value)
Parameters
System.Object value

The value.

UpdateDistinctValuesOnAddWithFilter(Object)

Updates the distinct values on add with filter.

Declaration
protected virtual void UpdateDistinctValuesOnAddWithFilter(object value)
Parameters
System.Object value

The value.

UpdateDistinctValuesWithFilter()

Updates the distinct values with filter.

Declaration
protected virtual void UpdateDistinctValuesWithFilter()

Explicit Interface Implementations

IServiceProvider.GetService(Type)

Declaration
object IServiceProvider.GetService(Type serviceType)
Parameters
System.Type serviceType

Returns
System.Object

Implements
System.IServiceProvider.GetService(System.Type)

Extension Methods