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