SPGridView members

Represents a grid view that looks and behaves like a SharePoint Foundation list view.

The SPGridView type exposes the following members.

Constructors

  Name Description
Public method SPGridView Initializes a new instance of the SPGridView class.

Top

Properties

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property AllowFiltering Gets or sets the Boolean AllowFiltering property.
Public property AllowGroupCollapse Gets or sets the Boolean value that specifies whether groups can be collapsed.
Public property AllowGrouping Gets or sets the Boolean that specifies whether grouping is enabled.
Public property AllowPaging (Inherited from GridView.)
Public property AllowSorting (Inherited from GridView.)
Public property AlternatingRowStyle (Inherited from GridView.)
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property AutoGenerateColumns (Inherited from GridView.)
Public property AutoGenerateDeleteButton (Inherited from GridView.)
Public property AutoGenerateEditButton (Inherited from GridView.)
Public property AutoGenerateSelectButton (Inherited from GridView.)
Public property BackColor (Inherited from WebControl.)
Public property BackImageUrl (Inherited from GridView.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property BottomPagerRow (Inherited from GridView.)
Public property Caption (Inherited from GridView.)
Public property CaptionAlign (Inherited from GridView.)
Public property CellPadding (Inherited from GridView.)
Public property CellSpacing (Inherited from GridView.)
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Public property ClientIDRowSuffix (Inherited from GridView.)
Public property ClientIDRowSuffixDataKeys (Inherited from GridView.)
Protected property ClientIDSeparator (Inherited from Control.)
Public property Columns (Inherited from GridView.)
Public property ColumnsGenerator (Inherited from GridView.)
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from CompositeDataBoundControl.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property DataBoundHasBeenRaised Gets or sets the Boolean DataBoundHasBeenRaised property.
Public property DataItemContainer (Inherited from Control.)
Public property DataKeyNames (Inherited from GridView.)
Public property DataKeys (Inherited from GridView.)
Public property DataKeysContainer (Inherited from Control.)
Public property DataMember (Inherited from DataBoundControl.)
Public property DataSource (Inherited from BaseDataBoundControl.)
Public property DataSourceID (Inherited from DataBoundControl.)
Public property DataSourceObject (Inherited from DataBoundControl.)
Protected property DesignMode (Inherited from Control.)
Public property DisplayGroupFieldName Gets or sets a value that indicates whether the group field name should be displayed.
Public property EditIndex (Inherited from GridView.)
Public property EditRowStyle (Inherited from GridView.)
Public property EmptyDataRowStyle (Inherited from GridView.)
Public property EmptyDataTemplate (Inherited from GridView.)
Public property EmptyDataText (Inherited from GridView.)
Public property Enabled (Inherited from WebControl.)
Public property EnableModelValidation (Inherited from GridView.)
Public property EnablePersistedSelection (Inherited from GridView.)
Public property EnableSortingAndPagingCallbacks (Inherited from GridView.)
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Protected property Events (Inherited from Control.)
Public property FilterDataFields Gets or sets the FilterDataFields property.
Public property FilteredDataSourcePropertyFormat Gets or sets the format of the data source
Public property FilteredDataSourcePropertyName Gets or sets the name of the property to set on the data source to filter.
Public property FilterFieldName Gets the name of the field that this gridview is currently filtered by or string.Empty is the filter is currently off.
Public property FilterFieldValue Gets the value of the field that this gridview is currently filtered by or string.Empty is the filter is currently off.
Public property FilteringIsCaseSensitive Specifies whether filtering is case-sensitive.
Public property Font (Inherited from WebControl.)
Public property FooterRow (Inherited from GridView.)
Public property FooterStyle (Inherited from GridView.)
Public property ForeColor (Inherited from WebControl.)
Public property GridLines (Inherited from GridView.)
Public property GroupColumnHeaderCssClass
Public property GroupDescriptionField Specifies the description for the group header
Public property GroupDisplayTextField Specifies the name of the field whose value will be used as the display text on the group.
Public property GroupField Gets or sets the name of the field to group by.
Public property GroupFieldDisplayName Gets or sets the display name of field to group by.
Public property GroupImageDescriptionField Specifies alternate text for GroupImageUrlField for accessibility
Public property GroupImageUrlField Specifies the path to the image shown alongside the group header
Public property GroupMenu Gets or sets the menu field used in the group headers.
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Public property HeaderRow (Inherited from GridView.)
Public property HeaderStyle (Inherited from GridView.)
Public property Height (Inherited from WebControl.)
Public property HighestDataItemIndex Gets the value representing the highest index value of all displayed items.
Public property HorizontalAlign (Inherited from GridView.)
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Protected property Initialized (Inherited from BaseDataBoundControl.)
Protected property IsBoundUsingDataSourceID (Inherited from BaseDataBoundControl.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Protected property LoadViewStateByID (Inherited from Control.)
Public property LowestDataItemIndex Gets the value representing the lowest index value of all displayed items.
Public property NamingContainer (Inherited from Control.)
Public property Page (Inherited from Control.)
Public property PageCount (Inherited from GridView.)
Public property PageIndex Provides the index of the current page. (Overrides GridView.PageIndex.)
Public property PagerSettings (Inherited from GridView.)
Public property PagerStyle (Inherited from GridView.)
Public property PagerTemplate (Inherited from GridView.)
Public property PageSize (Inherited from GridView.)
Public property Parent (Inherited from Control.)
Public property PreviousPageFirstRowDataKey The DataKey from first row on the previous page, which can be used by DataSource controls to optimize retrieval of the next page.
Public property PreviousPageIndex Gets or sets an index that determines paging direction.
Public property PreviousPageLastRowDataKey The DataKey from last row on the previous page, which can be used by DataSource controls to optimize retrieval of the next page.
Public property RenderingCompatibility (Inherited from Control.)
Protected property RequiresDataBinding (Inherited from BaseDataBoundControl.)
Public property RowHeaderColumn (Inherited from GridView.)
Public property Rows (Inherited from GridView.)
Public property RowStyle (Inherited from GridView.)
Protected property SelectArguments (Inherited from DataBoundControl.)
Public property SelectedDataKey (Inherited from GridView.)
Public property SelectedIndex (Inherited from GridView.)
Public property SelectedPersistedDataKey (Inherited from GridView.)
Public property SelectedRow (Inherited from GridView.)
Public property SelectedRowStyle (Inherited from GridView.)
Public property SelectedValue (Inherited from GridView.)
Public property ShowFooter (Inherited from GridView.)
Public property ShowHeader (Inherited from GridView.)
Public property ShowHeaderWhenEmpty (Inherited from GridView.)
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property SortDirection (Inherited from GridView.)
Public property SortDirectionImageUrl Gets the URL of the sort direction image if sorting is currently active.
Public property SortedAscendingCellStyle (Inherited from GridView.)
Public property SortedAscendingHeaderStyle (Inherited from GridView.)
Public property SortedDescendingCellStyle (Inherited from GridView.)
Public property SortedDescendingHeaderStyle (Inherited from GridView.)
Public property SortExpression (Inherited from GridView.)
Public property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from BaseDataBoundControl.)
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from GridView.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property ToolTip (Inherited from WebControl.)
Public property TopPagerRow (Inherited from GridView.)
Public property UniqueID (Inherited from Control.)
Public property UseAccessibleHeader (Inherited from GridView.)
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible (Inherited from Control.)
Public property Width (Inherited from WebControl.)

Top

Methods

  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject (Inherited from Control.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Protected method ClearCachedClientID (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Protected method ClearEffectiveClientIDMode (Inherited from Control.)
Protected method ConfirmInitState (Inherited from BaseDataBoundControl.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateAutoGeneratedColumn (Inherited from GridView.)
Protected method CreateChildControls() (Inherited from CompositeDataBoundControl.)
Protected method CreateChildControls(IEnumerable, Boolean) (Overrides GridView.CreateChildControls(IEnumerable, Boolean).)
Protected method CreateChildTable (Inherited from GridView.)
Protected method CreateColumns (Inherited from GridView.)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from GridView.)
Protected method CreateDataSourceSelectArguments (Inherited from GridView.)
Protected method CreateRow (Overrides GridView.CreateRow(Int32, Int32, DataControlRowType, DataControlRowState).)
Public method DataBind() (Inherited from GridView.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method DeleteRow (Inherited from GridView.)
Public method Dispose (Inherited from Control.)
Protected method DoFilterPostBackEventProcessing Does the actual work for a Filter postback.
Protected method DoSortPostBackEventProcessing Does the actual work for a Sort postback.
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureDataBound (Inherited from BaseDataBoundControl.)
Protected method EnsureID (Inherited from Control.)
Public method Equals (Inherited from Object.)
Protected method ExtractRowValues (Inherited from GridView.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetCallbackResult (Overrides GridView.GetCallbackResult().)
Protected method GetCallbackScript (Inherited from GridView.)
Protected method GetData (Inherited from DataBoundControl.)
Protected method GetDataSource (Inherited from DataBoundControl.)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetHashCode (Inherited from Object.)
Public method GetRouteUrl(Object) (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
Public method GetRouteUrl(String, Object) (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Protected method InitializePager (Inherited from GridView.)
Protected method InitializeRow (Inherited from GridView.)
Protected method InvokeCallbackEvent Handles the callback event from the client.
Public method IsBindableType (Inherited from GridView.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState Load the data item indices from the control state (Overrides GridView.LoadControlState(Object).)
Protected method LoadViewState (Inherited from GridView.)
Protected method MapPathSecure (Inherited from Control.)
Protected method MarkAsDataBound (Inherited from DataBoundControl.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method OnBubbleEvent (Inherited from GridView.)
Protected method OnDataBinding (Overrides Control.OnDataBinding(EventArgs).)
Protected method OnDataBound Raises the DataBound event. (Overrides BaseDataBoundControl.OnDataBound(EventArgs).)
Protected method OnDataPropertyChanged (Inherited from GridView.)
Protected method OnDataSourceViewChanged (Inherited from GridView.)
Protected method OnInit Raises the Init event. (Overrides GridView.OnInit(EventArgs).)
Protected method OnLoad (Overrides DataBoundControl.OnLoad(EventArgs).)
Protected method OnPageIndexChanged (Inherited from GridView.)
Protected method OnPageIndexChanging (Inherited from GridView.)
Protected method OnPagePreLoad (Inherited from GridView.)
Protected method OnPreRender (Inherited from GridView.)
Protected method OnRowCancelingEdit (Inherited from GridView.)
Protected method OnRowCommand (Inherited from GridView.)
Protected method OnRowCreated Raises the RowCreated event. (Overrides GridView.OnRowCreated(GridViewRowEventArgs).)
Protected method OnRowDataBound (Inherited from GridView.)
Protected method OnRowDeleted (Inherited from GridView.)
Protected method OnRowDeleting (Inherited from GridView.)
Protected method OnRowEditing (Inherited from GridView.)
Protected method OnRowUpdated (Inherited from GridView.)
Protected method OnRowUpdating (Inherited from GridView.)
Protected method OnSelectedIndexChanged (Inherited from GridView.)
Protected method OnSelectedIndexChanging (Inherited from GridView.)
Protected method OnSorted (Inherited from GridView.)
Protected method OnSorting (Inherited from GridView.)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method PerformDataBinding (Inherited from GridView.)
Protected method PerformSelect (Inherited from DataBoundControl.)
Protected method PrepareControlHierarchy (Inherited from GridView.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Protected method RaiseCallbackEvent (Overrides GridView.RaiseCallbackEvent(String).)
Protected method RaisePostBackEvent Notifies the server that it should handle an incoming postback event. (Overrides GridView.RaisePostBackEvent(String).)
Protected method RaisePostBackEventInternal Internal method that actually handles the postback event from the client and is callable from a derived class.
Protected method RemovedControl (Inherited from Control.)
Protected method Render (Overrides GridView.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from WebControl.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from WebControl.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState Save the data item indices in the control state (Overrides GridView.SaveControlState().)
Protected method SaveViewState (Inherited from GridView.)
Public method SelectRow (Inherited from GridView.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetEditRow (Inherited from GridView.)
Public method SetPageIndex (Inherited from GridView.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method Sort (Inherited from GridView.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from GridView.)
Public method UpdateRow (Inherited from GridView.)
Protected method ValidateDataSource (Inherited from DataBoundControl.)

Top

Events

  Name Description
Public event DataBinding (Inherited from Control.)
Public event DataBound (Inherited from BaseDataBoundControl.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PageIndexChanged (Inherited from GridView.)
Public event PageIndexChanging (Inherited from GridView.)
Public event PreRender (Inherited from Control.)
Public event RowCancelingEdit (Inherited from GridView.)
Public event RowCommand (Inherited from GridView.)
Public event RowCreated (Inherited from GridView.)
Public event RowDataBound (Inherited from GridView.)
Public event RowDeleted (Inherited from GridView.)
Public event RowDeleting (Inherited from GridView.)
Public event RowEditing (Inherited from GridView.)
Public event RowUpdated (Inherited from GridView.)
Public event RowUpdating (Inherited from GridView.)
Public event SelectedIndexChanged (Inherited from GridView.)
Public event SelectedIndexChanging (Inherited from GridView.)
Public event Sorted (Inherited from GridView.)
Public event Sorting (Inherited from GridView.)
Public event Unload (Inherited from Control.)

Top

Fields

  Name Description
Public fieldStatic member CallbackArgumentPrefix Stores the callback argument prefix associated with the item. This field is constant.
Protected field m_HighestDataItemIndex Provides the value for the HighestDataItemIndex property.
Protected field m_LowestDataItemIndex Provides the value for the LowestDataItemIndex property.
Public fieldStatic member PostbackArgumentPrefix Stores the post back argument prefix associated with the item. This field is constant.
Public fieldStatic member PostbackFilterCommand
Public fieldStatic member PostbackFilterCommandClear
Public fieldStatic member PostbackSortCommand
Public fieldStatic member PostbackSortCommandAscending
Public fieldStatic member PostbackSortCommandDescending

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBoundListControl.ClientIDRowSuffix (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataKeysControl.ClientIDRowSuffixDataKeys (Inherited from GridView.)
Explicit interface implemetationPrivate property IControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IPersistedSelector.DataKey (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundControl.DataKeyNames (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundListControl.DataKeys (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundControl.DataMember (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundControl.DataSource (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundControl.DataSourceID (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundControl.DataSourceObject (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundListControl.EnablePersistedSelection (Inherited from GridView.)
Explicit interface implemetationPrivate property IExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate property IFieldControl.FieldsGenerator (Inherited from GridView.)
Explicit interface implemetationPrivate method IAttributeAccessor.GetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method ICallbackEventHandler.GetCallbackResult (Inherited from GridView.)
Explicit interface implemetationPrivate method ICallbackContainer.GetCallbackScript (Inherited from GridView.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IPostBackContainer.GetPostBackOptions (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate method ICallbackEventHandler.RaiseCallbackEvent (Inherited from GridView.)
Explicit interface implemetationPrivate method IPostBackEventHandler.RaisePostBackEvent (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundListControl.SelectedDataKey (Inherited from GridView.)
Explicit interface implemetationPrivate property IDataBoundListControl.SelectedIndex (Inherited from GridView.)
Explicit interface implemetationPrivate method IAttributeAccessor.SetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate property IControlDesignerAccessor.UserData (Inherited from Control.)

Top

See also

Reference

SPGridView class

Microsoft.SharePoint.WebControls namespace