Export (0) Print
Expand All

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)

[ThemeableAttribute(false)]
public virtual LogoutAction LogoutAction { get; set; }
<asp:LoginStatus LogoutAction="LogoutAction" />

Property Value

Type: System.Web.UI.WebControls.LogoutAction
One of the LogoutAction values. The default is Refresh.

ExceptionCondition
ArgumentOutOfRangeException

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

Redirect

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.

RedirectToLoginPage

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

Refresh

Refreshes the current page.

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

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"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:LoginStatus id="LoginStatus1" runat="server"
       LogoutAction="RedirectToLoginPage" />

    </form>
    </body>
</html>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft