Edit

Share via

LoginStatus.LoggedOut Event

  • Reference

Definition

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

Raised after the user clicks the logout link and the logout process is complete.

public:
 event EventHandler ^ LoggedOut;
public event EventHandler LoggedOut;
member this.LoggedOut : EventHandler 
Public Custom Event LoggedOut As EventHandler

Event Type

EventHandler

Examples

The following code example attaches an event handler to the LoggedOut 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

The LoggedOut event is raised on the server after the user clicks the logout link and the logout process is complete.

When the user clicks the logout link, the LoggingOut event is raised, then the logout process is run, and finally the LoggedOut event is raised.

Use the LoggedOut event to provide additional processing such as cleaning up database connections or removing per-user cached data after the user logs out of a Web site. The user's identity is still available while the LoggedOut event is executing. If your handler for the LoggedOut event redirects the client browser to another page, the authentication cookie will be cleared from the client.

Applies to

See also