This documentation is archived and is not being maintained.

Login.OnLoggedIn Method

Raises the LoggedIn event after the user logs in to the Web site and has been authenticated.

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

protected virtual void OnLoggedIn(
	EventArgs e
)

Parameters

e
Type: System.EventArgs

A EventArgs that contains the event data.

The OnLoggedIn method raises the LoggedIn event. Use the LoggedIn event to provide additional processing, such as accessing per-user data, after the user is authenticated.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnLoggedIn method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnLoggedIn in a derived class, be sure to call the base class's OnLoggedIn method so that registered delegates receive the event.

The following code example uses the LoggedIn event to call a site-specific method that keeps a record of user logins.

<%@ page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
// This custom Login control uses a site-specific method 
// to record the current date and time when users are  
// authenticated at the site. 

class CustomLogin : Login
{
    private void SiteSpecificUserLoggingMethod(string UserName)
    {
        // Insert code to record the current date and time 
        // when this user was authenticated at the site.
    }

    override protected void OnLoggedIn(EventArgs e)
    {
        SiteSpecificUserLoggingMethod(UserName);
    }
}
    // Add the custom login control to the page. 
    void Page_Load(object sender, EventArgs e) 
    {
        CustomLogin loginControl = new CustomLogin();
        loginControl.ID = "loginControl";
        Placeholder1.Controls.Add(loginControl);
    }

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="Form1" runat="server">
            <asp:placeholder id="Placeholder1" runat="server"></asp:placeholder>
        </form>
    </body>
</html>

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: