Control.OnLoad Method (System.Web.UI)

OnLoad Method

.NET Framework Class Library

Control..::.OnLoad Method

Updated: April 2009

Raises the Load event.

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

Syntax

Visual Basic (Declaration)

Protected Friend Overridable Sub OnLoad ( _
    e As EventArgs _
)

Visual Basic (Usage)

Dim e As EventArgs

Me.OnLoad(e)

protected internal virtual void OnLoad(
    EventArgs e
)

Visual C++

protected public:
virtual void OnLoad(
    EventArgs^ e
)

JScript

protected internal function OnLoad(
    e : EventArgs
)

Parameters

e: Type: System..::.EventArgs
The EventArgs object that contains the event data.

Remarks

ASP.NET calls this method in order to raise the Load event. If you are developing a custom control, you can override this method in order to provide additional processing. If you override this method, you typically call the base control's OnLoad method. If the base control's OnLoad method is not called, subscribers to the event will not be notified.

Examples

Visual Basic

Protected Overrides Sub OnLoad(ByVal e As EventArgs)
    MyBase.OnLoad(e)
    If _text Is Nothing Then
        _text = "Here is some default text."
    End If
End Sub

// Override the OnLoad method to set _text to
// a default value if it is null.
protected override void OnLoad(EventArgs e)
{
    base.OnLoad(e);
    if (_text == null)
        _text = "Here is some default text.";
}

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

Control Class

Control Members

System.Web.UI Namespace

Page

IsPostBack

Other Resources

ASP.NET Page Life Cycle Overview

Change History

Date	History	Reason
April 2009	Revised Remarks section and code example to clarify how the method is used.	Customer feedback.

Date

History

Reason

April 2009

Revised Remarks section and code example to clarify how the method is used.

Customer feedback.