CatalogPart クラス

定義

public ref class CatalogPart abstract : System::Web::UI::WebControls::WebParts::Part

[System.ComponentModel.Bindable(false)]
public abstract class CatalogPart : System.Web.UI.WebControls.WebParts.Part

[<System.ComponentModel.Bindable(false)>]
type CatalogPart = class
    inherit Part

Public MustInherit Class CatalogPart
Inherits Part

継承

Object

Control

WebControl

Panel

Part

CatalogPart

派生

System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

属性

BindableAttribute

例

次のコード例では、 クラスの使用方法を CatalogPart 示します。 クラスは抽象であるため、コード内で直接使用されるわけではありません。 ただし、この例では、Web パーツ コントロール セットで提供される CatalogPart 3 つの派生コントロールを操作して、一般的な使用シナリオを示す方法を示します。

コード例には、次の 4 つの部分があります。

• Web ページの表示モードを変更できるユーザー コントロール。

• Web ページ。Web パーツ コントロール セットと共に提供される 3 つの CatalogPart コントロールが含まれており、これらはすべて Web ページ上の 内 CatalogZone で宣言されています。 ページには、ゾーンで WebPartZone 宣言されたコントロールを AdRotator 含むコントロールも含まれています。

• Web ページのコントロールに表示される引用符を AdRotator 含む XML ファイル。

• 例を実行する方法の説明。

このコード例の最初の部分は、ユーザーが Web ページの表示モードを変更できるようにするユーザー コントロールです。 このコードは、使用している言語に応じて、DisplayModeMenuCS.ascx または DisplayModeMenuVB.ascx という名前のファイルに保存する必要があります。 このコントロールの表示モードとソース コードの説明の詳細については、「 チュートリアル: Web パーツ ページでの表示モードの変更」を参照してください。

<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }
    
  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
  ' Use a field to reference the current WebPartManager.
  Dim _manager As WebPartManager

  Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler Page.InitComplete, AddressOf InitComplete
  End Sub

  Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
      
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
      
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In _manager.SupportedDisplayModes
      Dim modeName As String = mode.Name
      ' Make sure a mode is enabled before adding it.
      If mode.IsEnabled(_manager) Then
        Dim item As New ListItem(modeName, modeName)
        DisplayModeDropdown.Items.Add(item)
      End If
    Next mode
      
    ' If shared scope is allowed for this user, display the scope-switching
    ' UI and select the appropriate radio button for the current user scope.
    If _manager.Personalization.CanEnterSharedScope Then
      Panel2.Visible = True
      If _manager.Personalization.Scope = PersonalizationScope.User Then
        RadioButton1.Checked = True
      Else
        RadioButton2.Checked = True
      End If
    End If
   
  End Sub

  ' Change the page to the selected display mode.
  Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue   
    Dim mode As WebPartDisplayMode = _
      _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
      _manager.DisplayMode = mode
    End If

  End Sub
   
  ' Set the selected item equal to the current display mode.
  Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
    Dim items As ListItemCollection = DisplayModeDropdown.Items
    Dim selectedIndex As Integer = _
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
    DisplayModeDropdown.SelectedIndex = selectedIndex

  End Sub

  ' Reset all of a user's personalization data for the page.
  Protected Sub LinkButton1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    _manager.Personalization.ResetPersonalizationState()
    
  End Sub

  ' If not in User personalization scope, toggle into it.
  Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.Scope = PersonalizationScope.Shared Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub
   
  ' If not in Shared scope, and if user is allowed, toggle the scope.
  Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.CanEnterSharedScope AndAlso _
      _manager.Personalization.Scope = PersonalizationScope.User Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub

</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

コード例の 2 番目の部分は Web ページです。 ページにはコントロールが CatalogZone 含まれており、子 <zonetemplate> 要素内では、Web パーツ コントロール セットで提供される 3 つの CatalogPart コントロールのそれぞれが宣言されます。 一部のDeclarativeCatalogPart属性はコントロールに設定され、ページのスクリプト> セクションでも<、そのコントロールの属性にプログラムでアクセスされます。 コントロールには、ユーザーがページに追加できる 1 つの子コントロール (標準 Calendar コントロール) が含まれています。 CatalogZoneコントロールと CatalogPart コントロールは、ユーザーがページをカタログ表示モードに切り替えたときにのみ表示されます。

