LoginStatus.OnLoggingOut Method (LoginCancelEventArgs)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 virtual void OnLoggingOut(
	LoginCancelEventArgs e
)

Parameters

e
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 NIB: 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="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_LoggingOut(Object sender, System.Web.UI.WebControls.LoginCancelEventArgs e)
    {
        Message.Text = "LoggingOut event. Don't go away now.";
        e.Cancel = true;
    }

</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" 
              onloggingout="LoginStatus1_LoggingOut">
            </asp:LoginStatus>
            <p></p>
            <asp:Literal id="Message" 
              runat="server" />
        </form>
    </body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: