EditorPart.ApplyChanges Méthode

Définition

Enregistre les valeurs d'un contrôle EditorPart dans les propriétés correspondantes du contrôle WebPart associé.

public:
 abstract bool ApplyChanges();
public abstract bool ApplyChanges ();
abstract member ApplyChanges : unit -> bool
Public MustOverride Function ApplyChanges () As Boolean

Retours

true si l'enregistrement des valeurs issues du contrôle EditorPart dans le contrôle WebPart est réussi ; sinon, (si une erreur se produit), false.

Exemples

L’exemple de code suivant montre comment implémenter la ApplyChanges méthode dans un contrôle personnalisé EditorPart . Pour obtenir le code complet requis pour exécuter l’exemple, consultez la section Exemple de la vue d’ensemble de la EditorPart classe.

La première partie de l’exemple de code illustre l’implémentation de la ApplyChanges méthode dans la classe personnalisée EditorPart nommée TextDisplayEditorPart. Cette méthode obtient une référence au contrôle associé à TextDisplayWebPart l’aide de la WebPartToEdit propriété . Il met ensuite à jour la valeur de la TextDisplayWebPart.FontStyle propriété .

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 deuxième partie de l’exemple de code montre comment le contrôle associé WebPart , TextDisplayWebPart, crée une collection de contrôles associés EditorPart (dans ce cas, il n’y a qu’un EditorPart seul contrôle nommé TextDisplayEditorPart dans la collection) dans son implémentation de la CreateEditorParts méthode. Cette méthode est exécutée lorsque le TextDisplayWebPart contrôle passe en mode édition.

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

Remarques

La ApplyChanges méthode est une méthode critique sur un EditorPart contrôle. Elle est définie comme une méthode abstraite dans la EditorPart classe et doit être implémentée par des contrôles hérités. L’objectif de la méthode est d’enregistrer les valeurs qu’un utilisateur a entrées dans un EditorPart contrôle dans les propriétés correspondantes dans le WebPart contrôle référencé dans la WebPartToEdit propriété .

La ApplyChanges méthode est appelée lorsque l’utilisateur clique sur un bouton représentant un verbe OK ou appliquer dans l’interface utilisateur d’édition.

Notes pour les responsables de l’implémentation

Une classe qui dérive de la EditorPart classe doit implémenter la ApplyChanges() méthode . La méthode implémentée obtient une référence au contrôle associé à l’aide de la WebPartToEdit propriété , puis met à jour les propriétés de ce contrôle avec les valeurs actuelles du EditorPart contrôle.

S’applique à

Voir aussi