This documentation is archived and is not being maintained.

LoginStatus.LoggingOut Event

Raised when the user clicks the logout button.

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

public event LoginCancelEventHandler LoggingOut
<asp:LoginStatus OnLoggingOut="LoginCancelEventHandler" />

The LoggingOut event is raised on the server when the user clicks the logout link. The logout process does not occur until after this event, and user information is still available.

The LoggingOut event allows you to cancel the logout process if the user must complete an activity before leaving the Web site, such as purchasing items in a shopping cart or submitting changes to a database. You can cancel the LoggingOut event by setting the Cancel property of the LoginCancelEventArgs parameter to true.

Use the LoggingOut event to provide additional processing, such as clearing per-user data, before a user logs out of a site.

The following code example attaches an event handler to the LoggingOut event. The event handler updates a field on the form, and then cancels the logout attempt.

<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

    void LoginStatus1_LoggingOut(Object sender, System.Web.UI.WebControls.LoginCancelEventArgs e)
        Message.Text = "LoggingOut event. Don't go away now.";
        e.Cancel = true;


<html xmlns="" >
    <head runat="server">
    <title>ASP.NET Example</title>
        <form id="FORM1" runat="server">
            <asp:LoginStatus id="LoginStatus1" 
            <asp:Literal id="Message" 
              runat="server" />

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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