Builder שמשמש לבניית אובייקטים של Range
מרכיבי מסמכים.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var rangeBuilder = documentTab.newRange(); var tables = documentTab.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 מההגדרות שהוחלו על ה-builder. |
getRangeElements() | RangeElement[] | מקבל את כל הרכיבים ב-Range , כולל רכיבי Text חלקיים (לדוגמה, במקרה
של בחירה שכוללת רק חלק מרכיב Text ). |
מסמכי תיעוד מפורטים
addElement(element)
הוספה של Element
שלם אל RangeBuilder
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
element | Element | הרכיב שרוצים להוסיף |
חזרה
RangeBuilder
– ה-builder הזה, לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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
– ה-builder הזה, ליצירת שרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
הפונקציה מוסיפה שני רכיבים שלמים ואת כל הרכיבים שביניהם לRangeBuilder
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
startElement | Element | את הרכיב הראשון להוספה |
endElementInclusive | Element | הרכיב האחרון שצריך להוסיף |
חזרה
RangeBuilder
– ה-builder הזה, ליצירת שרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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
– ה-builder הזה, לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addRange(range)
הוספת התוכן של Range
אחר ל-RangeBuilder
הזה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
range | Range | הטווח שצריך להוסיף לו את הרכיבים |
חזרה
RangeBuilder
– ה-builder הזה, לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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