Range
שיש לו שם ומזהה שמאפשרים אחזור מאוחר יותר. השמות לא צריכים להיות ייחודיים בהכרח. ייתכן שמספר טווחים שונים באותו מסמך יחלקו את אותו שם, בדומה למחלקה ב-HTML. לעומת זאת, המזהים הם ייחודיים בתוך המסמך, כמו מזהה ב-HTML. אחרי שמוסיפים NamedRange
למסמך, אי אפשר לשנות אותו אלא רק להסיר אותו.
ניתן לגשת ל-NamedRange
באמצעות כל סקריפט שניגש למסמך. כדי למנוע התנגשויות לא מכוונות בין סקריפטים, מומלץ להוסיף מחרוזת ייחודית לשמות של טווחים.
// Create a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.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()
remove()
פעולה זו תסיר את NamedRange
מהמסמך. השיטה הזו לא מוחקת את התוכן של הטווח, אלא רק מסירה את ההפניה. אין השפעה על הקריאה לשיטה הזו
ב-NamedRange
שכבר הוסר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents