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.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataList
        System.Web.UI.WebControls.DataGrid

type DataGrid = 
    class
        inherit BaseDataList
        interface INamingContainer
    end

NameDescription
System_CAPS_pubmethodDataGrid()

Initializes a new instance of the DataGrid class.

NameDescription
System_CAPS_pubpropertyAccessKey

Gets or sets the access key that allows you to quickly navigate to the Web server control.(Inherited from WebControl.)

System_CAPS_protpropertyAdapter

Gets the browser-specific adapter for the control.(Inherited from Control.)

System_CAPS_pubpropertyAllowCustomPaging

Gets or sets a value that indicates whether custom paging is enabled.

System_CAPS_pubpropertyAllowPaging

Gets or sets a value that indicates whether paging is enabled.

System_CAPS_pubpropertyAllowSorting

Gets or sets a value that indicates whether sorting is enabled.

System_CAPS_pubpropertyAlternatingItemStyle

Gets the style properties for alternating items in the DataGrid control.

System_CAPS_pubpropertyAppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)

System_CAPS_pubpropertyAttributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.(Inherited from WebControl.)

System_CAPS_pubpropertyAutoGenerateColumns

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.

System_CAPS_pubpropertyBackColor

Gets or sets the background color of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyBackImageUrl

Gets or sets the URL of an image to display in the background of the DataGrid control.

System_CAPS_pubpropertyBindingContainer

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)

System_CAPS_pubpropertyBorderColor

Gets or sets the border color of the Web control.(Inherited from WebControl.)

System_CAPS_pubpropertyBorderStyle

Gets or sets the border style of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyBorderWidth

Gets or sets the border width of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyCaption

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.)

System_CAPS_pubpropertyCaptionAlign

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.)

System_CAPS_pubpropertyCellPadding

Gets or sets the amount of space between the contents of a cell and the cell's border.(Inherited from BaseDataList.)

System_CAPS_pubpropertyCellSpacing

Gets or sets the amount of space between cells.(Inherited from BaseDataList.)

System_CAPS_protpropertyChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)

System_CAPS_pubpropertyClientID

Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)

System_CAPS_pubpropertyClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)

System_CAPS_protpropertyClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)

System_CAPS_pubpropertyColumns

Gets a collection of objects that represent the columns of the DataGrid control.

System_CAPS_protpropertyContext

Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)

System_CAPS_pubpropertyControls

Gets a System.Web.UI.ControlCollection object that contains a collection of child controls in a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubpropertyControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubpropertyControlStyleCreated

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.)

System_CAPS_pubpropertyCssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.(Inherited from WebControl.)

System_CAPS_pubpropertyCurrentPageIndex

Gets or sets the index of the currently displayed page.

System_CAPS_pubpropertyDataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)

System_CAPS_pubpropertyDataKeyField

Gets or sets the key field in the data source specified by the DataSource property.(Inherited from BaseDataList.)

System_CAPS_pubpropertyDataKeys

Gets a DataKeyCollection object that stores the key values of each record in a data listing control.(Inherited from BaseDataList.)

System_CAPS_protpropertyDataKeysArray

Gets an ArrayList object that contains the key values of each record in a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubpropertyDataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)

System_CAPS_pubpropertyDataMember

Gets or sets the specific data member in a multimember data source to bind to a data listing control.(Inherited from BaseDataList.)

System_CAPS_pubpropertyDataSource

Gets or sets the source containing a list of values used to populate the items within the control.(Inherited from BaseDataList.)

System_CAPS_pubpropertyDataSourceID

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.)

System_CAPS_protpropertyDesignMode

Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)

System_CAPS_pubpropertyEditItemIndex

Gets or sets the index of an item in the DataGrid control to edit.

System_CAPS_pubpropertyEditItemStyle

Gets the style properties of the item selected for editing in the DataGrid control.

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)

System_CAPS_pubpropertyEnableTheming

Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)

System_CAPS_pubpropertyEnableViewState

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.)

