EditorPart.ApplyChanges 方法

定義

命名空間:

System.Web.UI.WebControls.WebParts

組件:

System.Web.dll

將值從 EditorPart 控制項儲存至相關聯 WebPart 控制項中對應的屬性。

public:
 abstract bool ApplyChanges();

public abstract bool ApplyChanges ();

abstract member ApplyChanges : unit -> bool

Public MustOverride Function ApplyChanges () As Boolean

傳回

Boolean

如果將值從 EditorPart 控制項儲存至 WebPart 控制項的動作順利進行，則為 true，否則 (如果發生錯誤) 為 false。

範例

下列程式碼範例示範如何在自訂 EditorPart 控制項中實 ApplyChanges 作 方法。 如需執行範例所需的完整程式碼，請參閱類別概觀的 EditorPart 範例一節。

程式碼範例的第一個部分示範在名為 TextDisplayEditorPart 的自訂 EditorPart 類別中方法的 ApplyChanges 實作。 這個方法會使用 WebPartToEdit 屬性取得相關聯 TextDisplayWebPart 控制項的參考。 然後，它會更新 屬性的值 TextDisplayWebPart.FontStyle 。

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

  return true;
}

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

程式碼範例的第二個部分示範相關聯的 WebPart 控制項 TextDisplayWebPart 如何在此案例中建立相關聯的 EditorPart 控制項集合 (，在方法的實 CreateEditorParts 作中，集合中只有一個名為 EditorPart 的控制項 TextDisplayEditorPart) 。 當控制項進入編輯模式時 TextDisplayWebPart ，就會執行這個方法。

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; }
}

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

備註

方法 ApplyChanges 是控制項上 EditorPart 的重要方法。 它定義為 類別中的 EditorPart 抽象方法，而且必須由繼承的控制項實作。 方法的目的是將使用者已輸入的值儲存至 EditorPart 控制項中參考之 屬性中的 WebPartWebPartToEdit 對應屬性。

ApplyChanges當使用者按一下代表 OK 的按鈕，或在編輯使用者介面 (UI) 套用動詞時，就會呼叫 方法。

給實施者的注意事項

衍生自 類別的 EditorPart 類別必須實作 ApplyChanges() 方法。 實作的方法會使用 WebPartToEdit 屬性取得相關聯控制項的參考，然後使用 控制項中的 EditorPart 目前值來更新該控制項的屬性。

另請參閱

• SyncChanges()
• IWebEditable
• ASP.NET 網頁元件控制項