-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.section.yml
436 lines (389 loc) · 16.5 KB
/
word.section.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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
### YamlMime:TSType
name: Word.Section
uid: 'word!Word.Section:class'
package: word!
fullName: Word.Section
summary: Represents a section in a Word document.
remarks: >-
\[ [API set: WordApi 1.1](/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/insert-section-breaks.yaml
// Inserts a section break on the next page.
await Word.run(async (context) => {
const body: Word.Body = context.document.body;
body.insertBreak(Word.BreakType.sectionNext, Word.InsertLocation.end);
await context.sync();
console.log("Inserted section break on next page.");
});
```
isPreview: false
isDeprecated: false
type: class
properties:
- name: body
uid: 'word!Word.Section#body:member'
package: word!
fullName: body
summary: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly body: Word.Body;'
return:
type: '<xref uid="word!Word.Body:class" />'
- name: context
uid: 'word!Word.Section#context:member'
package: word!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="word!Word.RequestContext:class" />'
methods:
- name: getFooter(type)
uid: 'word!Word.Section#getFooter:member(1)'
package: word!
fullName: getFooter(type)
summary: Gets one of the section's footers.
remarks: |-
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy sectionsCollection object.
const mySections = context.document.sections;
// Queue a command to load the sections.
mySections.load('body/style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Create a proxy object the primary footer of the first section.
// Note that the footer is a body object.
const myFooter = mySections.items[0].getFooter(Word.HeaderFooterType.primary);
// Queue a command to insert text at the end of the footer.
myFooter.insertText("This is a footer.", Word.InsertLocation.end);
// Queue a command to wrap the header in a content control.
myFooter.insertContentControl();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log("Added a footer to the first section.");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getFooter(type: Word.HeaderFooterType): Word.Body;'
parameters:
- id: type
description: 'Required. The type of footer to return. This value must be: ''Primary'', ''FirstPage'', or ''EvenPages''.'
type: '<xref uid="word!Word.HeaderFooterType:enum" />'
return:
type: '<xref uid="word!Word.Body:class" />'
description: ''
- name: getFooter(typeString)
uid: 'word!Word.Section#getFooter:member(2)'
package: word!
fullName: getFooter(typeString)
summary: Gets one of the section's footers.
remarks: >-
\[ [API set: WordApi 1.1](/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/25-paragraph/insert-header-and-footer.yaml
await Word.run(async (context) => {
context.document.sections
.getFirst()
.getFooter("Primary")
.insertParagraph("This is a primary footer.", "End");
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getFooter(typeString: "Primary" | "FirstPage" | "EvenPages"): Word.Body;'
parameters:
- id: typeString
description: 'Required. The type of footer to return. This value must be: ''Primary'', ''FirstPage'', or ''EvenPages''.'
type: '"Primary" | "FirstPage" | "EvenPages"'
return:
type: '<xref uid="word!Word.Body:class" />'
description: ''
- name: getHeader(type)
uid: 'word!Word.Section#getHeader:member(1)'
package: word!
fullName: getHeader(type)
summary: Gets one of the section's headers.
remarks: >-
\[ [API set: WordApi 1.1](/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/25-paragraph/insert-header-and-footer.yaml
await Word.run(async (context) => {
context.document.sections
.getFirst()
.getHeader(Word.HeaderFooterType.primary)
.insertParagraph("This is a primary header.", "End");
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getHeader(type: Word.HeaderFooterType): Word.Body;'
parameters:
- id: type
description: 'Required. The type of header to return. This value must be: ''Primary'', ''FirstPage'', or ''EvenPages''.'
type: '<xref uid="word!Word.HeaderFooterType:enum" />'
return:
type: '<xref uid="word!Word.Body:class" />'
description: ''
- name: getHeader(typeString)
uid: 'word!Word.Section#getHeader:member(2)'
package: word!
fullName: getHeader(typeString)
summary: Gets one of the section's headers.
remarks: |-
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy sectionsCollection object.
const mySections = context.document.sections;
// Queue a command to load the sections.
mySections.load('body/style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Create a proxy object the primary header of the first section.
// Note that the header is a body object.
const myHeader = mySections.items[0].getHeader("Primary");
// Queue a command to insert text at the end of the header.
myHeader.insertText("This is a header.", Word.InsertLocation.end);
// Queue a command to wrap the header in a content control.
myHeader.insertContentControl();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log("Added a header to the first section.");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getHeader(typeString: "Primary" | "FirstPage" | "EvenPages"): Word.Body;'
parameters:
- id: typeString
description: 'Required. The type of header to return. This value must be: ''Primary'', ''FirstPage'', or ''EvenPages''.'
type: '"Primary" | "FirstPage" | "EvenPages"'
return:
type: '<xref uid="word!Word.Body:class" />'
description: ''
- name: getNext()
uid: 'word!Word.Section#getNext:member(1)'
package: word!
fullName: getNext()
summary: Gets the next section. Throws an `ItemNotFound` error if this section is the last one.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getNext(): Word.Section;'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: getNextOrNullObject()
uid: 'word!Word.Section#getNextOrNullObject:member(1)'
package: word!
fullName: getNextOrNullObject()
summary: >-
Gets the next section. If this section is the last one, then this method will return an object with its
`isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getNextOrNullObject(): Word.Section;'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: load(options)
uid: 'word!Word.Section#load:member(1)'
package: word!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Word.Interfaces.SectionLoadOptions): Word.Section;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="word!Word.Interfaces.SectionLoadOptions:interface" />'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: load(propertyNames)
uid: 'word!Word.Section#load:member(2)'
package: word!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Word.Section;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'word!Word.Section#load:member(3)'
package: word!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Section;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'word!Word.Section#set:member(1)'
package: word!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="word!Word.Interfaces.SectionUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'word!Word.Section#set:member(2)'
package: word!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Word.Section): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="word!Word.Section:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'word!Word.Section#toJSON:member(1)'
package: word!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Word.Interfaces.SectionData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Word.Interfaces.SectionData;'
return:
type: '<xref uid="word!Word.Interfaces.SectionData:interface" />'
description: ''
- name: track()
uid: 'word!Word.Section#track:member(1)'
package: word!
fullName: track()
summary: >-
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
for
[context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
-->. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and
get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the
object to the tracked object collection when the object was first created. If this object is part of a collection,
you should also track the parent collection.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'track(): Word.Section;'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
- name: untrack()
uid: 'word!Word.Section#untrack:member(1)'
package: word!
fullName: untrack()
summary: >-
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
[context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
-->. Having many tracked objects slows down the host application, so please remember to free any objects you add,
once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'untrack(): Word.Section;'
return:
type: '<xref uid="word!Word.Section:class" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'