דף זה תורגם על ידי Cloud Translation API.

Class 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