Class Selection

Auswahl

Auf die aktuell aktive Auswahl im aktiven Tabellenblatt zugreifen. Eine Auswahl ist der Satz von Zellen, den der Nutzer im Tabellenblatt markiert hat. Dabei kann es sich um nicht nebeneinanderliegende Bereiche handeln. Eine Zelle in der Auswahl ist die aktuelle Zelle, auf die der Nutzer aktuell fokussiert ist. Sie wird in der Benutzeroberfläche von Google Tabellen mit einem dunkleren Rahmen hervorgehoben.

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());

Methoden

MethodeRückgabetypKurzbeschreibung
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.
getActiveSheet()SheetGibt das aktive Tabellenblatt in der Tabelle zurück.
getCurrentCell()RangeGibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche ausgewählt ist, oder null, wenn keine Zelle vorhanden ist.
getNextDataRange(direction)RangeAusgehend von current cell und active range wird beim Bewegen in die angegebene Richtung ein angepasster Bereich zurückgegeben, in dem die entsprechende Kante des Bereichs verschoben wurde, um die next data cell abzudecken, während die aktuelle Zelle weiterhin abgedeckt ist.

Detaillierte Dokumentation

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist Wenn mehrere Bereiche ausgewählt sind, gibt diese Methode nur den zuletzt ausgewählten Bereich zurück.

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

Return

Range: Der aktive Bereich.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveRangeList()

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.

Wenn nur ein Bereich ausgewählt ist, verhält sich dies wie ein getActiveRange()-Aufruf.

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

Return

RangeList: Die Liste der aktiven Bereiche.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveSheet()

Gibt das aktive Tabellenblatt in der Tabelle zurück.

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

Return

Sheet: Das aktive Tabellenblatt in der Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getCurrentCell()

Gibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche ausgewählt ist, oder null, wenn keine Zelle vorhanden ist.

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

Return

Range: Die aktuelle Zelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getNextDataRange(direction)

Ausgehend von current cell und active range wird beim Bewegen in die angegebene Richtung ein angepasster Bereich zurückgegeben, in dem die entsprechende Kante des Bereichs verschoben wurde, um die next data cell abzudecken, während die aktuelle Zelle weiterhin abgedeckt ist. Wenn der aktive Bereich entlang des dimension der Richtung unbegrenzt ist, wird der ursprüngliche aktive Bereich zurückgegeben. Wenn keine aktuelle Zelle und kein aktiver Bereich vorhanden ist, wird null zurückgegeben. Dies entspricht der Auswahl eines Bereichs im Editor und der Betätigung von 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());

Parameter

NameTypBeschreibung
directionDirectionDie Richtung, in der die nächste Edge-Zelle für den Datenbereich gesucht wird.

Return

Range: der angepasste Bereich, der die Datenzelle enthält, oder null, wenn keine Auswahl vorhanden ist

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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