LoginName.FormatString Propriedade

  • Referência

Definição

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Fornece uma cadeia de caracteres de item de formato a ser exibida.

public:
 virtual property System::String ^ FormatString { System::String ^ get(); void set(System::String ^ value); };
public virtual string FormatString { get; set; }
member this.FormatString : string with get, set
Public Overridable Property FormatString As String

Valor da propriedade

String

Uma cadeia de caracteres que contém itens de formato para exibir o nome do usuário. O valor padrão é "{0}".

Exceções

FormatException

A cadeia de caracteres de formato não é válida.

Exemplos

O exemplo de código a seguir mostra como usar a FormatString propriedade em uma página. Clicar no botão altera o formato de exibição.

<%@ 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 Button1_Click(Object sender, EventArgs e) {
        LoginName1.FormatString = "Welcome to our Web site, {0}";
         Button1.Visible = false;
    }

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <p>
            <asp:LoginName id="LoginName1" runat="server" 
               FormatString ="Welcome, {0}" />
        </p>
        <p>
            <asp:Button id="Button1" onclick="Button1_Click" runat="server" 
               Text="Change Format" />
        </p>
    </form>
</body>
</html>

<%@ Page Language="VB" 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">

    Sub Button1_Click(sender As Object, e As EventArgs) 
        LoginName1.FormatString = "Welcome to our Web site, {0}"
         Button1.Visible = false
    End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <p>
            <asp:LoginName id="LoginName1" runat="server" 
               FormatString="Welcome, {0}" />
        </p>
        <p>
            <asp:Button id="Button1" onclick="Button1_Click" runat="server" 
               Text="Change Format" />
        </p>
    </form>
</body>
</html>

Comentários

A FormatString propriedade contém uma cadeia de caracteres de formato de texto padrão que exibe o nome do usuário na página da Web. A cadeia de caracteres "{0}" indica onde, na cadeia de caracteres, o nome do usuário é inserido. A tabela a seguir descreve as configurações de propriedade disponíveis.

Configuração de propriedade Comportamento
Padrão ("{0}") O nome do usuário é exibido quando o usuário está conectado; caso contrário, nada será exibido.
Empty Igual ao padrão. Para ocultar o controle, defina a Visible propriedade como false.
"Bem-vindo ao meu site, {0}." Exibe a cadeia de caracteres "Bem-vindo ao meu site, nome de usuário" quando o usuário está conectado. Quando o usuário não está conectado, nada é exibido.
"Bem-vindo ao meu site." Quando a FormatString propriedade é definida como uma cadeia de caracteres, a cadeia de caracteres é exibida quando o usuário está conectado. Como a cadeia de caracteres não contém "{0}", o nome do usuário não é exibido. Quando o usuário não está conectado, nada é exibido.

O valor dessa propriedade, quando definido, pode ser salvo automaticamente em um arquivo de recurso usando uma ferramenta de designer. Para obter mais informações, consulte LocalizableAttributeGlobalização e Localização.

Aplica-se a

Confira também