Part クラス

定義

public ref class Part abstract : System::Web::UI::WebControls::Panel, System::Web::UI::INamingContainer, System::Web::UI::WebControls::ICompositeControlDesignerAccessor

public abstract class Part : System.Web.UI.WebControls.Panel, System.Web.UI.INamingContainer, System.Web.UI.WebControls.ICompositeControlDesignerAccessor

type Part = class
    inherit Panel
    interface INamingContainer
    interface ICompositeControlDesignerAccessor

Public MustInherit Class Part
Inherits Panel
Implements ICompositeControlDesignerAccessor, INamingContainer

継承

Object

Control

WebControl

Panel

Part

派生

System.Web.UI.WebControls.WebParts.CatalogPart

System.Web.UI.WebControls.WebParts.EditorPart

System.Web.UI.WebControls.WebParts.WebPart

実装

INamingContainer ICompositeControlDesignerAccessor

例

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

この例の最初の部分には、 という名前 TextDisplayWebPartのカスタム コントロールのコードが含まれています。 コントロールは から WebPart派生しているため、クラスが提供する Part 共通プロパティも継承し、このコード例でこれらのプロパティの使用方法を示します。

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;
    const string _subTitle = "Contoso, Ltd";

    public TextDisplayWebPart()
    {
      this.AllowClose = false;
    }

    [
      Personalizable(PersonalizationScope.User, true),
      WebBrowsable()
    ]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = 
        System.Drawing.Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);
      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
      ChildControlsCreated = true;
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        this.ContentText = Page.Server.HtmlEncode(input.Text) + @"<br />";
        // Clear the input textbox.
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Security.Permissions
Imports System.Web
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 Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    
    
    Public Sub New() 
      Me.AllowClose = False
    End Sub
    
    <Personalizable(), WebBrowsable()>  _
    Public Property ContentText() As String 
        Get
            Return _contentText
        End Get
        Set
            _contentText = value
        End Set
    End Property
     
    Protected Overrides Sub CreateChildControls() 
        Controls.Clear()
        DisplayContent = New Label()
        DisplayContent.Text = Me.ContentText
        DisplayContent.BackColor = _
          System.Drawing.Color.LightBlue
        Me.Controls.Add(DisplayContent)
        input = New TextBox()
        Me.Controls.Add(input)
        Dim update As New Button()
        update.Text = "Set Label Content"
        AddHandler update.Click, AddressOf Me.submit_Click
        Me.Controls.Add(update)
        ChildControlsCreated = True
    
    End Sub
    
    
    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs) 
        ' Update the label string.
        If input.Text <> String.Empty Then
            Me.ContentText = Page.Server.HtmlEncode(input.Text) + "<br />"
            ' Clear the input textbox.
            input.Text = String.Empty
            DisplayContent.Text = Me.ContentText
        End If
    
    End Sub
    
End Class

End Namespace

この例の 2 番目の部分は、ASP.NET Web ページでカスタム パーツ コントロールを参照する方法を示しています。 さまざまな Part プロパティがカスタム コントロール インスタンスに宣言によって割り当てられていることに注意してください。 ページ上の 2 つのインスタンスを参照する宣言型コードを比較し、ブラウザーにページを読み込みます。 さまざまなプロパティがコントロールの外観にどのように影響するかに注意してください。 たとえば、ブラウザーでページを読み込んだ後、コントロールのプロパティ値が にMinimized設定されているためChromeState、コントロールの 2 番目のTextDisplayWebPartインスタンスは最小化されたように見えます。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            Description="A text content WebPart control."
            ChromeType="TitleAndBorder"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart2" 
            title = "Text Content WebPart 2" 
            Description="A text content WebPart control."
            ChromeType="TitleOnly"
            ChromeState="Minimized"
            width="350px" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注釈

クラスは Part 、すべてのパーツ コントロールに共通するプロパティを定義し、Web ページ上でモジュール式で一貫性のある外観を実現できるようにします。 これらの一般的なプロパティには、パーツ コントロールを囲むクロムまたはフレームのタイトル、説明、および特性が含まれます。

