Login.LoginButtonType Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the type of button to use when rendering the Login button.

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

public virtual ButtonType LoginButtonType { get; set; }
/** @property */
public ButtonType get_LoginButtonType ()

/** @property */
public void set_LoginButtonType (ButtonType value)

public function get LoginButtonType () : ButtonType

public function set LoginButtonType (value : ButtonType)

Property Value

One of the ButtonType enumeration values. The default is Button.

Exception typeCondition

ArgumentOutOfRangeException

The LoginButtonType property is not set to a valid ButtonType enumeration value.

The LoginButtonType property determines the type of button to use for the Login control's login button. The following table describes the different button types.

LoginButtonType setting

Type of button rendered

Button

An HTML button with the text specified in the LoginButtonText property.

Image

An image. The URL of the image is specified in the LoginButtonImageUrl property. The string specified in the LoginButtonText property is used as alternate text for the image.

Link

An HTML link with the text specified in the LoginButtonText property.

When the LoginButtonType property is set to Button or Link, the content of the LoginButtonImageUrl property is ignored.

The following code example shows the different types of login buttons available for the Login control.

<%@ 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>
  <body>
     <form 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 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: