IWebPart.Subtitle Egenskap

Definition

Namnområde:
System.Web.UI.WebControls.WebParts
Sammansättning:
System.Web.dll

Hämtar en sträng som sammanfogas med egenskapsvärdet Title för att skapa en fullständig rubrik för en WebPart kontroll.

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

Egenskapsvärde

String

En sträng som fungerar som underrubrik för kontrollen. Standardvärdet är en tom sträng ("").

Exempel

I följande kodexempel visas deklarativ och programmatisk användning av Subtitle egenskapen. Den fullständiga källkoden för exemplet finns i avsnittet Exempel i klassöversikten IWebPart .

Den första delen av kodexemplet visar hur användarkontrollen implementerar Subtitle egenskapen. Observera att egenskapen är skrivskyddad och är avsedd att användas för att tillhandahålla en standardrubrik som läggs till i huvudrubriken för en kontroll.

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

Den andra delen av kodexemplet visar hur användarkontrollen som implementerar gränssnittet refereras IWebPart i en WebPartZone kontroll och hur de skrivbara egenskaperna från IWebPart anges deklarativt på kontrollen. När du har läst in sidan i en webbläsare bör du observera att standardvärdet Subtitle för egenskapen, som angavs i användarkontrollens implementeringskod, läggs till i rubriken i kontrollens namnlist.

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

Kommentarer

Egenskapen Subtitle används för att returnera en standardrubriksträng för en WebPart kontroll som läggs till i kontrollens rubrik i namnlisten.

Om du anger ett standardvärde för Subtitle egenskapen i en kontroll som implementerar IWebPart gränssnittet lägger webbdelskontrolluppsättningen automatiskt till värdet Title för egenskapen för kontrollen vid körning.

Gäller för

Se även