What's the difference between getActiveCell and getCurrentCell in Google Apps Script?

user_1732483 0
Viewed 3006

I've read the definitions a few times over and I still don't understand the difference.

getActiveCell: Range

getCurrentCell: Range

  • https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#getCurrentCell()
  • Summary: Returns the current cell in the active sheet or null if there is no current cell.
  • Description: Returns the current cell in the active sheet or null if there is no current cell. The current cell is the cell that has focus in the Google Sheets UI, and is highlighted by a dark border. There is never more than one current cell. When a user selects one or more cell ranges, one of the cells in the selection is the current cell.

There's this note in getActiveCell's documentation: (copy-pasted including grammatical errors)

It's preferrable to use getCurrentCell(), which the returns the current highlighted cell.

Which doesn't make it any clearer

google-apps-script google-sheets
1 Answers

Answer:

getCurrentCell() returns the highlighted cell as seen by the dark border in the Sheets UI, whereas getActiveCell() returns the top-left cell of the selected range.

Example:

Say you have a range highlighted in a Sheet: B2:E10, for example. In the case where the you clicked on B2 and dragged down to E10:

enter image description here

Running the following code in the script editor:

function getCells() {
  var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sheet1")
  console.log(sheet.getActiveCell().getA1Notation())
  console.log(sheet.getCurrentCell().getA1Notation())
}

You will see in the logs that both getActiveCell() and getCurrentCell() return B2.

However in the opposite scenario, where you clicked on E10 and dragged up to B2:

enter image description here

After running the same code, you will see that getActiveCell() still returns B2, but now getCurrentCell() returns E10.

user_115514680
Related