← すべてのドキュメント

editor.getSelection()

エディターの実際の選択範囲オブジェクトを返します。外側のページの window.getSelection() ではなく、編集領域内の選択範囲です。何が選択されているかを調べたり、範囲を読み取ったり、カスタムコマンドで低レベルの選択処理を行ったりするときに使います。

構文

editor.getSelection()

パラメーター

なし。

戻り値

エディターの選択範囲オブジェクト。

動作に関する注意

  • 編集用の iframe に限定されます。これはエディターのコンテンツ内の選択範囲なので、その範囲は周囲のページではなく、editor.getDocument()内のノードを指します。
  • 実際の選択範囲です。必要になったその時点で読み取ってください。キャレットや強調表示が現在どこにあっても、それを反映します。
  • よくある用途には、より高レベルのヘルパーがあります。選択範囲を自分でたどる代わりに、テキストには getSelectedText() を、それを囲む要素には getSelectionElement() を使ってください。

使用例

何かが選択されているかどうかを確認します。

var editor1 = new RichTextEditor("#div_editor1");
var sel = editor1.getSelection();
if (sel && !sel.isCollapsed) {
    // there is a highlighted range to act on
}

選択範囲から現在の範囲を読み取ります。

var sel = editor1.getSelection();
if (sel && sel.rangeCount) {
    var range = sel.getRangeAt(0);
    console.log(range.toString());
}

関連項目