LoginName::FormatString Property
Provides a format item string to display.
Assembly: System.Web (in System.Web.dll)
public: property String^ FormatString { virtual String^ get(); virtual void set(String^ value); }
Property Value
Type: System::String^A string containing format items for displaying the user's name. The default value is "{0}".
| Exception | Condition |
|---|---|
| FormatException | The format string is not valid. |
The 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.
Property setting | Behavior |
|---|---|
Default ("{0}") | The user's name is displayed when the user is logged on; otherwise, nothing is displayed. |
Same as default. To hide the control, set the 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 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 LocalizableAttribute and ASP.NET Globalization and Localization.
Available since 2.0