Export (0) Print
Expand All
4 out of 6 rated this helpful - Rate this topic

DataGrid Members

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.

The DataGrid type exposes the following members.

  NameDescription
Public method DataGrid Initializes a new instance of the DataGrid class.
Top
  NameDescription
Protected method 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.)
Protected method AddedControl Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method 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.)
Public method 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.)
Public method ApplyStyleSheetSkin Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method 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.)
Protected method ClearChildControlState Deletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildState Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewState Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
Public method 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.)
Protected method CreateChildControls Infrastructure. Creates a child control using the view state. (Inherited from BaseDataList.)
Protected method 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.
Protected method CreateControlCollection Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected method CreateControlHierarchy Creates the control hierarchy that is used to render the DataGrid. (Overrides BaseDataList.CreateControlHierarchy(Boolean).)
Protected method CreateControlStyle Creates new control style. (Overrides WebControl.CreateControlStyle().)
Protected method CreateDataSourceSelectArguments Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified. (Inherited from BaseDataList.)
Protected method CreateItem Creates a DataGridItem object.
Public method DataBind Overloaded. Binds a data source to the invoked server control and all its child controls.
Protected method DataBindChildren Binds a data source to the server control's child controls. (Inherited from Control.)
Public method Dispose Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EnsureChildControls Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method 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.)
Protected method EnsureID Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl Overloaded. Searches the current naming container for the specified server control.
Public method Focus Sets input focus to a control. (Inherited from Control.)
Protected method GetData Returns an IEnumerable-implemented object that represents the data source. (Inherited from BaseDataList.)
Protected method GetDesignModeState Infrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method HasControls Determines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEvents Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method InitializeItem Initializes the specified DataGridItem object.
Protected method InitializePager Creates a DataGridItem object that contains the paging UI.
Protected method IsLiteralContent Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlState Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadViewState Loads a saved state of the DataGrid. (Overrides WebControl.LoadViewState(Object).)
Protected method MapPathSecure Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method 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.)
Protected method OnBubbleEvent Passes the event raised by a control within the container up the page's UI server control hierarchy. (Overrides Control.OnBubbleEvent(Object, EventArgs).)
Protected method OnCancelCommand Raises the CancelCommand event. This allows you to provide a custom handler for the event.
Protected method OnDataBinding Infrastructure. Raises the DataBinding event of a BaseDataList control. (Inherited from BaseDataList.)
Protected method 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.)
Protected method OnDataSourceViewChanged Raises the DataSourceViewChanged event. (Inherited from BaseDataList.)
Protected method OnDeleteCommand Raises the DeleteCommand event. This allows you to provide a custom handler for the event.
Protected method OnEditCommand Raises the EditCommand event. This allows you to provide a custom handler for the event.
Protected method OnInit Infrastructure. Raises the Init event for the BaseDataList control. (Inherited from BaseDataList.)
Protected method OnItemCommand Raises the ItemCommand event. This allows you to provide a custom handler for the event.
Protected method OnItemCreated Raises the ItemCreated event. This allows you to provide a custom handler for the event.
Protected method OnItemDataBound Raises the ItemDataBound event. This allows you to provide a custom handler for the event.
Protected method OnLoad Infrastructure. Raises the Load event. (Inherited from BaseDataList.)
Protected method OnPageIndexChanged Raises the PageIndexChanged event. This allows you to provide a custom handler for the event.
Protected method OnPreRender Infrastructure. Raises the PreRender event. (Inherited from BaseDataList.)
Protected method OnSelectedIndexChanged Raises the SelectedIndexChanged event of a BaseDataList control. (Inherited from BaseDataList.)
Protected method OnSortCommand Raises the SortCommand event. This allows you to provide a custom handler for the event.
Protected method OnUnload Raises the Unload event. (Inherited from Control.)
Protected method OnUpdateCommand Raises the UpdateCommand event. This allows you to provide a custom handler for the event.
Protected method OpenFile Gets a Stream used to read a file. (Inherited from Control.)
Protected method PrepareControlHierarchy Infrastructure. Sets up the control hierarchy for this DataGrid control. (Overrides BaseDataList.PrepareControlHierarchy().)
Protected method RaiseBubbleEvent Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RemovedControl Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method Render Infrastructure. Renders the control to the specified HTML writer. (Inherited from BaseDataList.)
Public method RenderBeginTag Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method 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.)
Protected method RenderContents Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public method RenderControl Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled.
Public method RenderEndTag Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method ResolveAdapter Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrl Gets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrl Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method SaveControlState Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewState Saves the current state of the DataGrid. (Overrides WebControl.SaveViewState().)
Protected method SetDesignModeState Sets design-time data for a control. (Inherited from Control.)
Public method SetRenderMethodDelegate Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewState Marks the starting point to begin tracking and saving changes to the control as part of the control view state. (Overrides WebControl.TrackViewState().)
Top
  NameDescription
Public Extension Method FindDataSourceControl Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplate Returns the field template for the specified column within the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTable Returns the MetaTable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  NameDescription
Public field Static member CancelCommandName Represents the Cancel command name. This field is read-only.
Public field Static member DeleteCommandName Represents the Delete command name. This field is read-only.
Public field Static member EditCommandName Represents the Edit command name. This field is read-only.
Public field Static member NextPageCommandArgument Represents the Next command argument. This field is read-only.
Public field Static member PageCommandName Represents the Page command name. This field is read-only.
Public field Static member PrevPageCommandArgument Represents the Prev command argument. This field is read-only.
Public field Static member SelectCommandName Represents the Select command name. This field is read-only.
Public field Static member SortCommandName Represents the Sort command name. This field is read-only.
Public field Static member UpdateCommandName Represents the Update command name. This field is read-only.
Top
  NameDescription
Public property AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property Adapter Gets the browser-specific adapter for the control. (Inherited from Control.)
Public property AllowCustomPaging Gets or sets a value that indicates whether custom paging is enabled.
Public property AllowPaging Gets or sets a value that indicates whether paging is enabled.
Public property AllowSorting Gets or sets a value that indicates whether sorting is enabled.
Public property AlternatingItemStyle Gets the style properties for alternating items in the DataGrid control.
Public property AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property 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.
Public property BackColor Gets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BackImageUrl Gets or sets the URL of an image to display in the background of the DataGrid control.
Public property BindingContainer Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColor Gets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderStyle Gets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidth Gets or sets the border width of the Web server control. (Inherited from WebControl.)
Public property 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.)
Public property 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.)
Public property CellPadding Gets or sets the amount of space between the contents of a cell and the cell's border. (Inherited from BaseDataList.)
Public property CellSpacing Gets or sets the amount of space between cells. (Inherited from BaseDataList.)
Protected property ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientID Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
Protected property ClientIDSeparator Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public property Columns Gets a collection of objects that represent the columns of the DataGrid control.
Protected property Context Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property Controls Gets a System.Web.UI.ControlCollection object that contains a collection of child controls in a data listing control. (Inherited from BaseDataList.)
Public property ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property 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.)
Public property CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property CurrentPageIndex Gets or sets the index of the currently displayed page.
Public property DataKeyField Gets or sets the key field in the data source specified by the DataSource property. (Inherited from BaseDataList.)
Public property DataKeys Gets a DataKeyCollection object that stores the key values of each record in a data listing control. (Inherited from BaseDataList.)
Protected property DataKeysArray Gets an ArrayList object that contains the key values of each record in a data listing control. (Inherited from BaseDataList.)
Public property DataMember Gets or sets the specific data member in a multimember data source to bind to a data listing control. (Inherited from BaseDataList.)
Public property DataSource Gets or sets the source containing a list of values used to populate the items within the control. (Inherited from BaseDataList.)
Public property 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.)
Protected property DesignMode Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property EditItemIndex Gets or sets the index of an item in the DataGrid control to edit.
Public property EditItemStyle Gets the style properties of the item selected for editing in the DataGrid control.
Public property Enabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableTheming Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property 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.)
Protected property Events Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property Font Gets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property FooterStyle Gets the style properties of the footer section in the DataGrid control.
Public property ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property GridLines Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed. (Inherited from BaseDataList.)
Public property HasAttributes Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property HeaderStyle Gets the style properties of the heading section in the DataGrid control.
Public property Height Gets or sets the height of the Web server control. (Inherited from WebControl.)
Public property HorizontalAlign Gets or sets the horizontal alignment of a data listing control within its container. (Inherited from BaseDataList.)
Public property ID Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparator Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected property Initialized Gets a value indicating whether the control has been initialized. (Inherited from BaseDataList.)
Protected property IsBoundUsingDataSourceID Gets a value indicating whether the DataSourceID property is set. (Inherited from BaseDataList.)
Protected property IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabled Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabled Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public property Items Gets a collection of DataGridItem objects that represent the individual items in the DataGrid control.
Public property ItemStyle Gets the style properties of the items in the DataGrid control.
Protected property LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property 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.)
Public property Page Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property PageCount Gets the total number of pages required to display the items in the DataGrid control.
Public property PagerStyle Gets the style properties of the paging section of the DataGrid control.
Public property PageSize Gets or sets the number of items to display on a single page of the DataGrid control.
Public property Parent Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Protected property RequiresDataBinding Gets or sets a value indicating whether the data listing control needs to bind to its specified data source. (Inherited from BaseDataList.)
Protected property SelectArguments Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from BaseDataList.)
Public property SelectedIndex Gets or sets the index of the selected item in the DataGrid control.
Public property SelectedItem Gets a DataGridItem object that represents the selected item in the DataGrid control.
Public property SelectedItemStyle Gets the style properties of the currently selected item in the DataGrid control.
Public property ShowFooter Gets or sets a value that indicates whether the footer is displayed in the DataGrid control.
Public property ShowHeader Gets or sets a value that indicates whether the header is displayed in the DataGrid control.
Public property Site Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinID Gets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property 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.)
Public property TabIndex Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKey Gets the HtmlTextWriterTag value for the DataGrid control. (Overrides WebControl.TagKey.)
Protected property TagName Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControl Gets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueID Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property 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.)
Protected property 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.)
Protected property ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property VirtualItemCount Gets or sets the virtual number of items in the DataGrid control when custom paging is used.
Public property Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property Width Gets or sets the width of the Web server control. (Inherited from WebControl.)
Top
  NameDescription
Public event CancelCommand Occurs when the Cancel button is clicked for an item in the DataGrid control.
Public event DataBinding Occurs when the server control binds to a data source. (Inherited from Control.)
Public event DeleteCommand Occurs when the Delete button is clicked for an item in the DataGrid control.
Public event 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.)
Public event EditCommand Occurs when the Edit button is clicked for an item in the DataGrid control.
Public event Init Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event ItemCommand Occurs when any button is clicked in the DataGrid control.
Public event ItemCreated Occurs on the server when an item in the DataGrid control is created.
Public event ItemDataBound Occurs after an item is data bound to the DataGrid control.
Public event Load Occurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event PageIndexChanged Occurs when one of the page selection elements is clicked.
Public event PreRender Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event SelectedIndexChanged Occurs when a different item is selected in a data listing control between posts to the server. (Inherited from BaseDataList.)
Public event SortCommand Occurs when a column is sorted.
Public event Unload Occurs when the server control is unloaded from memory. (Inherited from Control.)
Public event UpdateCommand Occurs when the Update button is clicked for an item in the DataGrid control.
Top
  NameDescription
Explicit interface implemetation Private method IParserAccessor.AddParsedSubObject For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Explicit interface implemetation Private property IControlBuilderAccessor.ControlBuilder For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.DataBindings For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.Expressions For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetation Private method IAttributeAccessor.GetAttribute Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IControlDesignerAccessor.GetDesignModeState For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.HasDataBindings For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.HasExpressions For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IAttributeAccessor.SetAttribute Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetDesignModeState For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetOwnerControl Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessor.UserData For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.