Represents a sort condition which will sort cells based on a custom, ordered list of values.

When the sort direction is ascending, the data range is sorted with the cells in the custom list appearing first, in the order they appear in the list, followed by the other cells in the same relative order they had to each other before the sort. When the sort direction is descending, the cells not in the list will appear first in the data region and they will appear in the same relative order they had before the sort. They will be followed by the other cells in the reverse order of the list.

The list of values specified on this sort condition are string values. If a cell being sorted has a string value, that value is used to sort the cell. Otherwise, the cell text is used. For example, if the cell's value is 0.01, but it is formatted as a percentage cell, the text used to sort it with this sort condition will be "1%" and not "0.01". When using the cell text, if the format string for the cell includes padding characters which are repeated across the cells, they will not be included in the cell text used for comparison.

When matching values from a cell to values in the custom list, strings are compared case-sensitively or case-insensitively based on the [[SortSettings`1.caseSensitive]] setting.

If the cell text contains any repeated padding characters, they are ignored when comparing strings.

@see [[SortSettings`1.caseSensitive]]

See

• [[SortSettings`1.sortConditions]]
• [[SortCondition.sortDirection]]
• [[WorksheetCell.getText]]
• [[WorksheetRow.getCellText]]