-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.insertlocation.yml
79 lines (61 loc) · 2.5 KB
/
word.insertlocation.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:TSEnum
name: Word.InsertLocation
uid: 'word!Word.InsertLocation:enum'
package: word!
fullName: Word.InsertLocation
summary: The insertion location types.
remarks: >-
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
To be used with an API call, such as `obj.insertSomething(newStuff, location);`<!-- -->. If the location is "Before"
or "After", the new content will be outside of the modified object. If the location is "Start" or "End", the new
content will be included as part of the modified object.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-section-breaks.yaml
// Inserts a section without an associated page break.
await Word.run(async (context) => {
const body: Word.Body = context.document.body;
body.insertBreak(Word.BreakType.sectionContinuous, Word.InsertLocation.end);
await context.sync();
console.log("Inserted section without an associated page break.");
});
```
isPreview: false
isDeprecated: false
fields:
- name: after
uid: 'word!Word.InsertLocation.after:member'
package: word!
summary: |-
Add content after the contents of the calling object.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"After"'
- name: before
uid: 'word!Word.InsertLocation.before:member'
package: word!
summary: |-
Add content before the contents of the calling object.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"Before"'
- name: end
uid: 'word!Word.InsertLocation.end:member'
package: word!
summary: |-
Append content to the contents of the calling object.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"End"'
- name: replace
uid: 'word!Word.InsertLocation.replace:member'
package: word!
summary: |-
Replace the contents of the current object.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"Replace"'
- name: start
uid: 'word!Word.InsertLocation.start:member'
package: word!
summary: |-
Prepend content to the contents of the calling object.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"Start"'