Class RangeList

فهرست محدوده

مجموعه‌ای از یک یا چند نمونه Range در یک برگه. می‌توانید از این کلاس برای اعمال عملیات روی مجموعه‌ای از محدوده‌ها یا سلول‌های غیرمجاور استفاده کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
activate() Range List لیست نمونه‌های Range را انتخاب می‌کند.
break Apart() Range List تمام سلول‌های ادغام‌شده افقی یا عمودی موجود در لیست محدوده را دوباره به سلول‌های مجزا تقسیم کنید.
check() Range List وضعیت کادرهای انتخاب در محدوده را به «علامت‌گذاری‌شده» تغییر می‌دهد.
clear() Range List محدوده‌ی محتوا، قالب‌ها و قوانین اعتبارسنجی داده‌ها را برای هر Range در لیست محدوده پاک می‌کند.
clear(options) Range List محدوده‌ی محتوا، قالب، قوانین اعتبارسنجی داده‌ها و نظرات را، همانطور که با گزینه‌های داده شده مشخص شده است، پاک می‌کند.
clear Content() Range List محتوای هر Range (Range) را در لیست محدوده‌ها پاک می‌کند، بدون اینکه قالب‌بندی آن دست نخورده باقی بماند.
clear Data Validations() Range List قوانین اعتبارسنجی داده‌ها را برای هر Range در لیست محدوده‌ها پاک می‌کند.
clear Format() Range List قالب‌بندی متن را برای هر Range در لیست محدوده پاک می‌کند.
clear Note() Range List یادداشت مربوط به هر Range در لیست محدوده‌ها را پاک می‌کند.
get Ranges() Range[] لیستی از یک یا چند نمونه Range را در همان برگه برمی‌گرداند.
insert Checkboxes() Range List کادرهای انتخاب را در هر سلول در محدوده درج می‌کند، که با true برای علامت‌گذاری شده و false برای علامت‌گذاری نشده پیکربندی شده است.
insert Checkboxes(checkedValue) Range List کادرهای انتخاب را در هر سلول در محدوده وارد می‌کند، که با یک مقدار سفارشی برای علامت‌گذاری شده و یک رشته خالی برای علامت‌گذاری نشده پیکربندی شده است.
insert Checkboxes(checkedValue, uncheckedValue) Range List کادرهای انتخاب را در هر سلول در محدوده وارد می‌کند، که با مقادیر سفارشی برای حالت‌های انتخاب‌شده و انتخاب‌نشده پیکربندی شده‌اند.
remove Checkboxes() Range List تمام کادرهای انتخاب را از محدوده حذف می‌کند.
set Background(color) Range List رنگ پس‌زمینه را برای هر Range در لیست محدوده‌ها تنظیم می‌کند.
set Background RGB(red, green, blue) Range List پس‌زمینه را با رنگ RGB داده شده تنظیم می‌کند.
set Border(top, left, bottom, right, vertical, horizontal) Range List ویژگی حاشیه را برای هر Range در لیست محدوده تنظیم می‌کند.
set Border(top, left, bottom, right, vertical, horizontal, color, style) Range List ویژگی حاشیه را با رنگ و/یا سبک برای هر Range در لیست محدوده تنظیم می‌کند.
set Font Color(color) Range List رنگ فونت را برای هر Range در لیست محدوده‌ها تنظیم می‌کند.
set Font Family(fontFamily) Range List خانواده فونت را برای هر Range در لیست محدوده تنظیم می‌کند.
set Font Line(fontLine) Range List سبک خط فونت را برای هر Range در لیست محدوده تنظیم می‌کند.
set Font Size(size) Range List اندازه فونت (بر حسب پوینت) را برای هر Range در لیست محدوده‌ها تنظیم می‌کند.
set Font Style(fontStyle) Range List سبک فونت را برای هر Range در لیست محدوده تنظیم کنید.
set Font Weight(fontWeight) Range List ضخامت فونت را برای هر Range در لیست محدوده تنظیم کنید.
set Formula(formula) Range List فرمول را برای هر Range در لیست محدوده‌ها به‌روزرسانی می‌کند.
set Formula R1C1(formula) Range List فرمول را برای هر Range در لیست محدوده‌ها به‌روزرسانی می‌کند.
set Horizontal Alignment(alignment) Range List تراز افقی را برای هر Range در لیست محدوده تنظیم کنید.
set Note(note) Range List متن یادداشت را برای هر Range در لیست محدوده تنظیم می‌کند.
set Number Format(numberFormat) Range List قالب عدد یا تاریخ را برای هر Range در لیست محدوده تنظیم می‌کند.
set Show Hyperlink(showHyperlink) Range List تعیین می‌کند که آیا هر Range در لیست محدوده باید لینک‌ها را نشان دهد یا خیر.
set Text Direction(direction) Range List جهت متن را برای سلول‌های هر Range در لیست محدوده تنظیم می‌کند.
set Text Rotation(degrees) Range List تنظیمات چرخش متن را برای سلول‌های هر Range در لیست محدوده تنظیم می‌کند.
set Value(value) Range List مقدار هر Range را در لیست محدوده‌ها تنظیم می‌کند.
set Vertical Alignment(alignment) Range List تراز عمودی را برای هر Range در لیست محدوده تنظیم کنید.
set Vertical Text(isVertical) Range List تنظیم می‌کند که آیا متن سلول‌های هر Range در لیست محدوده روی هم قرار گیرد یا خیر.
set Wrap(isWrapEnabled) Range List برای هر Range در لیست محدوده، نحوه‌ی قرارگیری متن را تنظیم کنید.
set Wrap Strategy(strategy) Range List استراتژی بسته‌بندی متن را برای هر Range در لیست محدوده تنظیم می‌کند.
trim Whitespace() Range List فضای خالی (مانند فاصله، تب یا خط جدید) را در هر سلول در این لیست محدوده حذف می‌کند.
uncheck() Range List وضعیت کادرهای انتخاب در محدوده را به «بدون علامت» تغییر می‌دهد.

