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 "Пример" обзора класса.
Первая часть примера кода демонстрирует реализацию ApplyChanges метода в пользовательском EditorPart классе с именем 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 элемент управления TextDisplayWebPartсоздает коллекцию связанных EditorPart элементов управления (в данном случае в коллекции существует только один EditorPart элемент управления, именованный TextDisplayEditorPart в коллекции) в реализации CreateEditorParts метода. Этот метод выполняется при входе 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 вызывается, когда пользователь нажимает кнопку, представляющую ОК или применить команду в пользовательском интерфейсе редактирования.
Примечания для тех, кто реализует этот метод
Класс, производный от EditorPart класса, должен реализовать ApplyChanges() метод. Реализованный метод получает ссылку на связанный элемент управления с помощью WebPartToEdit свойства, а затем обновляет свойства этого элемента управления с текущими значениями в элементе EditorPart управления.