Skip to main content

GetSortFields

Returns the sort fields collection.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.GetSortFields();

expression - A variable that represents a ApiSort class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiSortFields

Example​

Retrieve the list of sort criteria defined for a formatted table in a spreadsheet.

// How do I access all the columns and rules that control how a table is sorted in a spreadsheet?

// Read the full set of sort fields to inspect or modify ordering rules before sorting in a spreadsheet.

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

let sort = table.GetSort();
let sortFields = sort.GetSortFields();

worksheet.GetRange("D1").SetValue("Sort fields count:");
worksheet.GetRange("E1").SetValue(sortFields.GetCount());