CatalogPart クラス

リファレンス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

CatalogZoneBase ゾーンに存在するコントロールの基底クラスとして機能し、ユーザーが Web ページに追加できる利用可能な Web サーバーコントロール (特に WebPart コントロール) のカタログを提供します。

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注意してください。 [ お気に入りの引用符 ] コントロールを選択し、[ 追加 ] ボタンをクリックして、コントロールをページに戻します。 [ 閉じる ] ボタンをクリックして、ページを参照モードに戻します。

注意

コントロールも ImportCatalogPart このページで宣言されていますが、コントロールをインポートする方法を示すサンプルの方が複雑であるため、このコード例ではコントロールの完全な使用は示されていません。完全な動作例については、クラスまたはクラスのクラス概要に関する ImportCatalogPart ドキュメントを CatalogZone 参照してください。

注釈

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

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

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

重要

クラスから継承するコントロールは、 CatalogPart クラスから CatalogZoneBase 派生したゾーンにのみ存在できます。

コントロール	説明
PageCatalogPart	ページで閉じられ、ユーザーが再度開いて (ページに追加) できるコントロールが含まれます。この種類のカタログのコントロールは、別のソースからページに既に追加され、ユーザーによって閉じられたコントロールです。
DeclarativeCatalogPart	コントロール内で DeclarativeCatalogPart 宣言されたサーバーコントロールが含まれます。このコントロール自体は、Web ページのマークアップ内のゾーンに含まれています CatalogZoneBase 。
ImportCatalogPart	コントロールを Web ページに追加できるように、ユーザーがコントロールの定義ファイル (状態情報を含むスキーマによって定義された XML ファイル) をカタログにアップロードするためのユーザーインターフェイス (UI) を提供します。コントロール自体は、この種類のカタログには表示されません。カタログは、外部コントロールの定義ファイルにアクセスしてページに追加できるようにするためのメカニズムにすぎません。

クラスは 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 サービスからさまざまなサーバーコントロールを読み込む方法も必要です。

コンストラクター

CatalogPart()

継承クラスインスタンスによって使用されるクラスを初期化します。このコンストラクターは、継承クラスによってのみ呼び出すことができます。

プロパティ

