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