Skip to content

Commit 81fe0a5

Browse files
[all hosts] Get latest (#2096)
* [all hosts] Get latest * add to preview reqt. set page
1 parent cd51bcd commit 81fe0a5

File tree

6 files changed

+48
-1
lines changed

6 files changed

+48
-1
lines changed

docs/docs-ref-autogen/word/word/word.document.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,28 @@ methods:
431431
return:
432432
type: void
433433
description: ''
434+
- name: 'compareFromBase64(base64File, documentCompareOptions)'
435+
uid: 'word!Word.Document#compareFromBase64:member(1)'
436+
package: word!
437+
fullName: 'compareFromBase64(base64File, documentCompareOptions)'
438+
summary: Displays revision marks that indicate where the specified document differs from another document.
439+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
440+
isPreview: true
441+
isDeprecated: false
442+
syntax:
443+
content: 'compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;'
444+
parameters:
445+
- id: base64File
446+
description: Required. The Base64-encoded content of the document with which the specified document is compared.
447+
type: string
448+
- id: documentCompareOptions
449+
description: >-
450+
Optional. The additional options that specify the behavior for comparing the documents. Note that the
451+
`compareTarget` option isn't allowed to be `CompareTargetSelected` in this API.
452+
type: '<xref uid="word!Word.DocumentCompareOptions:interface" />'
453+
return:
454+
type: void
455+
description: ''
434456
- name: deleteBookmark(name)
435457
uid: 'word!Word.Document#deleteBookmark:member(1)'
436458
package: word!

docs/includes/word-preview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.|
3838
||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.|
3939
|[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.|
40+
|[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.|
4041
|[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.|
4142
||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.|
4243
||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.|

docs/requirement-sets/word/word-preview-apis.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Word JavaScript preview APIs
33
description: Details about upcoming Word JavaScript APIs.
4-
ms.date: 09/05/2024
4+
ms.date: 10/15/2024
55
ms.topic: whats-new
66
ms.localizationpriority: medium
77
---
@@ -42,6 +42,7 @@ The following table lists the Word JavaScript APIs currently in preview, except
4242
|[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.|
4343
||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.|
4444
||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.|
45+
|[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.|
4546
|[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.|
4647
||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.|
4748
||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.|

generate-docs/API Coverage Report.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11090,6 +11090,7 @@ Word.Document,"addStyle(name, typeString)",Method,Fine,false
1109011090
Word.Document,"close(closeBehavior)",Method,Poor,true
1109111091
Word.Document,"close(closeBehaviorString)",Method,Poor,false
1109211092
Word.Document,"compare(filePath, documentCompareOptions)",Method,Fine,true
11093+
Word.Document,"compareFromBase64(base64File, documentCompareOptions)",Method,Fine,false
1109311094
Word.Document,"deleteBookmark(name)",Method,Poor,false
1109411095
Word.Document,"getAnnotationById(id)",Method,Poor,false
1109511096
Word.Document,"getBookmarkRange(name)",Method,Poor,false

generate-docs/api-extractor-inputs-word/word.d.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3326,6 +3326,17 @@ export declare namespace Word {
33263326
* @param documentCompareOptions - Optional. The additional options that specifies the behavior of comparing document.
33273327
*/
33283328
compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
3329+
/**
3330+
* Displays revision marks that indicate where the specified document differs from another document.
3331+
*
3332+
* @remarks
3333+
* [Api set: WordApi BETA (PREVIEW ONLY)]
3334+
* @beta
3335+
*
3336+
* @param base64File - Required. The Base64-encoded content of the document with which the specified document is compared.
3337+
* @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.
3338+
*/
3339+
compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
33293340
/**
33303341
* Deletes a bookmark, if it exists, from the document.
33313342
*

generate-docs/script-inputs/office_preview.d.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93579,6 +93579,17 @@ declare namespace Word {
9357993579
* @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document.
9358093580
*/
9358193581
compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
93582+
/**
93583+
* Displays revision marks that indicate where the specified document differs from another document.
93584+
*
93585+
* @remarks
93586+
* [Api set: WordApi BETA (PREVIEW ONLY)]
93587+
* @beta
93588+
*
93589+
* @param base64File Required. The Base64-encoded content of the document with which the specified document is compared.
93590+
* @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.
93591+
*/
93592+
compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
9358293593
/**
9358393594
* Deletes a bookmark, if it exists, from the document.
9358493595
*

0 commit comments

Comments
 (0)