IWebPart.TitleIconImageUrl Propriedade

Definição

Obtém ou define a URL para uma imagem usada para representar um controle de Web Parts na barra de título do próprio controle.

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

Valor da propriedade

Uma cadeia de caracteres que representa a URL para uma imagem. 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 TitleIconImageUrl propriedade . O código-fonte completo do 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 TitleIconImageUrl propriedade .

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

    return (string)objTitle;
  }
  set
  {
    ViewState["TitleIconImageUrl"] = value;
  }
}
Public Property TitleIconImageUrl() As String _
  Implements IWebPart.TitleIconImageUrl
  Get
    Dim objTitle As Object = ViewState("TitleIconImageUrl")
    If objTitle Is Nothing Then
      Return String.Empty
    End If
    Return CStr(objTitle)
  End Get
  Set(ByVal value As String)
    ViewState("TitleIconImageUrl") = value
  End Set
End Property

A segunda parte do exemplo de código demonstra o método no controle de usuário que define programaticamente o valor da TitleIconImageUrl 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;
  }
}
' Update the selected IWebPart property value.
Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
  Dim propertyValue As String = Server.HtmlEncode(TextBox3.Text)
  TextBox3.Text = String.Empty
    
  Select Case RadioButtonList1.SelectedValue
    Case "title"
      Me.Title = propertyValue
    Case "description"
      Me.Description = propertyValue
    Case "catalogiconimageurl"
      Me.CatalogIconImageUrl = propertyValue
    Case "titleiconimageurl"
      Me.TitleIconImageUrl = propertyValue
    Case "titleurl"
      Me.TitleUrl = propertyValue
    Case Else
  End Select

End Sub 'Button1_Click

A terceira parte do exemplo de código mostra como o controle de usuário que implementa a IWebPart interface é referenciado em um WebPartZone controle e como a TitleIconImageUrl propriedade é definida declarativamente no controle. Observe que, se você não fornecer a URL para uma imagem real, um espaço reservado para o ícone aparecerá na barra de título.

<%@ 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>
<%@ page language="VB" %>
<%@ register tagprefix="uc1" 
    tagname="AccountUserControlVB" 
    src="AccountUserControlvb.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:AccountUserControlVB 
            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

A TitleIconImageUrl propriedade fornece uma maneira de associar um ícone a um WebPart controle . O ícone aparece na barra de título do controle. Para consistência temática, os desenvolvedores de aplicativos podem querer tornar esse ícone semelhante à imagem que representa o controle em um catálogo de controles de Web Parts (a imagem referenciada na CatalogIconImageUrl propriedade ).

Como ela é implementada no conjunto de controle de Web Parts, a TitleIconImageUrl propriedade pode ser personalizada pelos usuários finais para alterar a imagem ou o ícone que aparece na barra de título de um controle.

Aplica-se a

Confira também