WebPartManager.GetGenericWebPart(Control) メソッド

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

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

public:
 System::Web::UI::WebControls::WebParts::GenericWebPart ^ GetGenericWebPart(System::Web::UI::Control ^ control);
public System.Web.UI.WebControls.WebParts.GenericWebPart GetGenericWebPart(System.Web.UI.Control control);
member this.GetGenericWebPart : System.Web.UI.Control -> System.Web.UI.WebControls.WebParts.GenericWebPart
Public Function GetGenericWebPart (control As Control) As GenericWebPart

パラメーター

control
Control

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

返品

GenericWebPart

子コントロールとしてcontrolをラップするGenericWebPart。 controlがGenericWebPartに含まれていない場合、メソッドはnullを返します。

例外

ArgumentNullException

control は nullです。

例

次のコード例は、 GetGenericWebPart メソッドの使用方法を示しています。 このコード例には、WebPartZone ゾーン内で宣言されたCalendar コントロールが含まれています。 Button1_Click メソッドは、最初にCalendar コントロールの ID をラベルに出力してから、GetGenericWebPart メソッドを使用して、カレンダーをラップするGenericWebPart コントロールへの参照を取得します。 GenericWebPart コントロールの ID と子コントロールの ID (Calendar コントロール) は、どちらも 2 番目のラベルに出力されます。

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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 xmlns="http://www.w3.org/1999/xhtml" >
<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>

<%@ Page Language="vb" %>

<!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 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 xmlns="http://www.w3.org/1999/xhtml" >
<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>

注釈

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

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

適用対象

こちらもご覧ください