-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.interfaces.documentloadoptions.yml
79 lines (79 loc) · 3.04 KB
/
word.interfaces.documentloadoptions.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
### YamlMime:TSType
name: Word.Interfaces.DocumentLoadOptions
uid: 'word!Word.Interfaces.DocumentLoadOptions:interface'
package: word!
fullName: Word.Interfaces.DocumentLoadOptions
summary: >-
The Document object is the top level object. A Document object contains one or more sections, content controls, and
the body that contains the contents of the document.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.DocumentLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`<!-- -->) but not
the navigational properties (such as `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: body
uid: 'word!Word.Interfaces.DocumentLoadOptions#body:member'
package: word!
fullName: body
summary: >-
Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes,
textboxes, etc.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'body?: Word.Interfaces.BodyLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
- name: changeTrackingMode
uid: 'word!Word.Interfaces.DocumentLoadOptions#changeTrackingMode:member'
package: word!
fullName: changeTrackingMode
summary: Specifies the ChangeTracking mode.
remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'changeTrackingMode?: boolean;'
return:
type: boolean
- name: properties
uid: 'word!Word.Interfaces.DocumentLoadOptions#properties:member'
package: word!
fullName: properties
summary: Gets the properties of the document.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'properties?: Word.Interfaces.DocumentPropertiesLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.DocumentPropertiesLoadOptions:interface" />'
- name: saved
uid: 'word!Word.Interfaces.DocumentLoadOptions#saved:member'
package: word!
fullName: saved
summary: >-
Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't
changed since it was saved.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'saved?: boolean;'
return:
type: boolean