← すべてのドキュメント

editor.commitBookmark()

エディターの現在の元に戻すためのエントリを確定します。通常、短い間隔で続けて行った編集は 1 つの元に戻す単位にまとめられます。確定すると現在の単位が完了したものとして扱われ、次の変更は個別に元に戻せる新しいエントリから始まります。プログラムによる変更の前後で、元に戻す履歴にきれいな区切りを付けたい場合に使います。

構文

editor.commitBookmark()

パラメーター

なし。

戻り値

なし（undefined）。

動作に関する注意

  • 制御するのは元に戻す単位の細かさで、コンテンツではありません。確定しても文書は変わりません。次の編集を現在の元に戻す単位にまとめるか、新しい単位を始めるかを決めるだけです。
  • 既定では編集はまとめられます。確定しない場合、短い時間内（エディターの、元に戻す履歴に追加するまでのタイムアウト）に行われた変更は 1 つのエントリにまとめられます。確定すると、すぐに区切りが付けられます。
  • 元に戻す操作では自動的に確定されます。エディターは元に戻す操作を実行する前に保留中のブックマークを確定するので、通常の入力でこれが必要になることはほとんどありません。もっとも役立つのは、スクリプトによる編集の前後です。

使用例

プログラムによる変更を前後で区切り、それだけで 1 つの元に戻す単位にします。

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

複数の断片を、1 つにまとめずに、それぞれ別の元に戻す単位として挿入します。

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

関連項目