@types/office-js-preview 1.0.377 → 1.0.379

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, 09 Mar 2023 21:32:39 GMT
+ * Last updated: Tue, 11 Apr 2023 23:03:25 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -718,7 +718,7 @@ declare namespace Office {
          * This method only requests that the tab be registered. The actual registration is controlled by the Office application and may not be complete when the returned `Promise` object is resolved.
          * For more information and code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
          * 
-         * @param tabDefinition - Specifies the tab's properties and child controls and their properties. Pass a JSON string that conforms to the Office dynamic-ribbon JSON schema to `JSON.parse`, and then pass the returned object to this method.
+         * @param tabDefinition - Specifies the tab's properties and child controls and their properties. This parameter isn't strongly typed because its shape is defined by a JSON schema that can be versioned. To create the parameter object, pass a JSON string that conforms to the Office {@link https://developer.microsoft.com/json-schemas/office-js/dynamic-ribbon.schema.json | dynamic-ribbon JSON schema} to `JSON.parse`, and then pass the returned object to this method. To get IntelliSense for the JSON in Visual Studio Code, see {@link https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings | Editing JSON with Visual Studio Code - JSON schemas and settings }.
          */
         requestCreateControls(tabDefinition: Object): Promise<void>;
         /**
@@ -87713,7 +87713,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML.
          *
@@ -88689,7 +88689,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML.
          *
@@ -89124,7 +89124,7 @@ declare namespace Word {
      * [Api set: WordApi BETA (PREVIEW ONLY)]
      * @beta
      */
-    interface GetContentControlsOptions {
+    interface ContentControlOptions {
         /**
          * An array of content control types, item must be 'RichText' or 'PlainText'.
          *
@@ -89898,7 +89898,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets the document's endnotes in a single body.
                     Not implemented in Word on the web.
@@ -89950,7 +89950,7 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          *
          * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'.
-         * @param fileName Optional. The file name. Only takes effect for a new document.
+         * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document.
          */
         save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;
         /**
@@ -89960,7 +89960,7 @@ declare namespace Word {
          * [Api set: WordApi 1.1]
          *
          * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'.
-         * @param fileName Optional. The file name. Only takes effect for a new document.
+         * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document.
          */
         save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;
         /**
@@ -90148,7 +90148,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets a StyleCollection object that represents the whole style set of the document.
          *
@@ -90184,7 +90184,7 @@ declare namespace Word {
          * [Api set: WordApiHiddenDocument 1.3]
          *
          * @param saveBehavior Optional. DocumentCreated only supports 'Save'.
-         * @param fileName Optional. The file name. Only takes effect for a new document.
+         * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document.
          */
         save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;
         /**
@@ -90194,7 +90194,7 @@ declare namespace Word {
          * [Api set: WordApiHiddenDocument 1.3]
          *
          * @param saveBehavior Optional. DocumentCreated only supports 'Save'.
-         * @param fileName Optional. The file name. Only takes effect for a new document.
+         * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document.
          */
         save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;
         /**
@@ -92281,7 +92281,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML.
          *
@@ -93060,7 +93060,7 @@ declare namespace Word {
          *
          * @param options Optional. Options that define which content controls are returned.
          */
-        getContentControls(options?: Word.GetContentControlsOptions): Word.ContentControlCollection;
+        getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
         /**
          * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML.
          *
@@ -93500,7 +93500,7 @@ declare namespace Word {
      */
     interface InsertFileOptions {
         /**
-         * Represents whether the change tracking mode from the source document should be imported.
+         * Represents whether the change tracking mode status from the source document should be imported.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -94156,7 +94156,7 @@ declare namespace Word {
          * [Api set: WordApi BETA (PREVIEW ONLY)]
          * @beta
          */
-        readonly styleType: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";
+        readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";
         /**
          * Gets or sets whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.
          *
@@ -101817,7 +101817,7 @@ declare namespace Word {
              * [Api set: WordApi BETA (PREVIEW ONLY)]
              * @beta
              */
-            styleType?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";
+            type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";
             /**
              * Gets or sets whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.
              *
@@ -105182,7 +105182,7 @@ declare namespace Word {
              * [Api set: WordApi BETA (PREVIEW ONLY)]
              * @beta
              */
-            styleType?: boolean;
+            type?: boolean;
             /**
              * For EACH ITEM in the collection: Gets or sets whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.
              *
@@ -105314,7 +105314,7 @@ declare namespace Word {
              * [Api set: WordApi BETA (PREVIEW ONLY)]
              * @beta
              */
-            styleType?: boolean;
+            type?: boolean;
             /**
              * Gets or sets whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.
              *

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.377",
+    "version": "1.0.379",
     "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": "7176c843b8384af543ec345483b02f476b1303b35766ab426e6f2c7867efed34",
-    "typeScriptVersion": "4.2"
+    "typesPublisherContentHash": "f6cac7ee561007c280c025efc33c2f0947230ed1ea49bc5f69cc6c71913ba505",
+    "typeScriptVersion": "4.3"
 }