Class RangeElement

רכיב של טווח

עטיפה של Element עם אפשרות להיסט התחלה וסיום. ההיסטים האלה מאפשרים לייצג טווח תווים בתוך רכיב Text בתוצאות חיפוש, בבחירות במסמכים ובטווחים עם שם.

Methods

שיטהסוג הערך המוחזרתיאור קצר
getElement()Elementהפונקציה מקבלת את הערך של Element שתואם ל-RangeElement הזה.
getEndOffsetInclusive()Integerהפונקציה מקבלת את המיקום של סוף טווח חלקי בתוך רכיב הטווח.
getStartOffset()Integerהפונקציה מקבלת את המיקום של תחילת טווח חלקי בתוך רכיב הטווח.
isPartial()Booleanקובע אם רכיב הטווח הזה מכסה את כל הרכיב או בחירה חלקית של התווים שלו.

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

getElement()

הפונקציה מקבלת את הערך של Element שתואם ל-RangeElement הזה. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// Log debug information about a range element.
Logger.log(`Element type: ${rangeElement.getElement().getType()}`);
if (rangeElement.isPartial()) {
  Logger.log(`The character range begins at ${rangeElement.getStartOffset()}`);
  Logger.log(
      `The character range ends at ${rangeElement.getEndOffsetInclusive()}`,
  );
} else {
  Logger.log('The entire range element is included.');
}

חזרה

Element – הרכיב שתואם ל-RangeElement הזה

אישור

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

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

getEndOffsetInclusive()

הפונקציה מקבלת את המיקום של סוף טווח חלקי בתוך רכיב הטווח. אם האלמנט הוא Text ו-isPartial() מחזיר true, ההיסט הוא מספר התווים לפני התו האחרון בטווח (כלומר, האינדקס של התו האחרון בטווח). בכל מקרה אחר, השיטה מחזירה את הערך -1.

חזרה

Integer – עבור רכיבי Text, מספר התו לפני התו האחרון בטווח. עבור רכיבים אחרים, -1

אישור

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

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

getStartOffset()

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

חזרה

Integer — עבור רכיבי Text, מספר התווים לפני תחילת הטווח. עבור רכיבים אחרים, -1

אישור

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

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

isPartial()

קובע אם רכיב הטווח הזה מכסה את כל הרכיב או מבחר חלקי של התווים שלו. אפשר לקבוע את ההתחלה והסיום של טווח של רכיב טווח חלקי באמצעות getStartOffset() ו-getEndOffsetInclusive(), בהתאמה.

חזרה

Boolean — true אם הרכיב נכלל באופן חלקי, false אם לא

אישור

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

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