wrapper במסגרת Element
עם היסט אפשרי להתחלה ולסיום. ההיסטים האלה מאפשרים
טווח של תווים בתוך Text
שמיוצג בתוצאות חיפוש, בבחירות מסמכים ובטווחי תאים בעלי שם.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getElement() | Element | הפונקציה מקבלת את ה-Element שתואם ל-RangeElement הזה. |
getEndOffsetInclusive() | Integer | הפונקציה מקבלת את המיקום של סוף טווח חלקי בתוך רכיב הטווח. |
getStartOffset() | Integer | הפונקציה מקבלת את המיקום של ההתחלה של טווח חלקי בתוך רכיב הטווח. |
isPartial() | Boolean | קובע אם רכיב הטווח הזה מכסה את כל הרכיב או בחירה חלקית של של הרכיב. |
מסמכי תיעוד מפורטים
getElement()
הפונקציה מקבלת את ה-Element
שתואם ל-RangeElement
הזה.
// 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