WebPartManager クラス

定義

Web パーツのコントロール、機能、および Web ページ上で発生するイベントのすべてを管理する、Web パーツ コントロール セットの中心的なクラスとして機能します。

public ref class WebPartManager : System::Web::UI::Control, System::Web::UI::INamingContainer, System::Web::UI::WebControls::WebParts::IPersonalizable
[System.ComponentModel.Bindable(false)]
public class WebPartManager : System.Web.UI.Control, System.Web.UI.INamingContainer, System.Web.UI.WebControls.WebParts.IPersonalizable
[<System.ComponentModel.Bindable(false)>]
type WebPartManager = class
    inherit Control
    interface INamingContainer
    interface IPersonalizable
Public Class WebPartManager
Inherits Control
Implements INamingContainer, IPersonalizable
継承
WebPartManager
属性
実装

次のコード例では、 コントロールの宣言型とプログラムによる使用の両方を WebPartManager 示します。

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

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

  • 接続できる 2 つのカスタム WebPart コントロールと <asp:webpartmanager> 要素を含む Web ページ。

  • 2 つのカスタム コントロールとカスタム WebPart インターフェイスを含むソース コード ファイル。

  • ブラウザーでのこの例の動作の説明。

ユーザー コントロールには、ページ上に存在する Web パーツ コントロールを指定して、ページで使用可能な表示モードを示すドロップダウン リスト コントロールがあります。 このコード例の Web ページでは、このユーザー コントロールはページのマークアップ内の要素のすぐ下 WebPartManager に宣言され、Web ページの上部付近にコントロールを登録するためのディレクティブがあります Register 。 表示モードの詳細と、このコントロールのソース コードの説明については、「 チュートリアル: 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>

Web ページの宣言型マークアップには、 Register ユーザー コントロールとカスタム コントロールの両方のディレクティブが含まれています。 <asp:webpartmanager>要素、カスタム コントロールを<asp:webpartzone>格納する要素、および 要素があります<asp:connectionszone>。 ページには、コントロールの接続関連イベント WebPartManager を処理するインライン コードも含まれています。コントロールの接続と切断時に、このコードの効果を確認できます。

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ConnectionSampleCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
 
  private void UpdateLabelData(int wpCount, int connCount)
  {
    Label1.Text = "WebPart Control Count:  " + wpCount.ToString();
    Label2.Text = "Connections Count: " + connCount.ToString();
  }

  protected void WebPartManager1_WebPartsConnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }

  protected void WebPartManager1_WebPartsDisconnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server"  
        OnWebPartsConnected="WebPartManager1_WebPartsConnected" 
        OnWebPartsDisconnected="WebPartManager1_WebPartsDisconnected" />
    <div>
      <uc1:DisplayModeMenuCS ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
      <br />
      <asp:Label ID="Label2" runat="server" Text=""></asp:Label>
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>
<%@ Page Language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls" 
  Assembly="ConnectionSampleVB" %>

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

  Protected Sub WebPartManager1_WebPartsConnected( _
    ByVal sender As Object, _
    ByVal e As System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs)
    
    UpdateLabelData(WebPartManager1.WebParts.Count, _
      WebPartManager1.Connections.Count)
    
  End Sub

  Protected Sub WebPartManager1_WebPartsDisconnected( _
    ByVal sender As Object, _
    ByVal e As System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs)
    
    UpdateLabelData(WebPartManager1.WebParts.Count, _
      WebPartManager1.Connections.Count)
    
  End Sub
  
  Private Sub UpdateLabelData(ByVal wpCount As Integer, _
    ByVal connCount As Integer)
    
    Label1.Text = "WebPart Control Count:  " & wpCount.ToString()
    Label2.Text = "Connections Count: " & connCount.ToString()
    
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server" OnWebPartsConnected="WebPartManager1_WebPartsConnected" OnWebPartsDisconnected="WebPartManager1_WebPartsDisconnected" />
    <div>
      <uc1:DisplayModeMenuVB ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
      <br />
      <asp:Label ID="Label2" runat="server" Text=""></asp:Label>
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

この例の 3 番目の部分は、 コントロールのソース コードです。 という名前 IZipCodeのインターフェイスがあり、このインターフェイスが クラスに実装されていることに ZipCodeWebPart 注意してください。 このクラスには、プロバイダーとして機能する という名前 ProvideIZipCode の特別なコールバック メソッドがあります。 という名前 WeatherWebPartのもう 1 つの型も、 という名前 GetIZipCodeの特殊なメソッドを使用して実装されます。これにより、コントロールが他のコントロールのコンシューマーとして機能できるようになります。

コード例を実行するには、このソース コードをコンパイルする必要があります。 明示的にコンパイルし、結果のアセンブリを Web サイトの Bin フォルダーまたはグローバル アセンブリ キャッシュに配置できます。 または、ソース コードをサイトの App_Code フォルダーに配置して、実行時に動的にコンパイルすることもできます。 このコード例では、ソースをアセンブリにコンパイルし、Web ページの ディレクティブが Register アセンブリ名を参照していることを前提としています。 コンパイル方法を示すチュートリアルについては、「 チュートリアル: カスタム Web サーバー コントロールの開発と使用」を参照してください。

