Page.Session Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the current Session object provided by ASP.NET.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

<BrowsableAttribute(False)>
Public Overridable ReadOnly Property Session As HttpSessionState

Property Value

Type: System.Web.SessionState.HttpSessionState

The current session-state data.

Exception Condition
HttpException

Occurs when the session information is set to null.

This property provides information about the current request's session. A Session object is maintained for each user that requests a page or document from an ASP.NET application. Variables stored in the Session object are not discarded when the user moves from page to page in the application; instead, these variables persist as long as the user is accessing pages in your application. For more information about session state, see ASP.NET Session State Overview.

The following code example creates a GetStyle function that retrieves a key stored in the session state of the Web Forms page and converts its value to a string.

' Create a private function that obtains
' information stored in session state
' in the application's Global.asax file.
' When this method is called and a key name
' that is stored in session state is passed
' as the parameter, the key is obtained and
' converted to a string.
Function GetStyle(Key As String) As String
  Return Session(Key).ToString()
End Function

.NET Framework
Available since 1.1
Return to top
Show: