EditorPart.ApplyChanges メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

EditorPart.ApplyChanges メソッド

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

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

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

Visual Basic (宣言)

Public MustOverride Function
 ApplyChanges As Boolean

Visual Basic (使用法)

Dim instance As EditorPart
Dim returnValue As Boolean

returnValue = instance.ApplyChanges

public abstract bool ApplyChanges ()

C++

public:
virtual bool ApplyChanges () abstract

public abstract boolean ApplyChanges ()

JScript

public abstract function ApplyChanges () :
 boolean

戻り値
EditorPart コントロールから WebPart コントロールへの値の保存アクションに成功した場合は true。それ以外の場合 (エラーが発生した場合) は false。

解説

ApplyChanges メソッドは、EditorPart コントロールの重要なメソッドです。これは、EditorPart クラスで抽象メソッドとして定義されており、継承コントロールによって実装される必要があります。メソッドの目的は、ユーザーが EditorPart コントロールに入力した値を、WebPartToEdit プロパティで参照される WebPart コントロールの対応するプロパティに保存することです。

ApplyChanges メソッドは、編集中のユーザーインターフェイス (UI) でユーザーが OK 動詞または apply 動詞を表すボタンをクリックすると呼び出されます。

継承時の注意 EditorPart クラスから派生するクラスは、ApplyChanges メソッドを実装する必要があります。実装されたメソッドは、WebPartToEdit プロパティを使用して、関連付けられているコントロールへの参照を取得し、そのコントロールのプロパティを EditorPart コントロールの現在の値で更新します。

使用例

カスタム EditorPart コントロールで ApplyChanges メソッドを実装する方法を次のコード例に示します。例の実行に必要なコード全体については、EditorPart クラスの概要で「例」を参照してください。

コード例の最初の部分は、TextDisplayEditorPart という名前のカスタム EditorPart クラスでの ApplyChanges メソッドの実装を示します。このメソッドは、WebPartToEdit プロパティを使用して、関連付けられている TextDisplayWebPart コントロールへの参照を取得します。次に、TextDisplayWebPart.FontStyle プロパティの値を更新します。

Visual Basic

Public Overrides Function
 ApplyChanges() As Boolean
  Dim part As TextDisplayWebPart = CType(WebPartToEdit,
 _
                                         TextDisplayWebPart)
  ' Update the custom WebPart control with the font style.
  part.FontStyle = PartContentFontStyle.SelectedValue

  Return True

End Function

public override bool ApplyChanges()
{
  TextDisplayWebPart part = 
    (TextDisplayWebPart)WebPartToEdit;
  // Update the custom WebPart control with the font style.
  part.FontStyle = PartContentFontStyle.SelectedValue;

  return true;
}

コード例の 2 番目の部分は、関連付けられている WebPart コントロール TextDisplayWebPart が、関連付けられている EditorPart コントロールのコレクション (この場合、コレクションには TextDisplayEditorPart という名前の EditorPart コントロールが 1 つだけ含まれる) をその CreateEditorParts メソッドの実装に作成する方法を示します。このメソッドは、TextDisplayWebPart コントロールが編集モードになったときに実行されます。

Visual Basic

Public Overrides Function
 CreateEditorParts() _
                            As EditorPartCollection
  Dim editorArray As New
 ArrayList()
  Dim edPart as New TextDisplayEditorPart()
  edPart.ID = Me.ID & "_editorPart1"
  editorArray.Add(edPart)
  Dim editorParts As New
 EditorPartCollection(editorArray)
  Return editorParts

End Function

Public Overrides ReadOnly
 Property WebBrowsableObject() _
                                    As Object
  Get
    Return Me
  End Get
End Property

public override EditorPartCollection CreateEditorParts()
{
  ArrayList editorArray = new ArrayList();
  TextDisplayEditorPart edPart = new TextDisplayEditorPart();
  edPart.ID = this.ID + "_editorPart1";
  editorArray.Add(edPart);
  EditorPartCollection editorParts = 
    new EditorPartCollection(editorArray);
  return editorParts;
}

public override object WebBrowsableObject
{
  get { return this; }
}