namespace Samples.AspNet.CS.Controls
{
  using System;
  using System.Web;
  using System.Web.Security;
  using System.Security.Permissions;
  using System.Web.UI;
  using System.Web.UI.WebControls;
  using System.Web.UI.WebControls.WebParts;

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public interface IZipCode
  {
    string ZipCode { get; set;}
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class ZipCodeWebPart : WebPart, IZipCode
  {
    string zipCodeText = String.Empty;
    TextBox input;
    Button send;

    public ZipCodeWebPart()
    {
    }

    // Make the implemented property personalizable to save 
    // the Zip Code between browser sessions.
    [Personalizable()]
    public virtual string ZipCode
    {
      get { return zipCodeText; }
      set { zipCodeText = value; }
    }

    // This is the callback method that returns the provider.
    [ConnectionProvider("Zip Code")]
    public IZipCode ProvideIZipCode()
    {
      return this;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      input = new TextBox();
      this.Controls.Add(input);
      send = new Button();
      send.Text = "Enter 5-digit Zip Code";
      send.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(send);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      if (!string.IsNullOrEmpty(input.Text))
      {
        zipCodeText = Page.Server.HtmlEncode(input.Text);
        input.Text = String.Empty;
      }
    }
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class WeatherWebPart : WebPart
  {
    private IZipCode _provider;
    string _zipSearch;
    Label DisplayContent;

    // This method is identified by the ConnectionConsumer 
    // attribute, and is the mechanism for connecting with 
    // the provider. 
    [ConnectionConsumer("Zip Code")]
    public void GetIZipCode(IZipCode Provider)
    {
      _provider = Provider;
    }
    
    protected override void OnPreRender(EventArgs e)
    {
      EnsureChildControls();

      if (this._provider != null)
      {
        _zipSearch = _provider.ZipCode.Trim();
        DisplayContent.Text = "My Zip Code is:  " + _zipSearch;
      }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      this.Controls.Add(DisplayContent);
    }
  }
}
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Interface IZipCode

    Property ZipCode() As String

  End Interface

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class ZipCodeWebPart
    Inherits WebPart
    Implements IZipCode
    Private zipCodeText As String = String.Empty
    Private input As TextBox
    Private send As Button

    Public Sub New()
    End Sub

    ' Make the implemented property personalizable to save 
    ' the Zip Code between browser sessions.
    <Personalizable()> _
    Public Property ZipCode() As String _
      Implements IZipCode.ZipCode

      Get
        Return zipCodeText
      End Get
      Set(ByVal value As String)
        zipCodeText = value
      End Set
    End Property

    ' This is the callback method that returns the provider.
    <ConnectionProvider("Zip Code")> _
    Public Function ProvideIZipCode() As IZipCode
      Return Me
    End Function


    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      input = New TextBox()
      Me.Controls.Add(input)
      send = New Button()
      send.Text = "Enter 5-digit Zip Code"
      AddHandler send.Click, AddressOf Me.submit_Click
      Me.Controls.Add(send)

    End Sub


    Private Sub submit_Click(ByVal sender As Object, _
      ByVal e As EventArgs)

      If input.Text <> String.Empty Then
        zipCodeText = Page.Server.HtmlEncode(input.Text)
        input.Text = String.Empty
      End If

    End Sub

  End Class

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class WeatherWebPart
    Inherits WebPart
    Private _provider As IZipCode
    Private _zipSearch As String
    Private DisplayContent As Label

    ' This method is identified by the ConnectionConsumer 
    ' attribute, and is the mechanism for connecting with 
    ' the provider. 
    <ConnectionConsumer("Zip Code")> _
    Public Sub GetIZipCode(ByVal Provider As IZipCode)
      _provider = Provider
    End Sub


    Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
      EnsureChildControls()

      If Not (Me._provider Is Nothing) Then
        _zipSearch = _provider.ZipCode.Trim()
    DisplayContent.Text = "My Zip Code is:  " + _zipSearch
      End If

    End Sub

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      Me.Controls.Add(DisplayContent)

    End Sub

  End Class

End Namespace

ブラウザーに Web ページを読み込んだ後、[ 表示モード ] ドロップダウン リスト コントロールをクリックし、[ 接続 ] を選択してページを接続モードに切り替えます。 接続モードでは、 要素を <asp:connectionszone> 使用して、コントロール間の接続を作成できます。 接続モードで、 ZIP コード コントロールのタイトル バーの下向き矢印をクリックして動詞メニューをアクティブ化し、[ 接続] をクリックします。 接続 UI が表示されたら、[ コンシューマーへの接続を作成 する] リンクをクリックします。 ドロップダウン リスト コントロールを持つセルが表示されます。 ドロップダウン リストで [ 天気予報コントロール ] を選択し、[ 接続 ] をクリックして 2 つのコントロールの接続を完了します。 [ 閉じる] をクリックし、[ 表示モード ] ドロップダウン リストを使用してページを通常のブラウズ モードに戻します。 郵便番号を入力すると、入力した値でコンシューマー コントロールが更新されます。 プロパティは ZipCode ソース コードで 属性で Personalizable マークされているため、このプロパティ値はブラウザー セッション間で保持されるため、ユーザーが入力した値を保存します。 より高度なコンシューマー コントロールでは、郵便番号情報を取得し、コードに基づいて気象情報を検索し、ユーザーに表示できます。

注釈

コントロールは WebPartManager 、Web パーツ アプリケーションのハブまたはコントロール センターとして機能します。 Web パーツ コントロールを使用するすべてのページには、1 つだけWebPartManager のコントロール インスタンスが必要です。 Web パーツ アプリケーションのほとんどの側面と同様に、コントロールは WebPartManager 認証されたユーザーでのみ機能します。 さらに、その機能は、 クラスから継承する Web パーツ ゾーン内に存在するサーバー コントロールでほぼ完全に WebZone 機能します。 これらのゾーンの外部のページに存在するサーバー コントロールは、Web パーツの機能やコントロールとの相互作用がほとんど WebPartManager ない場合があります。

コントロールは、ページ上の Web パーツ機能のハブとして、 WebPartManager 次の表で説明するタスクの種類を実行します。

タスクのカテゴリ コントロールの動作
Web パーツ コントロールの追跡 コントロール、接続、ゾーンなど WebPart 、Web パーツ機能を提供するページ上のさまざまな種類のコントロールを追跡します。
Web パーツ コントロールの追加と削除 ページ上のコントロールを追加、削除、終了 WebPart するためのメソッドを提供します。
接続の管理 コントロール間の接続を作成し、接続と、それらを追加および削除するプロセスを監視します。
コントロールとページのカスタマイズ ユーザーがコントロールをページ上の別の場所に移動し、ユーザーがコントロールの外観、プロパティ、および動作を編集できるビューを起動できるようにします。 各ページでユーザー固有のパーソナル化設定を維持します。
異なるページ ビューを切り替える ユーザーがページ レイアウトの変更やコントロールの編集などの特定のタスクを実行できるように、ページの特殊なビュー間でページを切り替えます。
Web パーツのライフサイクル イベントの発生 コントロールの追加、移動、接続、削除などの Web パーツ コントロールのライフサイクル イベントを開発者が処理できるようにします。
コントロールのインポートとエクスポートの有効化 コントロールのプロパティの状態を含む XML ストリームをエクスポートし、ユーザーが他の WebPart ページやサイトで複雑なコントロールをカスタマイズする際に便利にファイルをインポートできるようにします。

クラスには WebPartManager 、プロパティの大きなセットがあります。 他のコントロールを WebPartManager 追跡する役割と一致し、Web パーツ コントロールまたはその他の特殊な Web パーツ オブジェクトのコレクションを参照するプロパティが多数存在します。 、AvailableTransformersConnectionsControlsDisplayModesDynamicConnectionsSupportedDisplayModesWebParts、および Zones の各プロパティは、コントロールが追跡やその他のWebPartManager管理タスクに使用するすべてのコレクションです。

プロパティの別のグループには、Web パーツ アプリケーションで発生する特定のシナリオに適用されるカスタマイズ可能な警告が含まれています。 これには、、 CloseProviderWarningDeleteWarningおよび プロパティが ExportSensitiveDataWarning 含まれます。

クラスは WebPartManager 、多くの Web サーバー コントロールで使用される基本継承プロパティの一部をオーバーライドします。 これには、、SkinIDEnableThemingおよび の各プロパティがVisible含まれます。

最後に、アプリケーションの現在の状態にアクセスするのに役立つプロパティのグループがあります。 プロパティは DisplayMode 、ページが存在する現在の表示モードを示します。 プロパティは EnableClientScript 、コントロールがクライアント側スクリプトのレンダリングを許可されているかどうかを示します。これは、ユーザーが異なる機能を持つブラウザーを持っているか、スクリプトがオフになっている可能性がある状況に関連します。 プロパティは Internals 、機能拡張ケースに使用される多数の重要な Web パーツ メソッドの呼び出しを含むユーティリティ クラスを参照する場合に便利です。 これらのメソッドの呼び出しを別のクラス ( WebPartManagerInternals クラス) で非表示にすると、 WebPartManager クラス独自の API が簡略化されます。 プロパティは Personalization 、ユーザーのパーソナル化設定を格納し、そのデータを永続的なストレージに保持するパーソナル化オブジェクトへのアクセスを提供します。 プロパティは SelectedWebPartWebPart ユーザーまたはアプリケーションによって現在選択されているページ上のコントロールを示します。 プロパティは IPersonalizable.IsDirty 、コントロールのカスタム パーソナル化データが WebPart 変更されたかどうかを示します。

コントロールには WebPartManager 、5 つの組み込みの表示モードまたは Web ページのビューが含まれています。 開発者はこの機能を拡張し、クラスや クラスなどの型を拡張することでカスタム表示モードをWebZoneToolZone作成できます。 特定の表示モードに対応する適切な種類のコントロールがページ上に存在する場合、ユーザーはページをさまざまな表示モードに切り替えることができます。

注意

この機能を拡張して、ユーザーがページ上に対応するゾーンを持たずにカスタム表示モードに切り替えることができます。 ただし、既定の動作では、表示モードはゾーンに対応します。

標準の表示モードは、 クラスのパブリック フィールドによって WebPartManager 表されます。 次の表は、フィールドとそれらが参照する表示モードをまとめたものです。 前述のように、ページの現在の表示モードは常に プロパティで DisplayMode 参照され、ページに存在するゾーンの種類を指定すると、特定のページで可能な一連の表示モードが プロパティに SupportedDisplayModes 含まれます。

フィールド 表示モードの詳細
BrowseDisplayMode Web ページの通常のユーザー ビュー。既定および最も一般的な表示モード。
DesignDisplayMode ユーザーがコントロールを再配置または削除してページ レイアウトを変更できるビュー。
EditDisplayMode 編集ユーザー インターフェイス (UI) が表示されるビュー。ユーザーは、通常のブラウズ モードで表示されるコントロールの外観、プロパティ、および動作を編集できます。
CatalogDisplayMode カタログ UI が表示されるビュー。ユーザーは、使用可能なコントロールのカタログからページにコントロールを追加できます。
ConnectDisplayMode 接続 UI が表示されるビュー。ユーザーは、コントロール間の接続を接続、管理、または切断できます。

コントロール WebPartManager には、Web パーツ ページとコントロールのライフ サイクルで重要なイベントも多数含まれています。 これらのイベントは、Web パーツ コントロールの動作をプログラムで正確に制御します。 ほとんどのメソッドは、コントロール (またはコントロールとしてWebPart動作できるようにゾーンに配置された他のWebPartZoneBaseサーバーまたはユーザー コントロール) に直接WebPart関係します。 ただし、いくつかのイベントは、ページまたはページ上の接続の状態に関連します。 次の表は、使用可能なイベントの一覧とその目的をまとめたものです。

注意

次の表のすべての場合、"control" という単語は、ゾーン内に存在し、実行時に WebPart オブジェクトでラップされるコントロールまたはサーバー コントロールを GenericWebPart 指します。

Event 説明
AuthorizeWebPart コントロールが承認されていることを確認するために、ページに追加される直前に発生します。
ConnectionsActivated ページ上のすべての接続がアクティブ化された後に発生します。
ConnectionsActivating ページ上のすべての接続をアクティブ化するプロセスの直前に発生します。
DisplayModeChanged ページの現在の表示モードが変更された後に発生します。
DisplayModeChanging ページの表示モードを変更するプロセスの直前に発生します。
SelectedWebPartChanged コントロールの選択が取り消された後に発生します。
SelectedWebPartChanging コントロールの選択を取り消すプロセスの直前に発生します。
WebPartAdded コントロールがゾーンに追加された後に発生します。
WebPartAdding ゾーンにコントロールを追加するプロセスの直前に発生します。
WebPartClosed コントロールが閉じられた (ページから削除された) 後に発生します。
WebPartClosing コントロールを閉じるプロセスの直前に発生します。
WebPartDeleted 動的コントロールのインスタンス (プログラムによって作成されたもの、またはカタログから追加されたもの) が完全に削除された後に発生します。
WebPartDeleting 動的コントロールを削除するプロセスの直前に発生します。
WebPartMoved コントロールがゾーン内または別のゾーンに移動した後に発生します。
WebPartMoving コントロールを移動するプロセスの直前に発生します。
WebPartsConnected 接続に参加するために選択された 2 つのコントロールが接続を確立した後に発生します。
WebPartsConnecting 2 つのコントロールを接続するプロセスの直前に発生します。
WebPartsDisconnected 2 つの接続されたコントロールが切断された後に発生します。
WebPartsDisconnecting 2 つのコントロールを切断するプロセスの直前に発生します。

WebPartManagerコントロールには、Web パーツ ページを管理するための多数のメソッドがあります。 ここに記載されていないメソッドの大きなセットは、名前が OnEventName の形式のメソッドです。 これらのメソッドは通常、関連するイベントを発生させ、 型のハンドラーをイベントに提供します WebPartEventHandler。 これらのメソッドのほとんどは、 クラスから WebPartManager 継承する開発者によってオーバーライドできます。 また、ページ開発者は、これらのメソッドに関連付けられているイベントのカスタム ハンドラーを提供できます。 たとえば、イベントの場合、ページ開発者は Web ページのWebPartAddedマークアップ内の 要素に<asp:webpartmanager>属性を追加OnWebPartAddedし、その属性にカスタム メソッド名を割り当てて、イベントのカスタム処理を提供できます。 属性は メソッドに OnWebPartAdded 対応しており、この基本的なイベント処理パターンは、ほとんどの Web パーツ イベントとそれに関連するメソッドに対して機能します。

さらに、コントロールには、WebPartManagerコントロール (およびコントロールとしてWebPart使用されるサーバーまたはユーザー コントロール) を管理するWebPartタスクに特有のメソッドがあります。 これらのメソッドには、、AuthorizeWebPart、、、CloseWebPartCopyWebPartCreateWebPartBeginWebPartEditingExportWebPartImportWebPartGetGenericWebPartDeleteWebPartDisconnectWebPartEndWebPartEditingIsAuthorizedおよび が含まれます。AddWebPartMoveWebPart

別の一連のメソッドは、接続に特化しています。 これには、 などのActivateConnectionsConnectWebPartsCreateAvailableTransformersCanConnectWebPartsBeginWebPartConnectingDisconnectWebPartsEndWebPartConnectingDisconnectWebPartGetConsumerConnectionPointsメソッドが含まれます。GetProviderConnectionPoints

最後に、一部 WebPartManager のメソッドはパーソナル化機能に重点を置きます。 これらのメソッドには、CreatePersonalizationLoadControlStateSaveCustomPersonalizationStateSetPersonalizationDirtyIPersonalizable.LoadIPersonalizable.Save、および SaveControlState が含まれます。

プロパティからアクセスInternalsできるその他WebPartManagerのメソッドの詳細については、 クラスのドキュメントをWebPartManagerInternals参照してください。

注意 (継承者)

コントロールは WebPartManager 拡張するように設計されています。 Web パーツ アプリケーションの中心であるため、Web パーツ コントロール セットで特定の型またはコントロールを拡張する場合は、多くの場合、カスタム型を Web パーツ アプリケーションのコンテキストで動作させるために必要なプロパティまたはメソッドが存在する可能性があるため、クラスを拡張 WebPartManager する必要があります。 Web パーツの参照ドキュメント (「」を参照) System.Web.UI.WebControls.WebPartsでは、Web パーツの種類を拡張する方法について説明するとき、クラスを拡張 WebPartManager するために必要な操作についてよく言及したり、コード例で拡張する方法を示したりします。

コンストラクター

WebPartManager()

WebPartManager クラスの新しいインスタンスを初期化します。

フィールド

BrowseDisplayMode

Web パーツ コントロールが含まれたページの既定の表示モードを表します。 このフィールドは読み取り専用です。

CatalogDisplayMode

コントロールのカタログから Web ページにサーバー コントロールを追加する場合に使用する表示モードを表します。 このフィールドは読み取り専用です。

ConnectDisplayMode

ユーザーが WebPart コントロール間の接続を管理するための特殊なユーザー インターフェイス (UI) を表示する場合に使用する表示モードを表します。 このフィールドは読み取り専用です。

DesignDisplayMode

Web パーツ コントロールを含む Web ページのレイアウトを変更する場合に使用する表示モードを表します。 このフィールドは読み取り専用です。

EditDisplayMode

エンド ユーザーによるサーバー コントロールの編集および変更が可能な表示モードを表します。 このフィールドは読み取り専用です。

プロパティ

Adapter

コントロール用のブラウザー固有のアダプターを取得します。

(継承元 Control)
AppRelativeTemplateSourceDirectory

このコントロールが含まれている Page オブジェクトまたは UserControl オブジェクトのアプリケーション相対の仮想ディレクトリを取得または設定します。

(継承元 Control)
AvailableTransformers

サーバー コントロールの間に Web パーツ接続を作成する場合に使用できる WebPartTransformer オブジェクトのコレクションを取得します。

BindingContainer

このコントロールのデータ バインディングを格納しているコントロールを取得します。

(継承元 Control)
ChildControlsCreated

サーバー コントロールの子コントロールが作成されたかどうかを示す値を取得します。

(継承元 Control)
ClientID

ASP.NET によって生成される HTML マークアップのコントロール ID を取得します。

(継承元 Control)
ClientIDMode

ClientID プロパティの値を生成するために使用されるアルゴリズムを取得または設定します。

(継承元 Control)
ClientIDSeparator

ClientID プロパティで使用される区切り記号を表す文字値を取得します。

(継承元 Control)
CloseProviderWarning

接続で他のコントロールに対するプロバイダーとして動作しているコントロールをユーザーが終了すると表示される警告を取得または設定します。

Connections

Web ページ上の現在の接続すべてのコレクションへの参照を取得します。

Context

現在の Web 要求に対するサーバー コントロールに関連付けられている HttpContext オブジェクトを取得します。

(継承元 Control)
Controls

Web ページ上の WebPart ゾーン内にあり、WebPartZoneBase コントロールによって管理される、すべての WebPartManager コントロール、サーバー コントロール、またはユーザー コントロールのコレクションを取得します。

DataItemContainer

名前付けコンテナーが IDataItemContainer を実装している場合、名前付けコンテナーへの参照を取得します。

(継承元 Control)
DataKeysContainer

名前付けコンテナーが IDataKeysControl を実装している場合、名前付けコンテナーへの参照を取得します。

(継承元 Control)
DeleteWarning

エンド ユーザーがコントロールを削除したときにそのユーザーに対して表示するカスタム警告メッセージを取得または設定します。

DesignMode

コントロールがデザイン サーフェイスで使用されているかどうかを示す値を取得します。

(継承元 Control)
DisplayMode

Web パーツ コントロールが含まれた Web ページのアクティブな表示モードを取得または設定します。

DisplayModes

WebPartManager コントロールに関連付けられたすべての表示モードの読み取り専用のコレクションを取得します。

DynamicConnections

現在 Web ページ上に存在するすべての動的接続のコレクションを取得します。

EnableClientScript

WebPartManager コントロールが含まれた Web ページ上でクライアント側スクリプト機能を有効にするかどうかを決定する値を取得または設定します。

EnableTheming

Web ページ上でテーマを使用できることを示す値を取得します。

EnableViewState

要求元クライアントに対して、サーバー コントロールがそのビュー状態と、そこに含まれる任意の子のコントロールのビュー状態を保持するかどうかを示す値を取得または設定します。

(継承元 Control)
Events

コントロールのイベント ハンドラー デリゲートのリストを取得します。 このプロパティは読み取り専用です。

(継承元 Control)
ExportSensitiveDataWarning

ユーザーが WebPart コントロールから重要な状態情報をエクスポートしようとしたときに表示される警告メッセージのテキストを取得または設定します。

HasChildViewState

現在のサーバー コントロールの子コントロールが、保存されたビューステートの設定を持っているかどうかを示す値を取得します。

(継承元 Control)
ID

サーバー コントロールに割り当てられたプログラム ID を取得または設定します。

(継承元 Control)
IdSeparator

コントロール ID を区別するために使用する文字を取得します。

(継承元 Control)
Internals

実際には WebPartManagerInternals クラスに実装されていても、ほとんどの場合コントロールの開発者に役立つメソッドのセットを構成したり分割したりするために使用する、WebPartManager クラスへの参照を取得します。

IsChildControlStateCleared

このコントロールに含まれているコントロールに、コントロールの状態が設定されているかどうかを示す値を取得します。

(継承元 Control)
IsCustomPersonalizationStateDirty

WebPartManager コントロールにより制御されるページ レベルのパーソナル化の情報に影響を与えるような、パーソナル化に関する変更が行われたかどうかを示す値を取得します。

IsTrackingViewState

サーバー コントロールがビューステートの変更を保存しているかどうかを示す値を取得します。

(継承元 Control)
IsViewStateEnabled

このコントロールでビューステートが有効かどうかを示す値を取得します。

(継承元 Control)
LoadViewStateByID

コントロールがインデックスではなく ID によりビューステートの読み込みを行うかどうかを示す値を取得します。

(継承元 Control)
MediumPermissionSet

PermissionSet および Execution のアクセス許可のみを付与する Medium オブジェクトを取得します。

MinimalPermissionSet

PermissionSet および Execution のアクセス許可のみを付与する Minimal オブジェクトを取得します。

NamingContainer

同じ ID プロパティ値を持つ複数のサーバー コントロールを区別するための一意の名前空間を作成する、サーバー コントロールの名前付けコンテナーへの参照を取得します。

(継承元 Control)
Page

サーバー コントロールを含んでいる Page インスタンスへの参照を取得します。

(継承元 Control)
Parent

ページ コントロールの階層構造における、サーバー コントロールの親コントロールへの参照を取得します。

(継承元 Control)
Personalization

Web ページのパーソナル化データが格納されたオブジェクトへの参照を取得します。

RenderingCompatibility

レンダリングされる HTML と互換性がある ASP.NET のバージョンを表す値を取得します。

(継承元 Control)
SelectedWebPart

別のコントロールとの接続を編集または作成するために現在選択されている WebPart コントロールまたはその他のサーバー コントロールへの参照を取得します。

Site

デザイン サーフェイスに現在のコントロールを表示するときに、このコントロールをホストするコンテナーに関する情報を取得します。

(継承元 Control)
SkinID

WebPartManager コントロールにスキンを適用できないように、空の文字列 ("") を取得または設定します。

StaticConnections

Web ページ上の静的接続として定義されているすべての WebPartConnection オブジェクトのコレクションへの参照を取得します。

SupportedDisplayModes

特定の Web ページ上で使用できるすべての表示モードの読み取り専用のコレクションを取得します。

TemplateControl

このコントロールを格納しているテンプレートへの参照を取得または設定します。

(継承元 Control)
TemplateSourceDirectory

現在のサーバー コントロールを格納している Page または UserControl の仮想ディレクトリを取得します。

(継承元 Control)
UniqueID

階層構造で修飾されたサーバー コントロールの一意の ID を取得します。

(継承元 Control)
ValidateRequestMode

ブラウザーからのクライアント入力の安全性をコントロールで調べるかどうかを示す値を取得または設定します。

(継承元 Control)
ViewState

同一のページに対する複数の要求にわたって、サーバー コントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。

(継承元 Control)
ViewStateIgnoresCase

StateBag オブジェクトが大文字小文字を区別しないかどうかを示す値を取得します。

(継承元 Control)
ViewStateMode

このコントロールのビューステート モードを取得または設定します。

(継承元 Control)
Visible

子コントロールを表示できるようにする値を取得します。

WebParts

Web ページ上の WebPart コントロールで追跡されるすべての WebPartManager コントロールへの参照を取得します。

Zones

Web ページ上のすべての WebPartZoneBase ゾーンのコレクションへの参照を取得します。

メソッド

ActivateConnections()

Web ページ上で現在アクティブでないすべての接続をアクティブにします。

AddedControl(Control, Int32)

子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。

(継承元 Control)
AddParsedSubObject(Object)

XML または HTML のいずれかの要素が解析されたことをサーバー コントロールに通知し、サーバー コントロールの ControlCollection オブジェクトに要素を追加します。

(継承元 Control)
AddWebPart(WebPart, WebPartZoneBase, Int32)

Web ページにプログラムで WebPart コントロールを追加する標準メソッドを提供します。

ApplyStyleSheetSkin(Page)

ページのスタイル シートに定義されたスタイル プロパティをコントロールに適用します。

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

レンダリング データのデザイン時のトレースを開始します。

(継承元 Control)
BeginWebPartConnecting(WebPart)

2 つの WebPart コントロールを接続するプロセスを開始します。

BeginWebPartEditing(WebPart)

WebPart コントロールを編集するプロセスを開始します。

BuildProfileTree(String, Boolean)

ページのトレースが有効な場合、サーバー コントロールに関する情報を収集し、これを表示するために Trace プロパティに渡します。

(継承元 Control)
CanConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

コンシューマー コントロールとプロバイダー コントロールが互換性のあるインターフェイスを持ち、WebPart オブジェクトが不要な場合に、接続に関係する WebPartTransformer コントロールをチェックし、こうしたコントロールを接続できるかどうかを判断します。

CanConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartTransformer)

接続に関係する WebPart コントロールをチェックして、こうしたコントロールが接続可能かどうかを判断し、WebPartTransformer オブジェクトを使用して互換性のないコンシューマーとプロバイダーの間に接続を作成します。

CheckRenderClientScript()

ブラウザーから要求を行う機能および EnableClientScript プロパティの値をチェックし、クライアント スクリプトを表示するかどうかを判断します。

ClearCachedClientID()

キャッシュされた ClientID 値を null に設定します。

(継承元 Control)
ClearChildControlState()

サーバー コントロールのすべての子コントロールについて、コントロールの状態情報を削除します。

(継承元 Control)
ClearChildState()

サーバー コントロールのすべての子コントロールのビューステート情報およびコントロールの状態情報を削除します。

(継承元 Control)
ClearChildViewState()

サーバー コントロールのすべての子コントロールのビューステート情報を削除します。

(継承元 Control)
ClearEffectiveClientIDMode()

現在のコントロール インスタンスおよびすべての子コントロールの ClientIDMode プロパティを Inherit に設定します。

(継承元 Control)
CloseWebPart(WebPart)

Web ページ上に表示されなくても再度開くことができる方法で WebPart コントロールを終了します。

ConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

コントロールへの参照とその指定された WebPart オブジェクトだけを使用して、2 つの GenericWebPart コントロールまたは ConnectionPoint コントロールの間に接続を作成します。

ConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartTransformer)