مستندات دقیق

activate()

لیست نمونه‌های Range instances) را انتخاب می‌کند. آخرین محدوده در لیست به عنوان active range تنظیم می‌شود.

نکته: این روشی برای انتخاب چندگانه تعدادی محدوده فراهم می‌کند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

بازگشت

Range List — فهرست محدوده‌های فعال، برای زنجیره‌سازی.

مجوز

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

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

break Apart()

تمام سلول‌های ادغام‌شده افقی یا عمودی موجود در لیست محدوده را دوباره به سلول‌های مجزا تقسیم کنید.

فراخوانی این تابع در یک لیست محدوده معادل انتخاب مجموعه‌ای از محدوده‌ها و انتخاب گزینه‌ی منوی Format > Merge > Unmerge Sheets است.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

check()

وضعیت کادرهای انتخاب در محدوده را به «علامت‌گذاری‌شده» تغییر می‌دهد. سلول‌هایی از محدوده را که در حال حاضر حاوی مقدار پیکربندی‌شده‌ی علامت‌گذاری‌شده یا علامت‌گذاری‌نشده نیستند، نادیده می‌گیرد.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear()

محدوده‌ی محتوا، قالب‌ها و قوانین اعتبارسنجی داده‌ها را برای هر Range در لیست محدوده پاک می‌کند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear(options)

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

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

پارامترها

نام نوع توضیحات
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته‌ای را مطابق لیست زیر مشخص می‌کند.

پارامترهای پیشرفته

نام نوع توضیحات
comments Only Boolean آیا فقط نظرات پاک شوند؟
contents Only Boolean اینکه آیا فقط محتویات پاک شود یا خیر.
format Only Boolean آیا فقط قالب را پاک کنیم؛ توجه داشته باشید که پاک کردن قالب، قوانین اعتبارسنجی داده‌ها را نیز پاک می‌کند.
validations Only Boolean آیا فقط قوانین اعتبارسنجی داده‌ها پاک شوند؟
skip Filtered Rows Boolean آیا از پاک کردن ردیف‌های فیلتر شده جلوگیری شود؟

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear Content()

محتوای هر Range (Range) را در لیست محدوده‌ها پاک می‌کند، بدون اینکه قالب‌بندی آن دست نخورده باقی بماند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear Data Validations()

قوانین اعتبارسنجی داده‌ها را برای هر Range در لیست محدوده‌ها پاک می‌کند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear Format()

