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).

תיעוד מפורט

addElement(element)

הוספת Element שלם לRangeBuilder.

פרמטרים

שםסוגתיאור
elementElementהאלמנט שרוצים להוסיף

חזרה

‫RangeBuilder – ה-builder הזה, לשרשור

אישור

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

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

addElement(textElement, startOffset, endOffsetInclusive)

מוסיף רכיב Text חלקי לרכיב RangeBuilder הזה.

פרמטרים

שםסוגתיאור
textElementTextרכיב הטקסט שיוסף באופן חלקי
startOffsetIntegerמספר התווים שלפני התו הראשון שייכלל (כלומר, האינדקס של התו הראשון בטווח)
endOffsetInclusiveIntegerמספר התווים לפני התו האחרון שייכלל (כלומר, האינדקס של התו האחרון בטווח)

חזרה

‫RangeBuilder – ה-builder הזה, לשרשור

אישור

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

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

addElementsBetween(startElement, endElementInclusive)

הפונקציה מוסיפה שני רכיבים שלמים, וגם את כל הרכיבים שביניהם, ל-RangeBuilder הזה.

פרמטרים

שםסוגתיאור
startElementElementהרכיב הראשון שיוסף
endElementInclusiveElementהרכיב האחרון שנוסף

חזרה

‫RangeBuilder – ה-builder הזה, לשרשור

אישור

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

פרמטרים

שםסוגתיאור
startTextElementTextרכיב הטקסט הראשון שנוסף באופן חלקי
startOffsetIntegerמספר התווים שלפני התו הראשון של startTextElement שייכללו (כלומר, האינדקס של התו הראשון בטווח)
endTextElementInclusiveTextרכיב הטקסט האחרון שנוסף באופן חלקי
endOffsetInclusiveIntegerמספר התווים לפני התו האחרון של endTextElementInclusive שייכללו (כלומר, האינדקס של התו האחרון בטווח)

חזרה

‫RangeBuilder – ה-builder הזה, לשרשור

אישור

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

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

addRange(range)

הוספת התוכן של Range אחר ל-RangeBuilder הזה.

פרמטרים

שםסוגתיאור
rangeRangeהטווח שהאלמנטים שלו צריכים להתווסף

חזרה

‫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

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