Excel.SortField interface

Represents a condition in a sorting operation.

[ API set: ExcelApi 1.2 ]

Properties

ascending

Represents whether the sorting is done in an ascending fashion.

[ API set: ExcelApi 1.2 ]

color

Represents the color that is the target of the condition if the sorting is on font or cell color.

[ API set: ExcelApi 1.2 ]

dataOption

Represents additional sorting options for this field.

[ API set: ExcelApi 1.2 ]

icon

Represents the icon that is the target of the condition if the sorting is on the cell's icon.

[ API set: ExcelApi 1.2 ]

key

Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).

[ API set: ExcelApi 1.2 ]

sortOn

Represents the type of sorting of this condition.

[ API set: ExcelApi 1.2 ]

subField

Represents the subfield that is the target property name of a rich value to sort on.

[ API set: ExcelApi 1.9 ]

Property Details

ascending

Represents whether the sorting is done in an ascending fashion.

[ API set: ExcelApi 1.2 ]

ascending?: boolean;

Property Value

boolean

color

Represents the color that is the target of the condition if the sorting is on font or cell color.

[ API set: ExcelApi 1.2 ]

color?: string;

Property Value

string

dataOption

Represents additional sorting options for this field.

[ API set: ExcelApi 1.2 ]

dataOption?: Excel.SortDataOption | "Normal" | "TextAsNumber";

Property Value

Excel.SortDataOption | "Normal" | "TextAsNumber"

icon

Represents the icon that is the target of the condition if the sorting is on the cell's icon.

[ API set: ExcelApi 1.2 ]

icon?: Excel.Icon;

Property Value

key

Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).

[ API set: ExcelApi 1.2 ]

key: number;

Property Value

number

sortOn

Represents the type of sorting of this condition.

[ API set: ExcelApi 1.2 ]

sortOn?: Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon";

Property Value

Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon"

subField

Represents the subfield that is the target property name of a rich value to sort on.

[ API set: ExcelApi 1.9 ]

subField?: string;

Property Value

string