AccessKey	Web サーバーコントロールにすばやく移動できるアクセスキーを取得または設定します。 (継承元 WebControl)
Adapter	コントロール用のブラウザー固有のアダプターを取得します。 (継承元 Control)
AppRelativeTemplateSourceDirectory	このコントロールが含まれている Page オブジェクトまたは UserControl オブジェクトのアプリケーション相対の仮想ディレクトリを取得または設定します。 (継承元 Control)
Attributes	コントロールのプロパティに対応しない任意の属性 (表示専用) のコレクションを取得します。 (継承元 WebControl)
BackColor	Web サーバーコントロールの背景色を取得または設定します。 (継承元 WebControl)
BackImageUrl	パネルコントロールの背景イメージの URL を取得または設定します。 (継承元 Panel)
BindingContainer	このコントロールのデータバインディングを格納しているコントロールを取得します。 (継承元 Control)
BorderColor	Web コントロールの境界線の色を取得または設定します。 (継承元 WebControl)
BorderStyle	Web サーバーコントロールの境界線スタイルを取得または設定します。 (継承元 WebControl)
BorderWidth	Web サーバーコントロールの境界線の幅を取得または設定します。 (継承元 WebControl)
ChildControlsCreated	サーバーコントロールの子コントロールが作成されたかどうかを示す値を取得します。 (継承元 Control)
ChromeState	パーツコントロールが最小化または標準のどちらの状態で表示されるかを示す値を取得または設定します。 (継承元 Part)
ChromeType	Web パーツコントロールを囲む境界線の種類を取得または設定します。 (継承元 Part)
ClientID	ASP.NET によって生成される HTML マークアップのコントロール ID を取得します。 (継承元 Control)
ClientIDMode	ClientID プロパティの値を生成するために使用されるアルゴリズムを取得または設定します。 (継承元 Control)
ClientIDSeparator	ClientID プロパティで使用される区切り記号を表す文字値を取得します。 (継承元 Control)
Context	現在の Web 要求に対するサーバーコントロールに関連付けられている HttpContext オブジェクトを取得します。 (継承元 Control)
Controls	ユーザーインターフェイスの階層構造の指定されたサーバーコントロールの子コントロールを格納している ControlCollection オブジェクトを取得します。 (継承元 Part)
ControlStyle	Web サーバーコントロールのスタイルを取得します。このプロパティは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
ControlStyleCreated	Style オブジェクトが ControlStyle プロパティに対して作成されたかどうかを示す値を取得します。このプロパティは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
CssClass	クライアントで Web サーバーコントロールによって表示されるカスケードスタイルシート (CSS: Cascading Style Sheet) クラスを取得または設定します。 (継承元 WebControl)
DataItemContainer	名前付けコンテナーが IDataItemContainer を実装している場合、名前付けコンテナーへの参照を取得します。 (継承元 Control)
DataKeysContainer	名前付けコンテナーが IDataKeysControl を実装している場合、名前付けコンテナーへの参照を取得します。 (継承元 Control)
DefaultButton	Panel コントロールに格納されている既定のボタンの識別子を取得または設定します。 (継承元 Panel)
Description	パーツコントロールのツールヒントやカタログで使用する、パーツコントロールの動作をまとめた短い語句を取得または設定します。 (継承元 Part)
DesignMode	コントロールがデザインサーフェイスで使用されているかどうかを示す値を取得します。 (継承元 Control)
Direction	テキストを含むコントロールを Panel コントロールに表示する方向を取得または設定します。 (継承元 Panel)
DisplayTitle	CatalogPart コントロールの現在の実際のタイトルを含む文字列を取得します。
Enabled	Web サーバーコントロールを有効にするかどうかを示す値を取得または設定します。 (継承元 WebControl)
EnableTheming	テーマがこのコントロールに適用されるかどうかを示す値を取得または設定します。 (継承元 WebControl)
EnableViewState	要求元クライアントに対して、サーバーコントロールがそのビュー状態と、そこに含まれる任意の子のコントロールのビュー状態を保持するかどうかを示す値を取得または設定します。 (継承元 Control)
Events	コントロールのイベントハンドラーデリゲートのリストを取得します。このプロパティは読み取り専用です。 (継承元 Control)
Font	Web サーバーコントロールに関連付けられたフォントプロパティを取得します。 (継承元 WebControl)
ForeColor	Web サーバーコントロールの前景色 (通常はテキストの色) を取得または設定します。 (継承元 WebControl)
GroupingText	パネルコントロールに格納されているコントロールのグループのキャプションを取得または設定します。 (継承元 Panel)
HasAttributes	コントロールに属性セットがあるかどうかを示す値を取得します。 (継承元 WebControl)
HasChildViewState	現在のサーバーコントロールの子コントロールが、保存されたビューステートの設定を持っているかどうかを示す値を取得します。 (継承元 Control)
Height	Web サーバーコントロールの高さを取得または設定します。 (継承元 WebControl)
HorizontalAlign	パネルの内容の水平方向の配置を取得または設定します。 (継承元 Panel)
ID	サーバーコントロールに割り当てられたプログラム ID を取得または設定します。 (継承元 Control)
IdSeparator	コントロール ID を区別するために使用する文字を取得します。 (継承元 Control)
IsChildControlStateCleared	このコントロールに含まれているコントロールに、コントロールの状態が設定されているかどうかを示す値を取得します。 (継承元 Control)
IsEnabled	コントロールが有効かどうかを示す値を取得します。 (継承元 WebControl)
IsTrackingViewState	サーバーコントロールがビューステートの変更を保存しているかどうかを示す値を取得します。 (継承元 Control)
IsViewStateEnabled	このコントロールでビューステートが有効かどうかを示す値を取得します。 (継承元 Control)
LoadViewStateByID	コントロールがインデックスではなく ID によりビューステートの読み込みを行うかどうかを示す値を取得します。 (継承元 Control)
NamingContainer	同じ ID プロパティ値を持つ複数のサーバーコントロールを区別するための一意の名前空間を作成する、サーバーコントロールの名前付けコンテナーへの参照を取得します。 (継承元 Control)
Page	サーバーコントロールを含んでいる Page インスタンスへの参照を取得します。 (継承元 Control)
Parent	ページコントロールの階層構造における、サーバーコントロールの親コントロールへの参照を取得します。 (継承元 Control)
RenderingCompatibility	レンダリングされる HTML と互換性がある ASP.NET のバージョンを表す値を取得します。 (継承元 Control)
ScrollBars	Panel コントロールのスクロールバーの表示状態と位置を取得または設定します。 (継承元 Panel)
Site	デザインサーフェイスに現在のコントロールを表示するときに、このコントロールをホストするコンテナーに関する情報を取得します。 (継承元 Control)
SkinID	コントロールに適用するスキンを取得または設定します。 (継承元 WebControl)
Style	Web サーバーコントロールの外側のタグにスタイル属性として表示されるテキスト属性のコレクションを取得します。 (継承元 WebControl)
SupportsDisabledAttribute	コントロールの `disabled` プロパティが IsEnabled の場合、レンダリングされた HTML 要素の `false` 属性を "無効" に設定するかどうかを示す値を取得します。 (継承元 Panel)
TabIndex	Web サーバーコントロールのタブインデックスを取得または設定します。 (継承元 WebControl)
TagKey	この Web サーバーコントロールに対応する HtmlTextWriterTag 値を取得します。このプロパティは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
TagName	コントロールタグの名前を取得します。このプロパティは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
TemplateControl	このコントロールを格納しているテンプレートへの参照を取得または設定します。 (継承元 Control)
TemplateSourceDirectory	現在のサーバーコントロールを格納している Page または UserControl の仮想ディレクトリを取得します。 (継承元 Control)
Title	パーツコントロールのタイトルを取得または設定します。 (継承元 Part)
ToolTip	マウスポインターが Web サーバーコントロールの上を移動したときに表示されるテキストを取得または設定します。 (継承元 WebControl)
UniqueID	階層構造で修飾されたサーバーコントロールの一意の ID を取得します。 (継承元 Control)
ValidateRequestMode	ブラウザーからのクライアント入力の安全性をコントロールで調べるかどうかを示す値を取得または設定します。 (継承元 Control)
ViewState	同一のページに対する複数の要求にわたって、サーバーコントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。 (継承元 Control)
ViewStateIgnoresCase	StateBag オブジェクトが大文字小文字を区別しないかどうかを示す値を取得します。 (継承元 Control)
ViewStateMode	このコントロールのビューステートモードを取得または設定します。 (継承元 Control)
Visible	サーバーコントロールがページ上の UI としてレンダリングされているかどうかを示す値を取得または設定します。 (継承元 Control)
WebPartManager	WebPartManager クラスの現在のインスタンスへの参照を取得します。
Width	Web サーバーコントロールの幅を取得または設定します。 (継承元 WebControl)
Wrap	パネルの内容をラップするかどうかを示す値を取得または設定します。 (継承元 Panel)
Zone	CatalogZoneBase コントロールを含んでいる CatalogPart ゾーンへの参照を取得します。

