0 out of 1 rated this helpful - Rate this topic

StateBag Class

Manages the view state of ASP.NET server controls, including pages. This class cannot be inherited.

System.Object
  System.Web.UI.StateBag

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
public sealed class StateBag : IStateManager, 
	IDictionary, ICollection, IEnumerable

The StateBag type exposes the following members.

  Name Description
Public method StateBag() Initializes a new instance of the StateBag class. This is the default constructor for this class.
Public method StateBag(Boolean) Initializes a new instance of the StateBag class that allows stored state values to be case-insensitive.
Top
  Name Description
Public property Count Gets the number of StateItem objects in the StateBag object.
Public property Item Gets or sets the value of an item stored in the StateBag object.
Public property Keys Gets a collection of keys representing the items in the StateBag object.
Public property Values Gets a collection of the view-state values stored in the StateBag object.
Top
  Name Description
Public method Add Adds a new StateItem object to the StateBag object. If the item already exists in the StateBag object, this method updates the value of the item.
Public method Clear Removes all items from the current StateBag object.
Public method Equals(Object) 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 GetEnumerator Returns an enumerator that iterates over all the key/value pairs of the StateItem objects stored in the StateBag object.
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 IsItemDirty Checks a StateItem object stored in the StateBag object to evaluate whether it has been modified since the call to Control.TrackViewState.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes the specified key/value pair from the StateBag object.
Public method SetDirty Sets the state of the StateBag object as well as the Dirty property of each of the StateItem objects contained by it.
Public method SetItemDirty Sets the Dirty property for the specified StateItem object in the StateBag object.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast<TResult> Converts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType<TResult> Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo For a description of this member, see ICollection.CopyTo.
Explicit interface implemetation Private property ICollection.IsSynchronized For a description of this member, see ICollection.IsSynchronized.
Explicit interface implemetation Private property ICollection.SyncRoot For a description of this member, see ICollection.SyncRoot.
Explicit interface implemetation Private method IDictionary.Add For a description of this member, see IDictionary.Add.
Explicit interface implemetation Private method IDictionary.Contains For a description of this member, see IDictionary.Contains.
Explicit interface implemetation Private property IDictionary.IsFixedSize For a description of this member, see IDictionary.IsFixedSize.
Explicit interface implemetation Private property IDictionary.IsReadOnly For a description of this member, see IDictionary.IsReadOnly.
Explicit interface implemetation Private property IDictionary.Item For a description of this member, see IDictionary.Item.
Explicit interface implemetation Private method IDictionary.Remove For a description of this member, see Remove.
Explicit interface implemetation Private method IEnumerable.GetEnumerator For a description of this member, see IEnumerable.GetEnumerator.
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value indicating whether state changes are being tracked.
Explicit interface implemetation Private method IStateManager.LoadViewState Restores the previously saved view state of the StateBag object.
Explicit interface implemetation Private method IStateManager.SaveViewState Saves the changes to the StateBag object since the time the page was posted back to the server.
Explicit interface implemetation Private method IStateManager.TrackViewState Causes the StateBag object to track changes to its state so that it can be persisted across requests.
Top

View state for a page or control is the cumulative property values, or view, of that page or control. You can access this class through the Control.ViewState property. Controls can also store essential state information in control state, but that information is not stored as a StateBag object.

This class is the primary storage mechanism for all HTML and Web server controls. It stores attribute/value pairs as strings associated with the control. It tracks changes to these attributes only after the OnInit method is executed for a page request, and saves the changes to the page's or control's view state.

This class implements a dictionary, and you can add items to it or remove items from it as you would any dictionary object. For more information about data collections, such as dictionaries, see Collections and Data Structures.

The following code example demonstrates a composite Label control that has Text and FontSize properties. These properties are saved to and retrieved from view state when the Control.Render method is called on the control.


// This control renders values stored in view state for Text and FontSize properties.
using System;
using System.Web;
using System.Web.UI;

namespace ViewStateControlSamples
{

    public class CustomLabel : Control
    {
        private const int defaultFontSize = 3;

        // Add property values to view state with set;
        // retrieve them from view state with get.
        public String Text
        {
            get 
            { 
                object o = ViewState["Text"]; 
                return (o == null)? String.Empty : (string)o;
            }

            set
            {
                ViewState["Text"] = value;
            }
        }


        public int FontSize
        {
            get
            {
                object o = ViewState["FontSize"];
                return (o == null) ? defaultFontSize : (int)o;
            }
            set
            {
                ViewState["FontSize"] = value;
            }
        }

        [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")]
        protected override void Render(HtmlTextWriter output)
        {
            output.Write("<font size=" + this.FontSize.ToString() + ">" + this.Text + "</font>");
        }
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