GridViewDataColumn
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
Initializes a new instance of the GridViewDataColumn.
public GridViewDataColumn()
Initializes a new instance of the GridViewDataColumn.
Initializes a new instance of the GridViewDataColumn.
public GridViewDataColumn(string fieldName)
A string value referring to the unique name of the column.
Fields
Identifies whether equal adjacent cell values may be merged in the view.
public static RadProperty AllowCellMergingProperty
Identifies whether users can filter the column.
public static RadProperty AllowFilteringProperty
Identifies whether sorting can be cleared to restore the source's natural order.
public static RadProperty AllowNaturalSortProperty
Identifies whether users can search the column.
public static RadProperty AllowSearchingProperty
Identifies the delay, in milliseconds, between the last keystroke and automatic filtering.
public static RadProperty AutoFilterDelayProperty
Identifies the format string populated from data-annotation display metadata.
public static RadProperty DataEditFormatStringProperty
Identifies the value written to the data source when the user enters a null value.
public static RadProperty DataSourceNullValueProperty
Identifies the converter used between data-source values and grid editors.
public static RadProperty DataTypeConverterProperty
Identifies the data type used to convert and edit the column's cell values.
public static RadProperty DataTypeProperty
Stores the selected Excel export format; a null value represents the default None setting.
protected DisplayFormatType? excelFormat
Identifies the culture used to format cell values.
public static RadProperty FormatInfoProperty
Identifies the format string applied to a cell's displayed text.
public static RadProperty FormatStringProperty
Identifies whether the column's type converter is used when comparing values for sorting.
public static RadProperty UseDataTypeConverterWhenSortingProperty
Properties
Gets or sets value indicating whether cells in the column can be merged.
[Browsable(true)]
public virtual bool AllowCellMerging { get; set; }
Gets or sets a value indicating whether the user can filter by this column.
[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.
[Browsable(true)]
public virtual bool AllowNaturalSort { get; set; }
Gets or sets a value indicating whether the user can search by this column.
[Browsable(true)]
public virtual bool AllowSearching { get; set; }
Gets or set the value in Milliseconds indicating delay between last key press and filtering operation."
[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
[Browsable(true)]
public object DataSourceNullValue { get; set; }
Implements:
Gets or sets the data type of the column.
[Browsable(true)]
[TypeConverter(typeof(DataTypeConverter))]
public virtual Type DataType { get; set; }
Implements:
Gets or sets the data type converter.
[Browsable(false)]
public TypeConverter DataTypeConverter { get; set; }
The data type converter.
Implements:
Gets the event type(s) this listener needs to process.
public GridEventType DesiredEvents { get; }
Implements:
Gets the event process mode for this instance.
public GridEventProcessMode DesiredProcessMode { get; }
Implements:
Gets the distinct values.
public virtual GridViewColumnValuesCollection DistinctValues { get; }
The distinct values.
Gets the distinct values with filter.
public virtual GridViewColumnValuesCollection DistinctValuesWithFilter { get; }
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.
[Browsable(true)]
public string ExcelExportFormatString { get; set; }
The excel export format string.
Gets or sets the type of the excel export.
public virtual DisplayFormatType ExcelExportType { get; set; }
The type of the excel export.
Gets or sets the filter descriptor.
[Browsable(true)]
public virtual FilterDescriptor FilterDescriptor { get; set; }
The filter descriptor.
Gets or sets the culture info used when formatting cell values.
[Browsable(true)]
[SerializationConverter(typeof(FormatInfoSerializationCoverter))]
public CultureInfo FormatInfo { get; set; }
Implements:
Gets or sets the format string applied to the textual content of each cell in the column.
[Browsable(true)]
public string FormatString { get; set; }
Implements:
Gets or sets the cell display value corresponding to a cell value of System.DBNull or null
[Browsable(true)]
public object NullValue { get; set; }
Implements:
Gets the priority of the current instance.
public EventListenerPriority Priority { get; }
Implements:
Gets or sets a value indicating whether the data type converter of this column should be used when sorting.
[Browsable(true)]
public bool UseDataTypeConverterWhenSorting { get; set; }
Methods
Leaves the synchronization service's pending event queue unchanged.
public bool AnalyzeQueue(List<GridViewEvent> events)
The events currently pending in the synchronization queue.
Returns:false because the column does not add or remove queued events.
Implements:
Creates the snapshot.
public void CreateSnapshot()
Returns the type of cell element to be created for the specified row.
public override Type GetCellType(GridViewRowInfo row)
The specified row.
Returns:The type of the cell to be created.
Overrides:
Gets the default data type converter.
protected virtual TypeConverter GetDefaultDataTypeConverter(Type type)
The type.
Returns:Gets the distinct values.
protected virtual GridViewColumnValuesCollection GetDistinctValues()
Gets the distinct values with filter.
protected virtual GridViewColumnValuesCollection GetDistinctValuesWithFilter()
Gets the event info.
protected override GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)
The property.
dispatchModeGridEventDispatchModeThe dispatch mode.
Returns:Overrides:
Initializes the column.
protected override void Initialize()
Overrides:
This method is called when the column is associated with GridViewTemplate.
Unregisters the column from its current synchronization service before its owner template changes.
protected override void OnNotifyPropertyChanging(PropertyChangingEventArgsEx e)
The pending property change; the listener is removed when PropertyName is OwnerTemplate.
Overrides:
Resets the default type converter when the data type changes and restores a retained filter descriptor when filtering is re-enabled.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
The property change details.
Overrides:
Allows additional processing of an event that has been just dispatched.
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Implements:
Allows previewing of an event that is about to be dispatched.
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Implements:
Core entry point for receiving and processing an event.
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Implements:
Returns a string representation of the column.
public override string ToString()
The string representation for the column.
Overrides:
Updates the distinct values.
protected virtual void UpdateDistinctValues()
Updates the distinct values on add.
Updates the distinct values on add with filter.
protected virtual void UpdateDistinctValuesOnAddWithFilter(object value)
The value.
Updates the distinct values with filter.
protected virtual void UpdateDistinctValuesWithFilter()