Skip to main content

GetCurrentRegion

Returns a range that represents the expanded range around the current range.

Syntax​

expression.GetCurrentRegion();

expression - A variable that represents a ApiRange class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiRange | null

Example​

This example shows how to get the current region of a range.

const worksheet = Api.GetActiveSheet();
worksheet.GetRange('B2').SetValue('Name');
worksheet.GetRange('C2').SetValue('Score');
worksheet.GetRange('B3').SetValue('Alice');
worksheet.GetRange('C3').SetValue(90);
worksheet.GetRange('B4').SetValue('Bob');
worksheet.GetRange('C4').SetValue(75);

const range = worksheet.GetRange('B3');
const region = range.GetCurrentRegion();
worksheet.GetRange('A1').SetValue('Current region: ' + region.GetAddress(true, true, 'xlA1', false));