This documentation is archived and is not being maintained.

LoginStatus.LogoutAction Property

Gets or sets a value that determines the action taken when a user logs out of a Web site with the LoginStatus control.

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

public virtual LogoutAction LogoutAction { get; set; }
/** @property */
public LogoutAction get_LogoutAction ()

/** @property */
public void set_LogoutAction (LogoutAction value)

public function get LogoutAction () : LogoutAction

public function set LogoutAction (value : LogoutAction)

Not applicable.

Property Value

One of the LogoutAction values. The default is Refresh.

Exception typeCondition


The property is set to an invalid LogoutAction value.

The LogoutAction property determines which page is presented to the user when he or she logs out using the LoginStatus control.

The following table describes the actions taken for each LogoutAction value.

LogoutAction value

Action taken


Redirects the user to the URL contained in the LogoutPageUrl property. If LogoutPageUrl is empty, the user is redirected to the login page defined in the application configuration settings.


Redirects the user to the login page defined in the application configuration settings.


Refreshes the current page.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and Introduction to ASP.NET Themes.

The following code example sets the LogoutAction property to the RedirectToLoginPage value to send the user to the login page.

<%@ Page Language="C#" AutoEventWireup="False" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="" >
    <title>ASP.NET Example</title>
    <form id="form1" runat="server">
    <asp:LoginStatus id="LoginStatus1" runat="server"
       LogoutAction="RedirectToLoginPage" />

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0