CatalogPart クラス

定義

CatalogZoneBase ゾーンに配置し、ユーザーが Web ページに追加できる Web サーバー コントロール (特に WebPart コントロール) のカタログを提供するコントロールの基本クラスとして機能します。Serves as the base class for controls that reside in CatalogZoneBase zones, and that provide catalogs of available Web server controls (especially WebPart controls) that users can add to a Web page.

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
type CatalogPart = class
    inherit Part
Public MustInherit Class CatalogPart
Inherits Part
継承
派生
属性

CatalogPartクラスの使用例を次のコード例に示します。The following code example demonstrates the use of the CatalogPart class. クラスは抽象クラスであるため、コード内で直接使用されることはありません。Because the class is abstract, it is not used directly in code. ただし、この例では、Web パーツコントロールセットで提供CatalogPartされる3つの派生コントロールを操作して、一般的な使用シナリオを示す方法を示します。However, the example shows how to work with the three derived CatalogPart controls provided with the Web Parts control set to demonstrate common usage scenarios.

コード例には、次の4つの部分があります。There are four parts to the code example:

  • Web ページの表示モードを変更できるユーザーコントロール。A user control that enables you to change display modes on the Web page.

  • Web ページ。 Web パーツコントロールセットで提供CatalogPartされる3つのコントロールが含まれ、web ページCatalogZone上の内で宣言されます。A Web page, which contains the three CatalogPart controls provided with the Web Parts control set, all declared within a CatalogZone on a Web page. また、このページにWebPartZoneはコントロールが含まAdRotatorれており、コントロールはゾーン内で宣言されています。The page also contains a WebPartZone control, with an AdRotator control declared in the zone.

  • Web ページ上のAdRotatorコントロールに表示される引用符を含む XML ファイル。An XML file that contains quotations displayed in the AdRotator control on the Web page.

  • 例を実行する方法について説明します。An explanation of how to run the example.

このコード例の最初の部分は、ユーザーが Web ページの表示モードを変更できるようにするユーザーコントロールです。The first part of this code example is the user control that enables users to change display modes on a Web page. このコードは、DisplayModeMenuCS. .ascx という名前のファイルに保存する必要があります (使用している言語によって異なります)。You should save this code in a file named DisplayModeMenuCS.ascx or DisplayModeMenuVB.ascx (depending on which language you are using). このコントロールの表示モードとソースコードの説明の詳細については、 「チュートリアル:Web パーツページでの表示モードの変更For details about display modes and a description of the source code in this control, see Walkthrough: Changing Display Modes on a Web Parts Page.

<%@ 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="&nbsp;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="&nbsp;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 ページです。The second part of the code example is the Web page. このページにはCatalogZoneコントロールが含まれ、子<zonetemplate>要素内には、Web パーツCatalogPartコントロールセットで提供される3つの各コントロールが宣言されています。The page contains a CatalogZone control, and within the child <zonetemplate> element, each of the three CatalogPart controls provided with the Web Parts control set is declared. DeclarativeCatalogPartコントロールにはいくつかの属性が設定され、 <ページの [スクリプト >] セクションにも、そのコントロールの属性がプログラムによってアクセスされます。Some attribute are set on the DeclarativeCatalogPart control, and also in the <script> section of the page, the attributes on that control are accessed programmatically. コントロールには、ユーザーがページに追加できる子コントロールとして、標準Calendarコントロールが1つ含まれています。The control contains one child control that a user can add to the page: a standard Calendar control. コントロールCatalogZoneCatalogPartコントロールは、ユーザーがページをカタログ表示モードに切り替えたときにのみ表示されます。The CatalogZone and CatalogPart control will only be visible when the user switches the page to catalog display mode.

このページにはWebPartZoneコントロールも含まれており、その子<zonetemplate>要素AdRotator内には、XML ファイルからの交互のメッセージを表示するコントロールがあります。The page also contains a WebPartZone control, and within its child <zonetemplate> element is an AdRotator control that displays alternating messages from an XML file. ページが表示されているときにユーザーが閉じる動詞をクリックしてコントロールを閉じた場合、コントロールはページカタログに追加され、ユーザーはページをカタログ表示モードに切り替え、 PageCatalogPartコントロールにアクセスして、コントロールを閉じました。If a user closes the control by clicking its close verb when the page is displayed, the control is added to the page catalog, and the user can reopen the control by switching the page into catalog display mode, accessing the PageCatalogPart control, and adding back the closed control.

