Class 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());

روش‌ها

روش نوع بازگشتی شرح مختصر
get Id() String شناسه (ID) این Named Range را دریافت می‌کند.
get Name() String نام این Named Range را دریافت می‌کند.
get Range() Range محدوده عناصر مرتبط با این Named Range را دریافت می‌کند.
remove() void این Named Range از برگه حذف می‌کند.

مستندات دقیق

getId()

شناسه (ID) این 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