-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.functionresult.yml
140 lines (140 loc) · 5.45 KB
/
excel.functionresult.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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
### YamlMime:TSType
name: Excel.FunctionResult
uid: 'excel!Excel.FunctionResult:class'
package: excel!
fullName: Excel.FunctionResult
summary: An object containing the result of a function-evaluation operation
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.FunctionResult#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" />'
- name: error
uid: 'excel!Excel.FunctionResult#error:member'
package: excel!
fullName: error
summary: >-
Error value (such as "\#DIV/0") representing the error. If the error string is not set, then the function
succeeded, and its result is written to the Value field. The error is always in the English locale.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly error: string;'
return:
type: string
- name: value
uid: 'excel!Excel.FunctionResult#value:member'
package: excel!
fullName: value
summary: >-
The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error
property is not set).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly value: T;'
return:
type: T
methods:
- name: load(options)
uid: 'excel!Excel.FunctionResult#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult<T>;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.FunctionResultLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><T>'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.FunctionResult#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): FunctionResult<T>;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><T>'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.FunctionResult#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): FunctionResult<T>;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><T>'
description: ''
- name: toJSON()
uid: 'excel!Excel.FunctionResult#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 `FunctionResult<T>` object is an API object, the `toJSON` method returns a
plain JavaScript object (typed as `Interfaces.FunctionResultData<T>`<!-- -->) that contains shallow copies of any
loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Interfaces.FunctionResultData<T>;'
return:
type: '<xref uid="excel!Excel.Interfaces.FunctionResultData:interface" /><T>'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'