WebPartManager.GetGenericWebPart メソッド

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

WebPartManager.GetGenericWebPart メソッド

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

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

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

Visual Basic (宣言)

Public Function GetGenericWebPart ( _
    control As Control _
) As GenericWebPart

Visual Basic (使用法)

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

returnValue = instance.GetGenericWebPart(control)

C#

public GenericWebPart GetGenericWebPart (
    Control control
)

C++

public:
GenericWebPart^ GetGenericWebPart (
    Control^ control
)

J#

public GenericWebPart GetGenericWebPart (
    Control control
)

JScript

public function GetGenericWebPart (
    control : Control
) : GenericWebPart

パラメータ

control

WebPartZoneBase 内に存在し、実行時に GenericWebPart の子コントロールとしてラップされるサーバー コントロール。

戻り値
control を子コントロールとしてラップする GenericWebPart。このメソッドは、GenericWebPart に control が含まれていない場合は null 参照 (Visual Basic では Nothing) を返します。

例外

例外の種類	条件
ArgumentNullException	control が null 参照 (Visual Basic では Nothing) です。

解説

一般に、開発者が WebPartZoneBase ゾーン内に配置して Web パーツ アプリケーションで使用するコントロールには 2 つのカテゴリがあります。その 1 つは、WebPart 基本クラスから継承する WebPart コントロールで、もう 1 つは、標準 ASP.NET コントロール、カスタム コントロール、またはユーザー コントロールを使用するその他のサーバー コントロールです。これらのコントロールのいずれかを WebPartZoneBase ゾーンに配置すると、それが WebPart コントロールの機能を備えます。WebPart コントロールは本質的にこの機能を備えていますが、他の種類のサーバー コントロールは備えていません。他のサーバー コントロールを WebPartZoneBase ゾーン内に配置すると、ASP.NET が GenericWebPart コントロールでそれらをラップし、それらが WebPart コントロールとして動作できるようになります。GenericWebPart コントロールは WebPart クラスから直接継承するため、真の Web パーツ機能を備えた子コントロールを提供します。

実行時にはしばしば、ページの開発者が、ゾーン内のサーバー コントロールの 1 つが含まれた GenericWebPart コントロールへの参照を取得することが必要になる場合があります。GetGenericWebPart メソッドを使用すると、GenericWebPart コントロールへの参照を取得できます。

使用例

GetGenericWebPart メソッドの使用方法を示すコード例を次に示します。このコード例には、WebPartZone ゾーン内に宣言された Calendar コントロールが含まれています。Button1_Click メソッドは最初に Calendar コントロールの ID をラベルに表示し、次に、GetGenericWebPart メソッドを使用して、予定表をラップする GenericWebPart コントロールへの参照を取得します。GenericWebPart コントロールの ID、および子コントロール (Calendar コントロール) の ID の両方を 2 番目のラベルに表示します。

Visual Basic

<%@ Page Language="vb" %>

<script runat="server">
 
  Protected Sub Button1_Click(ByVal
 sender As Object, _
    ByVal e As System.EventArgs)
    
    Label1.Text = "<h2>Server Control</h2>"
    Label1.Text += "Server Control ID:  " + Calendar1.ID
    Label2.Text = "<h2>GenericWebPart Controls</h2>"
    Dim part As GenericWebPart
    part = mgr.GetGenericWebPart(Calendar1)
    If part IsNot Nothing Then
      Label2.Text += _
        "GenericWebPart ID:  " & part.ID &
 "<br />"
      Label2.Text += _
        "Underlying Control ID: " + part.ChildControl.ID
    End If
    
  End Sub

</script>

<html  >
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server"
 />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server"
            Title="My Calendar" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server"
 
        Text="Get GenericWebPart"
        OnClick="Button1_Click" />
      <hr />
      <asp:Label ID="Label1" runat="server"
 Text="" />
      <br />
      <asp:Label ID="Label2" runat="server"
 Text="" />
    </div>
    </form>
</body>
</html>

C#

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

<script runat="server">
 
  protected void Button1_Click(object sender,
 EventArgs e)
  {
    Label1.Text = "<h2>Server Control</h2>";
    Label1.Text += "Server Control ID:  " + Calendar1.ID;
    Label2.Text = "<h2>GenericWebPart Control</h2>";
    GenericWebPart part = mgr.GetGenericWebPart(Calendar1);
    if (part != null)
    {
      Label2.Text +=
        "GenericWebPart ID:  " + part.ID + "<br />";
      Label2.Text +=
        "Underlying Control ID: " + part.ChildControl.ID;
    }
  }

</script>

<html  >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server"
            Title="My Calendar" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Get GenericWebPart"
        OnClick="Button1_Click" />
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""
 />
      <br />
      <asp:Label ID="Label2" runat="server" Text=""
 />
    </div>
    </form>
</body>
</html>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

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