Add2

Adds a sort field with subfield support for linked data types (Stocks, Geography).

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax

expression.Add2(Key, SortOn, Order, CustomOrder, DataOption, SubField);

expression - A variable that represents a ApiSortFields class.

Parameters

Name	Required/Optional	Data type	Default	Description
Key	Required	ApiRange		A range within the table that defines the sort column.
SortOn	Optional	XlSortOn	"xlSortOnValues"	The value used as the sort criteria.
Order	Optional	SortOrder	"xlAscending"	The sort order.
CustomOrder	Optional	number | string	0	Reserved. Custom order sorting is not yet supported by the engine.
DataOption	Optional	XlSortDataOption	"xlSortNormal"	The data sort option.
SubField	Optional	string		Subfield name for linked data types (e.g. "Population", "Volume").

Returns

ApiSortField | null

Example

Register a sort column that can also target a sub-property of a linked data type in a spreadsheet.

// How do I add a sort column with an optional sub-property for linked data in a spreadsheet?

// Supply a subfield alongside the column to refine what value the sort reads from each cell in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Product");
worksheet.GetRange("A2").SetValue("Oranges");
worksheet.GetRange("A3").SetValue("Apples");
worksheet.GetRange("A4").SetValue("Bananas");
let table = worksheet.AddListObject("xlSrcRange", "A1:A4");

let sort = table.GetSort();
let sortFields = sort.GetSortFields();
sortFields.Add2(worksheet.GetRange("A1"), "xlSortOnValues", "xlAscending", null, "xlSortNormal", null);

worksheet.GetRange("C1").SetValue("Fields count:");
worksheet.GetRange("D1").SetValue(sortFields.GetCount());
worksheet.GetRange("C2").SetValue("First product after sort:");
worksheet.GetRange("D2").SetValue(worksheet.GetRange("A2").GetValue());