ページにはコントロールも含まれており WebPartZone 、その子 <zonetemplate> 要素内には AdRotator XML ファイルからの交互のメッセージを表示するコントロールがあります。 ユーザーがページの表示時に閉じる動詞をクリックしてコントロールを閉じる場合、コントロールはページ カタログに追加され、ユーザーはページをカタログ表示モードに切り替え、コントロールにアクセス PageCatalogPart し、閉じたコントロールを再び追加することで、コントロールを再度開くことができます。

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  
  // <snippet3>
  protected void Button1_Click(object sender, EventArgs e)
  {
    
    Label1.Text = "<h3>DeclarativeCatalogPart Property Values</h3>" +
      "Display Title: " + DeclarativeCatalogPart1.DisplayTitle + 
      "<br />" + 
      "Description: " + DeclarativeCatalogPart1.Description + 
      "<br />" + 
      "Chrome type: " + DeclarativeCatalogPart1.ChromeType.ToString();
  }

  protected void WebPartManager1_DisplayModeChanged(object sender, 
    WebPartDisplayModeEventArgs e)
  {
    Label1.Text = String.Empty;
    if (WebPartManager1.DisplayMode == WebPartManager.CatalogDisplayMode)
      Button1.Visible = true;
    else
      Button1.Visible = false;
  }
  // </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CatalogPart Samples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" 
      OnDisplayModeChanged="WebPartManager1_DisplayModeChanged" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:AdRotator ID="AdRotator1" runat="server" 
          AdvertisementFile="~/quotes.xml" 
          Title="Favorite Quotes"  />         
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="DeclarativeCatalogPart1" 
          runat="server"
          Title="Controls to Add"
          ChromeType="TitleOnly"
          Description="Provides a list of controls that users can
            add to the page.">
          <WebPartsTemplate>
            <asp:Calendar ID="Calendar1" runat="server" 
              Title="My Calendar" />         
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
        <asp:importcatalogpart id="ImportCatalogPart1" runat="server" />
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" runat="server" 
      Text="Display DeclarativeCatalogPart Properties" 
      OnClick="Button1_Click" 
      Visible="false"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" />
  </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  ' <snippet3>
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Label1.Text = "<h3>DeclarativeCatalogPart Property Values</h3>" & _
      "Display Title: " & DeclarativeCatalogPart1.DisplayTitle & _
      "<br />" & _
      "Description: " & DeclarativeCatalogPart1.Description & _
      "<br />" & _
      "Chrome type: " & DeclarativeCatalogPart1.ChromeType.ToString()
    
  End Sub

  Protected Sub WebPartManager1_DisplayModeChanged(ByVal sender _
    As Object, ByVal e As WebPartDisplayModeEventArgs)
    Label1.Text = String.Empty
    If WebPartManager1.DisplayMode _
      Is WebPartManager.CatalogDisplayMode Then
      Button1.Visible = True
    Else
      Button1.Visible = False
    End If
  End Sub
  ' </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CatalogPart Samples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" 
      OnDisplayModeChanged="WebPartManager1_DisplayModeChanged" />
    <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:AdRotator ID="AdRotator1" runat="server" 
          AdvertisementFile="~/quotes.xml" 
          Title="Favorite Quotes"  />         
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="DeclarativeCatalogPart1" 
          runat="server"
          Title="Controls to Add"
          ChromeType="TitleOnly"
          Description="Provides a list of controls that users can
            add to the page.">
          <WebPartsTemplate>
            <asp:Calendar ID="Calendar1" runat="server" 
              Title="My Calendar" />         
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
        <asp:importcatalogpart id="ImportCatalogPart1" runat="server" />
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" runat="server" 
      Text="Display DeclarativeCatalogPart Properties" 
      OnClick="Button1_Click" 
      Visible="false"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" />
  </form>
</body>
</html>

コード例の 3 番目の部分は XML ファイルです。 このファイルは、ページで宣言されているコントロールの AdRotator ソース ファイルです。 ファイルには、コントロールが定期的に回転して表示する、お気に入りの引用符が含まれています。 次の内容をテキスト エディターにコピーし、ファイルを Quotes.xml として保存します。

<?xml version="1.0" encoding="utf-8" ?>  
<Advertisements>  
  <Ad>  
    <AlternateText>  
      A stitch in time saves nine.  
    </AlternateText>      
  </Ad>  
  <Ad>  
    <AlternateText>  
      A penny saved is a penny earned.  
    </AlternateText>      
  </Ad>  
</Advertisements>  

