Google Docs Apps Script：无法检查光标是否位于命名区域

我之前也碰到过这个问题——光标在命名区域里时，cursor.getElement()只会返回Text对象，没法直接关联到对应的命名区域。后来摸索出了一个可行的方法，核心思路是遍历所有命名区域，检查光标位置是否落在该区域的范围边界内，具体实现如下：

实现步骤与代码示例 #

首先，我们需要获取光标所在的元素和偏移量，然后逐个检查每个命名区域的范围是否包含这个位置。这里要考虑三种常见的情况：光标在命名区域的起始元素内、结束元素内，或者处于中间的元素中。

function checkCursorInNamedRange(targetRangeName = null) {
  const doc = DocumentApp.getActiveDocument();
  const cursor = doc.getCursor();
  
  // 先判断是否存在光标
  if (!cursor) {
    Logger.log("未检测到光标位置");
    return false;
  }
  
  const cursorElement = cursor.getElement();
  const cursorOffset = cursor.getOffset();
  
  // 获取目标命名区域：如果传入名称则只检查该区域，否则检查所有
  const namedRanges = targetRangeName 
    ? doc.getNamedRanges(targetRangeName) 
    : doc.getNamedRanges();
  
  // 遍历每个命名区域进行检查
  for (const namedRange of namedRanges) {
    const range = namedRange.getRange();
    const startElem = range.getStartElement();
    const endElem = range.getEndElement();
    const startOffset = range.getStartOffset();
    const endOffset = range.getEndOffsetInclusive();
    
    // 情况1：光标在命名区域的起始元素内，且偏移量不小于起始偏移
    if (cursorElement === startElem) {
      if (startElem === endElem) {
        // 命名区域是单个元素内的片段，需同时满足偏移量不大于结束偏移
        if (cursorOffset >= startOffset && cursorOffset <= endOffset) {
          Logger.log(`光标位于命名区域：${namedRange.getName()}`);
          return true;
        }
      } else {
        // 命名区域跨多个元素，只要在起始元素内且偏移达标就算在范围内
        if (cursorOffset >= startOffset) {
          Logger.log(`光标位于命名区域：${namedRange.getName()}`);
          return true;
        }
      }
    }
    
    // 情况2：光标在命名区域的结束元素内，且偏移量不大于结束偏移
    if (cursorElement === endElem && cursorOffset <= endOffset) {
      Logger.log(`光标位于命名区域：${namedRange.getName()}`);
      return true;
    }
    
    // 情况3：光标处于命名区域的中间元素（既不是起始也不是结束）
    // 通过父元素的位置判断顺序
    const cursorParentIndex = doc.getBody().getChildIndex(cursorElement.getParent());
    const startParentIndex = doc.getBody().getChildIndex(startElem.getParent());
    const endParentIndex = doc.getBody().getChildIndex(endElem.getParent());
    
    if (cursorParentIndex > startParentIndex && cursorParentIndex < endParentIndex) {
      Logger.log(`光标位于命名区域：${namedRange.getName()}`);
      return true;
    }
  }
  
  Logger.log("光标不在目标命名区域内");
  return false;
}

关键细节说明 #

1. 参数可选：函数支持传入targetRangeName参数，如果你只需要检查某个特定名称的命名区域，直接传入名称即可，无需遍历所有区域。
2. 多元素区域处理：当命名区域跨多个段落或元素时，通过比较父元素的索引位置，判断光标是否处于起始和结束元素之间的区域。
3. 边界判断：对于单个元素内的命名片段（比如某段文字中的一部分），需要同时检查偏移量的上下限，确保光标落在片段范围内。

扩展用法 #

如果需要返回所有包含光标的命名区域（比如存在重叠区域的情况），可以把返回值改成数组，在匹配时将命名区域对象或名称存入数组，最后返回数组即可。

内容的提问来源于stack exchange，提问作者DjH