DIV CSS 佈局教程網

TextRange 物件用法整理:文字選取與搜尋的底層操作
編輯:關於JavaScript     

TextRange 是早期 IE 提供的動態 HTML 特性,讓你能以「字元」為單位隨意框選文件中的文字,而不受限於瀏覽器原生的選取行為。它可以拿來做即時搜尋、光標定位、特定字串反白等效果。以下整理其屬性、方法與典型用法。

它解決什麼問題

瀏覽器原生的選取(selection)是以「使用者用滑鼠刷過的範圍」為單位,程式很難精準控制。TextRange 則把「一段文字」抽象成有明確起點與終點的物件,你可以用字元計數的方式移動這兩個端點,再將結果套用成選取。一句話概括:它是文件文字流上的可程式化選取框。

常用屬性

text
讀寫範圍內包含的文字內容。設定它會直接改寫文件裡的文字。
htmlText
讀取範圍內包含標籤的 HTML 片段。
boundingHeight / boundingWidth
包圍整個範圍的矩形高度與寬度。
offsetLeft / offsetTop
範圍左上角相對於定位父元素的座標。

常用方法

createTextRange()
建立 Range 物件。BODY、TEXTAREA、INPUT、BUTTON 等元素都支援。
move(unit, count)
把範圍收縮成一個插入點,再依 unit(character/word/sentence/textedit)位移 count 個單位。正數往前、負數往後。
moveStart(unit, count) / moveEnd(unit, count)
只移動起點或終點,範圍大小因此改變。這兩個才是「選取一段文字」的主力。
collapse(boolean)
把範圍收縮成插入點。參數為 true 時落在起點,false 時落在終點。
select()
把目前範圍套用成頁面上的實際選取(可視為「把光標放在這裡」或「反白這段」)。
findText(str, scope, flags)
在範圍內搜尋字串。找到時範圍會收縮到該字串並回傳 true。
parentElement()
回傳包含此範圍的 DOM 元素,可藉此知道選取落在哪個標籤裡。

基本三步驟

  1. 建立 Range:const rng = input.createTextRange();
  2. 設定起訖點:用 moveStart / moveEnd 決定要框住哪一段
  3. 對範圍操作:select() 反白、findText() 搜尋、text 讀寫內容

範例一:把光標移到指定字元位置

<input type="text" id="txtTest" size="60"
       value="明·羅貫中《三國演義》第二十一回:夫英雄者,胸懷大志,腹有良謀。">
<br>
移動光標到第 <input type="text" id="txtNum" size="4"> 個位置
<input type="button" value="移動" onclick="moveCursor()">

<script>
function moveCursor() {
  const pos = Number(document.getElementById('txtNum').value);
  if (Number.isNaN(pos)) { alert('請輸入一個數字'); return; }

  const rng = document.getElementById('txtTest').createTextRange();
  rng.move('character', pos);   // 先收縮成插入點再位移
  rng.select();                 // 套用為選取(此時起訖重合,看起來就是光標)
}
</script>

「光標」在 TextRange 的模型裡其實就是起點與終點重合的範圍,這點理解之後很多事情就通了。

範例二:反白除了首尾字元以外的整段

function selectInner() {
  const box = document.getElementById('txtBox');
  const rng = box.createTextRange();
  rng.moveStart('character', 1);   // 起點往前一格
  rng.moveEnd('character', -1);    // 終點往後一格
  rng.select();
}

預設情況下範圍起點在容器第一個字元、終點在最後一個字元之後,所以各移動一格就能去掉首尾。

範例三:逐個搜尋並反白(findText)

const box = document.getElementById('txtBox');
const rng = box.createTextRange();

function findNext(str) {
  if (!str) return;

  if (rng.findText(str)) {
    rng.select();          // 反白找到的內容
    rng.collapse(false);   // 把起點移到這次的終點,下次才能繼續往後找
  } else {
    alert('搜尋完畢');
    rng = box.createTextRange();   // 重置,否則永遠搜不到
  }
}

這段有兩個關鍵:每次找到後要 collapse(false),否則下一次搜尋會從同一個位置開始而永遠停在第一筆;搜到底要重設 range,否則範圍已被壓縮到尾端,再也找不到任何東西。

findText 的另外兩個參數:scope 指定搜尋的距離上限(負值代表往前搜),flags 用位元組合成設定行為——2 表示只匹配整個單字、4 表示區分大小寫,兩者並用則是 2 ^ 4 = 6。

範例四:找出選取所在的元素

function showContainer() {
  const rng = document.selection.createRange();
  alert(rng.parentElement().tagName);
}

現況提醒

TextRange 是微軟專屬的舊技術,在非 IE 瀏覽器中完全不存在,而且 IE 本身也已停止維護。新專案請改用標準的 Selection 與 Range API:

const selection = window.getSelection();
const range = document.createRange();

// 選取某元素全部內容
range.selectNodeContents(document.getElementById('target'));
selection.removeAllRanges();
selection.addRange(range);

// 搜尋則用 window.find(str) 或自行遍歷文字節點

標準 Range 用 setStart() / setEnd() 搭配 DOM 節點與偏移量來定位,概念與 TextRange 相似但更精確(能跨越元素邊界)。把這份筆記當成「文字範圍操作」的觀念入門即可,實際實作請走標準 API。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved