Class Range

Range

טווח של רכיבים במסמך. הבחירה של המשתמש מיוצגת כ-Range, בין היתר. תסריטים יכולים לגשת רק לבחירה של המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט קשור למסמך.

// Bold all selected text.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  for (let i = 0; i < elements.length; i++) {
    const element = elements[i];

    // Only modify elements that can be edited as text; skip images and other
    // non-text elements.
    if (element.getElement().editAsText) {
      const text = element.getElement().editAsText();

      // Bold the selected part of the element, or the full element if it's
      // completely selected.
      if (element.isPartial()) {
        text.setBold(
            element.getStartOffset(),
            element.getEndOffsetInclusive(),
            true,
        );
      } else {
        text.setBold(true);
      }
    }
  }
}

Methods

שיטהסוג הערך המוחזרתיאור קצר
getRangeElements()RangeElement[]הפונקציה מקבלת את כל הרכיבים ב-Range הזה, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מאלמנט Text).
שיטהסוג הערך המוחזרתיאור קצר
getSelectedElements()RangeElement[]הפונקציה מקבלת את כל הרכיבים שהמשתמש בחר במופע הפתוח של המסמך, כולל רכיבי Text שנבחרו באופן חלקי.

מסמכים מפורטים

getRangeElements()

הפונקציה מקבלת את כל הרכיבים ב-Range הזה, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מאלמנט Text). כדי לקבוע אם רכיב Text נכלל בטווח באופן חלקי בלבד, אפשר לעיין במאמר RangeElement.isPartial().

חזרה

RangeElement[] – מערך של רכיבים, בסדר שבו הם מופיעים במסמך

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

שיטות שהוצאו משימוש

הוצא משימוש. השם השתנה ל-getRangeElements().

הפונקציה מקבלת את כל הרכיבים שהמשתמש בחר במופע הפתוח של המסמך, כולל רכיבי Text שנבחרו באופן חלקי.

חזרה

RangeElement[] – מערך של רכיבים שנבחרו או שנבחרו חלקית, לפי הסדר שבו הם מופיעים במסמך

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents