This documentation is archived and is not being maintained.

LoginStatus.LoggingOut Event

Note: This event is new in the .NET Framework version 2.0.

Raised when the user clicks the logout button.

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

public event LoginCancelEventHandler LoggingOut
/** @event */
public void add_LoggingOut (LoginCancelEventHandler value)

/** @event */
public void remove_LoggingOut (LoginCancelEventHandler value)

JScript supports the use of events, but not the declaration of new ones.

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

<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;

        <FORM id="FORM1" runat="server">
            <asp:LoginStatus id="LoginStatus1" 
            <asp:Literal id="Message" 
              runat="server" />

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0