Page.RegisterRequiresControlState Method (Control)
.NET Framework (current version)
Registers a control as one whose control state must be persisted.
Assembly: System.Web (in System.Web.dll)
Parameters
- control
-
Type:
System.Web.UI.Control
The control to register.
| Exception | Condition |
|---|---|
| ArgumentException | The control to register is null. |
| InvalidOperationException | The RegisterRequiresControlState method can be called only before or during the PreRender event. |
Custom server controls that use control state must call the RegisterRequiresControlState method on each request because registration for control state is not carried over from request to request during a postback event. It is recommended that registration occur in the Init event.
The following code example shows a custom server control calling the RegisterRequiresControlState method.
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
Available since 2.0
Available since 2.0
Show: