-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.worksheetpositiontype.yml
64 lines (54 loc) · 2.37 KB
/
excel.worksheetpositiontype.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
### YamlMime:TSEnum
name: Excel.WorksheetPositionType
uid: 'excel!Excel.WorksheetPositionType:enum'
package: excel!
fullName: Excel.WorksheetPositionType
summary: The position of a worksheet relative to another worksheet or the entire worksheet collection.
remarks: >-
\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml
await Excel.run(async (context) => {
// Retrieve the source workbook.
const workbook = context.workbook;
// Set up the insert options.
const options = {
sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
};
// Insert the new worksheets.
workbook.insertWorksheetsFromBase64(externalWorkbook, options);
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: after
uid: 'excel!Excel.WorksheetPositionType.after:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"After"'
- name: before
uid: 'excel!Excel.WorksheetPositionType.before:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Before"'
- name: beginning
uid: 'excel!Excel.WorksheetPositionType.beginning:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Beginning"'
- name: end
uid: 'excel!Excel.WorksheetPositionType.end:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"End"'
- name: none
uid: 'excel!Excel.WorksheetPositionType.none:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"None"'