Login.LoginButtonText Property

Gets or sets the text for the Login control's login button.

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

[LocalizableAttribute(true)] 
public virtual string LoginButtonText { get; set; }
/** @property */
public String get_LoginButtonText ()

/** @property */
public void set_LoginButtonText (String value)

public function get LoginButtonText () : String

public function set LoginButtonText (value : String)

Not applicable.

Property Value

The text used for the Login control's login button. The default is "Login".

The LoginButtonText property contains the text displayed for the Login control's login button. Depending on the value of the LoginButtonType property, the LoginButtonText property can appear as text on a button, as text displayed as an alternative to an image in browsers that do not render images, or as the text of a link. The following table describes how the different LoginButtonType values affect the LoginButtonText property.

LoginButtonType setting

How the LoginButtonText property is used.

Button

As the button's Text property.

Image

As alternative text for the image.

Link

As link text.

The default text for the control is localized based on the server's current locale.

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 ASP.NET Globalization and Localization.

The following code example shows how the text in the LoginButtonText property is affected by the value of the LoginButtonType property.

Security noteSecurity Note:

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview (Visual Studio).

<%@ 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 changeButton_Click(Object sender, EventArgs e) 
    {
      if (ChooseButtonType.SelectedValue == "Button")
      {
        Login1.LoginButtonType = ButtonType.Button;
      }
      if (ChooseButtonType.SelectedValue == "Image")
      {
        Login1.LoginButtonType = ButtonType.Image;
      }
      if (ChooseButtonType.SelectedValue == "Link")
      {
        Login1.LoginButtonType = ButtonType.Link;
      }
      
      Login1.LoginButtonText = Server.HtmlEncode(buttonText.Text);
    }

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
     <form id="form1" runat="server">
       <table>
           <tr>
             <td>Login Button Text:
             </td>
             <td>
               <asp:TextBox id="buttonText" 
                            runat="server"
                            Text="Login"></asp:TextBox>
             </td>
             <td>Button Type:
             </td>
             <td>
               <asp:DropDownList id="ChooseButtonType" 
                                 runat="server">
                 <asp:ListItem value="Button"
                               selected="true"></asp:ListItem>
                 <asp:ListItem value="Image"></asp:ListItem>
                 <asp:ListItem value="Link"></asp:ListItem>
               </asp:DropDownList>
             </td>
             <td>
                        <asp:Button id="changeButton" runat="server" Text="Change" OnClick="changeButton_Click"></asp:Button>
             </td>
           </tr>
           <tr>
             <td colspan="4" 
                 align="center">
             <asp:Login id="Login1" 
                        runat="server" 
                        LoginButtonType="Image" 
                        LoginButtonText="Log in to Web Site."
                        LoginButtonImageUrl="images\login.png">
             </asp:Login>
             </td>
           </tr>
        </table>
     </form>
  </body>
</html>

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

Community Additions

ADD
Show: