Compartilhar via

IWebPart.TitleUrl Propriedade

  • Referência

Definição

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

Obtém ou define uma URL para informações complementares sobre um controle WebPart.

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

Valor da propriedade

String

Uma cadeia de caracteres que representa uma URL para obter mais informações sobre um WebPart 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 TitleUrl 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 TitleUrl propriedade .

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

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

Public Property TitleUrl() As String _
  Implements IWebPart.TitleUrl
  Get
    Dim objTitle As Object = ViewState("TitleUrl")
    If objTitle Is Nothing Then
      Return String.Empty
    End If
    Return CStr(objTitle)
  End Get
  Set(ByVal value As String)
    ViewState("TitleUrl") = 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 TitleUrl 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 do usuário que implementa a IWebPart interface é referenciado em um WebPartZone controle e como a TitleUrl propriedade é definida declarativamente no controle. Observe que, se você não fornecer uma URL para uma página real e, em seguida, um usuário clicar no link na barra de título, uma mensagem de erro será exibida.

<%@ 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

Quando você atribui uma URL à TitleUrl propriedade , o título do controle se torna um link. A finalidade dessa propriedade é fornecer uma maneira conveniente para os usuários finais acessarem informações adicionais sobre um controle. As informações adicionais podem fornecer dados de direitos autorais, dados de contato, detalhes sobre o criador do controle ou um resumo da finalidade do controle.

Observação

Normalmente, você não usaria a TitleUrl propriedade para vincular ao conteúdo da Ajuda. A melhor maneira de fornecer um link para a Ajuda para um controle é usar a HelpUrl propriedade .

Aplica-se a

Confira também