Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

Control.SaveControlState Method

Saves any server control state changes that have occurred since the time the page was posted back to the server.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
protected internal virtual Object SaveControlState()

Return Value

Type: System.Object
Returns the server control's current state. If there is no state associated with the control, this method returns null.

Use the SaveControlState method to save state information required for the operation of a specific control. This control-state data is stored separately from the control's view-state data.

Custom controls using control state must call the RegisterRequiresControlState method on the Page before saving control state.

Notes to Inheritors:

When control state is saved, a string object is returned to the client as a variable that is stored in an HTML HIDDEN element. Override this method to extract the state information to use in your control.

Control state is intended for small amounts of critical data, such as a page index or a keyword. Using control state for large amounts of data can adversely affect page performance. For more information, see ASP.NET State Management Overview.

The following code example overrides the SaveControlState method in a custom ASP.NET control. When this method is invoked, it determines whether the internal property currentIndex is set to a non-default value and, if so, saves the value to control state.

The OnInit method is overridden to call the RegisterRequiresControlState method on the Page to indicate that the custom control uses control state.

public class Sample : Control {
    private int currentIndex = 0;

    protected override void OnInit(EventArgs e) {
        Page.RegisterRequiresControlState(this);
        base.OnInit(e);
    }

    protected override object SaveControlState() {
        return currentIndex != 0 ? (object)currentIndex : null;
    }

    protected override void LoadControlState(object state) {
        if (state != null) {
            currentIndex = (int)state;
        }
    }
}

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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.