コード例を実行するには、ブラウザーで Web ページを読み込みます。 [表示モード] ドロップダウン コントロールを使用して、[カタログ] を選択し、ページをカタログ表示モードに切り替えます。 コントロールを含むコントロールに対して設定されたさまざまなプロパティ値の DeclarativeCatalogPart 効果に Calendar 注目してください。 コントロールの横にあるチェック ボックスをオンに Calendar し、[ 追加 ] をクリックしてページに追加できます。 [ Display DeclarativeCatalogPart Properties]\(宣言型CatalogPart プロパティの表示 \) ボタンをクリックすると、そのコントロールのプロパティの値が表示されます。 [ 閉じる ] をクリックすると、ページが通常のブラウズ モードに戻り、ページに追加されたコントロールが表示されます。 次に、コントロールの動詞メニュー AdRotator (タイトル バーの下向き矢印で表されます) に移動し、[ 閉じる] をクリックします。 コントロールが閉じられ、ページ カタログに追加されます。 ページをもう一度カタログ表示モードに切り替え、[ページ カタログ] ハイパーリンクをクリックしてコントロールを PageCatalogPart 表示します。 コントロールは、タイトル Favorite Quotes によって参照されることにAdRotator注意してください。 [ お気に入りの引用符 ] コントロールを選択し、[ 追加 ] ボタンをクリックして、コントロールをページに戻します。 [ 閉じる ] ボタンをクリックして、ページを参照モードに戻します。

注釈

CatalogPartクラスは、ゾーンに存在CatalogZoneBaseする特殊なコントロールの基底クラスです。 これらの派生 CatalogPart コントロールは、エンド ユーザーが Web ページに追加できる Web サーバー コントロールのカタログを提供します。 サーバー コントロールを追加または削除することで、Web ページの機能を柔軟に変更できるようにエンド ユーザーに提供する場合は、Web アプリケーションでコントロールを使用 CatalogPart します。

カタログは、ユーザーが Web ページに追加できる 1 つ以上の使用可能な Web サーバー コントロール (コントロール、ASP.NET サーバー コントロール、カスタム コントロールまたはユーザー コントロールを含む WebPart ) の一覧です。 カタログには、エンド ユーザーの指示テキストなど、いくつかの一般的な特性があります。各サーバー コントロールを説明するテキスト。ヘルパー コントロールを使用してサーバー コントロールを選択し、ページに追加します。共通のヘッダー、フッター、および罫線。および多数のスタイル属性。

次の表で CatalogPart 説明するように、Web パーツ コントロール セットには 3 種類のコントロールが用意されています。 コントロールの CatalogPart 種類ごとに、異なるソースからページに追加されるサーバー コントロールが含まれています。

クラスは CatalogPart 基底 Part クラスから継承されるため、Web パーツ コントロール セット内の他のパーツ コントロールの一般的な動作が行われます。 さらに、カタログ機能に役立ついくつかのメンバーが追加されます。 プロパティは DisplayTitle 、コントロールのタイトルとして現在表示されている実際の文字列を取得します。 このプロパティの値は、プロパティの Title 値と同じにすることができます。または、そのプロパティに値が割り当てられていない場合は、.NET Framework によって提供される既定値を指定できます。 プロパティと Zone プロパティはWebPartManagerどちらも、コントロールのライフ サイクルCatalogPartを制御する 2 つの重要なオブジェクト (コントロールWebPartManagerとCatalogZoneBaseコントロールを含むゾーン) に簡単にCatalogPartアクセスできます。

CatalogPartクラスには、いくつかのメソッドも含まれています。 メソッドは GetAvailableWebPartDescriptions 、継承者によって実装される必要がある抽象メソッドとして宣言されています。 その目的は、カタログ内のコントロールの説明のコレクションを返します。 関連する メソッド GetWebPart( ) も抽象として宣言されており、継承者によって実装される必要があります。 このメソッドは、パラメーターとして メソッドに渡される説明に基づいてコントロールのインスタンス WebPart を返すことを目的としています。

注意 (実装者)

CatalogPartクラスは抽象であるため、Web ページで直接使用することはできません。 Web パーツ コントロール セットには、基本クラスから派生し、Web パーツ ページで使用できる 3 つの CatalogPart コントロール (このトピックの「解説」セクションの表に記載されています) が用意されています。 これらのコントロールは、Web サーバー コントロールのカタログを作成するために必要なほとんどの機能を提供する必要があります。 ただし、カスタム CatalogPart コントロールを開発する必要がある特殊なニーズがある場合があります。 たとえば、Web サービスを介して、またはデータベースから直接サーバー コントロールを使用できるようにする特別な種類 CatalogPart のコントロールを作成できます。 これを行うには、 クラスから継承する CatalogPart 必要があります。 また、抽象 GetAvailableWebPartDescriptions() および GetWebPart(WebPartDescription) メソッドをオーバーライドして、 またはその他のサーバー コントロールとその説明を WebPart 返す実装を提供する必要があります。 また、データベースまたは Web サービスからさまざまなサーバー コントロールを読み込む方法も必要です。

コンストラクター

プロパティ

メソッド

イベント

明示的なインターフェイスの実装

拡張メソッド

適用対象

こちらもご覧ください

• CatalogZoneBase
• チュートリアル: カスタム サーバー コントロールの開発と使用
• チュートリアル: Web パーツ ページでの表示モードの変更
• ASP.NET Web パーツ コントロール