Skip to main content

GetRng

Returns the data body range that the sort applies to.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.GetRng();

expression - A variable that represents a ApiSort class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiRange | null

Example​

Retrieve the cell range that a table sort will reorder in a spreadsheet.

// How do I find out which cells are included in the sort operation in a spreadsheet?

// Identify the exact data area affected by a sort in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Product");
worksheet.GetRange("B1").SetValue("Price");
worksheet.GetRange("A2").SetValue("Apples");
worksheet.GetRange("B2").SetValue(100);
worksheet.GetRange("A3").SetValue("Oranges");
worksheet.GetRange("B3").SetValue(150);
let table = worksheet.AddListObject("xlSrcRange", "A1:B3");

let sort = table.GetSort();
let rng = sort.GetRng();

worksheet.GetRange("D1").SetValue("Sort range:");
worksheet.GetRange("E1").SetValue(rng ? rng.GetAddress() : "none");