דף זה תורגם על ידי Cloud Translation API.

Class Selection

אפשר לגשת לבחירה הפעילה הנוכחית בגיליון הפעיל. בחירה היא קבוצת התאים שהמשתמש מודגש בגיליון, שיכול להיות טווחים לא סמוכים. תא אחד לבחירה הוא התא הנוכחי, שבו נמצא המיקוד הנוכחי של המשתמש. התא הנוכחי מודגש באמצעות גבול כהה יותר בממשק המשתמש של Google Sheets.

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