<%@ 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 ファイルです。The third part of the code example is the XML file. このファイルは、ページで宣言さAdRotatorれているコントロールのソースファイルです。This file is a source file for the AdRotator control that is declared on the page. このファイルには、コントロールによって定期的に回転および表示される、お気に入りの引用符が含まれています。The file contains favorite quotations, which the control periodically rotates and displays. 次の内容をテキストエディターにコピーし、ファイルを引用符で囲んで保存します。Copy the following content into a text editor, and save the file as 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 ページを読み込みます。To run the code example, load the Web page in a browser. [表示モード] ドロップダウンコントロールを使用してカタログを選択し、ページをカタログ表示モードに切り替えます。Use the Display Modes drop-down control to select Catalog and switch the page to catalog display mode. コントロールCalendarを含むDeclarativeCatalogPartコントロールに設定されたさまざまなプロパティ値の効果に注意してください。Notice the effects of the various property values that were set on the DeclarativeCatalogPart control that contains the Calendar control. コントロールのCalendar横にあるチェックボックスをオンにし、[追加] をクリックしてそのコントロールをページに追加できます。You can select the check box next to the Calendar control, and click Add to add it to the page. [DeclarativeCatalogPart のプロパティを表示] ボタンをクリックすると、そのコントロールのプロパティの値が表示されます。If you click the Display DeclarativeCatalogPart Properties button, the values of the properties for that control are displayed. [閉じる] をクリックすると、ページが通常ブラウズモードに戻り、ページに追加したコントロールが表示されます。You can click Close to return the page to normal browse mode and see the added control on the page. 次に、コントロールのAdRotator動詞メニュー (タイトルバーの下向き矢印によって表されます) にアクセスし、[閉じる] をクリックします。Now go to the verbs menu on the AdRotator control (represented by the downward arrow in the title bar) and click Close. コントロールが閉じられ、ページカタログに追加されます。The control is closed and added to the page catalog. ページをもう一度カタログ表示モードに切り替え、ページカタログのハイパーリンクをクリックしてPageCatalogPartコントロールを表示します。Switch the page into catalog display mode again, and click the Page Catalog hyperlink to display the PageCatalogPart control. コントロールはタイトル、お気に入りの引用符によって参照されていることに注意してください。 AdRotatorNote that the AdRotator control is referenced there by its title, Favorite Quotes. [お気に入りの引用符] コントロールを選択し、[追加] ボタンをクリックして、コントロールをページに戻します。Select the Favorite Quotes control, and click the Add button to add the control back to the page. [閉じる] ボタンをクリックして、ページをブラウズモードに戻します。Click the Close button to return the page to browse mode.

注意

このページでもコントロールが宣言されていますが、コントロールのインポート方法を示すサンプルが含まれているため、このコード例ではコントロールを完全に使用することはできません。ImportCatalogPartThe ImportCatalogPart control is also declared on this page, but a sample showing how to import controls is more involved, so full use of the control is not demonstrated in this code example. 完全な動作例についてImportCatalogPart CatalogZoneは、クラスまたはクラスのクラスの概要に関するドキュメントを参照してください。To see a full working example, see the class overview documents for the ImportCatalogPart class or the CatalogZone class.

注釈

クラスCatalogPartは、ゾーンにCatalogZoneBase存在する特殊なコントロールの基本クラスです。The CatalogPart class is a base class for special controls that reside in CatalogZoneBase zones. これらのCatalogPart派生コントロールは、エンドユーザーが web ページに追加できる web サーバーコントロールのカタログを提供します。These derived CatalogPart controls provide catalogs of Web server controls that end users can add to a Web page. サーバー CatalogPartコントロールを追加または削除することによって web ページの機能を変更する柔軟性をエンドユーザーに提供する場合は、web アプリケーションのコントロールを使用します。Use CatalogPart controls in a Web application when you want to provide end users with the flexibility to change the functionality of a Web page by adding or removing server controls.

カタログは、ユーザーが web ページに追加できる1つまたは複数のWebPart使用可能な web サーバーコントロール (コントロール、ASP.NET サーバーコントロール、カスタムコントロール、ユーザーコントロールなど) のリストです。A catalog is simply a list of one or more available Web server controls (including WebPart controls, ASP.NET server controls, and custom or user controls) that users can add to a Web page. カタログには、エンドユーザーのための指示テキストなど、いくつかの一般的な特性があります。各サーバーコントロールについて説明するテキストです。ヘルパーはサーバーコントロールを選択し、ページに追加します。共通のヘッダー、フッター、および境界線およびいくつかのスタイル属性があります。A catalog has a number of common characteristics, including instruction text for end users; text to describe each server control; helper controls to select the server controls and add them to the page; a common header, footer, and border; and a number of style attributes.

次の表で説明CatalogPartするように、Web パーツコントロールセットには3種類のコントロールが用意されています。There are three types of CatalogPart controls provided with the Web Parts control set, as described in the following table. 各種類のCatalogPartコントロールには、別のソースからページに追加されるサーバーコントロールが含まれています。Each type of CatalogPart control contains server controls that are added to a page from a different source.

重要

CatalogPartクラスを継承するコントロールは、そのCatalogZoneBaseクラスから派生したゾーンにのみ配置できます。Controls that inherit from the CatalogPart class can reside only in zones derived from the CatalogZoneBase class.

コントロールControl 説明Description
PageCatalogPart ページで閉じられていて、ユーザーが再び開く (ページに再び追加する) ことができるコントロールが含まれています。Contains controls that have been closed on a page, and that can be reopened (added back to the page) by users. この種類のカタログのコントロールは、既に別のソースからページに追加されていて、ユーザーによって閉じられたコントロールです。The controls in this type of catalog are controls that were already added to the page from another source, and were then closed by a user.
DeclarativeCatalogPart DeclarativeCatalogPartコントロール内で宣言されたサーバーコントロールを含みます。これCatalogZoneBaseは、Web ページのマークアップ内のゾーンに含まれています。Contains server controls declared within a DeclarativeCatalogPart control, which is itself contained in a CatalogZoneBase zone in the markup of a Web page.
ImportCatalogPart ユーザーがコントロールの定義ファイル (状態情報を含むスキーマによって定義された XML ファイル) をアップロードして、そのコントロールを Web ページに追加できるようにするためのユーザーインターフェイス (UI) を提供します。Provides the user interface (UI) for a user to upload a control's definition file (an XML file defined by a schema, that contains state information) to a catalog, so that the control can be added to a Web page. コントロール自体は、この種類のカタログには表示されません。カタログは、外部コントロールをページに追加できるように、その定義ファイルにアクセスするためのメカニズムにすぎません。The controls themselves do not appear in this type of catalog; the catalog is just a mechanism for accessing the definition files for external controls so they can be added to a page.

