WebPartManager.CreateWebPart メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebPartManager.CreateWebPart メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 CreateWebPart ( _
    control As Control _
) As GenericWebPart

Visual Basic (使用法)

Dim instance As WebPartManager
Dim control As Control
Dim returnValue As GenericWebPart

returnValue = instance.CreateWebPart(control)

public virtual GenericWebPart CreateWebPart (
    Control control
)

C++

public:
virtual GenericWebPart^ CreateWebPart (
    Control^ control
)

public GenericWebPart CreateWebPart (
    Control control
)

JScript

public function CreateWebPart (
    control : Control
) : GenericWebPart

パラメータ

control: WebPart コントロール以外のサーバーコントロール。

戻り値
control をラップし、真の WebPart コントロールとして機能できる GenericWebPart。

解説

CreateWebPart メソッドは、WebPart コントロール以外のサーバーコントロールに WebPart コントロールと同じ機能を提供し、Web パーツアプリケーションで完全に動作できるようにするための中心的なしくみです。このメソッドを使用することにより、標準 ASP.NET コントロール、ユーザーコントロール、およびカスタムコントロールという、事実上すべての種類のサーバーコントロールを使用できるため、開発者が Web パーツアプリケーションで使用できるサーバーコントロールの数が大幅に増加します。

WebPartManager コントロールも、次の 2 つの場合に、このメソッドを使用して GenericWebPart オブジェクトでサーバーコントロールをラップします。ユーザーが ImportCatalogPart コントロールを使用してページにサーバーコントロールを追加するときに、インポートしたコントロールが WebPart コントロールでない場合、CreateWebPart メソッドを呼び出します。また、サーバーコントロールが、Web ページ上の WebPartZoneBase ゾーン内に永続形式で宣言されている場合、WebPart コントロール以外のすべてのコントロールに対して CreateWebPart メソッドを呼び出します。

プログラムでサーバーコントロールをゾーンに追加する場合の代表的な方法では、CreateWebPart メソッドを使用して GenericWebPart オブジェクトでコントロールをラップします。次に、AddWebPart メソッドを呼び出し、WebParts プロパティで参照される、ページ上のすべての WebPart コントロールのコレクションにそのコントロールを追加します。

継承時の注意 このメソッドをオーバーライドすると、Web パーツコントロールセットに提供される基本クラスの代わりに、GenericWebPart 派生クラスを使用できます。

使用例

CreateWebPart メソッドを使用するコード例を次に示します。Button2_Click method で CreateWebPart メソッドを呼び出し、Calendar コントロールをゾーンに追加する前にそれを GenericWebPart オブジェクトでラップします。

Visual Basic

<%@ Page Language="vb" %>

<script runat="server">

  Protected Sub Button2_Click(ByVal
 sender As Object, _
    ByVal e As System.EventArgs)
    Dim mgr As WebPartManager = WebPartManager1
    Dim cal As New Calendar()
    cal.ID = "cal1"
    Dim calWebPart As GenericWebPart = mgr.CreateWebPart(cal)
    mgr.AddWebPart(calWebPart, WebPartZone1, 1)
  End Sub

  Protected Sub Button1_Click(ByVal
 sender As Object, _
    ByVal e As System.EventArgs)

    If WebPartZone1.WebParts.Count > 1 Then
      Dim cal As WebPart = WebPartZone1.WebParts(1)
      If cal.Controls(0).GetType().Name = "Calendar"
 AndAlso _
        cal IsNot Nothing Then
        WebPartManager1.DeleteWebPart(cal)
      End If
    End If
  End Sub
</script>

<html  >
<head id="Head1" runat="server">
    <title>Adding a Server Control</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="WebPartManager1"
 
        runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList  
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">
            Microsoft
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
            MSN
            </asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">
            Contoso Corp.
            </asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server"
 
        Text="Delete Calendar" 
        OnClick="Button1_Click" />
      <asp:Button ID="Button2" runat="server"
 
        Text="Add Calendar" 
        OnClick="Button2_Click" />
    </div>
    </form>
</body>
</html>

<%@ Page Language="C#" %>

<script runat="server">

  protected void Button2_Click(object sender,
 EventArgs e)
  {
    WebPartManager mgr = WebPartManager1;
    Calendar cal = new Calendar();
    cal.ID = "cal1";
    GenericWebPart calWebPart = mgr.CreateWebPart(cal);
    mgr.AddWebPart(calWebPart, WebPartZone1, 1);
  }

  protected void Button1_Click(object sender,
 EventArgs e)
  {
    if (WebPartZone1.WebParts.Count > 1)
    {
      WebPart cal = WebPartZone1.WebParts[1];
      if (cal.Controls[0].GetType().Name == "Calendar"
 
        && cal != null)
        WebPartManager1.DeleteWebPart(cal);
    }

  }
</script>

<html  >
<head runat="server">
    <title>Adding a Server Control</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="WebPartManager1" 
        runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList  
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">
            Microsoft
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
            MSN
            </asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">
            Contoso Corp.
            </asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Delete Calendar" 
        OnClick="Button1_Click" />
      <asp:Button ID="Button2" runat="server" 
        Text="Add Calendar" 
        OnClick="Button2_Click" />
    </div>
    </form>
</body>
</html>

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebPartManager クラス
WebPartManager メンバ
System.Web.UI.WebControls.WebParts 名前空間
AddWebPart
その他の技術情報
ASP.NET Web パーツページ

>> 「WebPartManager.CreateWebPart メソッド」を含む用語の索引
WebPartManager.CreateWebPart メソッドのページへのリンク


	© 2024 Microsoft.All rights reserved.

WebPartManager.CreateWebPart メソッドとは？ わかりやすく解説

WebPartManager.CreateWebPart メソッド

急上昇のことば

WebPartManager.CreateWebPart メソッドとは？わかりやすく解説