Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Admin] Publish #2097

Merged
merged 3 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
[all hosts] Get latest (#2096)
* [all hosts] Get latest

* add to preview reqt. set page
  • Loading branch information
ElizabethSamuel-MSFT authored Oct 15, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 81fe0a57f4a9aaafebd4a86750d0e2ad59ed7eb2
22 changes: 22 additions & 0 deletions docs/docs-ref-autogen/word/word/word.document.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: '<xref uid="word!Word.DocumentCompareOptions:interface" />'
return:
type: void
description: ''
- name: deleteBookmark(name)
uid: 'word!Word.Document#deleteBookmark:member(1)'
package: word!
Expand Down
1 change: 1 addition & 0 deletions docs/includes/word-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.|
Expand Down
3 changes: 2 additions & 1 deletion docs/requirement-sets/word/word-preview-apis.md
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down Expand Up @@ -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.|
Expand Down
1 change: 1 addition & 0 deletions generate-docs/API Coverage Report.csv
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions generate-docs/api-extractor-inputs-word/word.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down
11 changes: 11 additions & 0 deletions generate-docs/script-inputs/office_preview.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down