プロパティは Title 、パーツ コントロールのタイトルを指定します。 プロパティは Description 、パーツ コントロールの目的を要約するために使用され、コントロールのタイトル バーにツールヒントとして表示されます。 プロパティは ChromeType 、パーツ コントロールの周囲にレンダリングされる境界線の種類を指定します。一方 ChromeState 、 プロパティは、パーツ コントロールが正常にレンダリングされるか、最小化されるかを示します。 パーツ コントロールの境界線は、そのコントロールを含むゾーンのプロパティの影響を受けます。たとえば、 プロパティは PartChromeType 、ゾーンに含まれるすべてのパーツ コントロールのフレームに影響します。

パーツ コントロールの 1 つの種類は WebPart 、対応するゾーン内のコンテンツをレンダリングする コントロールです。 もう 1 つの種類は EditorPart コントロールで、個々 WebPart のコントロールを変更 (カスタマイズ) するために使用されるユーザー インターフェイス (UI) コントロールを提供します。 3 番目の種類のパーツ コントロールは CatalogPart コントロールであり、ユーザーが Web ページに追加したり、Web ページから削除したりできるコントロールの WebPart 一覧を提供します。

パーツ コントロールはゾーンに含まれており、そのすべてが抽象 WebZone クラスから派生します。 ゾーンは、そのゾーンに含まれるパーツ コントロールを整理する役割を担います。 また、各ゾーンは、ヘッダー、フッター、タイトル バー、および境界線などの各包含パーツ コントロールの周囲の UI 要素を含む、それ自体の UI 要素もレンダリングします。

次の表に、基本パーツタイプとそれに対応するゾーンタイプの例をいくつか示します。

クラスから Part 派生するさまざまな種類のパーツ コントロールは、継承された UI 指向のプロパティを異なる方法で処理します。 WebPart コントロールは、継承された UI プロパティの一部をオーバーライドし、属性で Personalizable マークします (詳細については、クラス ドキュメントを参照してください PersonalizableAttribute )。これにより、これらのプロパティの値を今後のブラウザー セッション (パーソナル化と呼ばれる機能) に保存できます。 たとえば、実行時にユーザーがコントロールTitleのプロパティのWebPart値をプログラムで更新できるようにする場合、その値はカスタマイズされます (パーソナル化が有効になっていると仮定します。これが既定です)。 コントロールが クラスと クラスからPart継承するいくつかの WebPart UI プロパティはWebControl、同じ方法で処理されます。

これに対し、 や CatalogPartなどのEditorPart他のパーツ コントロールでは、継承された UI プロパティをカスタマイズすることはできません。 このため、プログラムによって割り当てられたプロパティ値は、今後のブラウザー セッションでは保存されません。 たとえば、実行時にユーザーがコントロールのTitleプロパティをプログラムで更新PropertyGridEditorPartできるようにする場合、更新された値はコントロールを閉じた後、またはブラウザー セッションが終了した後に失われます。

このような継承された UI プロパティ EditorPart に値を保存する簡単な方法と、 CatalogPart 今後のブラウザー セッション用の コントロールは、プロパティ値をページ永続化形式で宣言することです。 ただし、これは静的なアプローチであり、ユーザーがプロパティ値をカスタマイズすることはできません。 別の方法として、ユーザーが実行時にカスタマイズできるように、継承された UI プロパティに対するプログラムによる更新を有効にする場合は、プライベートの静的変数を使用してプロパティ値を保存できます。 または CatalogPart コントロールのEditorPart新しいインスタンスが作成されるたびに (たとえば、コントロールInitのイベントを処理するメソッドでは)、静的変数の値を対応するプロパティに再割り当てできます。 このような方法により、ユーザーは Web パーツ アプリケーションの編集 UI とカタログ UI をカスタマイズできます。

注意 (実装者)

通常、カスタム Web パーツ コントロールを Part 開発するために、 クラスから直接継承しないでください。 Web パーツの完全な機能を提供するには、Web パーツ コントロール セットには、 クラスからPart派生したクラス (、、、 CatalogPart) WebPartEditorPartが必要です。そのため、カスタム コントロールを開発するには、そこから派生する必要があります。 ただし、基底 Part クラスの動作を理解することは、他のすべてのパーツ クラスで使用される共通のプロパティ セットを提供するため、引き続き重要です。

プロパティ

メソッド

イベント

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

拡張メソッド

適用対象

こちらもご覧ください

• ASP.NET Web パーツの概要
• Web パーツ コントロール セットの概要
• ASP.NET Web パーツ コントロール