IWebPart.Description Propriedade

Definição

Obtém ou define uma frase curta que resume o que um controle faz, para ser usada em dicas de ferramenta e catálogos de controles de WebPart.

public string Description { get; set; }

Valor da propriedade

Uma cadeia de caracteres que resume brevemente a funcionalidade do controle. O valor padrão é uma cadeia de caracteres vazia ("").

Exemplos

O exemplo de código a seguir demonstra o uso declarativo e programático da Description propriedade . O código-fonte completo para o exemplo é encontrado na seção Exemplo da visão geral da IWebPart classe.

A primeira parte do exemplo de código mostra como o controle de usuário implementa a Description propriedade .

public string Description
{
  get
  {
    object objTitle = ViewState["Description"];
    if (objTitle == null)
      return String.Empty;

    return (string)objTitle;
  }
  set
  {
    ViewState["Description"] = value;
  }
}

A segunda parte do exemplo de código demonstra o método no controle de usuário que define programaticamente o valor da Description propriedade quando um usuário seleciona o nome da propriedade apropriado nos botões de opção na página, define um novo valor na caixa de texto e clica no botão Atualizar .

Importante

Este exemplo tem uma caixa de texto que aceita a entrada do usuário, que é uma possível ameaça à segurança. Por padrão, ASP.NET páginas da Web validam que a entrada do usuário não inclui elementos HTML ou script. Para obter mais informações, consulte Visão geral de explorações de script.

// Update the selected IWebPart property value.
void Button1_Click(object sender, EventArgs e)
{
  String propertyValue = Server.HtmlEncode(TextBox3.Text);
  TextBox3.Text = String.Empty;

  switch (RadioButtonList1.SelectedValue)
  {
    case "title":
      this.Title = propertyValue;
      break;
    case "description":
      this.Description = propertyValue;
      break;
    case "catalogiconimageurl":
      this.CatalogIconImageUrl = propertyValue;
      break;
    case "titleiconimageurl":
      this.TitleIconImageUrl = propertyValue;
      break;
    case "titleurl":
      this.TitleUrl = propertyValue;
      break;
    default:
      break;
  }
}

A terceira parte do exemplo de código mostra como o controle do usuário que implementa a IWebPart interface é referenciado em um WebPartZone controle e como a Description propriedade é definida declarativamente no controle. Observe que você pode ver o valor dessa propriedade posicionando o ponteiro do mouse sobre o texto do título na barra de título do controle, depois de carregar a página em um navegador. Você também pode experimentar a alteração do valor da propriedade programaticamente em tempo de execução carregando a página da Web e usando a interface do usuário (interface do usuário) fornecida para alterar o valor da propriedade.

<%@ page language="c#" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlCS" 
    src="AccountUserControlcs.ascx"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>
      Personalizable User Control with IWebPart Properties
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server" />
      <asp:webpartzone 
        id="zone1" 
        runat="server" 
        headertext="Main" 
        CloseVerb-Enabled="false">
        <zonetemplate>
          <uc1:AccountUserControlCS 
            runat="server" 
            id="accountwebpart" 
            title="Account Form"
            Description="Account Form with default values."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconImageUrl="MyTitleIcon.gif"
            TitleUrl="MyUrl.html"/>
        </zonetemplate>
      </asp:webpartzone>    
    </form>
  </body>
</html>

Comentários

O Description valor da propriedade normalmente é usado como uma cadeia de caracteres descritiva para um controle em catálogos que fornecem listas de WebPart controles e como uma Dica de Ferramenta na barra de título de um controle. O conteúdo da propriedade aparece em uma Dica de Ferramenta quando um usuário posiciona o ponteiro do mouse sobre o texto do título na barra de título de um controle.

Aplica-se a

Produto Versões
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Confira também