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

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

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

EditorPart.SyncChanges メソッド

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

WebPart コントロールから、それに関連付けられている EditorPart コントロール用に、プロパティ値を取得します。

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

Visual Basic (宣言)

Public MustOverride Sub
 SyncChanges

Visual Basic (使用法)

Dim instance As EditorPart

instance.SyncChanges

public abstract void SyncChanges ()

C++

public:
virtual void SyncChanges () abstract

public abstract void SyncChanges ()

JScript

public abstract function SyncChanges ()

解説

SyncChanges メソッドは、EditorPart コントロールの重要なメソッドです。これは、EditorPart クラスで抽象メソッドとして定義されており、継承コントロールによって実装される必要があります。メソッドの目的は、WebPartToEdit プロパティで参照される WebPart コントロールから現在の値を取得し、それらの値で EditorPart コントロールのフィールドを更新して、ユーザーが編集できるようにすることです。

SyncChanges メソッドは、関連付けられている WebPart コントロールの値が変更されるたびに呼び出されます。各 EditorPart コントロールでは、そのコントロールを含む EditorZoneBase ゾーンが、ApplyChanges メソッドの呼び出し直後に SyncChanges メソッドを呼び出します。これで、EditorPart コントロールの値は、関連付けられている WebPart コントロールの値と常に同期されます。また、SyncChanges メソッドは、WebPart コントロールが編集モードになるときにも呼び出されます。

メモ
ApplyChanges メソッドが false を返す場合はエラーが発生しているので、このメソッドの後に SyncChanges メソッドは呼び出されません。

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

使用例

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

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

Visual Basic

Public Overrides Sub SyncChanges()
  Dim part As TextDisplayWebPart = CType(WebPartToEdit,
 _
                                         TextDisplayWebPart)
  Dim currentStyle As String
 = part.FontStyle

  ' Select the current font style in the drop-down control.
  Dim item As ListItem
  For Each item In PartContentFontStyle.Items
    If item.Value = currentStyle Then
      item.Selected = True
      Exit For
    End If
  Next item

End Sub

public override void SyncChanges()
{
  TextDisplayWebPart part = 
    (TextDisplayWebPart)WebPartToEdit;
  String currentStyle = part.FontStyle;

  // Select the current font style in the drop-down control.
  foreach (ListItem item in PartContentFontStyle.Items)
  {
    if (item.Value == currentStyle)
    {
      item.Selected = true;
      break;
    }
  }
}

コード例の 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; }
}