ApiSortField

表示 ApiSortField 类。

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

属性

名称	类型	描述
Key	ApiRange | null	返回或设置排序键范围（完整表格列）。
Order	SortOrder	返回或设置排序顺序。
Parent	ApiSortFields	返回父 SortFields 集合。
Priority	number	返回或设置从 1 开始的排序优先级。
SortOn	XlSortOn	返回或设置用作排序条件的值。

方法

方法	返回值	描述
Delete	无	从集合中移除此排序字段。
GetKey	ApiRange | null	返回排序键范围（完整表格列）。
GetOrder	SortOrder	返回排序顺序：“xlAscending” 或 “xlDescending”。
GetParent	ApiSortFields	返回父 SortFields 集合。
GetPriority	number	返回此排序字段在集合中从 1 开始的优先级。
GetSortOn	XlSortOn	返回排序依据类型：“xlSortOnValues”、“xlSortOnCellColor”、“xlSortOnFontColor”、“xlSortOnIcon”。
GetSortOnValue	ApiColor | null	返回此排序字段排序依据的值（颜色或 null）。
ModifyKey	无	更改排序键列。
SetOrder	无	设置排序顺序。
SetPriority	无	设置此排序字段从 1 开始的优先级，在集合中重新定位。
SetSortOn	无	设置排序依据类型。
SetSortOnColor	无	设置基于颜色排序的颜色。