@types/office-js-preview 1.0.476 → 1.0.478

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: Fri, 07 Jun 2024 00:25:08 GMT
+ * Last updated: Mon, 17 Jun 2024 18:08:12 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -89978,40 +89978,35 @@ declare namespace Word {
      * Properties defining the behavior of the pop-up menu for a given critique.
      *
      * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: WordApi 1.8]
      */
     interface CritiquePopupOptions {
         /**
          * Gets the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         brandingTextResourceId: string;
         /**
          * Gets the manifest resource ID of the string to use as the subtitle.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         subtitleResourceId: string;
         /**
          * Gets the suggestions to display in the critique pop-up menu.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         suggestions: string[];
         /**
          * Gets the manifest resource ID of the string to use as the title.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         titleResourceId: string;
     }
@@ -90040,8 +90035,7 @@ declare namespace Word {
          * Specifies the behavior of the pop-up menu for the critique.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         popupOptions: Word.CritiquePopupOptions;
         /**
@@ -90301,32 +90295,28 @@ declare namespace Word {
      * Represents action information that's passed back on annotation pop-up action event.
      *
      * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: WordApi 1.8]
      */
     interface AnnotationPopupActionEventArgs {
         /**
          * Specifies the chosen action in the pop-up menu.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         action: string;
         /**
          * Specifies the accepted suggestion (only populated when accepting a critique suggestion).
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         critiqueSuggestion: string;
         /**
          * Specifies the annotation ID for which the event was fired.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         id: string;
     }
@@ -90688,10 +90678,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` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. 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 | "RichText" | "PlainText" | "CheckBox"): 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.
          *
@@ -91643,6 +91634,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.
          *
@@ -92368,7 +92367,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)]
@@ -92378,7 +92377,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)]
@@ -92394,7 +92393,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)]
@@ -92461,7 +92460,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)]
@@ -92530,12 +92529,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[];
     }
@@ -93473,10 +93473,9 @@ declare namespace Word {
          * Occurs when the user performs an action in an annotation pop-up menu.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * [Api set: WordApi 1.8]
          *
          * @eventproperty
-         * @beta
          */
         readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;
         /**
@@ -93996,6 +93995,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.
      *
@@ -96017,10 +96083,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` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. 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 | "RichText" | "PlainText" | "CheckBox"): 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.
          *
@@ -96783,8 +96850,7 @@ declare namespace Word {
                     To highlight the text permanently, set the range's Font.HighlightColor.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         highlight(): void;
         /**
@@ -96825,10 +96891,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` and `ComboBox` support are currently in preview.
          *
-         * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. 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 | "RichText" | "PlainText" | "CheckBox"): 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.
          *
@@ -96995,8 +97062,7 @@ declare namespace Word {
          * Removes the highlight added by the Highlight function if any.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         removeHighlight(): void;
         /**
@@ -99944,8 +100010,7 @@ declare namespace Word {
         /**
          * Represents an action in the annotation pop-up.
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.8]
          */
         annotationPopupAction = "AnnotationPopupAction",
     }
@@ -99967,47 +100032,6 @@ declare namespace Word {
          */
         remote = "Remote",
     }
-    /**
-     * Provides information about the content control that raised an event.
-     *
-     * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
-     */
-    interface ContentControlEventArgs {
-        /**
-         * The object that raised the event. Load this object to get its properties.
-         *
-         * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        contentControl: Word.ContentControl;
-        /**
-         * The event type. See Word.EventType for details.
-         *
-         * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
-        /**
-         * Gets the content control IDs.
-         *
-         * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        ids: number[];
-        /**
-         * The source of the event. It can be local or remote (through coauthoring).
-         *
-         * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        source: Word.EventSource | "Local" | "Remote";
-    }
     /**
      * Provides information about the content control that raised contentControlAdded event.
      *
@@ -104049,7 +104073,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)]
@@ -104065,7 +104089,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)]
@@ -105622,6 +105646,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.
              *
@@ -105789,7 +105821,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)]
@@ -105805,7 +105837,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)]
@@ -106113,6 +106145,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 {
             /**
@@ -108477,7 +108512,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)]
@@ -108489,7 +108524,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)]
@@ -108505,7 +108540,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)]
@@ -108514,7 +108549,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)]
@@ -108526,7 +108561,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)]
@@ -108542,7 +108577,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)]
@@ -110674,7 +110709,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.476",
+    "version": "1.0.478",
     "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": "ced4e49bf900a0f2bf0b7060f3890add325755da221296fc6453a798c34cd04c",
+    "typesPublisherContentHash": "78689265f2fd891d7d8339a179df4b0fcc58030b98c6b90a0808f9bffb154a6c",
     "typeScriptVersion": "4.7",
     "nonNpm": true
 }