System_CAPS_protpropertyEvents

Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)

System_CAPS_pubpropertyFont

Gets the font properties associated with the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyFooterStyle

Gets the style properties of the footer section in the DataGrid control.

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyGridLines

Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed.(Inherited from BaseDataList.)

System_CAPS_pubpropertyHasAttributes

Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)

System_CAPS_protpropertyHasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)

System_CAPS_pubpropertyHeaderStyle

Gets the style properties of the heading section in the DataGrid control.

System_CAPS_pubpropertyHeight

Gets or sets the height of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyHorizontalAlign

Gets or sets the horizontal alignment of a data listing control within its container.(Inherited from BaseDataList.)

System_CAPS_pubpropertyID

Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)

System_CAPS_protpropertyIdSeparator

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)

System_CAPS_protpropertyInitialized

Gets a value indicating whether the control has been initialized.(Inherited from BaseDataList.)

System_CAPS_protpropertyIsBoundUsingDataSourceID

Gets a value indicating whether the DataSourceID property is set.(Inherited from BaseDataList.)

System_CAPS_protpropertyIsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)

System_CAPS_protpropertyIsEnabled

Gets a value indicating whether the control is enabled.(Inherited from WebControl.)

System_CAPS_protpropertyIsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)

System_CAPS_protpropertyIsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)

System_CAPS_pubpropertyItems

Gets a collection of DataGridItem objects that represent the individual items in the DataGrid control.

System_CAPS_pubpropertyItemStyle

Gets the style properties of the items in the DataGrid control.

System_CAPS_protpropertyLoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)

System_CAPS_pubpropertyNamingContainer

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.)

System_CAPS_pubpropertyPage

Gets a reference to the Page instance that contains the server control.(Inherited from Control.)

System_CAPS_pubpropertyPageCount

Gets the total number of pages required to display the items in the DataGrid control.

System_CAPS_pubpropertyPagerStyle

Gets the style properties of the paging section of the DataGrid control.

System_CAPS_pubpropertyPageSize

Gets or sets the number of items to display on a single page of the DataGrid control.

System_CAPS_pubpropertyParent

Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)

System_CAPS_pubpropertyRenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)

System_CAPS_protpropertyRequiresDataBinding

Gets or sets a value indicating whether the data listing control needs to bind to its specified data source.(Inherited from BaseDataList.)

System_CAPS_protpropertySelectArguments

Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.(Inherited from BaseDataList.)

System_CAPS_pubpropertySelectedIndex

Gets or sets the index of the selected item in the DataGrid control.

System_CAPS_pubpropertySelectedItem

Gets a DataGridItem object that represents the selected item in the DataGrid control.

System_CAPS_pubpropertySelectedItemStyle

Gets the style properties of the currently selected item in the DataGrid control.

System_CAPS_pubpropertyShowFooter

Gets or sets a value that indicates whether the footer is displayed in the DataGrid control.

System_CAPS_pubpropertyShowHeader

Gets or sets a value that indicates whether the header is displayed in the DataGrid control.

System_CAPS_pubpropertySite

Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)

System_CAPS_pubpropertySkinID

Gets or sets the skin to apply to the control.(Inherited from WebControl.)

System_CAPS_pubpropertyStyle

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.)

System_CAPS_pubpropertySupportsDisabledAttribute

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.)

System_CAPS_pubpropertyTabIndex

Gets or sets the tab index of the Web server control.(Inherited from WebControl.)

System_CAPS_protpropertyTagKey

Gets the HtmlTextWriterTag value for the DataGrid control.(Overrides WebControl.TagKey.)

System_CAPS_protpropertyTagName

Gets the name of the control tag. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubpropertyTemplateControl

Gets or sets a reference to the template that contains this control. (Inherited from Control.)

System_CAPS_pubpropertyTemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)

System_CAPS_pubpropertyToolTip

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertyUniqueID

Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)

System_CAPS_pubpropertyUseAccessibleHeader

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.)

