@types/office-js-preview 1.0.477 → 1.0.479

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Mon, 10 Jun 2024 15:07:29 GMT
+ * Last updated: Thu, 20 Jun 2024 16:08:33 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -3072,6 +3072,30 @@ declare namespace Office {
          */
         Headers
     }
+    /**
+     * Specifies the Office theme that's currently selected.
+     *
+     * For information on Office themes, see
+     * {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
+     */
+    enum ThemeId {
+        /**
+         * The currently selected Office theme is **Black**.
+         */
+        Black,
+        /**
+         * The currently selected Office theme is **Colorful**.
+         */
+        Colorful,
+        /**
+         * The currently selected Office theme is **Dark Gray**.
+         */
+        DarkGray,
+        /**
+         * The currently selected Office theme is **White**.
+         */
+        White
+    }
     /**
      * Specifies whether values, such as numbers and dates, returned by the invoked method are returned with their formatting applied.
      *
@@ -6989,10 +7013,14 @@ declare namespace Office {
     /**
      * Provides access to the properties for Office theme colors.
      *
-     * Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with **File** \>
-     * **Office Account** \> **Office Theme UI**, which is applied across all Office applications. Using Office theme colors is appropriate for mail and
+     * Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
+     * The user sets a theme in an Office application through **File** \> **Account** or **Office Account** \> **Office Theme**.
+     * The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
      * task pane add-ins.
      *
+     * For more information on Office themes, see
+     * {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
+     *
      * @remarks
      *
      * *Supported applications, by platform*
@@ -7007,7 +7035,7 @@ declare namespace Office {
      *  </tr>
      *  <tr>
      *    <td><strong>Excel</strong></td>
-     *    <td>Not available</td>
+     *    <td>Supported</td>
      *    <td>Supported</td>
      *    <td>Supported</td>
      *    <td>Supported</td>
@@ -7015,15 +7043,15 @@ declare namespace Office {
      *  </tr>
      *  <tr>
      *    <td><strong>Outlook</strong></td>
-     *    <td>Supported\*</td>
-     *    <td>Supported\*</td>
+     *    <td>Supported</td>
+     *    <td>Supported</td>
      *    <td>Not available</td>
      *    <td>Not available</td>
      *    <td>Not available</td>
      *  </tr>
      *  <tr>
      *    <td><strong>PowerPoint</strong></td>
-     *    <td>Not available</td>
+     *    <td>Supported</td>
      *    <td>Supported</td>
      *    <td>Supported</td>
      *    <td>Supported</td>
@@ -7039,7 +7067,7 @@ declare namespace Office {
      *  </tr>
      * </table>
      *
-     * \* In Outlook, the Office theme API is supported starting in
+     * **Important**: In Outlook, the Office theme API is supported starting in
      * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
      * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      */
@@ -7060,6 +7088,22 @@ declare namespace Office {
          * Gets the Office theme control foreground color as a hexadecimal color triplet (e.g., "#FFA500").
          */
         controlForegroundColor: string;
+        /**
+         * Returns `true` if the Office theme that's currently selected is **Black** (dark mode) or **Dark Gray**.
+         *
+         * @remarks
+         *
+         * **Important**: The `isDarkTheme` property isn't yet supported in Outlook. 
+         */
+        isDarkTheme: boolean;
+        /**
+         * Gets the Office theme that's currently selected.
+         *
+         * @remarks
+         *
+         * **Important**: The `themeId` property isn't yet supported in Outlook. 
+         */
+        themeId: ThemeId;
     }
     /**
      * Specifies a cell, or row, or column, by its zero-based row and/or column number. Example: `{row: 3, column: 4}` specifies the cell in the 3rd
@@ -90678,11 +90722,11 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          *
          * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
-         * `DropDownList` support is currently in preview.
+         * `DropDownList` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;
         /**
          * Inserts a document into the body at the specified location.
          *
@@ -91634,6 +91678,14 @@ declare namespace Word {
          * [Api set: WordApi 1.7]
          */
         readonly checkboxContentControl: Word.CheckboxContentControl;
+        /**
+         * Specifies the combo box-related data if the content control's type is 'ComboBox'. It's `null` otherwise.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly comboBoxContentControl: Word.ComboBoxContentControl;
         /**
          * Gets the collection of content control objects in the content control.
          *
@@ -92359,7 +92411,7 @@ declare namespace Word {
         toJSON(): Word.Interfaces.ContentControlCollectionData;
     }
     /**
-     * Represents a list item in a dropdown list content control.
+     * Represents a list item in a dropdown list or combo box content control.
      *
      * @remarks
      * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92369,7 +92421,7 @@ declare namespace Word {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Specifies the display text of a list item for a dropdown list content control.
+         * Specifies the display text of a list item for a dropdown list or combo box content control.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92385,7 +92437,7 @@ declare namespace Word {
          */
         index: number;
         /**
-         * Specifies the programmatic value of a list item for a dropdown list content control.
+         * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92452,7 +92504,7 @@ declare namespace Word {
         toJSON(): Word.Interfaces.ContentControlListItemData;
     }
     /**
-     * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list content control.
+     * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control.
      *
      * @remarks
      * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92521,12 +92573,13 @@ declare namespace Word {
      */
     interface ContentControlOptions {
         /**
-         * An array of content control types, item must be 'RichText', 'PlainText', or 'CheckBox'.
+         * An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'.
          *
          * @remarks
          * [Api set: WordApi 1.5]
          *
-         * Note: `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
+         * Note: 'PlainText' support was added in WordApi 1.5. 'CheckBox' support was added in WordApi 1.7.
+         * 'DropDownList' and 'ComboBox' support are currently in preview.
          */
         types: Word.ContentControlType[];
     }
