-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.closebehavior.yml
45 lines (34 loc) · 1.2 KB
/
word.closebehavior.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
### YamlMime:TSEnum
name: Word.CloseBehavior
uid: 'word!Word.CloseBehavior:enum'
package: word!
fullName: Word.CloseBehavior
summary: Specifies the close behavior for `Document.close`<!-- -->.
remarks: >-
\[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml
// Closes the document after saving.
await Word.run(async (context) => {
context.document.close(Word.CloseBehavior.save);
});
```
isPreview: false
isDeprecated: false
fields:
- name: save
uid: 'word!Word.CloseBehavior.save:member'
package: word!
summary: |-
Saves the changes before closing the document.
* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"Save"'
- name: skipSave
uid: 'word!Word.CloseBehavior.skipSave:member'
package: word!
summary: |-
Discard the possible changes when closing the document.
* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"SkipSave"'