Skip to main content

Delete

Removes this sort field from the collection.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.Delete();

expression - A variable that represents a ApiSortField class.

Parameters​

This method doesn't have any parameters.

Returns​

This method doesn't return any data.

Example​

Remove one of the sort criteria from a table's sorting rules in a spreadsheet.

// How do I drop a specific sort criterion so the table ignores that column in a spreadsheet?

// Trim the active sort rules down by deleting an unwanted field 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 sortFields = table.GetSort().GetSortFields();
sortFields.Add(worksheet.GetRange("A1:A3"), "xlSortOnValues", "xlAscending");
let field2 = sortFields.Add(worksheet.GetRange("B1:B3"), "xlSortOnValues", "xlDescending");

field2.Delete();

worksheet.GetRange("D1").SetValue("Fields count after delete:");
worksheet.GetRange("E1").SetValue(sortFields.GetCount());