Class NamedRange

NamedRange

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

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

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 מהכרטיסייה. השיטה הזו לא מוחקת את התוכן של הטווח, אלא רק מסירה את ההפניה. להפעלת ה-method הזו ב-NamedRange שכבר הוסר אין השפעה.

אישור

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

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