メソッド

AddAttributesToRender(HtmlTextWriter)	背景イメージ、配置、ラップ、および表示する属性のリストの方向に関する情報を追加します。 (継承元 Panel)
AddedControl(Control, Int32)	子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。 (継承元 Control)
AddParsedSubObject(Object)	XML または HTML のいずれかの要素が解析されたことをサーバーコントロールに通知し、サーバーコントロールの ControlCollection オブジェクトに要素を追加します。 (継承元 Control)
ApplyStyle(Style)	指定したスタイルの空白以外の要素を Web コントロールにコピーして、コントロールの既存のスタイル要素を上書きします。このメソッドは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
ApplyStyleSheetSkin(Page)	ページのスタイルシートに定義されたスタイルプロパティをコントロールに適用します。 (継承元 Control)
BeginRenderTracing(TextWriter, Object)	レンダリングデータのデザイン時のトレースを開始します。 (継承元 Control)
BuildProfileTree(String, Boolean)	ページのトレースが有効な場合、サーバーコントロールに関する情報を収集し、これを表示するために Trace プロパティに渡します。 (継承元 Control)
ClearCachedClientID()	キャッシュされた ClientID 値を `null` に設定します。 (継承元 Control)
ClearChildControlState()	サーバーコントロールのすべての子コントロールについて、コントロールの状態情報を削除します。 (継承元 Control)
ClearChildState()	サーバーコントロールのすべての子コントロールのビューステート情報およびコントロールの状態情報を削除します。 (継承元 Control)
ClearChildViewState()	サーバーコントロールのすべての子コントロールのビューステート情報を削除します。 (継承元 Control)
ClearEffectiveClientIDMode()	現在のコントロールインスタンスおよびすべての子コントロールの ClientIDMode プロパティを Inherit に設定します。 (継承元 Control)
CopyBaseAttributes(WebControl)	指定した Web サーバーコントロールから、Style オブジェクトでカプセル化されていないプロパティをこのメソッドの呼び出し元の Web サーバーコントロールにコピーします。このメソッドは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
CreateChildControls()	ASP.NET ページフレームワークによって呼び出され、ポストバックまたはレンダリングの準備として、合成ベースの実装を使うサーバーコントロールに対し、それらのコントロールに含まれる子コントロールを作成するように通知します。 (継承元 Control)
CreateControlCollection()	サーバーコントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。 (継承元 Control)
CreateControlStyle()	すべてのスタイル関連プロパティを実装するために Panel コントロールが内部で使用するスタイルオブジェクトを作成します。 (継承元 Panel)
DataBind()	呼び出されたサーバーコントロールとそのすべての子コントロールにデータソースをバインドします。 (継承元 Part)
DataBind(Boolean)	DataBinding イベントを発生させるオプションを指定して、呼び出されたサーバーコントロールとそのすべての子コントロールにデータソースをバインドします。 (継承元 Control)
DataBindChildren()	データソースをサーバーコントロールの子コントロールにバインドします。 (継承元 Control)
Dispose()	サーバーコントロールが、メモリから解放される前に最終的なクリーンアップを実行できるようにします。 (継承元 Control)
EndRenderTracing(TextWriter, Object)	レンダリングデータのデザイン時のトレースを終了します。 (継承元 Control)
EnsureChildControls()	サーバーコントロールに子コントロールが含まれているかどうかを確認します。含まれていない場合、子コントロールを作成します。 (継承元 Control)
EnsureID()	ID が割り当てられていないコントロールの ID を作成します。 (継承元 Control)
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
FindControl(String)	指定した `id` パラメーターを使用して、サーバーコントロールの現在の名前付けコンテナーを検索します。 (継承元 Control)
FindControl(String, Int32)	指定した `id` および検索に役立つ `pathOffset` パラメーターに指定された整数を使用して、サーバーコントロールの現在の名前付けコンテナーを検索します。この形式の FindControl メソッドはオーバーライドしないでください。 (継承元 Control)
Focus()	コントロールに入力フォーカスを設定します。 (継承元 Control)
GetAvailableWebPartDescriptions()	カタログ内で利用できる WebPart コントロールの説明のコレクションを返します。
GetDesignModeState()	CatalogPart コントロールの親ゾーンの現在の状態を取得します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetRouteUrl(Object)	ルートパラメーターのセットに対応する URL を取得します。 (継承元 Control)
GetRouteUrl(RouteValueDictionary)	ルートパラメーターのセットに対応する URL を取得します。 (継承元 Control)
GetRouteUrl(String, Object)	ルートパラメーターのセットおよびルート名に対応する URL を取得します。 (継承元 Control)
GetRouteUrl(String, RouteValueDictionary)	ルートパラメーターのセットおよびルート名に対応する URL を取得します。 (継承元 Control)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
GetUniqueIDRelativeTo(Control)	指定されたコントロールの UniqueID プロパティのプレフィックス部分を返します。 (継承元 Control)
GetWebPart(WebPartDescription)	このメソッドに渡された WebPart オブジェクトによって参照される WebPartDescription コントロールを、カタログから取得します。
HasControls()	サーバーコントロールに子コントロールが含まれているかどうかを確認します。 (継承元 Control)
HasEvents()	コントロールまたは子コントロールに対してイベントが登録されているかどうかを示す値を返します。 (継承元 Control)
IsLiteralContent()	サーバーコントロールがリテラルな内容だけを保持しているかどうかを決定します。 (継承元 Control)
LoadControlState(Object)	SaveControlState() メソッドによって保存された前回のページ要求からコントロールの状態情報を復元します。 (継承元 Control)
LoadViewState(Object)	SaveViewState() メソッドで保存された前の要求からビューステート情報を復元します。 (継承元 WebControl)
MapPathSecure(String)	仮想パス (絶対パスまたは相対パス) の割り当て先の物理パスを取得します。 (継承元 Control)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
MergeStyle(Style)	指定したスタイルの空白以外の要素を Web コントロールにコピーしますが、コントロールの既存のスタイル要素は上書きしません。このメソッドは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
OnBubbleEvent(Object, EventArgs)	サーバーコントロールのイベントをページの UI サーバーコントロールの階層構造に渡すかどうかを決定します。 (継承元 Control)
OnDataBinding(EventArgs)	DataBinding イベントを発生させます。 (継承元 Control)
OnInit(EventArgs)	Init イベントを発生させます。 (継承元 Control)
OnLoad(EventArgs)	Load イベントを発生させます。 (継承元 Control)
OnPreRender(EventArgs)	PreRender イベントを発生させます。
OnUnload(EventArgs)	Unload イベントを発生させます。 (継承元 Control)
OpenFile(String)	ファイルの読み込みで使用される Stream を取得します。 (継承元 Control)
RaiseBubbleEvent(Object, EventArgs)	イベントのソースおよびその情報をコントロールの親に割り当てます。 (継承元 Control)
RemovedControl(Control)	Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。 (継承元 Control)
Render(HtmlTextWriter)	指定された HTML ライターにコントロールを描画します。 (継承元 WebControl)
RenderBeginTag(HtmlTextWriter)	Panel コントロールの HTML 開始タグを指定したライターに表示します。 (継承元 Panel)
RenderChildren(HtmlTextWriter)	提供された HtmlTextWriter オブジェクトに対してサーバーコントロールの子のコンテンツを出力すると、クライアントで表示されるコンテンツが記述されます。 (継承元 Control)
RenderContents(HtmlTextWriter)	コントロールの内容を指定したライターに出力します。このメソッドは、主にコントロールの開発者によって使用されます。 (継承元 WebControl)
RenderControl(HtmlTextWriter)	指定の HtmlTextWriter オブジェクトにサーバーコントロールの内容を出力し、トレースが有効である場合はコントロールに関するトレース情報を保存します。 (継承元 Control)
RenderControl(HtmlTextWriter, ControlAdapter)	指定した ControlAdapter オブジェクトを使用して、指定した HtmlTextWriter オブジェクトにサーバーコントロールの内容を出力します。 (継承元 Control)
RenderEndTag(HtmlTextWriter)	Panel コントロールの HTML 終了タグを指定したライターに表示します。 (継承元 Panel)
ResolveAdapter()	指定したコントロールを表示するコントロールアダプターを取得します。 (継承元 Control)
ResolveClientUrl(String)	ブラウザーで使用できる URL を取得します。 (継承元 Control)
ResolveUrl(String)	要求側クライアントで使用できる URL に変換します。 (継承元 Control)
SaveControlState()	ページがサーバーにポストバックされた時間以降に発生したすべてのサーバーコントロール状態の変化を保存します。 (継承元 Control)
SaveViewState()	TrackViewState() メソッドが呼び出された後に変更された状態を保存します。 (継承元 WebControl)
SetDesignModeState(IDictionary)	コントロールのデザイン時データを設定します。
SetRenderMethodDelegate(RenderMethod)	サーバーコントロールとその内容を親コントロールに表示するイベントハンドラーデリゲートを割り当てます。 (継承元 Control)
SetTraceData(Object, Object)	トレースデータキーとトレースデータ値を使用して、レンダリングデータのデザイン時トレースのトレースデータを設定します。 (継承元 Control)
SetTraceData(Object, Object, Object)	トレースされたオブジェクト、トレースデータキー、およびトレースデータ値を使用して、レンダリングデータのデザイン時トレースのトレースデータを設定します。 (継承元 Control)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
TrackViewState()	コントロールでそのビューステートの変化を追跡して、その変化をオブジェクトの ViewState プロパティに保存できるようにします。 (継承元 WebControl)

