Udostępnij przez

IWebPart.Subtitle Właściwość

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Web.UI.WebControls.WebParts
Zestaw:
System.Web.dll

Pobiera ciąg połączony z wartością Title właściwości, aby utworzyć pełny tytuł kontrolki WebPart .

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

Wartość właściwości

String

Ciąg, który służy jako podtytuł kontrolki. Wartością domyślną jest ciąg pusty ("").

Przykłady

W poniższym przykładzie kodu pokazano deklaratywne i programowe użycie Subtitle właściwości . Kompletny kod źródłowy przykładu znajduje się w sekcji Przykład w przeglądzie IWebPart klasy.

Pierwsza część przykładu kodu pokazuje, jak kontrolka Subtitle użytkownika implementuje właściwość . Należy pamiętać, że właściwość jest tylko do odczytu i ma być używana do podawania domyślnego podtytułu, który jest dołączany do głównego tytułu kontrolki.

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

Druga część przykładu kodu pokazuje, w jaki sposób kontrolka użytkownika, która implementuje IWebPart interfejs, jest przywoływana w kontrolce WebPartZone i jak zapisywalne właściwości z IWebPart elementu są ustawiane deklaratywnie na kontrolce. Po załadowaniu strony w przeglądarce należy pamiętać, że domyślna wartość Subtitle właściwości, która została ustawiona w kodzie implementacji kontrolki użytkownika, jest dołączana do tytułu na pasku tytułu kontrolki.

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

Uwagi

Właściwość Subtitle służy do zwracania domyślnego ciągu podtytułu dla WebPart kontrolki, która jest dołączana do tytułu kontrolki na pasku tytułu tytułu.

Jeśli podasz wartość domyślną dla Subtitle właściwości w kontrolce, która implementuje IWebPart interfejs, zestaw kontrolek składników Web Part automatycznie dołącza ją do wartości Title właściwości kontrolki w czasie wykonywania.

Dotyczy

Zobacz też