コントロールへの参照、指定された WebPart オブジェクト、および GenericWebPart オブジェクトを使用して、2 つの ConnectionPoint コントロールまたは WebPartTransformer コントロール間の接続を作成します。

CopyWebPart(WebPart)

Web ページに WebPart コントロールまたはサーバー コントロールを追加するためにこうしたコントロールのコピーを作成する場合に、Web パーツ コントロール セットで使用されます。

CreateAvailableTransformers()

Web サイトの構成ファイルに指定されているトランスフォーマーのセットを作成し、AvailableTransformers プロパティで参照されるトランスフォーマーのコレクションにそれを追加します。

CreateChildControls()

ASP.NET ページ フレームワークによって呼び出され、ポストバックまたはレンダリングの準備として、合成ベースの実装を使うサーバー コントロールに対し、それらのコントロールに含まれる子コントロールを作成するように通知します。

(継承元 Control)
CreateControlCollection()

Web ページ上の WebPartManager コントロールで管理されるすべてのコントロールのコレクションを返します。 このクラスは継承できません。

CreateDisplayModes()

Web パーツ アプリケーションで使用できるすべての表示モードのセットを作成します。

CreateDynamicConnectionID()

動的接続の ID として使用される一意の値を取得します。

CreateDynamicWebPartID(Type)

動的な WebPart コントロールの一意の ID を生成します。

CreateErrorWebPart(String, String, String, String, String)

動的な WebPart コントロールを読み込むか作成しようとして何らかの理由で失敗したときに、ページに挿入してエンド ユーザーに表示する特別なコントロールを作成します。

CreatePersonalization()

現在の Web ページのユーザーのパーソナル化データを格納するパーソナル化オブジェクトを返します。

CreateWebPart(Control)

WebPart オブジェクトを持った GenericWebPart コントロール以外のサーバー コントロールが Web パーツ機能を備えることができるように、そのコントロールをラップします。

DataBind()

呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。

(継承元 Control)
DataBind(Boolean)

DataBinding イベントを発生させるオプションを指定して、呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。

(継承元 Control)
DataBindChildren()

データ ソースをサーバー コントロールの子コントロールにバインドします。

(継承元 Control)
DeleteWebPart(WebPart)

WebPart コントロールの動的インスタンスを Web ページから完全に削除します。

DisconnectWebPart(WebPart)

終了または削除する WebPart コントロールまたはサーバー コントロールを、それが関係する接続から削除します。

DisconnectWebParts(WebPartConnection)

Web ページ上で接続されたサーバー コントロールの接続を解除するプロセスを実行します。

Dispose()

