@types/office-js-preview 1.0.402 → 1.0.404

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 18 Jul 2023 19:32:54 GMT
11
+ * Last updated: Tue, 01 Aug 2023 16:32:48 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -231,7 +231,6 @@ declare namespace Office {
231
231
  */
232
232
  resolve(): Promise<void>;
233
233
  }
234
-
235
234
  /**
236
235
  * Gets the Context object that represents the runtime environment of the add-in and provides access to the top-level objects of the API.
237
236
  *
@@ -1063,7 +1062,6 @@ declare namespace Office {
1063
1062
  * This property is supported in Outlook only in {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later.
1064
1063
  */
1065
1064
  source:Source;
1066
-
1067
1065
  /**
1068
1066
  * Indicates that the add-in has completed processing and will automatically be closed.
1069
1067
  *
@@ -1072,10 +1070,13 @@ declare namespace Office {
1072
1070
  * - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
1073
1071
  *
1074
1072
  * - An event defined in the {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
1075
- * For example, an `OnMessageSend` event.
1073
+ * For example, an `OnMessageSend` event.
1076
1074
  *
1077
1075
  * - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
1078
1076
  * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
1077
+ *
1078
+ * - An event defined in the
1079
+ * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint?view=outlook-js-preview&preserve-view=true#reportphishingcommandsurface-preview | ReportPhishingCommandSurface extension point (preview)}.
1079
1080
  *
1080
1081
  * @remarks
1081
1082
  *
@@ -1091,18 +1092,19 @@ declare namespace Office {
1091
1092
  */
1092
1093
  completed(options?: EventCompletedOptions): void;
1093
1094
  }
1094
-
1095
1095
  /**
1096
1096
  * Specifies the behavior for when the event is completed.
1097
1097
  */
1098
1098
  interface EventCompletedOptions {
1099
1099
  /**
1100
- * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1101
- * is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
1100
+ * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1101
+ * to signal completion of an event handler, this property indicates if the handled event should continue execution or be canceled.
1102
1102
  * For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
1103
1103
  * sending of an item. For a complete sample, see the
1104
1104
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
1105
1105
  *
1106
+ * **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
1107
+ *
1106
1108
  * @remarks
1107
1109
  *
1108
1110
  * [Api set: Mailbox 1.8]
@@ -1111,14 +1113,15 @@ declare namespace Office {
1111
1113
  *
1112
1114
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
1113
1115
  */
1114
- allowEvent: boolean;
1115
-
1116
+ allowEvent?: boolean;
1116
1117
  /**
1117
- * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1118
- * is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
1119
- * that will be displayed to the user. For an example, see the
1118
+ * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1119
+ * to signal completion of an event handler and set its `allowEvent` property to `false`, this property sets the error message
1120
+ * that will be displayed to the user. For an example, see the
1120
1121
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
1121
1122
  *
1123
+ * **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
1124
+ *
1122
1125
  * @remarks
1123
1126
  *
1124
1127
  * [Api set: Mailbox 1.12]
@@ -1128,8 +1131,98 @@ declare namespace Office {
1128
1131
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
1129
1132
  */
1130
1133
  errorMessage?: string;
1134
+ /**
1135
+ * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1136
+ * to signal that a reported message has finished processing, this property specifies the Outlook mailbox folder to which the message will be moved.
1137
+ *
1138
+ * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
1139
+ *
1140
+ * @remarks
1141
+ *
1142
+ * [Api set: Mailbox preview]
1143
+ *
1144
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
1145
+ *
1146
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
1147
+ *
1148
+ * **Important**:
1149
+ *
1150
+ * - If the specified folder doesn't exist yet, it will be created before the message is moved.
1151
+ *
1152
+ * - If the `postProcessingAction` property is set to `moveToCustomFolder`, the `folderName` property must be specified.
1153
+ * Otherwise, the reported message is moved to the Junk Email folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
1154
+ * the `folderName` property is ignored.
1155
+ *
1156
+ * @beta
1157
+ */
1158
+ folderName?: string;
1159
+ /**
1160
+ * When set to `true`, deletes a reported message if an error occurs while the message is processed.
1161
+ * If this property is set to `false` or isn't specified in the
1162
+ * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method},
1163
+ * the reported message remains in its current mailbox folder.
1164
+ *
1165
+ * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
1166
+ *
1167
+ * @remarks
1168
+ *
1169
+ * [Api set: Mailbox preview]
1170
+ *
1171
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
1172
+ *
1173
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
1174
+ *
1175
+ * @beta
1176
+ */
1177
+ onErrorDeleteItem?: boolean;
1178
+ /**
1179
+ * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1180
+ * to signal that a reported message has finished processing, this property specifies the next action to be performed on the message. The following post-processing actions are available:
1181
+ *
1182
+ * - `delete` - Deletes the reported message.
1183
+ *
1184
+ * - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
1185
+ *
1186
+ * - `moveToSpamFolder` - Moves the reported message to the Junk Email folder of the mailbox.
1187
+ *
1188
+ * - `noMove` - Leaves the reported message in its current folder.
1189
+ *
1190
+ * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
1191
+ *
1192
+ * @remarks
1193
+ *
1194
+ * [Api set: Mailbox preview]
1195
+ *
1196
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
1197
+ *
1198
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
1199
+ *
1200
+ * **Important**: If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which the message will be moved in the `folderName`
1201
+ * property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to `moveToSpamFolder` and move the reported message to the
1202
+ * Junk Email folder.
1203
+ *
1204
+ * @beta
1205
+ */
1206
+ postProcessingAction?: string;
1207
+ /**
1208
+ * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
1209
+ * to signal that a reported message has finished processing, this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property
1210
+ * must contain a title and a description. If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
1211
+ *
1212
+ * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
1213
+ *
1214
+ * @remarks
1215
+ *
1216
+ * [Api set: Mailbox preview]
1217
+ *
1218
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
1219
+ *
1220
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
1221
+ *
1222
+ * @beta
1223
+ */
1224
+ showPostProcessingDialog?: object;
1131
1225
  }
1132
-
1133
1226
  /**
1134
1227
  * Encapsulates source data for add-in events.
1135
1228
  */
@@ -1427,7 +1520,6 @@ declare namespace Office {
1427
1520
  */
1428
1521
  openBrowserWindow(url: string): void;
1429
1522
  }
1430
-
1431
1523
  /**
1432
1524
  * Provides information about which Requirement Sets are supported in the current environment.
1433
1525
  */
@@ -1450,7 +1542,6 @@ declare namespace Office {
1450
1542
  */
1451
1543
  isSetSupported(name: string, minVersionNumber?: number): boolean;
1452
1544
  }
1453
-
1454
1545
  /**
1455
1546
  * Provides options for how a dialog is displayed.
1456
1547
  */
@@ -1482,7 +1573,6 @@ declare namespace Office {
1482
1573
  */
1483
1574
  asyncContext?: any
1484
1575
  }
1485
-
1486
1576
  /**
1487
1577
  * The Office Auth namespace, `Office.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
1488
1578
  * Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
@@ -2074,7 +2164,6 @@ declare namespace Office {
2074
2164
  */
2075
2165
  sendMessage(name: string): void;
2076
2166
  }
2077
-
2078
2167
  /**
2079
2168
  * Returns a promise of an object described in the expression. Callback is invoked only if the function fails.
2080
2169
  *
@@ -2446,6 +2535,15 @@ declare namespace Office {
2446
2535
  * **Applications**: Excel, PowerPoint, Word
2447
2536
  */
2448
2537
  SettingsChanged,
2538
+ /**
2539
+ * Occurs in Outlook when an unsolicited message is reported. The event handler receives an argument of type
2540
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventargs?view=outlook-js-preview&preserve-view=true | Office.SpamReportingEventArgs}.
2541
+ *
2542
+ * [Api set: Mailbox preview]
2543
+ *
2544
+ * @beta
2545
+ */
2546
+ SpamReporting,
2449
2547
  /**
2450
2548
  * Triggers when a Task selection happens in Project.
2451
2549
  */
@@ -3020,7 +3118,6 @@ declare namespace Office {
3020
3118
  */
3021
3119
  setDataAsync(data: TableData | any, callback?: (result: AsyncResult<void>) => void): void;
3022
3120
  }
3023
-
3024
3121
  /**
3025
3122
  * Provides information about the binding that raised the DataChanged event.
3026
3123
  */
@@ -3035,7 +3132,6 @@ declare namespace Office {
3035
3132
  */
3036
3133
  type: EventType;
3037
3134
  }
3038
-
3039
3135
  /**
3040
3136
  * Provides information about the binding that raised the SelectionChanged event.
3041
3137
  */
@@ -3089,7 +3185,6 @@ declare namespace Office {
3089
3185
  */
3090
3186
  type: EventType;
3091
3187
  }
3092
-
3093
3188
  /**
3094
3189
  * Represents the bindings the add-in has within the document.
3095
3190
  */
@@ -3705,7 +3800,6 @@ declare namespace Office {
3705
3800
  */
3706
3801
  removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;
3707
3802
  }
3708
-
3709
3803
  /**
3710
3804
  * Provides information about the deleted node that raised the nodeDeleted event.
3711
3805
  */
@@ -3726,7 +3820,6 @@ declare namespace Office {
3726
3820
  */
3727
3821
  oldNode: CustomXmlNode;
3728
3822
  }
3729
-
3730
3823
  /**
3731
3824
  * Provides information about the inserted node that raised the nodeInserted event.
3732
3825
  */
@@ -3742,7 +3835,6 @@ declare namespace Office {
3742
3835
  */
3743
3836
  newNode: CustomXmlNode;
3744
3837
  }
3745
-
3746
3838
  /**
3747
3839
  * Provides information about the replaced node that raised the nodeReplaced event.
3748
3840
  */
@@ -3765,7 +3857,6 @@ declare namespace Office {
3765
3857
  */
3766
3858
  oldNode: CustomXmlNode;
3767
3859
  }
3768
-
3769
3860
  /**
3770
3861
  * Represents a collection of CustomXmlPart objects.
3771
3862
  *
@@ -17244,6 +17335,42 @@ declare namespace Office {
17244
17335
  * If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
17245
17336
  */
17246
17337
  getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
17338
+ /**
17339
+ * Gets the current message in EML format encoded in Base64.
17340
+ *
17341
+ * @remarks
17342
+ * [Api set: Mailbox preview]
17343
+ *
17344
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17345
+ *
17346
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17347
+ *
17348
+ * @param options - An object literal that contains one or more of the following properties:-
17349
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17350
+ * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
17351
+ * `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
17352
+ * returned in the `asyncResult.error` property.
17353
+ *
17354
+ * @beta
17355
+ */
17356
+ getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
17357
+ /**
17358
+ * Gets the current message in EML format encoded in Base64.
17359
+ *
17360
+ * @remarks
17361
+ * [Api set: Mailbox preview]
17362
+ *
17363
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17364
+ *
17365
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17366
+ *
17367
+ * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter, `asyncResult`, which is an
17368
+ * `Office.AsyncResult` object. The Base64-encoded EML format of the message is returned in the `asyncResult.value` property. Any errors encountered are
17369
+ * returned in the `asyncResult.error` property.
17370
+ *
17371
+ * @beta
17372
+ */
17373
+ getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
17247
17374
  /**
17248
17375
  * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
17249
17376
  *
@@ -19612,6 +19739,25 @@ declare namespace Office {
19612
19739
  */
19613
19740
  delegatePermissions: MailboxEnums.DelegatePermissions;
19614
19741
  }
19742
+ /**
19743
+ * Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
19744
+ *
19745
+ * @remarks
19746
+ * [Api set: Mailbox preview]
19747
+ *
19748
+ * @beta
19749
+ */
19750
+ export interface SpamReportingEventArgs {
19751
+ /**
19752
+ * The type of event that was raised. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
19753
+ *
19754
+ * @remarks
19755
+ * [Api set: Mailbox preview]
19756
+ *
19757
+ * @beta
19758
+ */
19759
+ type: "SpamReporting";
19760
+ }
19615
19761
  /**
19616
19762
  * Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
19617
19763
  *
@@ -94735,6 +94881,14 @@ declare namespace Word {
94735
94881
  * [Api set: WordApi 1.5]
94736
94882
  */
94737
94883
  readonly paragraphFormat: Word.ParagraphFormat;
94884
+ /**
94885
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
94886
+ *
94887
+ * @remarks
94888
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
94889
+ * @beta
94890
+ */
94891
+ readonly shading: Word.Shading;
94738
94892
  /**
94739
94893
  * Gets the name of an existing style to use as the base formatting of another style.
94740
94894
  *
@@ -94870,6 +95024,83 @@ declare namespace Word {
94870
95024
  */
