עוטף את Element עם אפשרות להזחת התחלה וסיום. ההיסטים האלה מאפשרים לייצג בתוצאות החיפוש, בבחירות של מסמכים ובטווחים עם שמות טווח של תווים בתוך רכיב Text.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
get | Element | הפונקציה מחזירה את ה-Element שמתאים ל-Range הזה. |
get | Integer | מקבל את המיקום של סוף הטווח החלקי בתוך רכיב הטווח. |
get | Integer | מחזירה את המיקום של תחילת טווח חלקי בתוך רכיב הטווח. |
is | 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