Class RadGridView

RadGridView is complex control that allows you to display and edit tabular data from many different kinds of data sources.

Inheritance
System.Object
RadControl
RadGridView
MultiColumnComboGridView
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadGridView : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IPrintable, IFilterable

Constructors

RadGridView()

Initializes a new instance of the RadGridView class.

Declaration
public RadGridView()

Properties

ActiveEditor

Gets the active editor

Declaration
public IInputEditor ActiveEditor { get; }
Property Value
IInputEditor

AddNewRowPosition

Gets or sets a value indicating the location of the new row in the view template.

Declaration
public SystemRowPosition AddNewRowPosition { get; set; }
Property Value
SystemRowPosition

See Also

AllowAddNewRow

Gets or sets a value indicating whether the user can add new rows through the grid.

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

Remarks

When set to true an empty row is added in which the user can enter data for the new record. Set to false to hide the row.
The row position is controlled through AddNewRowPosition

See Also

AllowAutoSizeColumns

Gets or sets a value indicating whether user can automatically resize a column to fit its content by double-clicking the right border of header cell.

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

See Also

AllowCellContextMenu

Gets or sets a value indicating whether context menu is displayed when user right clicks on a data cell.

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

AllowColumnChooser

Gets or sets a value indicating whether GridViewColumnChooser is available to the user for this instance of GridViewTemplate.

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

See Also

AllowColumnHeaderContextMenu

Gets or sets a value indicating whether context menu is displayed when user right clicks on a column header.

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

AllowColumnReorder

Gets or sets a value indicating whether user can reorder Columns.

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

AllowColumnResize

Gets or sets a value indicating whether user can resize columns.

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

Remarks

This property does not prevent developer from setting Width

See Also

AllowDeleteRow

Gets or sets a value indicating whether user can delete rows.

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

See Also

AllowDragToGroup

Gets or sets a value indicating whether user can drag a column header to grouping panel.

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

AllowEditRow

Gets or sets a value indicating whether user can edit rows.

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

See Also

AllowMultiColumnSorting

Gets or sets a value indicating whether the end-user can sort by more than one column.

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

AllowRowHeaderContextMenu

Gets or sets a value indicating whether context menu is displayed when user right clicks on a row header.

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

AllowRowReorder

Gets or sets a value indicating whether the user is able to reorder rows in the grid

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

AllowRowResize

Gets or sets a value indicating whether user can resize a row.

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

Remarks

This property does not prevent developer from setting Height

See Also

AllowSearchRow

Gets or sets a value indicating whether the user can search through the data of the grid.

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

Remarks

When set to true a search row is added in which the user can enter search criteria. Set to false to hide the row.
The row position is controlled through SearchRowPosition

See Also

AutoExpandGroups

Sets or gets a value indicating the initial state of group rows when data is grouped.

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

See Also

AutoGenerateColumns

Gets or sets a value indicating whether columns are created automatically when the Telerik.WinControls.UIViewTemplate.DataSource or Telerik.WinControls.UIViewTemplate.DataMember properties are set.

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

true if the columns should be created automatically; otherwise, false. The default is true.

AutoGenerateHierarchy

Gets or sets a value indicating whether the RadGridView will automatically build hierarchy from DataSource.

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

AutoSize

Gets or sets a value indicating whether the control is automatically resized to display its entire contents.

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

Overrides

AutoSizeColumnsMode

Gets or sets a value indicating how column widths are determined.

Declaration
public GridViewAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }
Property Value
GridViewAutoSizeColumnsMode

See Also

AutoSizeRows

Gets or sets a value indicating whether row height in a RataGridView will expand for multiline cell text

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

BackColor

RadGridView consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

BeginEditMode

Gets or sets value indicating how user begins editing a cell.

Declaration
public RadGridViewBeginEditMode BeginEditMode { get; set; }
Property Value
RadGridViewBeginEditMode

BottomPinnedRowsMode

Gets or sets a value indicating how bottom pinned rows are laid out.

Declaration
public GridViewBottomPinnedRowsMode BottomPinnedRowsMode { get; set; }
Property Value
GridViewBottomPinnedRowsMode

See Also

CaseSensitive

Indicates whether string comparisons of data are case-sensitive.

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

ChildRows

Gets the child rows.

Declaration
public GridViewChildRowCollection ChildRows { get; }
Property Value
GridViewChildRowCollection

The child rows.

ChildViewTabsPosition

Gets or sets the position to place tabs for child views related with this template.

Declaration
public TabPositions ChildViewTabsPosition { get; set; }
Property Value
TabPositions

ClipboardCopyMode

Gets or sets a value that indicates whether users can copy cell text values to the System.Windows.Forms.Clipboard and whether row and column header text is included.

Declaration
public GridViewClipboardCopyMode ClipboardCopyMode { get; set; }
Property Value
GridViewClipboardCopyMode

ClipboardCutMode

Gets or sets a value that indicates whether users can cut cell text values to the System.Windows.Forms.Clipboard and whether row and column header text is included.

Declaration
public GridViewClipboardCutMode ClipboardCutMode { get; set; }
Property Value
GridViewClipboardCutMode

ClipboardPasteMode

Gets or sets a value that indicates whether users can paste Clipboard values to the RadGridView control.

Declaration
public GridViewClipboardPasteMode ClipboardPasteMode { get; set; }
Property Value
GridViewClipboardPasteMode

CloseEditorWhenValidationFails

Gets or sets a value indicating whether the active editor should be closed when validation process fails.

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

ColumnChooser

Gets the current column chooser

Declaration
public GridViewColumnChooser ColumnChooser { get; }
Property Value
GridViewColumnChooser

ColumnChooserSortOrder

Gets or sets the column chooser sort order.

Declaration
public RadSortOrder ColumnChooserSortOrder { get; set; }
Property Value
RadSortOrder

The column chooser sort order.

ColumnCount

Gets or sets the number of columns displayed.

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

Columns

Gets the columns.

Declaration
public GridViewColumnCollection Columns { get; }
Property Value
GridViewColumnCollection

The columns.

ContextMenuManager

Gets an instance of GridViewContextMenuManager or the instance that implements IContextMenuManager interface.

Declaration
public virtual IContextMenuManager ContextMenuManager { get; }
Property Value
IContextMenuManager

CurrentCell

Gets the currently active cell in the grid.

Declaration
public GridDataCellElement CurrentCell { get; }
Property Value
GridDataCellElement

CurrentCellAddress

Gets the row and column indexes of the currently active cell.

Declaration
public Point CurrentCellAddress { get; }
Property Value
System.Drawing.Point

CurrentColumn

Gets or sets the current column of the currently active view containing the current cell.

Declaration
public GridViewColumn CurrentColumn { get; set; }
Property Value
GridViewColumn

CurrentRow

Gets or sets the current row of the currently active view containing the current cell.

Declaration
public GridViewRowInfo CurrentRow { get; set; }
Property Value
GridViewRowInfo

CurrentView

Gets the currently active view in the RadGridView

Declaration
public IRowView CurrentView { get; set; }
Property Value
IRowView

DataMember

Declaration
[RadDefaultValue("DataMember", typeof(GridViewTemplate))]
public string DataMember { get; set; }
Property Value
System.String

DataSource

Declaration
[RadDefaultValue("DataSource", typeof(GridViewTemplate))]
public object DataSource { get; set; }
Property Value
System.Object

Implements

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

The default System.Drawing.Size of the control.

EditorManager

Gets an instance of GridViewEditManager that defines how to initialize and create cells and editors.

Declaration
public GridViewEditManager EditorManager { get; }
Property Value
GridViewEditManager

EnableAlternatingRowColor

Gets or sets a value indicating whether alternating row color is enabled.

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

EnableCustomDrawing

Gets or sets a value specifying if the custom drawing (e.g. CellPaint and RowPaint) is enabled

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

EnableCustomFiltering

Gets or sets a value indicating whether the custom filtering functionality should be enabled. Use the CustomFiltering event to apply the desired filters.

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

EnableCustomGrouping

Gets or sets a value indicating whether the custom grouping functionality should be enabled. Use the CustomGrouping event to group the data.

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

EnableCustomSorting

Gets or sets a value indicating whether the custom sorting functionality should be enabled. Use the CustomSorting event to apply the desired sorting.

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

EnableFastScrolling

Gets or sets value indicating if fast scrolling mode is turned on.

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

EnableFiltering

Gets or sets value indicating whether users can filter data in the master view template.

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

EnableGrouping

Gets or sets value indicating whether users can group data in the master view template.

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

EnableHotTracking

Gets or sets value indicating whether hot tracking is enabled.

Declaration
[RadPropertyDefaultValue("EnableHotTracking", typeof(GridTableElement))]
[RadDescription("EnableHotTracking", typeof(GridTableElement))]
public bool EnableHotTracking { get; set; }
Property Value
System.Boolean

EnableKineticScrolling

Gets or sets a value indicating whether the kinetic scrolling function is enabled.

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

EnablePaging

Gets or sets value indicating whether users can paginate data in the master view template.

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

EnableSorting

Gets or sets value indicating whether users can sort data in master view template.

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

EnterKeyMode

Gets or sets value indicating the behavior when the user presses Enter.

Declaration
public RadGridViewEnterKeyMode EnterKeyMode { get; set; }
Property Value
RadGridViewEnterKeyMode

FilterDescriptors

Gets the filter descriptors of master template.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

The filter descriptors of master template.
Implements

ForeColor

RadGridView consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

GridBehavior

