Export (0) Print
Expand All

DataGrid Members

DataGrid overview

Public Constructors

public constructorDataGrid Constructor Initializes a new instance of the DataGrid class.

Public Fields

public fieldstatic (Shared in Visual Basic)CancelCommandName Represents the Cancel command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)DeleteCommandName Represents the Delete command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)EditCommandName Represents the Edit command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)NextPageCommandArgument Represents the Next command argument. This field is read-only.
public fieldstatic (Shared in Visual Basic)PageCommandName Represents the Page command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)PrevPageCommandArgument Represents the Prev command argument. This field is read-only.
public fieldstatic (Shared in Visual Basic)SelectCommandName Represents the Select command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)SortCommandName Represents the Sort command name. This field is read-only.
public fieldstatic (Shared in Visual Basic)UpdateCommandName Represents the Update command name. This field is read-only.

Public Properties

public propertyAccessKey (inherited from WebControl) Gets or sets the access key (underlined letter) that allows you to quickly navigate to the Web server control.
public propertyAllowCustomPaging Gets or sets a value that indicates whether custom paging is enabled.
public propertyAllowPaging Gets or sets a value that indicates whether paging is enabled.
public propertyAllowSorting Gets or sets a value that indicates whether sorting is enabled.
public propertyAlternatingItemStyle Gets the style properties for alternating items in the DataGrid control.
public propertyAttributes (inherited from WebControl) Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
public propertyAutoGenerateColumns 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 propertyBackColor (inherited from WebControl) Gets or sets the background color of the Web server control.
public propertyBackImageUrl Gets or sets the URL of an image to display in the background of the DataGrid control.
public propertyBorderColor (inherited from WebControl) Gets or sets the border color of the Web control.
public propertyBorderStyle (inherited from WebControl) Gets or sets the border style of the Web server control.
public propertyBorderWidth (inherited from WebControl) Gets or sets the border width of the Web server control.
public propertyCellPadding (inherited from BaseDataList) Gets or sets the amount of space between the contents of a cell and the cell's border.
public propertyCellSpacing (inherited from BaseDataList) Gets or sets the amount of space between cells.
public propertyClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
public propertyColumns Gets a collection of objects that represent the columns of the DataGrid control.
public propertyControls (inherited from BaseDataList) Overridden. Gets a System.Web.UI.ControlCollection that contains a collection of child controls in a data listing control.
public propertyControlStyle (inherited from WebControl) Gets the style of the Web server control. This property is used primarily by control developers.
public propertyControlStyleCreated (inherited from WebControl) Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
public propertyCssClass (inherited from WebControl) Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
public propertyCurrentPageIndex Gets or sets the index of the currently displayed page.
public propertyDataKeyField (inherited from BaseDataList) Gets or sets the key field in the data source specified by the DataSource property.
public propertyDataKeys (inherited from BaseDataList) Gets a DataKeyCollection that stores the key values of each record (displayed as a row) in a data listing control.
public propertyDataMember (inherited from BaseDataList) Gets or sets the specific data member in a multimember data source to bind to a data listing control.
public propertyDataSource (inherited from BaseDataList) Gets or sets the source containing a list of values used to populate the items within the control.
public propertyEditItemIndex Gets or sets the index of an item in the DataGrid control to edit.
public propertyEditItemStyle Gets the style properties of the item selected for editing in the DataGrid control.
public propertyEnabled (inherited from WebControl) Gets or sets a value indicating whether the Web server control is enabled.
public propertyEnableViewState (inherited from Control) 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.
public propertyFont (inherited from WebControl) Gets the font properties associated with the Web server control.
public propertyFooterStyle Gets the style properties of the footer section in the DataGrid control.
public propertyForeColor (inherited from WebControl) Gets or sets the foreground color (typically the color of the text) of the Web server control.
public propertyGridLines (inherited from BaseDataList) Gets or sets a value that specifies whether the border between the cells of a data listing control is displayed.
public propertyHeaderStyle Gets the style properties of the heading section in the DataGrid control.
public propertyHeight (inherited from WebControl) Gets or sets the height of the Web server control.
public propertyHorizontalAlign (inherited from BaseDataList) Gets or sets the horizontal alignment of a data listing control within its container.
public propertyID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
public propertyItems Gets a collection of DataGridItem objects that represent the individual items in the DataGrid control.
public propertyItemStyle Gets the style properties of the items in the DataGrid control.
public propertyNamingContainer (inherited from Control) 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.
public propertyPage (inherited from Control) Gets a reference to the Page instance that contains the server control.
public propertyPageCount Gets the total number of pages required to display the items in the DataGrid control.
public propertyPagerStyle Gets the style properties of the paging section of the DataGrid control.
public propertyPageSize Gets or sets the number of items to display on a single page of the DataGrid control.
public propertyParent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
public propertySelectedIndex Gets or sets the index of the selected item in the DataGrid control.
public propertySelectedItem Gets a DataGridItem object that represents the selected item in the DataGrid control.
public propertySelectedItemStyle Gets the style properties of the currently selected item in the DataGrid control.
public propertyShowFooter Gets or sets a value that indicates whether the footer is displayed in the DataGrid control.
public propertyShowHeader Gets or sets a value that indicates whether the header is displayed in the DataGrid control.
public propertySite (inherited from Control) Gets information about the Web site to which the server control belongs.
public propertyStyle (inherited from WebControl) Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
public propertyTabIndex (inherited from WebControl) Gets or sets the tab index of the Web server control.
public propertyTemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
public propertyToolTip (inherited from WebControl) Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
public propertyUniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
public propertyVirtualItemCount Gets or sets the virtual number of items in the DataGrid control when custom paging is used.
public propertyVisible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.
public propertyWidth (inherited from WebControl) Gets or sets the width of the Web server control.

