ApiSort

Class representing the sort state of a list object (table).

note

This functionality is available in paid ONLYOFFICE Docs editions.

Properties

Name	Type	Description
Header	string	Returns the header setting (always "xlYes" for a ListObject).
MatchCase	boolean	Returns or sets whether the sort is case-sensitive.
Orientation	XlSortOrientation	Returns or sets the sort orientation.
Parent	ApiListObject	Returns the parent list object.
Rng	ApiRange | null	Returns the data body range that the sort applies to.
SortFields	ApiSortFields	Returns the collection of sort fields.
SortMethod	XlSortMethod	Returns or sets the sort method for Chinese text.

Methods

The following table lists the available methods.

Method	Returns	Description
Apply	None	Applies the current sort settings to the table.
GetHeader	string	Returns the header setting.
GetMatchCase	boolean	Returns whether the sort is case-sensitive.
GetOrientation	XlSortOrientation	Returns the sort orientation: "xlTopToBottom" or "xlLeftToRight".
GetParent	ApiListObject	Returns the parent list object.
GetRng	ApiRange | null	Returns the data body range that the sort applies to.
GetSortFields	ApiSortFields	Returns the sort fields collection.
GetSortMethod	XlSortMethod	Returns the sort method: "xlPinYin" or "xlStroke".
SetMatchCase	None	Sets whether the sort is case-sensitive.
SetOrientation	None	Sets the sort orientation.
SetSortMethod	None	Sets the sort method.