Share via

IWebPart.Subtitle Eigenschaft

  • Referenz

Definition

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

Ruft eine Zeichenfolge ab, die mit dem Wert der Title-Eigenschaft verkettet wird, um einen vollständigen Titel für ein WebPart-Steuerelement zu bilden.

public:
 property System::String ^ Subtitle { System::String ^ get(); };
public string Subtitle { get; }
member this.Subtitle : string
Public ReadOnly Property Subtitle As String

Eigenschaftswert

String

Eine Zeichenfolge, die als Untertitel für das Steuerelement fungiert. Der Standardwert ist eine leere Zeichenfolge ("").

Beispiele

Im folgenden Codebeispiel wird die deklarative und programmgesteuerte Verwendung der Subtitle 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 Subtitle -Eigenschaft implementiert. Beachten Sie, dass die Eigenschaft schreibgeschützt ist und zum Bereitstellen eines Standardtitels verwendet werden soll, der an den Haupttitel eines Steuerelements angefügt wird.

public string Subtitle
{
  get
  {
    object objSubTitle = ViewState["Subtitle"];
    if (objSubTitle == null)
      return "My Subtitle";

    return (string)objSubTitle;
  }

}

ReadOnly Property Subtitle() As String _
  Implements IWebPart.Subtitle
  Get
    Dim objSubTitle As Object = ViewState("Subtitle")
    If objSubTitle Is Nothing Then
      Return "My Subtitle"
    End If
    Return CStr(objSubTitle)
  End Get
End Property

Der zweite Teil des Codebeispiels zeigt, wie auf das Benutzersteuerelement, das die IWebPart Schnittstelle implementiert, in einem WebPartZone Steuerelement verwiesen wird und wie die schreibbaren Eigenschaften von deklarativ IWebPart für das Steuerelement festgelegt werden. Nachdem Sie die Seite in einem Browser geladen haben, beachten Sie, dass der Standardwert der Subtitle Eigenschaft, der im Implementierungscode des Benutzersteuerelements festgelegt wurde, in der Titelleiste des Steuerelements an den Titel angefügt wird.

<%@ 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 Subtitle -Eigenschaft wird verwendet, um eine Standard-Untertitelzeichenfolge für ein WebPart Steuerelement zurückzugeben, das an den Titel des Steuerelementtitels in der Titelleiste angefügt wird.

Wenn Sie einen Standardwert für die Subtitle Eigenschaft in einem Steuerelement bereitstellen, das die IWebPart Schnittstelle implementiert, fügt der Webpart-Steuerelementsatz ihn zur Laufzeit automatisch an den Wert der Title -Eigenschaft des Steuerelements an.

Gilt für:

Weitere Informationen