94871
95025
  toJSON(): Word.Interfaces.StyleData;
94872
95026
  }
95027
+ /**
95028
+ * Represents the shading object.
95029
+ *
95030
+ * @remarks
95031
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95032
+ * @beta
95033
+ */
95034
+ class Shading extends OfficeExtension.ClientObject {
95035
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
95036
+ context: RequestContext;
95037
+ /**
95038
+ * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
95039
+ *
95040
+ * @remarks
95041
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95042
+ * @beta
95043
+ */
95044
+ backgroundPatternColor: string;
95045
+ /**
95046
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
95047
+ *
95048
+ * @remarks
95049
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95050
+ * @beta
95051
+ */
95052
+ foregroundPatternColor: string;
95053
+ /**
95054
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
95055
+ *
95056
+ * @remarks
95057
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95058
+ * @beta
95059
+ */
95060
+ texture: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
95061
+ /**
95062
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
95063
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
95064
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
95065
+ */
95066
+ set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;
95067
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
95068
+ set(properties: Word.Shading): void;
95069
+ /**
95070
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
95071
+ *
95072
+ * @param options Provides options for which properties of the object to load.
95073
+ */
95074
+ load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading;
95075
+ /**
95076
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
95077
+ *
95078
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
95079
+ */
95080
+ load(propertyNames?: string | string[]): Word.Shading;
95081
+ /**
95082
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
95083
+ *
95084
+ * @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.
95085
+ */
95086
+ load(propertyNamesAndPaths?: {
95087
+ select?: string;
95088
+ expand?: string;
95089
+ }): Word.Shading;
95090
+ /**
95091
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.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.
95092
+ */
95093
+ track(): Word.Shading;
95094
+ /**
95095
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.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.
95096
+ */
95097
+ untrack(): Word.Shading;
95098
+ /**
95099
+ * 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.)
95100
+ * Whereas the original Word.Shading object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
95101
+ */
95102
+ toJSON(): Word.Interfaces.ShadingData;
95103
+ }
94873
95104
  /**
94874
95105
  * Represents a table in a Word document.
94875
95106
  *
@@ -99627,6 +99858,274 @@ declare namespace Word {
99627
99858
  */
99628
99859
  legalLZ = "LegalLZ",
99629
99860
  }