イベント

DataBinding	サーバーコントロールがデータソースに連結すると発生します。 (継承元 Control)
Disposed	サーバーコントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバーコントロールの有効期間における最終段階です。 (継承元 Control)
Init	サーバーコントロールが初期化されると発生します。これは、サーバーコントロールの有効期間における最初の手順です。 (継承元 Control)
Load	サーバーコントロールが Page オブジェクトに読み込まれると発生します。 (継承元 Control)
PreRender	Control オブジェクトの読み込み後、表示を開始する前に発生します。 (継承元 Control)
Unload	サーバーコントロールがメモリからアンロードされると発生します。 (継承元 Control)

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

IAttributeAccessor.GetAttribute(String)	指定された名前の Web コントロールの属性を取得します。 (継承元 WebControl)
IAttributeAccessor.SetAttribute(String, String)	Web コントロールの属性を指定された名前と値に設定します。 (継承元 WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls()	複合パーツコントロールのデザイナーの開発者が、デザインサーフェイスでコントロールの子コントロールを再作成できるようにします。 (継承元 Part)
IControlBuilderAccessor.ControlBuilder	このメンバーの詳細については、「ControlBuilder」をご覧ください。 (継承元 Control)
IControlDesignerAccessor.GetDesignModeState()	このメンバーの詳細については、「GetDesignModeState()」をご覧ください。 (継承元 Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	このメンバーの詳細については、「SetDesignModeState(IDictionary)」をご覧ください。 (継承元 Control)
IControlDesignerAccessor.SetOwnerControl(Control)	このメンバーの詳細については、「SetOwnerControl(Control)」をご覧ください。 (継承元 Control)
IControlDesignerAccessor.UserData	このメンバーの詳細については、「UserData」をご覧ください。 (継承元 Control)
IDataBindingsAccessor.DataBindings	このメンバーの詳細については、「DataBindings」をご覧ください。 (継承元 Control)
IDataBindingsAccessor.HasDataBindings	このメンバーの詳細については、「HasDataBindings」をご覧ください。 (継承元 Control)
IExpressionsAccessor.Expressions	このメンバーの詳細については、「Expressions」をご覧ください。 (継承元 Control)
IExpressionsAccessor.HasExpressions	このメンバーの詳細については、「HasExpressions」をご覧ください。 (継承元 Control)
IParserAccessor.AddParsedSubObject(Object)	このメンバーの詳細については、「AddParsedSubObject(Object)」をご覧ください。 (継承元 Control)

拡張メソッド

FindDataSourceControl(Control)	指定されたコントロールのデータコントロールに関連付けられているデータソースを返します。
FindFieldTemplate(Control, String)	指定されたコントロールの名前付けコンテナー内にある、指定された列のフィールドテンプレートを返します。
FindMetaTable(Control)	格納しているデータコントロールのメタテーブルオブジェクトを返します。
GetDefaultValues(INamingContainer)	指定されたデータコントロールの既定値のコレクションを取得します。
GetMetaTable(INamingContainer)	指定されたデータコントロールのテーブルメタデータを取得します。
SetMetaTable(INamingContainer, MetaTable)	指定されたデータコントロールのテーブルメタデータを設定します。
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)	指定したデータコントロールのテーブルメタデータおよび既定値のマッピングを設定します。
SetMetaTable(INamingContainer, MetaTable, Object)	指定したデータコントロールのテーブルメタデータおよび既定値のマッピングを設定します。
TryGetMetaTable(INamingContainer, MetaTable)	テーブルメタデータが使用できるかどうかを判断します。
EnableDynamicData(INamingContainer, Type)	指定されたデータコントロールの動的データの動作を有効にします。
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)	指定されたデータコントロールの動的データの動作を有効にします。
EnableDynamicData(INamingContainer, Type, Object)	指定されたデータコントロールの動的データの動作を有効にします。

適用対象

次の方法で共有