Login.OnLoggedIn Method (EventArgs)

 

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 Overridable Sub OnLoggedIn (
	e As EventArgs
)

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="VB" %>

<!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
        Inherits Login

        Private Sub SiteSpecificUserLoggingMethod(ByVal UserName As String)
            ' Insert code to record the current date and time
            ' when this user was authenticated at the site.
        End Sub

        Overrides Protected Sub OnLoggedIn(ByVal e As EventArgs)
            SiteSpecificUserLoggingMethod(UserName)
        End Sub
    End Class

    ' Add the custom login control to the page.
    Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        Dim loginControl As New CustomLogin

        loginControl.ID = "loginControl"

        PlaceHolder1.Controls.Add(loginControl)
    End Sub
</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>

.NET Framework
Available since 2.0
Return to top
Show: