diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 98d14d0281..aafb640667 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -69,6 +69,7 @@ "word-js-desktop-1.1", "word-js-1.9", "word-js-desktop-1.2", + "word-js-desktop-1.3", "word-js-online" ], "open_to_public_contributors": true, @@ -387,6 +388,10 @@ "ReferenceTOC": "docs/docs-ref-autogen/word_desktop_1_2/toc.yml", "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" }, + { + "ReferenceTOC": "docs/docs-ref-autogen/word_desktop_1_3/toc.yml", + "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" + }, { "ReferenceTOC": "docs/docs-ref-autogen/word_online/toc.yml", "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" diff --git a/docs/docfx.json b/docs/docfx.json index 16562a6a07..26d4132b8e 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -882,6 +882,18 @@ "src": "docs-ref-autogen/word_desktop_1_2", "dest": "api" }, + { + "files": ["**/toc.yml"], + "group": "word-js-desktop-1.3", + "src": "docs-ref-autogen/word_desktop_1_3", + "dest": "api/office-js-docs-reference" + }, + { + "files": ["**/*.md", "**/*.yml"], + "group": "word-js-desktop-1.3", + "src": "docs-ref-autogen/word_desktop_1_3", + "dest": "api" + }, { "files": ["**/toc.yml"], "group": "word-js-online", @@ -1165,6 +1177,10 @@ "dest": "word-js-desktop-1.2", "moniker_range": "word-js-desktop-1.2" }, + "word-js-desktop-1.3": { + "dest": "word-js-desktop-1.3", + "moniker_range": "word-js-desktop-1.3" + }, "word-js-online": { "dest": "word-js-online", "moniker_range": "word-js-online" diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml index 9df30971f4..29bbc244c7 100644 --- a/docs/docs-ref-autogen/common/toc.yml +++ b/docs/docs-ref-autogen/common/toc.yml @@ -885,6 +885,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml index 9df30971f4..29bbc244c7 100644 --- a/docs/docs-ref-autogen/common_preview/toc.yml +++ b/docs/docs-ref-autogen/common_preview/toc.yml @@ -885,6 +885,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index 912ce58ba3..3ea1d90d5d 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -2097,6 +2097,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_1/toc.yml b/docs/docs-ref-autogen/excel_1_1/toc.yml index d94b3019d4..390661faf7 100644 --- a/docs/docs-ref-autogen/excel_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_1_1/toc.yml @@ -1027,6 +1027,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_10/toc.yml b/docs/docs-ref-autogen/excel_1_10/toc.yml index 7110aefbaa..d7f59faf8c 100644 --- a/docs/docs-ref-autogen/excel_1_10/toc.yml +++ b/docs/docs-ref-autogen/excel_1_10/toc.yml @@ -1711,6 +1711,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_11/toc.yml b/docs/docs-ref-autogen/excel_1_11/toc.yml index 64ed2d5af7..6aba979781 100644 --- a/docs/docs-ref-autogen/excel_1_11/toc.yml +++ b/docs/docs-ref-autogen/excel_1_11/toc.yml @@ -1723,6 +1723,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_12/toc.yml b/docs/docs-ref-autogen/excel_1_12/toc.yml index 058a0ebb7a..0c1812b656 100644 --- a/docs/docs-ref-autogen/excel_1_12/toc.yml +++ b/docs/docs-ref-autogen/excel_1_12/toc.yml @@ -1769,6 +1769,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_13/toc.yml b/docs/docs-ref-autogen/excel_1_13/toc.yml index 5fa8524a99..10a61744be 100644 --- a/docs/docs-ref-autogen/excel_1_13/toc.yml +++ b/docs/docs-ref-autogen/excel_1_13/toc.yml @@ -1779,6 +1779,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_14/toc.yml b/docs/docs-ref-autogen/excel_1_14/toc.yml index 83a7c26357..fe5b7aa7ee 100644 --- a/docs/docs-ref-autogen/excel_1_14/toc.yml +++ b/docs/docs-ref-autogen/excel_1_14/toc.yml @@ -1797,6 +1797,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_15/toc.yml b/docs/docs-ref-autogen/excel_1_15/toc.yml index e6e48e2ce0..a24056d24e 100644 --- a/docs/docs-ref-autogen/excel_1_15/toc.yml +++ b/docs/docs-ref-autogen/excel_1_15/toc.yml @@ -1801,6 +1801,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_16/toc.yml b/docs/docs-ref-autogen/excel_1_16/toc.yml index a1998e49f3..17de4b7c8f 100644 --- a/docs/docs-ref-autogen/excel_1_16/toc.yml +++ b/docs/docs-ref-autogen/excel_1_16/toc.yml @@ -1929,6 +1929,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_17/toc.yml b/docs/docs-ref-autogen/excel_1_17/toc.yml index 3a38c9d450..bbba08132b 100644 --- a/docs/docs-ref-autogen/excel_1_17/toc.yml +++ b/docs/docs-ref-autogen/excel_1_17/toc.yml @@ -1935,6 +1935,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_18/toc.yml b/docs/docs-ref-autogen/excel_1_18/toc.yml index af8a8ff430..b4b80c4f89 100644 --- a/docs/docs-ref-autogen/excel_1_18/toc.yml +++ b/docs/docs-ref-autogen/excel_1_18/toc.yml @@ -1953,6 +1953,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_19/toc.yml b/docs/docs-ref-autogen/excel_1_19/toc.yml index 6b7685fa50..2b45763679 100644 --- a/docs/docs-ref-autogen/excel_1_19/toc.yml +++ b/docs/docs-ref-autogen/excel_1_19/toc.yml @@ -1999,6 +1999,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_2/toc.yml b/docs/docs-ref-autogen/excel_1_2/toc.yml index d455ccf315..8adbe2a605 100644 --- a/docs/docs-ref-autogen/excel_1_2/toc.yml +++ b/docs/docs-ref-autogen/excel_1_2/toc.yml @@ -1124,6 +1124,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_20/toc.yml b/docs/docs-ref-autogen/excel_1_20/toc.yml index 11e4b24507..2b24754919 100644 --- a/docs/docs-ref-autogen/excel_1_20/toc.yml +++ b/docs/docs-ref-autogen/excel_1_20/toc.yml @@ -2003,6 +2003,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_3/toc.yml b/docs/docs-ref-autogen/excel_1_3/toc.yml index 2308f16910..d1a0740a0b 100644 --- a/docs/docs-ref-autogen/excel_1_3/toc.yml +++ b/docs/docs-ref-autogen/excel_1_3/toc.yml @@ -1132,6 +1132,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_4/toc.yml b/docs/docs-ref-autogen/excel_1_4/toc.yml index 15ae12a105..c7603c2638 100644 --- a/docs/docs-ref-autogen/excel_1_4/toc.yml +++ b/docs/docs-ref-autogen/excel_1_4/toc.yml @@ -1140,6 +1140,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_5/toc.yml b/docs/docs-ref-autogen/excel_1_5/toc.yml index 79e2f16bfb..743f81a167 100644 --- a/docs/docs-ref-autogen/excel_1_5/toc.yml +++ b/docs/docs-ref-autogen/excel_1_5/toc.yml @@ -1148,6 +1148,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_6/toc.yml b/docs/docs-ref-autogen/excel_1_6/toc.yml index 4bd960e797..eefb5f7a7d 100644 --- a/docs/docs-ref-autogen/excel_1_6/toc.yml +++ b/docs/docs-ref-autogen/excel_1_6/toc.yml @@ -1230,6 +1230,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_7/toc.yml b/docs/docs-ref-autogen/excel_1_7/toc.yml index 3391f570ce..bec3699ada 100644 --- a/docs/docs-ref-autogen/excel_1_7/toc.yml +++ b/docs/docs-ref-autogen/excel_1_7/toc.yml @@ -1332,6 +1332,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_8/toc.yml b/docs/docs-ref-autogen/excel_1_8/toc.yml index 93e4e5a755..a9b2e150ed 100644 --- a/docs/docs-ref-autogen/excel_1_8/toc.yml +++ b/docs/docs-ref-autogen/excel_1_8/toc.yml @@ -1426,6 +1426,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_9/toc.yml b/docs/docs-ref-autogen/excel_1_9/toc.yml index ebdcf63076..3e7296dc5f 100644 --- a/docs/docs-ref-autogen/excel_1_9/toc.yml +++ b/docs/docs-ref-autogen/excel_1_9/toc.yml @@ -1667,6 +1667,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml index 0feb8ffdc8..d9c33a4065 100644 --- a/docs/docs-ref-autogen/excel_online/toc.yml +++ b/docs/docs-ref-autogen/excel_online/toc.yml @@ -2019,6 +2019,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml index 2009f68054..49ba3de8a1 100644 --- a/docs/docs-ref-autogen/onenote/toc.yml +++ b/docs/docs-ref-autogen/onenote/toc.yml @@ -989,6 +989,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index e1e6f54ab6..5f37a53bd1 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -1105,6 +1105,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index 994bc902c9..6c6d487638 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -961,6 +961,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index 59155ae64a..82bb94603c 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -1061,6 +1061,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index 05f10817df..8ab206c27c 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -1063,6 +1063,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index 755a56970a..6ba8b55c4f 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -1065,6 +1065,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index f1e7a35690..6c4b8dd892 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -1077,6 +1077,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index 586c5099d4..e4085071cc 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -1091,6 +1091,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_15/toc.yml b/docs/docs-ref-autogen/outlook_1_15/toc.yml index 59eca5c53c..b0c5929a56 100644 --- a/docs/docs-ref-autogen/outlook_1_15/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml @@ -1097,6 +1097,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index 7ab668f1ea..e9a2c77041 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -963,6 +963,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 9a143d5a52..1cefadcff0 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -971,6 +971,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 9a143d5a52..1cefadcff0 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -971,6 +971,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index e19a818fff..df2ca8fa0a 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -981,6 +981,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index e19a818fff..df2ca8fa0a 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -981,6 +981,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index df12289d7e..5275806acf 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -1011,6 +1011,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 6ec450ae30..21c7aefee6 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -1045,6 +1045,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.draganddropeventargs.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.draganddropeventargs.yml index ccb791c6ee..8846e1c531 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.draganddropeventargs.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.draganddropeventargs.yml @@ -18,6 +18,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.dragovereventdata.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.dragovereventdata.yml index 89ff94573f..9c8ea9616f 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.dragovereventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.dragovereventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.dropeventdata.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.dropeventdata.yml index 97f1a32391..af6d3ba506 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.dropeventdata.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.dropeventdata.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditemdetails.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditemdetails.yml index dea606db41..88d069cdb2 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditemdetails.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditemdetails.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditems.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditems.yml index a3730fd111..bfc22bdb20 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditems.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.droppeditems.yml @@ -17,6 +17,40 @@ remarks: >- add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items). + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml + + + function dragAndDropEventHandler(event) { + Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => { + console.log(`Event type: ${event.type}`); + + const eventData = event.dragAndDropEventData; + console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`); + + if (eventData.type == "drop") { + console.log("Items dropped into task pane."); + const files = eventData.dataTransfer.files; + files.forEach((file) => { + const content = file.fileContent; + const name = file.name; + const fileType = file.type; + console.log(`File name: ${name}`); + console.log(`File type: ${fileType}`); + console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`); + }); + } + }); + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 6ec450ae30..21c7aefee6 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -1045,6 +1045,10 @@ items: - name: WordApi online-only requirement set href: ../../requirement-sets/word/word-api-online-requirement-set.md displayName: Word + - name: WordApiDesktop 1.3 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.3-requirement-set.md + displayName: Word - name: WordApiDesktop 1.2 requirement set href: >- ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md diff --git a/docs/docs-ref-autogen/overview/overview.md b/docs/docs-ref-autogen/overview/overview.md index 3f77cd1d80..aa5674776f 100644 --- a/docs/docs-ref-autogen/overview/overview.md +++ b/docs/docs-ref-autogen/overview/overview.md @@ -3,7 +3,7 @@ ms.topic: landing-page title: Office JavaScript API reference description: The Office JavaScript APIs by host and version. ms.localizationpriority: high -ms.date: 09/17/2025 +ms.date: 09/30/2025 --- # Office Add-ins JavaScript API reference @@ -76,6 +76,7 @@ The following is a list of APIs for the [supported Office host applications](/of