-
Notifications
You must be signed in to change notification settings - Fork 62
/
word.interfaces.documentdata.yml
77 lines (77 loc) · 3.02 KB
/
word.interfaces.documentdata.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
### YamlMime:TSType
name: Word.Interfaces.DocumentData
uid: 'word!Word.Interfaces.DocumentData:interface'
package: word!
fullName: Word.Interfaces.DocumentData
summary: An interface describing the data returned by calling `document.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: body
uid: 'word!Word.Interfaces.DocumentData#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.BodyData;'
return:
type: '<xref uid="word!Word.Interfaces.BodyData:interface" />'
- name: contentControls
uid: 'word!Word.Interfaces.DocumentData#contentControls:member'
package: word!
fullName: contentControls
summary: >-
Gets the collection of content control objects in the document. This includes content controls in the body of the
document, headers, footers, textboxes, etc.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'contentControls?: Word.Interfaces.ContentControlData[];'
return:
type: '<xref uid="word!Word.Interfaces.ContentControlData:interface" />[]'
- name: properties
uid: 'word!Word.Interfaces.DocumentData#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.DocumentPropertiesData;'
return:
type: '<xref uid="word!Word.Interfaces.DocumentPropertiesData:interface" />'
- name: saved
uid: 'word!Word.Interfaces.DocumentData#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
- name: sections
uid: 'word!Word.Interfaces.DocumentData#sections:member'
package: word!
fullName: sections
summary: Gets the collection of section objects in the document.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'sections?: Word.Interfaces.SectionData[];'
return:
type: '<xref uid="word!Word.Interfaces.SectionData:interface" />[]'