サーバー コントロールが、メモリから解放される前に最終的なクリーンアップを実行できるようにします。

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

レンダリング データのデザイン時のトレースを終了します。

(継承元 Control)
EndWebPartConnecting()

一方の WebPart コントロールをもう一方のコントロールに接続するプロセスを完了させます。

EndWebPartEditing()

WebPart コントロールを編集するプロセスを完了させます。

EnsureChildControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。 含まれていない場合、子コントロールを作成します。

(継承元 Control)
EnsureID()

ID が割り当てられていないコントロールの ID を作成します。

(継承元 Control)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
ExportWebPart(WebPart, XmlWriter)

サーバー コントロールの状態データとプロパティ データが格納された XML 記述ファイルを作成します。

FindControl(String)

指定した id パラメーターを使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。

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

指定した id および検索に役立つ pathOffset パラメーターに指定された整数を使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。 この形式の FindControl メソッドはオーバーライドしないでください。

(継承元 Control)
Focus()

オーバーライドして、ユーザー インターフェイス (UI) のない WebPartManager コントロールにフォーカスが設定されるのを防ぎます。

GetConsumerConnectionPoints(WebPart)

Web パーツ接続内でコンシューマーとして動作するサーバー コントロールから、コネクション ポイントとして機能できる ConsumerConnectionPoint オブジェクトのコレクションを取得します。

