IStateFormatter.Serialize Method (Object)

 

Serializes ASP.NET Web server control state to string form.

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

Function Serialize (
	state As Object
) As String

Parameters

state
Type: System.Object

The object that represents the view state of the Web server control to serialize to string form.

Return Value

Type: System.String

A string that represents a Web server control's view state.

Use the Serialize method to transform an object state graph to string form. Reconstitute a state object from the string using the Deserialize method.

The following code example demonstrates how the Serialize method persists view state information to a file. The Save method of the StreamPageStatePersister class uses the IStateFormatter interface inherited from the PageStatePersister class to serialize view state. This code example is part of a larger example provided for the IStateFormatter interface.

'
' Persist any ViewState and ControlState.
'
Public Overrides Sub Save()

    If Not (ViewState Is Nothing) OrElse Not (ControlState Is Nothing) Then
        If Not (Page.Session Is Nothing) Then

            Dim stateStream As Stream
            stateStream = GetSecureStream()

            ' Write a state string, using the StateFormatter.
            Dim writer As New StreamWriter(stateStream)

            Dim formatter As IStateFormatter
            formatter = Me.StateFormatter

            Dim statePair As New Pair(ViewState, ControlState)

            Dim serializedState As String
            serializedState = formatter.Serialize(statePair)

            writer.Write(serializedState)
            writer.Close()
            stateStream.Close()
        Else
            Throw New InvalidOperationException("Session needed for StreamPageStatePersister.")
        End If
    End If
End Sub 'Save

.NET Framework
Available since 2.0
Return to top
Show: