EditorPart.ApplyChanges Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Guarda los valores de un control EditorPart en las propiedades correspondientes del control WebPart asociado.
public:
abstract bool ApplyChanges();
public abstract bool ApplyChanges ();
abstract member ApplyChanges : unit -> bool
Public MustOverride Function ApplyChanges () As Boolean
Devoluciones
Es true
si la acción de guardar los valores del control EditorPart en el control WebPart se realiza correctamente; en caso contrario (si se produce un error), es false
.
Ejemplos
En el ejemplo de código siguiente se muestra cómo implementar el ApplyChanges método en un control personalizado EditorPart . Para obtener el código completo necesario para ejecutar el ejemplo, vea la sección Ejemplo de la información general de la EditorPart clase.
La primera parte del ejemplo de código muestra la implementación del ApplyChanges método en la clase personalizada EditorPart denominada TextDisplayEditorPart
. Este método obtiene una referencia al control asociado TextDisplayWebPart
mediante la WebPartToEdit propiedad . A continuación, actualiza el valor de la TextDisplayWebPart.FontStyle
propiedad .
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
La segunda parte del ejemplo de código muestra cómo el control asociado WebPart , TextDisplayWebPart
, crea una colección de controles asociados EditorPart (en este caso, solo hay un EditorPart control denominado TextDisplayEditorPart
en la colección) en su implementación del CreateEditorParts método . Este método se ejecuta cuando el TextDisplayWebPart
control entra en modo de edición.
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
Comentarios
El ApplyChanges método es un método crítico en un EditorPart control . Se define como un método abstracto en la EditorPart clase y debe implementarse mediante controles heredados. El propósito del método es guardar los valores que un usuario ha escrito en un EditorPart control en las propiedades correspondientes del WebPart control al que se hace referencia en la WebPartToEdit propiedad .
Se ApplyChanges llama al método cuando el usuario hace clic en un botón que representa un verbo Ok o apply en la interfaz de usuario (UI) de edición.
Notas a los implementadores
Una clase que deriva de la EditorPart clase debe implementar el ApplyChanges() método . El método implementado obtiene una referencia al control asociado mediante la WebPartToEdit propiedad y, a continuación, actualiza las propiedades de ese control con los valores actuales del EditorPart control.