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