-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.rangesort.yml
113 lines (113 loc) · 4.55 KB
/
excel.rangesort.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
### YamlMime:TSType
name: Excel.RangeSort
uid: 'excel!Excel.RangeSort:class'
package: excel!
fullName: Excel.RangeSort
summary: Manages sorting operations on `Range` objects.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.RangeSort#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
methods:
- name: 'apply(fields, matchCase, hasHeaders, orientation, method)'
uid: 'excel!Excel.RangeSort#apply:member(1)'
package: excel!
fullName: 'apply(fields, matchCase, hasHeaders, orientation, method)'
summary: Perform a sort operation.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation,
method?: Excel.SortMethod): void;
parameters:
- id: fields
description: The list of conditions to sort on.
type: '<xref uid="excel!Excel.SortField:interface" />[]'
- id: matchCase
description: Optional. Whether to have the casing impact string ordering.
type: boolean
- id: hasHeaders
description: Optional. Whether the range has a header.
type: boolean
- id: orientation
description: Optional. Whether the operation is sorting rows or columns.
type: '<xref uid="excel!Excel.SortOrientation:enum" />'
- id: method
description: Optional. The ordering method used for Chinese characters.
type: '<xref uid="excel!Excel.SortMethod:enum" />'
return:
type: void
description: ''
- name: 'apply(fields, matchCase, hasHeaders, orientationString, methodString)'
uid: 'excel!Excel.RangeSort#apply:member(2)'
package: excel!
fullName: 'apply(fields, matchCase, hasHeaders, orientationString, methodString)'
summary: Perform a sort operation.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientationString?: "Rows" |
"Columns", methodString?: "PinYin" | "StrokeCount"): void;
parameters:
- id: fields
description: The list of conditions to sort on.
type: '<xref uid="excel!Excel.SortField:interface" />[]'
- id: matchCase
description: Optional. Whether to have the casing impact string ordering.
type: boolean
- id: hasHeaders
description: Optional. Whether the range has a header.
type: boolean
- id: orientationString
description: Optional. Whether the operation is sorting rows or columns.
type: '"Rows" | "Columns"'
- id: methodString
description: Optional. The ordering method used for Chinese characters.
type: '"PinYin" | "StrokeCount"'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.RangeSort#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.RangeSort object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.RangeSortData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
toJSON(): {
[key: string]: string;
};
return:
type: |-
{
[key: string]: string;
}
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'