Skip to main content

GetDefName

Returns the ApiName object of the current range.

Syntax​

expression.GetDefName();

expression - A variable that represents a ApiRange class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiName

Example​

Get the named range object of the range in a spreadsheet.

// How to find out a range name in a spreadsheet.

// Get a range, get its name and show it in the worksheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("1");
worksheet.GetRange("B1").SetValue("2");
Api.AddDefName("numbers", "Sheet1!$A$1:$B$1");
let range = worksheet.GetRange("A1:B1");
let defName = range.GetDefName();
worksheet.GetRange("A3").SetValue("DefName: " + defName.GetName());