Gets or sets an instance of BaseGridBehavior or the instance that implements IGridBehavior interface.

Declaration
public virtual IGridBehavior GridBehavior { get; set; }
Property Value
IGridBehavior

See Also

GridNavigator

Gets an instance of BaseGridNavigator or the instance that implements IGridNavigator interface.

Declaration
public virtual IGridNavigator GridNavigator { get; }
Property Value
IGridNavigator

See Also

GridViewElement

Gets the instance of GridVisualElement. This instance is wrapped by this control and the main element in the hierarchy tree and encapsulates the actual functionality of RadGridView.

Declaration
public RadGridViewElement GridViewElement { get; }
Property Value
RadGridViewElement

See Also

GroupDescriptors

Gets the group descriptors of master template.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

The group descriptors of master template.

GroupExpandAnimationType

Gets or set a value indicating the animation effect that will be used when expanding/collapsing groups.

Declaration
public GridExpandAnimationType GroupExpandAnimationType { get; set; }
Property Value
GridExpandAnimationType

Groups

Gets a collection that contains the all groups in the MasterTemplate.

Declaration
public DataGroupCollection Groups { get; }
Property Value
DataGroupCollection

HideSelection

Gets or sets a value indicating whether the selected item in the control remains highlighted when the control loses focus.

Returns: true if the selected item does not appear highlighted when the control loses focus; false if the selected item still appears highlighted when the control loses focus. The default is true.

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

HorizontalScrollState

Gets or sets the display state of grid horizontal scrollbars.

Declaration
public ScrollState HorizontalScrollState { get; set; }
Property Value
ScrollState

IsCurrentRowDirty

Gets a value indicating whether the current row has changes that are not committed.

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

true if the current row has changes that are not committed; otherwise, false.

IsDisposing

Gets whether the grid is disposing.

Declaration
protected virtual bool IsDisposing { get; }
Property Value
System.Boolean

The is disposing.

IsInEditMode

Gets a value indicating whether the cell is in edit mode.

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

MasterTemplate

Gets the GridViewTemplate representing the top-most level
of the hierarchical data.

Declaration
public MasterGridViewTemplate MasterTemplate { get; }
Property Value
MasterGridViewTemplate

See Also

MasterView

Gets the top-most GridViewInfo level of the grid.

Declaration
public GridViewInfo MasterView { get; }
Property Value
GridViewInfo

See Also

MergeCellsEditMode

Gets or sets a value indicating how the merged cells will be edited.

Declaration
public MergeCellsEditMode MergeCellsEditMode { get; set; }
Property Value
MergeCellsEditMode

MergeCellsMode

Indicates whether and how the cells will be merged.

Declaration
public MergeCellsMode MergeCellsMode { get; set; }
Property Value
MergeCellsMode

MultiSelect

Gets or sets a value indicating whether the user is allowed to select more than one cell, row, or column of the RadGridView at a time.

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

NewRowEnterKeyMode

Gets or sets value indicating the behavior when the user presses Enter while adding new row.

Declaration
public RadGridViewNewRowEnterKeyMode NewRowEnterKeyMode { get; set; }
Property Value
RadGridViewNewRowEnterKeyMode

PageSize

Gets or sets value indicating the number of rows in the master view template when paging is enabled.

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

PrintSettingsDialogFactory

Gets or sets the print settings dialog factory.

Declaration
public IPrintSettingsDialogFactory PrintSettingsDialogFactory { get; set; }
Property Value
IPrintSettingsDialogFactory

The print settings dialog factory.

PrintStyle

Gets or sets a value indicating how the RadGridView is printed.

Declaration
public GridPrintStyle PrintStyle { get; set; }
Property Value
GridPrintStyle

See Also

ReadOnly

Gets or sets a value indicating whether the user can edit the cells of the RadGridView control.

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

Relations

Gets collection of GridViewRelation instances that represent the hierarchical structure.

Declaration
public GridViewRelationCollection Relations { get; }
Property Value
GridViewRelationCollection

RowCount

Gets or sets the number of rows contained in the current GridViewTemplate.

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

Rows

Gets a collection that contains the all rows in the MasterTemplate.

Declaration
public GridViewRowCollection Rows { get; }
Property Value
GridViewRowCollection

SearchRowPosition

Gets or sets a value indicating the location of the search row.

Declaration
public SystemRowPosition SearchRowPosition { get; set; }
Property Value
SystemRowPosition

See Also

SelectedCells

Gets the collection of cells selected by the user.

Declaration
public GridViewSelectedCellsCollection SelectedCells { get; }
Property Value
GridViewSelectedCellsCollection

SelectedRows

Gets the collection of rows selected by the user.

Declaration
public GridViewSelectedRowsCollection SelectedRows { get; }
Property Value
GridViewSelectedRowsCollection

SelectionMode

Gets or sets a value indicating how the cells of the RadGridView can be selected.

Declaration
public GridViewSelectionMode SelectionMode { get; set; }
Property Value
GridViewSelectionMode

ShowCellErrors

Gets or sets a value indicating whether to show cell errors.

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

ShowChildViewCaptions

Gets or sets a value indicating whether to show child view captions.

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

ShowCollapsedGroupSummaries

Indicates whether summary rows of collapsed groups will be visible. If true the summary rows will not be hidden when the group is collapsed. Note that the GridViewGroupRowInfo has the same property and it has higher priority. If you need different behavior for different groups/group levels, you can use the CreateRowInfo event and set the ShowCollapsedGroupSummaries of each group individually.

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

ShowColumnHeaders

Gets or sets a value indicating whether the column headers are visible.

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

ShowFilteringRow

Gets or sets a value indicating whether the filtering row should be visible.

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

ShowGroupedColumns

Gets or sets a value indicating whether the columns by which the data is grouped are visible.

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

Remarks

Set to false, and each column contained in the GroupDescriptors, will get hidden. Set to true to see all columns. If some column is still not visible, check IsVisible.

See Also

ShowGroupPanel

Gets or sets value indicating whether the GridGroupPanel is visible.

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

ShowGroupPanelScrollbars

Gets or sets a value indicating whether the group panel will show scroll bars or it will expand to show all group headers.

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

ShowHeaderCellButtons

Gets or sets a value indicating whether the header cell buttons are visible.

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

ShowNoDataText

Gets or sets the text to use when there is no data.

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

ShowRowErrors

Gets or sets a value indicating whether to show row errors.

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

ShowRowHeaderColumn

Gets or sets a value indicating whether the row header column is visible.

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

ShowSelectColumn

Gets or sets a value indicating whether the select column is visible. The select column in only supported for the GridViewSelectionMode.FullRowSelect.

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

SortDescriptors

Gets the sort descriptors of master template.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

The sort descriptors.

SplitMode

Gets or sets a value indicating how to split RadGridView.

Declaration
public RadGridViewSplitMode SplitMode { get; set; }
Property Value
RadGridViewSplitMode

StandardTab

Gets or sets a value indicating whether the TAB key moves the focus to the next control in the tab order rather than moving focus to the next cell in the control.

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

SummaryRowsBottom

Gets the collection containing summary rows placed at the bottom of each DataGroup.

Declaration
public GridViewSummaryRowItemCollection SummaryRowsBottom { get; }
Property Value
GridViewSummaryRowItemCollection

SummaryRowsTop

Gets the collection containing summary rows placed on top of each DataGroup.

Declaration
public GridViewSummaryRowItemCollection SummaryRowsTop { get; }
Property Value
GridViewSummaryRowItemCollection

SynchronizeCurrentRowInSplitMode

Gets or sets whether when changing the current row in one split view the same row in the other split view will be brought into view.

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

TableElement

Gets the instance of GridTableElement

Declaration
public GridTableElement TableElement { get; }
Property Value
GridTableElement

See Also

Templates

Gets the child templates of master template.

Declaration
public GridViewTemplateCollection Templates { get; }
Property Value
GridViewTemplateCollection

The child templates of master template.

Text

This property is not relevant for this class.

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

Overrides

TitlePosition

Gets or sets a value indicating the position of the title.

Declaration
public Dock TitlePosition { get; set; }
Property Value
Dock

TitleText

Gets or set the text of the grid title.

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

UseScrollbarsInHierarchy

Gets or sets a value indicating whether to use dedicated vertical scrollbars in hierarchy.

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

VerticalScrollState

Gets or sets the display state of grid vertical scrollbars.

Declaration
public ScrollState VerticalScrollState { get; set; }
Property Value
ScrollState

ViewDefinition

Gets or sets the IGridViewDefinition associated with the MasterTemplate.

Declaration
public IGridViewDefinition ViewDefinition { get; set; }
Property Value
IGridViewDefinition

VirtualMode

Gets or sets a value indicating whether you have provided your own data-management operations for the RadGridView control.

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

The virtual mode.

XmlSerializationInfo

Gets the serialization info for RadGridView used by Save/Load layout methods to persist grid settings to/from XML. By default, or when set to null the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

Declaration
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

BeginEdit()

Puts the current cell in edit mode.

Declaration
public virtual bool BeginEdit()
Returns
System.Boolean

Returns true if the process is successful.

BeginInit()

Suspends layout during initialization.

Declaration
public override void BeginInit()
Overrides

BeginUpdate()

Begins the update.

Declaration
public void BeginUpdate()

BestFitColumns()

Widens / shrinks all columns based on the space required by the text in the columns.

Declaration
public void BestFitColumns()

BestFitColumns(BestFitColumnMode)

Widens / shrinks all columns based on the space required by the text in the columns.

