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
)

Parameters

savedState
Type: System.Object

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

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft