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()
محدوده عناصر مرتبط با این 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