LoginStatus.OnLoggingOut(LoginCancelEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

protected:
 virtual void OnLoggingOut(System::Web::UI::WebControls::LoginCancelEventArgs ^ e);

protected virtual void OnLoggingOut (System.Web.UI.WebControls.LoginCancelEventArgs e);

abstract member OnLoggingOut : System.Web.UI.WebControls.LoginCancelEventArgs -> unit
override this.OnLoggingOut : System.Web.UI.WebControls.LoginCancelEventArgs -> unit

Protected Overridable Sub OnLoggingOut (e As LoginCancelEventArgs)

Parameters

e: LoginCancelEventArgs

A LoginCancelEventArgs that contains event data.

Examples

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>

<%@ 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_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
  
</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>

Remarks

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 Handling and Raising Events.

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

Applies to