← すべてのドキュメント

editor.clearHistory()

元に戻す（Undo）とやり直し（Redo）のスタックを両方とも空にします。文書のコンテンツはそのままで、消去されるのは記録された履歴だけです。プログラムで新しい文書を読み込んだ後に呼び出すと、ユーザーが元に戻す操作で、設定したばかりのコンテンツより前に戻ることはできなくなります。

構文

editor.clearHistory()

パラメーター

なし。

戻り値

なし（undefined）。

動作に関する注意

  • コンテンツには影響しません。履歴を消去しても削除されるのは元に戻す／やり直しの記録だけで、エディター内の内容はそのまま残ります。
  • ツールバーの状態が更新されます。スタックが空になった後、エディターは選択範囲の状態を再評価するため、ツールバーの「元に戻す」と「やり直し」のボタンは正しく無効の状態で表示されます。
  • プログラムによる読み込みと組み合わせます。setHTMLCode でコンテンツを設定すると、元に戻すためのエントリが追加されます。その直後に clearHistory() を呼び出すと、読み込んだ状態がまっさらな出発点になります。

使用例

文書を読み込み、ユーザーがそれより前に戻れない基準点にします。

var editor1 = new RichTextEditor("#div_editor1");
editor1.setHTMLCode(loadedDocumentHtml);
editor1.clearHistory();   // fresh start; Undo is now disabled

シングルページアプリで別のレコードに切り替えるときに、エディターをリセットします。

function openRecord(html) {
    editor1.setHTMLCode(html);
    editor1.clearHistory();
}

関連項目