Class NamedRange

به نام محدوده

Range ای که دارای نام و شناسه است تا امکان بازیابی بعدی را فراهم کند. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک برگه ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند. هنگامی که یک Named Range به یک برگه اضافه شد، نمی توان آن را تغییر داد، فقط حذف کرد.

یک Named Range توسط هر اسکریپتی که به برگه دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

// 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 شناسه این Named Range را دریافت می کند.
get Name() String نام این Named Range را می گیرد.
get Range() Range محدوده عناصر مرتبط با این Named Range را دریافت می کند.
remove() void این Named Range از برگه حذف می کند.

مستندات دقیق

get Id()

شناسه این Named Range را دریافت می کند. شناسه در برگه منحصر به فرد است.

بازگشت

String - شناسه محدوده، که در برگه منحصر به فرد است.

get Name()

نام این Named Range را می گیرد. نام لزوما منحصر به فرد نیست.

بازگشت

String - نام محدوده، که لزوما منحصر به فرد نیست.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Range()

محدوده عناصر مرتبط با این Named Range را دریافت می کند.

بازگشت

Range - محدوده عناصر مرتبط با نام و شناسه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove()

این Named Range از برگه حذف می کند. این روش محتویات محدوده را حذف نمی کند. این فقط مرجع را حذف می کند. فراخوانی این روش بر روی یک Named Range که قبلاً حذف شده است تأثیری ندارد.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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