RadGrid for ASP.NET
Search RadGrid for ASP.NET
Contents
At a glance
Installation and deployment
DNN
Licensing
Already using the control
Functional overview
ASP.NET 2.0 Features
Getting Started
Grid columns
Grid rows
Defining Structure
Visible/Enabled conventions
Populating the control with data
AJAX
Sorting
Paging
Scrolling
Grouping
Filtering
Selecting grid items
Insert/Update/Delete records
Hierarchical grid types and Load modes
Design-time support
Controlling visual appearance
Localization/Accessibility
RadGrid export
The control lifecycle
Performance tips and tricks
Getting familiar with server-side API
Getting familiar with client-side API
Telerik RadGrid inheritance
How-to
Troubleshooting
Integration with other controls
Client-side API Reference
API Reference
Telerik.RadGridUtils Namespace
Telerik.WebControls Namespace
GridBaseDataList Class
GridBoolColumnEditor Class
GridBoundColumn Class
GridButtonColumn Class
GridCheckBoxColumn Class
GridCheckBoxColumnEditor Class
GridClientDeleteColumn Class
GridClientEvents Class
GridClientMessages Class
GridClientSelectColumn Class
GridClientSettings Class
GridColumn Class
GridColumnCollection Class
GridColumnCreatedEventArgs Class
GridColumnCreatingEventArgs Class
GridColumnEditorBase Class
GridColumnEditorException Class
GridColumnsReorderEventArgs Class
GridCommandEventArgs Class
GridCommandItem Class
GridCommandItemSettings Class
GridCreateColumnEditorEventArgs Class
GridDataChangeEventArgs Class
GridDataInsertItem Class
GridDataItem Class
GridDataItemCollection Class
GridDataKeyArray Class
GridDeletedEventArgs Class
GridDetailTableDataBindEventArgs Class
GridDropDownColumn Class
GridDropDownColumnEditor Class
GridDropDownListColumnEditor Class
GridEditableColumn Class
GridEditableItem Class
GridEditCommandColumn Class
GridEditFormInsertItem Class
GridEditFormItem Class
GridEditFormItem.EditFormTableCell Class
GridEditFormSettings Class
GridEditManager Class
GridException Class
GridExpandColumn Class
GridExportSettings Class
GridFilterFunction Class
GridFilterFunction.FunctionEntry Class
GridFilterFunction.StringFunctionEntry Class
GridFilteringException Class
GridFilteringItem Class
GridFilteringParamsException Class
GridFilterMenu Class
GridFooterItem Class
GridGroupByException Class
GridGroupByExpression Class
GridGroupByExpressionCollection Class
GridGroupByExpressionCollection.GridGroupByExpressionEnumerator Class
GridGroupByField Class
GridGroupHeaderItem Class
GridGroupingContext Class
GridGroupingSettings Class
GridGroupPanel Class
GridGroupPanelImageButton Class
GridGroupPanelStyle Class
GridGroupsChangingEventArgs Class
GridGroupSplitterColumn Class
GridHeaderItem Class
GridHierarchySettings Class
GridHyperLinkColumn Class
GridImage Class
GridImageButton Class
GridIndexCollection Class
GridInitializeEditFormContainer Class
GridInitializePagerItem Class
GridInsertedEventArgs Class
GridInsertionObject Class
GridItem Class
GridItemBuilder.GroupingHelperDataRow Class
GridItemBuilder.GroupingHelperDataTable Class
GridItemCollection Class
GridItemCreated Class
GridItemDataBound Class
GridItemEventArgs Class
GridItemEventInfo Class
GridMenuItem Class
GridMenuItemClickEventArgs Class
GridMenuItemCollection Class
GridMultiRowItem Class
GridNeedDataSourceEventArgs Class
GridNestedViewItem Class
GridNoRecordsItem Class
GridNotSupportedException Class
GridObjectWithState Class
GridPageChangedEventArgs Class
GridPagerItem Class
GridPagerStyle Class
GridPageSizeChangedEventArgs Class
GridPagingManager Class
GridPanelItemsStyle Class
GridPdfSettings Class
GridPostBackReferences Class
GridPropertyEvaluator Class
GridRelationFields Class
GridResizing Class
GridRowIndicatorColumn Class
GridScrolling Class
GridSelecting Class
GridSelfHierarchySettings Class
GridSortCommandEventArgs Class
GridSortExpression Class
GridSortExpressionCollection Class
GridSortingSettings Class
GridSplitGroup Class
GridStatusBarItem Class
GridStatusBarItemDecorator Class
GridStatusBarItemSettings Class
GridStringArrayConverter Class
GridTableCell Class
GridTableHeaderCell Class
GridTableItemStyle Class
GridTableRow Class
GridTableView Class
GridTableViewCollection Class
GridTableViewCollection.GridDataTableEnumerator Class
GridTableViewRelation Class
GridTableViewRelation.GridRelationFieldsEnumerator Class
GridTemplateColumn Class
GridTemplateColumnEditor Class
GridTextBoxColumnEditor Class
GridTextButton Class
GridTextColumnEditor Class
GridTFoot Class
GridTHead Class
GridUpdatedEventArgs Class
GridValidationSettings Class
GroupItemCell Class
RadGrid Class
Overview
Members
RadGrid Constructor
Methods
Properties
Fields
Events
IGridColumnEditor Interface
IGridCommandEvent Interface
IGridEditableColumn Interface
IGridInsertItem Interface
GridAggregateFunction Enumeration
GridButtonColumnType Enumeration
GridChildLoadMode Enumeration
GridClientSettings.GridColumnsReorderMethod Enumeration
GridCommandItemDisplay Enumeration
GridDataSourcePersistenceMode Enumeration
GridEditFormType Enumeration
GridEditMode Enumeration
GridExpandColumnType Enumeration
GridFilterListOptions Enumeration
GridForceExtractValues Enumeration
GridGroupLoadMode Enumeration
GridGroupsChangingAction Enumeration
GridGroupSplitMode Enumeration
GridHeaderButtonType Enumeration
GridItemType Enumeration
GridKnownFunction Enumeration
GridPagerMode Enumeration
GridPagerPosition Enumeration
GridPaperSize Enumeration
GridRebindReason Enumeration
GridResetPageIndexAction Enumeration
GridSortOrder Enumeration
GridTableFrame Enumeration
GridTableLayout Enumeration
GridTableTextDirection Enumeration
Need for help
PID412 ; RID7 ; VID7
RadGrid
Send comments
on this topic.
RadGrid Class Members
See Also
Fields
Properties
Methods
Events
Collapse All
Expand All
Members Options: Show All
Members Options: Filtered
Telerik.WebControls Namespace
: RadGrid Class
Include Inherited Members
Include Protected Members
The following tables list the members exposed by
RadGrid
.
Public Constructors
Name
Description
RadGrid Constructor
Constructs a new instance of RadGrid
Top
Public Fields
Name
Description
CancelAllCommandName
CancelCommandName
Represents the
Cancel
command name. This field is read-only.
DeleteCommandName
Represents the "Delete" command name. This field is read-only.
DeleteSelectedCommandName
Represents the "DeleteSelected" command name. This field is read-only.
DeselectCommandName
EditAllCommandName
EditCommandName
Represents the "Edit" command name. This field is read-only.
EditSelectedCommandName
ExpandCollapseCommandName
ExportToCsvCommandName
ExportToExcelCommandName
ExportToPdfCommandName
ExportToWordCommandName
FilterCommandName
InitInsertCommandName
Represents the "InitInsert" command name. This field is read-only.
NextPageCommandArgument
PageCommandName
PerformInsertCommandName
Represents the "PerformInsert" command name. This field is read-only.
PrevPageCommandArgument
RebindGridCommandName
Represents the "RebindGrid" command name. This field is read-only. Forces
RadGrid.Rebind
SelectCommandName
SortCommandName
UpdateCommandName
Represents the "Update" command name. This field is read-only.
UpdateEditedCommandName
Represents the "UpdateEdited" command name. Updates all items that are in edit mode. This field is read-only.
Top
Public Properties
Name
Description
AccessKey
(Inherited from
System.Web.UI.WebControls.WebControl
)
ActiveItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the active item in a Telerik RadGrid control.
AJAXLoadingTemplate
The template that will be displayed as a progress indicator during AJAX request.
AjaxUrl
Gets or sets a value the URL that the control will use for AJAX requests. (Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
AllowAutomaticDeletes
Gets or sets a value indicating whether Telerik RadGrid will automatically delete records from the specified data source.
AllowAutomaticInserts
Gets or sets a value indicating whether Telerik RadGrid will perform automatic insert of records to the data source.
AllowAutomaticUpdates
Gets or sets a value indicating whether Telerik RadGrid will perform automatic updates to the data source.
AllowCustomPaging
Gets or sets a value indicating whether custom paging should be performed instead of the integrated automatic paging.
AllowFilteringByColumn
Gets or sets a value indicating whether the filtering of all tables in the hierarchy will be enabled, unless specified other by
GridTableView.AllowFilteringByColumn.
AllowMultiRowEdit
Gets or sets a value indicating whether Telerik RadGrid will allow you to have multiple rows in edit mode. The default value is
false
.
AllowMultiRowSelection
Gets or sets a value indicating whether you will be able to select multiple rows in Telerik RadGrid. By default this property is set to
false
.
AllowPaging
Gets or sets a value indicating whether the automatic paging feature is enabled.
AllowSorting
Gets or sets a value indicating whether the sorting feature is enabled.
AlternatingItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating data items in a Telerik RadGrid control.
AppRelativeTemplateSourceDirectory
(Inherited from
System.Web.UI.Control
)
Attributes
(Inherited from
System.Web.UI.WebControls.WebControl
)
AutoGenerateColumns
Gets or sets a value indicating whether bound fields are automatically created for each field in the data source.
AutoGenerateDeleteColumn
AutoGenerateEditColumn
BackColor
(Inherited from
System.Web.UI.WebControls.WebControl
)
BackImageUrl
Gets or sets the URL to an image to display in the background of a Telerik RadGrid control.
BorderColor
(Inherited from
System.Web.UI.WebControls.WebControl
)
BorderStyle
(Inherited from
System.Web.UI.WebControls.WebControl
)
BorderWidth
(Inherited from
System.Web.UI.WebControls.WebControl
)
CellPadding
Gets or sets the amount of space between the contents of a cell and the cell's border. (Inherited from
GridBaseDataList
)
CellSpacing
Gets or sets the amount of space between cells. (Inherited from
GridBaseDataList
)
ClientID
(Inherited from
System.Web.UI.Control
)
ClientSettings
Gets a reference to the
GridClientSettings
object that allows you to set the properties of the client-side behavior and appearance in a Telerik RadGrid control.
Columns
Gets a collection (
GridColumnCollection
) of all columns in Telerik RadGrid.
CommandItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the command item in a Telerik RadGrid control.
ControlStyle
(Inherited from
System.Web.UI.WebControls.WebControl
)
ControlStyleCreated
(Inherited from
System.Web.UI.WebControls.WebControl
)
CssClass
(Inherited from
System.Web.UI.WebControls.WebControl
)
CurrentPageIndex
Gets or sets an integer value representing the current page index.
DataMember
Overridden. Gets or sets the name of the list of data that the Telerik RadGrid control binds to, in cases where the data source contains more than one distinct list of data items.
DataSource
Overridden. Gets or sets the object from which the Telerik RadGrid control retrieves its list of data items.
DataSourceID
Overridden. Gets or sets the ID of the control from which the Telerik RadGrid control retrieves its list of data items.
EditIndexes
Gets a collection of the indexes of the Items that are in edit mode.
EditItems
Gets a collection of all
GridItems
in edit mode. See the Remarks for more info.
EditItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the item selected for editing in a Telerik RadGrid control.
EnableAJAX
Overridden. Gets or sets a value indicating whether Telerik RadGrid will work in AJAX mode, i.e. will perform asynchronous requests instead of traditional postbacks.
EnableAJAXLoadingTemplate
If set to true and if there is AJAX request, RadGrid will show
AJAXLoadingTemplate
Enabled
(Inherited from
System.Web.UI.WebControls.WebControl
)
EnableOutsideScripts
Overridden. Gets or sets a value indicating if the outside scripts for the AJAX-enabled controls will be evaluated.
EnableTheming
(Inherited from
System.Web.UI.WebControls.WebControl
)
EnableViewState
(Inherited from
System.Web.UI.Control
)
ExportSettings
Gets a reference to the
GridExportSettings
object that allows you to set the properties of the grouping operation in a Telerik RadGrid control.
FilterItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a Telerik RadGrid control.
FilterMenu
Gets a reference to
GridFilterMenu
object. The filtering menu appears when the filter button on the
GridFilterItem
is clicked.
Font
(Inherited from
System.Web.UI.WebControls.WebControl
)
FooterStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the footer item in a Telerik RadGrid control.
ForeColor
(Inherited from
System.Web.UI.WebControls.WebControl
)
FormID
GridLines
Gets or sets a value that specifies whether the border between the cells of a data table is displayed. (Inherited from
GridBaseDataList
)
GroupHeaderItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the group-header item in a Telerik RadGrid control.
GroupingEnabled
Gets or sets a value indicating whether the grouping is enabled.
GroupingSettings
Gets a reference to the
GridGroupingSettings
object that allows you to set the properties of the grouping operation in a Telerik RadGrid control.
GroupPanel
Gets group panel control instance - visible only if grouping is enabled in grid (
GroupingEnabled
). Each
GridTableView
's Group-By-Expression is visualized in this panel.
HasAttributes
(Inherited from
System.Web.UI.WebControls.WebControl
)
HeaderStyle
Gets the style properties of the heading section in the RadGrid control.
Height
(Inherited from
System.Web.UI.WebControls.WebControl
)
HierarchySettings
Gets a reference to the
GridHierarchySettings
object that allows you to set the properties of the hierarchical Telerik RadGrid control.
HorizontalAlign
Gets or sets the horizontal alignment of a data table within its container. (Inherited from
GridBaseDataList
)
ID
(Inherited from
System.Web.UI.Control
)
IsAjaxRequest
Gets a value indicating whether the current request is an AJAX request initiated by the current control. (Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
IsAsyncRequest
Gets a value indicating whether the current request is an AJAX request initiated by the current control. (Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
Items
Gets a collection of all
GridDataItems
.
ItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the data items in a RadGrid control.
LoadingTemplateTransparency
Gets or sets
AJAXLoadingTemplate
transparency in percentage. Default value is 0 percents.
MasterTableView
The instance of
GridTableView
that represents the main grid-table view in RadGrid.
NamingContainer
(Inherited from
System.Web.UI.Control
)
OnAjaxRequestError
Using this property you can provide your own error handler for AJAX requests in RadAjax, RadGrid, RadCalendar if you wish to block or handle those errors in a specific way. You can either supply the name of a javascript function or executable code like "alert(e.message)" The javascript handler function should have the following signature: AjaxRequestErrorHandler(e, clientID) {...} It must also be defined ABOVE the code clock which contains your AJAX enabled control. (Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
Page
(Inherited from
System.Web.UI.Control
)
PageCount
Gets the number of pages required to display the records of the data source in a Telerik RadGrid control.
PagerStyle
Gets a reference to the
GridPagerStyle
object that allows you to set the appearance of the page item in a Telerik RadGrid control.
PageSize
Gets or sets an integer value indicating the number of Items that a single page in Telerik RadGrid will contain.
Parent
(Inherited from
System.Web.UI.Control
)
RadControlsDir
(Inherited from
Telerik.RadGridUtils.RadControl
)
ResponseScripts
Gets or sets a string collection of JavaScripts that will be executed on client-side when the response returns. (Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
SelectedIndexes
Gets a collection of indexes of the selected items.
SelectedItems
Gets a collection of the currently selected GridDataItems
SelectedItemStyle
Gets a reference to the
GridTableItemStyle
object that allows you to set the appearance of the selected item in a Telerik RadGrid control.
SelectedValue
Gets the data key value of the selected row in a RadGrid control.
ShowFooter
Gets or set a value indicating whether the footer item of the grid will be shown.
ShowGroupPanel
Gets or sets a value indicating whether the
GridGroupPanel
would be shown in Telerik RadGrid.
ShowHeader
Gets or set a value indicating whether the header item of the grid will be shown.
ShowStatusBar
Gets or set a value indicating whether the statusbar item of the grid will be shown.
Site
(Inherited from
System.Web.UI.Control
)
Skin
Overridden. Gets or sets the name of the Skin that Telerik RadGrid will use. The name of the skin is actually the name of the subfolder of
~/RadControls/Grid/Skins
, where the stylesheet and images for this skin reside.
The folder that holds the skins can be changed using the
SkinsPath Property
.
SkinID
(Inherited from
System.Web.UI.WebControls.WebControl
)
SkinsPath
Overridden. Gets or sets the folder where the skins for Telerik RadGrid reside. By default this is
~/RadControls/Grid/Skins
folder.
SortingSettings
Gets a reference to the
GridSortingSettings
object that allows you to set the properties of the sorting operation in a Telerik RadGrid control.
StatusBarSettings
Gets a
GridStatusBarItemSettings
object that contains variable settings related to the status bar.
Style
(Inherited from
System.Web.UI.WebControls.WebControl
)
TabIndex
Gets or sets the tab index of the Web server control. (Inherited from
GridBaseDataList
)
TemplateControl
(Inherited from
System.Web.UI.Control
)
TemplateSourceDirectory
(Inherited from
System.Web.UI.Control
)
ToolTip
(Inherited from
System.Web.UI.WebControls.WebControl
)
UniqueID
(Inherited from
System.Web.UI.Control
)
Url
Overridden.
UseEmbeddedScripts
Gets or sets a value indicating whether to use the embedded JavaScript files or not. (Inherited from
Telerik.RadGridUtils.RadControl
)
ValidationSettings
Gets a reference to the
GridValidationSettings
object that allows you to set the properties of the validate operation in a Telerik RadGrid control.
VirtualItemCount
Gets or sets a value, indicating the total number of items in the data source when custom paging is used. Thus the grid "understands" that the data source contains the specified number of records and it should fetch merely part of them at a time to execute requested operation.
Visible
(Inherited from
System.Web.UI.Control
)
Width
(Inherited from
System.Web.UI.WebControls.WebControl
)
Top
Public Methods
Name
Description
ApplyStyle
(Inherited from
System.Web.UI.WebControls.WebControl
)
ApplyStyleSheetSkin
(Inherited from
System.Web.UI.Control
)
AsyncRedirect
Overloaded. Performs a redirection to another page defined with a relative path using an AJAX request.
CopyBaseAttributes
(Inherited from
System.Web.UI.WebControls.WebControl
)
CreateTableView
This method is used by RadGrid internally. Please do not use.
DataBind
Overridden. Data-bind
MasterTableView
and its detail
GridTableView
s. Prior to calling
DataBind
, the
DataSource
property should be assigned.
Dispose
(Inherited from
System.Web.UI.Control
)
FindControl
(Inherited from
System.Web.UI.Control
)
Focus
(Inherited from
System.Web.UI.Control
)
GetSkinFolderName
Returns the path of the used skin, relative to the application root.
HasControls
(Inherited from
System.Web.UI.Control
)
MergeStyle
(Inherited from
System.Web.UI.WebControls.WebControl
)
Rebind
Forces RadGrid to fire
NeedDataSource
event then calls
DataBind
RenderBeginTag
(Inherited from
System.Web.UI.WebControls.WebControl
)
RenderControl
(Inherited from
System.Web.UI.Control
)
RenderEndTag
(Inherited from
System.Web.UI.WebControls.WebControl
)
ResolveClientUrl
(Inherited from
System.Web.UI.Control
)
ResolveUrl
(Inherited from
System.Web.UI.Control
)
SetMaxRequestQueueSize
(Inherited from
Telerik.RadGridUtils.RadAJAXControl
)
SetRenderMethodDelegate
(Inherited from
System.Web.UI.Control
)
Top
Public Events
Name
Description
CancelCommand
Occurs when the Cancel button is clicked for an item in the Telerik RadGrid control.
ColumnCreated
This event is fired
after
the creation of auto-generated columns.
ColumnCreating
Fires
before
a custom column is created. You can handle the event to replace or modify the instance of the column that should be created and added into the collection of column in the corresponding
GridTableView
.
CreateColumnEditor
Fires when each editable column creates its column editor, prior to initializing its controls in the cells of the grid
DataBinding
(Inherited from
System.Web.UI.Control
)
DataBound
(Inherited from
System.Web.UI.WebControls.BaseDataBoundControl
)
DeleteCommand
Occurs when the Delete button is clicked for an item in the Telerik RadGrid control.
DetailTableDataBind
Fires when a detail-table in the hierarchy is about to be bound. You should only assign the DataSource property of the detail table to a data-source properly filtered to display ony child records related to the parent item.
Disposed
(Inherited from
System.Web.UI.Control
)
EditCommand
Occurs when the Edit button is clicked for an item in the Telerik RadGrid control.
GroupsChanging
Fires when a grouping action has been performed. For example when a column header was dragged in the GroupPanel.
Init
(Inherited from
System.Web.UI.Control
)
InsertCommand
Occurs when the Insert button is clicked for an item in the Telerik RadGrid control.
ItemCommand
Occurs when a button is clicked in a Telerik RadGrid control.
ItemCreated
Occurs when a item is created in a Telerik RadGrid control.
ItemDataBound
Occurs when a data iten is bound to data in a Telerik RadGrid control.
ItemDeleted
Fires when a grid item has been deleted.
ItemEvent
Fires when various item events occur - for example, before Pager item is initialized, before EditForm is initialized, etc.
ItemInserted
Fires when a grid item has been inserted.
ItemUpdated
Fires when a grid item has been updated.
Load
(Inherited from
System.Web.UI.Control
)
NeedDataSource
Fires when the grid is about to be bound and the data source must be assigned (is null/Nothing).
PageIndexChanged
Fires when a paging action has been performed.
PageSizeChanged
Fires when
PageSize
property value has been changed.
PreRender
(Inherited from
System.Web.UI.Control
)
SelectedIndexChanged
Occurs when a different item is selected in a table between posts to the server. (Inherited from
GridBaseDataList
)
SortCommand
Occurs when a column is sorted.
Unload
(Inherited from
System.Web.UI.Control
)
UpdateCommand
Occurs when the Update button is clicked for an item in the Telerik RadGrid control.
Top
See Also
Reference
RadGrid Class
Telerik.WebControls Namespace
GridTableView Class
GridTableView Class
GridTableView Class