GetCurrentWebPartManager(Page)

ページ上の WebPartManager コントロールの現在のインスタンスへの参照を取得します。

GetDesignModeState()

コントロールのデザイン時データを取得します。

(継承元 Control)
GetDisplayTitle(WebPart)

DisplayTitle コントロールの WebPart プロパティの値が含まれた文字列を取得します。

GetExportUrl(WebPart)

ユーザーが WebPart コントロールをエクスポートしようとするときの要求に含まれる相対仮想パスとクエリ文字列を取得します。

GetGenericWebPart(Control)

サーバー コントロールが含まれた GenericWebPart コントロールのインスタンスへの参照を取得します。

GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetProviderConnectionPoints(WebPart)

Web パーツ接続内でプロバイダーとして動作するサーバー コントロールから、コネクション ポイントとして機能できる ProviderConnectionPoint オブジェクトのコレクションを取得します。

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)
HasControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。

(継承元 Control)
HasEvents()

コントロールまたは子コントロールに対してイベントが登録されているかどうかを示す値を返します。

(継承元 Control)
ImportWebPart(XmlReader, String)

WebPart コントロールの状態データとプロパティ データが格納された XML 記述ファイルをインポートし、コントロールにそのデータを適用します。

IsAuthorized(Type, String, String, Boolean)

