-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.requestcontext.yml
78 lines (75 loc) · 2.36 KB
/
excel.requestcontext.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
### YamlMime:TSType
name: Excel.RequestContext
uid: 'excel!Excel.RequestContext:class'
package: excel!
fullName: Excel.RequestContext
summary: >-
The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel
application run in two different processes, the request context is required to get access to the Excel object model
from the add-in.
remarks: |-
#### Examples
```TypeScript
// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await Excel.run(async (context: Excel.RequestContext) => {
const workbook = context.workbook;
// Interact with the Excel workbook...
});
```
isPreview: false
isDeprecated: false
type: class
constructors:
- name: (constructor)(url)
uid: 'excel!Excel.RequestContext:constructor(1)'
package: excel!
fullName: (constructor)(url)
summary: Constructs a new instance of the `RequestContext` class
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'constructor(url?: string | Session);'
parameters:
- id: url
description: ''
type: 'string | <xref uid="excel!Excel.Session:interface" />'
properties:
- name: application
uid: 'excel!Excel.RequestContext#application:member'
package: excel!
fullName: application
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly application: Application;'
return:
type: '<xref uid="excel!Excel.Application:class" />'
- name: runtime
uid: 'excel!Excel.RequestContext#runtime:member'
package: excel!
fullName: runtime
summary: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly runtime: Runtime;'
return:
type: '<xref uid="excel!Excel.Runtime:class" />'
- name: workbook
uid: 'excel!Excel.RequestContext#workbook:member'
package: excel!
fullName: workbook
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly workbook: Workbook;'
return:
type: '<xref uid="excel!Excel.Workbook:class" />'
extends: '<xref uid="office!OfficeExtension.ClientRequestContext:class" />'