LoginStatus.LogoutAction Property

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.

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

public:
 virtual property System::Web::UI::WebControls::LogoutAction LogoutAction { System::Web::UI::WebControls::LogoutAction get(); void set(System::Web::UI::WebControls::LogoutAction value); };

[System.Web.UI.Themeable(false)]
public virtual System.Web.UI.WebControls.LogoutAction LogoutAction { get; set; }

[<System.Web.UI.Themeable(false)>]
member this.LogoutAction : System.Web.UI.WebControls.LogoutAction with get, set

Public Overridable Property LogoutAction As LogoutAction

Property Value

LogoutAction

One of the LogoutAction values. The default is Refresh.

Attributes: ThemeableAttribute

Exceptions

ArgumentOutOfRangeException

The property is set to an invalid LogoutAction value.

Examples

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>

<%@ Page Language="VB" 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>

Remarks

The LogoutAction property determines which page is presented to the user when they log 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.

Applies to