Skip to main content

GetLocale

Returns the current locale ID.

Syntax​

expression.GetLocale();

expression - A variable that represents a Api class.

Parameters​

This method doesn't have any parameters.

Returns​

number

Example​

Read the active regional language setting and display it in a cell in a spreadsheet.

// How do I find out which locale or language region is currently set in a spreadsheet?

// Confirm the applied locale by printing its identifier into a cell in a spreadsheet.

let worksheet = Api.GetActiveSheet();
Api.SetLocale("en-CA");
let locale = Api.GetLocale();
worksheet.GetRange("A1").SetValue("Locale: " + locale);