クラスCatalogPartは、基底Partクラスから継承して、Web パーツコントロールセット内の他のパーツコントロールの共通動作を持つようにします。The CatalogPart class inherits from the base Part class, so that it has the common behavior of other part controls in the Web Parts control set. また、カタログ機能に役立つメンバーがいくつか追加されています。In addition, it adds some members that are useful for the catalog functionality. プロパティDisplayTitleは、コントロールのタイトルとして現在表示されている実際の文字列を取得します。The DisplayTitle property gets the actual string that is currently being displayed as the title of the control. このプロパティの値は、 Titleプロパティの値と同じにすることができます。また、プロパティに値が割り当てられていない場合は、.NET Framework によって指定された既定値になります。The value of this property can be the same as the value of the Title property or, if no value has been assigned to that property, a default value supplied by the .NET Framework. プロパティWebPartManagerWebPartManager CatalogPart CatalogPart CatalogZoneBaseプロパティは両方とも、コントロールのライフサイクルを制御する2つの重要なオブジェクト (コントロールと、 Zoneそれぞれ制御します。The WebPartManager and Zone properties both provide convenient access to the two essential objects that control the life cycle of a CatalogPart control: the WebPartManager control, and the CatalogZoneBase zone that contains the CatalogPart control, respectively.

クラスCatalogPartには、いくつかのメソッドも含まれています。The CatalogPart class also contains several methods. メソッドGetAvailableWebPartDescriptionsは、継承によって実装される必要がある抽象メソッドとして宣言されます。The GetAvailableWebPartDescriptions method is declared as an abstract method that must be implemented by inheritors. その目的は、カタログ内のコントロールの説明のコレクションを返すことです。Its intended purpose is to return a collection of descriptions of the controls in the catalog. 関連するメソッドGetWebPartも abstract として宣言され、継承によって実装される必要があります。A related method, GetWebPart, is also declared as abstract and must be implemented by inheritors. このメソッドは、パラメーターとしてメソッドにWebPart渡された説明に基づいて、コントロールのインスタンスを返すことを目的としています。This method is intended to return an instance of a WebPart control based on a description that is passed to the method as a parameter.

注意 (実装者)

CatalogPartクラスは抽象クラスであるため、Web ページ上で直接使用することはできません。Because the CatalogPart class is abstract, you cannot use it directly on a Web page. Web パーツコントロールセットには、 CatalogPart基本クラスから派生し、Web パーツのページで使用できる3つのコントロール (このトピックの「解説」の表を参照) が用意されています。The Web Parts control set provides three CatalogPart controls (listed in the table in the Remarks section of this topic) that derive from the base class and that can be used on Web Parts pages. これらのコントロールは、Web サーバーコントロールのカタログを作成するために必要な機能のほとんどを提供する必要があります。These controls should provide most of the features needed to create catalogs of Web server controls. ただし、カスタムCatalogPartコントロールの開発が必要になる特殊なニーズがある場合もあります。However, you might have specialized needs that would require developing a custom CatalogPart control. たとえば、Web サービスまたはデータベースから直接サーバー CatalogPartコントロールを使用できるようにする特殊な種類のコントロールを作成できます。For example, you can create a special type of CatalogPart control that makes server controls available through a Web service, or directly from a database. これを行うには、 CatalogPartクラスから継承する必要があります。To do this, you must inherit from the CatalogPart class. また、抽象GetAvailableWebPartDescriptions() GetWebPart(WebPartDescription)メソッドとメソッドをオーバーライドして、 WebPartまたは他のサーバーコントロールとその説明を返す実装を提供する必要もあります。You must also override the abstract GetAvailableWebPartDescriptions() and GetWebPart(WebPartDescription) methods to provide an implementation that returns the WebPart or other server controls, and their descriptions. また、データベースまたは Web サービスからさまざまなサーバーコントロールを読み込む方法も必要になります。You will also need methods to load the various server controls from your database or Web service.

コンストラクター

CatalogPart()

継承クラス インスタンスによって使用されるクラスを初期化します。Initializes the class for use by an inherited class instance. このコンストラクターは、継承クラスによってのみ呼び出すことができます。This constructor can only be called by an inherited class.

プロパティ

AccessKey

Web サーバー コントロールにすばやく移動できるアクセス キーを取得または設定します。Gets or sets the access key that allows you to quickly navigate to the Web server control.

(継承元 WebControl)
Adapter

コントロール用のブラウザー固有のアダプターを取得します。Gets the browser-specific adapter for the control.

(継承元 Control)
AppRelativeTemplateSourceDirectory

このコントロールが含まれている Page オブジェクトまたは UserControl オブジェクトのアプリケーション相対の仮想ディレクトリを取得または設定します。Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(継承元 Control)
Attributes

コントロールのプロパティに対応しない任意の属性 (表示専用) のコレクションを取得します。Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

(継承元 WebControl)
BackColor

Web サーバー コントロールの背景色を取得または設定します。Gets or sets the background color of the Web server control.

(継承元 WebControl)
BackImageUrl

パネル コントロールの背景イメージの URL を取得または設定します。Gets or sets the URL of the background image for the panel control.

(継承元 Panel)
BindingContainer

このコントロールのデータ バインディングを格納しているコントロールを取得します。Gets the control that contains this control's data binding.

(継承元 Control)
BorderColor

Web コントロールの境界線の色を取得または設定します。Gets or sets the border color of the Web control.

(継承元 WebControl)
BorderStyle

Web サーバー コントロールの境界線スタイルを取得または設定します。Gets or sets the border style of the Web server control.

(継承元 WebControl)
BorderWidth

Web サーバー コントロールの境界線の幅を取得または設定します。Gets or sets the border width of the Web server control.

(継承元 WebControl)
ChildControlsCreated

サーバー コントロールの子コントロールが作成されたかどうかを示す値を取得します。Gets a value that indicates whether the server control's child controls have been created.

(継承元 Control)
ChromeState

パーツ コントロールが最小化または標準のどちらの状態で表示されるかを示す値を取得または設定します。Gets or sets whether a part control is in a minimized or normal state.

(継承元 Part)
ChromeType

Web パーツ コントロールを囲む境界線の種類を取得または設定します。Gets or sets the type of border that frames a Web Parts control.

(継承元 Part)
ClientID

ASP.NET によって生成される HTML マークアップのコントロール ID を取得します。Gets the control ID for HTML markup that is generated by ASP.NET.

(継承元 Control)
ClientIDMode

ClientID プロパティの値を生成するために使用されるアルゴリズムを取得または設定します。Gets or sets the algorithm that is used to generate the value of the ClientID property.

(継承元 Control)
ClientIDSeparator

ClientID プロパティで使用される区切り記号を表す文字値を取得します。Gets a character value representing the separator character used in the ClientID property.

(継承元 Control)
Context

現在の Web 要求に対するサーバー コントロールに関連付けられている HttpContext オブジェクトを取得します。Gets the HttpContext object associated with the server control for the current Web request.

(継承元 Control)
Controls

ユーザー インターフェイスの階層構造の指定されたサーバー コントロールの子コントロールを格納している ControlCollection オブジェクトを取得します。Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy.

(継承元 Part)
ControlStyle

Web サーバー コントロールのスタイルを取得します。Gets the style of the Web server control. このプロパティは、主にコントロールの開発者によって使用されます。This property is used primarily by control developers.

(継承元 WebControl)
ControlStyleCreated

Style オブジェクトが ControlStyle プロパティに対して作成されたかどうかを示す値を取得します。Gets a value indicating whether a Style object has been created for the ControlStyle property. このプロパティは、主にコントロールの開発者によって使用されます。This property is primarily used by control developers.

(継承元 WebControl)
CssClass

クライアントで Web サーバー コントロールによって表示されるカスケード スタイル シート (CSS: Cascading Style Sheet) クラスを取得または設定します。Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

(継承元 WebControl)
DataItemContainer

名前付けコンテナーが IDataItemContainer を実装している場合、名前付けコンテナーへの参照を取得します。Gets a reference to the naming container if the naming container implements IDataItemContainer.

(継承元 Control)
DataKeysContainer

名前付けコンテナーが IDataKeysControl を実装している場合、名前付けコンテナーへの参照を取得します。Gets a reference to the naming container if the naming container implements IDataKeysControl.

(継承元 Control)
DefaultButton

Panel コントロールに格納されている既定のボタンの識別子を取得または設定します。Gets or sets the identifier for the default button that is contained in the Panel control.

(継承元 Panel)
Description

パーツ コントロールのツールヒントやカタログで使用する、パーツ コントロールの動作をまとめた短い語句を取得または設定します。Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.

(継承元 Part)
DesignMode

コントロールがデザイン サーフェイスで使用されているかどうかを示す値を取得します。Gets a value indicating whether a control is being used on a design surface.

(継承元 Control)
Direction

テキストを含むコントロールを Panel コントロールに表示する方向を取得または設定します。Gets or sets the direction in which to display controls that include text in a Panel control.

(継承元 Panel)
DisplayTitle

CatalogPart コントロールの現在の実際のタイトルを含む文字列を取得します。Gets a string that contains the actual current title of a CatalogPart control.

Enabled

Web サーバー コントロールを有効にするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the Web server control is enabled.

(継承元 WebControl)
EnableTheming

テーマがこのコントロールに適用されるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether themes apply to this control.

(継承元 WebControl)
EnableViewState

要求元クライアントに対して、サーバー コントロールがそのビュー状態と、そこに含まれる任意の子のコントロールのビュー状態を保持するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

(継承元 Control)
Events

コントロールのイベント ハンドラー デリゲートのリストを取得します。Gets a list of event handler delegates for the control. このプロパティは読み取り専用です。This property is read-only.

(継承元 Control)
Font

Web サーバー コントロールに関連付けられたフォント プロパティを取得します。Gets the font properties associated with the Web server control.

(継承元 WebControl)
ForeColor

Web サーバー コントロールの前景色 (通常はテキストの色) を取得または設定します。Gets or sets the foreground color (typically the color of the text) of the Web server control.

(継承元 WebControl)
GroupingText

パネル コントロールに格納されているコントロールのグループのキャプションを取得または設定します。Gets or sets the caption for the group of controls that is contained in the panel control.

(継承元 Panel)
HasAttributes

コントロールに属性セットがあるかどうかを示す値を取得します。Gets a value indicating whether the control has attributes set.

(継承元 WebControl)
HasChildViewState

現在のサーバー コントロールの子コントロールが、保存されたビューステートの設定を持っているかどうかを示す値を取得します。Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(継承元 Control)
Height

Web サーバー コントロールの高さを取得または設定します。Gets or sets the height of the Web server control.

(継承元 WebControl)
HorizontalAlign

パネルの内容の水平方向の配置を取得または設定します。Gets or sets the horizontal alignment of the contents within the panel.

(継承元 Panel)
ID

サーバー コントロールに割り当てられたプログラム ID を取得または設定します。Gets or sets the programmatic identifier assigned to the server control.

(継承元 Control)
IdSeparator

コントロール ID を区別するために使用する文字を取得します。Gets the character used to separate control identifiers.

(継承元 Control)
IsChildControlStateCleared

このコントロールに含まれているコントロールに、コントロールの状態が設定されているかどうかを示す値を取得します。Gets a value indicating whether controls contained within this control have control state.

(継承元 Control)
IsEnabled

コントロールが有効かどうかを示す値を取得します。Gets a value indicating whether the control is enabled.

(継承元 WebControl)
IsTrackingViewState

サーバー コントロールがビューステートの変更を保存しているかどうかを示す値を取得します。Gets a value that indicates whether the server control is saving changes to its view state.

(継承元 Control)
IsViewStateEnabled

このコントロールでビューステートが有効かどうかを示す値を取得します。Gets a value indicating whether view state is enabled for this control.

(継承元 Control)
LoadViewStateByID

コントロールがインデックスではなく ID によりビューステートの読み込みを行うかどうかを示す値を取得します。Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(継承元 Control)
NamingContainer

同じ ID プロパティ値を持つ複数のサーバー コントロールを区別するための一意の名前空間を作成する、サーバー コントロールの名前付けコンテナーへの参照を取得します。Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

(継承元 Control)
Page

サーバー コントロールを含んでいる Page インスタンスへの参照を取得します。Gets a reference to the Page instance that contains the server control.

(継承元 Control)
Parent

ページ コントロールの階層構造における、サーバー コントロールの親コントロールへの参照を取得します。Gets a reference to the server control's parent control in the page control hierarchy.

(継承元 Control)
RenderingCompatibility

レンダリングされる HTML と互換性がある ASP.NET のバージョンを表す値を取得します。Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(継承元 Control)
ScrollBars

Panel コントロールのスクロール バーの表示状態と位置を取得または設定します。Gets or sets the visibility and position of scroll bars in a Panel control.

(継承元 Panel)
Site

デザイン サーフェイスに現在のコントロールを表示するときに、このコントロールをホストするコンテナーに関する情報を取得します。Gets information about the container that hosts the current control when rendered on a design surface.

(継承元 Control)
SkinID

コントロールに適用するスキンを取得または設定します。Gets or sets the skin to apply to the control.

(継承元 WebControl)
Style

Web サーバー コントロールの外側のタグにスタイル属性として表示されるテキスト属性のコレクションを取得します。Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.

(継承元 WebControl)
SupportsDisabledAttribute

コントロールの IsEnabled プロパティが disabled の場合、レンダリングされた HTML 要素の false 属性を "無効" に設定するかどうかを示す値を取得します。Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.

(継承元 Panel)
TabIndex

Web サーバー コントロールのタブ インデックスを取得または設定します。Gets or sets the tab index of the Web server control.

(継承元 WebControl)
TagKey

この Web サーバー コントロールに対応する HtmlTextWriterTag 値を取得します。Gets the HtmlTextWriterTag value that corresponds to this Web server control. このプロパティは、主にコントロールの開発者によって使用されます。This property is used primarily by control developers.

(継承元 WebControl)
TagName

コントロール タグの名前を取得します。Gets the name of the control tag. このプロパティは、主にコントロールの開発者によって使用されます。This property is used primarily by control developers.

(継承元 WebControl)
TemplateControl

このコントロールを格納しているテンプレートへの参照を取得または設定します。Gets or sets a reference to the template that contains this control.

(継承元 Control)
TemplateSourceDirectory

現在のサーバー コントロールを格納している Page または UserControl の仮想ディレクトリを取得します。Gets the virtual directory of the Page or UserControl that contains the current server control.

(継承元 Control)
Title

パーツ コントロールのタイトルを取得または設定します。Gets or sets the title of a part control.

(継承元 Part)
ToolTip

マウス ポインターが Web サーバー コントロールの上を移動したときに表示されるテキストを取得または設定します。Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

(継承元 WebControl)
UniqueID

階層構造で修飾されたサーバー コントロールの一意の ID を取得します。Gets the unique, hierarchically qualified identifier for the server control.

(継承元 Control)
ValidateRequestMode

ブラウザーからのクライアント入力の安全性をコントロールで調べるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(継承元 Control)
ViewState

同一のページに対する複数の要求にわたって、サーバー コントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

(継承元 Control)
ViewStateIgnoresCase

StateBag オブジェクトが大文字小文字を区別しないかどうかを示す値を取得します。Gets a value that indicates whether the StateBag object is case-insensitive.

(継承元 Control)
ViewStateMode

このコントロールのビューステート モードを取得または設定します。Gets or sets the view-state mode of this control.

(継承元 Control)
Visible

サーバー コントロールがページ上の UI としてレンダリングされているかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether a server control is rendered as UI on the page.

(継承元 Control)
WebPartManager

WebPartManager クラスの現在のインスタンスへの参照を取得します。Gets a reference to the current instance of the WebPartManager class.

Width

Web サーバー コントロールの幅を取得または設定します。Gets or sets the width of the Web server control.

(継承元 WebControl)
Wrap

パネルの内容をラップするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the content wraps within the panel.

(継承元 Panel)
Zone

CatalogZoneBase コントロールを含んでいる CatalogPart ゾーンへの参照を取得します。Gets a reference to the CatalogZoneBase zone that contains a CatalogPart control.

メソッド

AddAttributesToRender(HtmlTextWriter)

背景イメージ、配置、ラップ、および表示する属性のリストの方向に関する情報を追加します。Adds information about the background image, alignment, wrap, and direction to the list of attributes to render.

(継承元 Panel)
AddedControl(Control, Int32)

子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。Called after a child control is added to the Controls collection of the Control object.

(継承元 Control)
AddParsedSubObject(Object)

XML または HTML のいずれかの要素が解析されたことをサーバー コントロールに通知し、サーバー コントロールの ControlCollection オブジェクトに要素を追加します。Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

(継承元 Control)
ApplyStyle(Style)

指定したスタイルの空白以外の要素を Web コントロールにコピーして、コントロールの既存のスタイル要素を上書きします。Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. このメソッドは、主にコントロールの開発者によって使用されます。This method is primarily used by control developers.

(継承元 WebControl)
ApplyStyleSheetSkin(Page)

ページのスタイル シートに定義されたスタイル プロパティをコントロールに適用します。Applies the style properties defined in the page style sheet to the control.

(継承元 Control)
BeginRenderTracing(TextWriter, Object)

レンダリング データのデザイン時のトレースを開始します。Begins design-time tracing of rendering data.

(継承元 Control)
BuildProfileTree(String, Boolean)

ページのトレースが有効な場合、サーバー コントロールに関する情報を収集し、これを表示するために Trace プロパティに渡します。Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

(継承元 Control)
ClearCachedClientID()

キャッシュされた ClientID 値を null に設定します。Sets the cached ClientID value to null.

(継承元 Control)
ClearChildControlState()

サーバー コントロールのすべての子コントロールについて、コントロールの状態情報を削除します。Deletes the control-state information for the server control's child controls.

(継承元 Control)
ClearChildState()

サーバー コントロールのすべての子コントロールのビューステート情報およびコントロールの状態情報を削除します。Deletes the view-state and control-state information for all the server control's child controls.

(継承元 Control)
ClearChildViewState()

サーバー コントロールのすべての子コントロールのビューステート情報を削除します。Deletes the view-state information for all the server control's child controls.

(継承元 Control)
ClearEffectiveClientIDMode()

現在のコントロール インスタンスおよびすべての子コントロールの ClientIDMode プロパティを Inherit に設定します。Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(継承元 Control)
CopyBaseAttributes(WebControl)

指定した Web サーバー コントロールから、Style オブジェクトでカプセル化されていないプロパティをこのメソッドの呼び出し元の Web サーバー コントロールにコピーします。Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. このメソッドは、主にコントロールの開発者によって使用されます。This method is used primarily by control developers.

(継承元 WebControl)
CreateChildControls()

ASP.NET ページ フレームワークによって呼び出され、ポストバックまたはレンダリングの準備として、合成ベースの実装を使うサーバー コントロールに対し、それらのコントロールに含まれる子コントロールを作成するように通知します。Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.

(継承元 Control)
CreateControlCollection()

サーバー コントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(継承元 Control)
CreateControlStyle()

すべてのスタイル関連プロパティを実装するために Panel コントロールが内部で使用するスタイル オブジェクトを作成します。Creates a style object that is used internally by the Panel control to implement all style related properties.

(継承元 Panel)
DataBind()

呼び出されたサーバー コントロールと、そのすべての子コントロールにデータ ソースをバインドします。Binds a data source to the invoked server control and all its child controls.

(継承元 Part)
DataBind(Boolean)

DataBinding イベントを発生させるオプションを指定して、呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

(継承元 Control)
DataBindChildren()

データ ソースをサーバー コントロールの子コントロールにバインドします。Binds a data source to the server control's child controls.

(継承元 Control)
Dispose()

サーバー コントロールが、メモリから解放される前に最終的なクリーンアップを実行できるようにします。Enables a server control to perform final clean up before it is released from memory.

(継承元 Control)
EndRenderTracing(TextWriter, Object)

レンダリング データのデザイン時のトレースを終了します。Ends design-time tracing of rendering data.

(継承元 Control)
EnsureChildControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。Determines whether the server control contains child controls. 含まれていない場合、子コントロールを作成します。If it does not, it creates child controls.

(継承元 Control)
EnsureID()

ID が割り当てられていないコントロールの ID を作成します。Creates an identifier for controls that do not have an identifier assigned.

(継承元 Control)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
FindControl(String)

指定した id パラメーターを使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。Searches the current naming container for a server control with the specified id parameter.

(継承元 Control)
FindControl(String, Int32)

指定した id および検索に役立つ pathOffset パラメーターに指定された整数を使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. この形式の FindControl メソッドはオーバーライドしないでください。You should not override this version of the FindControl method.

(継承元 Control)
Focus()

コントロールに入力フォーカスを設定します。Sets input focus to a control.

(継承元 Control)
GetAvailableWebPartDescriptions()

カタログ内で利用できる WebPart コントロールの説明のコレクションを返します。Returns a collection of descriptions of the available WebPart controls in a catalog.

GetDesignModeState()

CatalogPart コントロールの親ゾーンの現在の状態を取得します。Retrieves the current state of a CatalogPart control's parent zone.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetRouteUrl(Object)

ルート パラメーターのセットに対応する URL を取得します。Gets the URL that corresponds to a set of route parameters.

(継承元 Control)
GetRouteUrl(RouteValueDictionary)

ルート パラメーターのセットに対応する URL を取得します。Gets the URL that corresponds to a set of route parameters.

(継承元 Control)
GetRouteUrl(String, Object)

ルート パラメーターのセットおよびルート名に対応する URL を取得します。Gets the URL that corresponds to a set of route parameters and a route name.

(継承元 Control)
GetRouteUrl(String, RouteValueDictionary)

ルート パラメーターのセットおよびルート名に対応する URL を取得します。Gets the URL that corresponds to a set of route parameters and a route name.

(継承元 Control)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
GetUniqueIDRelativeTo(Control)

指定されたコントロールの UniqueID プロパティのプレフィックス部分を返します。Returns the prefixed portion of the UniqueID property of the specified control.

(継承元 Control)
GetWebPart(WebPartDescription)

このメソッドに渡された WebPart オブジェクトによって参照される WebPartDescription コントロールを、カタログから取得します。Retrieves from a catalog the WebPart control that is referenced by the WebPartDescription object passed to the method.

HasControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。Determines if the server control contains any child controls.

(継承元 Control)
HasEvents()

コントロールまたは子コントロールに対してイベントが登録されているかどうかを示す値を返します。Returns a value indicating whether events are registered for the control or any child controls.

(継承元 Control)
IsLiteralContent()

サーバー コントロールがリテラルな内容だけを保持しているかどうかを決定します。Determines if the server control holds only literal content.

(継承元 Control)
LoadControlState(Object)

SaveControlState() メソッドによって保存された前回のページ要求からコントロールの状態情報を復元します。Restores control-state information from a previous page request that was saved by the SaveControlState() method.

(継承元 Control)
LoadViewState(Object)

SaveViewState() メソッドによって保存された前回の要求からビューステート情報を復元します。Restores view-state information from a previous request that was saved with the SaveViewState() method.

(継承元 WebControl)
MapPathSecure(String)

仮想パス (絶対パスまたは相対パス) の割り当て先の物理パスを取得します。Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(継承元 Control)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MergeStyle(Style)

指定したスタイルの空白以外の要素を Web コントロールにコピーしますが、コントロールの既存のスタイル要素は上書きしません。Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. このメソッドは、主にコントロールの開発者によって使用されます。This method is used primarily by control developers.

(継承元 WebControl)
OnBubbleEvent(Object, EventArgs)

サーバー コントロールのイベントをページの UI サーバー コントロールの階層構造に渡すかどうかを決定します。Determines whether the event for the server control is passed up the page's UI server control hierarchy.

(継承元 Control)
OnDataBinding(EventArgs)

DataBinding イベントを発生させます。Raises the DataBinding event.

(継承元 Control)
OnInit(EventArgs)

Init イベントを発生させます。Raises the Init event.

(継承元 Control)
OnLoad(EventArgs)

Load イベントを発生させます。Raises the Load event.

(継承元 Control)
OnPreRender(EventArgs)

PreRender イベントを発生させます。Raises the PreRender event.

OnUnload(EventArgs)

Unload イベントを発生させます。Raises the Unload event.

(継承元 Control)
OpenFile(String)

ファイルの読み込みで使用される Stream を取得します。Gets a Stream used to read a file.

(継承元 Control)
RaiseBubbleEvent(Object, EventArgs)

イベントのソースおよびその情報をコントロールの親に割り当てます。Assigns any sources of the event and its information to the control's parent.

(継承元 Control)
RemovedControl(Control)

Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。Called after a child control is removed from the Controls collection of the Control object.

(継承元 Control)
Render(HtmlTextWriter)

指定された HTML ライターにコントロールを表示します。Renders the control to the specified HTML writer.

(継承元 WebControl)
RenderBeginTag(HtmlTextWriter)

Panel コントロールの HTML 開始タグを指定したライターに表示します。Renders the HTML opening tag of the Panel control to the specified writer.

(継承元 Panel)
RenderChildren(HtmlTextWriter)

クライアントに表示される内容の書き込みを行う、指定された HtmlTextWriter オブジェクトに、サーバー コントロールの子を出力します。Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(継承元 Control)
RenderContents(HtmlTextWriter)

コントロールの内容を指定したライターに出力します。Renders the contents of the control to the specified writer. このメソッドは、主にコントロールの開発者によって使用されます。This method is used primarily by control developers.

(継承元 WebControl)
RenderControl(HtmlTextWriter)

指定の HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力し、トレースが有効である場合はコントロールに関するトレース情報を保存します。Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

(継承元 Control)
RenderControl(HtmlTextWriter, ControlAdapter)

指定した ControlAdapter オブジェクトを使用して、指定した HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力します。Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(継承元 Control)
RenderEndTag(HtmlTextWriter)

Panel コントロールの HTML 終了タグを指定したライターに表示します。Renders the HTML closing tag of the Panel control into the specified writer.

(継承元 Panel)
ResolveAdapter()

指定したコントロールを表示するコントロール アダプターを取得します。Gets the control adapter responsible for rendering the specified control.

(継承元 Control)
ResolveClientUrl(String)

ブラウザーで使用できる URL を取得します。Gets a URL that can be used by the browser.

(継承元 Control)
ResolveUrl(String)

要求側クライアントで使用できる URL に変換します。Converts a URL into one that is usable on the requesting client.

(継承元 Control)
SaveControlState()

ページがサーバーにポスト バックされた時間以降に発生したすべてのサーバー コントロール状態の変化を保存します。Saves any server control state changes that have occurred since the time the page was posted back to the server.

(継承元 Control)
SaveViewState()

TrackViewState() メソッドが呼び出された後に変更された状態を保存します。Saves any state that was modified after the TrackViewState() method was invoked.

(継承元 WebControl)
SetDesignModeState(IDictionary)

コントロールのデザイン時データを設定します。Sets design-time data for a control.

SetRenderMethodDelegate(RenderMethod)

サーバー コントロールとその内容を親コントロールに表示するイベント ハンドラー デリゲートを割り当てます。Assigns an event handler delegate to render the server control and its content into its parent control.

(継承元 Control)
SetTraceData(Object, Object)

トレース データ キーとトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(継承元 Control)
SetTraceData(Object, Object, Object)

トレースされたオブジェクト、トレース データ キー、およびトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(継承元 Control)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
TrackViewState()

ビューステートの変更をコントロールに追跡させ、変更をオブジェクトの ViewState プロパティに格納できるようにします。Causes the control to track changes to its view state so they can be stored in the object's ViewState property.

(継承元 WebControl)

イベント

DataBinding

サーバー コントロールがデータ ソースに連結すると発生します。Occurs when the server control binds to a data source.

(継承元 Control)
Disposed

サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(継承元 Control)
Init

サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。Occurs when the server control is initialized, which is the first step in its lifecycle.

(継承元 Control)
Load

サーバー コントロールが Page オブジェクトに読み込まれると発生します。Occurs when the server control is loaded into the Page object.

(継承元 Control)
PreRender

Control オブジェクトの読み込み後、表示を開始する前に発生します。Occurs after the Control object is loaded but prior to rendering.

(継承元 Control)
Unload

サーバー コントロールがメモリからアンロードされると発生します。Occurs when the server control is unloaded from memory.

(継承元 Control)

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

IAttributeAccessor.GetAttribute(String)

指定された名前の Web コントロールの属性を取得します。Gets an attribute of the Web control with the specified name.

(継承元 WebControl)
IAttributeAccessor.SetAttribute(String, String)

Web コントロールの属性を指定された名前と値に設定します。Sets an attribute of the Web control to the specified name and value.

(継承元 WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls()

複合パーツ コントロールのデザイナーの開発者が、デザイン サーフェイスでコントロールの子コントロールを再作成できるようにします。Allows the developer of a designer for a composite part control to recreate the control's child controls on the design surface.

(継承元 Part)
IControlBuilderAccessor.ControlBuilder

このメンバーの詳細については、「ControlBuilder」をご覧ください。For a description of this member, see ControlBuilder.

(継承元 Control)
IControlDesignerAccessor.GetDesignModeState()

このメンバーの詳細については、「GetDesignModeState()」をご覧ください。For a description of this member, see GetDesignModeState().

(継承元 Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)

このメンバーの詳細については、「SetDesignModeState(IDictionary)」をご覧ください。For a description of this member, see SetDesignModeState(IDictionary).

(継承元 Control)
IControlDesignerAccessor.SetOwnerControl(Control)

このメンバーの詳細については、「SetOwnerControl(Control)」をご覧ください。For a description of this member, see SetOwnerControl(Control).

(継承元 Control)
IControlDesignerAccessor.UserData

このメンバーの詳細については、「UserData」をご覧ください。For a description of this member, see UserData.

(継承元 Control)
IDataBindingsAccessor.DataBindings

このメンバーの詳細については、「DataBindings」をご覧ください。For a description of this member, see DataBindings.

(継承元 Control)
IDataBindingsAccessor.HasDataBindings

このメンバーの詳細については、「HasDataBindings」をご覧ください。For a description of this member, see HasDataBindings.

(継承元 Control)
IExpressionsAccessor.Expressions

このメンバーの詳細については、「Expressions」をご覧ください。For a description of this member, see Expressions.

(継承元 Control)
IExpressionsAccessor.HasExpressions

このメンバーの詳細については、「HasExpressions」をご覧ください。For a description of this member, see HasExpressions.

(継承元 Control)
IParserAccessor.AddParsedSubObject(Object)

このメンバーの詳細については、「AddParsedSubObject(Object)」をご覧ください。For a description of this member, see AddParsedSubObject(Object).

(継承元 Control)

拡張メソッド

FindDataSourceControl(Control)

指定されたコントロールのデータ コントロールに関連付けられているデータ ソースを返します。Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String)

指定されたコントロールの名前付けコンテナー内にある、指定された列のフィールド テンプレートを返します。Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control)

格納しているデータ コントロールのメタテーブル オブジェクトを返します。Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer)

指定されたデータ コントロールの既定値のコレクションを取得します。Gets the collection of the default values for the specified data control.

GetMetaTable(INamingContainer)

指定されたデータ コントロールのテーブル メタデータを取得します。Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable)

指定されたデータ コントロールのテーブル メタデータを設定します。Sets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)

指定したデータ コントロールのテーブル メタデータおよび既定値のマッピングを設定します。Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable, Object)

指定したデータ コントロールのテーブル メタデータおよび既定値のマッピングを設定します。Sets the table metadata and default value mapping for the specified data control.

TryGetMetaTable(INamingContainer, MetaTable)

テーブル メタデータが使用できるかどうかを判断します。Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type)

指定されたデータ コントロールの動的データの動作を有効にします。Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)

指定されたデータ コントロールの動的データの動作を有効にします。Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object)

指定されたデータ コントロールの動的データの動作を有効にします。Enables Dynamic Data behavior for the specified data control.

適用対象

こちらもご覧ください