System_CAPS_pubpropertyValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)

System_CAPS_protpropertyViewState

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.)

System_CAPS_protpropertyViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)

System_CAPS_pubpropertyViewStateMode

Gets or sets the view-state mode of this control.(Inherited from Control.)

System_CAPS_pubpropertyVirtualItemCount

Gets or sets the virtual number of items in the DataGrid control when custom paging is used.

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.)

System_CAPS_pubpropertyWidth

Gets or sets the width of the Web server control.(Inherited from WebControl.)

NameDescription
System_CAPS_protmethodAddAttributesToRender(HtmlTextWriter)

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.)

System_CAPS_protmethodAddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodAddParsedSubObject(Object)

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.)

System_CAPS_pubmethodApplyStyle(Style)

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.)

System_CAPS_pubmethodApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)

System_CAPS_protmethodBeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethodBuildProfileTree(String, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_protmethodClearCachedClientID()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)

System_CAPS_protmethodClearChildControlState()

Deletes the control-state information for the server control's child controls. (Inherited from Control.)

System_CAPS_protmethodClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearChildViewState()

Deletes the view-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearEffectiveClientIDMode()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)

System_CAPS_pubmethodCopyBaseAttributes(WebControl)

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.)

System_CAPS_protmethodCreateChildControls()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a child control using the view state.(Inherited from BaseDataList.)

System_CAPS_protmethodCreateColumnSet(PagedDataSource, Boolean)

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.

System_CAPS_protmethodCreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.)

System_CAPS_protmethodCreateControlHierarchy(Boolean)

Creates the control hierarchy that is used to render the DataGrid.(Overrides BaseDataList.CreateControlHierarchy(Boolean).)

System_CAPS_protmethodCreateControlStyle()

Creates new control style.(Overrides WebControl.CreateControlStyle().)

System_CAPS_protmethodCreateDataSourceSelectArguments()

Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.(Inherited from BaseDataList.)

System_CAPS_protmethodCreateItem(Int32, Int32, ListItemType)

Creates a DataGridItem object.

System_CAPS_pubmethodDataBind()

Binds the control and all its child controls to the specified data source.(Inherited from BaseDataList.)

System_CAPS_protmethodDataBind(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.)

System_CAPS_protmethodDataBindChildren()

Binds a data source to the server control's child controls.(Inherited from Control.)

System_CAPS_pubmethodDispose()

Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)

System_CAPS_protmethodEndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethodEnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)

System_CAPS_protmethodEnsureDataBound()

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.)

System_CAPS_protmethodEnsureID()

Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindControl(String)

Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)

System_CAPS_protmethodFindControl(String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_pubmethodFocus()

Sets input focus to a control.(Inherited from Control.)

System_CAPS_protmethodGetData()

Returns an IEnumerable-implemented object that represents the data source.(Inherited from BaseDataList.)

System_CAPS_protmethodGetDesignModeState()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)

System_CAPS_pubmethodHasControls()

Determines if the server control contains any child controls.(Inherited from Control.)

System_CAPS_protmethodHasEvents()

Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)

System_CAPS_protmethodInitializeItem(DataGridItem, DataGridColumn[])

Initializes the specified DataGridItem object.

System_CAPS_protmethodInitializePager(DataGridItem, Int32, PagedDataSource)

Creates a DataGridItem object that contains the paging UI.

System_CAPS_protmethodIsLiteralContent()

This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)

System_CAPS_protmethodLoadControlState(Object)

Restores control-state information from a previous page request that was saved by the SaveControlState method.(Inherited from Control.)

System_CAPS_protmethodLoadViewState(Object)

Loads a saved state of the DataGrid.(Overrides WebControl.LoadViewState(Object).)

System_CAPS_protmethodMapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMergeStyle(Style)

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.)

System_CAPS_protmethodOnBubbleEvent(Object, EventArgs)

Passes the event raised by a control within the container up the page's UI server control hierarchy.(Overrides Control.OnBubbleEvent(Object, EventArgs).)

System_CAPS_protmethodOnCancelCommand(DataGridCommandEventArgs)

Raises the CancelCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnDataBinding(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the DataBinding event of a BaseDataList control.(Inherited from BaseDataList.)

System_CAPS_protmethodOnDataPropertyChanged()

Called when one of the base data source identification properties is changed, to rebind the data-bound control to its data.(Inherited from BaseDataList.)

System_CAPS_protmethodOnDataSourceViewChanged(Object, EventArgs)

Raises the DataSourceViewChanged event.(Inherited from BaseDataList.)

System_CAPS_protmethodOnDeleteCommand(DataGridCommandEventArgs)

Raises the DeleteCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnEditCommand(DataGridCommandEventArgs)

Raises the EditCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnInit(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Init event for the BaseDataList control.(Inherited from BaseDataList.)

System_CAPS_protmethodOnItemCommand(DataGridCommandEventArgs)

Raises the ItemCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnItemCreated(DataGridItemEventArgs)

Raises the ItemCreated event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnItemDataBound(DataGridItemEventArgs)

Raises the ItemDataBound event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnLoad(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Load event.(Inherited from BaseDataList.)

System_CAPS_protmethodOnPageIndexChanged(DataGridPageChangedEventArgs)

Raises the PageIndexChanged event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnPreRender(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the PreRender event.(Inherited from BaseDataList.)

System_CAPS_protmethodOnSelectedIndexChanged(EventArgs)

Raises the SelectedIndexChanged event of a BaseDataList control. (Inherited from BaseDataList.)

System_CAPS_protmethodOnSortCommand(DataGridSortCommandEventArgs)

Raises the SortCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOnUnload(EventArgs)

Raises the Unload event.(Inherited from Control.)

System_CAPS_protmethodOnUpdateCommand(DataGridCommandEventArgs)

Raises the UpdateCommand event. This allows you to provide a custom handler for the event.

System_CAPS_protmethodOpenFile(String)

Gets a Stream used to read a file.(Inherited from Control.)

System_CAPS_protmethodPrepareControlHierarchy()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets up the control hierarchy for this DataGrid control.(Overrides BaseDataList.PrepareControlHierarchy().)

System_CAPS_protmethodRaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)

System_CAPS_protmethodRemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodRender(HtmlTextWriter)

This API supports the product infrastructure and is not intended to be used directly from your code. Renders the control to the specified HTML writer.(Inherited from BaseDataList.)

System_CAPS_pubmethodRenderBeginTag(HtmlTextWriter)

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodRenderChildren(HtmlTextWriter)

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.)

System_CAPS_protmethodRenderContents(HtmlTextWriter)

Renders the contents of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubmethodRenderControl(HtmlTextWriter)

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)

System_CAPS_protmethodRenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)

System_CAPS_pubmethodRenderEndTag(HtmlTextWriter)

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodResolveAdapter()

Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)

System_CAPS_pubmethodResolveClientUrl(String)

Gets a URL that can be used by the browser.(Inherited from Control.)

System_CAPS_pubmethodResolveUrl(String)

Converts a URL into one that is usable on the requesting client.(Inherited from Control.)

System_CAPS_protmethodSaveControlState()

Saves any server control state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.)

System_CAPS_protmethodSaveViewState()

Saves the current state of the DataGrid.(Overrides WebControl.SaveViewState().)

System_CAPS_protmethodSetDesignModeState(IDictionary)

Sets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethodSetRenderMethodDelegate(RenderMethod)

This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)

System_CAPS_pubmethodSetTraceData(Object, Object)

Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.(Inherited from Control.)

System_CAPS_pubmethodSetTraceData(Object, Object, Object)

Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.(Inherited from Control.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTrackViewState()

Marks the starting point to begin tracking and saving changes to the control as part of the control view state.(Overrides WebControl.TrackViewState().)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCancelCommandName

Represents the Cancel command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticDeleteCommandName

Represents the Delete command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticEditCommandName

Represents the Edit command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticNextPageCommandArgument

Represents the Next command argument. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticPageCommandName

Represents the Page command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticPrevPageCommandArgument

Represents the Prev command argument. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticSelectCommandName

Represents the Select command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticSortCommandName

Represents the Sort command name. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticUpdateCommandName

Represents the Update command name. This field is read-only.

NameDescription
System_CAPS_pubeventCancelCommand

Occurs when the Cancel button is clicked for an item in the DataGrid control.

System_CAPS_pubeventDataBinding

Occurs when the server control binds to a data source.(Inherited from Control.)

System_CAPS_pubeventDeleteCommand

Occurs when the Delete button is clicked for an item in the DataGrid control.

System_CAPS_pubeventDisposed

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.)

System_CAPS_pubeventEditCommand

Occurs when the Edit button is clicked for an item in the DataGrid control.

System_CAPS_pubeventInit

Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)

System_CAPS_pubeventItemCommand

Occurs when any button is clicked in the DataGrid control.

System_CAPS_pubeventItemCreated

Occurs on the server when an item in the DataGrid control is created.

System_CAPS_pubeventItemDataBound

Occurs after an item is data bound to the DataGrid control.

System_CAPS_pubeventLoad

Occurs when the server control is loaded into the Page object.(Inherited from Control.)

System_CAPS_pubeventPageIndexChanged

Occurs when one of the page selection elements is clicked.

System_CAPS_pubeventPreRender

Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)

System_CAPS_pubeventSelectedIndexChanged

Occurs when a different item is selected in a data listing control between posts to the server.(Inherited from BaseDataList.)

System_CAPS_pubeventSortCommand

Occurs when a column is sorted.

System_CAPS_pubeventUnload

Occurs when the server control is unloaded from memory.(Inherited from Control.)

System_CAPS_pubeventUpdateCommand

Occurs when the Update button is clicked for an item in the DataGrid control.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAttributeAccessor.GetAttribute(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an attribute of the Web control with the specified name.(Inherited from WebControl.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.(Inherited from WebControl.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.GetDesignModeState()

For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetOwnerControl(Control)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIParserAccessor.AddParsedSubObject(Object)

For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlBuilderAccessor.ControlBuilder

For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlDesignerAccessor.UserData

For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.DataBindings

For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.HasDataBindings

For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.Expressions

For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.HasExpressions

For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)

NameDescription
System_CAPS_pubmethodEnableDynamicData(Type)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, IDictionary<String, Object>)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, Object)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodFindDataSourceControl()

Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindFieldTemplate(String)

Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindMetaTable()

Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetDefaultValues()

Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetMetaTable()

Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable)

Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, IDictionary<String, Object>)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, Object)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodTryGetMetaTable(MetaTable)

Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

In this topic:

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.

System_CAPS_cautionCaution

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

BoundColumn

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.

ButtonColumn

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.

EditCommandColumn

Displays a column that contains editing commands for each item in the column.

HyperLinkColumn

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.

TemplateColumn

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.

System_CAPS_noteNote

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.

System_CAPS_noteNote

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

AlternatingItemStyle

Specifies the style for alternating items in the DataGrid control.

EditItemStyle

Specifies the style for the item being edited in the DataGrid control.

FooterStyle

Specifies the style for the footer section in the DataGrid control.

HeaderStyle

Specifies the style for the header section in the DataGrid control.

ItemStyle

Specifies the style for the items in the DataGrid control.

PagerStyle

Specifies the style for the page selection section of the DataGrid control.

SelectedItemStyle

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

ShowFooter

Shows or hides the footer section of the DataGrid control.

ShowHeader

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.

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.

<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>

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.

No code example is currently available or this language may not be supported.

The following code example demonstrates how to use the DataGrid control for a simple shopping cart.

No code example is currently available or this language may not be supported.

The following code example demonstrates how to dynamically add attributes to the <td> and <tr> tags generated by the DataGrid control.

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: