IWebPart.TitleUrl Eigenschaft

Referenz

Definition

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

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft eine URL zu ergänzenden Informationen über ein WebPart-Steuerelement ab oder legt diese fest.

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

Eigenschaftswert

String

Eine Zeichenfolge, die eine URL zu weiteren Informationen über ein WebPart-Steuerelement darstellt. Der Standardwert ist eine leere Zeichenfolge ("").

Beispiele

Im folgenden Codebeispiel wird die deklarative und programmgesteuerte Verwendung der TitleUrl Eigenschaft veranschaulicht. Der vollständige Quellcode für das Beispiel wird im Abschnitt "Beispiel" der IWebPart Klassenübersicht gefunden.

Im ersten Teil des Codebeispiels wird gezeigt, wie das Benutzersteuerelement die TitleUrl Eigenschaft implementiert.

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

Im zweiten Teil des Codebeispiels wird die Methode im Benutzersteuerelement veranschaulicht, die den Wert der Eigenschaft programmgesteuert festlegt, wenn ein Benutzer den entsprechenden Eigenschaftennamen aus den Optionsschaltflächen auf der Seite auswählt, einen neuen Wert TitleUrl im Textfeld festlegt und dann auf die Schaltfläche " Aktualisieren " klickt.

Wichtig

Dieses Beispiel umfasst ein Textfeld, das Benutzereingaben akzeptiert, die ein potenzielles Sicherheitsrisiko darstellen. Standardmäßig stellen ASP.NET-Webseiten sicher, dass Benutzereingaben keine Skript- oder HTML-Elemente enthalten. Weitere Informationen finden Sie unter Übersicht über Skriptangriffe.

// 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

Der dritte Teil des Codebeispiels zeigt, wie das Benutzersteuerelement, auf das die IWebPart Schnittstelle implementiert wird, in einem WebPartZone Steuerelement verwiesen wird und wie die TitleUrl Eigenschaft deklarativ auf das Steuerelement festgelegt wird. Beachten Sie, dass wenn Sie keine URL zu einer echten Seite bereitstellen und dann auf den Link in der Titelleiste klicken, wird eine Fehlermeldung angezeigt.

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

Hinweise

Wenn Sie der TitleUrl Eigenschaft eine URL zuweisen, wird der Titel des Steuerelements zu einem Link. Der Zweck dieser Eigenschaft besteht darin, Endbenutzern eine bequeme Möglichkeit zu bieten, auf zusätzliche Informationen zu einem Steuerelement zuzugreifen. Die zusätzlichen Informationen könnten Copyright-Daten, Kontaktdaten, Details zum Ersteller des Steuerelements oder eine Zusammenfassung des Zwecks des Steuerelements bereitstellen.

Hinweis

Normalerweise würden Sie die TitleUrl Eigenschaft nicht verwenden, um mit Hilfeinhalten zu verknüpfen. Die beste Möglichkeit, einen Link zur Hilfe für ein Steuerelement bereitzustellen, besteht darin, die HelpUrl Eigenschaft zu verwenden.

Gilt für

Freigeben über