EditorPart.ApplyChanges 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
將值從 EditorPart 控制項儲存至相關聯 WebPart 控制項中對應的屬性。
public:
abstract bool ApplyChanges();
public abstract bool ApplyChanges ();
abstract member ApplyChanges : unit -> bool
Public MustOverride Function ApplyChanges () As 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 目前值來更新該控件的屬性。