@types/office-js-preview 1.0.412 → 1.0.414

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Thu, 07 Sep 2023 21:03:10 GMT
+ * Last updated: Thu, 21 Sep 2023 17:06:04 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -8536,13 +8536,14 @@ declare namespace Office {
         /**
          * Specifies the category color.
          *
-         * **Note**: The actual color depends on how the Outlook client renders it.
-         * In this case, the colors noted on each preset are for the Outlook desktop client.
-         *
          * @remarks
          * [Api set: Mailbox 1.8]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
+         *
+         * **Important**: The actual color depends on how the Outlook client renders it.
+         * In this case, the colors noted on each preset apply to Outlook on Windows, on the web,
+         * and on Mac (starting in Version 16.78).
          */
         enum CategoryColor {
             /**
@@ -89320,11 +89321,11 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.1]
          *
-         * Note: The `contentControlType` parameter was introduced in WordApi 1.5.
+         * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support in currently in preview.
          *
-         * @param contentControlType Optional. The content control type. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
         /**
          * Inserts a document into the body at the specified location.
          *
@@ -89745,6 +89746,23 @@ declare namespace Word {
         */
         toJSON(): Word.Interfaces.BorderCollectionData;
     }
+    /**
+     * The data specific to content controls of type CheckBox.
+     *
+     * @remarks
+     * [Api set: WordApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    interface CheckboxContentControl {
+        /**
+         * Specifies the current state of the checkbox.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        isChecked: boolean;
+    }
     /**
      * Represents a comment in the document.
      *
@@ -90349,6 +90367,14 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          */
         cannotEdit: boolean;
+        /**
+         * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly checkboxContentControl: Word.CheckboxContentControl;
         /**
          * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
          *
@@ -90905,10 +90931,11 @@ declare namespace Word {
      */
     interface ContentControlOptions {
         /**
-         * An array of content control types, item must be 'RichText' or 'PlainText'.
+         * An array of content control types, item must be 'RichText', 'PlainText', or 'CheckBox'.
          *
          * @remarks
          * [Api set: WordApi 1.5]
+         * Note: `PlainText` support was added in WordApi 1.5. `CheckBox` support is currently in preview.
          */
         types: Word.ContentControlType[];
     }
@@ -91635,6 +91662,17 @@ declare namespace Word {
          * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'.
          */
         close(closeBehavior?: "Save" | "SkipSave"): void;
+        /**
+         * Displays revision marks that indicate where the specified document differs from another document.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param filePath Required. The path of the document with which the specified document is compared.
+         * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document.
+         */
+        compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
         /**
          * Deletes a bookmark, if it exists, from the document.
          *
@@ -94288,11 +94326,11 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.1]
          *
-         * Note: The `contentControlType` parameter was introduced in WordApi 1.5.
+         * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support is currently in preview.
          *
-         * @param contentControlType Optional. The content control type. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
         /**
          * Inserts a document into the paragraph at the specified location.
          *
@@ -95080,11 +95118,11 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.1]
          *
-         * Note: The `contentControlType` parameter was introduced in WordApi 1.5.
+         * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support is currently in preview.
          *
-         * @param contentControlType Optional. The content control type. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
         /**
          * Inserts an endnote. The endnote reference is placed after the range.
          *
@@ -95554,6 +95592,72 @@ declare namespace Word {
         */
         toJSON(): Word.Interfaces.SearchOptionsData;
     }
+    /**
+     * Specifies the options to be included in a compare document operation.
+     *
+     * @remarks
+     * [Api set: WordApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    interface DocumentCompareOptions {
+        /**
+         * True adds the document to the list of recently used files on the File menu. The default value is True.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        addToRecentFiles?: boolean;
+        /**
+         * The reviewer name associated with the differences generated by the comparison.
+                    If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        authorName?: string;
+        /**
+         * The target document for the comparison. Default value is 'CompareTargetCurrent'.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";
+        /**
+         * True (default) for the comparison to include detection of format changes.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        detectFormatChanges?: boolean;
+        /**
+         * True compares the documents without notifying a user of problems. The default value is False.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        ignoreAllComparisonWarnings?: boolean;
+        /**
+         * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        removeDateAndTime?: boolean;
+        /**
+         * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        removePersonalInformation?: boolean;
+    }
     /**
      * Represents a section in a Word document.
      *
@@ -102094,6 +102198,36 @@ declare namespace Word {
          */
         solid = "Solid",
     }
+    /**
+     * Specifies the target document for displaying document comparison differences.
+     *
+     * @remarks
+     * [Api set: WordApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    enum CompareTarget {
+        /**
+         * Places comparison differences in the current document.
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        compareTargetCurrent = "CompareTargetCurrent",
+        /**
+         * Places comparison differences in the target document.
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        compareTargetSelected = "CompareTargetSelected",
+        /**
+         * Places comparison differences in a new document.
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        compareTargetNew = "CompareTargetNew",
+    }
     enum ErrorCodes {
         accessDenied = "AccessDenied",
         generalException = "GeneralException",
@@ -103997,6 +104131,14 @@ declare namespace Word {
              * [Api set: WordApi 1.1]
              */
             cannotEdit?: boolean;
+            /**
+             * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            checkboxContentControl?: Word.CheckboxContentControl;
             /**
              * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
              *
@@ -106043,7 +106185,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies the line color for the border.
+             * For EACH ITEM in the collection: Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -106474,6 +106616,14 @@ declare namespace Word {
              * [Api set: WordApi 1.1]
              */
             cannotEdit?: boolean;
+            /**
+             * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            checkboxContentControl?: boolean;
             /**
              * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
              *
@@ -106640,6 +106790,14 @@ declare namespace Word {
              * [Api set: WordApi 1.1]
              */
             cannotEdit?: boolean;
+            /**
+             * For EACH ITEM in the collection: Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            checkboxContentControl?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
              *

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.412",
+    "version": "1.0.414",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "99d421aebb64aa661b5dff618299759c044238eb754cd0bae84e2ba4a466c94f",
-    "typeScriptVersion": "4.3"
+    "typesPublisherContentHash": "eeeb1c7f7227d9df8aa5427d0a157961312554f233650da1dc2dc6365f966a8f",
+    "typeScriptVersion": "4.5"
 }