/
onenote.interfaces.inkanalysiswordcollectionloadoptions.yml
89 lines (89 loc) · 3.65 KB
/
onenote.interfaces.inkanalysiswordcollectionloadoptions.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
### YamlMime:TSType
name: OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions:interface'
package: onenote!
fullName: OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions
summary: Represents a collection of InkAnalysisWord objects.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#$all:member'
package: onenote!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: id
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#id:member'
package: onenote!
fullName: id
summary: 'For EACH ITEM in the collection: Gets the ID of the InkAnalysisWord object. Read-only.'
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
return:
type: boolean
- name: languageId
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#languageId:member'
package: onenote!
fullName: languageId
summary: 'For EACH ITEM in the collection: The id of the recognized language in this inkAnalysisWord. Read-only.'
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'languageId?: boolean;'
return:
type: boolean
- name: line
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#line:member'
package: onenote!
fullName: line
summary: 'For EACH ITEM in the collection: Reference to the parent InkAnalysisLine.'
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'line?: OneNote.Interfaces.InkAnalysisLineLoadOptions;'
return:
type: '<xref uid="onenote!OneNote.Interfaces.InkAnalysisLineLoadOptions:interface" />'
- name: strokePointers
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#strokePointers:member'
package: onenote!
fullName: strokePointers
summary: >-
For EACH ITEM in the collection: Weak references to the ink strokes that were recognized as part of this ink
analysis word. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'strokePointers?: boolean;'
return:
type: boolean
- name: wordAlternates
uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions#wordAlternates:member'
package: onenote!
fullName: wordAlternates
summary: >-
For EACH ITEM in the collection: 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: 'wordAlternates?: boolean;'
return:
type: boolean