Login.FailureTextStyle Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a reference to a collection of properties that define the appearance of error text in the Login control.

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

public TableItemStyle FailureTextStyle { get; }

Property Value

Type: System.Web.UI.WebControls.TableItemStyle

A reference to the TableItemStyle that contains properties that define the appearance of error text.

The FailureTextStyle property gets a reference to a TableItemStyle object that you use to change the appearance of login failure text. The default is to display the text in red.

This property is read-only; however, you can set the properties of the TableItemStyle object it returns. You can set these properties declaratively in the form Property-Subproperty, where Subproperty represents a property of the TableItemStyle class (for example, FailureTextStyle-ForeColor). You can set the property programmatically in the form Property.Subproperty (for example, FailureTextStyle.ForeColor).

Common settings include custom background color, text color, and font properties. The FailureTextStyle property defines the appearance of the FailureText property.

The style settings for the FailureTextStyle property are merged with the style settings for the Login control. Any settings made in the FailureTextStyle property override the corresponding settings in properties of the Login control.

The following Login control style properties are overridden by FailureTextStyle settings:

When you use templates to define the appearance of the Login control, the FailureTextStyle property has no effect.

The following code example specifies the login failure text style by setting the background and text color properties of the TableItemStyle object referenced in the FailureTextStyle property.

<%@ 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">

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
        <form id="form1" runat="server">
            <asp:Login id="Login1" runat="server" FailureText="There was an error while logging you in. Please try again.">
                <FailureTextStyle ForeColor="White" BackColor="Red"></FailureTextStyle>


.NET Framework
Available since 2.0
Return to top