EditorPart.ApplyChanges Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Сохраняет значения в элементе управления EditorPart в соответствующие свойства связанного элемента управления WebPart.
public:
abstract bool ApplyChanges();
public abstract bool ApplyChanges ();
abstract member ApplyChanges : unit -> bool
Public MustOverride Function ApplyChanges () As Boolean
Возвращаемое значение
Значение true
, если процесс сохранения значений из элемента управления EditorPart в элемент управления WebPart выполнен успешно; в противном случае (если происходит ошибка) — значение false
.
Примеры
В следующем примере кода показано, как реализовать ApplyChanges метод в пользовательском EditorPart элементе управления. Полный код, необходимый для выполнения примера, см. в разделе EditorPart Пример обзора класса.
В первой части примера кода демонстрируется реализация метода в пользовательском ApplyChangesEditorPart классе с именем TextDisplayEditorPart
. Этот метод получает ссылку на связанный TextDisplayWebPart
элемент управления с помощью WebPartToEdit свойства . Затем обновляется значение 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 элемент управления , создает коллекцию связанных EditorPart элементов управления (в данном случае в коллекции есть только один EditorPart элемент управления с именемTextDisplayEditorPart
) в своей реализации CreateEditorParts метода . TextDisplayWebPart
Этот метод выполняется, когда 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 управления, в соответствующих свойствах элемента WebPart управления, на который ссылается свойство WebPartToEdit .
Метод ApplyChanges вызывается, когда пользователь нажимает кнопку, представляющую ОК или команду apply в пользовательском интерфейсе редактирования.
Примечания для тех, кто реализует этот метод
Класс, производный от класса , EditorPart должен реализовывать ApplyChanges() метод . Реализованный метод получает ссылку на связанный элемент управления с помощью WebPartToEdit свойства , а затем обновляет свойства этого элемента управления текущими значениями в элементе EditorPart управления .