Range.Sort Method

Reference

Definition

Namespace:: Microsoft.Office.Interop.Excel

Assembly:: Microsoft.Office.Interop.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sorts a PivotTable report, a range, or the active region if the specified range contains only one cell.

public object Sort (object Key1, Microsoft.Office.Interop.Excel.XlSortOrder Order1 = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, object Key2, object Type, Microsoft.Office.Interop.Excel.XlSortOrder Order2 = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, object Key3, Microsoft.Office.Interop.Excel.XlSortOrder Order3 = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, Microsoft.Office.Interop.Excel.XlYesNoGuess Header = Microsoft.Office.Interop.Excel.XlYesNoGuess.xlNo, object OrderCustom, object MatchCase, Microsoft.Office.Interop.Excel.XlSortOrientation Orientation = Microsoft.Office.Interop.Excel.XlSortOrientation.xlSortRows, Microsoft.Office.Interop.Excel.XlSortMethod SortMethod = Microsoft.Office.Interop.Excel.XlSortMethod.xlPinYin, Microsoft.Office.Interop.Excel.XlSortDataOption DataOption1 = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal, Microsoft.Office.Interop.Excel.XlSortDataOption DataOption2 = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal, Microsoft.Office.Interop.Excel.XlSortDataOption DataOption3 = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal);

Public Function Sort (Optional Key1 As Object, Optional Order1 As XlSortOrder = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, Optional Key2 As Object, Optional Type As Object, Optional Order2 As XlSortOrder = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, Optional Key3 As Object, Optional Order3 As XlSortOrder = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, Optional Header As XlYesNoGuess = Microsoft.Office.Interop.Excel.XlYesNoGuess.xlNo, Optional OrderCustom As Object, Optional MatchCase As Object, Optional Orientation As XlSortOrientation = Microsoft.Office.Interop.Excel.XlSortOrientation.xlSortRows, Optional SortMethod As XlSortMethod = Microsoft.Office.Interop.Excel.XlSortMethod.xlPinYin, Optional DataOption1 As XlSortDataOption = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal, Optional DataOption2 As XlSortDataOption = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal, Optional DataOption3 As XlSortDataOption = Microsoft.Office.Interop.Excel.XlSortDataOption.xlSortNormal) As Object

Parameters

Key1: Object

Optional Object. The first sort field, as either text (a PivotTable field or range name) or a Range object ("Dept" or Cells(1, 1), for example).

Order1: XlSortOrder

Optional XlSortOrder. The sort order for the field or range specified in Key1. Can be one of the following XlSortOrder constants:xlDescending. Sorts Key1 in descending order.xlAscendingdefault. Sorts Key1 in ascending order.

Key2: Object

Optional Object. The second sort field, as either text (a PivotTable field or range name) or a Range object. If you omit this argument, there’s no second sort field. Cannot be used when sorting Pivot Table reports.

Type: Object

Optional Object. Specifies which elements are to be sorted. Use this argument only when sorting PivotTable reports. Can be one of the following XlSortType constants:xlSortLabels. Sorts the PivotTable report by labels.xlSortValues. Sorts the PivotTable report by values.

Order2: XlSortOrder

Optional XlSortOrder. The sort order for the field or range specified in Key2. Cannot be used when sorting PivotTable reports. Can be one of the following XlSortOrder constants:xlDescending. Sorts Key2 in descending order.xlAscendingdefault. Sorts Key2 in ascending order.

Key3: Object

Optional Object. The third sort field, as either text (a range name) or a Range object. If you omit this argument, there’s no third sort field. Cannot be used when sorting PivotTable reports.

Order3: XlSortOrder

Optional XlSortOrder. The sort order for the field or range specified in Key3. Cannot be used when sorting PivotTable reports. Can be one of the following XlSortOrder constants:xlDescending. Sorts Key3 in descending order.xlAscendingdefault. Sorts Key3 in ascending order.

Header: XlYesNoGuess

Optional XlYesNoGuess. Specifies whether or not the first row contains headers. Cannot be used when sorting PivotTable reports. Can be one of the following XlYesNoGuess constants:xlGuess. Let Microsoft Excel determine whether there’s a header, and determine where it is if there is one.xlNodefault. (The entire range should be sorted).xlYes. (The entire range should not be sorted).

OrderCustom: Object

Optional Object. This argument is a one-based integer offset to the list of custom sort orders. If you omit OrderCustom, a normal sort is used.

MatchCase: Object

Optional Object. True to do a case-sensitive sort; False to do a sort that’s not case sensitive. Cannot be used when sorting PivotTable reports.

Orientation: XlSortOrientation

Optional XlSortOrientation. The sort orientation. Can be one of the following XlSortOrientation constants:xlSortRowsdefault. Sorts by row.xlSortColumns. Sorts by column.

SortMethod: XlSortMethod

Optional XlSortMethod. The type of sort. Some of these constants may not be available to you, depending on the language support (U.S. English, for example) that you’ve selected or installed. Can be one of the following XlSortMethod constants:xlStroke Sorting by the quantity of strokes in each character.xlPinYindefault. Phonetic Chinese sort order for characters.

DataOption1: XlSortDataOption

Optional XlSortDataOption. Specifies how to sort text in Key 1. Cannot be used when sorting PivotTable reports. Can be one of the following XlSortDataOption constants:xlSortTextAsNumbers. Treat text as numeric data for the sort.xlSortNormaldefault. Sorts numeric and text data separately.

DataOption2: XlSortDataOption

Optional XlSortDataOption. Specifies how to sort text in Key 2. Cannot be used when sorting PivotTable reports. Can be one of the following XlSortDataOption constants:xlSortTextAsNumbers. Treats text as numeric data for the sort.xlSortNormaldefault. Sorts numeric and text data separately.

DataOption3: XlSortDataOption

Optional XlSortDataOption. Specifies how to sort text in key 3. Cannot be used when sorting PivotTable reports. Can be one of the following XlSortDataOption constants:xlSortTextAsNumbers. Treats text as numeric data for the sort.xlSortNormaldefault. Sorts numeric and text data separately.

Returns

Object

Remarks

The settings for Header, Order1, Order2, Order3, OrderCustom, and Orientation are saved, for the particular worksheet, each time you use this method. If you don’t specify values for these arguments the next time you call the method, the saved values are used. Set these arguments explicitly each time you use Sort method if you choose not to use the saved values.

Text strings which are not convertible to numeric data are sorted normally.

If no arguments are defined with the Sort method, Microsoft Excel will sort the selection, chosen to be sorted, in ascending order.

Applies to