This documentation is archived and is not being maintained.

UserControl.SaveViewState Method

Saves any user control view-state changes that have occurred since the last page postback.

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

'Declaration
Protected Overrides Function SaveViewState As Object
'Usage
Dim returnValue As Object 

returnValue = Me.SaveViewState()

Return Value

Type: System.Object
Returns the user control's current view state. If there is no view state associated with the control, it returns Nothing.

In general, you do not need to call this method. However, if you store custom information in view state, you can override this method to do so.

The following example demonstrates a user control that manages its view state using the LoadViewState and SaveViewState methods.

    Public Property UserText() As String 

        Get 
            Return CStr(ViewState("usertext"))
        End Get 
        Set(ByVal value As String)
            ViewState("usertext") = value
        End Set 

    End Property 

    Public Property PasswordText() As String 

        Get 
            Return CStr(ViewState("passwordtext"))
        End Get 
        Set(ByVal value As String)
            ViewState("passwordtext") = value
        End Set 

    End Property

    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
    Protected Overrides Sub LoadViewState(ByVal savedState As Object)

        Dim totalState As Object() = Nothing 
        If Not (savedState Is Nothing) Then
            totalState = CType(savedState, Object())
            If totalState.Length <> 3 Then 
                ' Throw an appropriate exception. 
            End If 
            ' Load base state. 
            MyBase.LoadViewState(totalState(0))
            ' Load extra information specific to this control. 
            If Not (totalState Is Nothing) AndAlso Not (totalState(1) Is Nothing) AndAlso Not (totalState(2) Is Nothing) Then
                UserText = CStr(totalState(1))
                PasswordText = CStr(totalState(2))
            End If 
        End If 

    End Sub

    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
    Protected Overrides Function SaveViewState() As Object

        Dim baseState As Object = MyBase.SaveViewState()
        Dim totalState(2) As Object
        totalState(0) = baseState
        totalState(1) = user.Text
        totalState(2) = password.Text
        Return totalState

    End Function 
End Class

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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