Declaration
public void BestFitColumns(BestFitColumnMode mode)
Parameters
BestFitColumnMode mode

The mode.

CancelEdit()

Close the currently active editor and discard changes.

Declaration
public virtual bool CancelEdit()
Returns
System.Boolean

true on successful cancellation.

CanEditElementAtDesignTime(RadElement)

Determines whether an element may be edited via the EditUIElements dialog at design-time.

Declaration
protected override bool CanEditElementAtDesignTime(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

ClearSelection()

Clears the current selection by deselecting all selected cells (rows).

Declaration
public void ClearSelection()

CloseEditor()

Ends the edit operation without committing the changes

Declaration
public virtual bool CloseEditor()
Returns
System.Boolean

true on success.

ControlDefinesThemeForElement(RadElement)

Gets whether the control defines the theme for the specific element.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element.
Returns
System.Boolean

Overrides

Copy()

Copy the formatted values that represent the contents of the selected cells to the System.Windows.Forms.Clipboard.

Declaration
public virtual void Copy()

CreateAccessibilityInstance()

Creates a new accessibility object for the control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

A new System.Windows.Forms.AccessibleObject for the control.

CreateChildItems(RadElement)

Creates the child items.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent.
Overrides

CreateGridViewElement()

Creates the grid view element.

Declaration
protected virtual RadGridViewElement CreateGridViewElement()
Returns
RadGridViewElement

CreateGridViewLayoutSerializer(ComponentXmlSerializationInfo)

Creates the grid view layout serializer.

Declaration
protected virtual GridViewLayoutSerializer CreateGridViewLayoutSerializer(ComponentXmlSerializationInfo info)
Parameters
ComponentXmlSerializationInfo info

The info.
Returns
GridViewLayoutSerializer

Cut()

Moves the current selection in the to the Clipboard.

Declaration
public virtual void Cut()

DeferRefresh()

Calls internally BeginUpdate.

Declaration
public IDisposable DeferRefresh()
Returns
System.IDisposable

DisplayedColumnCount(Boolean)

Gets the displayed column count.

Declaration
public int DisplayedColumnCount(bool includePartialColumn)
Parameters
System.Boolean includePartialColumn

The include partial column.
Returns
System.Int32

DisplayedRowCount(Boolean)

Gets the displayed row count.

Declaration
public int DisplayedRowCount(bool includePartialRow)
Parameters
System.Boolean includePartialRow

The include partial row.
Returns
System.Int32

Dispose(Boolean)

Disposes the grid.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

The disposing.
Overrides

EndEdit()

Commits any changes and ends the edit operation on the current cell.

Declaration
public virtual bool EndEdit()
Returns
System.Boolean

true on success.

EndInit()

Resumes layout.

Declaration
public override void EndInit()
Overrides

EndUpdate()

Ends the update.

Declaration
public void EndUpdate()

EndUpdate(Boolean)

Ends the update.

Declaration
public void EndUpdate(bool notify)
Parameters
System.Boolean notify

Evaluate(String, IEnumerable<GridViewRowInfo>)

Evaluates the specified expression.

Declaration
public object Evaluate(string expression, IEnumerable<GridViewRowInfo> rows)
Parameters
System.String expression

The expression.
System.Collections.Generic.IEnumerable<GridViewRowInfo> rows

The rows.
Returns
System.Object

GetClipboardContent()

Retrieves the formatted values that represent the contents of the selected cells for copying to the System.Windows.Forms.Clipboard.

Declaration
public virtual DataObject GetClipboardContent()
Returns
System.Windows.Forms.DataObject

GetDefaultXmlSerializationInfo()

Gets the default serialization info for RadGridView used by Save/Load layout methods to persist grid settings to/from XML.

Declaration
public virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

Remarks

You can use the serialization info to include/exclude properties of RadGridView and related objects from XML serialization. Example:
ComponentXmlSerializationInfo serializationInfo = radGridView1. info.SerializationMetadata.Add();

HideColumnChooser()

Hides the GridViewColumnChooser

Declaration
public void HideColumnChooser()
See Also

InvalidateMultiSelection()

Invalidates the multi selection.

Declaration
protected virtual void InvalidateMultiSelection()

IsInputKey(Keys)

Determines whether the specified key data is input key.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

The key data.
Returns
System.Boolean

Overrides

LoadFrom(IDataReader)

Unbound load the IDatareader data and reset current DataSource for MasterTemplate

Declaration
public void LoadFrom(IDataReader dataReader)
Parameters
System.Data.IDataReader dataReader

LoadLayout(Stream)

Loads RadGridView properties, sub-objects and their properties from XML stream, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void LoadLayout(Stream stream)
Parameters
System.IO.Stream stream

LoadLayout(String)

Loads RadGridView properties, sub-objects and their properties from XML file, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void LoadLayout(string fileName)
Parameters
System.String fileName

LoadLayout(XmlReader)

Loads RadGridView properties, sub-objects and their properties from XML reader, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

OnAutoGeneratingColumn(Object, GridViewAutoGeneratingColumnEventArgs)

Called when a new column is automatically generated.

Declaration
protected virtual void OnAutoGeneratingColumn(object sender, GridViewAutoGeneratingColumnEventArgs e)
Parameters
System.Object sender

The sender.
GridViewAutoGeneratingColumnEventArgs e

The GridViewAutoGeneratingColumnEventArgs instance containing the event data.

OnBindingContextChanged(EventArgs)

Raises the System.Windows.Forms.Control.BindingContextChanged event.

Declaration
protected override void OnBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnCancelRowEdit(Object, QuestionEventArgs)

Called when the row editing is canceled.

Declaration
protected virtual void OnCancelRowEdit(object sender, QuestionEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.QuestionEventArgs e

The System.Windows.Forms.QuestionEventArgs instance containing the event data.

OnCellBeginEdit(Object, GridViewCellCancelEventArgs)

Called when the cell begins editing.

Declaration
protected virtual void OnCellBeginEdit(object sender, GridViewCellCancelEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellCancelEventArgs e

The GridViewCellCancelEventArgs instance containing the event data.

OnCellClick(Object, GridViewCellEventArgs)

Called when [cell click].

Declaration
protected virtual void OnCellClick(object sender, GridViewCellEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellEventArgs e

The GridViewCellEventArgs instance containing the event data.

OnCellDoubleClick(Object, GridViewCellEventArgs)

Called when the cell is double clicked.

Declaration
protected void OnCellDoubleClick(object sender, GridViewCellEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellEventArgs e

The GridViewCellEventArgs instance containing the event data.

OnCellEditorInitialized(Object, GridViewCellEventArgs)

Raises the CellEditorInitialized event.

Declaration
protected virtual void OnCellEditorInitialized(object sender, GridViewCellEventArgs e)
Parameters
System.Object sender

The cell that is to be edited.
GridViewCellEventArgs e

A GridViewCellEventArgs instance containing event data.
See Also

OnCellEndEdit(Object, GridViewCellEventArgs)

Called when the cell ends editing.

Declaration
protected virtual void OnCellEndEdit(object sender, GridViewCellEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellEventArgs e

The GridViewCellEventArgs instance containing the event data.

OnCellFormatting(Object, CellFormattingEventArgs)

Raises the CellFormatting event

Declaration
protected void OnCellFormatting(object sender, CellFormattingEventArgs e)
Parameters
System.Object sender

The cell that needs formatting.
CellFormattingEventArgs e

A CellFormattingEventArgs instance containing event data.
See Also

OnCellMerging(GridViewCellMergingEventArgs)

Raises the CellMerging event

Declaration
protected void OnCellMerging(GridViewCellMergingEventArgs e)
Parameters
GridViewCellMergingEventArgs e

A GridViewCellMergingEventArgsinstance containing event data.
See Also

OnCellMouseMove(Object, MouseEventArgs)

Raises the CellMouseMove event

Declaration
protected void OnCellMouseMove(object sender, MouseEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs e

OnCellPaint(Object, GridViewCellPaintEventArgs)

Raises the CellPaint event.

Declaration
protected virtual void OnCellPaint(object sender, GridViewCellPaintEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCellPaintEventArgs e

An instance of GridViewCellPaintEventArgs containing event data.

OnCellValidated(Object, CellValidatedEventArgs)

Raises the CellValidated event.

Declaration
protected virtual void OnCellValidated(object sender, CellValidatedEventArgs e)
Parameters
System.Object sender

CellValidatedEventArgs e

OnCellValidating(Object, CellValidatingEventArgs)

Raises the CellValidating event.

Declaration
protected virtual void OnCellValidating(object sender, CellValidatingEventArgs e)
Parameters
System.Object sender

CellValidatingEventArgs e

OnCellValueChanged(Object, GridViewCellEventArgs)

Called when the cell value is changed.

Declaration
protected virtual void OnCellValueChanged(object sender, GridViewCellEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellEventArgs e

The GridViewCellEventArgs instance containing the event data.

OnCellValueNeeded(Object, GridViewCellValueEventArgs)

Raises the CellValueNeeded event.

Declaration
protected virtual void OnCellValueNeeded(object sender, GridViewCellValueEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCellValueEventArgs e

An instance of GridViewRowEventArgs containing event data.
See Also

OnCellValuePushed(Object, GridViewCellValueEventArgs)

Raises the CellValuePushed event.

Declaration
protected virtual void OnCellValuePushed(object sender, GridViewCellValueEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCellValueEventArgs e

An instance of GridViewRowEventArgs containing event data.
See Also

OnChildViewExpanded(Object, ChildViewExpandedEventArgs)

Called when the child view is expanded.

Declaration
protected virtual void OnChildViewExpanded(object sender, ChildViewExpandedEventArgs e)
Parameters
System.Object sender

The sender.
ChildViewExpandedEventArgs e

The ChildViewExpandedEventArgs instance containing the event data.

OnChildViewExpanding(Object, ChildViewExpandingEventArgs)

Called when the child view is expanding.

Declaration
protected virtual void OnChildViewExpanding(object sender, ChildViewExpandingEventArgs e)
Parameters
System.Object sender

The sender.
ChildViewExpandingEventArgs e

The ChildViewExpandingEventArgs instance containing the event data.

OnChildViewPrinting(Object, ChildViewPrintingEventArgs)

Occurs for hierarchy rows with more than one child views.

Declaration
protected virtual void OnChildViewPrinting(object sender, ChildViewPrintingEventArgs e)
Parameters
System.Object sender

The print renderer that is currently printing the grid.
ChildViewPrintingEventArgs e

The ChildViewPrintingEventArgs

OnColumnChooserItemElementCreating(Object, ColumnChooserItemElementCreatingEventArgs)

Called when the column chooser item element is creating.

Declaration
protected virtual void OnColumnChooserItemElementCreating(object sender, ColumnChooserItemElementCreatingEventArgs e)
Parameters
System.Object sender

The sender.
ColumnChooserItemElementCreatingEventArgs e

The ColumnChooserItemElementCreatingEventArgs instance containing the event data.

OnColumnWidthChanged(Object, ColumnWidthChangedEventArgs)

Called when the column width is changed.

Declaration
protected virtual void OnColumnWidthChanged(object sender, ColumnWidthChangedEventArgs args)
Parameters
System.Object sender

The sender.
System.Windows.Forms.ColumnWidthChangedEventArgs args

The System.Windows.Forms.ColumnWidthChangedEventArgs instance containing the event data.

OnColumnWidthChanging(Object, ColumnWidthChangingEventArgs)

Called when the column width is changing.

Declaration
protected virtual void OnColumnWidthChanging(object sender, ColumnWidthChangingEventArgs args)
Parameters
System.Object sender

The sender.
System.Windows.Forms.ColumnWidthChangingEventArgs args

The System.Windows.Forms.ColumnWidthChangingEventArgs instance containing the event data.

OnCommandCellClick(Object, GridViewCellEventArgs)

Called when the command cell is clicked.

Declaration
protected virtual void OnCommandCellClick(object sender, GridViewCellEventArgs args)
Parameters
System.Object sender

The sender.
GridViewCellEventArgs args

The GridViewCellEventArgs instance containing the event data.

OnConditionalFormattingFormShown(Object, EventArgs)

Raises the ConditionalFormattingFormShown event.

Declaration
protected virtual void OnConditionalFormattingFormShown(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnContextMenuOpening(Object, ContextMenuOpeningEventArgs)

Called when the context menu is opening.

Declaration
protected virtual void OnContextMenuOpening(object sender, ContextMenuOpeningEventArgs args)
Parameters
System.Object sender

The sender.
ContextMenuOpeningEventArgs args

The ContextMenuOpeningEventArgs instance containing the event data.

OnCopying(Object, GridViewClipboardEventArgs)

Called when RadGridView has prepared appropriate data formats that represent the copy selection, added the copy selection formats to a DataObject, and is ready to either place the DataObject on the Clipboard.

Declaration
protected virtual void OnCopying(object sender, GridViewClipboardEventArgs e)
Parameters
System.Object sender

The sender.
GridViewClipboardEventArgs e

The GridViewClipboardEventArgs instance containing the event data.

OnCopyingCellClipboardContent(Object, GridViewCellValueEventArgs)

Called when the cell clipboard content is being copied.

Declaration
protected virtual void OnCopyingCellClipboardContent(object sender, GridViewCellValueEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellValueEventArgs e

The GridViewCellValueEventArgs instance containing the event data.

OnCreateCell(Object, GridViewCreateCellEventArgs)

Raises the CreateCell event.

Declaration
protected virtual void OnCreateCell(object sender, GridViewCreateCellEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCreateCellEventArgs e

An instance of GridViewCreateCellEventArgs containing event data.

OnCreateCompositeFilterDialog(Object, GridViewCreateCompositeFilterDialogEventArgs)

Raises the CreateCompositeFilterDialog event.

Declaration
protected virtual void OnCreateCompositeFilterDialog(object sender, GridViewCreateCompositeFilterDialogEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCreateCompositeFilterDialogEventArgs e

The GridViewCreateCompositeFilterDialogEventArgs instance containing the event data.

OnCreateRow(Object, GridViewCreateRowEventArgs)

Raises the CreateRow event.

Declaration
protected virtual void OnCreateRow(object sender, GridViewCreateRowEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCreateRowEventArgs e

An instance of GridViewCreateRowEventArgs containing event data.

OnCreateRowInfo(Object, GridViewCreateRowInfoEventArgs)

Called when the row info is created.

Declaration
protected virtual void OnCreateRowInfo(object sender, GridViewCreateRowInfoEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCreateRowInfoEventArgs e

The GridViewCreateRowInfoEventArgs instance containing the event data.

OnCurrentCellChanged(Object, CurrentCellChangedEventArgs)

Called when the current cell is changed.

Declaration
protected virtual void OnCurrentCellChanged(object sender, CurrentCellChangedEventArgs e)
Parameters
System.Object sender

The sender.
CurrentCellChangedEventArgs e

The CurrentCellChangedEventArgs instance containing the event data.

OnCurrentColumnChanged(Object, CurrentColumnChangedEventArgs)

Raises the CurrentColumnChanged event.

Declaration
protected virtual void OnCurrentColumnChanged(object sender, CurrentColumnChangedEventArgs e)
Parameters
System.Object sender

CurrentColumnChangedEventArgs e

A CurrentColumnChangedEventArgs that contains the event data.

OnCurrentRowChanged(Object, CurrentRowChangedEventArgs)

Called when the current row is changed.

Declaration
protected virtual void OnCurrentRowChanged(object sender, CurrentRowChangedEventArgs e)
Parameters
System.Object sender

The sender.
CurrentRowChangedEventArgs e

The CurrentRowChangedEventArgs instance containing the event data.

OnCurrentRowChanging(Object, CurrentRowChangingEventArgs)

Called when the current row is changing.

Declaration
protected virtual void OnCurrentRowChanging(object sender, CurrentRowChangingEventArgs e)
Parameters
System.Object sender

The sender.
CurrentRowChangingEventArgs e

The CurrentRowChangingEventArgs instance containing the event data.

OnCustomFiltering(Object, GridViewCustomFilteringEventArgs)

Raises the CustomFiltering event.

Declaration
protected virtual void OnCustomFiltering(object sender, GridViewCustomFilteringEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCustomFilteringEventArgs e

An instance of GridViewCustomFilteringEventArgs containing event data.

OnCustomGrouping(Object, GridViewCustomGroupingEventArgs)

Raises the CustomGrouping event.

Declaration
protected virtual void OnCustomGrouping(object sender, GridViewCustomGroupingEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCustomGroupingEventArgs e

An instance of GridViewCustomGroupingEventArgs containing event data.

OnCustomSorting(Object, GridViewCustomSortingEventArgs)

Raises the CustomSorting event.

Declaration
protected virtual void OnCustomSorting(object sender, GridViewCustomSortingEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewCustomSortingEventArgs e

An instance of GridViewCustomSortingEventArgs containing event data.

OnDataBindingComplete(Object, GridViewBindingCompleteEventArgs)

Raises the DataBindingComplete event.

Declaration
protected virtual void OnDataBindingComplete(object sender, GridViewBindingCompleteEventArgs e)
Parameters
System.Object sender

GridViewBindingCompleteEventArgs e

An GridViewBindingCompleteEventArgs instance that contains the event data.
See Also

OnDataError(Object, GridViewDataErrorEventArgs)

Called when a data error occurs.

Declaration
protected virtual void OnDataError(object sender, GridViewDataErrorEventArgs e)
Parameters
System.Object sender

The sender.
GridViewDataErrorEventArgs e

The GridViewDataErrorEventArgs instance containing the event data.

OnDataGroupNeeded(Object, GridViewDataGroupEventArgs)

Fires when the data group requires in virtual mode..

Declaration
protected virtual void OnDataGroupNeeded(object sender, GridViewDataGroupEventArgs e)
Parameters
System.Object sender

The sender.
GridViewDataGroupEventArgs e

The GridViewDataGroupEventArgs instance containing the event data.

OnDefaultValuesNeeded(Object, DefaultValuesNeededEventArgs)

Raises the DefaultValuesNeeded event.

Declaration
protected virtual void OnDefaultValuesNeeded(object sender, DefaultValuesNeededEventArgs e)
Parameters
System.Object sender

The owner control.
DefaultValuesNeededEventArgs e

An instance of DefaultValuesNeededEventArgs containing event data.
See Also

OnEditorRequired(Object, EditorRequiredEventArgs)

Fires when an element for editing a cell is showing.

Declaration
protected virtual void OnEditorRequired(object sender, EditorRequiredEventArgs e)
Parameters
System.Object sender

The sender.
EditorRequiredEventArgs e

The EditorRequiredEventArgs instance containing the event data.

OnExpressionEditorFormCreated(Object, ExpressionEditorFormCreatedEventArgs)

Fires when a new expression editor form is created.

Declaration
protected virtual void OnExpressionEditorFormCreated(object sender, ExpressionEditorFormCreatedEventArgs e)
Parameters
System.Object sender

The sender.
ExpressionEditorFormCreatedEventArgs e

The ExpressionEditorFormCreatedEventArgs instance containing the event data.

OnFilterChanged(Object, GridViewCollectionChangedEventArgs)

Fires when the filter is changed.

Declaration
protected void OnFilterChanged(object sender, GridViewCollectionChangedEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangedEventArgs e

The GridViewCollectionChangedEventArgs instance containing the event data.

OnFilterChanging(Object, GridViewCollectionChangingEventArgs)

Called when the filter is changing.

Declaration
protected void OnFilterChanging(object sender, GridViewCollectionChangingEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangingEventArgs e

The GridViewCollectionChangingEventArgs instance containing the event data.

OnFilterExpressionChanged(Object, FilterExpressionChangedEventArgs)

Called when the filter expression is changed.

Declaration
protected void OnFilterExpressionChanged(object sender, FilterExpressionChangedEventArgs args)
Parameters
System.Object sender

The sender.
FilterExpressionChangedEventArgs args

The FilterExpressionChangedEventArgs instance containing the event data.

OnFilterPopupInitialized(Object, FilterPopupInitializedEventArgs)

Raises the FilterPopupInitialized event.

Declaration
protected virtual void OnFilterPopupInitialized(object sender, FilterPopupInitializedEventArgs e)
Parameters
System.Object sender

The sender.
FilterPopupInitializedEventArgs e

The FilterPopupInitializedEventArgs instance containing the event data.

OnFilterPopupRequired(Object, FilterPopupRequiredEventArgs)

Raises the FilterPopupRequired event.

Declaration
protected virtual void OnFilterPopupRequired(object sender, FilterPopupRequiredEventArgs e)
Parameters
System.Object sender

The sender.
FilterPopupRequiredEventArgs e

The FilterPopupRequiredEventArgs instance containing the event data.

OnGotFocus(EventArgs)

Raises the System.Windows.Forms.Control.GotFocus event.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnGroupByChanged(Object, GridViewCollectionChangedEventArgs)

Fires when grouping is changed.

Declaration
protected virtual void OnGroupByChanged(object sender, GridViewCollectionChangedEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangedEventArgs e

The GridViewCollectionChangedEventArgs instance containing the event data.

OnGroupByChanging(Object, GridViewCollectionChangingEventArgs)

Fires when grouping is changing.

Declaration
protected virtual void OnGroupByChanging(object sender, GridViewCollectionChangingEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangingEventArgs e

The GridViewCollectionChangingEventArgs instance containing the event data.

OnGroupExpanded(Object, GroupExpandedEventArgs)

Fires when the DataGroup is expanded or collapsed.

Declaration
protected virtual void OnGroupExpanded(object sender, GroupExpandedEventArgs e)
Parameters
System.Object sender

The sender.
GroupExpandedEventArgs e

The GroupExpandedEventArgs instance containing the event data.

OnGroupExpanding(Object, GroupExpandingEventArgs)

Fires when the DataGroup is expanding or collapsing. This behavior is valid when grouping or hierarchy mode is applied.

Declaration
protected virtual void OnGroupExpanding(object sender, GroupExpandingEventArgs e)
Parameters
System.Object sender

The sender.
GroupExpandingEventArgs e

The GroupExpandingEventArgs instance containing the event data.

OnGroupSortChanged(Object, GridViewGroupSortChangedEventArgs)

Fires after the user has changed the sorting of the group.

Declaration
protected virtual void OnGroupSortChanged(object sender, GridViewGroupSortChangedEventArgs e)
Parameters
System.Object sender

The sender.
GridViewGroupSortChangedEventArgs e

The GridViewGroupSortChangedEventArgs instance containing the event data.

OnGroupSortChanging(Object, GridViewGroupSortChangingEventArgs)

Fires when the user changes the sorting of the group. The action can be canceled.

Declaration
protected virtual void OnGroupSortChanging(object sender, GridViewGroupSortChangingEventArgs e)
Parameters
System.Object sender

The sender.
GridViewGroupSortChangingEventArgs e

The GridViewGroupSortChangingEventArgs instance containing the event data.

OnGroupSummaryEvaluate(Object, GroupSummaryEvaluationEventArgs)

Fires when evaluation of group summary is undergoing.

Declaration
protected virtual void OnGroupSummaryEvaluate(object sender, GroupSummaryEvaluationEventArgs e)
Parameters
System.Object sender

The sender.
GroupSummaryEvaluationEventArgs e

The GroupSummaryEvaluationEventArgs instance containing the event data.

OnHeaderCellToggleStateChanged(Object, GridViewHeaderCellEventArgs)

Fires when a toggle state changed of RadCheckBoxElement in header cell.

Declaration
protected virtual void OnHeaderCellToggleStateChanged(object sender, GridViewHeaderCellEventArgs args)
Parameters
System.Object sender

The sender.
GridViewHeaderCellEventArgs args

The GridViewHeaderCellEventArgs instance containing the event data.

OnHyperlinkOpened(Object, HyperlinkOpenedEventArgs)

Fires when a link from a GridViewHyperlinkColumn is opened.

Declaration
protected void OnHyperlinkOpened(object sender, HyperlinkOpenedEventArgs e)
Parameters
System.Object sender

The sender.
HyperlinkOpenedEventArgs e

The HyperlinkOpenedEventArgs instance containing the event data.

OnHyperlinkOpening(Object, HyperlinkOpeningEventArgs)

Called when the hyperlink is opening.

Declaration
protected void OnHyperlinkOpening(object sender, HyperlinkOpeningEventArgs e)
Parameters
System.Object sender

The sender.
HyperlinkOpeningEventArgs e

The HyperlinkOpeningEventArgs instance containing the event data.

OnKeyDown(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyDown event.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.KeyEventArgs that contains the event data.
Overrides

OnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

The System.Windows.Forms.KeyPressEventArgs instance containing the event data.
Overrides

OnKeyUp(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyUp event.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.KeyEventArgs that contains the event data.
Overrides

OnLayoutLoaded(Object, LayoutLoadedEventArgs)

Fires when the layout is loaded.

Declaration
protected void OnLayoutLoaded(object sender, LayoutLoadedEventArgs e)
Parameters
System.Object sender

The sender.
LayoutLoadedEventArgs e

The LayoutLoadedEventArgs instance containing the event data.

OnLoad(Size)

Notifies that the control is about to be visualized.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnLostFocus(EventArgs)

Raises the LostFocus event.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseClick event.

Declaration
protected override void OnMouseClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseDoubleClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseDoubleClick event.

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

An System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Raises the MouseDown event.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseEnter(EventArgs)

Raises the MouseEnter event.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseLeave(EventArgs)

Raises the MouseLeave event.

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

OnMouseMove(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseMove event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseUp(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseUp event.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseWheel(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseWheel event.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnNewRowNeeded(Object, GridViewRowEventArgs)

Fires when the unbound cell requires a value for a cell in order to format and display the cell.

Declaration
protected virtual void OnNewRowNeeded(object sender, GridViewRowEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowEventArgs e

The GridViewRowEventArgs instance containing the event data.

OnPageChanged(Object, EventArgs)

Fires when the current page is changed.

Declaration
protected virtual void OnPageChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnPageChanging(Object, PageChangingEventArgs)

Fires when the current page is changing.

Declaration
protected virtual void OnPageChanging(object sender, PageChangingEventArgs e)
Parameters
System.Object sender

The sender.
PageChangingEventArgs e

The PageChangingEventArgs instance containing the event data.

OnPasting(Object, GridViewClipboardEventArgs)

Occurs when the RadGridView is ready to paste data.

Declaration
protected virtual void OnPasting(object sender, GridViewClipboardEventArgs e)
Parameters
System.Object sender

The sender.
GridViewClipboardEventArgs e

The GridViewClipboardEventArgs instance containing the event data.

OnPastingCellClipboardContent(Object, GridViewCellValueEventArgs)

Occurs when the RadGridView is ready to paste data to individual cells.

Declaration
protected virtual void OnPastingCellClipboardContent(object sender, GridViewCellValueEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCellValueEventArgs e

The GridViewCellValueEventArgs instance containing the event data.

OnPrintCellFormatting(Object, PrintCellFormattingEventArgs)

Raises the PrintCellFormatting event

Declaration
protected virtual void OnPrintCellFormatting(object sender, PrintCellFormattingEventArgs e)
Parameters
System.Object sender

The grid cell that needs formatting.
PrintCellFormattingEventArgs e

A PrintCellFormattingEventArgsinstance containing event data.
See Also

OnPrintCellPaint(Object, PrintCellPaintEventArgs)

Raises the PrintCellPaint event

Declaration
protected virtual void OnPrintCellPaint(object sender, PrintCellPaintEventArgs e)
Parameters
System.Object sender

The grid cell that is painted.
PrintCellPaintEventArgs e

A PrintCellPaintEventArgsinstance containing event data.
See Also

OnResize(EventArgs)

Raises the System.Windows.Forms.Control.Resize event.

Declaration
protected override void OnResize(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnRowDirtyStateNeeded(Object, QuestionEventArgs)

Fires when an unbound cell requires a value for a cell in order to format and display the cell.

Declaration
protected virtual void OnRowDirtyStateNeeded(object sender, QuestionEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.QuestionEventArgs e

The System.Windows.Forms.QuestionEventArgs instance containing the event data.

OnRowFormatting(Object, RowFormattingEventArgs)

Raises the RowFormatting event.

Declaration
protected void OnRowFormatting(object sender, RowFormattingEventArgs e)
Parameters
System.Object sender

The row that needs formatting.
RowFormattingEventArgs e

A RowFormattingEventArgs instance containing event data.
See Also

OnRowHeightChanged(Object, RowHeightChangedEventArgs)

Fires after the height of a row changes.

Declaration
protected virtual void OnRowHeightChanged(object sender, RowHeightChangedEventArgs args)
Parameters
System.Object sender

The sender.
RowHeightChangedEventArgs args

The RowHeightChangedEventArgs instance containing the event data.

OnRowHeightChanging(Object, RowHeightChangingEventArgs)

Fires before the height of a row changes.

Declaration
protected virtual void OnRowHeightChanging(object sender, RowHeightChangingEventArgs args)
Parameters
System.Object sender

The sender.
RowHeightChangingEventArgs args

The RowHeightChangingEventArgs instance containing the event data.

OnRowIsVisibleChanged(Object, EventArgs)

Fires after the IsVisible property of a row changes.

Declaration
protected virtual void OnRowIsVisibleChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnRowMouseMove(Object, MouseEventArgs)

Raises the RowMouseMove event.

Declaration
protected void OnRowMouseMove(object sender, MouseEventArgs e)
Parameters
System.Object sender

The row under the mouse pointer.
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs instance containing event data.
See Also

OnRowPaint(Object, GridViewRowPaintEventArgs)

Raises the RowPaint event.

Declaration
protected virtual void OnRowPaint(object sender, GridViewRowPaintEventArgs e)
Parameters
System.Object sender

The owner control.
GridViewRowPaintEventArgs e

An instance of GridViewRowPaintEventArgs containing event data.

OnRowsChanged(Object, GridViewCollectionChangedEventArgs)

Fires when the Rows collection of a GridViewTemplate changes.

Declaration
protected virtual void OnRowsChanged(object sender, GridViewCollectionChangedEventArgs args)
Parameters
System.Object sender

The sender.
GridViewCollectionChangedEventArgs args

The GridViewCollectionChangedEventArgs instance containing the event data.

OnRowsChanging(Object, GridViewCollectionChangingEventArgs)

Fires before the Rows collection of a GridViewTemplate changes.

Declaration
protected virtual void OnRowsChanging(object sender, GridViewCollectionChangingEventArgs args)
Parameters
System.Object sender

The sender.
GridViewCollectionChangingEventArgs args

The GridViewCollectionChangingEventArgs instance containing the event data.

OnRowSourceNeeded(Object, GridViewRowSourceNeededEventArgs)

Fires the RowSourceNeeded event.

Declaration
protected virtual void OnRowSourceNeeded(object sender, GridViewRowSourceNeededEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowSourceNeededEventArgs e

The GridViewRowSourceNeededEventArgs instance containing the event data.

OnRowValidated(Object, RowValidatedEventArgs)

Raises the RowValidated event.

Declaration
protected virtual void OnRowValidated(object sender, RowValidatedEventArgs e)
Parameters
System.Object sender

RowValidatedEventArgs e

An instance of RowValidatedEventArgs containing event data.

OnRowValidating(Object, RowValidatingEventArgs)

Raises the RowValidating event.

Declaration
protected virtual void OnRowValidating(object sender, RowValidatingEventArgs e)
Parameters
System.Object sender

RowValidatingEventArgs e

An instance of RowValidatingEventArgs containing event data.

OnSelectionChanged(Object, EventArgs)

Fires when the current selection changes.

Declaration
protected virtual void OnSelectionChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnSelectionChanging(Object, GridViewSelectionCancelEventArgs)

Fires when the current selection is changing.

Declaration
protected virtual void OnSelectionChanging(object sender, GridViewSelectionCancelEventArgs e)
Parameters
System.Object sender

The sender.
GridViewSelectionCancelEventArgs e

The GridViewSelectionCancelEventArgs instance containing the event data.

OnSortChanged(Object, GridViewCollectionChangedEventArgs)

Fires when sorting is changed.

Declaration
protected virtual void OnSortChanged(object sender, GridViewCollectionChangedEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangedEventArgs e

The GridViewCollectionChangedEventArgs instance containing the event data.

OnSortChanging(Object, GridViewCollectionChangingEventArgs)

Fires when sorting is changing.

Declaration
protected virtual void OnSortChanging(object sender, GridViewCollectionChangingEventArgs e)
Parameters
System.Object sender

The sender.
GridViewCollectionChangingEventArgs e

The GridViewCollectionChangingEventArgs instance containing the event data.

OnUserAddedRow(Object, GridViewRowEventArgs)

Occurs when the user has finished adding a row to the RadGridView.

Declaration
protected virtual void OnUserAddedRow(object sender, GridViewRowEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowEventArgs e

The GridViewRowEventArgs instance containing the event data.

OnUserAddingRow(Object, GridViewRowCancelEventArgs)

Occurs when the user adding new row to the RadGridView.

Declaration
protected virtual void OnUserAddingRow(object sender, GridViewRowCancelEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowCancelEventArgs e

The GridViewRowCancelEventArgs instance containing the event data.

OnUserDeletedRow(Object, GridViewRowEventArgs)

Occurs when the user has finished deleting a row from the RadGridView.

Declaration
protected virtual void OnUserDeletedRow(object sender, GridViewRowEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowEventArgs e

The GridViewRowEventArgs instance containing the event data.

OnUserDeletingRow(Object, GridViewRowCancelEventArgs)

Occurs when the user deletes a row from the RadGridView.

Declaration
protected virtual void OnUserDeletingRow(object sender, GridViewRowCancelEventArgs e)
Parameters
System.Object sender

The sender.
GridViewRowCancelEventArgs e

The GridViewRowCancelEventArgs instance containing the event data.

OnValidated(EventArgs)

Raises the System.Windows.Forms.Control.Validated event.

Declaration
protected override void OnValidated(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnValidating(CancelEventArgs)

Raises the System.Windows.Forms.Control.Validating event.

Declaration
protected override void OnValidating(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

A System.ComponentModel.CancelEventArgs that contains the event data.

OnValueChanged(Object, EventArgs)

Fires when the value of a cell changes.

Declaration
protected virtual void OnValueChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnValueChanging(Object, ValueChangingEventArgs)

Fires before the value in a cell is changing.

Declaration
protected virtual void OnValueChanging(object sender, ValueChangingEventArgs e)
Parameters
System.Object sender

The sender.
ValueChangingEventArgs e

The ValueChangingEventArgs instance containing the event data.

OnViewCellFormatting(Object, CellFormattingEventArgs)

Raises the ViewCellFormatting event

Declaration
protected void OnViewCellFormatting(object sender, CellFormattingEventArgs e)
Parameters
System.Object sender

The grid cell that needs formatting.
CellFormattingEventArgs e

A CellFormattingEventArgsinstance containing event data.
See Also

OnViewRowFormatting(Object, RowFormattingEventArgs)

Raises the ViewRowFormatting event.

Declaration
protected void OnViewRowFormatting(object sender, RowFormattingEventArgs e)
Parameters
System.Object sender

The row that needs formatting.
RowFormattingEventArgs e

A RowFormattingEventArgs instance containing event data.
See Also

Paste()

Paste the contents of the System.Windows.Forms.Clipboard to the current view.

Declaration
public virtual void Paste()

Print()

Directly prints the RadGridView to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadGridView to the default printer or shows printer settings and then prints the RadGridView.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadGridView to the default printer or shows printer settings and then prints the RadGridView.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadGridView print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadGridView print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

ProcessCodedUIMessage(ref IPCMessage)

Processes the coded UI message.

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

The request.
Overrides

ProcessDialogKey(Keys)

Processes a dialog key.

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

One of the System.Windows.Forms.Keys values that represents the key to process.
Returns
System.Boolean

true if the key was processed by the control; otherwise, false.

SaveLayout(Stream)

Stores to a stream RadGridView properties, sub-objects and their properties in XML format, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void SaveLayout(Stream stream)
Parameters
System.IO.Stream stream

SaveLayout(String)

Stores to a file RadGridView properties, sub-objects and their properties in XML format, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void SaveLayout(string fileName)
Parameters
System.String fileName

SaveLayout(XmlWriter)

Stores RadGridView properties, sub-objects and their properties in XML format, using the serialization information provided by the XmlSerializationInfo property

Declaration
public virtual void SaveLayout(XmlWriter xmlWriter)
Parameters
System.Xml.XmlWriter xmlWriter

XmlWriter to use by the built-in serializer

SelectAll()

Select all cells (rows) in RadGriView

Declaration
public void SelectAll()

ShowColumnChooser()

Shows the GridViewColumnChooser for the columns of the master view template.

Declaration
public void ShowColumnChooser()
See Also

ShowColumnChooser(GridViewTemplate)

Shows the GridViewColumnChooser.

Declaration
public void ShowColumnChooser(GridViewTemplate template)
Parameters
GridViewTemplate template

The template which columns will be shown for.
See Also

UnWireEvents()

Unsubscribe from the handled events.

Declaration
protected virtual void UnWireEvents()

WireEvents()

Subscribe to events handling the basic features in RadGridView.

Declaration
protected virtual void WireEvents()

WndProc(ref Message)

Processes Windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows System.Windows.Forms.Message to process.
Overrides

Events

AutoGeneratingColumn

Fires each time a new column is automatically generated and is about to be added to the columns of RadGridView. Occurs one time for each public, non-static property in the bound data type when the DataSource property is changed and the AutoGenerateColumns property is true.

Declaration
public event GridViewAutoGeneratingColumnEventHandler AutoGeneratingColumn
Event Type
GridViewAutoGeneratingColumnEventHandler

CancelRowEdit

Fires when the unbound cell requires a value for a cell in order to format and display the cell.

Declaration
public event QuestionEventHandler CancelRowEdit
Event Type
System.Windows.Forms.QuestionEventHandler

CellBeginEdit

Fires when the cell is entering edit mode. The action can be canceled.

Declaration
public event GridViewCellCancelEventHandler CellBeginEdit
Event Type
GridViewCellCancelEventHandler

CellClick

Fires when a cell is clicked.

Declaration
public event GridViewCellEventHandler CellClick
Event Type
GridViewCellEventHandler

CellDoubleClick

Fires when a cell is double clicked.

Declaration
public event GridViewCellEventHandler CellDoubleClick
Event Type
GridViewCellEventHandler

CellEditorInitialized

Fires when an element for editing a cell is initialized and visible.

Declaration
public event GridViewCellEventHandler CellEditorInitialized
Event Type
GridViewCellEventHandler

See Also

CellEndEdit

Fires when the cell editing is finished.

Declaration
public event GridViewCellEventHandler CellEndEdit
Event Type
GridViewCellEventHandler

CellFormatting

Fires when the content of a data cell needs to be formatted for display.

Declaration
public event CellFormattingEventHandler CellFormatting
Event Type
CellFormattingEventHandler

See Also

CellMerging

Fires when the two neighbor cells are compared and about to be merged.

Declaration
public event GridViewCellMergingEventHandler CellMerging
Event Type
GridViewCellMergingEventHandler

See Also

CellMouseMove

Fires when the mouse pointer moves over the cell.

Declaration
public event CellMouseMoveEventHandler CellMouseMove
Event Type
CellMouseMoveEventHandler

CellPaint

Fires when a cell needs to be painted.

Declaration
public event GridViewCellPaintEventHandler CellPaint
Event Type
GridViewCellPaintEventHandler

CellValidated

Fires when a row has finished validating.

Declaration
public event CellValidatedEventHandler CellValidated
Event Type
CellValidatedEventHandler

CellValidating

Fires when Cell is validating.

Declaration
public event CellValidatingEventHandler CellValidating
Event Type
CellValidatingEventHandler

CellValueChanged

Fires when the value of a cell changes.

Declaration
public event GridViewCellEventHandler CellValueChanged
Event Type
GridViewCellEventHandler

CellValueNeeded

Fires when the unbound cell requires a value for a cell in order to format and display the cell.

Declaration
public event GridViewCellValueEventHandler CellValueNeeded
Event Type
GridViewCellValueEventHandler

See Also

CellValuePushed

Fires when the unbound cell changed and requires storage in the underlying data source.

Declaration
public event GridViewCellValueEventHandler CellValuePushed
Event Type
GridViewCellValueEventHandler

See Also

ChildViewExpanded

Fires when the child view is expanded or collapsed.

Declaration
public event ChildViewExpandedEventHandler ChildViewExpanded
Event Type
ChildViewExpandedEventHandler

ChildViewExpanding

Fires when the child view is expanded or collapsed.

Declaration
public event ChildViewExpandingEventHandler ChildViewExpanding
Event Type
ChildViewExpandingEventHandler

ChildViewPrinting

Fires for hierarchy rows with more than one child views.

Declaration
public event ChildViewPrintingEventHandler ChildViewPrinting
Event Type
ChildViewPrintingEventHandler

ColumnChooserCreated

Fires when a ColumnChooserCreated is created.

Declaration
public event ColumnChooserCreatedEventHandler ColumnChooserCreated
Event Type
ColumnChooserCreatedEventHandler

ColumnChooserItemElementCreating

Fires when a new column chooser item element is being created.

Declaration
public event ColumnChooserItemElementCreatingEventHandler ColumnChooserItemElementCreating
Event Type
ColumnChooserItemElementCreatingEventHandler

ColumnWidthChanged

Fires when the width of a column changes.

Declaration
public event ColumnWidthChangedEventHandler ColumnWidthChanged
Event Type
System.Windows.Forms.ColumnWidthChangedEventHandler

ColumnWidthChanging

Fires before the width of a column changes.

Declaration
public event ColumnWidthChangingEventHandler ColumnWidthChanging
Event Type
System.Windows.Forms.ColumnWidthChangingEventHandler

CommandCellClick

Fires when a command cell is clicked.

Declaration
public event CommandCellClickEventHandler CommandCellClick
Event Type
CommandCellClickEventHandler

ConditionalFormattingFormShown

Declaration
public event EventHandler ConditionalFormattingFormShown
Event Type
System.EventHandler

ContextMenuOpening

Fires before a context menu is shown.

Declaration
public event ContextMenuOpeningEventHandler ContextMenuOpening
Event Type
ContextMenuOpeningEventHandler

Copying

Occurs when the RadGridView has prepared appropriate data formats that represent the copy selection, added the copy selection formats to a DataObject, and is ready to either place the DataObject on the Clipboard.

Declaration
public event GridViewClipboardEventHandler Copying
Event Type
GridViewClipboardEventHandler

CopyingCellClipboardContent

Occurs when the RadGridView prepares each cell's value to be placed on the Clipboard.

Declaration
public event GridViewCellValueEventHandler CopyingCellClipboardContent
Event Type
GridViewCellValueEventHandler

CreateCell

Fires when a cell needs to be created.

Declaration
public event GridViewCreateCellEventHandler CreateCell
Event Type
GridViewCreateCellEventHandler

CreateCompositeFilterDialog

Occurs when a composite filter dialog is being created.

Declaration
public event GridViewCreateCompositeFilterDialogEventHandler CreateCompositeFilterDialog
Event Type
GridViewCreateCompositeFilterDialogEventHandler

CreateRow

Fires when a row needs to be created.

Declaration
public event GridViewCreateRowEventHandler CreateRow
Event Type
GridViewCreateRowEventHandler

CreateRowInfo

Occurs when the instance of GridViewRowInfo is created.

Declaration
public event GridViewCreateRowInfoEventHandler CreateRowInfo
Event Type
GridViewCreateRowInfoEventHandler

CurrentCellChanged

Fires after the current cell has changed.

Declaration
public event CurrentCellChangedEventHandler CurrentCellChanged
Event Type
CurrentCellChangedEventHandler

CurrentColumnChanged

Fires when the current column has changed.

Declaration
public event CurrentColumnChangedEventHandler CurrentColumnChanged
Event Type
CurrentColumnChangedEventHandler

See Also

CurrentRowChanged

Fires when current row is changed.

Declaration
public event CurrentRowChangedEventHandler CurrentRowChanged
Event Type
CurrentRowChangedEventHandler

CurrentRowChanging

Fires when the current row is changing. The action can be canceled.

Declaration
public event CurrentRowChangingEventHandler CurrentRowChanging
Event Type
CurrentRowChangingEventHandler

CurrentViewChanged

Fires when the current view in RadGridView has changed.

Declaration
public event GridViewCurrentViewChangedEventHandler CurrentViewChanged
Event Type
GridViewCurrentViewChangedEventHandler

CustomFiltering

Fires for custom filtering operation.

Declaration
public event GridViewCustomFilteringEventHandler CustomFiltering
Event Type
GridViewCustomFilteringEventHandler

CustomGrouping

Fires for custom grouping operation.

Declaration
public event GridViewCustomGroupingEventHandler CustomGrouping
Event Type
GridViewCustomGroupingEventHandler

CustomSorting

Fires for custom sorting operation.

Declaration
public event GridViewCustomSortingEventHandler CustomSorting
Event Type
GridViewCustomSortingEventHandler

DataBindingComplete

Fires after data binding operation has finished.

Declaration
public event GridViewBindingCompleteEventHandler DataBindingComplete
Event Type
GridViewBindingCompleteEventHandler

See Also

DataError

Fires when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.

Declaration
public event GridViewDataErrorEventHandler DataError
Event Type
GridViewDataErrorEventHandler

DataGroupNeeded

Fires when the data group is required in virtual mode.

Declaration
public event GridViewDataGroupEventHandler DataGroupNeeded
Event Type
GridViewDataGroupEventHandler

DefaultValuesNeeded

Fires when the user enters the row for new records, so that it can be populated with default values.

Declaration
public event GridViewRowEventHandler DefaultValuesNeeded
Event Type
GridViewRowEventHandler

See Also

EditorRequired

Fires after CellBeginEdit.

Declaration
public event EditorRequiredEventHandler EditorRequired
Event Type
EditorRequiredEventHandler

ExpressionEditorFormCreated

Fires when a new expression editor form is created.

Declaration
public event ExpressionEditorFormCreatedEventHandler ExpressionEditorFormCreated
Event Type
ExpressionEditorFormCreatedEventHandler

FilterChanged

Occurs when the filter is changed.

Declaration
public event GridViewCollectionChangedEventHandler FilterChanged
Event Type
GridViewCollectionChangedEventHandler

FilterChanging

Occurs when the filter is changing.

Declaration
public event GridViewCollectionChangingEventHandler FilterChanging
Event Type
GridViewCollectionChangingEventHandler

FilterExpressionChanged

Occurs when the filter expression is changed.

Declaration
public event GridViewFilterExpressionChangedEventHandler FilterExpressionChanged
Event Type
GridViewFilterExpressionChangedEventHandler

FilterPopupInitialized

Occurs when the filter popup has been initialized.

Declaration
public event FilterPopupInitializedEventHandler FilterPopupInitialized
Event Type
FilterPopupInitializedEventHandler

FilterPopupRequired

Occurs when a filter popup is required.

Declaration
public event FilterPopupRequiredEventHandler FilterPopupRequired
Event Type
FilterPopupRequiredEventHandler

GroupByChanged

Fires when grouping is changed.

Declaration
public event GridViewCollectionChangedEventHandler GroupByChanged
Event Type
GridViewCollectionChangedEventHandler

GroupByChanging

Fires when grouping is changing. The action can be canceled.

Declaration
public event GridViewCollectionChangingEventHandler GroupByChanging
Event Type
GridViewCollectionChangingEventHandler

GroupExpanded

Fires when the DataGroup is expanded or collapsed.

Declaration
public event GroupExpandedEventHandler GroupExpanded
Event Type
GroupExpandedEventHandler

GroupExpanding

Fires when the DataGroup is expanding or collapsing. This behavior is valid when grouping or hierarchy mode is applied.

Declaration
public event GroupExpandingEventHandler GroupExpanding
Event Type
GroupExpandingEventHandler

GroupSortChanged

Fires after the user has changed the sorting of the group.

Declaration
public event GridViewGroupSortChangedEventHandler GroupSortChanged
Event Type
GridViewGroupSortChangedEventHandler

GroupSortChanging

Fires when the user changes the sorting of the group. The action can be canceled.

Declaration
public event GridViewGroupSortChangingEventHandler GroupSortChanging
Event Type
GridViewGroupSortChangingEventHandler

GroupSummaryEvaluate

Fires when evaluation of group summary is undergoing.

Declaration
public event GroupSummaryEvaluateEventHandler GroupSummaryEvaluate
Event Type
GroupSummaryEvaluateEventHandler

Remarks

Allows modification of the result by providing access to the currently evaluated value and the data group.

HeaderCellToggleStateChanged

Fires when a toggle state changed of RadCheckBoxElement in header cell.

Declaration
public event HeaderCellToggleStateChangedEventHandler HeaderCellToggleStateChanged
Event Type
HeaderCellToggleStateChangedEventHandler

HyperlinkOpened

Occurs when the hyperlink is opened.

Declaration
public event HyperlinkOpenedEventHandler HyperlinkOpened
Event Type
HyperlinkOpenedEventHandler

HyperlinkOpening

Occurs when the hyperlink is opening.

Declaration
public event HyperlinkOpeningEventHandler HyperlinkOpening
Event Type
HyperlinkOpeningEventHandler

LayoutLoaded

Occurs when the layout is loaded.

Declaration
public event LayoutLoadedEventHandler LayoutLoaded
Event Type
LayoutLoadedEventHandler

NewRowNeeded

Fires when the unbound cell requires a value for a cell in order to format and display the cell.

Declaration
public event GridViewRowEventHandler NewRowNeeded
Event Type
GridViewRowEventHandler

See Also

PageChanged

Fires after the current page has changed.

Declaration
public event EventHandler<EventArgs> PageChanged
Event Type
System.EventHandler<System.EventArgs>

PageChanging

Fires when the current page is changing.

Declaration
public event EventHandler<PageChangingEventArgs> PageChanging
Event Type
System.EventHandler<PageChangingEventArgs>

Pasting

Occurs when the RadGridView is ready to paste data.

Declaration
public event GridViewClipboardEventHandler Pasting
Event Type
GridViewClipboardEventHandler

PastingCellClipboardContent

Occurs when the RadGridView is ready to paste data to individual cells.

Declaration
public event GridViewCellValueEventHandler PastingCellClipboardContent
Event Type
GridViewCellValueEventHandler

PrintCellFormatting

Fires when the content of any grid cell needs to be formatted for printing.

Declaration
public event PrintCellFormattingEventHandler PrintCellFormatting
Event Type
PrintCellFormattingEventHandler

See Also

PrintCellPaint

Fires when the content of any grid cell needs to be formatted for printing.

Declaration
public event PrintCellPaintEventHandler PrintCellPaint
Event Type
PrintCellPaintEventHandler

See Also

RowDirtyStateNeeded

Fires when an unbound cell requires a value for a cell in order to format and display the cell.

Declaration
public event QuestionEventHandler RowDirtyStateNeeded
Event Type
System.Windows.Forms.QuestionEventHandler

RowFormatting

Fires when a data row is invalidated and needs to be formatted.

Declaration
public event RowFormattingEventHandler RowFormatting
Event Type
RowFormattingEventHandler

Examples
void radGridView1_RowFormatting(object sender, RowFormattingEventArgs e) 
{ 
   if (e.RowElement.RowInfo.Cells.Count > 0 && (string)e.RowElement.RowInfo.Cells[0].Value == "3") 
       e.RowElement.Font = strikeoutFont; 
   else 
       e.RowElement.Font = SystemFonts.DialogFont; 
}
See Also

RowHeightChanged

Fires after the height of a row changes.

Declaration
public event RowHeightChangedEventHandler RowHeightChanged
Event Type
RowHeightChangedEventHandler

RowHeightChanging

Fires before the height of a row changes.

Declaration
public event RowHeightChangingEventHandler RowHeightChanging
Event Type
RowHeightChangingEventHandler

RowMouseMove

Fires when the mouse pointer moves over a row.

Declaration
public event RowMouseMoveEventHandler RowMouseMove
Event Type
RowMouseMoveEventHandler

See Also

RowPaint

Fires when a row needs to be painted.

Declaration
public event GridViewRowPaintEventHandler RowPaint
Event Type
GridViewRowPaintEventHandler

RowsChanged

Fires when the Rows collection of a GridViewTemplate changes.

Declaration
public event GridViewCollectionChangedEventHandler RowsChanged
Event Type
GridViewCollectionChangedEventHandler

RowsChanging

Fires before the Rows collection of a GridViewTemplate changes.

Declaration
public event GridViewCollectionChangingEventHandler RowsChanging
Event Type
GridViewCollectionChangingEventHandler

RowSourceNeeded

Provides data for the parent row in RadGridView Hierarchy Mode

Declaration
public event GridViewRowSourceNeededEventHandler RowSourceNeeded
Event Type
GridViewRowSourceNeededEventHandler

RowValidated

Fires when a row is validated.

Declaration
public event RowValidatedEventHandler RowValidated
Event Type
RowValidatedEventHandler

RowValidating

Fires before a row is validated.

Declaration
public event RowValidatingEventHandler RowValidating
Event Type
RowValidatingEventHandler

SelectionChanged

Fires when the current selection is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

SelectionChanging

Fires when the current selection is changing.

Declaration
public event GridViewSelectionCancelEventHandler SelectionChanging
Event Type
GridViewSelectionCancelEventHandler

SortChanged

Fires when the sorting is changed.

Declaration
public event GridViewCollectionChangedEventHandler SortChanged
Event Type
GridViewCollectionChangedEventHandler

SortChanging

Fires when the sorting is changing. The action can be canceled.

Declaration
public event GridViewCollectionChangingEventHandler SortChanging
Event Type
GridViewCollectionChangingEventHandler

UserAddedRow

Occurs when the user has finished adding a row to the RadGridView

Declaration
public event GridViewRowEventHandler UserAddedRow
Event Type
GridViewRowEventHandler

UserAddingRow

Occurs when the user adding new row to the RadGridView

Declaration
public event GridViewRowCancelEventHandler UserAddingRow
Event Type
GridViewRowCancelEventHandler

UserDeletedRow

Occurs when the user has finished deleting a row from the RadGridView.

Declaration
public event GridViewRowEventHandler UserDeletedRow
Event Type
GridViewRowEventHandler

UserDeletingRow

Occurs when the user deletes a row from the RadGridView.

Declaration
public event GridViewRowCancelEventHandler UserDeletingRow
Event Type
GridViewRowCancelEventHandler

ValueChanged

Fires when the value of an editor changes.

Declaration
public event EventHandler ValueChanged
Event Type
System.EventHandler

ValueChanging

Fires before the value in an editor is being changed. The action can be canceled.

Declaration
public event ValueChangingEventHandler ValueChanging
Event Type
ValueChangingEventHandler

ViewCellFormatting

Fires when the content of any grid cell needs to be formatted for display.

Declaration
public event CellFormattingEventHandler ViewCellFormatting
Event Type
CellFormattingEventHandler

See Also

ViewRowFormatting

Fires when a grid row is invalidated and needs to be formatted.

Declaration
public event RowFormattingEventHandler ViewRowFormatting
Event Type
RowFormattingEventHandler

See Also

Explicit Interface Implementations

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

This method is called every time new print procedure is initiated.

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

The document that contains the printed graphics.
System.Drawing.Printing.PrintEventArgs args

The print arguments.
Returns
System.Int32

The number of pages that will be required for the print of the control.
Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

This method is called when all pages have been printed.

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

The document that contains the printed graphics.
System.Drawing.Printing.PrintEventArgs args

The print arguments.
Returns
System.Boolean

Always returns true.
Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Gets the dialog containing settings for the print job.

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

The document that contains the printed graphics.
Returns
System.Windows.Forms.Form

A print settings dialog.
Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

This method is called for every page that is printed.

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

The number of the current page.
RadPrintDocument sender

The document that contains the printed graphics.
System.Drawing.Printing.PrintPageEventArgs args

The print arguments.
Returns
System.Boolean

True if there are more pages to print.
Implements

Extension Methods