IWebPart.TitleIconImageUrl 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 die URL eines Bilds ab, mit dem ein Webparts-Steuerelement auf dessen eigener Titelleiste dargestellt wird, oder legt diese fest.

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

Eigenschaftswert

String

Eine Zeichenfolge, die die URL eines Bildes darstellt. Der Standardwert ist eine leere Zeichenfolge ("").

Beispiele

Im folgenden Codebeispiel wird die deklarative und programmgesteuerte Verwendung der TitleIconImageUrl Eigenschaft veranschaulicht. Den vollständigen Quellcode für das Beispiel finden Sie im Abschnitt Beispiel der IWebPart Klassenübersicht.

Der erste Teil des Codebeispiels zeigt, wie das Benutzersteuerelement die TitleIconImageUrl -Eigenschaft implementiert.

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

Der zweite Teil des Codebeispiels veranschaulicht die Methode im Benutzersteuerelement, die programmgesteuert den Wert der TitleIconImageUrl Eigenschaft festlegt, wenn ein Benutzer den entsprechenden Eigenschaftennamen aus den Optionsfeldern auf der Seite auswählt, einen neuen Wert 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 auf das Benutzersteuerelement, das die IWebPart Schnittstelle implementiert, in einem WebPartZone Steuerelement verwiesen wird und wie die TitleIconImageUrl Eigenschaft deklarativ für das Steuerelement festgelegt wird. Beachten Sie, dass ein Platzhalter für das Symbol in der Titelleiste angezeigt wird, wenn Sie die URL für ein reales Bild nicht angeben.

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

Die TitleIconImageUrl -Eigenschaft bietet eine Möglichkeit, ein Symbol einem WebPart Steuerelement zuzuordnen. Das Symbol wird in der eigenen Titelleiste des Steuerelements angezeigt. Aus Gründen der thematischen Konsistenz sollten Anwendungsentwickler dieses Symbol dem Bild ähneln, das das Steuerelement in einem Katalog von Webpart-Steuerelementen darstellt (das Bild, auf das in der CatalogIconImageUrl -Eigenschaft verwiesen wird).

Da sie im Webparts-Steuerelementsatz implementiert ist, kann die TitleIconImageUrl Eigenschaft von Endbenutzern personalisiert werden, um das Bild oder symbol zu ändern, das in der Titelleiste eines Steuerelements angezeigt wird.

Gilt für:

Freigeben über