Edit

Share via

LoginStatus.OnLoggedOut(EventArgs) Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

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

protected:
 virtual void OnLoggedOut(EventArgs ^ e);
protected virtual void OnLoggedOut (EventArgs e);
abstract member OnLoggedOut : EventArgs -> unit
override this.OnLoggedOut : EventArgs -> unit
Protected Overridable Sub OnLoggedOut (e As EventArgs)

Parameters

e
EventArgs

An EventArgs that contains the event data.

Examples

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>

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

    Sub LoginStatus1_LoggedOut(ByVal sender As Object, ByVal e As System.EventArgs)
        ' Perform any post logout processing, such as setting the user's
          ' last logout time or clearing a per-user cache of objects here.
    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:LoginStatus id="LoginStatus1" 
              runat="server" 
              onloggedout="LoginStatus1_LoggedOut">
            </asp:LoginStatus>
        </form>
    </body>
</html>

Remarks

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 how to handle events, see Handling and Raising Events. Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

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

Applies to

See also