ページへのコントロールの追加が承認されているかどうかを判断する最後の手順を実行します。

IsAuthorized(WebPart)

ページへのコントロールの追加が承認されているかどうかを判断する最初の手順を実行します。

IsLiteralContent()

サーバー コントロールがリテラルな内容だけを保持しているかどうかを決定します。

(継承元 Control)
LoadControlState(Object)

前回のページ要求で保存され、後続の要求で復元する必要のある、コントロールの状態データを読み込みます。

LoadCustomPersonalizationState(PersonalizationDictionary)

初期化プロセス中に後で使用するためにパーソナル化オブジェクトによって WebPartManager コントロールに渡されたカスタムのパーソナル化データを格納します。

LoadViewState(Object)

SaveViewState() メソッドによって保存された前回のページ要求からビューステート情報を復元します。

(継承元 Control)
MapPathSecure(String)

仮想パス (絶対パスまたは相対パス) の割り当て先の物理パスを取得します。

(継承元 Control)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
MoveWebPart(WebPart, WebPartZoneBase, Int32)

1 つの WebPart ゾーンから別のゾーンまたは同じゾーン内の新しい位置に、WebPartZoneBase コントロールまたはサーバー コントロールを移動します。

OnAuthorizeWebPart(WebPartAuthorizationEventArgs)

AuthorizeWebPart イベントを発生させ、イベントのハンドラーが存在する場合はそれを呼び出します。

OnBubbleEvent(Object, EventArgs)

サーバー コントロールのイベントをページの UI サーバー コントロールの階層構造に渡すかどうかを決定します。

(継承元 Control)
OnConnectionsActivated(EventArgs)

ページとそのコントロールが読み込まれ、ページの接続がアクティブになってデータの共有が開始されることを示す ConnectionsActivated イベントを発生させます。

OnConnectionsActivating(EventArgs)

ページとそのコントロールが読み込まれ、接続をアクティブにするプロセスを開始できることを示す ConnectionsActivating イベントを発生させます。

OnDataBinding(EventArgs)

DataBinding イベントを発生させます。

(継承元 Control)
OnDisplayModeChanged(WebPartDisplayModeEventArgs)

Web ページ上で DisplayModeChanged コントロールが、ある表示モードから別の表示モードに切り替えるプロセスを完了したことを示す、WebPartManager イベントを発生させます。

OnDisplayModeChanging(WebPartDisplayModeCancelEventArgs)

Web ページ上で DisplayModeChanging コントロールが、ある表示モードから別の表示モードに切り替えるプロセスを実行していることを示す、WebPartManager イベントを発生させます。

OnInit(EventArgs)

Init コントロールの有効期間における最初のイベントとして、WebPartManager イベントを発生させます。

OnLoad(EventArgs)

Load イベントを発生させます。

(継承元 Control)
OnPreRender(EventArgs)

Web ページに PreRender コントロールを表示する直前に発生する、WebPartManager イベントを発生させます。

OnSelectedWebPartChanged(WebPartEventArgs)

SelectedWebPartChanged コントロールを新しく選択した後またはその選択を解除した後に発生する、WebPart イベントを発生させます。

OnSelectedWebPartChanging(WebPartCancelEventArgs)

現在選択されている SelectedWebPartChanging コントロールから選択を他に変更するプロセスを実行しているときに発生する、WebPart イベントを発生させます。

OnUnload(EventArgs)

Unload 基本イベントを発生させ、Web ページから WebPartManager インスタンスを削除します。

OnWebPartAdded(WebPartEventArgs)

WebPartAdded コントロールがページに追加された後に発生する、WebPart イベントを発生させます。

OnWebPartAdding(WebPartAddingEventArgs)

WebPartAdding コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) を WebPart ゾーンに追加するプロセスを実行しているときに発生する、WebPartZoneBase イベントを発生させます。

OnWebPartClosed(WebPartEventArgs)

コントロールがページから削除されたことを通知する WebPartClosed イベントを発生させます。

OnWebPartClosing(WebPartCancelEventArgs)

ページから WebPartClosing コントロールまたはサーバー コントロールを削除するプロセスを実行しているときに発生する、WebPart イベントを発生させます。

OnWebPartDeleted(WebPartEventArgs)

WebPartDeleted コントロールがページから完全に削除された後に発生する、WebPart イベントを発生させます。

OnWebPartDeleting(WebPartCancelEventArgs)

動的な WebPartDeleting コントロール (または、WebPart ゾーンに配置されたサーバー コントロールまたはユーザー コントロール) を削除するプロセスを実行していることを示す、WebPartZoneBase イベントを発生させます。

OnWebPartMoved(WebPartEventArgs)

WebPartMoved コントロールがページ上の別の位置に移動された後に発生する、WebPart イベントを発生させます。

OnWebPartMoving(WebPartMovingEventArgs)

WebPartMoving ゾーン内の WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) を移動するプロセスを実行していることを示す、WebPartZoneBase イベントを発生させます。

OnWebPartsConnected(WebPartConnectionsEventArgs)

WebPartsConnected コントロールの間に接続が確立された後に発生する、WebPart イベントを発生させます。

OnWebPartsConnecting(WebPartConnectionsCancelEventArgs)

WebPartsConnecting ゾーンに配置されている 2 つの WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) の間に接続を確立するプロセスを実行しているときに発生する、WebPartZoneBase イベントを発生させます。

OnWebPartsDisconnected(WebPartConnectionsEventArgs)

WebPartsDisconnected コントロール間の接続が終了した後に発生する、WebPart イベントを発生させます。

OnWebPartsDisconnecting(WebPartConnectionsCancelEventArgs)

WebPartsDisconnecting ゾーン内の 2 つの WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) の接続を終了するプロセスを実行していることを示す、WebPartZoneBase イベントを発生させます。

OpenFile(String)

ファイルの読み込みで使用される Stream を取得します。

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

イベントのソースおよびその情報をコントロールの親に割り当てます。

(継承元 Control)
RegisterClientScript()

