WebPartManager.WebPartClosing イベント

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

WebPartManager.WebPartClosing イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

WebPart コントロール (あるいは、サーバー コントロールまたはユーザー コントロール) をページから削除するプロセスを実行しているときに発生します。

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

Visual Basic (宣言)

Public Event WebPartClosing As
 WebPartCancelEventHandler

Visual Basic (使用法)

Dim instance As WebPartManager
Dim handler As WebPartCancelEventHandler

AddHandler instance.WebPartClosing, handler

C#

public event WebPartCancelEventHandler WebPartClosing

C++

public:
event WebPartCancelEventHandler^ WebPartClosing {
    void add (WebPartCancelEventHandler^ value);
    void remove (WebPartCancelEventHandler^ value);
}

J#

/** @event */
public void add_WebPartClosing (WebPartCancelEventHandler
 value)

/** @event */
public void remove_WebPartClosing (WebPartCancelEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

WebPartClosing イベントは、WebPartManager コントロールがコントロールを終了するプロセスを実行しているときに、OnWebPartClosing メソッドによって発生します。コントロールの削除が正常に完了すると、このイベントに続いて WebPartClosed イベントが発生します。

ページの開発者は、ページの <asp:webpartmanager> 要素に OnWebPartClosed 属性を追加し、その属性にカスタム メソッド名を割り当てることにより、イベントのカスタム ハンドラを用意できます。

通常、ユーザーが WebPart コントロールを閉じる操作の直接の結果として WebPartClosing イベントが発生した場合、このイベントをキャンセルできます。しかし、イベントをキャンセルできない場合もあります。WebPartZone コントロールが削除された場合、それに含まれる WebPart コントロールはすべて閉じる必要があります。そうしないと、それらは孤立することになります。この場合、ユーザーではなく WebPartManager コントロールが WebPart コントロールを閉じます。WebPartManager コントロールが、各コントロールを閉じるために CloseWebPart メソッドを呼び出す処理中で、WebPartClosing イベントが発生した場合は、そのイベントは (仕様上) キャンセルできません。これは、WebPartManager がすべてのゾーンのコントロールをクリーンアップするタスクを完了する必要があるためです。

プラットフォーム

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 名前空間
OnWebPartClosing
WebPartManager.WebPartClosed イベント
CloseWebPart
その他の技術情報
ASP.NET Web パーツ ページ