WebPartZoneBase.CloseWebPart メソッド

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

WebPartZoneBase.CloseWebPart メソッド

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

ゾーン内の選択した WebPart コントロールを終了します。

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

Visual Basic (宣言)

Protected Overridable Sub
 CloseWebPart ( _
    webPart As WebPart _
)

Visual Basic (使用法)

Dim webPart As WebPart

Me.CloseWebPart(webPart)

C#

protected virtual void CloseWebPart (
    WebPart webPart
)

C++

protected:
virtual void CloseWebPart (
    WebPart^ webPart
)

J#

protected void CloseWebPart (
    WebPart webPart
)

JScript

protected function CloseWebPart (
    webPart : WebPart
)

パラメータ

webPart

終了する WebPart コントロール。

解説

エンド ユーザーは通常 WebPart コントロールのタイトル バーにある close 動詞をクリックする方法でコントロールを終了します。CloseWebPart メソッドは、コントロールの終了アクションを実行する、WebPartManager クラスの CloseWebPart メソッドを呼び出します。メソッドは、WebPartZone などの派生 WebPartZoneBase ゾーンによってのみ使用されます。

終了した WebPart コントロールは、ページには表示されません。代わりに、ページで終了したすべてのコントロールのリストを保持するページ カタログに追加されます。ユーザーがコントロールを終了する Web パーツ ページに CatalogZone で宣言された <asp:PageCatalogPart> 要素もある場合、ユーザーはページをカタログ表示モードに切り替えて、終了したコントロールをページに戻すことができます。

メモ
ユーザーが WebPart コントロールを終了できるようにするには、コントロールの AllowClose プロパティおよびゾーンの AllowLayoutChange プロパティの両方を true に設定する必要があります。

プラットフォーム

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

参照

関連項目
WebPartZoneBase クラス
WebPartZoneBase メンバ
System.Web.UI.WebControls.WebParts 名前空間
PageCatalogPart クラス
WebPart.AllowClose プロパティ
WebPart.Hidden プロパティ
CloseVerb
その他の技術情報
ASP.NET Web パーツ ページ