قالب‌بندی متن را برای هر Range در لیست محدوده پاک می‌کند.

این کار قالب‌بندی متن را برای هر محدوده پاک می‌کند، اما هیچ یک از قوانین قالب‌بندی اعداد را بازنشانی نمی‌کند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

clear Note()

یادداشت مربوط به هر Range در لیست محدوده‌ها را پاک می‌کند.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

get Ranges()

لیستی از یک یا چند نمونه Range را در همان برگه برمی‌گرداند.

بازگشت

Range[] — فهرست محدوده‌ها.

مجوز

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

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

insert Checkboxes()

کادرهای انتخاب را در هر سلول در محدوده وارد می‌کند، که با true برای علامت‌گذاری شده و false برای علامت‌گذاری نشده پیکربندی شده است. مقدار همه سلول‌های محدوده را روی false تنظیم می‌کند. 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

insert Checkboxes(checkedValue)

کادرهای انتخاب را در هر سلول در محدوده وارد می‌کند، که با یک مقدار سفارشی برای علامت‌گذاری شده و یک رشته خالی برای علامت‌گذاری نشده پیکربندی شده است. مقدار هر سلول در محدوده را روی رشته خالی تنظیم می‌کند. 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

پارامترها

نام نوع توضیحات
checked Value Object مقدار بررسی‌شده برای اعتبارسنجی داده‌های کادر انتخاب.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

insert Checkboxes(checkedValue, uncheckedValue)

کادرهای انتخاب را در هر سلول در محدوده وارد می‌کند، که با مقادیر سفارشی برای حالت‌های علامت‌دار و علامت‌دار پیکربندی شده است. مقدار هر سلول در محدوده را روی مقدار علامت‌دار سفارشی تنظیم می‌کند. 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

پارامترها

نام نوع توضیحات
checked Value Object مقدار بررسی‌شده برای اعتبارسنجی داده‌های کادر انتخاب.
unchecked Value Object مقدار تیک نخورده برای اعتبارسنجی داده‌های کادر انتخاب.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

remove Checkboxes()

تمام کادرهای انتخاب را از محدوده حذف می‌کند. اعتبارسنجی داده‌های هر سلول را پاک می‌کند، و علاوه بر این، اگر سلول حاوی مقدار انتخاب شده یا انتخاب نشده باشد، مقدار آن را نیز پاک می‌کند. 

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Background(color)

رنگ پس‌زمینه را برای هر Range در لیست محدوده‌ها تنظیم می‌کند. رنگ در نمادگذاری CSS با نماد '#ffffff' یا 'white' نمایش داده می‌شود. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

پارامترها

نام نوع توضیحات
color String کد رنگ پس‌زمینه در نمادگذاری CSS مانند '#ffffff' یا 'white' ؛ مقدار null رنگ را بازنشانی می‌کند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Background RGB(red, green, blue)

پس‌زمینه را با رنگ RGB داده شده تنظیم می‌کند. این یک پوشش مناسب پیرامون فراخوانی set Background(color) است. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

پارامترها

نام نوع توضیحات
red Integer مقدار قرمز در نمادگذاری RGB.
green Integer مقدار سبز در نمادگذاری RGB.
blue Integer مقدار آبی در نمادگذاری RGB.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Border(top, left, bottom, right, vertical, horizontal)

ویژگی حاشیه را برای هر Range در لیست محدوده تنظیم می‌کند. مقادیر معتبر عبارتند از true (روشن)، false (خاموش) و null (بدون تغییر). 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

پارامترها

نام نوع توضیحات
top Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
left Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
bottom Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
right Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
vertical Boolean برای حاشیه‌های عمودی داخلی true ، برای هیچ‌کدام false و برای عدم تغییر null .
horizontal Boolean برای حاشیه‌های افقی داخلی true ، برای هیچ‌کدام false و برای عدم تغییر null .

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Border(top, left, bottom, right, vertical, horizontal, color, style)

ویژگی حاشیه را به همراه رنگ و/یا سبک برای هر Range در لیست محدوده تنظیم می‌کند. مقادیر معتبر عبارتند از true (روشن)، false (خاموش) و null (بدون تغییر). رنگ در نمادگذاری CSS نمایش داده می‌شود؛ برای مثال، '#ffffff' یا 'white' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

