Class Selection

انتخاب

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

var activeSheet = SpreadsheetApp.getActiveSheet();
var rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']);
rangeList.activate();

var selection = activeSheet.getSelection();
// Current Cell: D1
console.log('Current Cell: ' + selection.getCurrentCell().getA1Notation());
// Active Range: D1:E4
console.log('Active Range: ' + selection.getActiveRange().getA1Notation());
// Active Ranges: A1:B4, D1:E4
var ranges =  selection.getActiveRangeList().getRanges();
for (var i = 0; i < ranges.length; i++) {
  console.log('Active Ranges: ' + ranges[i].getA1Notation());
}
console.log('Active Sheet: ' + selection.getActiveSheet().getName());

روش ها

روش	نوع برگشت	شرح مختصر
getActiveRange()	Range	محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد null .
getActiveRangeList()	RangeList	لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد null برمی گرداند.
getActiveSheet()	Sheet	برگه فعال در صفحه گسترده را برمی گرداند.
getCurrentCell()	Range	سلول فعلی (هایلایت شده) را که در یکی از محدوده‌های فعال انتخاب شده است برمی‌گرداند یا اگر سلول فعلی وجود نداشته باشد null است.
getNextDataRange(direction)	Range	با شروع از current cell و active range و حرکت در جهت داده شده، یک محدوده تنظیم شده را برمی گرداند که در آن لبه مناسب محدوده برای پوشش next data cell در حالی که هنوز سلول فعلی را پوشش می دهد، جابجا شده است.

مستندات دقیق

getActiveRange()

محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد null . اگر چندین محدوده انتخاب شده باشد، این روش فقط آخرین محدوده انتخاب شده را برمی گرداند.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeRange = selection.getActiveRange();

بازگشت

Range - محدوده فعال.

مجوز

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

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

---

getActiveRangeList()

لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد null برمی گرداند.

اگر یک محدوده انتخاب شده باشد، به عنوان یک فراخوانی getActiveRange() عمل می کند.

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

بازگشت

RangeList - لیست محدوده های فعال.

مجوز

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

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

---

getActiveSheet()

برگه فعال در صفحه گسترده را برمی گرداند.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeSheet = selection.getActiveSheet();

بازگشت

Sheet - برگه فعال در صفحه گسترده.

مجوز

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

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

---

getCurrentCell()

سلول فعلی (هایلایت شده) را که در یکی از محدوده‌های فعال انتخاب شده است برمی‌گرداند یا اگر سلول فعلی وجود نداشته باشد null است.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = selection.getCurrentCell();

بازگشت

Range - سلول فعلی.

مجوز

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

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

---

getNextDataRange(direction)

با شروع از current cell و active range و حرکت در جهت داده شده، یک محدوده تنظیم شده را برمی گرداند که در آن لبه مناسب محدوده برای پوشش next data cell در حالی که هنوز سلول فعلی را پوشش می دهد، جابجا شده است. اگر محدوده فعال در امتداد dimension جهت نامحدود باشد، محدوده فعال اولیه برگردانده می شود. اگر سلول فعلی یا محدوده فعال وجود نداشته باشد، null برگردانده می شود. این معادل انتخاب یک محدوده در ویرایشگر و زدن کلیدهای Ctrl+Shift+[arrow key] است.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Makes C3 the current cell and C3:E5 the active range.
sheet.getRange('C3:E5').activate();
// Logs 'C1:E3'
console.log(SpreadsheetApp.getSelection()
                          .getNextDataRange(SpreadsheetApp.Direction.UP)
                          .getA1Notation());

پارامترها

نام	تایپ کنید	توضیحات
direction	Direction	جهتی که در آن سلول لبه منطقه داده بعدی پیدا می شود.

بازگشت

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

مجوز

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

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