diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index c0247519d9..bf4ea5a17d 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -431,6 +431,28 @@ methods: return: type: void description: '' + - name: 'compareFromBase64(base64File, documentCompareOptions)' + uid: 'word!Word.Document#compareFromBase64:member(1)' + package: word! + fullName: 'compareFromBase64(base64File, documentCompareOptions)' + summary: Displays revision marks that indicate where the specified document differs from another document. + remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;' + parameters: + - id: base64File + description: Required. The Base64-encoded content of the document with which the specified document is compared. + type: string + - id: documentCompareOptions + description: >- + Optional. The additional options that specify the behavior for comparing the documents. Note that the + `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + type: '' + return: + type: void + description: '' - name: deleteBookmark(name) uid: 'word!Word.Document#deleteBookmark:member(1)' package: word! diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index 6bfe01955a..b43d7b238b 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -37,6 +37,7 @@ ||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| ||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| |[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| +|[Document](/javascript/api/word/word.document)|[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| |[DropDownListContentControl](/javascript/api/word/word.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| ||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| ||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| diff --git a/docs/requirement-sets/common/dialog-api-requirement-sets.md b/docs/requirement-sets/common/dialog-api-requirement-sets.md index 353ed3cc2f..64d796b5aa 100644 --- a/docs/requirement-sets/common/dialog-api-requirement-sets.md +++ b/docs/requirement-sets/common/dialog-api-requirement-sets.md @@ -1,7 +1,7 @@ --- title: Dialog API requirement sets description: Learn more about the Dialog API requirement sets. -ms.date: 10/08/2024 +ms.date: 10/17/2024 ms.topic: overview ms.localizationpriority: medium --- @@ -12,13 +12,15 @@ Requirement sets are named groups of API members. Office Add-ins use requirement Office Add-ins run across multiple versions of Office. The following table lists the Dialog API requirement sets, the supported Office client applications, and the **minimum** builds or versions for those applications where applicable. -| Requirement set | Office on the web | Office on Windows
(Microsoft 365 subscription) | Office on Windows\*
(retail perpetual) | Office on Windows\*
(volume-licensed perpetual) | Office on Mac | Office on iPad | Office Online Server | +| Requirement set | Office on the web | Office on Windows
(Microsoft 365 subscription) | Office on Windows1
(retail perpetual) | Office on Windows1
(volume-licensed perpetual) | Office on Mac | Office on iPad | Office Online Server | |:-----|:-----|:-----|:-----|:-----|:-----|:-----|:-----| | DialogApi 1.2 | Supported | See [support](#office-on-windows-microsoft-365-subscription-support)
[section](#office-on-windows-microsoft-365-subscription-support) | Version 2005 (Build 12827.20268) | Office 2021: Version 2005 (Build 12827.20268) | Version 16.37 (20051002) | Version 16.37 | Not supported | -| DialogApi 1.1 | Supported | Version 1602 (Build 6741.0000) | Version 1602 (Build 6741.0000) | Office 2016 | Version 15.20 | Version 1.22 | Version 1608 (Build 7601.6800) | +| DialogApi 1.1 | Supported | Version 1602 (Build 6741.0000) | Version 1602 (Build 6741.0000) | Office 20162 | Version 15.20 | Version 1.22 | Version 1608 (Build 7601.6800) | > [!NOTE] -> \* Users of perpetual versions of Office may not have accepted all patches and updates. If so, the DLL that Office uses to report its version in the UI may be greater than the versions listed here even if the updated DLLs needed to support DialogApi haven't been installed on the user's computer. To ensure that the needed patch is installed, the user must go to the [Office 2016 update list](/officeupdates/msp-files-office-2016), search for **osfclient-x-none**, and install the listed patch. +> 1Users of perpetual versions of Office may not have accepted all patches and updates. If so, the DLL that Office uses to report its version in the UI may be greater than the versions listed here even if the updated DLLs needed to support DialogApi haven't been installed on the user's computer. To ensure that the needed patch is installed, the user must go to the [Office 2016 update list](/officeupdates/msp-files-office-2016), search for **osfclient-x-none**, and install the listed patch. +> +> 2 DialogApi 1.1 isn't supported in Outlook 2016 (volume-licensed perpetual). ## Office on Windows (Microsoft 365 subscription) support diff --git a/docs/requirement-sets/excel/excel-api-requirement-sets.md b/docs/requirement-sets/excel/excel-api-requirement-sets.md index d0bc8b02b4..09a55d24ed 100644 --- a/docs/requirement-sets/excel/excel-api-requirement-sets.md +++ b/docs/requirement-sets/excel/excel-api-requirement-sets.md @@ -1,7 +1,7 @@ --- title: Excel JavaScript API requirement sets description: Office Add-in requirement set information for Excel builds. -ms.date: 10/03/2024 +ms.date: 10/17/2024 ms.topic: overview ms.localizationpriority: high --- @@ -23,9 +23,9 @@ Excel add-ins run across multiple versions of Office, including Office 2016 or l |:-----|:-----|:-----|:-----|:-----|:-----| | [Preview](excel-preview-apis.md) | Please use the latest Office version to try preview APIs (you may need to join the [Microsoft 365 Insider program](https://insider.microsoft365.com/join)). | | [ExcelApiOnline](excel-api-online-requirement-set.md) | Latest (see [requirement set page](excel-api-online-requirement-set.md)) | Not applicable | Not applicable | Not applicable | Not applicable | -| [ExcelApi 1.17](excel-api-1-17-requirement-set.md) | Supported | Version 2302 (Build 16130.20332) | Not available | Version 16.70 (23021201) | Version 16.70 | -| [ExcelApi 1.16](excel-api-1-16-requirement-set.md) | Supported | Version 2208 (Build 15601.20148) | Not available | Version 16.64 (22081401) | Version 16.66 | -| [ExcelApi 1.15](excel-api-1-15-requirement-set.md) | Supported | Version 2202 (Build 14931.20132) | Not available | Version 16.58 (22021501) | Version 16.59 | +| [ExcelApi 1.17](excel-api-1-17-requirement-set.md) | Supported | Version 2302 (Build 16130.20332) | Office 2024: Version 2302 (Build 16130.20332) | Version 16.70 (23021201) | Version 16.70 | +| [ExcelApi 1.16](excel-api-1-16-requirement-set.md) | Supported | Version 2208 (Build 15601.20148) | Office 2024: Version 2208 (Build 15601.20148) | Version 16.64 (22081401) | Version 16.66 | +| [ExcelApi 1.15](excel-api-1-15-requirement-set.md) | Supported | Version 2202 (Build 14931.20132) | Office 2024: Version 2202 (Build 14931.20132) | Version 16.58 (22021501) | Version 16.59 | | [ExcelApi 1.14](excel-api-1-14-requirement-set.md) | Supported | Version 2108 (Build 14326.20508) | Office 2021: Version 2108 (Build 14326.20508) | Version 16.52 (21080801) | Version 16.53 | | [ExcelApi 1.13](excel-api-1-13-requirement-set.md) | Supported | Version 2102 (Build 13801.20738) | Office 2021: Version 2102 (Build 13801.20738) | Version 16.50 (21061301) | Version 16.50 | | [ExcelApi 1.12](excel-api-1-12-requirement-set.md) | Supported | Version 2008 (Build 13127.20408) | Office 2021: Version 2008 (Build 13127.20408) | Version 16.40 (20081000) | Version 16.40 | diff --git a/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md b/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md index 98598a6973..9e2264b483 100644 --- a/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md +++ b/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md @@ -1,7 +1,7 @@ --- title: PowerPoint JavaScript API requirement sets description: Learn more about the PowerPoint JavaScript API requirement sets. -ms.date: 04/15/2024 +ms.date: 10/17/2024 ms.topic: overview ms.localizationpriority: high --- @@ -15,9 +15,9 @@ The following table lists the PowerPoint requirement sets, the supported Office | Requirement set | Office on the web | Office on Windows | Office on Windows | Office on Mac | Office on iPad | |:-----|:-----|:-----|:-----|:-----|:-----| | [Preview](powerpoint-preview-apis.md) | Please use the latest Office version to try preview APIs (you may need to join the [Microsoft 365 Insider program](https://insider.microsoft365.com/join)). | -| [PowerPointApi 1.5](powerpoint-api-1-5-requirement-set.md) | Supported | Version 2208 (Build 15601.20230) | Not available | Version 16.64 (22080400) | Not available | -| [PowerPointApi 1.4](powerpoint-api-1-4-requirement-set.md) | Supported | Version 2207 (Build 15330.20122) | Not available | Version 16.62 (22061100) | Not available | -| [PowerPointApi 1.3](powerpoint-api-1-3-requirement-set.md) | Supported | Version 2111 (Build 14701.20060) | Not available | Version 16.55 (21111400) | Not available | +| [PowerPointApi 1.5](powerpoint-api-1-5-requirement-set.md) | Supported | Version 2208 (Build 15601.20230) | Office 2024: Version 2208 (Build 15601.20230) | Version 16.64 (22080400) | Not available | +| [PowerPointApi 1.4](powerpoint-api-1-4-requirement-set.md) | Supported | Version 2207 (Build 15330.20122) | Office 2024: Version 2207 (Build 15330.20122) | Version 16.62 (22061100) | Not available | +| [PowerPointApi 1.3](powerpoint-api-1-3-requirement-set.md) | Supported | Version 2111 (Build 14701.20060) | Office 2024: Version 2111 (Build 14701.20060) | Version 16.55 (21111400) | Not available | | [PowerPointApi 1.2](powerpoint-api-1-2-requirement-set.md) | Supported | Version 2011 (Build 13426.20184) | Office 2021: Version 2011 (Build 13426.20184) | Version 16.43 (20110804) | Not available | | [PowerPointApi 1.1](powerpoint-api-1-1-requirement-set.md) | Supported | Version 1810 (Build 11001.20074) | Office 2021: Version 1810 (Build 11001.20074) | Version 16.19 (18110915) | Version 2.17 | diff --git a/docs/requirement-sets/requirement-sets.md b/docs/requirement-sets/requirement-sets.md index 060330e1ca..e50bbbf43a 100644 --- a/docs/requirement-sets/requirement-sets.md +++ b/docs/requirement-sets/requirement-sets.md @@ -1,7 +1,7 @@ --- title: Office client application and platform availability for Office Add-ins description: Supported requirement sets for Excel, OneNote, Outlook, PowerPoint, Project, and Word. -ms.date: 10/08/2024 +ms.date: 10/17/2024 ms.topic: overview ms.localizationpriority: high --- @@ -20,13 +20,14 @@ To work as expected, your Office Add-in might depend on a specific Office applic |Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)| |---|---|---|---| -|Office on the web|||| -|Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
  • |||| -|Office 2021 on Windows
    (volume-licensed perpetual)|||| -|Office 2019 on Windows
    (volume-licensed perpetual)|||| -|Office 2016 on Windows
    (volume-licensed perpetual)|||| -|Office on Mac|||| -|Office on iPad
    (Microsoft 365 subscription)|||| +|Office on the web|||| +|Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
  • |||| +|Office 2024 on Windows
    (volume-licensed perpetual)|||| +|Office 2021 on Windows
    (volume-licensed perpetual)|||| +|Office 2019 on Windows
    (volume-licensed perpetual)|||| +|Office 2016 on Windows
    (volume-licensed perpetual)|||| +|Office on Mac|||| +|Office on iPad
    (Microsoft 365 subscription)|||| ** Added with post-release updates.* @@ -36,6 +37,7 @@ To work as expected, your Office Add-in might depend on a specific Office applic |---|---|---|---| |Office on the web|||Not applicable| |Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
  • ||||| +|Office 2024 on Windows
    (volume-licensed perpetual)|||| +|Office 2021 on Windows
    (volume-licensed perpetual)|||| +|Office 2019 on Windows
    (volume-licensed perpetual)|||| +|Office 2016 on Windows
    (volume-licensed perpetual)|||| +|Office on Mac|||| +|Office on iPad
    (Microsoft 365 subscription)|||| ** Added with post-release updates.* @@ -91,12 +95,13 @@ To work as expected, your Office Add-in might depend on a specific Office applic |Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)| |---|---|---|---| -|Office on the web|||| -|Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
  • |||| -|Office 2021 on Windows
    (volume-licensed perpetual)|||| -|Office 2019 on Windows
    (volume-licensed perpetual)||Not available|| -|Office 2016 on Windows
    (volume-licensed perpetual)||Not available|| -|Office on Mac|||| +|Office on the web|||| +|Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
  • |||| +|Office 2024 on Windows
    (volume-licensed perpetual)|||| +|Office 2021 on Windows
    (volume-licensed perpetual)|||| +|Office 2019 on Windows
    (volume-licensed perpetual)||Not available|| +|Office 2016 on Windows
    (volume-licensed perpetual)||Not available|| +|Office on Mac|||| ** Added with post-release updates.* @@ -104,15 +109,16 @@ To work as expected, your Office Add-in might depend on a specific Office applic |Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)| |---|---|---|---| -|Office on the web|||| +|Office on the web|||| ## Project |Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)| |---|---|---|---| -|Office 2021 on Windows
    (volume-licensed perpetual)||Not available|| -|Office 2019 on Windows
    (volume-licensed perpetual)||Not available|| -|Office 2016 on Windows
    (volume-licensed perpetual)||Not available|| +|Office 2024 on Windows
    (volume-licensed perpetual)||Not available|| +|Office 2021 on Windows
    (volume-licensed perpetual)||Not available|| +|Office 2019 on Windows
    (volume-licensed perpetual)||Not available|| +|Office 2016 on Windows
    (volume-licensed perpetual)||Not available|| ## See also diff --git a/docs/requirement-sets/word/word-api-requirement-sets.md b/docs/requirement-sets/word/word-api-requirement-sets.md index 902edca579..f09aa27038 100644 --- a/docs/requirement-sets/word/word-api-requirement-sets.md +++ b/docs/requirement-sets/word/word-api-requirement-sets.md @@ -1,7 +1,7 @@ --- title: Word JavaScript API requirement sets description: Office Add-in requirement set information for Word. -ms.date: 10/03/2024 +ms.date: 10/17/2024 ms.topic: overview ms.localizationpriority: high --- @@ -23,15 +23,15 @@ Word add-ins run across multiple versions of Office, including Office 2016 or la |:-----|:-----|:-----|:-----|:-----|:-----| | [Preview](word-preview-apis.md) | Please use the latest Office version to try preview APIs (you may need to join the [Microsoft 365 Insider program](https://insider.microsoft365.com/join)) | | [WordApiOnline 1.1](word-api-online-requirement-set.md) | Latest (see [requirement set page](word-api-online-requirement-set.md)) | Not applicable | Not applicable | Not applicable | Not applicable | -| [WordApiDesktop 1.1](word-api-desktop-1.1-requirement-set.md) | Not applicable | Version 2408 (Build 17928.20114) | Not available | Version 16.88 (24081116) | Version 16.88 | +| [WordApiDesktop 1.1](word-api-desktop-1.1-requirement-set.md) | Not applicable | Version 2408 (Build 17928.20114) | Office 2024: Version 2408 (Build 17928.20114) | Version 16.88 (24081116) | Version 16.88 | | [WordApiHiddenDocument 1.5](word-api-1.5-hidden-document-requirement-set.md) (Desktop only) | Not applicable | Version 2302 (Build 16130.20332) | Not available | Version 16.70 (23021201) | Not applicable | | [WordApiHiddenDocument 1.4](word-api-1.4-hidden-document-requirement-set.md) (Desktop only) | Not applicable | Version 2208 (Build 15601.20148) | Not available | Version 16.64 (22081401) | Not applicable | | [WordApiHiddenDocument 1.3](word-api-1.3-hidden-document-requirement-set.md) (Desktop only) | Not applicable | Version 1612 (Build 7668.1000) | Office 2019: Version 1612 (Build 7668.1000) | Version 15.32 (17030901) | Not applicable | -| [WordApi 1.8](word-api-1-8-requirement-set.md) | Supported | Version 2405 (Build 17628.20110) | Not available | Version 16.85 (24051214) | Version 16.85 | -| [WordApi 1.7](word-api-1-7-requirement-set.md) | Supported | Version 2311 (Build 17029.20068) | Not available | Version 16.79 (23111019) | Version 16.79 | -| [WordApi 1.6](word-api-1-6-requirement-set.md) | Supported | Version 2308 (Build 16731.20234) | Not available | Version 16.76 (23081101) | Version 16.76 | -| [WordApi 1.5](word-api-1-5-requirement-set.md) | Supported | Version 2302 (Build 16130.20332) | Not available | Version 16.70 (23021201) | Version 16.70 | -| [WordApi 1.4](word-api-1-4-requirement-set.md) | Supported | Version 2208 (Build 15601.20148) | Not available | Version 16.64 (22081401) | Version 16.64 | +| [WordApi 1.8](word-api-1-8-requirement-set.md) | Supported | Version 2405 (Build 17628.20110) | Office 2024: Version 2405 (Build 17628.20110) | Version 16.85 (24051214) | Version 16.85 | +| [WordApi 1.7](word-api-1-7-requirement-set.md) | Supported | Version 2311 (Build 17029.20068) | Office 2024: Version 2311 (Build 17029.20068) | Version 16.79 (23111019) | Version 16.79 | +| [WordApi 1.6](word-api-1-6-requirement-set.md) | Supported | Version 2308 (Build 16731.20234) | Office 2024: Version 2308 (Build 16731.20234) | Version 16.76 (23081101) | Version 16.76 | +| [WordApi 1.5](word-api-1-5-requirement-set.md) | Supported | Version 2302 (Build 16130.20332) | Office 2024: Version 2302 (Build 16130.20332) | Version 16.70 (23021201) | Version 16.70 | +| [WordApi 1.4](word-api-1-4-requirement-set.md) | Supported | Version 2208 (Build 15601.20148) | Office 2024: Version 2208 (Build 15601.20148) | Version 16.64 (22081401) | Version 16.64 | | [WordApi 1.3](word-api-1-3-requirement-set.md) | Supported | Version 1612 (Build 7668.1000) | Office 2019: Version 1612 (Build 7668.1000) | Version 15.32 (17030901) | Version 2.22 | | [WordApi 1.2](word-api-1-2-requirement-set.md) | Supported | Version 1601 (Build 6568.1000) | Office 2019: Version 1601 (Build 6568.1000) | Version 15.19 | Version 1.18 | | [WordApi 1.1](word-api-1-1-requirement-set.md) | Supported | Version 1509 (Build 4266.1001) | Office 2016: Version 1509 (Build 4266.1001) | Version 15.19 | Version 1.18 | diff --git a/docs/requirement-sets/word/word-preview-apis.md b/docs/requirement-sets/word/word-preview-apis.md index cf8a246010..10c0141e42 100644 --- a/docs/requirement-sets/word/word-preview-apis.md +++ b/docs/requirement-sets/word/word-preview-apis.md @@ -1,7 +1,7 @@ --- title: Word JavaScript preview APIs description: Details about upcoming Word JavaScript APIs. -ms.date: 09/05/2024 +ms.date: 10/15/2024 ms.topic: whats-new ms.localizationpriority: medium --- @@ -42,6 +42,7 @@ The following table lists the Word JavaScript APIs currently in preview, except |[ContentControlListItemCollection](/javascript/api/word/word.contentcontrollistitemcollection)|[getFirst()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirst-member(1))|Gets the first list item in this collection.| ||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| ||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/javascript/api/word/word.document)|[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| |[DropDownListContentControl](/javascript/api/word/word.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| ||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| ||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 4417c21284..11fd001610 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -11090,6 +11090,7 @@ Word.Document,"addStyle(name, typeString)",Method,Fine,false Word.Document,"close(closeBehavior)",Method,Poor,true Word.Document,"close(closeBehaviorString)",Method,Poor,false Word.Document,"compare(filePath, documentCompareOptions)",Method,Fine,true +Word.Document,"compareFromBase64(base64File, documentCompareOptions)",Method,Fine,false Word.Document,"deleteBookmark(name)",Method,Poor,false Word.Document,"getAnnotationById(id)",Method,Poor,false Word.Document,"getBookmarkRange(name)",Method,Poor,false diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index cac220022b..f694d82cd5 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -3326,6 +3326,17 @@ export declare namespace Word { * @param documentCompareOptions - Optional. The additional options that specifies the behavior of comparing document. */ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + /** + * Displays revision marks that indicate where the specified document differs from another document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param base64File - Required. The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions - Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + */ + compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** * Deletes a bookmark, if it exists, from the document. * diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 961582b49c..38a5fa92db 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -93579,6 +93579,17 @@ declare namespace Word { * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. */ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + /** + * Displays revision marks that indicate where the specified document differs from another document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param base64File Required. The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + */ + compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** * Deletes a bookmark, if it exists, from the document. * diff --git a/generate-docs/scripts/util.ts b/generate-docs/scripts/util.ts index 14ba420960..e43bbcd254 100644 --- a/generate-docs/scripts/util.ts +++ b/generate-docs/scripts/util.ts @@ -71,7 +71,7 @@ export function stripSpaces(text: string) { // Replace each tab with 4 spaces. for (let i: number = 0; i < lines.length; i++) { - lines[i].replace('\t', ' '); + lines[i].replace(/\t/g, ' '); } let isZeroLengthLine: boolean = true;