Export (0) Print
Expand All

Control.LoadControlState Method

Restores control-state information from a previous page request that was saved by the SaveControlState method.

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

protected internal virtual void LoadControlState (
	Object savedState
)
protected void LoadControlState (
	Object savedState
)
protected internal function LoadControlState (
	savedState : Object
)
Not applicable.

Parameters

savedState

An Object that represents the control state to be restored.

Override this method when you need to specify how a custom server control restores its control state. For more information, see ASP.NET State Management.

The following code example overrides the LoadControlState method in a custom ASP.NET control. When this method is invoked, it determines whether control state was previously saved for the control and, if so, sets the internal property currentIndex to the saved value.

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 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

Community Additions

ADD
Show:
© 2014 Microsoft