Public Methods

public methodApplyStyle (inherited from WebControl) 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.
public methodCopyBaseAttributes (inherited from 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.
public methodDataBind (inherited from BaseDataList) Overridden. Binds the control and all its child controls to the data source specified by the DataSource property.
public methodDispose (inherited from Control) Enables a server control to perform final clean up before it is released from memory.
public methodEquals (inherited from Object) Overloaded. Determines whether two Object instances are equal.
public methodFindControl (inherited from Control) Overloaded. Searches the current naming container for the specified server control.
public methodGetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
public methodGetType (inherited from Object) Gets the Type of the current instance.
public methodHasControls (inherited from Control) Determines if the server control contains any child controls.
public methodMergeStyle (inherited from WebControl) 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.
public methodRenderBeginTag (inherited from WebControl) Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.
public methodRenderControl (inherited from Control) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
public methodRenderEndTag (inherited from WebControl) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
public methodResolveUrl (inherited from Control) Converts a URL into one that is usable on the requesting client.
public methodToString (inherited from Object) Returns a String that represents the current Object.

Public Events

public eventCancelCommand Occurs when the Cancel button is clicked for an item in the DataGrid control.
public eventDataBinding (inherited from Control) Occurs when the server control binds to a data source.
public eventDeleteCommand Occurs when the Delete button is clicked for an item in the DataGrid control.
public eventDisposed (inherited from Control) 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.
public eventEditCommand Occurs when the Edit button is clicked for an item in the DataGrid control.
public eventInit (inherited from Control) Occurs when the server control is initialized, which is the first step in the its lifecycle.
public eventItemCommand Occurs when any button is clicked in the DataGrid control.
public eventItemCreated Occurs on the server when an item in the DataGrid control is created.
public eventItemDataBound Occurs after an item is data bound to the DataGrid control.
public eventLoad (inherited from Control) Occurs when the server control is loaded into the Page object.
public eventPageIndexChanged Occurs when one of the page selection elements is clicked.
public eventPreRender (inherited from Control) Occurs when the server control is about to render to its containing Page object.
public eventSelectedIndexChanged (inherited from BaseDataList) Occurs when a different item is selected in a data listing control between posts to the server.
public eventSortCommand Occurs when a column is sorted.
public eventUnload (inherited from Control) Occurs when the server control is unloaded from memory.
public eventUpdateCommand Occurs when the Update button is clicked for an item in the DataGrid control.

Protected Properties

protected propertyChildControlsCreated (inherited from Control) Gets a value that indicates whether the server control's child controls have been created.
protected propertyContext (inherited from Control) Gets the HttpContext object associated with the server control for the current Web request.
protected propertyEvents (inherited from Control) Gets a list of event handler delegates for the control. This property is read-only.
protected propertyHasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
protected propertyIsTrackingViewState (inherited from Control) Gets a value that indicates whether the server control is saving changes to its view state.
protected propertyTagKey (inherited from WebControl) Gets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
protected propertyTagName (inherited from WebControl) Gets the name of the control tag. This property is used primarily by control developers.
protected propertyViewState (inherited from Control) 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.
protected propertyViewStateIgnoresCase (inherited from Control) Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Methods

protected methodAddAttributesToRender (inherited from WebControl) Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter. This method is used primarily by control developers.
protected methodAddedControl (inherited from Control) Called after a control is added to the Controls collection of another control.
protected methodAddParsedSubObject (inherited from Control) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
protected methodClearChildViewState (inherited from Control) Deletes the view-state information for all the server control's child controls.
protected methodCreateChildControls (inherited from Control) Notifies server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
protected methodCreateControlCollection (inherited from Control) Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
protected methodCreateControlStyle Overridden. See WebControl.CreateControlStyle.
protected methodEnsureChildControls (inherited from Control) Determines whether the server control contains child controls. If it does not, it creates child controls.
protected methodFinalize (inherited from Object) Overridden. Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

In C# and C++, finalizers are expressed using destructor syntax.

protected methodIsLiteralContent (inherited from Control) Determines if the server control holds only literal content.
protected methodLoadViewState Overridden. See Control.LoadViewState.
protected methodMapPathSecure (inherited from Control) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
protected methodMemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
protected methodOnBubbleEvent Overridden. See Control.OnBubbleEvent.
protected methodOnCancelCommand Raises the CancelCommand event. This allows you to provide a custom handler for the event.
protected methodOnDataBinding (inherited from Control) Raises the DataBinding event.
protected methodOnDeleteCommand Raises the DeleteCommand event. This allows you to provide a custom handler for the event.
protected methodOnEditCommand Raises the EditCommand event. This allows you to provide a custom handler for the event.
protected methodOnInit (inherited from Control) Raises the Init event.
protected methodOnItemCommand Raises the ItemCommand event. This allows you to provide a custom handler for the event. This allows you to provide a custom handler for the event.
protected methodOnItemCreated Raises the ItemCreated event. This allows you to provide a custom handler for the event.
protected methodOnItemDataBound Raises the ItemDataBound event. This allows you to provide a custom handler for the event.
protected methodOnLoad (inherited from Control) Raises the Load event.
protected methodOnPageIndexChanged Raises the PageIndexChanged event. This allows you to provide a custom handler for the event.
protected methodOnPreRender (inherited from Control) Raises the PreRender event.
protected methodOnSelectedIndexChanged (inherited from BaseDataList) Raises the SelectedIndexChanged event of a BaseDataList. This allows you to create a custom handler for the event.
protected methodOnSortCommand Raises the SortCommand event. This allows you to provide a custom handler for the event.
protected methodOnUnload (inherited from Control) Raises the Unload event.
Note   Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
protected methodOnUpdateCommand Raises the UpdateCommand event. This allows you to provide a custom handler for the event.
protected methodRaiseBubbleEvent (inherited from Control) Assigns any sources of the event and its information to the control's parent.
protected methodRemovedControl (inherited from Control) Called after a control is removed from the Controls collection of another control.
protected methodRender (inherited from Control) Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
protected methodRenderChildren (inherited from Control) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
protected methodRenderContents (inherited from WebControl) Renders the contents of the control into the specified writer. This method is used primarily by control developers.
protected methodSaveViewState Overridden. See Control.SaveViewState.
protected methodTrackViewState Overridden. See Control.TrackViewState.

See Also

DataGrid Class | System.Web.UI.WebControls Namespace

Show:
© 2014 Microsoft