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 参照してください。

コード例の最初の部分では、ユーザー コントロールが プロパティを実装する方法を 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

コード例の 2 番目の部分では、インターフェイスを実装 IWebPart するユーザー コントロールをコントロールで WebPartZone 参照する方法と、 の書き込み可能なプロパティ 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値に自動的に追加されます。

適用対象

こちらもご覧ください