Skip to content

Commit a5e0238

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2471)
Co-authored-by: github-actions <github-actions@github.com>
1 parent eb922cf commit a5e0238

22 files changed

+502
-9
lines changed

docs/docs-ref-autogen/excel/excel/excel.worksheetmovedeventargs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ remarks: >-
1717
\[ [API set: ExcelApi
1818
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1919
20+
21+
#### Examples
22+
23+
24+
```TypeScript
25+
26+
// Link to full sample:
27+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
28+
29+
30+
async function onWorksheetMoved(event) {
31+
await Excel.run(async (context) => {
32+
console.log("Handler for worksheet onMoved event has been triggered.");
33+
console.log(` Worksheet ID: ${event.worksheetId}`);
34+
console.log(` Position before move: ${event.positionBefore}`);
35+
console.log(` Position after move: ${event.positionAfter}`);
36+
console.log(` Event source: ${event.source}`);
37+
});
38+
}
39+
40+
```
41+
2042
isPreview: false
2143
isDeprecated: false
2244
type: interface

docs/docs-ref-autogen/excel/excel/excel.worksheetnamechangedeventargs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ remarks: >-
88
\[ [API set: ExcelApi
99
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11+
12+
#### Examples
13+
14+
15+
```TypeScript
16+
17+
// Link to full sample:
18+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
19+
20+
21+
async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
22+
await Excel.run(async (context) => {
23+
console.log(`Handler for worksheet onNameChanged event has been triggered.`);
24+
console.log(` Name before change: ` + event.nameBefore);
25+
console.log(` Name after change: ` + event.nameAfter);
26+
});
27+
}
28+
29+
```
30+
1131
isPreview: false
1232
isDeprecated: false
1333
type: interface

docs/docs-ref-autogen/excel_1_17/excel/excel.worksheetmovedeventargs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ remarks: >-
1717
\[ [API set: ExcelApi
1818
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1919
20+
21+
#### Examples
22+
23+
24+
```TypeScript
25+
26+
// Link to full sample:
27+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
28+
29+
30+
async function onWorksheetMoved(event) {
31+
await Excel.run(async (context) => {
32+
console.log("Handler for worksheet onMoved event has been triggered.");
33+
console.log(` Worksheet ID: ${event.worksheetId}`);
34+
console.log(` Position before move: ${event.positionBefore}`);
35+
console.log(` Position after move: ${event.positionAfter}`);
36+
console.log(` Event source: ${event.source}`);
37+
});
38+
}
39+
40+
```
41+
2042
isPreview: false
2143
isDeprecated: false
2244
type: interface

docs/docs-ref-autogen/excel_1_17/excel/excel.worksheetnamechangedeventargs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ remarks: >-
88
\[ [API set: ExcelApi
99
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11+
12+
#### Examples
13+
14+
15+
```TypeScript
16+
17+
// Link to full sample:
18+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
19+
20+
21+
async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
22+
await Excel.run(async (context) => {
23+
console.log(`Handler for worksheet onNameChanged event has been triggered.`);
24+
console.log(` Name before change: ` + event.nameBefore);
25+
console.log(` Name after change: ` + event.nameAfter);
26+
});
27+
}
28+
29+
```
30+
1131
isPreview: false
1232
isDeprecated: false
1333
type: interface

docs/docs-ref-autogen/excel_1_18/excel/excel.worksheetmovedeventargs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ remarks: >-
1717
\[ [API set: ExcelApi
1818
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1919
20+
21+
#### Examples
22+
23+
24+
```TypeScript
25+
26+
// Link to full sample:
27+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
28+
29+
30+
async function onWorksheetMoved(event) {
31+
await Excel.run(async (context) => {
32+
console.log("Handler for worksheet onMoved event has been triggered.");
33+
console.log(` Worksheet ID: ${event.worksheetId}`);
34+
console.log(` Position before move: ${event.positionBefore}`);
35+
console.log(` Position after move: ${event.positionAfter}`);
36+
console.log(` Event source: ${event.source}`);
37+
});
38+
}
39+
40+
```
41+
2042
isPreview: false
2143
isDeprecated: false
2244
type: interface

docs/docs-ref-autogen/excel_1_18/excel/excel.worksheetnamechangedeventargs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ remarks: >-
88
\[ [API set: ExcelApi
99
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11+
12+
#### Examples
13+
14+
15+
```TypeScript
16+
17+
// Link to full sample:
18+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
19+
20+
21+
async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
22+
await Excel.run(async (context) => {
23+
console.log(`Handler for worksheet onNameChanged event has been triggered.`);
24+
console.log(` Name before change: ` + event.nameBefore);
25+
console.log(` Name after change: ` + event.nameAfter);
26+
});
27+
}
28+
29+
```
30+
1131
isPreview: false
1232
isDeprecated: false
1333
type: interface

docs/docs-ref-autogen/excel_1_19/excel/excel.worksheetmovedeventargs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ remarks: >-
1717
\[ [API set: ExcelApi
1818
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1919
20+
21+
#### Examples
22+
23+
24+
```TypeScript
25+
26+
// Link to full sample:
27+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
28+
29+
30+
async function onWorksheetMoved(event) {
31+
await Excel.run(async (context) => {
32+
console.log("Handler for worksheet onMoved event has been triggered.");
33+
console.log(` Worksheet ID: ${event.worksheetId}`);
34+
console.log(` Position before move: ${event.positionBefore}`);
35+
console.log(` Position after move: ${event.positionAfter}`);
36+
console.log(` Event source: ${event.source}`);
37+
});
38+
}
39+
40+
```
41+
2042
isPreview: false
2143
isDeprecated: false
2244
type: interface

docs/docs-ref-autogen/excel_1_19/excel/excel.worksheetnamechangedeventargs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ remarks: >-
88
\[ [API set: ExcelApi
99
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11+
12+
#### Examples
13+
14+
15+
```TypeScript
16+
17+
// Link to full sample:
18+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
19+
20+
21+
async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
22+
await Excel.run(async (context) => {
23+
console.log(`Handler for worksheet onNameChanged event has been triggered.`);
24+
console.log(` Name before change: ` + event.nameBefore);
25+
console.log(` Name after change: ` + event.nameAfter);
26+
});
27+
}
28+
29+
```
30+
1131
isPreview: false
1232
isDeprecated: false
1333
type: interface

docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetmovedeventargs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ remarks: >-
1717
\[ [API set: ExcelApi
1818
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1919
20+
21+
#### Examples
22+
23+
24+
```TypeScript
25+
26+
// Link to full sample:
27+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
28+
29+
30+
async function onWorksheetMoved(event) {
31+
await Excel.run(async (context) => {
32+
console.log("Handler for worksheet onMoved event has been triggered.");
33+
console.log(` Worksheet ID: ${event.worksheetId}`);
34+
console.log(` Position before move: ${event.positionBefore}`);
35+
console.log(` Position after move: ${event.positionAfter}`);
36+
console.log(` Event source: ${event.source}`);
37+
});
38+
}
39+
40+
```
41+
2042
isPreview: false
2143
isDeprecated: false
2244
type: interface

docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetnamechangedeventargs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ remarks: >-
88
\[ [API set: ExcelApi
99
1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
1010
11+
12+
#### Examples
13+
14+
15+
```TypeScript
16+
17+
// Link to full sample:
18+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
19+
20+
21+
async function onNameChanged(event: Excel.WorksheetNameChangedEventArgs) {
22+
await Excel.run(async (context) => {
23+
console.log(`Handler for worksheet onNameChanged event has been triggered.`);
24+
console.log(` Name before change: ` + event.nameBefore);
25+
console.log(` Name after change: ` + event.nameAfter);
26+
});
27+
}
28+
29+
```
30+
1131
isPreview: false
1232
isDeprecated: false
1333
type: interface

0 commit comments

Comments
 (0)