0 out of 1 rated this helpful - Rate this topic

Page.RegisterRequiresControlState Method

.NET Framework 2.0

Other Versions

Note: This method is new in the .NET Framework version 2.0.

Registers a control as one whose control state must be persisted.

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

Syntax

C++

Copy

public void RegisterRequiresControlState (
	Control control
)

Copy

public void RegisterRequiresControlState (
	Control control
)

JScript

Copy

public function RegisterRequiresControlState (
	control : Control
)

Parameters

control: The control to register.

Exceptions

Exception type	Condition
ArgumentException	The control to register is a null reference (Nothing in Visual Basic).

Remarks

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.

Example

The following code example shows a custom server control calling the RegisterRequiresControlState method.

Copy

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

Platforms

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0

Reference

Page Class
Page Members
System.Web.UI Namespace
RequiresControlState

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