PropertyGridEditorPart.ApplyChanges メソッド

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

PropertyGridEditorPart.ApplyChanges メソッド

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

PropertyGridEditorPart コントロールの値を、関連付けられた WebPart コントロールの対応するプロパティに保存します。

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

Visual Basic (宣言)

Public Overrides Function
 ApplyChanges As Boolean

Visual Basic (使用法)

Dim instance As PropertyGridEditorPart
Dim returnValue As Boolean

returnValue = instance.ApplyChanges

C#

public override bool ApplyChanges ()

C++

public:
virtual bool ApplyChanges () override

J#

public boolean ApplyChanges ()

JScript

public override function ApplyChanges () :
 boolean

戻り値
PropertyGridEditorPart の値を WebPart に正常に保存できた場合は true。それ以外の場合 (エラーが発生した場合) は false。

例外

例外の種類	条件
Exception	関連付けられた WebPart のプロパティ値を設定しようとしたときにエラーが発生しました。

解説

ApplyChanges メソッドは、PropertyGridEditorPart コントロールの重要なメソッドです。このメソッドは、ユーザーが PropertyGridEditorPart コントロールに設定した値を、関連付けられた WebPart コントロールの対応するプロパティに保存します。関連付けられたコントロールは、PropertyGridEditorPart コントロールの継承された WebPartToEdit プロパティで参照されます。

重要 :
PropertyGridEditorPart 型は継承されないようにシールされているため、ApplyChanges メソッドはオーバーライドできません。ただし、各種の WebPart コントロールのプロパティ編集処理を、PropertyGridEditorPart コントロールに用意されている機能よりも詳細にプログラムによって制御する必要がある場合は、カスタムの EditorPart コントロールを作成し、このメソッドの独自の実装を提供できます。コード例については、ApplyChanges メソッドのトピックを参照してください。

ApplyChanges メソッドは、関連付けられた WebPart コントロールの各パブリック カスタム プロパティに [WebBrowsable(true)] 属性が指定されている場合に、これらのプロパティの値を設定しようとします。

編集ユーザー インターフェイス (UI) で、ユーザーが OK や適用の動詞を表すボタンをクリックすると、ApplyChanges メソッドが呼び出されます。ユーザーの操作に関係なく編集された値を保存する必要がある場合は、独自のコードから直接このメソッドを呼び出すこともできます。

プラットフォーム

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

参照

関連項目
PropertyGridEditorPart クラス
PropertyGridEditorPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
ApplyChanges
SyncChanges
その他の技術情報
ASP.NET Web パーツ ページ