Class RangeBuilder

RangeBuilder

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.

פרמטרים

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

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

פרמטרים

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

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