Class NamedRange

NamedRange

Range עם שם ומזהה שמאפשרים אחזור מאוחר יותר. השמות אינם ייחודיות, כמה טווחים שונים באותה כרטיסייה עשויים להיות בעלי אותו שם, באופן דומה ב-HTML. לעומת זאת, מזהים הם ייחודיים בכרטיסייה, כמו מזהה ב-HTML. אחרי שמוסיפים NamedRange לכרטיסייה, לא ניתן לשנות אותו, אלא רק להסיר אותו.

אפשר לגשת אל NamedRange באמצעות כל סקריפט שניגשים לכרטיסייה. כדי להימנע מכך בניגוד לסקריפטים, מומלץ להוסיף מחרוזת ייחודית לשמות של טווחים. 

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

שיטות

שיטהסוג הערך המוחזרתיאור קצר
getId()Stringמקבל את המזהה של NamedRange.
getName()Stringמקבל את השם של ה-NamedRange הזה.
getRange()Rangeהפונקציה מקבלת את טווח הרכיבים שמשויכים אל NamedRange הזה.
remove()voidהסרה של NamedRange מהכרטיסייה.

מסמכי תיעוד מפורטים

getId()

מקבל את המזהה של NamedRange. המזהה ייחודי בכרטיסייה.

חזרה

String – המזהה של הטווח, שהוא ייחודי בכרטיסייה.

getName()

מקבל את השם של ה-NamedRange הזה. השם אינו בהכרח ייחודי.

חזרה

String – שם הטווח, שהוא לא בהכרח ייחודי.

אישור

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

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

getRange()

הפונקציה מקבלת את טווח הרכיבים שמשויכים אל NamedRange הזה.

חזרה

Range – טווח הרכיבים שמשויכים לשם ולמזהה.

אישור

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

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

remove()

הסרה של NamedRange מהכרטיסייה. השיטה הזו לא מוחקת את התוכן של טווח; היא רק מסירה את ההפניה. התקשרות לשיטה הזו ב-NamedRange כבר הוסר אין השפעה.

אישור

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

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