Class RangeBuilder

RangeBuilder

כלי ליצירת אובייקטים של Range מרכיבי מסמך.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
addElement(element)	RangeBuilder	הוספת Element שלם לRangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)	RangeBuilder	מוסיף רכיב Text חלקי לרכיב RangeBuilder הזה.
addElementsBetween(startElement, endElementInclusive)	RangeBuilder	הפונקציה מוסיפה שני רכיבים שלמים, וגם את כל הרכיבים שביניהם, ל-RangeBuilder הזה.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)	RangeBuilder	מוסיף שני רכיבי Text חלקיים, ואת כל הרכיבים שביניהם, אל RangeBuilder.
addRange(range)	RangeBuilder	הוספת התוכן של Range אחר ל-RangeBuilder הזה.
build()	Range	יוצר Range מההגדרות שחלות על ה-builder.
getRangeElements()	RangeElement[]	מחזירה את כל הרכיבים ב-Range, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מרכיב Text).

שיטות שהוצאו משימוש

שיטה	סוג הערך שמוחזר	תיאור קצר
getSelectedElements()	RangeElement[]	מחזירה את כל הרכיבים שהמשתמש בחר במופע הפתוח של המסמך, כולל רכיבי 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)

מוסיף שני רכיבי Text חלקיים, ואת כל הרכיבים שביניהם, אל RangeBuilder.

פרמטרים

שם	סוג	תיאור
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()

יוצר Range מההגדרות שחלות על ה-builder.

חזרה

‫Range — הטווח החדש שנבנה

---

getRangeElements()

מחזירה את כל הרכיבים ב-Range, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מרכיב Text). כדי לקבוע אם רכיב Text נכלל רק באופן חלקי בטווח, אפשר לעיין בRangeElement.isPartial().

חזרה

‫RangeElement[] – מערך של רכיבים, בסדר שבו הם מופיעים במסמך

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

שיטות שהוצאו משימוש

getSelectedElements()

הוצא משימוש. השם החדש הוא getRangeElements().

מחזירה את כל הרכיבים שהמשתמש בחר במופע הפתוח של המסמך, כולל רכיבי Text שנבחרו באופן חלקי.

חזרה

‫RangeElement[] — מערך של רכיבים שנבחרו או שנבחרו באופן חלקי, לפי הסדר שבו הם מופיעים במסמך

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents