Export (0) Print
Expand All

LoginStatus.OnLoggedOut Method

Raises the LoggedOut event after the user clicks the logout link and logout processing is complete.

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

protected virtual void OnLoggedOut(
	EventArgs e
)

Parameters

e
Type: System.EventArgs

An EventArgs that contains the event data.

Use the LoggedOut event to provide additional processing, such as closing database connections or cleaning up per-user cached data, after the user has logged out of a Web site.

For more information about handling events, see Consuming Events. Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnLoggedOut 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 OnLoggedOut in a derived class, be sure to call the base class's OnLoggedOut method so that registered delegates receive the event.

The following code example attaches an event handler to the OnLoggedOut event. The event handler in this example is empty.

<%@ Page Language="C#" AutoEventWireup="true" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    void LoginStatus1_LoggedOut(Object sender, System.EventArgs e)
    {
        // Perform any post-logout processing, such as setting the
          // user's last logout time or clearing a per-user cache of 
          // objects here.
    }

</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:LoginStatus id="LoginStatus1" 
              runat="server" 
              onloggedout="LoginStatus1_LoggedOut">
            </asp:LoginStatus>
        </form>
    </body>
</html>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft