LoginStatus.LogoutText 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 the text used for the logout link.

public:
 virtual property System::String ^ LogoutText { System::String ^ get(); void set(System::String ^ value); };

public virtual string LogoutText { get; set; }

member this.LogoutText : string with get, set

Public Overridable Property LogoutText As String

Property Value

String

A string displayed as the logout link. The default is "Logout".

Examples

The following code example shows how to set the LogoutText property.

ASP.NET (C#)

<%@ 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">
<script runat="server">

    void Button1_Click(Object sender, EventArgs e) {
        LoginStatus1.LogoutText = "Log out of this Web site.";
         Button1.Visible = false;
    }

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <p>
            <asp:LoginStatus id="LoginStatus1" runat="server" 
               LogoutText="Logout now." />
        </p>
        <p>
            <asp:Button id="Button1" onclick="Button1_Click" runat="server" 
               Text="Change Text" />
        </p>
    </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">
<script runat="server">

    Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) 
        LoginStatus1.LoginText = "Log out of this Web site."
         Button1.Visible = false
    End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <p>
            <asp:LoginStatus id="LoginStatus1" runat="server" 
               LoginText="Logout now." />
        </p>
        <p>
            <asp:Button id="Button1" onclick="Button1_Click" runat="server" 
               Text="Change Text" />
        </p>
    </form>
</body>
</html>

Remarks

The LogoutText property is displayed when the LogoutImageUrl property is empty.

When the LogoutImageUrl property contains a link, the LogoutText property is used as the alternative text for the image in browsers that do not support images.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and Globalization and Localization.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

AI Skills Fest

Share via