@types/office-js-preview 1.0.531 → 1.0.532

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, 15 Nov 2024 20:02:25 GMT
+ * Last updated: Mon, 18 Nov 2024 16:02:32 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -94367,7 +94367,7 @@ 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.
+         * `DropDownList` and `ComboBox` support was added in WordApi 1.9.
          *
          * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
@@ -95300,18 +95300,17 @@ 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 checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
+         * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
          *
          * @remarks
          * [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.
+         * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         readonly comboBoxContentControl: Word.ComboBoxContentControl;
         /**
@@ -95322,11 +95321,10 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's `null` otherwise.
+         * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         readonly dropDownListContentControl: Word.DropDownListContentControl;
         /**
@@ -96040,8 +96038,7 @@ declare namespace Word {
      * Represents a list item in a dropdown list or combo box content control.
      *
      * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: WordApi 1.9]
      */
     class ContentControlListItem extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -96050,24 +96047,21 @@ declare namespace Word {
          * Specifies the display text of a list item for a dropdown list or combo box content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         displayText: string;
         /**
          * Specifies the index location of a content control list item in the collection of list items.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         index: number;
         /**
          * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         value: string;
         /**
@@ -96082,16 +96076,14 @@ declare namespace Word {
          * Deletes the list item.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         delete(): void;
         /**
          * Selects the list item and sets the text of the content control to the value of the list item.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         select(): void;
         /**
@@ -96133,8 +96125,7 @@ declare namespace Word {
      * 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)]
-     * @beta
+     * [Api set: WordApi 1.9]
      */
     class ContentControlListItemCollection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -96145,8 +96136,7 @@ declare namespace Word {
          * Gets the first list item in this collection. Throws an `ItemNotFound` error if this collection is empty.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         getFirst(): Word.ContentControlListItem;
         /**
@@ -96155,8 +96145,7 @@ declare namespace Word {
                     see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         getFirstOrNullObject(): Word.ContentControlListItem;
         /**
@@ -96205,7 +96194,7 @@ declare namespace Word {
          * [Api set: WordApi 1.5]
          *
          * 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.
+         * 'DropDownList' and 'ComboBox' support was added in WordApi 1.9.
          */
         types: Word.ContentControlType[];
     }
@@ -97049,9 +97038,24 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.6]
          *
+         * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
+         *
          * @param stylesJson Required. A JSON-formatted string representing the styles.
+         * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
+        /**
+         * Import styles from a JSON-formatted string.
+         *
+         * @remarks
+         * [Api set: WordApi 1.6]
+         *
+         * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
+         *
+         * @param stylesJson Required. A JSON-formatted string representing the styles.
+         * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
+         */
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;
         /**
          * Inserts a document into the target document at a specific location with additional properties.
                     Headers, footers, watermarks, and other section properties are copied by default.
@@ -97616,8 +97620,7 @@ declare namespace Word {
      * The data specific to content controls of type DropDownList.
      *
      * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: WordApi 1.9]
      */
     class DropDownListContentControl extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -97626,16 +97629,14 @@ declare namespace Word {
          * Gets the collection of list items in the dropdown list content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         readonly listItems: Word.ContentControlListItemCollection;
         /**
          * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          *
          * @param displayText Required. Display text of the list item.
          * @param value Optional. Value of the list item.
@@ -97646,8 +97647,7 @@ declare namespace Word {
          * Deletes all list items in this dropdown list content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         deleteAllListItems(): void;
         /**
@@ -97683,8 +97683,7 @@ declare namespace Word {
      * The data specific to content controls of type 'ComboBox'.
      *
      * @remarks
-     * [Api set: WordApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: WordApi 1.9]
      */
     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. */
@@ -97693,16 +97692,14 @@ declare namespace Word {
          * Gets the collection of list items in the combo box content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         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
+         * [Api set: WordApi 1.9]
          *
          * @param displayText Required. Display text of the list item.
          * @param value Optional. Value of the list item.
@@ -97713,8 +97710,7 @@ declare namespace Word {
          * Deletes all list items in this combo box content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         deleteAllListItems(): void;
         /**
@@ -99751,7 +99747,7 @@ 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.
+         * `DropDownList` and `ComboBox` support was added in WordApi 1.9.
          *
          * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
@@ -100559,7 +100555,7 @@ 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.
+         * `DropDownList` and `ComboBox` support was added in WordApi 1.9.
          *
          * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'.
          */
@@ -107327,6 +107323,32 @@ declare namespace Word {
          */
         compareTargetNew = "CompareTargetNew",
     }
+    /**
+     * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document.
+     *
+     * @remarks
+     * [Api set: WordApiDesktop 1.1]
+     */
+    enum ImportedStylesConflictBehavior {
+        /**
+         * Ignore conflicting imported styles and keep the existing version of those styles in the current document.
+         * @remarks
+         * [Api set: WordApiDesktop 1.1]
+         */
+        ignore = "Ignore",
+        /**
+         * Overwrite the existing styles in the current document.
+         * @remarks
+         * [Api set: WordApiDesktop 1.1]
+         */
+        overwrite = "Overwrite",
+        /**
+         * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1.
+         * @remarks
+         * [Api set: WordApiDesktop 1.1]
+         */
+        createNew = "CreateNew",
+    }
     enum ErrorCodes {
         accessDenied = "AccessDenied",
         generalException = "GeneralException",
@@ -107563,7 +107585,7 @@ declare namespace Word {
         /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */
         interface ContentControlUpdateData {
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
+             * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -107657,24 +107679,21 @@ declare namespace Word {
              * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             displayText?: string;
             /**
              * Specifies the index location of a content control list item in the collection of list items.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             index?: number;
             /**
              * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             value?: string;
         }
@@ -109197,18 +109216,17 @@ declare namespace Word {
         /** An interface describing the data returned by calling `contentControl.toJSON()`. */
         interface ContentControlData {
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
+             * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [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.
+             * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;
             /**
@@ -109219,11 +109237,10 @@ declare namespace Word {
              */
             contentControls?: Word.Interfaces.ContentControlData[];
             /**
-             * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's `null` otherwise.
+             * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;
             /**
@@ -109379,24 +109396,21 @@ declare namespace Word {
              * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             displayText?: string;
             /**
              * Specifies the index location of a content control list item in the collection of list items.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             index?: number;
             /**
              * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             value?: string;
         }
@@ -111695,7 +111709,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
+             * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -111868,7 +111882,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
+             * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -112033,8 +112047,7 @@ declare namespace Word {
          * Represents a list item in a dropdown list or combo box content control.
          *
          * @remarks
-         * [Api set: WordApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         interface ContentControlListItemLoadOptions {
             /**
@@ -112045,24 +112058,21 @@ declare namespace Word {
              * Specifies the display text of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             displayText?: boolean;
             /**
              * Specifies the index location of a content control list item in the collection of list items.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             index?: boolean;
             /**
              * Specifies the programmatic value of a list item for a dropdown list or combo box content control.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             value?: boolean;
         }
@@ -112070,8 +112080,7 @@ declare namespace Word {
          * 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)]
-         * @beta
+         * [Api set: WordApi 1.9]
          */
         interface ContentControlListItemCollectionLoadOptions {
             /**
@@ -112082,24 +112091,21 @@ declare namespace Word {
              * 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)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             displayText?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items.
              *
              * @remarks
-             * [Api set: WordApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             index?: boolean;
             /**
              * 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)]
-             * @beta
+             * [Api set: WordApi 1.9]
              */
             value?: boolean;
         }

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.531",
+    "version": "1.0.532",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -46,7 +46,7 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "1e667b8dd3d40f1f45cdc4e1a2612bb211ff2937bba9d27db2fc1db40ad620a2",
+    "typesPublisherContentHash": "53a23bc9abefc5fcd5478f9d425e96353def328e427ecd6b2d78b9088a08c19a",
     "typeScriptVersion": "4.9",
     "nonNpm": true
 }