This documentation is archived and is not being maintained.

LoginStatus.OnLoggingOut Method

Raises the LoggingOut event when a user clicks the logout link on the LoginStatus control.

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

Protected Overridable Sub OnLoggingOut ( _
	e As LoginCancelEventArgs _


Type: System.Web.UI.WebControls.LoginCancelEventArgs
A LoginCancelEventArgs that contains event data.

Use the LoggingOut event to provide additional processing, such as cleaning up per-user data, before a user logs out of a site. The OnLoggingOut event can be canceled, so you can give the user the option of saving data such as a shopping cart or database changes before leaving the Web site.

For more information about handling events, see Events and Delegates.

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

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

<%@ Page Language="VB" AutoEventWireup="True" %>

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

  Sub LoginStatus1_LoggingOut(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.LoginCancelEventArgs)
    Message.Text = "LoggingOut event. Don't go away now."
    e.Cancel = True
  End Sub


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