-
Notifications
You must be signed in to change notification settings - Fork 62
/
onenote.inkword.yml
195 lines (195 loc) · 7.66 KB
/
onenote.inkword.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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
### YamlMime:TSType
name: OneNote.InkWord
uid: 'onenote!OneNote.InkWord:class'
package: onenote!
fullName: OneNote.InkWord
summary: A container for the ink in a word in a paragraph.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'onenote!OneNote.InkWord#context:member'
package: onenote!
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="onenote!OneNote.RequestContext:class" />'
- name: id
uid: 'onenote!OneNote.InkWord#id:member'
package: onenote!
fullName: id
summary: Gets the ID of the InkWord object. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
return:
type: string
- name: languageId
uid: 'onenote!OneNote.InkWord#languageId:member'
package: onenote!
fullName: languageId
summary: The id of the recognized language in this ink word. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly languageId: string;'
return:
type: string
- name: paragraph
uid: 'onenote!OneNote.InkWord#paragraph:member'
package: onenote!
fullName: paragraph
summary: The parent paragraph containing the ink word. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly paragraph: OneNote.Paragraph;'
return:
type: '<xref uid="onenote!OneNote.Paragraph:class" />'
- name: wordAlternates
uid: 'onenote!OneNote.InkWord#wordAlternates:member'
package: onenote!
fullName: wordAlternates
summary: 'The words that were recognized in this ink word, in order of likelihood. Read-only.'
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly wordAlternates: string[];'
return:
type: 'string[]'
methods:
- name: load(options)
uid: 'onenote!OneNote.InkWord#load:member(1)'
package: onenote!
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?: OneNote.Interfaces.InkWordLoadOptions): OneNote.InkWord;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="onenote!OneNote.Interfaces.InkWordLoadOptions:interface" />'
return:
type: '<xref uid="onenote!OneNote.InkWord:class" />'
description: ''
- name: load(propertyNames)
uid: 'onenote!OneNote.InkWord#load:member(2)'
package: onenote!
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[]): OneNote.InkWord;'
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="onenote!OneNote.InkWord:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'onenote!OneNote.InkWord#load:member(3)'
package: onenote!
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;
}): OneNote.InkWord;
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="onenote!OneNote.InkWord:class" />'
description: ''
- name: toJSON()
uid: 'onenote!OneNote.InkWord#toJSON:member(1)'
package: onenote!
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 OneNote.InkWord object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `OneNote.Interfaces.InkWordData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): OneNote.Interfaces.InkWordData;'
return:
type: '<xref uid="onenote!OneNote.Interfaces.InkWordData:interface" />'
description: ''
- name: track()
uid: 'onenote!OneNote.InkWord#track:member(1)'
package: onenote!
fullName: track()
summary: >-
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
for `context.trackedObjects.add(thisObject)`<!-- -->. If you are using this object across `.sync` calls and
outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property
or invoking a method on the object, you needed to have added the object to the tracked object collection when the
object was first created.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'track(): OneNote.InkWord;'
return:
type: '<xref uid="onenote!OneNote.InkWord:class" />'
description: ''
- name: untrack()
uid: 'onenote!OneNote.InkWord#untrack:member(1)'
package: onenote!
fullName: untrack()
summary: >-
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
`context.trackedObjects.remove(thisObject)`<!-- -->. Having many tracked objects slows down the host application,
so please remember to free any objects you add, once you're done using them. You will need to call
`context.sync()` before the memory release takes effect.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'untrack(): OneNote.InkWord;'
return:
type: '<xref uid="onenote!OneNote.InkWord:class" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'