Redigera

Dela via

LoginStatus.LoggingOut Event

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Raised when the user clicks the logout button.

public:
 event System::Web::UI::WebControls::LoginCancelEventHandler ^ LoggingOut;
public event System.Web.UI.WebControls.LoginCancelEventHandler LoggingOut;
member this.LoggingOut : System.Web.UI.WebControls.LoginCancelEventHandler 
Public Custom Event LoggingOut As LoginCancelEventHandler

Event Type

LoginCancelEventHandler

Examples

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

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.

Applies to

See also