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 را در لیست محدوده پاک می کند و قالب بندی را دست نخورده باقی می گذارد.
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 را انتخاب می کند. آخرین محدوده در لیست به عنوان 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 را در لیست محدوده پاک می کند و قالب بندی را دست نخورده باقی می گذارد. 

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 در لیست محدوده تنظیم می کند.

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

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 را فعال کرده‌اند، تغییر اندازه می‌دهند تا محتوای کامل خود را نمایش دهند. سلول‌های دارای بسته‌بندی غیرفعال تا حد امکان در سلول بدون تغییر اندازه یا اجرای چندین خط نمایش داده می‌شوند. 

// 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