Class NamedRange

محدوده نامگذاری شده

ایجاد، دسترسی و تغییر محدوده‌های نامگذاری‌شده در یک صفحه‌گسترده. محدوده‌های نامگذاری‌شده، محدوده‌هایی هستند که دارای نام‌های مستعار رشته‌ای مرتبط هستند. آن‌ها را می‌توان از طریق رابط کاربری Sheets در منوی Data > Named ranges... مشاهده و ویرایش کرد.

روش‌ها

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

مستندات دقیق

getName()

نام این محدوده‌ی نامگذاری شده را دریافت می‌کند.

بازگشت

String - نام این محدوده نامگذاری شده

مجوز

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

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

---

getRange()

محدوده‌ای که توسط این محدوده‌ی نامگذاری شده ارجاع داده می‌شود را برمی‌گرداند.

بازگشت

Range - محدوده صفحه‌گسترده که با این محدوده نامگذاری شده مرتبط است

مجوز

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

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

---

remove()

این محدوده نامگذاری شده را حذف می‌کند.

// The code below deletes all the named ranges in the spreadsheet.
const namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (let i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

مجوز

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

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

---

setName(name)

نام محدوده‌ی نامگذاری شده را تنظیم/به‌روزرسانی می‌کند.

// The code below updates the name for the first named range.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName('UpdatedNamedRange');
}

پارامترها

نام	نوع	توضیحات
name	String	نام جدید محدوده‌ی نامگذاری شده.

بازگشت

NamedRange - محدوده‌ای که نام آن توسط فراخوانی تعیین شده است

مجوز

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

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

---

setRange(range)

محدوده‌ی این محدوده‌ی نامگذاری شده را تنظیم/به‌روزرسانی می‌کند.

پارامترها

نام	نوع	توضیحات
range	Range	محدوده‌ی صفحه‌گسترده که قرار است به این محدوده‌ی نامگذاری‌شده مرتبط شود.

بازگشت

NamedRange - محدوده نامگذاری شده‌ای که محدوده صفحه گسترده برای آن تنظیم شده است.

مجوز

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

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