← Toute la documentation

editor.commitBookmark()

Finalise l’entrée d’annulation courante de l’éditeur. Normalement, des modifications consécutives faites à peu d’intervalle sont regroupées en une seule étape d’annulation ; valider marque l’étape courante comme terminée, si bien que la modification suivante commence une nouvelle entrée, annulable séparément. Utilisez-la pour tracer une frontière nette dans l’historique d’annulation autour d’une modification faite par programmation.

Syntaxe

editor.commitBookmark()

Paramètres

Aucun.

Valeur renvoyée

Rien (undefined).

Remarques sur le comportement

  • Elle contrôle la granularité de l’annulation, pas le contenu. La validation ne modifie pas le document ; elle décide seulement si la modification suivante se fond dans l’étape d’annulation courante ou en commence une nouvelle.
  • Les modifications sont regroupées par défaut. Sans validation, les modifications qui surviennent dans un court intervalle (le délai d’ajout à l’annulation de l’éditeur) sont regroupées en une seule entrée d’annulation — la validation impose immédiatement la frontière.
  • L’annulation valide automatiquement. L’éditeur valide le signet en attente avant d’effectuer une annulation : vous en avez donc rarement besoin pour la saisie normale — elle est surtout utile autour de modifications scriptées.

Exemple d’utilisation

Encadrer une modification faite par programmation pour qu’elle devienne sa propre étape d’annulation :

var editor1 = new RichTextEditor("#div_editor1");
editor1.commitBookmark();               // close whatever came before
editor1.setHTMLCode("<b>hello world</b>");
editor1.commitBookmark();               // this insert is now its own undo step

Insérer plusieurs fragments en étapes d’annulation séparées plutôt qu’en une seule étape fusionnée :

fragments.forEach(function (html) {
    editor1.insertHTML(html);
    editor1.commitBookmark();   // each fragment undoes independently
});

Voir aussi