ClassGridViewDataColumn
GridViewDataColumn inherits GridViewColumn and is base for all data-bound columns.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public abstract class GridViewDataColumn : GridViewColumn, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IEditorProvider, INotifyPropertyChangingEx, IContextMenuProvider, IDataConversionInfoProvider, IGridViewEventListener, ITypeDescriptorContext, IServiceProvider
Inheritance: objectDisposableObjectRadObjectGridViewColumnGridViewDataColumn
Derived Classes:
Implements:
Inherited Members
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
fieldName
A string value referring to the unique name of the column.
GridViewDataColumn(string, string)
Initializes a new instance of the GridViewDataColumn.
Fields
AllowCellMergingProperty
Declaration
public static RadProperty AllowCellMergingProperty
Field Value
AllowFilteringProperty
Declaration
public static RadProperty AllowFilteringProperty
Field Value
AllowNaturalSortProperty
Declaration
public static RadProperty AllowNaturalSortProperty
Field Value
AllowSearchingProperty
Declaration
public static RadProperty AllowSearchingProperty
Field Value
AutoFilterDelayProperty
Declaration
public static RadProperty AutoFilterDelayProperty
Field Value
DataEditFormatStringProperty
Declaration
public static RadProperty DataEditFormatStringProperty
Field Value
DataSourceNullValueProperty
Declaration
public static RadProperty DataSourceNullValueProperty
Field Value
DataTypeConverterProperty
Declaration
public static RadProperty DataTypeConverterProperty
Field Value
FormatStringProperty
Declaration
public static RadProperty FormatStringProperty
Field Value
UseDataTypeConverterWhenSortingProperty
Declaration
public static RadProperty UseDataTypeConverterWhenSortingProperty
Field Value
excelFormat
Declaration
protected DisplayFormatType? excelFormat
Field Value
Properties
AllowCellMerging
Gets or sets value indicating whether cells in the column can be merged.
Declaration
[Browsable(true)]
public virtual bool AllowCellMerging { get; set; }
Property Value
AllowFiltering
Gets or sets a value indicating whether the user can filter by this column.
Declaration
[Browsable(true)]
public virtual bool AllowFiltering { get; set; }
Property Value
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
[Browsable(true)]
public virtual bool AllowNaturalSort { get; set; }
Property Value
AllowSearching
Gets or sets a value indicating whether the user can search by this column.
Declaration
[Browsable(true)]
public virtual bool AllowSearching { get; set; }
Property Value
AutoFilterDelay
Gets or set the value in Milliseconds indicating delay between last key press and filtering operation."
Declaration
[Browsable(true)]
public virtual int AutoFilterDelay { get; set; }
Property Value
DataSourceNullValue
Gets or sets a value to the data source when the user enters a null value into a cell
Declaration
[Browsable(true)]
public object DataSourceNullValue { get; set; }
Property Value
Implements
DataType
Gets or sets the data type of the column.
Declaration
[Browsable(true)]
[TypeConverter(typeof(DataTypeConverter))]
public virtual Type DataType { get; set; }
Property Value
Implements
DataTypeConverter
Gets or sets the data type converter.
Declaration
[Browsable(false)]
public TypeConverter DataTypeConverter { get; set; }
Property Value
The data type converter.
Implements
DesiredEvents
Gets the event type(s) this listener needs to process.
Declaration
public GridEventType DesiredEvents { get; }
Property Value
Implements
DesiredProcessMode
Gets the event process mode for this instance.
Declaration
public GridEventProcessMode DesiredProcessMode { get; }
Property Value
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
[Browsable(true)]
public string ExcelExportFormatString { get; set; }
Property Value
The excel export format string.
ExcelExportType
Gets or sets the type of the excel export.
Declaration
public virtual DisplayFormatType ExcelExportType { get; set; }
Property Value
The type of the excel export.
FilterDescriptor
Gets or sets the filter descriptor.
Declaration
[Browsable(true)]
public virtual FilterDescriptor FilterDescriptor { get; set; }
Property Value
The filter descriptor.
FormatInfo
Gets or sets the culture info used when formatting cell values.
Declaration
[Browsable(true)]
[SerializationConverter(typeof(FormatInfoSerializationCoverter))]
public CultureInfo FormatInfo { get; set; }
Property Value
Implements
FormatString
Gets or sets the format string applied to the textual content of each cell in the column.
Declaration
[Browsable(true)]
public string FormatString { get; set; }
Property Value
Implements
NullValue
Gets or sets the cell display value corresponding to a cell value of System.DBNull or null
Declaration
[Browsable(true)]
public object NullValue { get; set; }
Property Value
Implements
Priority
Gets the priority of the current instance.
Declaration
public EventListenerPriority Priority { get; }
Property Value
Implements
UseDataTypeConverterWhenSorting
Gets or sets a value indicating whether the data type converter of this column should be used when sorting.
Declaration
[Browsable(true)]
public bool UseDataTypeConverterWhenSorting { get; set; }
Property Value
Methods
AnalyzeQueue(List<GridViewEvent>)
Allows a listener to examine events queue and optionally to remove/add events.
Declaration
public bool AnalyzeQueue(List<GridViewEvent> events)
Parameters
events
List<GridViewEvent>
Returns
True if the listener has actually modified the queue, false otherwise.
Implements
GetCellType(GridViewRowInfo)
Returns the type of cell element to be created for the specified row.
Declaration
public override Type GetCellType(GridViewRowInfo row)
Parameters
row
The specified row.
Returns
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
type
The type.
Returns
GetDistinctValues()
Gets the distinct values.
Declaration
protected virtual GridViewColumnValuesCollection GetDistinctValues()
Returns
GetDistinctValuesWithFilter()
Gets the distinct values with filter.
Declaration
protected virtual GridViewColumnValuesCollection GetDistinctValuesWithFilter()
Returns
GetEventInfo(RadProperty, out GridEventDispatchMode)
Gets the event info.
Declaration
protected override GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)
Parameters
property
The property.
dispatchMode
The dispatch mode.
Returns
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
e
Overrides
OnPropertyChanged(RadPropertyChangedEventArgs)
Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
The RadPropertyChangedEventArgs containing information about the property change.
Overrides
PostProcessEvent(GridViewEvent)
Allows additional processing of an event that has been just dispatched.
Declaration
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
PreProcessEvent(GridViewEvent)
Allows previewing of an event that is about to be dispatched.
Declaration
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
ProcessEvent(GridViewEvent)
Core entry point for receiving and processing an event.
Declaration
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
ToString()
Returns a string representation of the column.
Declaration
public override string ToString()
Returns
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
value
The value.
UpdateDistinctValuesOnAddWithFilter(object)
Updates the distinct values on add with filter.
Declaration
protected virtual void UpdateDistinctValuesOnAddWithFilter(object value)
Parameters
value
The value.
UpdateDistinctValuesWithFilter()
Updates the distinct values with filter.
Declaration
protected virtual void UpdateDistinctValuesWithFilter()