-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.workbookcreated.yml
95 lines (95 loc) · 3.72 KB
/
excel.workbookcreated.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
### YamlMime:TSType
name: Excel.WorkbookCreated
uid: 'excel!Excel.WorkbookCreated:class'
package: excel!
fullName: Excel.WorkbookCreated
summary: >-
The `WorkbookCreated` object is the top level object created by `Application.CreateWorkbook`<!-- -->. A
`WorkbookCreated` object is a special Workbook object.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.WorkbookCreated#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: load(propertyNames)
uid: 'excel!Excel.WorkbookCreated#load:member(1)'
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[]): Excel.WorkbookCreated;'
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.WorkbookCreated:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.WorkbookCreated#load:member(2)'
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;
}): Excel.WorkbookCreated;
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.WorkbookCreated:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.WorkbookCreated#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.WorkbookCreated object is an API object, the `toJSON` method returns a
plain JavaScript object (typed as `Excel.Interfaces.WorkbookCreatedData`<!-- -->) that contains shallow copies of
any loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.WorkbookCreatedData;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorkbookCreatedData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'