ModifyKey

Changes the sort key column.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax

expression.ModifyKey(rng);

expression - A variable that represents a ApiSortField class.

Parameters

Name	Required/Optional	Data type	Default	Description
rng	Required	ApiRange		New sort key range.

Returns

This method doesn't return any data.

Example

Point an existing sort criterion at a different column and re-sort the table in a spreadsheet.

// How do I reassign which column a sort field targets without creating a new sort rule in a spreadsheet?

// Swap the data column driving a sort criterion, then apply the updated order 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);
worksheet.GetRange("A4").SetValue("Bananas");
worksheet.GetRange("B4").SetValue(80);
let table = worksheet.AddListObject("xlSrcRange", "A1:B4");

let sort = table.GetSort();
let field = sort.GetSortFields().Add(worksheet.GetRange("A1"), "xlSortOnValues", "xlAscending");
field.ModifyKey(worksheet.GetRange("B1"));
sort.Apply();

worksheet.GetRange("D1").SetValue("First product after sort by price:");
worksheet.GetRange("E1").SetValue(worksheet.GetRange("A2").GetValue());