כלי לבניית מודלים של Range
אובייקטים מרכיבי מסמכים.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addElement(element) | RangeBuilder | הוספה של Element שלמה אל RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | הוספת רכיב Text חלקי לRangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | מוסיף שני רכיבים שלמים ואת כל הרכיבים ביניהם ל-RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | מוסיף ל-RangeBuilder שני רכיבי Text חלקיים ואת כל הרכיבים ביניהם. |
addRange(range) | RangeBuilder | הוספת התוכן של Range אחר ל-RangeBuilder . |
build() | Range | הפונקציה יוצרת Range מההגדרות שהוחלו על הבונה. |
getRangeElements() | RangeElement[] | הפונקציה מקבלת את כל הרכיבים ב-Range , כולל רכיבי Text חלקיים (לדוגמה, במקרה
של בחירה שכוללת רק חלק מרכיב Text ). |
תיעוד מפורט
addElement(element)
הוספה של Element
שלמה אל RangeBuilder
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
element | Element | את הרכיב שיש להוסיף |
החזרות
RangeBuilder
– הכלי הזה ליצירת שרשורים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
הוספת רכיב Text
חלקי לRangeBuilder
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
textElement | Text | את רכיב הטקסט שצריך להוסיף באופן חלקי |
startOffset | Integer | מספר התווים לפני התו הראשון שיש לכלול (כלומר, האינדקס של התו הראשון בטווח) |
endOffsetInclusive | Integer | מספר התווים לפני התו האחרון שיש לכלול (כלומר, האינדקס של התו האחרון בטווח) |
החזרות
RangeBuilder
– הכלי הזה ליצירת שרשורים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
מוסיף שני רכיבים שלמים ואת כל הרכיבים ביניהם ל-RangeBuilder
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
startElement | Element | את הרכיב הראשון שצריך להוסיף |
endElementInclusive | Element | את הרכיב האחרון שצריך להוסיף |
החזרות
RangeBuilder
– הכלי הזה ליצירת שרשורים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
מוסיף ל-RangeBuilder
שני רכיבי Text
חלקיים ואת כל הרכיבים ביניהם.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
startTextElement | Text | את רכיב הטקסט הראשון שיתווסף חלקית |
startOffset | Integer | מספר התווים שיש לכלול לפני התו הראשון של startTextElement (כלומר, האינדקס של התו הראשון בטווח) |
endTextElementInclusive | Text | את רכיב הטקסט האחרון שיתווסף חלקית |
endOffsetInclusive | Integer | מספר התווים לפני התו האחרון של endTextElementInclusive שצריך לכלול (כלומר, האינדקס של התו האחרון
בטווח) |
החזרות
RangeBuilder
– הכלי הזה ליצירת שרשורים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addRange(range)
הוספת התוכן של Range
אחר ל-RangeBuilder
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
range | Range | הטווח שיש להוסיף את רכיביו |
החזרות
RangeBuilder
– הכלי הזה ליצירת שרשורים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
getRangeElements()
הפונקציה מקבלת את כל הרכיבים ב-Range
, כולל רכיבי Text
חלקיים (לדוגמה, במקרה
של בחירה שכוללת רק חלק מרכיב Text
). כדי לקבוע אם רכיב
Text
נכלל רק באופן חלקי בטווח, אפשר לעיין ב-RangeElement.isPartial()
.
החזרות
RangeElement[]
- מערך של רכיבים, לפי הסדר שבו הם מופיעים במסמך
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents