NamedRange.SortSpecial Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.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.

Uses East Asian sorting methods to sort the NamedRange control. For example, Japanese sorts in the order of the Kana syllabary. For more information, see the parameters list.

public object SortSpecial (Microsoft.Office.Interop.Excel.XlSortMethod SortMethod = Microsoft.Office.Interop.Excel.XlSortMethod.xlPinYin, object Key1, Microsoft.Office.Interop.Excel.XlSortOrder Order1 = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, object Type, object Key2, 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.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);

abstract member SortSpecial : Microsoft.Office.Interop.Excel.XlSortMethod * obj * Microsoft.Office.Interop.Excel.XlSortOrder * obj * obj * Microsoft.Office.Interop.Excel.XlSortOrder * obj * Microsoft.Office.Interop.Excel.XlSortOrder * Microsoft.Office.Interop.Excel.XlYesNoGuess * obj * obj * Microsoft.Office.Interop.Excel.XlSortOrientation * Microsoft.Office.Interop.Excel.XlSortDataOption * Microsoft.Office.Interop.Excel.XlSortDataOption * Microsoft.Office.Interop.Excel.XlSortDataOption -> obj

Public Function SortSpecial (Optional SortMethod As XlSortMethod = Microsoft.Office.Interop.Excel.XlSortMethod.xlPinYin, Optional Key1 As Object, Optional Order1 As XlSortOrder = Microsoft.Office.Interop.Excel.XlSortOrder.xlAscending, Optional Type As Object, Optional Key2 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 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

SortMethod: 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 have selected or installed.Can be one of the following XlSortMethod values: xlStroke. Sorting by the quantity of strokes in each character. xlPinYin (default). Phonetic Chinese sort order for characters.

Key1: Object

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

Order1: XlSortOrder

The sort order for the field or range specified in Key1.Can be one of the following XlSortOrder values: xlDescending. Sorts Key1 in descending order. xlAscending (default). Sorts Key1 in ascending order.

Type: Object

Specifies which elements are to be sorted. Use this argument only when sorting PivotTable reports.

Key2: Object

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

Order2: XlSortOrder

The sort order for the field or range specified in the Key2 argument. Cannot be used when sorting PivotTable reports.Can be one of the following XlSortOrder values: xlDescending. Sorts Key2 in descending order. xlAscending (default). Sorts Key2 in ascending order.

Key3: Object

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

Order3: XlSortOrder

The sort order for the field or range specified in the Key3 argument. Cannot be used when sorting PivotTable reports.Can be one of the following XlSortOrder values: xlDescending. Sorts Key3 in descending order. xlAscending (default). Sorts Key3 in ascending order.

Header: XlYesNoGuess

Specifies whether or not the first row contains headers. Cannot be used when sorting PivotTable reports.Can be one of the following XlYesNoGuess values: xlGuess. Lets Microsoft Office Excel determine whether there is a header, and to determine where it is, if there is one. xlNo (default). The entire range should be sorted. xlYes. The entire range should not be sorted.

OrderCustom: Object

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

MatchCase: Object

true to do a case-sensitive sort; false to do a sort that is not case sensitive. Cannot be used when sorting PivotTable reports.

Orientation: XlSortOrientation

The sort orientation.Can be one of the following XlSortOrientation values: xlSortRows (default). The sort is done by row. xlSortColumns. The sort is done by column.

DataOption1: XlSortDataOption

Specifies how to sort text in key1. Cannot be used when sorting PivotTable reports.Can be one of the following XlSortDataOption values: xlSortTextAsNumbers. Treats text as numeric data for the sort. xlSortNormal (default). Sorts numeric and text data separately.

DataOption2: XlSortDataOption

Specifies how to sort text in key2. Cannot be used when sorting PivotTable reports.Can be one of the following XlSortDataOption values: xlSortTextAsNumbers. Treats text as numeric data for the sort. xlSortNormal (default). Sorts numeric and text data separately.

DataOption3: XlSortDataOption

Specifies how to sort text in key3. Cannot be used when sorting PivotTable reports.Can be one of the following XlSortDataOption values: xlSortTextAsNumbers. Treats text as numeric data for the sort. xlSortNormal (default). Sorts numeric and text data separately.

Returns

Object

Examples

The following code example uses the SortSpecial method to sort a NamedRange using Pin Yin (phonetic Chinese sort order for characters). To sort Chinese characters, this example assumes the user has Chinese language support for Microsoft Office Excel. Excel will default to sorting the NamedRange by value if the user does not have Chinese language support.

This example is for a document-level customization.

private void SortSpecialNamedRange()
{
    this.Range["A1"].Value2 = 50;
    this.Range["A2"].Value2 = 10;
    this.Range["A3"].Value2 = 20;
    this.Range["A4"].Value2 = 30;
    this.Range["A5"].Value2 = 40;

    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1", "A5"],
        "namedRange1");

    namedRange1.SortSpecial(Excel.XlSortMethod.xlPinYin,
        this.Range["A1", "A5"], Excel.XlSortOrder.xlAscending,
        missing, missing, Excel.XlSortOrder.xlAscending,
        missing, Excel.XlSortOrder.xlAscending,
        Excel.XlYesNoGuess.xlNo, missing, missing,
        Excel.XlSortOrientation.xlSortColumns,
        Excel.XlSortDataOption.xlSortNormal,
        Excel.XlSortDataOption.xlSortNormal,
        Excel.XlSortDataOption.xlSortNormal);

}

Private Sub SortSpecialNamedRange()
    Me.Range("A1").Value2 = 50
    Me.Range("A2").Value2 = 10
    Me.Range("A3").Value2 = 20
    Me.Range("A4").Value2 = 30
    Me.Range("A5").Value2 = 40

    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A1", "A5"), _
        "namedRange1")

    namedRange1.SortSpecial(Excel.XlSortMethod.xlPinYin, _
        Me.Range("A1", "A5"), Excel.XlSortOrder.xlAscending, , , _
        Excel.XlSortOrder.xlAscending, , _
        Excel.XlSortOrder.xlAscending, _
        Excel.XlYesNoGuess.xlNo, , , _
        Excel.XlSortOrientation.xlSortColumns, _
        Excel.XlSortDataOption.xlSortNormal, _
        Excel.XlSortDataOption.xlSortNormal, _
        Excel.XlSortDataOption.xlSortNormal)
End Sub

Remarks

If no arguments are defined with this method, Microsoft Office Excel sorts the selection in ascending order.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to