@@ -93986,6 +94039,73 @@ declare namespace Word {
          */
         toJSON(): Word.Interfaces.DropDownListContentControlData;
     }
+    /**
+     * The data specific to content controls of type 'ComboBox'.
+     *
+     * @remarks
+     * [Api set: WordApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    class ComboBoxContentControl extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /**
+         * Gets the collection of list items in the combo box content control.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly listItems: Word.ContentControlListItemCollection;
+        /**
+         * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param displayText Required. Display text of the list item.
+         * @param value Optional. Value of the list item.
+         * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list.
+         */
+        addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem;
+        /**
+         * Deletes all list items in this combo box content control.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        deleteAllListItems(): void;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+         */
+        load(propertyNames?: string | string[]): Word.ComboBoxContentControl;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+         */
+        load(propertyNamesAndPaths?: {
+            select?: string;
+            expand?: string;
+        }): Word.ComboBoxContentControl;
+        /**
+         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
+         */
+        track(): Word.ComboBoxContentControl;
+        /**
+         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
+         */
+        untrack(): Word.ComboBoxContentControl;
+        /**
+        * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+        * Whereas the original Word.ComboBoxContentControl object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
+        */
+        toJSON(): Word.Interfaces.ComboBoxContentControlData;
+    }
     /**
      * Represents a field.
      *
@@ -96007,11 +96127,11 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          *
          * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
-         * `DropDownList` support is currently in preview.
+         * `DropDownList` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;
         /**
          * Inserts a document into the paragraph at the specified location.
          *
@@ -96815,11 +96935,11 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          *
          * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
-         * `DropDownList` support is currently in preview.
+         * `DropDownList` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
+         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
-        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
+        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;
         /**
          * Inserts an endnote. The endnote reference is placed after the range.
          *
@@ -103997,7 +104117,7 @@ declare namespace Word {
         /** An interface for updating data on the ContentControlListItem object, for use in `contentControlListItem.set({ ... })`. */
         interface ContentControlListItemUpdateData {
             /**
-             * Specifies the display text of a list item for a dropdown list content control.
+             * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104013,7 +104133,7 @@ declare namespace Word {
              */
             index?: number;
             /**
-             * Specifies the programmatic value of a list item for a dropdown list content control.
+             * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -105570,6 +105690,14 @@ declare namespace Word {
              * [Api set: WordApi 1.7]
              */
             checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
+            /**
+             * Specifies the combo box-related data if the content control's type is 'ComboBox'. It's null otherwise.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;
             /**
              * Gets the collection of content control objects in the content control.
              *
@@ -105737,7 +105865,7 @@ declare namespace Word {
         /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */
         interface ContentControlListItemData {
             /**
-             * Specifies the display text of a list item for a dropdown list content control.
+             * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -105753,7 +105881,7 @@ declare namespace Word {
              */
             index?: number;
             /**
-             * Specifies the programmatic value of a list item for a dropdown list content control.
+             * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -106061,6 +106189,9 @@ declare namespace Word {
         /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */
         interface DropDownListContentControlData {
         }
+        /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */
+        interface ComboBoxContentControlData {
+        }
         /** An interface describing the data returned by calling `field.toJSON()`. */
         interface FieldData {
             /**
@@ -108425,7 +108556,7 @@ declare namespace Word {
             type?: boolean;
         }
         /**
-         * Represents a list item in a dropdown list content control.
+         * Represents a list item in a dropdown list or combo box content control.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -108437,7 +108568,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * Specifies the display text of a list item for a dropdown list content control.
+             * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -108453,7 +108584,7 @@ declare namespace Word {
              */
             index?: boolean;
             /**
-             * Specifies the programmatic value of a list item for a dropdown list content control.
+             * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -108462,7 +108593,7 @@ declare namespace Word {
             value?: boolean;
         }
         /**
-         * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list content control.
+         * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -108474,7 +108605,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list content control.
+             * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -108490,7 +108621,7 @@ declare namespace Word {
              */
             index?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list content control.
+             * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -110622,7 +110753,7 @@ declare namespace Word {
              *
              * @remarks
              * [Api set: WordApi 1.1]
-            */
+             */
             body?: Word.Interfaces.BodyLoadOptions;
         }
         /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.477",
+    "version": "1.0.479",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,7 +45,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "701b1495adaafdb8da7ffd9d600dd594ea8999dacb9ec27580935889caf20f1d",
+    "typesPublisherContentHash": "555ccb55a6776312c1857533b39d243c6acba81068830c2249e0548694b49b21",
     "typeScriptVersion": "4.7",
     "nonNpm": true
 }