WebPart クラス
アセンブリ: System.Web (system.web.dll 内)
構文解説Web パーツ機能を持つコントロールを作成する場合は、2 つの基本オプションがあります。WebPart クラスから派生するカスタム コントロールを作成するオプションと、他のサーバー コントロールを作成または使用するオプションです。既存の ASP.NET コントロール、カスタム サーバー コントロール、およびユーザー コントロールを WebPartZone ゾーン コントロール内で宣言する (またはプログラムによってこのゾーン コントロールに追加する) ことによって、これらのコントロールに完全な Web パーツ機能を追加できます。この結果、コントロールは実行時に GenericWebPart オブジェクトでラップされ、真の WebPart コントロールとして扱われます。詳細については、GenericWebPart クラスのドキュメントを参照してください。開発速度を上げ、コードをできる限り再利用するためには、既存のサーバー コントロールの使用をお勧めします。コントロールの動作と Web パーツ機能をプログラムで最大限に制御するためには、多くの場合、WebPart クラスから継承するカスタム コントロールを作成する方法が最適です。
WebPart 抽象クラスは、Part 基本コントロールから継承し、すべての WebPart コントロールの基本要素を提供します。クラスには、UI の外観に影響するプロパティの共通セットが含まれます。AllowClose、AllowConnect、AllowEdit、AllowHide、AllowMinimize、および AllowZoneChange の各プロパティは、Web アプリケーションのユーザーが特定のプロパティ名で示される方法でパーツ コントロールとやり取りすることを許可するかどうかを指定します。CatalogIconImageUrl、ChromeState、ChromeType、Description、Height、HelpUrl、Hidden、Title、TitleIconImageUrl、TitleUrl、および Width の各プロパティは、WebPart コントロールのサイズ、可視性、外観、およびサポートしている内容 (タイトルや説明など) を指定します。
WebPart コントロールと、Web パーツ コントロール セット内にあるその内容との関係は、コントロールが関連付けられている WebPartManager オブジェクトへの参照を保持する WebPartManager や、コントロールを格納する WebZone を参照する Zone などのプロパティによって決まります。WebPartManager コントロールは各ページに 1 つだけです。また、WebPart コントロールの各インスタンスは、一度に 1 つだけの WebZone 内に配置できます。
.gif) メモ |
|---|
| WebPart コントロールは、Web ページ内のゾーンの外部に配置できますが、この場合、通常のサーバー コントロールとして機能し、ほぼすべての Web パーツ機能が失われます。 |
他のいくつかの重要なプロパティは、WebPart コントロールの固有の機能に影響します。AuthorizationFilter プロパティを使用すると、実行時にコントロールがページに追加されるかどうかを決定するフィルタとして使用できる任意の文字列を、開発者が設定できます。AuthorizationFilter プロパティは、ロール管理などの機能と共に使用され、定義済みのユーザー ロールに基づいたビューの作成に役立つ機構を提供します。ExportMode プロパティは、エクスポート中に、コントロールの利用可能なすべてのプロパティ データがエクスポートされるか、または機密以外のデータだけがエクスポートされるかを示します。これによって、開発者は、セキュリティの目的で機密データとそれ以外のデータを区別できます。WebBrowsableObject プロパティは、WebPart コントロールのインスタンスへの参照を返して、ページが編集モードの場合に、そのコントロールを EditorPart コントロールで編集できるようにします。最後に、ページの残り部分に関連するコントロールのステータスを示すいくつかのプロパティがあります。IsClosed プロパティは、コントロールが終了されている (したがって PageCatalogPart オブジェクトに追加されている) かどうか、またはページで開かれ利用できるようになっているかどうかを示します。IsShared プロパティは、コントロールが、(ユーザー固有のコントロールに対して) 共有コントロールであるかどうかを示します。共有コントロールは、Web ページのすべてのユーザーに表示されます。IsStandalone プロパティは、コントロールが現在 (WebPartZone などの) WebPartZoneBase 派生ゾーンに含まれているかどうかを示します。false 値は、コントロールがゾーン内にあり、したがって完全な Web パーツ機能を備えていることを示します。IsStatic プロパティは、コントロールが静的か動的かを示します。スタティック コントロールは、Web ページのマークアップで宣言されますが、ダイナミック コントロールはプログラムで追加されます。
WebPart クラスには、コントロールの有効期間中のさまざまな時点での動作を決定するいくつかのメソッドも用意されています。たとえば、OnConnectModeChanged メソッドおよび OnEditModeChanged メソッドの両方を派生クラスでオーバーライドして、各メソッドの名前に対応するイベントでのコントロールの内容の表示をプログラムによって制御できます。
WebPart から派生するクラスは、WebPartVerb オブジェクトを Verbs コレクションに追加できます。動詞は、WebPart コントロールのタイトル バーに表示される動詞メニューに表示されます。WebPartVerb オブジェクトは、コントロールの非表示、最小化、ヘルプの表示などの一般的なユーザー アクションに対する単純な UI 要素を提供します。
CreateEditorParts メソッドは、WebPart コントロールに関連付けられているカスタム EditorPart コントロールのコレクションを作成します。開発者は、WebPart コントロールの編集用にデザインされたカスタム コントロールを作成するように、このメソッドをオーバーライドできます。このメソッドは、ユーザーが WebPart コントロールで edit 動詞をクリックしたときに呼び出されます。
使用例WebPart コントロールを作成し、それを Web ページで参照する方法を次のコード例に示します。
例の最初の部分には、TextDisplayWebPart という名前のカスタム WebPart コントロールのコードが含まれています。このコントロールは、Web パーツ コントロール セットの機能を利用できるようにする単純なカスタム WebPart コントロールを作成する方法を示します。コード例を実行するためには、このソース コードをコンパイルする必要があります。それを明示的にコンパイルし、コンパイル済みのアセンブリを Web サイトの Bin フォルダまたはグローバル アセンブリ キャッシュに配置できます。サイトの App_Code フォルダにソース コードを配置し、実行時に動的にコンパイルすることもできます。このコード例は、ソース コードをアセンブリにコンパイルし、それを各自の Web アプリケーションの Bin サブフォルダに配置し、アセンブリを各自の Web ページの Register ディレクティブで参照することを前提にしています。両方のコンパイル方法を示すチュートリアルについては、「チュートリアル : カスタム サーバー コントロールの開発と使用」を参照してください。
Imports System Imports System.Security.Permissions Imports System.Web 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 _contentText = input.Text & "<br />" input.Text = String.Empty DisplayContent.Text = Me.ContentText End If End Sub End Class End Namespace
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; public TextDisplayWebPart() { this.AllowClose = false; } [Personalizable(), 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 (input.Text != String.Empty) { _contentText = input.Text + @"<br />"; input.Text = String.Empty; DisplayContent.Text = this.ContentText; } } } }
package Samples.AspNet.JSL.Controls; import System.*; import System.Security.Permissions.*; import System.Web.*; import System.Web.UI.WebControls.*; import System.Web.UI.WebControls.WebParts.*; /** @attribute AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal) */ /** @attribute AspNetHostingPermission(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */ public class TextDisplayWebPart extends WebPart { private String _contentText = null; private TextBox input; private Label displayContent; public TextDisplayWebPart() { this.set_AllowClose(false); } //TextDisplayWebPart /** @attribute Personalizable() @attribute WebBrowsable() */ /** @property */ public String get_ContentText() { return _contentText; } //get_ContentText /** @property */ public void set_ContentText(String value) { _contentText = value; } //set_ContentText protected void CreateChildControls() { get_Controls().Clear(); displayContent = new Label(); displayContent.set_BackColor(System.Drawing.Color.get_LightBlue()); displayContent.set_Text(this.get_ContentText()); this.get_Controls().Add(displayContent); input = new TextBox(); this.get_Controls().Add(input); Button update = new Button(); update.set_Text("Set Label Content"); update.add_Click(new EventHandler(this.Submit_Click)); this.get_Controls().Add(update); set_ChildControlsCreated(true); } //CreateChildControls private void Submit_Click(Object sender, EventArgs e) { // Update the label string. if (!(input.get_Text().Equals(""))) { _contentText = input.get_Text() + "<br />"; input.set_Text(""); displayContent.set_Text(this.get_ContentText()); } } //Submit_Click } //TextDisplayWebPart
この例の 2 番目の部分は、ASP.NET Web ページで TextDisplayWebPart コントロールを参照する方法を示しています。さまざまな WebPart プロパティの多くは、宣言によってカスタム コントロールに代入できます。
<%@ page language="VB" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.VB.Controls" Assembly="TextDisplayWebPartVB"%> <html> <head id="Head1" runat="server"> </head> <body> <form id="Form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <asp:webpartzone id="WebPartZone1" runat="server" title="Zone 1" PartChromeType="TitleAndBorder"> <parttitlestyle font-bold="true" ForeColor="#3300cc" /> <partstyle borderwidth="1px" borderstyle="Solid" bordercolor="#81AAF2" /> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" /> </zonetemplate> </asp:webpartzone> </form> </body> </html>
<%@ page language="C#" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.CS.Controls" Assembly="TextDisplayWebPartCS"%> <html> <head id="Head1" runat="server"> </head> <body> <form id="Form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <asp:webpartzone id="WebPartZone1" runat="server" title="Zone 1" PartChromeType="TitleAndBorder"> <parttitlestyle font-bold="true" ForeColor="#3300cc" /> <partstyle borderwidth="1px" borderstyle="Solid" bordercolor="#81AAF2" /> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" /> </zonetemplate> </asp:webpartzone> </form> </body> </html>
<%@ page language="VJ#" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.JSL.Controls" Assembly="TextDisplayWebPartJSL"%> <html> <head id="Head1" runat="server"> </head> <body> <form id="Form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <asp:webpartzone id="WebPartZone1" runat="server" title="Zone 1" PartChromeType="TitleAndBorder"> <parttitlestyle font-bold="true" ForeColor="#3300cc" /> <partstyle borderwidth="1px" borderstyle="Solid" bordercolor="#81AAF2" /> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" /> </zonetemplate> </asp:webpartzone> </form> </body> </html>
.NET Framework のセキュリティ継承階層System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.Panel
System.Web.UI.WebControls.WebParts.Part
System.Web.UI.WebControls.WebParts.WebPart
System.Web.UI.WebControls.WebParts.GenericWebPart
System.Web.UI.WebControls.WebParts.ProxyWebPart
スレッド セーフプラットフォーム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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- WebPart クラスのページへのリンク