پارامترها

نام نوع توضیحات
top Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
left Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
bottom Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
right Boolean برای حاشیه مقدار true ، برای هیچ مقدار false و برای عدم تغییر null .
vertical Boolean برای حاشیه‌های عمودی داخلی true ، برای هیچ‌کدام false و برای عدم تغییر null .
horizontal Boolean برای حاشیه‌های افقی داخلی true ، برای هیچ‌کدام false و برای عدم تغییر null .
color String رنگ حاشیه در نمادهای CSS مانند '#ffffff' یا 'white' ، null برای رنگ پیش‌فرض (سیاه).
style Border Style استایل مربوط به حاشیه‌ها، که برای استایل پیش‌فرض (جامد) null .

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Color(color)

رنگ فونت را برای هر Range در لیست محدوده تنظیم می‌کند. رنگ در نمادگذاری CSS نمایش داده می‌شود؛ برای مثال، '#ffffff' یا 'white' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

پارامترها

نام نوع توضیحات
color String رنگ فونت در نمادگذاری CSS مانند '#ffffff' یا 'white' ؛ مقدار null رنگ را به حالت اولیه برمی‌گرداند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Family(fontFamily)

خانواده فونت را برای هر Range در لیست محدوده تنظیم می‌کند. خانواده فونت توسط یک شناسه رشته‌ای مانند Arial یا Roboto توصیف می‌شود. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

پارامترها

نام نوع توضیحات
font Family String خانواده فونتی که باید تنظیم شود؛ مقدار null خانواده فونت را ریست می‌کند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Line(fontLine)

سبک خط فونت را برای هر Range در لیست محدوده تنظیم می‌کند. گزینه‌های سبک خط عبارتند از 'underline' ، 'line-through' یا 'none' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

پارامترها

نام نوع توضیحات
font Line String سبک خط فونت، یا 'underline' ، 'line-through' یا 'none' ؛ مقدار null سبک خط فونت را بازنشانی می‌کند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Size(size)

اندازه فونت (بر حسب پوینت) را برای هر Range در لیست محدوده‌ها تنظیم می‌کند. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

پارامترها

نام نوع توضیحات
size Integer اندازه نقطه فونت.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Style(fontStyle)

سبک فونت را برای هر Range در لیست محدوده تنظیم کنید. گزینه‌های سبک فونت 'italic' یا 'normal' هستند. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

پارامترها

نام نوع توضیحات
font Style String سبک فونت، یا 'italic' یا 'normal' ؛ مقدار null سبک فونت را به حالت اولیه برمی‌گرداند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Font Weight(fontWeight)

وزن فونت را برای هر Range در لیست محدوده تنظیم کنید. گزینه‌های وزن فونت 'normal' یا 'bold' هستند. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

پارامترها

نام نوع توضیحات
font Weight String وزن فونت، یا 'bold' یا 'normal' ؛ مقدار null وزن فونت را بازنشانی می‌کند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Formula(formula)

فرمول را برای هر Range در لیست محدوده‌ها به‌روزرسانی می‌کند. فرمول داده شده باید با نمادگذاری A1 باشد. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

پارامترها

نام نوع توضیحات
formula String رشته‌ای که فرمول مورد نظر برای تنظیم را نشان می‌دهد.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Formula R1C1(formula)

فرمول را برای هر Range در لیست محدوده به‌روزرسانی می‌کند. فرمول داده شده باید با نمادگذاری R1C1 باشد. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

پارامترها

نام نوع توضیحات
formula String یک فرمول رشته‌ای.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Horizontal Alignment(alignment)

تراز افقی هر Range در لیست محدوده را تنظیم کنید. گزینه‌های ترازبندی عبارتند از 'left' ، 'center' یا 'right' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

پارامترها

نام نوع توضیحات
alignment String ترازبندی، یا 'left' ، 'center' یا 'normal' است؛ مقدار null ترازبندی را به حالت اولیه برمی‌گرداند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Note(note)

متن یادداشت را برای هر Range در لیست محدوده تنظیم می‌کند. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

پارامترها

نام نوع توضیحات
note String متن یادداشت برای تنظیم؛ مقدار null یادداشت را حذف می‌کند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Number Format(numberFormat)

قالب عدد یا تاریخ را برای هر Range در لیست محدوده تنظیم می‌کند.

الگوهای قالب‌بندی پذیرفته‌شده در راهنمای قالب‌بندی تاریخ و عدد Sheets API شرح داده شده‌اند. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

پارامترها

نام نوع توضیحات
number Format String یک رشته با فرمت عددی.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

تعیین می‌کند که آیا هر Range در لیست محدوده باید لینک‌ها را نشان دهد یا خیر. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

پارامترها

نام نوع توضیحات
show Hyperlink Boolean نمایش یا عدم نمایش هایپرلینک.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Text Direction(direction)

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

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

پارامترها

نام نوع توضیحات
direction Text Direction جهت متن مورد نظر؛ اگر null ، جهت قبل از تنظیم استنباط می‌شود.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Text Rotation(degrees)

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

برای جهت متن از چپ به راست، زوایای مثبت در جهت خلاف عقربه‌های ساعت هستند، در حالی که برای راست به چپ، در جهت عقربه‌های ساعت هستند. 

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

پارامترها

نام نوع توضیحات
degrees Integer زاویه مورد نظر بین جهت استاندارد و جهت دلخواه. برای متن از چپ به راست، زوایای مثبت در جهت خلاف عقربه‌های ساعت هستند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Value(value)

مقدار هر Range در لیست محدوده را تعیین می‌کند. این مقدار می‌تواند عددی، رشته‌ای، بولی یا تاریخ باشد. اگر با '="' شروع شود، به عنوان یک فرمول تفسیر می‌شود. 

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

پارامترها

نام نوع توضیحات
value Object مقدار برای محدوده.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Vertical Alignment(alignment)

تراز عمودی را برای هر Range در لیست محدوده تنظیم کنید. گزینه‌های ترازبندی عبارتند از 'top' ، 'middle' یا 'bottom' . 

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

پارامترها

نام نوع توضیحات
alignment String ترازبندی، یا 'top' ، 'middle' یا 'bottom' است؛ مقدار null ترازبندی را به حالت اولیه برمی‌گرداند.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Vertical Text(isVertical)

تنظیم می‌کند که آیا متن سلول‌های هر Range در لیست محدوده روی هم قرار گیرد یا خیر. اگر متن به صورت عمودی روی هم قرار گیرد، تنظیم چرخش متن درجه نادیده گرفته می‌شود. 

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

پارامترها

نام نوع توضیحات
is Vertical Boolean متن روی هم قرار بگیرد یا نه.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Wrap(isWrapEnabled)

نحوه‌ی قرارگیری متن در هر Range در لیست محدوده را تنظیم کنید. سلول‌هایی که قابلیت wrap در آنها فعال است، برای نمایش کل محتوای خود، تغییر اندازه می‌دهند. سلول‌هایی که قابلیت wrap در آنها غیرفعال است، تا حد امکان بدون تغییر اندازه یا اجرای چندین خط، محتوای خود را نمایش می‌دهند. 

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

پارامترها

نام نوع توضیحات
is Wrap Enabled Boolean اینکه متن را پوشش دهد یا نه.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

set Wrap Strategy(strategy)

استراتژی بسته‌بندی متن را برای هر Range در لیست محدوده تنظیم می‌کند. 

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

پارامترها

نام نوع توضیحات
strategy Wrap Strategy استراتژی بسته‌بندی مورد نظر.

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

trim Whitespace()

فاصله‌های خالی (مانند فاصله‌ها، تب‌ها یا خطوط جدید) را در هر سلول در این لیست محدوده حذف می‌کند. تمام فاصله‌های خالی را از ابتدا و انتهای متن هر سلول حذف می‌کند و هر زیردنباله از کاراکترهای فاصله خالی باقی‌مانده را به یک فاصله واحد کاهش می‌دهد.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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

همچنین ببینید

uncheck()

وضعیت کادرهای انتخاب در محدوده را به «بدون علامت» تغییر می‌دهد. سلول‌هایی از محدوده را که در حال حاضر حاوی مقدار پیکربندی‌شده‌ی علامت‌دار یا بدون علامت نیستند، نادیده می‌گیرد. 

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

بازگشت

Range List — این فهرست محدوده، برای زنجیره‌سازی.

مجوز

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

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