UserControl.Session Property

Gets the HttpSessionStateobject for the current Web request.

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

'Declaration
Public ReadOnly Property Session As HttpSessionState
'Usage
Dim instance As UserControl
Dim value As HttpSessionState

value = instance.Session

/** @property */
public HttpSessionState get_Session ()

public function get Session () : HttpSessionState

Not applicable.

Property Value

An HttpSessionState object associated with the Page that contains the UserControl instance.

The following example adds values to the Session property of a user control. The myControl.Session.Add syntax inserts the values of two TextBox Web server controls to the session associated with the user control and the page that contains it.

' Saves state information which is used by display handler after the postback has occured.

Sub SubmitBtn_Click(Sender As Object, e As EventArgs) 

    ' Clear all values from session state of 'Page'.
    Session.Clear()

    ' Populate Session State of UserControl with the values entered by user.
    myControl.Session.Add("username",myControl.user.Text)
    myControl.Session.Add("password",myControl.password.Text)

    ' Add UserControl state to the SessionState object of Page.
    Session(myControl.user.Text)= myControl
    Display.Enabled = true
End Sub

Sub Display_Click(Sender As Object,e As EventArgs)

    Dim position As Integer = Session.Count - 1

    ' Extract stored UserControl from the session state of page.
    Dim tempControl As LogOnControl = CType(Session(Session.Keys(position)),LogOnControl)

    ' Use SessionState of UserControl to display previously typed information.
    txtSession.Text = "<br /><br />User:" + tempControl.Session("username") + "<br />Password : " + tempControl.Session("password")
    Display.Enabled = false
End Sub

// Save state information which is used by display handler after the
// postback has occured.
void SubmitBtn_Click(Object sender, EventArgs e) 
{
    // Clear all values from session state of 'Page'.
    get_Session().Clear();
    // Populate Session State of UserControl with the values entered by user.
    myControl.get_Session().Add("username",myControl.user.get_Text());
    myControl.get_Session().Add("password",myControl.password.get_Text());
    // Add UserControl state to the SessionState object of Page.
    get_Session() .set_Item( myControl.user.get_Text() , myControl );
    display.set_Enabled(true);
} //SubmitBtn_Click

void Display_Click(Object sender, EventArgs e)
{
    int position = get_Session().get_Count() - 1;
    // Extract stored UserControl from the session state of page.
    LogOnControl tempControl = (LogOnControl)(get_Session().get_Item(
        get_Session().get_Keys().get_Item(position)));
    // Use SessionState of UserControl to display previously typed
    // information.
    txtSession.set_Text("<br /><br />User:" 
        + tempControl.get_Session().get_Item("username") + "<br />Password : "
        + tempControl.get_Session().get_Item("password"));
    display.set_Enabled(false);
} //Display_Click

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: