Excel.SortOn enum

Package:

excel

Represents the part of the cell used as the sorting criteria.

Remarks

[ API set: ExcelApi 1.2 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

Fields

cellColor = "CellColor"	[ API set: ExcelApi 1.2 ]
fontColor = "FontColor"	[ API set: ExcelApi 1.2 ]
icon = "Icon"	[ API set: ExcelApi 1.2 ]
value = "Value"	[ API set: ExcelApi 1.2 ]