Class Selection

Auswahl

Greifen Sie auf die aktuelle aktive Auswahl im aktiven Tabellenblatt zu. Eine Auswahl ist die Menge der Zellen, die der Nutzer im Tabellenblatt hervorgehoben hat. Dabei kann es sich um nicht angrenzende Bereiche handeln. Eine Zelle in der Auswahl ist die aktuelle Zelle, auf die der Nutzer gerade fokussiert ist. Die aktuelle Zelle ist in der Google Tabellen-Benutzeroberfläche mit einem dunkleren Rahmen hervorgehoben. 

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

const 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
const ranges = selection.getActiveRangeList().getRanges();
for (let i = 0; i < ranges.length; i++) {
  console.log(`Active Ranges: ${ranges[i].getA1Notation()}`);
}
console.log(`Active Sheet: ${selection.getActiveSheet().getName()}`);

Methoden

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

Detaillierte Dokumentation

getActiveRange()

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

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

Rückflug

Range|null – Der aktive Bereich.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getActiveRangeList()

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

Wenn ein einzelner Bereich ausgewählt ist, verhält sich diese Methode wie ein Aufruf von getActiveRange(). 

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

Rückflug

RangeList|null – Die Liste der aktiven Bereiche.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getActiveSheet()

Gibt das aktive Tabellenblatt in der Tabelle zurück. 

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

Rückflug

Sheet – Das aktive Tabellenblatt in der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 aktuelle Zelle vorhanden ist. 

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

Rückflug

Range|null – Die aktuelle Zelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getNextDataRange(direction)

Ausgehend von der current cell und dem active range und in der angegebenen Richtung wird ein angepasster Bereich zurückgegeben, bei dem der entsprechende Rand des Bereichs verschoben wurde, um die next data cell abzudecken, während die aktuelle Zelle weiterhin abgedeckt wird. Wenn der aktive Bereich entlang der dimension der Richtung unbegrenzt ist, wird der ursprüngliche aktive Bereich zurückgegeben. Wenn keine aktuelle Zelle oder kein aktiver Bereich vorhanden ist, wird null zurückgegeben. Das entspricht der Auswahl eines Bereichs im Editor und dem Drücken von Ctrl+Shift+[arrow key]. 

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Zelle am Rand des Datenbereichs gesucht werden soll.

Rückflug

Range|null – Der angepasste Bereich, der die Datenzelle enthält, oder null wenn keine Auswahl vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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