IWebPart.Subtitle 屬性

  • 參考

定義

命名空間:
System.Web.UI.WebControls.WebParts
組件:
System.Web.dll

取得與 Title 屬性值串連的字串，組成 WebPart 控制項的完整標題。

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

屬性值

String

字串，做為控制項的副標題。 預設值為空字串 ("")。

範例

下列程式碼範例示範 屬性的 Subtitle 宣告式和程式設計用法。 此範例的完整原始程式碼位於類別概觀的 IWebPart Example 區段中。

程式碼範例的第一個部分示範使用者控制項如何實作 Subtitle 屬性。 請注意，屬性是唯讀的，而且是要用來提供附加至控制項主要標題的預設子標題。

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

程式碼範例的第二個部分示範如何在 控制項中 WebPartZone 參考實 IWebPart 作 介面的使用者控制項，以及如何以宣告方式在 控制項上設定 來自 IWebPart 的可寫入屬性。 在瀏覽器中載入頁面之後，請注意，在使用者控制項的實作程式碼中設定的 屬性預設值 Subtitle 會附加至控制項標題列中的標題。

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

備註

屬性 Subtitle 是用來傳回附加至標題列中控制項標題之控制項的預設子標題字串 WebPart 。

如果您在實 IWebPart 作 介面的控制項中提供 屬性的預設值 Subtitle ，Web 元件控制項會在執行時間自動將它附加至 控制項的 Title 屬性值。

適用於

另請參閱