ApiSortField

Represents the ApiSortField class.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Properties

Name	Type	Description
Key	ApiRange | null	Returns or sets the sort key range (the full table column).
Order	SortOrder	Returns or sets the sort order.
Parent	ApiSortFields	Returns the parent SortFields collection.
Priority	number	Returns or sets the 1-based sort priority.
SortOn	XlSortOn	Returns or sets what value is used as the sort criteria.

Methods

Method	Returns	Description
Delete	None	Removes this sort field from the collection.
GetKey	ApiRange | null	Returns the sort key range (the full table column).
GetOrder	SortOrder	Returns the sort order: "xlAscending" or "xlDescending".
GetParent	ApiSortFields	Returns the parent SortFields collection.
GetPriority	number	Returns the 1-based priority of this sort field within the collection.
GetSortOn	XlSortOn	Returns the sort-on type: "xlSortOnValues", "xlSortOnCellColor", "xlSortOnFontColor", "xlSortOnIcon".
GetSortOnValue	ApiColor | null	Returns the value (color or null) by which this sort field is sorted.
ModifyKey	None	Changes the sort key column.
SetOrder	None	Sets the sort order.
SetPriority	None	Sets the 1-based priority of this sort field, repositioning it within the collection.
SetSortOn	None	Sets the sort-on type.
SetSortOnColor	None	Sets the color for color-based sorting.