99861
+ /**
99862
+ * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
99863
+ *
99864
+ * @remarks
99865
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99866
+ * @beta
99867
+ */
99868
+ enum ShadingTextureType {
99869
+ /**
99870
+ * Represents 10 percent texture.
99871
+ * @remarks
99872
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99873
+ * @beta
99874
+ */
99875
+ texture10Percent = "Texture10Percent",
99876
+ /**
99877
+ * Represents 12.5 percent texture.
99878
+ * @remarks
99879
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99880
+ * @beta
99881
+ */
99882
+ texture12Pt5Percent = "Texture12Pt5Percent",
99883
+ /**
99884
+ * Represents 15 percent texture.
99885
+ * @remarks
99886
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99887
+ * @beta
99888
+ */
99889
+ texture15Percent = "Texture15Percent",
99890
+ /**
99891
+ * Represents 20 percent texture.
99892
+ * @remarks
99893
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99894
+ * @beta
99895
+ */
99896
+ texture20Percent = "Texture20Percent",
99897
+ /**
99898
+ * Represents 25 percent texture.
99899
+ * @remarks
99900
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99901
+ * @beta
99902
+ */
99903
+ texture25Percent = "Texture25Percent",
99904
+ /**
99905
+ * Represents 30 percent texture.
99906
+ * @remarks
99907
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99908
+ * @beta
99909
+ */
99910
+ texture30Percent = "Texture30Percent",
99911
+ /**
99912
+ * Represents 35 percent texture.
99913
+ * @remarks
99914
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99915
+ * @beta
99916
+ */
99917
+ texture35Percent = "Texture35Percent",
99918
+ /**
99919
+ * Represents 37.5 percent texture.
99920
+ * @remarks
99921
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99922
+ * @beta
99923
+ */
99924
+ texture37Pt5Percent = "Texture37Pt5Percent",
99925
+ /**
99926
+ * Represents 40 percent texture.
99927
+ * @remarks
99928
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99929
+ * @beta
99930
+ */
99931
+ texture40Percent = "Texture40Percent",
99932
+ /**
99933
+ * Represents 45 percent texture.
99934
+ * @remarks
99935
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99936
+ * @beta
99937
+ */
99938
+ texture45Percent = "Texture45Percent",
99939
+ /**
99940
+ * Represents 50 percent texture.
99941
+ * @remarks
99942
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99943
+ * @beta
99944
+ */
99945
+ texture50Percent = "Texture50Percent",
99946
+ /**
99947
+ * Represents 55 percent texture.
99948
+ * @remarks
99949
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99950
+ * @beta
99951
+ */
99952
+ texture55Percent = "Texture55Percent",
99953
+ /**
99954
+ * Represents 5 percent texture.
99955
+ * @remarks
99956
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99957
+ * @beta
99958
+ */
99959
+ texture5Percent = "Texture5Percent",
99960
+ /**
99961
+ * Represents 60 percent texture.
99962
+ * @remarks
99963
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99964
+ * @beta
99965
+ */
99966
+ texture60Percent = "Texture60Percent",
99967
+ /**
99968
+ * Represents 62.5 percent texture.
99969
+ * @remarks
99970
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99971
+ * @beta
99972
+ */
99973
+ texture62Pt5Percent = "Texture62Pt5Percent",
99974
+ /**
99975
+ * Represents 65 percent texture.
99976
+ * @remarks
99977
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99978
+ * @beta
99979
+ */
99980
+ texture65Percent = "Texture65Percent",
99981
+ /**
99982
+ * Represents 70 percent texture.
99983
+ * @remarks
99984
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99985
+ * @beta
99986
+ */
99987
+ texture70Percent = "Texture70Percent",
99988
+ /**
99989
+ * Represents 75 percent texture.
99990
+ * @remarks
99991
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99992
+ * @beta
99993
+ */
99994
+ texture75Percent = "Texture75Percent",
99995
+ /**
99996
+ * Represents 80 percent texture.
99997
+ * @remarks
99998
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99999
+ * @beta
100000
+ */
100001
+ texture80Percent = "Texture80Percent",
100002
+ /**
100003
+ * Represents 85 percent texture.
100004
+ * @remarks
100005
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100006
+ * @beta
100007
+ */
100008
+ texture85Percent = "Texture85Percent",
100009
+ /**
100010
+ * Represents 87.5 percent texture.
100011
+ * @remarks
100012
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100013
+ * @beta
100014
+ */
100015
+ texture87Pt5Percent = "Texture87Pt5Percent",
100016
+ /**
100017
+ * Represents 90 percent texture.
100018
+ * @remarks
100019
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100020
+ * @beta
100021
+ */
100022
+ texture90Percent = "Texture90Percent",
100023
+ /**
100024
+ * Represents 95 percent texture.
100025
+ * @remarks
100026
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100027
+ * @beta
100028
+ */
100029
+ texture95Percent = "Texture95Percent",
100030
+ /**
100031
+ * Represents dark diagonal-down texture.
100032
+ * @remarks
100033
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100034
+ * @beta
100035
+ */
100036
+ textureDarkDiagonalDown = "TextureDarkDiagonalDown",
100037
+ /**
100038
+ * Represents dark diagonal-up texture.
100039
+ * @remarks
100040
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100041
+ * @beta
100042
+ */
100043
+ textureDarkDiagonalUp = "TextureDarkDiagonalUp",
100044
+ /**
100045
+ * Represents dark horizontal-cross texture.
100046
+ * @remarks
100047
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100048
+ * @beta
100049
+ */
100050
+ textureDarkGrid = "TextureDarkGrid",
100051
+ /**
100052
+ * Represents dark horizontal texture.
100053
+ * @remarks
100054
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100055
+ * @beta
100056
+ */
100057
+ textureDarkHorizontal = "TextureDarkHorizontal",
100058
+ /**
100059
+ * Represents dark diagonal-cross texture.
100060
+ * @remarks
100061
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100062
+ * @beta
100063
+ */
100064
+ textureDarkTrellis = "TextureDarkTrellis",
100065
+ /**
100066
+ * Represents dark vertical texture.
100067
+ * @remarks
100068
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100069
+ * @beta
100070
+ */
100071
+ textureDarkVertical = "TextureDarkVertical",
100072
+ /**
100073
+ * Represents light diagonal-down texture.
100074
+ * @remarks
100075
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100076
+ * @beta
100077
+ */
100078
+ textureLightDiagonalDown = "TextureLightDiagonalDown",
100079
+ /**
100080
+ * Represents light diagonal-up texture.
100081
+ * @remarks
100082
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100083
+ * @beta
100084
+ */
100085
+ textureLightDiagonalUp = "TextureLightDiagonalUp",
100086
+ /**
100087
+ * Represents light horizontal-cross texture.
100088
+ * @remarks
100089
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100090
+ * @beta
100091
+ */
100092
+ textureLightGrid = "TextureLightGrid",
100093
+ /**
100094
+ * Represents light horizontal texture.
100095
+ * @remarks
100096
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100097
+ * @beta
100098
+ */
100099
+ textureLightHorizontal = "TextureLightHorizontal",
100100
+ /**
100101
+ * Represents light diagonal-cross texture.
100102
+ * @remarks
100103
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100104
+ * @beta
100105
+ */
100106
+ textureLightTrellis = "TextureLightTrellis",
100107
+ /**
100108
+ * Represents light vertical texture.
100109
+ * @remarks
100110
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100111
+ * @beta
100112
+ */
100113
+ textureLightVertical = "TextureLightVertical",
100114
+ /**
100115
+ * Represents that there's no texture.
100116
+ * @remarks
100117
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100118
+ * @beta
100119
+ */
100120
+ textureNone = "TextureNone",
100121
+ /**
100122
+ * Represents solid texture.
100123
+ * @remarks
100124
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100125
+ * @beta
100126
+ */
100127
+ textureSolid = "TextureSolid",
100128
+ }
99630
100129
  enum ErrorCodes {
99631
100130
  accessDenied = "AccessDenied",
99632
100131
  generalException = "GeneralException",
@@ -100650,6 +101149,14 @@ declare namespace Word {
100650
101149
  * [Api set: WordApi 1.5]
100651
101150
  */
100652
101151
  paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
101152
+ /**
101153
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
101154
+ *
101155
+ * @remarks
101156
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101157
+ * @beta
101158
+ */
101159
+ shading?: Word.Interfaces.ShadingUpdateData;
100653
101160
  /**
100654
101161
  * Specifies the priority.
100655
101162
  *
@@ -100679,6 +101186,33 @@ declare namespace Word {
100679
101186
  */
100680
101187
  visibility?: boolean;
100681
101188
  }
101189
+ /** An interface for updating data on the Shading object, for use in `shading.set({ ... })`. */
101190
+ interface ShadingUpdateData {
101191
+ /**
101192
+ * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
101193
+ *
101194
+ * @remarks
101195
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101196
+ * @beta
101197
+ */
101198
+ backgroundPatternColor?: string;
101199
+ /**
101200
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
101201
+ *
101202
+ * @remarks
101203
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101204
+ * @beta
101205
+ */
101206
+ foregroundPatternColor?: string;
101207
+ /**
101208
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
101209
+ *
101210
+ * @remarks
101211
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101212
+ * @beta
101213
+ */
101214
+ texture?: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
101215
+ }
100682
101216
  /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
100683
101217
  interface TableUpdateData {
100684
101218
  /**
@@ -102441,6 +102975,14 @@ declare namespace Word {
102441
102975
  * [Api set: WordApi 1.5]
102442
102976
  */
102443
102977
  paragraphFormat?: Word.Interfaces.ParagraphFormatData;
102978
+ /**
102979
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
102980
+ *
102981
+ * @remarks
102982
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
102983
+ * @beta
102984
+ */
102985
+ shading?: Word.Interfaces.ShadingData;
102444
102986
  /**
102445
102987
  * Gets the name of an existing style to use as the base formatting of another style.
102446
102988
  *
@@ -102527,6 +103069,33 @@ declare namespace Word {
102527
103069
  */
102528
103070
  visibility?: boolean;
102529
103071
  }
103072
+ /** An interface describing the data returned by calling `shading.toJSON()`. */
103073
+ interface ShadingData {
103074
+ /**
103075
+ * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
103076
+ *
103077
+ * @remarks
103078
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
103079
+ * @beta
103080
+ */
103081
+ backgroundPatternColor?: string;
103082
+ /**
103083
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
103084
+ *
103085
+ * @remarks
103086
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
103087
+ * @beta
103088
+ */
103089
+ foregroundPatternColor?: string;
103090
+ /**
103091
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
103092
+ *
103093
+ * @remarks
103094
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
103095
+ * @beta
103096
+ */
103097
+ texture?: Word.ShadingTextureType | "Texture10Percent" | "Texture12Pt5Percent" | "Texture15Percent" | "Texture20Percent" | "Texture25Percent" | "Texture30Percent" | "Texture35Percent" | "Texture37Pt5Percent" | "Texture40Percent" | "Texture45Percent" | "Texture50Percent" | "Texture55Percent" | "Texture5Percent" | "Texture60Percent" | "Texture62Pt5Percent" | "Texture65Percent" | "Texture70Percent" | "Texture75Percent" | "Texture80Percent" | "Texture85Percent" | "Texture87Pt5Percent" | "Texture90Percent" | "Texture95Percent" | "TextureDarkDiagonalDown" | "TextureDarkDiagonalUp" | "TextureDarkGrid" | "TextureDarkHorizontal" | "TextureDarkTrellis" | "TextureDarkVertical" | "TextureLightDiagonalDown" | "TextureLightDiagonalUp" | "TextureLightGrid" | "TextureLightHorizontal" | "TextureLightTrellis" | "TextureLightVertical" | "TextureNone" | "TextureSolid";
103098
+ }
102530
103099
  /** An interface describing the data returned by calling `table.toJSON()`. */
102531
103100
  interface TableData {
102532
103101
  /**
@@ -105773,6 +106342,14 @@ declare namespace Word {
105773
106342
  * [Api set: WordApi 1.5]
105774
106343
  */
105775
106344
  paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
106345
+ /**
106346
+ * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
106347
+ *
106348
+ * @remarks
106349
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106350
+ * @beta
106351
+ */
106352
+ shading?: Word.Interfaces.ShadingLoadOptions;
105776
106353
  /**
105777
106354
  * For EACH ITEM in the collection: Gets the name of an existing style to use as the base formatting of another style.
105778
106355
  *
@@ -105892,6 +106469,14 @@ declare namespace Word {
105892
106469
  * [Api set: WordApi 1.5]
105893
106470
  */
105894
106471
  paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
106472
+ /**
106473
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
106474
+ *
106475
+ * @remarks
106476
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106477
+ * @beta
106478
+ */
106479
+ shading?: Word.Interfaces.ShadingLoadOptions;
105895
106480
  /**
105896
106481
  * Gets the name of an existing style to use as the base formatting of another style.
105897
106482
  *
@@ -105978,6 +106563,43 @@ declare namespace Word {
105978
106563
  */
105979
106564
  visibility?: boolean;
105980
106565
  }
106566
+ /**
106567
+ * Represents the shading object.
106568
+ *
106569
+ * @remarks
106570
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106571
+ * @beta
106572
+ */
106573
+ interface ShadingLoadOptions {
106574
+ /**
106575
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
106576
+ */
106577
+ $all?: boolean;
106578
+ /**
106579
+ * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
106580
+ *
106581
+ * @remarks
106582
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106583
+ * @beta
106584
+ */
106585
+ backgroundPatternColor?: boolean;
106586
+ /**
106587
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
106588
+ *
106589
+ * @remarks
106590
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106591
+ * @beta
106592
+ */
106593
+ foregroundPatternColor?: boolean;
106594
+ /**
106595
+ * Specifies the shading texture of the object.
106596
+ *
106597
+ * @remarks
106598
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106599
+ * @beta
106600
+ */
106601
+ texture?: boolean;
106602
+ }
105981
106603
  /**
105982
106604
  * Represents a table in a Word document.
105983
106605
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.402",
3
+ "version": "1.0.404",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "a3545d6007c97f7cee291d7c5d89d3ef78859764061d65765aa8e3283d407122",
48
+ "typesPublisherContentHash": "f1d2eee82a6816b91e09a6f0f09a3e6b57253aea229b58cbd73d44069069158c",
49
49
  "typeScriptVersion": "4.3"
50
50
  }