diff --git a/docs/code-snippets/office-snippets.yaml b/docs/code-snippets/office-snippets.yaml index 9eb71feea..e528f1005 100644 --- a/docs/code-snippets/office-snippets.yaml +++ b/docs/code-snippets/office-snippets.yaml @@ -4428,6 +4428,20 @@ Office.Slice:interface: } } ); +Office.SlideRange:interface: + - |- + Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, (asyncResult) => { + if (asyncResult.status === Office.AsyncResultStatus.Succeeded) { + const slideRange: Office.SlideRange = asyncResult.value; + console.log(`Selected ${slideRange.slides.length} slide(s)`); + slideRange.slides.forEach(slide => { + console.log(`Slide ${slide.index}: ${slide.title} (ID: ${slide.id})`); + }); + } + else { + console.error(asyncResult.error.message); + } + }); Office.StartupBehavior:enum: - |- // Configure your add-in to load and start running when the document is opened. diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml index 6ae84e046..771d466c8 100644 --- a/docs/docs-ref-autogen/common/toc.yml +++ b/docs/docs-ref-autogen/common/toc.yml @@ -198,6 +198,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml index 6ae84e046..771d466c8 100644 --- a/docs/docs-ref-autogen/common_preview/toc.yml +++ b/docs/docs-ref-autogen/common_preview/toc.yml @@ -198,6 +198,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel/excel/excel.range.yml b/docs/docs-ref-autogen/excel/excel/excel.range.yml index dc4a6d8d9..1e3f10973 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.range.yml @@ -3852,7 +3852,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index d64fc0408..2462a51cc 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -1414,6 +1414,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_1/toc.yml b/docs/docs-ref-autogen/excel_1_1/toc.yml index 02672201e..6f9213a2d 100644 --- a/docs/docs-ref-autogen/excel_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_1_1/toc.yml @@ -340,6 +340,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_10/toc.yml b/docs/docs-ref-autogen/excel_1_10/toc.yml index 6b7daad97..28308b03e 100644 --- a/docs/docs-ref-autogen/excel_1_10/toc.yml +++ b/docs/docs-ref-autogen/excel_1_10/toc.yml @@ -1024,6 +1024,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml index 5e13a67cd..6c3e92856 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml @@ -2913,7 +2913,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_11/toc.yml b/docs/docs-ref-autogen/excel_1_11/toc.yml index 2011e27e3..17a6eef33 100644 --- a/docs/docs-ref-autogen/excel_1_11/toc.yml +++ b/docs/docs-ref-autogen/excel_1_11/toc.yml @@ -1036,6 +1036,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml index 8fb0de5b3..3eb9ad341 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml @@ -3196,7 +3196,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_12/toc.yml b/docs/docs-ref-autogen/excel_1_12/toc.yml index 42ce7a356..00ccf3322 100644 --- a/docs/docs-ref-autogen/excel_1_12/toc.yml +++ b/docs/docs-ref-autogen/excel_1_12/toc.yml @@ -1082,6 +1082,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml index a7ad0c630..21c0f2e1a 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml @@ -3501,7 +3501,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_13/toc.yml b/docs/docs-ref-autogen/excel_1_13/toc.yml index db201c9be..0738925f4 100644 --- a/docs/docs-ref-autogen/excel_1_13/toc.yml +++ b/docs/docs-ref-autogen/excel_1_13/toc.yml @@ -1092,6 +1092,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml index 6bb028f1c..ec3cf5b74 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml @@ -3553,7 +3553,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_14/toc.yml b/docs/docs-ref-autogen/excel_1_14/toc.yml index 39669c151..86b6e87a1 100644 --- a/docs/docs-ref-autogen/excel_1_14/toc.yml +++ b/docs/docs-ref-autogen/excel_1_14/toc.yml @@ -1110,6 +1110,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml index 94e3fdc85..b32e42ff8 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml @@ -3609,7 +3609,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_15/toc.yml b/docs/docs-ref-autogen/excel_1_15/toc.yml index 3d511559b..707a87767 100644 --- a/docs/docs-ref-autogen/excel_1_15/toc.yml +++ b/docs/docs-ref-autogen/excel_1_15/toc.yml @@ -1114,6 +1114,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml index 89a21a669..28c6224cd 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml @@ -3687,7 +3687,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_16/toc.yml b/docs/docs-ref-autogen/excel_1_16/toc.yml index cd14670a3..c99d2d68e 100644 --- a/docs/docs-ref-autogen/excel_1_16/toc.yml +++ b/docs/docs-ref-autogen/excel_1_16/toc.yml @@ -1244,6 +1244,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml index 89a21a669..28c6224cd 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml @@ -3687,7 +3687,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_17/toc.yml b/docs/docs-ref-autogen/excel_1_17/toc.yml index 983e836ca..f5db1edbe 100644 --- a/docs/docs-ref-autogen/excel_1_17/toc.yml +++ b/docs/docs-ref-autogen/excel_1_17/toc.yml @@ -1250,6 +1250,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml index b68e120e3..0fbdf2851 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml @@ -3780,7 +3780,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_18/toc.yml b/docs/docs-ref-autogen/excel_1_18/toc.yml index db187df96..92cf85a06 100644 --- a/docs/docs-ref-autogen/excel_1_18/toc.yml +++ b/docs/docs-ref-autogen/excel_1_18/toc.yml @@ -1268,6 +1268,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml index f7fd38f08..0c46a84dc 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml @@ -3813,7 +3813,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_19/toc.yml b/docs/docs-ref-autogen/excel_1_19/toc.yml index 7cecee09e..a29bad14f 100644 --- a/docs/docs-ref-autogen/excel_1_19/toc.yml +++ b/docs/docs-ref-autogen/excel_1_19/toc.yml @@ -1312,6 +1312,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_2/toc.yml b/docs/docs-ref-autogen/excel_1_2/toc.yml index 6f4cb60a4..21745d381 100644 --- a/docs/docs-ref-autogen/excel_1_2/toc.yml +++ b/docs/docs-ref-autogen/excel_1_2/toc.yml @@ -437,6 +437,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml index f7fd38f08..0c46a84dc 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml @@ -3813,7 +3813,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_20/toc.yml b/docs/docs-ref-autogen/excel_1_20/toc.yml index 0e738e859..4e0e7d6b8 100644 --- a/docs/docs-ref-autogen/excel_1_20/toc.yml +++ b/docs/docs-ref-autogen/excel_1_20/toc.yml @@ -1316,6 +1316,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_3/toc.yml b/docs/docs-ref-autogen/excel_1_3/toc.yml index bd61d40b4..e36a2ba09 100644 --- a/docs/docs-ref-autogen/excel_1_3/toc.yml +++ b/docs/docs-ref-autogen/excel_1_3/toc.yml @@ -445,6 +445,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_4/toc.yml b/docs/docs-ref-autogen/excel_1_4/toc.yml index 568d02742..6a683e0b9 100644 --- a/docs/docs-ref-autogen/excel_1_4/toc.yml +++ b/docs/docs-ref-autogen/excel_1_4/toc.yml @@ -453,6 +453,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_5/toc.yml b/docs/docs-ref-autogen/excel_1_5/toc.yml index 82420824f..22a91a4bf 100644 --- a/docs/docs-ref-autogen/excel_1_5/toc.yml +++ b/docs/docs-ref-autogen/excel_1_5/toc.yml @@ -461,6 +461,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_6/toc.yml b/docs/docs-ref-autogen/excel_1_6/toc.yml index 01414187f..7cbb7cd6a 100644 --- a/docs/docs-ref-autogen/excel_1_6/toc.yml +++ b/docs/docs-ref-autogen/excel_1_6/toc.yml @@ -543,6 +543,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_7/toc.yml b/docs/docs-ref-autogen/excel_1_7/toc.yml index b4b4801ca..221e88906 100644 --- a/docs/docs-ref-autogen/excel_1_7/toc.yml +++ b/docs/docs-ref-autogen/excel_1_7/toc.yml @@ -645,6 +645,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_8/toc.yml b/docs/docs-ref-autogen/excel_1_8/toc.yml index 29820d667..61a96c29b 100644 --- a/docs/docs-ref-autogen/excel_1_8/toc.yml +++ b/docs/docs-ref-autogen/excel_1_8/toc.yml @@ -739,6 +739,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_1_9/toc.yml b/docs/docs-ref-autogen/excel_1_9/toc.yml index 3e2e12052..a6637597e 100644 --- a/docs/docs-ref-autogen/excel_1_9/toc.yml +++ b/docs/docs-ref-autogen/excel_1_9/toc.yml @@ -980,6 +980,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_desktop_1_1/excel/excel.range.yml b/docs/docs-ref-autogen/excel_desktop_1_1/excel/excel.range.yml index 5d3823fd4..f781d4fa9 100644 --- a/docs/docs-ref-autogen/excel_desktop_1_1/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_desktop_1_1/excel/excel.range.yml @@ -3852,7 +3852,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml b/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml index 88afc822f..c6cd2e909 100644 --- a/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml @@ -1322,6 +1322,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml index f7fd38f08..0c46a84dc 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml @@ -3813,7 +3813,9 @@ methods: destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the - original range's area are not changed. + original range's area are not changed. Note: When a range is moved to a + new address using this API, the new range object should be retrieved using + the new address. remarks: >- \[ [API set: ExcelApi 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml index 200e84f5a..71c167178 100644 --- a/docs/docs-ref-autogen/excel_online/toc.yml +++ b/docs/docs-ref-autogen/excel_online/toc.yml @@ -1332,6 +1332,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/office/office.yml b/docs/docs-ref-autogen/office/office.yml index c58fc2e75..8b7b00263 100644 --- a/docs/docs-ref-autogen/office/office.yml +++ b/docs/docs-ref-autogen/office/office.yml @@ -66,6 +66,8 @@ interfaces: - office!Office.Settings:interface - office!Office.SettingsChangedEventArgs:interface - office!Office.Slice:interface + - office!Office.Slide:interface + - office!Office.SlideRange:interface - office!Office.Tab:interface - office!Office.TableBinding:interface - office!Office.TaskPane:interface diff --git a/docs/docs-ref-autogen/office/office/office.context.yml b/docs/docs-ref-autogen/office/office/office.context.yml index f6d232eab..92781f966 100644 --- a/docs/docs-ref-autogen/office/office/office.context.yml +++ b/docs/docs-ref-autogen/office/office/office.context.yml @@ -486,7 +486,7 @@ properties: // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } diff --git a/docs/docs-ref-autogen/office/office/office.document.yml b/docs/docs-ref-autogen/office/office/office.document.yml index 00d38c9f8..5f2b1bd5c 100644 --- a/docs/docs-ref-autogen/office/office/office.document.yml +++ b/docs/docs-ref-autogen/office/office/office.document.yml @@ -1928,33 +1928,15 @@ methods: **Requirement sets**: - - - [HtmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion) - (when using `Office.CoercionType.Html`) - - - - - [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) - (when using `Office.CoercionType.Matrix`) - - - - - [OoxmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion) - (when using `Office.CoercionType.Ooxml`) - - - [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) - - [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) - (when using `Office.CoercionType.Table`) + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) - - - [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) - (when using `Office.CoercionType.Text`) + **Supported applications**: Excel, PowerPoint, Project, Word In the callback function that is passed to the getSelectedDataAsync @@ -1963,10 +1945,10 @@ methods: - - + +
Property Use
AsyncResult.value Always returns - undefined because there's no object or data to retrieve.
AsyncResult.status Determine the - success or failure of the operation.
AsyncResult.value Access the selected data as a + string. If the selection does not contain text, returns an empty + string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.error Access an Error object that provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any @@ -1974,29 +1956,6 @@ methods:
- The possible values for the - [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary - by the Office application. - - - - - - - - - - - - - - - - -
CoercionType Supported - applications
Office.CoercionType.Html
  • Word
Office.CoercionType.Matrix (array of arrays)
  • Excel
  • Word
Office.CoercionType.Ooxml (Office Open XML)
  • Word
Office.CoercionType.SlideRange
  • PowerPoint
Office.CoercionType.Table (TableData object)
  • Excel
  • Word
Office.CoercionType.Text (string)
  • Excel
  • PowerPoint
  • Project
  • Word
Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
- - #### Examples @@ -2139,15 +2098,13 @@ methods: isDeprecated: false syntax: content: >- - getSelectedDataAsync(coercionType: Office.CoercionType, options?: - GetSelectedDataOptions, callback?: (result: AsyncResult) => void): - void; + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; parameters: - id: coercionType - description: >- - The type of data structure to return. See the Remarks section for - each application's supported coercion types. - type: + description: Must be `Office.CoercionType.Text`. + type: - id: options description: >- Provides options for customizing what data is returned and how it is @@ -2158,18 +2115,16 @@ methods: Optional. A function that is invoked when the callback returns, whose only parameter is of type [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is the data in the current - selection. This is returned in the data structure or format you - specified with the coercionType parameter. (See Remarks for more - information about data coercion.) + -->. The `value` property of the result is a string containing the + selected text. type: >- (result: <T>) => void + /><string>) => void return: type: void description: '' - name: getSelectedDataAsync(coercionType, callback) - uid: office!Office.Document#getSelectedDataAsync:member(2) + uid: office!Office.Document#getSelectedDataAsync:member(10) package: office! fullName: getSelectedDataAsync(coercionType, callback) summary: Reads the data contained in the current selection in the document. @@ -2206,14 +2161,37 @@ methods: (when using `Office.CoercionType.Text`) + The possible values for the + [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary + by the Office application. + + + + + + + + + + + + + + + + +
CoercionType Supported + applications
Office.CoercionType.Html
  • Word
Office.CoercionType.Matrix (array of arrays)
  • Excel
  • Word
Office.CoercionType.Ooxml (Office Open XML)
  • Word
Office.CoercionType.SlideRange
  • PowerPoint
Office.CoercionType.Table (TableData object)
  • Excel
  • Word
Office.CoercionType.Text (string)
  • Excel
  • PowerPoint
  • Project
  • Word
Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
+ + In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return the following information. - +
Property Use
AsyncResult.value Always returns - undefined because there's no object or data to retrieve.AsyncResult.value Access the selected data. The + type depends on the coercionType parameter specified in the call.
AsyncResult.status Determine the success or failure of the operation.
AsyncResult.error Access an Error object that @@ -2223,6 +2201,267 @@ methods:
+ For other coercion types or when the coercion type is not known at compile + time, use the generic version of this method and specify the type + parameter explicitly. + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: >- + The type of data structure to return. See the Remarks section for + each application's supported coercion types. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is the data in the current + selection. This is returned in the data structure or format you + specified with the coercionType parameter. (See Remarks for more + information about data coercion.) + type: >- + (result: <T>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(2) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + [Office.TableData](xref:office!Office.TableData:class) object. Returns + null if no table is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Table`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.TableData](xref:office!Office.TableData:class) object + containing the data in the current selection. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(3) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as an + array of arrays. Returns an empty array if no data is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Matrix`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is an array of arrays + containing the data in the current selection. + type: >- + (result: <any[][]>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(4) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement set**: + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + **Supported application**: PowerPoint + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected slides as + a [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, + options?: GetSelectedDataOptions, callback?: (result: + AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.SlideRange`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the selected slides. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(5) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [HtmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion) + (when using `Office.CoercionType.Html`) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + (when using `Office.CoercionType.Matrix`) + + + - + [OoxmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion) + (when using `Office.CoercionType.Ooxml`) + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + (when using `Office.CoercionType.Table`) + + + - + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) + (when using `Office.CoercionType.Text`) + + The possible values for the [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary by the Office application. @@ -2245,18 +2484,46 @@ methods: Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
+ + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data. The + type depends on the coercionType parameter specified in the call.
AsyncResult.status Determine the + success or failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + + For other coercion types or when the coercion type is not known at compile + time, use the generic version of this method and specify the type + parameter explicitly. + isPreview: false isDeprecated: false syntax: content: >- - getSelectedDataAsync(coercionType: Office.CoercionType, callback?: - (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => void): + void; parameters: - id: coercionType description: >- The type of data structure to return. See the Remarks section for each application's supported coercion types. type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: - id: callback description: >- Optional. A function that is invoked when the callback returns, @@ -2272,6 +2539,239 @@ methods: return: type: void description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(6) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) + + + **Supported applications**: Excel, PowerPoint, Project, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + string. If the selection does not contain text, returns an empty + string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Text`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a string containing the + selected text. + type: >- + (result: <string>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(7) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + [Office.TableData](xref:office!Office.TableData:class) object. Returns + null if no table is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Table`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.TableData](xref:office!Office.TableData:class) object + containing the data in the current selection. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(8) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as an + array of arrays. Returns an empty array if no data is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, + callback?: (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Matrix`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is an array of arrays + containing the data in the current selection. + type: >- + (result: <any[][]>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(9) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement set**: + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + **Supported application**: PowerPoint + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected slides as + a [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, + callback?: (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.SlideRange`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the selected slides. + type: >- + (result: <>) => void + return: + type: void + description: '' - name: getSelectedResourceAsync(options, callback) uid: office!Office.Document#getSelectedResourceAsync:member(1) package: office! diff --git a/docs/docs-ref-autogen/office/office/office.officetheme.yml b/docs/docs-ref-autogen/office/office/office.officetheme.yml index 8992a7af8..bc6c33dbc 100644 --- a/docs/docs-ref-autogen/office/office/office.officetheme.yml +++ b/docs/docs-ref-autogen/office/office/office.officetheme.yml @@ -63,7 +63,7 @@ remarks: >- // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } diff --git a/docs/docs-ref-autogen/office/office/office.slide.yml b/docs/docs-ref-autogen/office/office/office.slide.yml new file mode 100644 index 000000000..f364fe713 --- /dev/null +++ b/docs/docs-ref-autogen/office/office/office.slide.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Office.Slide +uid: office!Office.Slide:interface +package: office! +fullName: Office.Slide +summary: >- + Represents a single slide in a PowerPoint presentation. This interface is used + as part of the [Office.SlideRange](xref:office!Office.SlideRange:interface) + object returned by when called with + [Office.CoercionType.SlideRange](xref:office!Office.CoercionType.SlideRange:member). +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: office!Office.Slide#id:member + package: office! + fullName: id + summary: Gets the unique ID of the slide. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'id: number;' + return: + type: number + - name: index + uid: office!Office.Slide#index:member + package: office! + fullName: index + summary: Gets the 1-based index of the slide within the presentation. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'index: number;' + return: + type: number + - name: title + uid: office!Office.Slide#title:member + package: office! + fullName: title + summary: Gets the title of the slide. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/office/office/office.sliderange.yml b/docs/docs-ref-autogen/office/office/office.sliderange.yml new file mode 100644 index 000000000..7e9435dd7 --- /dev/null +++ b/docs/docs-ref-autogen/office/office/office.sliderange.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Office.SlideRange +uid: office!Office.SlideRange:interface +package: office! +fullName: Office.SlideRange +summary: >- + Represents the selected slides in a PowerPoint presentation. This object is + returned when calling with + [Office.CoercionType.SlideRange](xref:office!Office.CoercionType.SlideRange:member) + in PowerPoint. +remarks: >- + + + #### Examples + + + ```TypeScript + + Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, + (asyncResult) => { + if (asyncResult.status === Office.AsyncResultStatus.Succeeded) { + const slideRange: Office.SlideRange = asyncResult.value; + console.log(`Selected ${slideRange.slides.length} slide(s)`); + slideRange.slides.forEach(slide => { + console.log(`Slide ${slide.index}: ${slide.title} (ID: ${slide.id})`); + }); + } + else { + console.error(asyncResult.error.message); + } + }); + + ``` + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: slides + uid: office!Office.SlideRange#slides:member + package: office! + fullName: slides + summary: Gets an array of the selected slides. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'slides: Slide[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/office_release/office.yml b/docs/docs-ref-autogen/office_release/office.yml index c58fc2e75..8b7b00263 100644 --- a/docs/docs-ref-autogen/office_release/office.yml +++ b/docs/docs-ref-autogen/office_release/office.yml @@ -66,6 +66,8 @@ interfaces: - office!Office.Settings:interface - office!Office.SettingsChangedEventArgs:interface - office!Office.Slice:interface + - office!Office.Slide:interface + - office!Office.SlideRange:interface - office!Office.Tab:interface - office!Office.TableBinding:interface - office!Office.TaskPane:interface diff --git a/docs/docs-ref-autogen/office_release/office/office.context.yml b/docs/docs-ref-autogen/office_release/office/office.context.yml index b5e99ce9e..a95ed81f0 100644 --- a/docs/docs-ref-autogen/office_release/office/office.context.yml +++ b/docs/docs-ref-autogen/office_release/office/office.context.yml @@ -455,7 +455,7 @@ properties: // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } diff --git a/docs/docs-ref-autogen/office_release/office/office.document.yml b/docs/docs-ref-autogen/office_release/office/office.document.yml index bfa9dd260..4d75c58f7 100644 --- a/docs/docs-ref-autogen/office_release/office/office.document.yml +++ b/docs/docs-ref-autogen/office_release/office/office.document.yml @@ -1928,33 +1928,15 @@ methods: **Requirement sets**: - - - [HtmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion) - (when using `Office.CoercionType.Html`) - - - - - [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) - (when using `Office.CoercionType.Matrix`) - - - - - [OoxmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion) - (when using `Office.CoercionType.Ooxml`) - - - [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) - - [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) - (when using `Office.CoercionType.Table`) + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) - - - [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) - (when using `Office.CoercionType.Text`) + **Supported applications**: Excel, PowerPoint, Project, Word In the callback function that is passed to the getSelectedDataAsync @@ -1963,10 +1945,10 @@ methods: - - + +
Property Use
AsyncResult.value Always returns - undefined because there's no object or data to retrieve.
AsyncResult.status Determine the - success or failure of the operation.
AsyncResult.value Access the selected data as a + string. If the selection does not contain text, returns an empty + string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.error Access an Error object that provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any @@ -1974,29 +1956,6 @@ methods:
- The possible values for the - [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary - by the Office application. - - - - - - - - - - - - - - - - -
CoercionType Supported - applications
Office.CoercionType.Html
  • Word
Office.CoercionType.Matrix (array of arrays)
  • Excel
  • Word
Office.CoercionType.Ooxml (Office Open XML)
  • Word
Office.CoercionType.SlideRange
  • PowerPoint
Office.CoercionType.Table (TableData object)
  • Excel
  • Word
Office.CoercionType.Text (string)
  • Excel
  • PowerPoint
  • Project
  • Word
Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
- - #### Examples @@ -2139,15 +2098,13 @@ methods: isDeprecated: false syntax: content: >- - getSelectedDataAsync(coercionType: Office.CoercionType, options?: - GetSelectedDataOptions, callback?: (result: AsyncResult) => void): - void; + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; parameters: - id: coercionType - description: >- - The type of data structure to return. See the Remarks section for - each application's supported coercion types. - type: + description: Must be `Office.CoercionType.Text`. + type: - id: options description: >- Provides options for customizing what data is returned and how it is @@ -2158,18 +2115,16 @@ methods: Optional. A function that is invoked when the callback returns, whose only parameter is of type [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is the data in the current - selection. This is returned in the data structure or format you - specified with the coercionType parameter. (See Remarks for more - information about data coercion.) + -->. The `value` property of the result is a string containing the + selected text. type: >- (result: <T>) => void + /><string>) => void return: type: void description: '' - name: getSelectedDataAsync(coercionType, callback) - uid: office!Office.Document#getSelectedDataAsync:member(2) + uid: office!Office.Document#getSelectedDataAsync:member(10) package: office! fullName: getSelectedDataAsync(coercionType, callback) summary: Reads the data contained in the current selection in the document. @@ -2206,14 +2161,37 @@ methods: (when using `Office.CoercionType.Text`) + The possible values for the + [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary + by the Office application. + + + + + + + + + + + + + + + + +
CoercionType Supported + applications
Office.CoercionType.Html
  • Word
Office.CoercionType.Matrix (array of arrays)
  • Excel
  • Word
Office.CoercionType.Ooxml (Office Open XML)
  • Word
Office.CoercionType.SlideRange
  • PowerPoint
Office.CoercionType.Table (TableData object)
  • Excel
  • Word
Office.CoercionType.Text (string)
  • Excel
  • PowerPoint
  • Project
  • Word
Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
+ + In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return the following information. - +
Property Use
AsyncResult.value Always returns - undefined because there's no object or data to retrieve.AsyncResult.value Access the selected data. The + type depends on the coercionType parameter specified in the call.
AsyncResult.status Determine the success or failure of the operation.
AsyncResult.error Access an Error object that @@ -2223,6 +2201,267 @@ methods:
+ For other coercion types or when the coercion type is not known at compile + time, use the generic version of this method and specify the type + parameter explicitly. + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: >- + The type of data structure to return. See the Remarks section for + each application's supported coercion types. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is the data in the current + selection. This is returned in the data structure or format you + specified with the coercionType parameter. (See Remarks for more + information about data coercion.) + type: >- + (result: <T>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(2) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + [Office.TableData](xref:office!Office.TableData:class) object. Returns + null if no table is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Table`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.TableData](xref:office!Office.TableData:class) object + containing the data in the current selection. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(3) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as an + array of arrays. Returns an empty array if no data is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => + void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Matrix`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is an array of arrays + containing the data in the current selection. + type: >- + (result: <any[][]>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(4) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement set**: + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + **Supported application**: PowerPoint + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected slides as + a [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, + options?: GetSelectedDataOptions, callback?: (result: + AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.SlideRange`. + type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the selected slides. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, options, callback) + uid: office!Office.Document#getSelectedDataAsync:member(5) + package: office! + fullName: getSelectedDataAsync(coercionType, options, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [HtmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion) + (when using `Office.CoercionType.Html`) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + (when using `Office.CoercionType.Matrix`) + + + - + [OoxmlCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion) + (when using `Office.CoercionType.Ooxml`) + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + (when using `Office.CoercionType.Table`) + + + - + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) + (when using `Office.CoercionType.Text`) + + The possible values for the [Office.CoercionType](xref:office!Office.CoercionType:enum) parameter vary by the Office application. @@ -2245,18 +2484,46 @@ methods: Office.CoercionType.XmlSvg
  • Excel on Windows and on Mac
+ + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data. The + type depends on the coercionType parameter specified in the call.
AsyncResult.status Determine the + success or failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + + For other coercion types or when the coercion type is not known at compile + time, use the generic version of this method and specify the type + parameter explicitly. + isPreview: false isDeprecated: false syntax: content: >- - getSelectedDataAsync(coercionType: Office.CoercionType, callback?: - (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options?: + GetSelectedDataOptions, callback?: (result: AsyncResult) => void): + void; parameters: - id: coercionType description: >- The type of data structure to return. See the Remarks section for each application's supported coercion types. type: + - id: options + description: >- + Provides options for customizing what data is returned and how it is + formatted. + type: - id: callback description: >- Optional. A function that is invoked when the callback returns, @@ -2272,6 +2539,239 @@ methods: return: type: void description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(6) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TextCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion) + + + **Supported applications**: Excel, PowerPoint, Project, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + string. If the selection does not contain text, returns an empty + string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Text`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a string containing the + selected text. + type: >- + (result: <string>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(7) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [TableCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as a + [Office.TableData](xref:office!Office.TableData:class) object. Returns + null if no table is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: + (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Table`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.TableData](xref:office!Office.TableData:class) object + containing the data in the current selection. + type: >- + (result: <>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(8) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement sets**: + + + - + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + - + [MatrixCoercion](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion) + + + **Supported applications**: Excel, Word + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected data as an + array of arrays. Returns an empty array if no data is selected.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, + callback?: (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.Matrix`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is an array of arrays + containing the data in the current selection. + type: >- + (result: <any[][]>) => void + return: + type: void + description: '' + - name: getSelectedDataAsync(coercionType, callback) + uid: office!Office.Document#getSelectedDataAsync:member(9) + package: office! + fullName: getSelectedDataAsync(coercionType, callback) + summary: Reads the data contained in the current selection in the document. + remarks: >- + **Requirement set**: + [Selection](https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection) + + + **Supported application**: PowerPoint + + + In the callback function that is passed to the getSelectedDataAsync + method, you can use the properties of the AsyncResult object to return the + following information. + + + + + + + +
Property Use
AsyncResult.value Access the selected slides as + a [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status Determine the success or + failure of the operation.
AsyncResult.error Access an Error object that + provides error information if the operation failed.
AsyncResult.asyncContext Define an item of any + type that's returned in the AsyncResult object without being altered.
+ + isPreview: false + isDeprecated: false + syntax: + content: >- + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, + callback?: (result: AsyncResult) => void): void; + parameters: + - id: coercionType + description: Must be `Office.CoercionType.SlideRange`. + type: + - id: callback + description: >- + Optional. A function that is invoked when the callback returns, + whose only parameter is of type + [Office.AsyncResult](xref:office!Office.AsyncResult:interface). The `value` property of the result is a + [Office.SlideRange](xref:office!Office.SlideRange:interface) object + containing the selected slides. + type: >- + (result: <>) => void + return: + type: void + description: '' - name: getSelectedResourceAsync(options, callback) uid: office!Office.Document#getSelectedResourceAsync:member(1) package: office! diff --git a/docs/docs-ref-autogen/office_release/office/office.officetheme.yml b/docs/docs-ref-autogen/office_release/office/office.officetheme.yml index 8992a7af8..bc6c33dbc 100644 --- a/docs/docs-ref-autogen/office_release/office/office.officetheme.yml +++ b/docs/docs-ref-autogen/office_release/office/office.officetheme.yml @@ -63,7 +63,7 @@ remarks: >- // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } diff --git a/docs/docs-ref-autogen/office_release/office/office.slide.yml b/docs/docs-ref-autogen/office_release/office/office.slide.yml new file mode 100644 index 000000000..f364fe713 --- /dev/null +++ b/docs/docs-ref-autogen/office_release/office/office.slide.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Office.Slide +uid: office!Office.Slide:interface +package: office! +fullName: Office.Slide +summary: >- + Represents a single slide in a PowerPoint presentation. This interface is used + as part of the [Office.SlideRange](xref:office!Office.SlideRange:interface) + object returned by when called with + [Office.CoercionType.SlideRange](xref:office!Office.CoercionType.SlideRange:member). +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: office!Office.Slide#id:member + package: office! + fullName: id + summary: Gets the unique ID of the slide. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'id: number;' + return: + type: number + - name: index + uid: office!Office.Slide#index:member + package: office! + fullName: index + summary: Gets the 1-based index of the slide within the presentation. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'index: number;' + return: + type: number + - name: title + uid: office!Office.Slide#title:member + package: office! + fullName: title + summary: Gets the title of the slide. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/office_release/office/office.sliderange.yml b/docs/docs-ref-autogen/office_release/office/office.sliderange.yml new file mode 100644 index 000000000..7e9435dd7 --- /dev/null +++ b/docs/docs-ref-autogen/office_release/office/office.sliderange.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Office.SlideRange +uid: office!Office.SlideRange:interface +package: office! +fullName: Office.SlideRange +summary: >- + Represents the selected slides in a PowerPoint presentation. This object is + returned when calling with + [Office.CoercionType.SlideRange](xref:office!Office.CoercionType.SlideRange:member) + in PowerPoint. +remarks: >- + + + #### Examples + + + ```TypeScript + + Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, + (asyncResult) => { + if (asyncResult.status === Office.AsyncResultStatus.Succeeded) { + const slideRange: Office.SlideRange = asyncResult.value; + console.log(`Selected ${slideRange.slides.length} slide(s)`); + slideRange.slides.forEach(slide => { + console.log(`Slide ${slide.index}: ${slide.title} (ID: ${slide.id})`); + }); + } + else { + console.error(asyncResult.error.message); + } + }); + + ``` + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: slides + uid: office!Office.SlideRange#slides:member + package: office! + fullName: slides + summary: Gets an array of the selected slides. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'slides: Slide[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml index 540c78519..998a4b4bf 100644 --- a/docs/docs-ref-autogen/onenote/toc.yml +++ b/docs/docs-ref-autogen/onenote/toc.yml @@ -302,6 +302,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index 7606d10fc..cb8512383 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -430,6 +430,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index fa7d8c6e8..2ec16c64a 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -276,6 +276,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index 0a329d6b9..4758805f6 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -376,6 +376,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index c5da2a1fb..77ff75ea1 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -378,6 +378,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index 89e3dff33..749896051 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -380,6 +380,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index b201278d8..b7e5b7352 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -392,6 +392,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index 6dc8a8eb7..a437ab990 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -406,6 +406,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_15/toc.yml b/docs/docs-ref-autogen/outlook_1_15/toc.yml index 2d05b021e..9e660853c 100644 --- a/docs/docs-ref-autogen/outlook_1_15/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml @@ -412,6 +412,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index 91a40c0df..8a177a1d0 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -278,6 +278,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 1509f0160..5b114e387 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -286,6 +286,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 1509f0160..5b114e387 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -286,6 +286,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index 2f8786674..656a12a09 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -296,6 +296,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index 2f8786674..656a12a09 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -296,6 +296,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index 7a2b3aee0..34079d63d 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -326,6 +326,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 36a4c5cf0..00c317ee2 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -360,6 +360,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.recurrence.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.recurrence.yml index 2abe1064a..1793437c5 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.recurrence.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.recurrence.yml @@ -178,7 +178,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose #### Examples @@ -254,7 +254,7 @@ methods: **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + -->**: Compose isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 36a4c5cf0..00c317ee2 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -360,6 +360,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint/toc.yml b/docs/docs-ref-autogen/powerpoint/toc.yml index 84e46bbe6..03dca45d8 100644 --- a/docs/docs-ref-autogen/powerpoint/toc.yml +++ b/docs/docs-ref-autogen/powerpoint/toc.yml @@ -413,6 +413,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml index 4fe2a5d1b..ac3c4e390 100644 --- a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml @@ -210,6 +210,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_10/toc.yml b/docs/docs-ref-autogen/powerpoint_1_10/toc.yml index 84e46bbe6..03dca45d8 100644 --- a/docs/docs-ref-autogen/powerpoint_1_10/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_10/toc.yml @@ -413,6 +413,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml index a49bfde43..efc46bbe1 100644 --- a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml @@ -218,6 +218,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml index 2546dcf09..a1a486bc2 100644 --- a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml @@ -236,6 +236,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml index 38e21b0cd..6626cd262 100644 --- a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml @@ -272,6 +272,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml index 80eed02e7..e57ca3daa 100644 --- a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml @@ -276,6 +276,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml index 5fb8aa484..c976c0457 100644 --- a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml @@ -280,6 +280,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml index dc03daaf1..5ef98e29c 100644 --- a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml @@ -294,6 +294,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml index 2fdd12d14..41c9d4ddb 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml @@ -340,6 +340,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml index 55c4d1aae..b9ab3c91b 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml @@ -360,6 +360,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index 69ebd75b6..43fb86e2f 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -1162,6 +1162,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_1/toc.yml b/docs/docs-ref-autogen/word_1_1/toc.yml index 2eb5999c3..0496c4ce8 100644 --- a/docs/docs-ref-autogen/word_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_1_1/toc.yml @@ -252,6 +252,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_2/toc.yml b/docs/docs-ref-autogen/word_1_2/toc.yml index 2eb5999c3..0496c4ce8 100644 --- a/docs/docs-ref-autogen/word_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_1_2/toc.yml @@ -252,6 +252,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_3/toc.yml b/docs/docs-ref-autogen/word_1_3/toc.yml index 87c25f207..fce274055 100644 --- a/docs/docs-ref-autogen/word_1_3/toc.yml +++ b/docs/docs-ref-autogen/word_1_3/toc.yml @@ -308,6 +308,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml index 87c25f207..fce274055 100644 --- a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml @@ -308,6 +308,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_4/toc.yml b/docs/docs-ref-autogen/word_1_4/toc.yml index 916732a4c..eb10a7fd8 100644 --- a/docs/docs-ref-autogen/word_1_4/toc.yml +++ b/docs/docs-ref-autogen/word_1_4/toc.yml @@ -336,6 +336,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml index 916732a4c..eb10a7fd8 100644 --- a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml @@ -336,6 +336,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_5/toc.yml b/docs/docs-ref-autogen/word_1_5/toc.yml index 3cf9a5934..4a60dc45e 100644 --- a/docs/docs-ref-autogen/word_1_5/toc.yml +++ b/docs/docs-ref-autogen/word_1_5/toc.yml @@ -378,6 +378,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml index 3cf9a5934..4a60dc45e 100644 --- a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml @@ -378,6 +378,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_6/toc.yml b/docs/docs-ref-autogen/word_1_6/toc.yml index d78da52b1..90d6a4a0b 100644 --- a/docs/docs-ref-autogen/word_1_6/toc.yml +++ b/docs/docs-ref-autogen/word_1_6/toc.yml @@ -394,6 +394,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_7/toc.yml b/docs/docs-ref-autogen/word_1_7/toc.yml index 2fdec8554..84ce849f3 100644 --- a/docs/docs-ref-autogen/word_1_7/toc.yml +++ b/docs/docs-ref-autogen/word_1_7/toc.yml @@ -420,6 +420,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_8/toc.yml b/docs/docs-ref-autogen/word_1_8/toc.yml index 6a23fc0cc..ed5548950 100644 --- a/docs/docs-ref-autogen/word_1_8/toc.yml +++ b/docs/docs-ref-autogen/word_1_8/toc.yml @@ -424,6 +424,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_1_9/toc.yml b/docs/docs-ref-autogen/word_1_9/toc.yml index aed4d9486..6d46f8df0 100644 --- a/docs/docs-ref-autogen/word_1_9/toc.yml +++ b/docs/docs-ref-autogen/word_1_9/toc.yml @@ -432,6 +432,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml index d29832286..62f5e8cc0 100644 --- a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml @@ -450,6 +450,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml index e1460311e..ba0230a73 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml @@ -512,6 +512,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_desktop_1_3/toc.yml b/docs/docs-ref-autogen/word_desktop_1_3/toc.yml index 8921ab41e..5898bec94 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/toc.yml @@ -774,6 +774,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_desktop_1_4/toc.yml b/docs/docs-ref-autogen/word_desktop_1_4/toc.yml index e3aa64c11..765587b91 100644 --- a/docs/docs-ref-autogen/word_desktop_1_4/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_4/toc.yml @@ -1106,6 +1106,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/docs/docs-ref-autogen/word_online/toc.yml b/docs/docs-ref-autogen/word_online/toc.yml index aed4d9486..6d46f8df0 100644 --- a/docs/docs-ref-autogen/word_online/toc.yml +++ b/docs/docs-ref-autogen/word_online/toc.yml @@ -432,6 +432,10 @@ items: uid: office!Office.SettingsChangedEventArgs:interface - name: Slice uid: office!Office.Slice:interface + - name: Slide + uid: office!Office.Slide:interface + - name: SlideRange + uid: office!Office.SlideRange:interface - name: Tab uid: office!Office.Tab:interface - name: TableBinding diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 7ecb9ba85..b9e36ca25 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -5313,7 +5313,7 @@ excel,Excel.Range,"load(options)",Method,Excellent,false excel,Excel.Range,"load(propertyNames)",Method,Excellent,true excel,Excel.Range,"load(propertyNamesAndPaths)",Method,Excellent,false excel,Excel.Range,"merge(across)",Method,Fine,true -excel,Excel.Range,"moveTo(destinationRange)",Method,Great,true +excel,Excel.Range,"moveTo(destinationRange)",Method,Excellent,true excel,Excel.Range,"removeDuplicates(columns, includesHeader)",Method,Great,true excel,Excel.Range,"replaceAll(text, replacement, criteria)",Method,Excellent,false excel,Excel.Range,"select()",Method,Fine,true @@ -7370,6 +7370,14 @@ office,Office.Document,"getResourceFieldAsync(resourceId, fieldId, options, call office,Office.Document,"getResourceFieldAsync(resourceId, fieldId, callback)",Method,Good,true office,Office.Document,"getSelectedDataAsync(coercionType, options, callback)",Method,Fine,true office,Office.Document,"getSelectedDataAsync(coercionType, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, options, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, options, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, options, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, options, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, callback)",Method,Fine,false +office,Office.Document,"getSelectedDataAsync(coercionType, callback)",Method,Fine,false office,Office.Document,"getSelectedResourceAsync(options, callback)",Method,Fine,false office,Office.Document,"getSelectedResourceAsync(callback)",Method,Fine,true office,Office.Document,"getSelectedTaskAsync(options, callback)",Method,Fine,false @@ -8123,6 +8131,12 @@ office,Office.Slice,N/A,Interface,Great,true office,Office.Slice,"data",Property,Excellent,false office,Office.Slice,"index",Property,Poor,false office,Office.Slice,"size",Property,Poor,false +office,Office.Slide,N/A,Interface,Excellent,false +office,Office.Slide,"id",Property,Poor,false +office,Office.Slide,"index",Property,Good,false +office,Office.Slide,"title",Property,Poor,false +office,Office.SlideRange,N/A,Interface,Great,true +office,Office.SlideRange,"slides",Property,Fine,false office,Office.StartupBehavior,N/A,Enum,Great,true office,Office.StartupBehavior,"load",EnumField,Poor,false office,Office.StartupBehavior,"none",EnumField,Poor,false diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts index 910477c51..cac207ca0 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts @@ -4291,6 +4291,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts index 469973941..1333c2193 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts @@ -5248,6 +5248,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts index 0cda0598e..a29d80868 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts @@ -5437,6 +5437,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts index e9c4b9387..d8d755c51 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts @@ -5751,6 +5751,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts index f391e0e31..0f7370f73 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts @@ -5783,6 +5783,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts index 2c0a7df43..b2536a38b 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts @@ -12141,6 +12141,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts index befc5ea3f..194ad8fff 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts @@ -12314,6 +12314,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts index 563241567..aa3b8ee0b 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts @@ -12426,6 +12426,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts index 01d7d81ca..3468ab6d5 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts @@ -12801,6 +12801,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts index 7574f737d..16f259322 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts @@ -12809,6 +12809,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_Desktop_1_1/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_Desktop_1_1/excel.d.ts index c198ae8bc..508c0a010 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_Desktop_1_1/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_Desktop_1_1/excel.d.ts @@ -12912,6 +12912,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel-init.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel-init.d.ts index 53d515d9e..e367fc2ec 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel-init.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel-init.d.ts @@ -13398,6 +13398,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts index 05fad506a..ac52d6b5d 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts @@ -13295,6 +13295,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index bc1fecf81..957e13126 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -17120,6 +17120,7 @@ export declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/api-extractor-inputs-office-release/office.d.ts b/generate-docs/api-extractor-inputs-office-release/office.d.ts index 4e1519862..958e993dd 100644 --- a/generate-docs/api-extractor-inputs-office-release/office.d.ts +++ b/generate-docs/api-extractor-inputs-office-release/office.d.ts @@ -5916,17 +5916,58 @@ export declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Text`. + * + * @param options - Provides options for customizing what data is returned and how it is formatted. + * + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -5938,7 +5979,93 @@ export declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType - Must be `Office.CoercionType.Table`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Matrix`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -5954,6 +6081,31 @@ export declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType - Must be `Office.CoercionType.SlideRange`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -5991,10 +6143,37 @@ export declare namespace Office { * *
* - * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. * - * @param options - Provides options for customizing what data is returned and how it is formatted. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
* + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * + * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. + * @param options - Provides options for customizing what data is returned and how it is formatted. * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. * This is returned in the data structure or format you specified with the coercionType parameter. @@ -6008,17 +6187,55 @@ export declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Text`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -6030,7 +6247,91 @@ export declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType - Must be `Office.CoercionType.Table`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Matrix`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -6046,6 +6347,30 @@ export declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType - Must be `Office.CoercionType.SlideRange`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6083,6 +6408,35 @@ export declare namespace Office { * *
* + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. @@ -8578,6 +8932,36 @@ export declare namespace Office { */ rows: any[][]; } + /** + * Represents a single slide in a PowerPoint presentation. + * This interface is used as part of the {@link Office.SlideRange} object returned by + * {@link Office.Document.getSelectedDataAsync} when called with {@link Office.CoercionType.SlideRange}. + */ + export interface Slide { + /** + * Gets the unique ID of the slide. + */ + id: number; + /** + * Gets the title of the slide. + */ + title: string; + /** + * Gets the 1-based index of the slide within the presentation. + */ + index: number; + } + /** + * Represents the selected slides in a PowerPoint presentation. + * This object is returned when calling {@link Office.Document.getSelectedDataAsync} with {@link Office.CoercionType.SlideRange} in PowerPoint. + * + */ + export interface SlideRange { + /** + * Gets an array of the selected slides. + */ + slides: Slide[]; + } /** * Provides methods to manage the task pane of an add-in. * diff --git a/generate-docs/api-extractor-inputs-office/office.d.ts b/generate-docs/api-extractor-inputs-office/office.d.ts index a16f5f60c..5fabe577a 100644 --- a/generate-docs/api-extractor-inputs-office/office.d.ts +++ b/generate-docs/api-extractor-inputs-office/office.d.ts @@ -5926,17 +5926,58 @@ export declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Text`. + * + * @param options - Provides options for customizing what data is returned and how it is formatted. + * + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -5948,7 +5989,93 @@ export declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType - Must be `Office.CoercionType.Table`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Matrix`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -5964,6 +6091,31 @@ export declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType - Must be `Office.CoercionType.SlideRange`. + * @param options - Provides options for customizing what data is returned and how it is formatted. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6001,10 +6153,37 @@ export declare namespace Office { * *
* - * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. * - * @param options - Provides options for customizing what data is returned and how it is formatted. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
* + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * + * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. + * @param options - Provides options for customizing what data is returned and how it is formatted. * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. * This is returned in the data structure or format you specified with the coercionType parameter. @@ -6018,17 +6197,55 @@ export declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Text`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -6040,7 +6257,91 @@ export declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType - Must be `Office.CoercionType.Table`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType - Must be `Office.CoercionType.Matrix`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -6056,6 +6357,30 @@ export declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType - Must be `Office.CoercionType.SlideRange`. + * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6093,6 +6418,35 @@ export declare namespace Office { * *
* + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * * @param coercionType - The type of data structure to return. See the Remarks section for each application's supported coercion types. * @param callback - Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. @@ -8588,6 +8942,36 @@ export declare namespace Office { */ rows: any[][]; } + /** + * Represents a single slide in a PowerPoint presentation. + * This interface is used as part of the {@link Office.SlideRange} object returned by + * {@link Office.Document.getSelectedDataAsync} when called with {@link Office.CoercionType.SlideRange}. + */ + export interface Slide { + /** + * Gets the unique ID of the slide. + */ + id: number; + /** + * Gets the title of the slide. + */ + title: string; + /** + * Gets the 1-based index of the slide within the presentation. + */ + index: number; + } + /** + * Represents the selected slides in a PowerPoint presentation. + * This object is returned when calling {@link Office.Document.getSelectedDataAsync} with {@link Office.CoercionType.SlideRange} in PowerPoint. + * + */ + export interface SlideRange { + /** + * Gets an array of the selected slides. + */ + slides: Slide[]; + } /** * Provides methods to manage the task pane of an add-in. * diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts index 8ec5452ef..692b0e3f9 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts @@ -10957,7 +10957,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -10975,7 +10975,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts index 9dedb6f74..7a79c0fee 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts @@ -10981,7 +10981,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -10999,7 +10999,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts index 38829922e..9f48845d6 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts @@ -10981,7 +10981,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -10999,7 +10999,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts index 0a27d8666..a2437b40e 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts @@ -11265,7 +11265,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -11283,7 +11283,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts index f82a61e74..db8432839 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts @@ -11644,7 +11644,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -11662,7 +11662,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts index f582478b2..5c0188901 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts @@ -13669,7 +13669,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -13687,7 +13687,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts index b45767e79..bae136010 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts @@ -7578,7 +7578,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -7596,7 +7596,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts index a140c6ebd..4bfa6392f 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts @@ -9800,7 +9800,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -9818,7 +9818,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts index c9b215d84..2f7c946bc 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts @@ -10411,7 +10411,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -10429,7 +10429,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts index d4d0c567d..dc1f42c1c 100644 --- a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts @@ -14428,7 +14428,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -14446,7 +14446,7 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. diff --git a/generate-docs/script-inputs/local-repo-snippets.yaml b/generate-docs/script-inputs/local-repo-snippets.yaml index 0318ed4a2..107ee46aa 100644 --- a/generate-docs/script-inputs/local-repo-snippets.yaml +++ b/generate-docs/script-inputs/local-repo-snippets.yaml @@ -2788,7 +2788,7 @@ Office.Context#officeTheme:member: // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } @@ -4646,7 +4646,7 @@ Office.OfficeTheme:interface: // Apply theme colors to a CSS class. $("body").css("background-color", bodyBackgroundColor); - if (Office.context.officeTheme.isDarkTheme()) { + if (Office.context.officeTheme.isDarkTheme) { $("h1").css("color", controlForegroundColor); } } @@ -6046,6 +6046,20 @@ Office.Slice:interface: } } ); +Office.SlideRange:interface: + - |- + Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, (asyncResult) => { + if (asyncResult.status === Office.AsyncResultStatus.Succeeded) { + const slideRange: Office.SlideRange = asyncResult.value; + console.log(`Selected ${slideRange.slides.length} slide(s)`); + slideRange.slides.forEach(slide => { + console.log(`Slide ${slide.index}: ${slide.title} (ID: ${slide.id})`); + }); + } + else { + console.error(asyncResult.error.message); + } + }); Office.StartupBehavior:enum: - |- // Configure your add-in to load and start running when the document is opened. diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index c12de7600..64287982b 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -5921,17 +5921,58 @@ declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Text`. + * + * @param options Provides options for customizing what data is returned and how it is formatted. + * + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -5943,7 +5984,93 @@ declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType Must be `Office.CoercionType.Table`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Matrix`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -5959,6 +6086,31 @@ declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType Must be `Office.CoercionType.SlideRange`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -5996,10 +6148,37 @@ declare namespace Office { * *
* - * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. * - * @param options Provides options for customizing what data is returned and how it is formatted. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
* + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * + * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. + * @param options Provides options for customizing what data is returned and how it is formatted. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. * This is returned in the data structure or format you specified with the coercionType parameter. @@ -6013,17 +6192,55 @@ declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Text`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -6035,7 +6252,51 @@ declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType Must be `Office.CoercionType.Table`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -6051,6 +6312,70 @@ declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.status
* + * @param coercionType Must be `Office.CoercionType.Matrix`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.SlideRange`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6088,6 +6413,35 @@ declare namespace Office { * *
* + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. @@ -8583,6 +8937,36 @@ declare namespace Office { */ rows: any[][]; } + /** + * Represents a single slide in a PowerPoint presentation. + * This interface is used as part of the {@link Office.SlideRange} object returned by + * {@link Office.Document.getSelectedDataAsync} when called with {@link Office.CoercionType.SlideRange}. + */ + interface Slide { + /** + * Gets the unique ID of the slide. + */ + id: number; + /** + * Gets the title of the slide. + */ + title: string; + /** + * Gets the 1-based index of the slide within the presentation. + */ + index: number; + } + /** + * Represents the selected slides in a PowerPoint presentation. + * This object is returned when calling {@link Office.Document.getSelectedDataAsync} with {@link Office.CoercionType.SlideRange} in PowerPoint. + * + */ + interface SlideRange { + /** + * Gets an array of the selected slides. + */ + slides: Slide[]; + } /** * Provides methods to manage the task pane of an add-in. * @@ -22572,7 +22956,7 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -22590,7 +22974,7 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. @@ -38317,6 +38701,7 @@ declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11] diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index c4be01e34..2c572bce2 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -5931,17 +5931,58 @@ declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Text`. + * + * @param options Provides options for customizing what data is returned and how it is formatted. + * + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -5953,7 +5994,93 @@ declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType Must be `Office.CoercionType.Table`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Matrix`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -5969,6 +6096,31 @@ declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.status
* + * @param coercionType Must be `Office.CoercionType.SlideRange`. + * @param options Provides options for customizing what data is returned and how it is formatted. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6006,10 +6158,37 @@ declare namespace Office { * *
* - * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. * - * @param options Provides options for customizing what data is returned and how it is formatted. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
* + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * + * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. + * @param options Provides options for customizing what data is returned and how it is formatted. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. * This is returned in the data structure or format you specified with the coercionType parameter. @@ -6023,17 +6202,55 @@ declare namespace Office { * * **Requirement sets**: * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * **Supported applications**: Excel, PowerPoint, Project, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data as a string. If the selection does not contain text, returns an empty string.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.Text`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a string containing the selected text. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} * - * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * **Supported applications**: Excel, Word * * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return * the following information. @@ -6045,7 +6262,51 @@ declare namespace Office { * * * AsyncResult.value - * Always returns undefined because there's no object or data to retrieve. + * Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected. + * + * + * AsyncResult.status + * Determine the success or failure of the operation. + * + * + * AsyncResult.error + * Access an Error object that provides error information if the operation failed. + * + * + * AsyncResult.asyncContext + * Define an item of any type that's returned in the AsyncResult object without being altered. + * + * + * + * @param coercionType Must be `Office.CoercionType.Table`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} + * + * **Supported applications**: Excel, Word + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * * * * @@ -6061,6 +6322,70 @@ declare namespace Office { * *
PropertyUse
AsyncResult.valueAccess the selected data as an array of arrays. Returns an empty array if no data is selected.
AsyncResult.status
* + * @param coercionType Must be `Office.CoercionType.Matrix`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is an array of arrays containing the data in the current selection. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * **Supported application**: PowerPoint + * + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * @param coercionType Must be `Office.CoercionType.SlideRange`. + * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. + * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides. + */ + getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult) => void): void; + /** + * Reads the data contained in the current selection in the document. + * + * @remarks + * + * **Requirement sets**: + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection} + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`) + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`) + * * The possible values for the {@link Office.CoercionType} parameter vary by the Office application. * * @@ -6098,6 +6423,35 @@ declare namespace Office { * *
* + * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return + * the following information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse
AsyncResult.valueAccess the selected data. The type depends on the coercionType parameter specified in the call.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextDefine an item of any type that's returned in the AsyncResult object without being altered.
+ * + * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method + * and specify the type parameter explicitly. + * * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types. * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}. * The `value` property of the result is the data in the current selection. @@ -8593,6 +8947,36 @@ declare namespace Office { */ rows: any[][]; } + /** + * Represents a single slide in a PowerPoint presentation. + * This interface is used as part of the {@link Office.SlideRange} object returned by + * {@link Office.Document.getSelectedDataAsync} when called with {@link Office.CoercionType.SlideRange}. + */ + interface Slide { + /** + * Gets the unique ID of the slide. + */ + id: number; + /** + * Gets the title of the slide. + */ + title: string; + /** + * Gets the 1-based index of the slide within the presentation. + */ + index: number; + } + /** + * Represents the selected slides in a PowerPoint presentation. + * This object is returned when calling {@link Office.Document.getSelectedDataAsync} with {@link Office.CoercionType.SlideRange} in PowerPoint. + * + */ + interface SlideRange { + /** + * Gets an array of the selected slides. + */ + slides: Slide[]; + } /** * Provides methods to manage the task pane of an add-in. * @@ -23341,7 +23725,7 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. @@ -23359,7 +23743,7 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * - * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object. @@ -42822,6 +43206,7 @@ declare namespace Excel { /** * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + Note: When a range is moved to a new address using this API, the new range object should be retrieved using the new address. * * @remarks * [Api set: ExcelApi 1.11]