WebPartManager コントロールで、Web ページ内における WebPart コントロールのドラッグなど、さまざまなパーソナル化機能に使用するクライアント側スクリプトを生成できるようにします。

RemovedControl(Control)

Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。

(継承元 Control)
Render(HtmlTextWriter)

オーバーライドして、WebPartManager コントロールが何らかの内容を表示するのを防ぎます。

RenderChildren(HtmlTextWriter)

提供された HtmlTextWriter オブジェクトに対してサーバー コントロールの子のコンテンツを出力すると、クライアントで表示されるコンテンツが記述されます。

(継承元 Control)
RenderControl(HtmlTextWriter)

指定の HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力し、トレースが有効である場合はコントロールに関するトレース情報を保存します。

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

指定した ControlAdapter オブジェクトを使用して、指定した HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力します。

(継承元 Control)
ResolveAdapter()

指定したコントロールを表示するコントロール アダプターを取得します。

(継承元 Control)
ResolveClientUrl(String)

ブラウザーで使用できる URL を取得します。

(継承元 Control)
ResolveUrl(String)

要求側クライアントで使用できる URL に変換します。

(継承元 Control)
SaveControlState()

WebPartManager コントロールの状態データを保存し、今後このコントロールが含まれた Web ページを要求されたときにそのデータを復元できるようにします。

SaveCustomPersonalizationState(PersonalizationDictionary)

WebPartManager コントロールによって管理されるカスタムのパーソナル化状態データを保存します。これにより、ページの再読み込みを行うたびにこのデータを読み込めるようになります。

SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、サーバー コントロールのビューステートの変更を保存します。

(継承元 Control)
SetDesignModeState(IDictionary)

コントロールのデザイン時データを設定します。

(継承元 Control)
SetPersonalizationDirty()

WebPartManager コントロールのカスタムのパーソナル化データが変更されたことを示すフラグを設定します。

SetRenderMethodDelegate(RenderMethod)

サーバー コントロールとその内容を親コントロールに表示するイベント ハンドラー デリゲートを割り当てます。

(継承元 Control)
SetSelectedWebPart(WebPart)

現在選択されている SelectedWebPart コントロールまたはサーバー コントロールと同じ WebPart プロパティ値を設定します。

SetTraceData(Object, Object)

トレース データ キーとトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。

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

トレースされたオブジェクト、トレース データ キー、およびトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。

(継承元 Control)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
TrackViewState()

パーソナル化状態データを WebPartManager コントロールに適用し、基本メソッドを呼び出してコントロールのビューステート データに対する変更を追跡できるようにします。

イベント

AuthorizeWebPart

IsAuthorized メソッドを呼び出すと発生し、WebPart コントロールまたはサーバー コントロールをページに追加できるかどうかを判断します。

ConnectionsActivated

ページ上の現在の Web パーツ接続すべてが接続され、さらにそれぞれの接続に関係するコンシューマー コントロールとプロバイダー コントロールの間にアクティブなデータの共有が開始された後に発生します。

ConnectionsActivating

Web ページ上で確立されたすべての Web パーツ接続をアクティブにするプロセスを実行しているときに発生します。

DataBinding

サーバー コントロールがデータ ソースに連結すると発生します。

(継承元 Control)
DisplayModeChanged

Web パーツ ページ上の現在の表示モードが変更された後に発生します。

DisplayModeChanging

Web ページ上で別の表示モードに変更するプロセスを開始する動詞をユーザーがクリックした後に発生します。

Disposed

サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。

(継承元 Control)
Init

サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。

(継承元 Control)
Load

サーバー コントロールが Page オブジェクトに読み込まれると発生します。

(継承元 Control)
PreRender

Control オブジェクトの読み込み後、表示を開始する前に発生します。

(継承元 Control)
SelectedWebPartChanged

ある WebPart コントロールの選択を変更して Web ページ上の別のコントロールに移動した後に発生します。

SelectedWebPartChanging

Web ページ上で現在選択されている WebPart コントロールまたはサーバー コントロールの変更プロセス中に発生します。

Unload

サーバー コントロールがメモリからアンロードされると発生します。

(継承元 Control)
WebPartAdded

動的な WebPart コントロールまたはその他のサーバー コントロールを WebPartZoneBase ゾーンに追加した後に発生し、そのコントロールが正常に追加されたことを示します。

WebPartAdding

動的な WebPart コントロールまたはその他のサーバー コントロールを WebPartZoneBase ゾーンに追加するプロセスを実行しているときに発生します。

WebPartClosed

WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) をページから削除すると発生します。

WebPartClosing

WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) をページから削除するプロセスを実行しているときに発生します。

WebPartDeleted

WebPart コントロールまたはその他のサーバー コントロールを WebPartZoneBase ゾーンから削除した後に発生します。

WebPartDeleting

動的な WebPart コントロールまたはその他のサーバー コントロールのインスタンスを WebPartZoneBase ゾーンから完全に削除するプロセスを実行しているときに発生します。

WebPartMoved

WebPart コントロールまたはサーバー コントロールを、Web ページ上の別の位置に移動した後に発生します。

WebPartMoving

WebPart ゾーンに配置されている WebPartZoneBase コントロールまたはその他のサーバー コントロールを移動するプロセスを実行しているときに発生します。

WebPartsConnected

WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) の間に特定の接続が確立された後に発生します。

WebPartsConnecting

WebPart コントロール (または、WebPartZoneBase ゾーンに配置されたサーバー コントロールまたはユーザー コントロール) の間に接続を作成するプロセスを実行しているときに発生します。

WebPartsDisconnected

2 つの WebPart コントロールまたはサーバー コントロール間の接続が終了した後に発生します。

WebPartsDisconnecting

以前に接続した WebPart コントロールまたはサーバー コントロール間の接続を終了するプロセスを実行しているときに発生します。

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

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)
IPersonalizable.IsDirty

WebPartManager コントロールによって管理されているカスタムのパーソナル化状態データが Web ページ上で変更されたかどうかを示す値を取得します。

IPersonalizable.Load(PersonalizationDictionary)

WebPartManager コントロールに読み込む必要がある、以前に保存したカスタムのパーソナル化状態データを返します。

IPersonalizable.Save(PersonalizationDictionary)

WebPartManager コントロールで管理されるカスタムのパーソナル化状態データを保存します。

拡張メソッド

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)

指定されたデータ コントロールの動的データの動作を有効にします。

適用対象

こちらもご覧ください