.NET Framework Class Library
DataGrid Class
A data bound list control that displays the items from data source in a table. The DataGrid control allows you to select, sort, and edit these items.
Inheritance Hierarchy
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.BaseDataList
System.Web.UI.WebControls.DataGrid
Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Syntax
Visual Basic
Public Class DataGrid _ Inherits BaseDataList _ Implements INamingContainer
C#
public class DataGrid : BaseDataList, INamingContainer
Visual C++
public ref class DataGrid : public BaseDataList, INamingContainer
F#
type DataGrid = class inherit BaseDataList interface INamingContainer end
ASP.NET
<asp:DataGrid />
The DataGrid type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
DataGrid | Initializes a new instance of the DataGrid class. |
Properties
| Name | Description | |
|---|---|---|
|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) |
|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
|
|
AllowCustomPaging | Gets or sets a value that indicates whether custom paging is enabled. |
|
|
AllowPaging | Gets or sets a value that indicates whether paging is enabled. |
|
|
AllowSorting | Gets or sets a value that indicates whether sorting is enabled. |
|
|
AlternatingItemStyle | Gets the style properties for alternating items in the DataGrid control. |
|
|
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
|
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) |
|
|
AutoGenerateColumns | Gets or sets a value that indicates whether BoundColumn objects are automatically created and displayed in the DataGrid control for each field in the data source. |
|
|
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) |
|
|
BackImageUrl | Gets or sets the URL of an image to display in the background of the DataGrid control. |
|
|
BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
|
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) |
|
|
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) |
|
|
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) |
|
|
Caption | Gets or sets the text to render in an HTML caption element in the control. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.) |
|
|
CaptionAlign | Gets or sets the horizontal or vertical position of the HTML caption element in a control. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.) |
|
|
CellPadding | Gets or sets the amount of space between the contents of a cell and the cell's border. (Inherited from BaseDataList.) |
|
|
CellSpacing | Gets or sets the amount of space between cells. (Inherited from BaseDataList.) |
|
|
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
|
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) |
|
|
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) |
|
|
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
|
Columns | Gets a collection of objects that represent the columns of the DataGrid control. |
|
|
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
|
Controls | Gets a System.Web.UI.ControlCollection object that contains a collection of child controls in a data listing control. (Inherited from BaseDataList.) |
|
|
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
|
|
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) |
|
|
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) |
|
|
CurrentPageIndex | Gets or sets the index of the currently displayed page. |
|
|
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) |
|
|
DataKeyField | Gets or sets the key field in the data source specified by the DataSource property. (Inherited from BaseDataList.) |
|
|
DataKeys | Gets a DataKeyCollection object that stores the key values of each record in a data listing control. (Inherited from BaseDataList.) |
|
|
DataKeysArray | Gets an ArrayList object that contains the key values of each record in a data listing control. (Inherited from BaseDataList.) |
|
|
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) |
|
|
DataMember | Gets or sets the specific data member in a multimember data source to bind to a data listing control. (Inherited from BaseDataList.) |
|
|
DataSource | Gets or sets the source containing a list of values used to populate the items within the control. (Inherited from BaseDataList.) |
|
|
DataSourceID | Gets or sets the ID property of the data source control that the data listing control should use to retrieve its data source. (Inherited from BaseDataList.) |
|
|
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
|
EditItemIndex | Gets or sets the index of an item in the DataGrid control to edit. |
|
|
EditItemStyle | Gets the style properties of the item selected for editing in the DataGrid control. |
|
|
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) |
|
|
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) |
|
|
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) |
|
|
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
|
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) |
|
|
FooterStyle | Gets the style properties of the footer section in the DataGrid control. |
|
|
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) |
|
|
GridLines | Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed. (Inherited from BaseDataList.) |
|
|
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) |
|
|
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
|
HeaderStyle | Gets the style properties of the heading section in the DataGrid control. |
|
|
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) |
|
|
HorizontalAlign | Gets or sets the horizontal alignment of a data listing control within its container. (Inherited from BaseDataList.) |
|
|
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
|
IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
|
Initialized | Gets a value indicating whether the control has been initialized. (Inherited from BaseDataList.) |
|
|
IsBoundUsingDataSourceID | Gets a value indicating whether the DataSourceID property is set. (Inherited from BaseDataList.) |
|
|
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
|
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) |
|
|
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
|
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
|
Items | Gets a collection of DataGridItem objects that represent the individual items in the DataGrid control. |
|
|
ItemStyle | Gets the style properties of the items in the DataGrid control. |
|
|
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
|
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.) |
|
|
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
|
PageCount | Gets the total number of pages required to display the items in the DataGrid control. |
|
|
PagerStyle | Gets the style properties of the paging section of the DataGrid control. |
|
|
PageSize | Gets or sets the number of items to display on a single page of the DataGrid control. |
|
|
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
|
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
|
|
RequiresDataBinding | Gets or sets a value indicating whether the data listing control needs to bind to its specified data source. (Inherited from BaseDataList.) |
|
|
SelectArguments | Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from BaseDataList.) |
|
|
SelectedIndex | Gets or sets the index of the selected item in the DataGrid control. |
|
|
SelectedItem | Gets a DataGridItem object that represents the selected item in the DataGrid control. |
|
|
SelectedItemStyle | Gets the style properties of the currently selected item in the DataGrid control. |
|
|
ShowFooter | Gets or sets a value that indicates whether the footer is displayed in the DataGrid control. |
|
|
ShowHeader | Gets or sets a value that indicates whether the header is displayed in the DataGrid control. |
|
|
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
|
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) |
|
|
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) |
|
|
SupportsDisabledAttribute | Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from BaseDataList.) |
|
|
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) |
|
|
TagKey | Gets the HtmlTextWriterTag value for the DataGrid control. (Overrides WebControl.TagKey.) |
|
|
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) |
|
|
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
|
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
|
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) |
|
|
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
|
UseAccessibleHeader | Gets or sets a value indicating whether the data listing control renders its header in an accessible format. This property is provided to make the control more accessible to users of assistive technology devices. (Inherited from BaseDataList.) |
|
|
ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) |
|
|
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
|
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) |
|
|
VirtualItemCount | Gets or sets the virtual number of items in the DataGrid control when custom paging is used. |
|
|
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
|
|
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
Methods
| Name | Description | |
|---|---|---|
|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
|
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection collection. (Inherited from BaseDataList.) |
|
|
ApplyStyle | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.) |
|
|
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
|
|
BuildProfileTree | Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) |
|
|
ClearCachedClientID | Infrastructure. Sets the cached ClientID value to null. (Inherited from Control.) |
|
|
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
|
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
|
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
|
ClearEffectiveClientIDMode | Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) |
|
|
CopyBaseAttributes | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
CreateChildControls | Infrastructure. Creates a child control using the view state. (Inherited from BaseDataList.) |
|
|
CreateColumnSet | Creates the set of columns to be used to build up the control hierarchy. When AutoGenerateColumns is true, the columns are created to match the data source and are appended to the set of columns defined in the Columns collection. |
|
|
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) |
|
|
CreateControlHierarchy | Creates the control hierarchy that is used to render the DataGrid. (Overrides BaseDataList.CreateControlHierarchy(Boolean).) |
|
|
CreateControlStyle | Creates new control style. (Overrides WebControl.CreateControlStyle().) |
|
|
CreateDataSourceSelectArguments | Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified. (Inherited from BaseDataList.) |
|
|
CreateItem | Creates a DataGridItem object. |
|
|
DataBind() | Binds the control and all its child controls to the specified data source. (Inherited from BaseDataList.) |
|
|
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) |
|
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
|
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
|
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
|
EnsureDataBound | Verifies that the data listing control requires data binding and that a valid data source control is specified before calling the DataBind method. (Inherited from BaseDataList.) |
|
|
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) |
|
|
FindControl(String, Int32) | Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) |
|
|
Focus | Sets input focus to a control. (Inherited from Control.) |
|
|
GetData | Returns an IEnumerable-implemented object that represents the data source. (Inherited from BaseDataList.) |
|
|
GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
|
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
|
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
|
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
|
|
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
|
|
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
|
InitializeItem | Initializes the specified DataGridItem object. |
|
|
InitializePager | Creates a DataGridItem object that contains the paging UI. |
|
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
|
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
|
|
LoadViewState | Loads a saved state of the DataGrid. (Overrides WebControl.LoadViewState(Object).) |
|
|
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
MergeStyle | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
OnBubbleEvent | Passes the event raised by a control within the container up the page's UI server control hierarchy. (Overrides Control.OnBubbleEvent(Object, EventArgs).) |
|
|
OnCancelCommand | Raises the CancelCommand event. This allows you to provide a custom handler for the event. |
|
|
OnDataBinding | Infrastructure. Raises the DataBinding event of a BaseDataList control. (Inherited from BaseDataList.) |
|
|
OnDataPropertyChanged | Called when one of the base data source identification properties is changed, to rebind the data-bound control to its data. (Inherited from BaseDataList.) |
|
|
OnDataSourceViewChanged | Raises the DataSourceViewChanged event. (Inherited from BaseDataList.) |
|
|
OnDeleteCommand | Raises the DeleteCommand event. This allows you to provide a custom handler for the event. |
|
|
OnEditCommand | Raises the EditCommand event. This allows you to provide a custom handler for the event. |
|
|
OnInit | Infrastructure. Raises the Init event for the BaseDataList control. (Inherited from BaseDataList.) |
|
|
OnItemCommand | Raises the ItemCommand event. This allows you to provide a custom handler for the event. |
|
|
OnItemCreated | Raises the ItemCreated event. This allows you to provide a custom handler for the event. |
|
|
OnItemDataBound | Raises the ItemDataBound event. This allows you to provide a custom handler for the event. |
|
|
OnLoad | Infrastructure. Raises the Load event. (Inherited from BaseDataList.) |
|
|
OnPageIndexChanged | Raises the PageIndexChanged event. This allows you to provide a custom handler for the event. |
|
|
OnPreRender | Infrastructure. Raises the PreRender event. (Inherited from BaseDataList.) |
|
|
OnSelectedIndexChanged | Raises the SelectedIndexChanged event of a BaseDataList control. (Inherited from BaseDataList.) |
|
|
OnSortCommand | Raises the SortCommand event. This allows you to provide a custom handler for the event. |
|
|
OnUnload | Raises the Unload event. (Inherited from Control.) |
|
|
OnUpdateCommand | Raises the UpdateCommand event. This allows you to provide a custom handler for the event. |
|
|
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
|
PrepareControlHierarchy | Infrastructure. Sets up the control hierarchy for this DataGrid control. (Overrides BaseDataList.PrepareControlHierarchy().) |
|
|
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
|
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
|
Render | Infrastructure. Renders the control to the specified HTML writer. (Inherited from BaseDataList.) |
|
|
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
|
|
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) |
|
|
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) |
|
|
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
|
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
|
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
|
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
|
|
SaveViewState | Saves the current state of the DataGrid. (Overrides WebControl.SaveViewState().) |
|
|
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
|
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
|
TrackViewState | Marks the starting point to begin tracking and saving changes to the control as part of the control view state. (Overrides WebControl.TrackViewState().) |
Events
| Name | Description | |
|---|---|---|
|
CancelCommand | Occurs when the Cancel button is clicked for an item in the DataGrid control. |
|
|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
|
DeleteCommand | Occurs when the Delete button is clicked for an item in the DataGrid control. |
|
|
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
|
|
EditCommand | Occurs when the Edit button is clicked for an item in the DataGrid control. |
|
|
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
|
ItemCommand | Occurs when any button is clicked in the DataGrid control. |
|
|
ItemCreated | Occurs on the server when an item in the DataGrid control is created. |
|
|
ItemDataBound | Occurs after an item is data bound to the DataGrid control. |
|
|
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
|
PageIndexChanged | Occurs when one of the page selection elements is clicked. |
|
|
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
|
SelectedIndexChanged | Occurs when a different item is selected in a data listing control between posts to the server. (Inherited from BaseDataList.) |
|
|
SortCommand | Occurs when a column is sorted. |
|
|
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
|
|
UpdateCommand | Occurs when the Update button is clicked for an item in the DataGrid control. |
Extension Methods
| Name | Description | |
|---|---|---|
|
EnableDynamicData(Type) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
|
|
EnableDynamicData(Type, Object) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
|
|
EnableDynamicData(Type, IDictionary<String, Object>) | Overloaded. Enables Dynamic Data behavior for the specified data control. (Defined by DataControlExtensions.) |
|
|
FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
|
FindFieldTemplate | Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
|
FindMetaTable | Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.) |
|
|
GetDefaultValues | Gets the collection of the default values for the specified data control. (Defined by DynamicDataExtensions.) |
|
|
GetMetaTable | Gets the table metadata for the specified data control. (Defined by DynamicDataExtensions.) |
|
|
SetMetaTable(MetaTable) | Overloaded. Sets the table metadata for the specified data control. (Defined by DynamicDataExtensions.) |
|
|
SetMetaTable(MetaTable, IDictionary<String, Object>) | Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.) |
|
|
SetMetaTable(MetaTable, Object) | Overloaded. Sets the table metadata and default value mapping for the specified data control. (Defined by DynamicDataExtensions.) |
|
|
TryGetMetaTable | Determines whether table metadata is available. (Defined by DynamicDataExtensions.) |
Fields
| Name | Description | |
|---|---|---|
|
CancelCommandName | Represents the Cancel command name. This field is read-only. |
|
|
DeleteCommandName | Represents the Delete command name. This field is read-only. |
|
|
EditCommandName | Represents the Edit command name. This field is read-only. |
|
|
NextPageCommandArgument | Represents the Next command argument. This field is read-only. |
|
|
PageCommandName | Represents the Page command name. This field is read-only. |
|
|
PrevPageCommandArgument | Represents the Prev command argument. This field is read-only. |
|
|
SelectCommandName | Represents the Select command name. This field is read-only. |
|
|
SortCommandName | Represents the Sort command name. This field is read-only. |
|
|
UpdateCommandName | Represents the Update command name. This field is read-only. |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
|
IAttributeAccessor.GetAttribute | Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.) |
|
|
IAttributeAccessor.SetAttribute | Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.) |
|
IControlBuilderAccessor.ControlBuilder | For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.) |
|
|
IControlDesignerAccessor.GetDesignModeState | For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetDesignModeState | For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.) |
|
|
IControlDesignerAccessor.UserData | For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.) |
|
|
IDataBindingsAccessor.DataBindings | For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.) |
|
|
IDataBindingsAccessor.HasDataBindings | For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.) |
|
|
IExpressionsAccessor.Expressions | For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.) |
|
|
IExpressionsAccessor.HasExpressions | For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.) |
|
|
IParserAccessor.AddParsedSubObject | For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.) |
Remarks
In this topic:
Introduction
Use the DataGrid control to display the fields of a data source as columns in a table. Each row in the DataGrid control represents a record in the data source. The DataGrid control supports selection, editing, deleting, paging, and sorting.
Caution
|
|---|
|
This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see Validation Server Control Syntax. |
Different column types determine the behavior of the columns in the control. The following table lists the different column types that can be used.
|
Column Type |
Description |
|---|---|
|
Displays a column bound to a field in a data source. It displays each item in the field as text. This is the default column type of the DataGrid control. |
|
|
Displays a command button for each item in the column. This allows you to create a column of custom button controls, such as Add or Remove buttons. |
|
|
Displays a column that contains editing commands for each item in the column. |
|
|
Displays the contents of each item in the column as a hyperlink. The contents of the column can be bound to a field in a data source or static text. |
|
|
Displays each item in the column following a specified template. This allows you to provide custom controls in the column. |
By default, the AutoGenerateColumns property is set to true, which creates a BoundColumn object for each field in the data source. Each field is then rendered as a column in the DataGrid control in the order that each field appears in the data source.
You can also manually control which columns appear in the DataGrid control by setting the AutoGenerateColumns property to false and then listing the columns that you want to include between the opening and closing <Columns> tags. The columns specified are added to the Columns collection in the order listed. This allows you to programmatically control the columns in the DataGrid control.
Note
|
|---|
|
The order that the columns are displayed in the DataGrid control is controlled by the order that the columns appear in the Columns collection. Although you can programmatically change the order of the columns by manipulating the Columns collection, it is easier to list the columns in the desired display order. |
Explicitly declared columns can be displayed in conjunction with automatically generated columns. When using both, explicitly declared columns will be rendered first, followed by the automatically generated columns.
|
Note
|
|---|
|
Automatically generated columns are not added to the Columns collection. |
The appearance of the DataGrid control may be customized by setting the style properties for the different parts of the control. The following table lists the different style properties.
|
Style Property |
Description |
|---|---|
|
Specifies the style for alternating items in the DataGrid control. |
|
|
Specifies the style for the item being edited in the DataGrid control. |
|
|
Specifies the style for the footer section in the DataGrid control. |
|
|
Specifies the style for the header section in the DataGrid control. |
|
|
Specifies the style for the items in the DataGrid control. |
|
|
Specifies the style for the page selection section of the DataGrid control. |
|
|
Specifies the style for the selected item in the DataGrid control. |
You can also show or hide different parts of the control. The following table lists the properties that control which parts are shown or hidden.
|
Property |
Description |
|---|---|
|
Shows or hides the footer section of the DataGrid control. |
|
|
Shows or hides the header section of the DataGrid control. |
You can control the appearance of the DataGrid control by programmatically adding attributes to the <td> and <tr> tags rendered by the control on the browser. Attributes can be programmatically added by providing code in the event handler for the OnItemCreated or OnItemDataBound event.
To add an attribute to the <td> tag, first get the TableCell object that represents the cell in the DataGrid control you want to add the attribute to. The Control.Controls collection for the Item property of the DataGridItemEventArgs object passed into the event handler can be used to get the desired TableCell object. You can then use the AttributeCollection.Add method of the Attributes collection for the TableCell object to add attributes to the <td> tag.
To add an attribute to the <tr> tag, first get the DataGridItem object that represents the row in the DataGrid control you want to add the attribute to. The Item property of the DataGridItemEventArgs object passed into the event handler can be used to get the desired DataGridItem object. You can then use the AttributeCollection.Add method of the Attributes collection for the DataGridItem object to add attributes to the <tr> tag.
Accessibility
For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.
Declarative Syntax
<asp:DataGrid
AccessKey="string"
AllowCustomPaging="True|False"
AllowPaging="True|False"
AllowSorting="True|False"
AutoGenerateColumns="True|False"
BackColor="color name|#dddddd"
BackImageUrl="uri"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
Inset|Outset"
BorderWidth="size"
Caption="string"
CaptionAlign="NotSet|Top|Bottom|Left|Right"
CellPadding="integer"
CellSpacing="integer"
CssClass="string"
DataKeyField="string"
DataMember="string"
DataSource="string"
DataSourceID="string"
EditItemIndex="integer"
Enabled="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
GridLines="None|Horizontal|Vertical|Both"
Height="size"
HorizontalAlign="NotSet|Left|Center|Right|Justify"
ID="string"
OnCancelCommand="CancelCommand event handler"
OnDataBinding="DataBinding event handler"
OnDeleteCommand="DeleteCommand event handler"
OnDisposed="Disposed event handler"
OnEditCommand="EditCommand event handler"
OnInit="Init event handler"
OnItemCommand="ItemCommand event handler"
OnItemCreated="ItemCreated event handler"
OnItemDataBound="ItemDataBound event handler"
OnLoad="Load event handler"
OnPageIndexChanged="PageIndexChanged event handler"
OnPreRender="PreRender event handler"
OnSelectedIndexChanged="SelectedIndexChanged event handler"
OnSortCommand="SortCommand event handler"
OnUnload="Unload event handler"
OnUpdateCommand="UpdateCommand event handler"
PageSize="integer"
runat="server"
SelectedIndex="integer"
ShowFooter="True|False"
ShowHeader="True|False"
SkinID="string"
Style="string"
TabIndex="integer"
ToolTip="string"
UseAccessibleHeader="True|False"
Visible="True|False"
Width="size"
>
<AlternatingItemStyle />
<Columns>
<asp:BoundColumn
DataField="string"
DataFormatString="string"
FooterText="string"
HeaderImageUrl="uri"
HeaderText="string"
ReadOnly="True|False"
SortExpression="string"
Visible="True|False"
>
<FooterStyle />
<HeaderStyle />
<ItemStyle />
</asp:BoundColumn>
<asp:ButtonColumn
ButtonType="LinkButton|PushButton"
CausesValidation="True|False"
CommandName="string"
DataTextField="string"
DataTextFormatString="string"
FooterText="string"
HeaderImageUrl="uri"
HeaderText="string"
SortExpression="string"
Text="string"
ValidationGroup="string"
Visible="True|False"
>
<FooterStyle />
<HeaderStyle />
<ItemStyle />
</asp:ButtonColumn>
<asp:EditCommandColumn
ButtonType="LinkButton|PushButton"
CancelText="string"
CausesValidation="True|False"
EditText="string"
FooterText="string"
HeaderImageUrl="uri"
HeaderText="string"
SortExpression="string"
UpdateText="string"
ValidationGroup="string"
Visible="True|False"
>
<FooterStyle />
<HeaderStyle />
<ItemStyle />
</asp:EditCommandColumn>
<asp:HyperLinkColumn
DataNavigateUrlField="string"
DataNavigateUrlFormatString="string"
DataTextField="string"
DataTextFormatString="string"
FooterText="string"
HeaderImageUrl="uri"
HeaderText="string"
NavigateUrl="uri"
SortExpression="string"
Target="string|_blank|_parent|_search|_self|_top"
Text="string"
Visible="True|False"
>
<FooterStyle />
<HeaderStyle />
<ItemStyle />
</asp:HyperLinkColumn>
<asp:TemplateColumn
FooterText="string"
HeaderImageUrl="uri"
HeaderText="string"
SortExpression="string"
Visible="True|False"
>
<FooterStyle />
<HeaderStyle />
<ItemStyle />
<EditItemTemplate>
<!-- child controls -->
</EditItemTemplate>
<FooterTemplate>
<!-- child controls -->
</FooterTemplate>
<HeaderTemplate>
<!-- child controls -->
</HeaderTemplate>
<ItemTemplate>
<!-- child controls -->
</ItemTemplate>
</asp:TemplateColumn>
</Columns>
<EditItemStyle />
<FooterStyle />
<HeaderStyle />
<ItemStyle />
<PagerStyle
BackColor="color name|#dddddd"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|
Groove|Ridge|Inset|Outset"
BorderWidth="size"
CssClass="string"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|
Medium|Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
Height="size"
HorizontalAlign="NotSet|Left|Center|Right|Justify"
Mode="NextPrev|NumericPages"
NextPageText="string"
OnDisposed="Disposed event handler"
PageButtonCount="integer"
Position="Bottom|Top|TopAndBottom"
PrevPageText="string"
VerticalAlign="NotSet|Top|Middle|Bottom"
Visible="True|False"
Width="size"
Wrap="True|False"
/>
<SelectedItemStyle />
</asp:DataGrid>
Examples
A Visual Studio Web site project with source code is available to accompany this topic: Download.
The following code example demonstrates how to use the DataGrid control to display the items in the data source.
Visual Basic
<%@ Page Language="VB" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script language="VB" runat="server"> Function CreateDataSource() As ICollection Dim dt As New DataTable() Dim dr As DataRow dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32))) dt.Columns.Add(New DataColumn("StringValue", GetType(String))) dt.Columns.Add(New DataColumn("CurrencyValue", GetType(Double))) Dim i As Integer For i = 0 To 8 dr = dt.NewRow() dr(0) = i dr(1) = "Item " + i.ToString() dr(2) = 1.23 *(i + 1) dt.Rows.Add(dr) Next i Dim dv As New DataView(dt) Return dv End Function 'CreateDataSource Sub Page_Load(sender As Object, e As EventArgs) If Not IsPostBack Then ' Load this data only once. ItemsGrid.DataSource = CreateDataSource() ItemsGrid.DataBind() End If End Sub 'Page_Load </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="true" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> </asp:DataGrid> </form> </body> </html>
C#
<%@ Page Language="C#" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script language="C#" runat="server"> ICollection CreateDataSource() { DataTable dt = new DataTable(); DataRow dr; dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32))); dt.Columns.Add(new DataColumn("StringValue", typeof(string))); dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double))); for (int i = 0; i < 9; i++) { dr = dt.NewRow(); dr[0] = i; dr[1] = "Item " + i.ToString(); dr[2] = 1.23 * (i + 1); dt.Rows.Add(dr); } DataView dv = new DataView(dt); return dv; } void Page_Load(Object sender, EventArgs e) { if (!IsPostBack) { // Load this data only once. ItemsGrid.DataSource= CreateDataSource(); ItemsGrid.DataBind(); } } </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="true" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> </asp:DataGrid> </form> </body> </html>
The following code example demonstrates how to use the DataGrid control for a simple shopping cart.
Visual Basic
<%@ Page Language="VB" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script language="VB" runat="server"> Dim Cart As DataTable Dim CartView As DataView Function CreateDataSource() As ICollection Dim dt As New DataTable() Dim dr As DataRow dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32))) dt.Columns.Add(New DataColumn("StringValue", GetType(String))) dt.Columns.Add(New DataColumn("CurrencyValue", GetType(Double))) Dim i As Integer For i = 0 To 8 dr = dt.NewRow() dr(0) = i dr(1) = "Item " + i.ToString() dr(2) = 1.23 *(i + 1) dt.Rows.Add(dr) Next i Dim dv As New DataView(dt) Return dv End Function 'CreateDataSource Sub Page_Load(sender As Object, e As EventArgs) If Session("DG4_ShoppingCart") Is Nothing Then Cart = New DataTable() Cart.Columns.Add(New DataColumn("Item", GetType(String))) Cart.Columns.Add(New DataColumn("Price", GetType(String))) Session("DG4_ShoppingCart") = Cart Else Cart = CType(Session("DG4_ShoppingCart"), DataTable) End If CartView = New DataView(Cart) ShoppingCart.DataSource = CartView ShoppingCart.DataBind() If Not IsPostBack Then ' Load this data only once. ItemsGrid.DataSource = CreateDataSource() ItemsGrid.DataBind() End If End Sub 'Page_Load Sub Grid_CartCommand(sender As Object, e As DataGridCommandEventArgs) Dim dr As DataRow = Cart.NewRow() ' e.Item is the table row where the command is raised. ' For bound columns, the value is stored in the Text property of the TableCell. Dim itemCell As TableCell = e.Item.Cells(2) Dim priceCell As TableCell = e.Item.Cells(3) Dim item As String = itemCell.Text Dim price As String = priceCell.Text If CType(e.CommandSource, Button).CommandName = "AddToCart" Then dr(0) = item dr(1) = price Cart.Rows.Add(dr) Else 'Remove from Cart. CartView.RowFilter = "Item" + ChrW(61) + "'" + item + "'" If CartView.Count > 0 Then CartView.Delete(0) End If CartView.RowFilter = "" End If ShoppingCart.DataBind() End Sub 'Grid_CartCommand </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <table cellpadding="5"> <tr valign="top"> <td> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="false" OnItemCommand="Grid_CartCommand" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <Columns> <asp:ButtonColumn HeaderText="Add to cart" ButtonType="PushButton" Text="Add" CommandName="AddToCart" /> <asp:ButtonColumn HeaderText="Remove from cart" ButtonType="PushButton" Text="Remove" CommandName="RemoveFromCart" /> <asp:BoundColumn HeaderText="Item" DataField="StringValue"/> <asp:BoundColumn HeaderText="Price" DataField="CurrencyValue" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="right"> </ItemStyle> </asp:BoundColumn> </Columns> </asp:DataGrid> </td> <td> <b>Shopping Cart</b> <asp:DataGrid id="ShoppingCart" runat="server" BorderColor="black" BorderWidth="1" GridLines="Both" ShowFooter="false" CellPadding="3" CellSpacing="0"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> </asp:DataGrid> </td> </tr> </table> </form> </body> </html>
C#
<%@ Page Language="C#" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script language="C#" runat="server"> DataTable Cart; DataView CartView; ICollection CreateDataSource() { DataTable dt = new DataTable(); DataRow dr; dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32))); dt.Columns.Add(new DataColumn("StringValue", typeof(string))); dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double))); for (int i = 0; i < 9; i++) { dr = dt.NewRow(); dr[0] = i; dr[1] = "Item " + i.ToString(); dr[2] = 1.23 * (i + 1); dt.Rows.Add(dr); } DataView dv = new DataView(dt); return dv; } void Page_Load(Object sender, EventArgs e) { if (Session["DG4_ShoppingCart"] == null) { Cart = new DataTable(); Cart.Columns.Add(new DataColumn("Item", typeof(string))); Cart.Columns.Add(new DataColumn("Price", typeof(string))); Session["DG4_ShoppingCart"] = Cart; } else { Cart = (DataTable)Session["DG4_ShoppingCart"]; } CartView = new DataView(Cart); ShoppingCart.DataSource = CartView; ShoppingCart.DataBind(); if (!IsPostBack) { // Load this data only once. ItemsGrid.DataSource= CreateDataSource(); ItemsGrid.DataBind(); } } void Grid_CartCommand(Object sender, DataGridCommandEventArgs e) { DataRow dr = Cart.NewRow(); // e.Item is the table row where the command is raised. // For bound columns, the value is stored in the Text property of the TableCell. TableCell itemCell = e.Item.Cells[2]; TableCell priceCell = e.Item.Cells[3]; string item = itemCell.Text; string price = priceCell.Text; if (((Button)e.CommandSource).CommandName == "AddToCart") { dr[0] = item; dr[1] = price; Cart.Rows.Add(dr); } else { // Remove from Cart. CartView.RowFilter = "Item='" + item + "'"; if (CartView.Count > 0) { CartView.Delete(0); } CartView.RowFilter = ""; } ShoppingCart.DataBind(); } </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <table cellpadding="5"> <tr valign="top"> <td> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="false" OnItemCommand="Grid_CartCommand" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <Columns> <asp:ButtonColumn HeaderText="Add to cart" ButtonType="PushButton" Text="Add" CommandName="AddToCart" /> <asp:ButtonColumn HeaderText="Remove from cart" ButtonType="PushButton" Text="Remove" CommandName="RemoveFromCart" /> <asp:BoundColumn HeaderText="Item" DataField="StringValue"/> <asp:BoundColumn HeaderText="Price" DataField="CurrencyValue" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="right"> </ItemStyle> </asp:BoundColumn> </Columns> </asp:DataGrid> </td> <td> <b>Shopping Cart</b> <asp:DataGrid id="ShoppingCart" runat="server" BorderColor="black" BorderWidth="1" GridLines="Both" ShowFooter="false" CellPadding="3" CellSpacing="0"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> </asp:DataGrid> </td> </tr> </table> </form> </body> </html>
The following code example demonstrates how to dynamically add attributes to the <td> and <tr> tags generated by the DataGrid control.
Visual Basic
<%@ Page Language="VB" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script runat="server"> Function CreateDataSource() As ICollection Dim dt As DataTable = New DataTable() Dim dr As DataRow Dim i As Integer Dim dv As DataView dt.Columns.Add(New DataColumn("IntegerValue", GetType(Integer))) dt.Columns.Add(New DataColumn("StringValue", GetType(String))) dt.Columns.Add(New DataColumn("CurrencyValue", GetType(Double))) For i = 0 to 4 dr = dt.NewRow() dr(0) = i dr(1) = "Item " + i.ToString() dr(2) = 1.23 * (i+1) dt.Rows.Add(dr) Next i dv = New DataView(dt) CreateDataSource = dv End Function Sub Page_Load(sender As Object, e As EventArgs) If Not IsPostBack ' Load this data only once. ItemsGrid.DataSource = CreateDataSource() ItemsGrid.DataBind() End If End Sub Sub Item_Bound(sender As Object, e As DataGridItemEventArgs) Dim itemType As ListItemType Dim intCell As TableCell itemType = CType(e.Item.ItemType, ListItemType) If (itemType <> ListItemType.Header) And _ (itemType <> ListItemType.Footer) And _ (itemType <> ListItemType.Separator) Then ' Get the IntegerValue cell from the grid's column collection. intCell = CType(e.Item.Controls(0), TableCell) ' Add attributes to the cell. intCell.Attributes.Add("id", "intCell" + e.Item.ItemIndex.ToString()) intCell.Attributes.Add("OnClick", _ "Update_intCell" + _ e.Item.ItemIndex.ToString() + _ "()") ' Add attributes to the row. e.Item.Attributes.Add("id", "row" + e.Item.ItemIndex.ToString()) e.Item.Attributes.Add("OnDblClick", _ "Update_row" + _ e.Item.ItemIndex.ToString() + _ "()") End If End Sub </script> <script type="text/vbscript"> sub Update_intCell0 Alert "You Selected Cell 0." end sub sub Update_intCell1 Alert "You Selected Cell 1." end sub sub Update_intCell2 Alert "You Selected Cell 2." end sub sub Update_intCell3 Alert "You Selected Cell 3." end sub sub Update_intCell4 Alert "You Selected Cell 4." end sub sub UpDate_row0 Alert "You selected the row 0." end sub sub UpDate_row1 Alert "You selected the row 1." end sub sub UpDate_row2 Alert "You selected the row 2." end sub sub UpDate_row3 Alert "You selected the row 3." end sub sub UpDate_row4 Alert "You selected the row 4." end sub </script> <head runat="server"> <title> Adding Attributes to the <td> and <tr> </title> </head> <body> <form id="form1" runat="server"> <h3> Adding Attributes to the <td> and <tr> <br /> Tags of a DataGrid Control </h3> <asp:DataGrid id="ItemsGrid" runat="server" BorderColor="black" BorderWidth="1" CellPadding="3" ShowFooter="true" OnItemDataBound="Item_Bound" AutoGenerateColumns="false"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <FooterStyle BackColor="#00aaaa"> </FooterStyle> <Columns> <asp:BoundColumn HeaderText="Number" DataField="IntegerValue"> <ItemStyle BackColor="yellow"> </ItemStyle> </asp:BoundColumn> <asp:BoundColumn HeaderText="Item" DataField="StringValue"/> <asp:BoundColumn HeaderText="Price" DataField="CurrencyValue" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="right"> </ItemStyle> </asp:BoundColumn> </Columns> </asp:DataGrid> <br /><br /> Click on one of the cells in the <b>Number</b> column to select the cell. <br /><br /> Double click on a row to select a row. </form> </body> </html>
C#
<%@ Page Language="C#" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script runat="server"> ICollection CreateDataSource() { DataTable dt = new DataTable(); DataRow dr; dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32))); dt.Columns.Add(new DataColumn("StringValue", typeof(string))); dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double))); for (int i = 0; i < 5; i++) { dr = dt.NewRow(); dr[0] = i; dr[1] = "Item " + i.ToString(); dr[2] = 1.23 * (i+1); dt.Rows.Add(dr); } DataView dv = new DataView(dt); return dv; } void Page_Load(Object sender, EventArgs e) { if (!IsPostBack) { // Load this data only once. ItemsGrid.DataSource = CreateDataSource(); ItemsGrid.DataBind(); } } void Item_Bound(Object sender, DataGridItemEventArgs e) { ListItemType itemType = (ListItemType)e.Item.ItemType; if ((itemType != ListItemType.Header) && (itemType != ListItemType.Footer) && (itemType != ListItemType.Separator)) { // Get the IntegerValue cell from the grid's column collection. TableCell intCell = (TableCell)e.Item.Controls[0]; // Add attributes to the cell. intCell.Attributes.Add("id", "intCell" + e.Item.ItemIndex.ToString()); intCell.Attributes.Add("OnClick", "Update_intCell" + e.Item.ItemIndex.ToString() + "()"); // Add attributes to the row. e.Item.Attributes.Add("id", "row" + e.Item.ItemIndex.ToString()); e.Item.Attributes.Add("OnDblClick", "Update_row" + e.Item.ItemIndex.ToString() + "()"); } } </script> <script type="text/vbscript"> sub Update_intCell0 Alert "You Selected Cell 0." end sub sub Update_intCell1 Alert "You Selected Cell 1." end sub sub Update_intCell2 Alert "You Selected Cell 2." end sub sub Update_intCell3 Alert "You Selected Cell 3." end sub sub Update_intCell4 Alert "You Selected Cell 4." end sub sub UpDate_row0 Alert "You selected the row 0." end sub sub UpDate_row1 Alert "You selected the row 1." end sub sub UpDate_row2 Alert "You selected the row 2." end sub sub UpDate_row3 Alert "You selected the row 3." end sub sub UpDate_row4 Alert "You selected the row 4." end sub </script> <head runat="server"> <title> Adding Attributes to the <td> and <tr> </title> </head> <body> <form id="form1" runat="server"> <h3> Adding Attributes to the <td> and <tr> <br /> Tags of a DataGrid Control </h3> <asp:DataGrid id="ItemsGrid" runat="server" BorderColor="black" BorderWidth="1" CellPadding="3" ShowFooter="true" OnItemDataBound="Item_Bound" AutoGenerateColumns="false"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <FooterStyle BackColor="#00aaaa"> </FooterStyle> <Columns> <asp:BoundColumn HeaderText="Number" DataField="IntegerValue"> <ItemStyle BackColor="yellow"> </ItemStyle> </asp:BoundColumn> <asp:BoundColumn HeaderText="Item" DataField="StringValue"/> <asp:BoundColumn HeaderText="Price" DataField="CurrencyValue" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="right"> </ItemStyle> </asp:BoundColumn> </Columns> </asp:DataGrid> <br /><br /> Click on one of the cells in the <b>Number</b> column to select the cell. <br /><br /> Double click on a row to select a row. </form> </body> </html>
Visual Basic
<%@ Page Language="VB" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script runat="server"> Function CreateDataSource() As ICollection ' Create sample data for the DataGrid control. Dim dt As DataTable = New DataTable() Dim dr As DataRow ' Define the columns of the table. dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32))) dt.Columns.Add(New DataColumn("StringValue", GetType(string))) dt.Columns.Add(New DataColumn("CurrencyValue", GetType(double))) ' Populate the table with sample values. Dim i As Integer For i = 0 to 8 dr = dt.NewRow() dr(0) = i dr(1) = "Item " & i.ToString() dr(2) = 1.23 * (i + 1) dt.Rows.Add(dr) Next i Dim dv As DataView = New DataView(dt) Return dv End Function Sub Page_Load(sender As Object, e As EventArgs) ' Load sample data only once when the page is first loaded. If Not IsPostBack Then ItemsGrid.DataSource = CreateDataSource() ItemsGrid.DataBind() End If End Sub Sub Button_Click(sender As Object, e As EventArgs) ' Count the number of selected items in the DataGrid control. Dim count As Integer = 0 ' Display the selected items. Message.Text = "You Selected: <br />" ' Iterate through each item (row) in the DataGrid control ' and determine whether it is selected. Dim item As DataGridItem For Each item In ItemsGrid.Items DetermineSelection(item, count) Next ' If no items are selected, display the appropriate message. If count = 0 Then Message.Text = "No items selected" End If End Sub Sub DetermineSelection(item As DataGridItem, ByRef count As Integer) ' Retrieve the SelectCheckBox CheckBox control from the specified ' item (row) in the DataGrid control. Dim selection As CheckBox = CType(item.FindControl("SelectCheckBox"), CheckBox) ' If the item is selected, display the appropriate message and ' increment the count of selected items. If Not selection Is Nothing Then If selection.Checked Then Message.Text &= "- " & item.Cells(1).Text & "<br />" count = count + 1 End If End If End Sub </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="False" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <Columns> <asp:BoundColumn DataField="IntegerValue" HeaderText="Item"/> <asp:BoundColumn DataField="StringValue" HeaderText="Description"/> <asp:BoundColumn DataField="CurrencyValue" HeaderText="Price" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="Right"> </ItemStyle> </asp:BoundColumn> <asp:TemplateColumn HeaderText="Select Item"> <ItemTemplate> <asp:CheckBox id="SelectCheckBox" Text="Add to Cart" Checked="False" runat="server"/> </ItemTemplate> </asp:TemplateColumn> </Columns> </asp:DataGrid> <br /><br /> <asp:Button id="SubmitButton" Text="Submit" OnClick = "Button_Click" runat="server"/> <br /><br /> <asp:Label id="Message" runat="server"/> </form> </body> </html>
C#
<%@ Page Language="C#" AutoEventWireup="True" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <script runat="server"> ICollection CreateDataSource() { // Create sample data for the DataGrid control. DataTable dt = new DataTable(); DataRow dr; // Define the columns of the table. dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32))); dt.Columns.Add(new DataColumn("StringValue", typeof(string))); dt.Columns.Add(new DataColumn("CurrencyValue", typeof(double))); // Populate the table with sample values. for (int i = 0; i < 9; i++) { dr = dt.NewRow(); dr[0] = i; dr[1] = "Item " + i.ToString(); dr[2] = 1.23 * (i + 1); dt.Rows.Add(dr); } DataView dv = new DataView(dt); return dv; } void Page_Load(Object sender, EventArgs e) { // Load sample data only once when the page is first loaded. if (!IsPostBack) { ItemsGrid.DataSource = CreateDataSource(); ItemsGrid.DataBind(); } } void Button_Click(Object sender, EventArgs e) { // Count the number of selected items in the DataGrid control. int count = 0; // Display the selected times. Message.Text = "You Selected: <br />"; // Iterate through each item (row) in the DataGrid control and // determine whether it is selected. foreach (DataGridItem item in ItemsGrid.Items) { DetermineSelection(item, ref count); } // If no items are selected, display the appropriate message. if (count == 0) { Message.Text = "No items selected"; } } void DetermineSelection(DataGridItem item, ref int count) { // Retrieve the SelectCheckBox CheckBox control from the specified // item (row) in the DataGrid control. CheckBox selection = (CheckBox)item.FindControl("SelectCheckBox"); // If the item is selected, display the appropriate message and // increment the count of selected items. if (selection != null) { if (selection.Checked) { Message.Text += "- " + item.Cells[1].Text + "<br />"; count++; } } } </script> <head runat="server"> <title>DataGrid Example</title> </head> <body> <form id="form1" runat="server"> <h3>DataGrid Example</h3> <b>Product List</b> <asp:DataGrid id="ItemsGrid" BorderColor="black" BorderWidth="1" CellPadding="3" AutoGenerateColumns="False" runat="server"> <HeaderStyle BackColor="#00aaaa"> </HeaderStyle> <Columns> <asp:BoundColumn DataField="IntegerValue" HeaderText="Item"/> <asp:BoundColumn DataField="StringValue" HeaderText="Description"/> <asp:BoundColumn DataField="CurrencyValue" HeaderText="Price" DataFormatString="{0:c}"> <ItemStyle HorizontalAlign="Right"> </ItemStyle> </asp:BoundColumn> <asp:TemplateColumn HeaderText="Select Item"> <ItemTemplate> <asp:CheckBox id="SelectCheckBox" Text="Add to Cart" Checked="False" runat="server"/> </ItemTemplate> </asp:TemplateColumn> </Columns> </asp:DataGrid> <br /><br /> <asp:Button id="SubmitButton" Text="Submit" OnClick = "Button_Click" runat="server"/> <br /><br /> <asp:Label id="Message" runat="server"/> </form> </body> </html>
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.See Also