SessionPageStatePersister Class

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Stores ASP.NET page view state on the Web server.

public ref class SessionPageStatePersister : System::Web::UI::PageStatePersister

public class SessionPageStatePersister : System.Web.UI.PageStatePersister

type SessionPageStatePersister = class
    inherit PageStatePersister

Public Class SessionPageStatePersister
Inherits PageStatePersister

Inheritance: Object

PageStatePersister
SessionPageStatePersister

Examples

The following code example demonstrates how you can write a PageAdapter class to return an instance of the SessionPageStatePersister class instead of the default HiddenFieldPageStatePersister class to save view state to the server-side session object.

namespace Samples.AspNet.CS {

    using System.Web.UI;

    public class MyPageAdapter : System.Web.UI.Adapters.PageAdapter {

        public override PageStatePersister GetStatePersister() {
            return new SessionPageStatePersister(Page);
        }
    }
}

Imports System.Web.UI

Namespace Samples.AspNet.VB

    Public Class MyPageAdapter
       Inherits System.Web.UI.Adapters.PageAdapter


       Public Overrides Function GetStatePersister() As PageStatePersister
          Return New SessionPageStatePersister(Page)
       End Function 'GetStatePersister

    End Class

End Namespace

Remarks

ASP.NET pages can store Page state information between the inherently stateless HTTP request and response required to process and serve any Web page. This state is called "view state."

The default ASP.NET persistence mechanism is to store view state on the client using the HiddenFieldPageStatePersister class. Storing view state and data with each HTTP request and response performs well in general and is important in large Web farm scenarios because it does not matter which Web server services the request: the page state is available in the current context for the server to accurately render the page.

In scenarios where pages are served to small devices that have limited client-side resources or use a markup language that does not support a hidden field element, it is required to store view state on the server. Several ASP.NET device page adapters override the GetStatePersister method to return a SessionPageStatePersister object that stores page state on the server in the session object associated with the client.

Constructors

SessionPageStatePersister(Page)

Initializes a new instance of the SessionPageStatePersister class.

Properties

ControlState	Gets or sets an object that represents the data that controls contained by the current Page object use to persist across HTTP requests to the Web server. (Inherited from PageStatePersister)
Page	Gets or sets the Page object that the view state persistence mechanism is created for. (Inherited from PageStatePersister)
StateFormatter	Gets an IStateFormatter object that is used to serialize and deserialize the state information contained in the ViewState and ControlState properties during calls to the Save() and Load() methods. (Inherited from PageStatePersister)
ViewState	Gets or sets an object that represents the data that controls contained by the current Page object use to persist across HTTP requests to the Web server. (Inherited from PageStatePersister)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Load()	Deserializes and loads persisted state from the server-side session object when a Page object initializes its control hierarchy.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Save()	Serializes any object state contained in the ViewState or the ControlState property and writes the state to the session object.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via