Skip to main content

GetRefersToRange

Returns the ApiRange object by its name.

Syntax​

expression.GetRefersToRange();

expression - A variable that represents a ApiName class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiRange

Example​

Get the cell range object by its name in a spreadsheet.

// How to get a range knowig its defname in a spreadsheet.

// Find a range by its name and change its properties in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("1");
worksheet.GetRange("B1").SetValue("2");
Api.AddDefName("numbers", "$A$1:$B$1");
let defName = Api.GetDefName("numbers");
let range = defName.GetRefersToRange();
range.SetBold(true);