@types/office-js 1.0.394 → 1.0.396

office-js/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.
 
 ### Additional Details
- * Last updated: Fri, 07 Jun 2024 00:25:08 GMT
+ * Last updated: Thu, 20 Jun 2024 16:08:33 GMT
  * Dependencies: none
 
 # Credits

office-js/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.
      *
@@ -6979,10 +7003,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*
@@ -6997,7 +7025,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>
@@ -7005,15 +7033,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>
@@ -7029,7 +7057,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}.
      */
@@ -7050,6 +7078,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
@@ -85271,6 +85315,42 @@ declare namespace Word {
          */
         berry = "Berry",
     }
+    /**
+     * Properties defining the behavior of the pop-up menu for a given critique.
+     *
+     * @remarks
+     * [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 1.8]
+         */
+        brandingTextResourceId: string;
+        /**
+         * Gets the manifest resource ID of the string to use as the subtitle.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        subtitleResourceId: string;
+        /**
+         * Gets the suggestions to display in the critique pop-up menu.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        suggestions: string[];
+        /**
+         * Gets the manifest resource ID of the string to use as the title.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        titleResourceId: string;
+    }
     /**
      * Critique that will be rendered as underline for the specified part of paragraph in the document.
      *
@@ -85292,6 +85372,13 @@ declare namespace Word {
          * [Api set: WordApi 1.7]
          */
         length: number;
+        /**
+         * Specifies the behavior of the pop-up menu for the critique.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        popupOptions: Word.CritiquePopupOptions;
         /**
          * Gets the start index of the critique inside paragraph.
          *
@@ -85545,6 +85632,35 @@ declare namespace Word {
          */
         id: string;
     }
+    /**
+     * Represents action information that's passed back on annotation pop-up action event.
+     *
+     * @remarks
+     * [Api set: WordApi 1.8]
+     */
+    interface AnnotationPopupActionEventArgs {
+        /**
+         * Specifies the chosen action in the pop-up menu.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        action: string;
+        /**
+         * Specifies the accepted suggestion (only populated when accepting a critique suggestion).
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        critiqueSuggestion: string;
+        /**
+         * Specifies the annotation ID for which the event was fired.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        id: string;
+    }
     /**
      * Contains a collection of {@link Word.Annotation} objects.
      *
@@ -88173,6 +88289,15 @@ declare namespace Word {
          * @eventproperty
          */
         readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;
+        /**
+         * Occurs when the user performs an action in an annotation pop-up menu.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         *
+         * @eventproperty
+         */
+        readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;
         /**
          * Occurs when the user deletes one or more annotations.
          *
@@ -91019,6 +91144,14 @@ declare namespace Word {
          * [Api set: WordApi 1.6]
          */
         getTrackedChanges(): Word.TrackedChangeCollection;
+        /**
+         * Highlights the range temporarily without changing document content.
+                    To highlight the text permanently, set the range's Font.HighlightColor.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        highlight(): void;
         /**
          * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first.
          *
@@ -91223,6 +91356,13 @@ declare namespace Word {
          * @param range Required. Another range.
          */
         intersectWithOrNullObject(range: Word.Range): Word.Range;
+        /**
+         * Removes the highlight added by the Highlight function if any.
+         *
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        removeHighlight(): void;
         /**
          * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects.
          *
@@ -93960,6 +94100,12 @@ declare namespace Word {
          * [Api set: WordApi 1.7]
          */
         annotationRemoved = "AnnotationRemoved",
+        /**
+         * Represents an action in the annotation pop-up.
+         * @remarks
+         * [Api set: WordApi 1.8]
+         */
+        annotationPopupAction = "AnnotationPopupAction",
     }
     /**
      * An enum that specifies an event's source. It can be local or remote (through coauthoring).
@@ -93992,7 +94138,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94021,7 +94167,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94050,7 +94196,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94079,7 +94225,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94108,7 +94254,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94137,7 +94283,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          */
-        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the content control IDs.
          *
@@ -94173,7 +94319,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.6]
          */
-        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
          *
@@ -94202,7 +94348,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.6]
          */
-        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
          *
@@ -94231,7 +94377,7 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.6]
          */
-        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
+        type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
         /**
          * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
          *

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.394",
+    "version": "1.0.396",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "0dc9cf2f71d799e043e1dfae04acf914e4d2adbc62fff35d59147a014f89eab1",
+    "typesPublisherContentHash": "b89b47f8ede1482e3013371cd555c5438702548ff0ee78c159b312f2a1950722",
     "typeScriptVersion": "4.7"
 }