System.Web.UI.WebControls.LoginName.FormatString Property

Provides a format item string to display.

Syntax

[System.ComponentModel.Localizable(true)]
[System.ComponentModel.DefaultValue("{0}")]
public virtual string FormatString { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

The LoginName.FormatString property contains a standard text format string that displays the user's name on the Web page. The string "{0}" indicates where in the string the user's name is inserted. The following table describes the available property settings.

Default ("{0}")

The user's name is displayed when the user is logged on; otherwise, nothing is displayed.

string.Empty

Same as default. To hide the control, set the System.Web.UI.Control.Visible property to false.

"Welcome to my site, {0}."

Displays the string "Welcome to my site, username." when the user is logged in. When the user is not logged in, nothing is displayed.

"Welcome to my site."

When the LoginName.FormatString property is set to a string, the string is displayed when the user is logged in. Because the string does not contain "{0}", the user's name is not displayed. When the user is not logged in, nothing is displayed.

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

Requirements

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0