@types/office-js-preview 1.0.589 → 1.0.591

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-preview (https://github.com
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: Thu, 08 May 2025 16:39:09 GMT
11
+ * Last updated: Mon, 12 May 2025 16:39:10 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -24830,20 +24830,20 @@ declare namespace Excel {
24830
24830
  referencedValues?: ReferencedValue[];
24831
24831
  }
24832
24832
  /**
24833
- * The Base64-encoded type and data of an image.
24834
- *
24835
- * @remarks
24836
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24837
- * @beta
24838
- */
24833
+ * The Base64-encoded type and data of an image.
24834
+ *
24835
+ * @remarks
24836
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24837
+ * @beta
24838
+ */
24839
24839
  interface Base64EncodedImage {
24840
24840
  /**
24841
- * The file type of the Base64-encoded image.
24842
- *
24843
- * @remarks
24844
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24845
- * @beta
24846
- */
24841
+ * The file type of the Base64-encoded image.
24842
+ *
24843
+ * @remarks
24844
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24845
+ * @beta
24846
+ */
24847
24847
  type: Base64EncodingType | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP";
24848
24848
  /**
24849
24849
  * The Base64-encoded string.
@@ -24979,7 +24979,7 @@ declare namespace Excel {
24979
24979
  firstRowIsHeader?: boolean;
24980
24980
  }
24981
24981
  /**
24982
- * Represents the compact layout properties for a value.
24982
+ * The basic compact layout properties.
24983
24983
  *
24984
24984
  * @remarks
24985
24985
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -25022,7 +25022,7 @@ declare namespace Excel {
25022
25022
  interface BasicViewLayouts {
25023
25023
  /**
25024
25024
  * Represents the layout of this value and its properties in card view.
25025
- * If the `BasicCardLayout` object doesn't have a layout property, it's assumed to be "Entity".
25025
+ * If the `BasicCardLayout` object does not have a layout property, it is assumed to be "Entity".
25026
25026
  *
25027
25027
  * @remarks
25028
25028
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -30733,11 +30733,11 @@ declare namespace Excel {
30733
30733
  */
30734
30734
  text?: string;
30735
30735
  /**
30736
- * Represents the properties of this entity and their metadata.
30737
- *
30738
- * @remarks
30739
- * [Api set: ExcelApi 1.16]
30740
- */
30736
+ * Represents the properties of this entity and their metadata.
30737
+ *
30738
+ * @remarks
30739
+ * [Api set: ExcelApi 1.16]
30740
+ */
30741
30741
  properties?: {
30742
30742
  [key: string]: EntityPropertyType;
30743
30743
  };
@@ -31401,11 +31401,11 @@ declare namespace Excel {
31401
31401
  */
31402
31402
  text?: string;
31403
31403
  /**
31404
- * Represents the properties of this linked entity and their metadata.
31405
- *
31406
- * @remarks
31407
- * [Api set: ExcelApi 1.16]
31408
- */
31404
+ * Represents the properties of this linked entity and their metadata.
31405
+ *
31406
+ * @remarks
31407
+ * [Api set: ExcelApi 1.16]
31408
+ */
31409
31409
  properties?: {
31410
31410
  [key: string]: EntityPropertyType;
31411
31411
  };
@@ -37382,14 +37382,7 @@ declare namespace Excel {
37382
37382
  * @remarks
37383
37383
  * [Api set: ExcelApi 1.18]
37384
37384
  */
37385
- checkbox = "Checkbox",
37386
- /**
37387
- * Type representing a dropdown control.
37388
- * @remarks
37389
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
37390
- * @beta
37391
- */
37392
- dropdown = "Dropdown"
37385
+ checkbox = "Checkbox"
37393
37386
  }
37394
37387
  /**
37395
37388
  * Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.
@@ -39785,7 +39778,7 @@ declare namespace Excel {
39785
39778
  * @remarks
39786
39779
  * [Api set: ExcelApi 1.1]
39787
39780
  *
39788
- * @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned.
39781
+ * @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds the character limit, this method returns an `InvalidArgument` error.
39789
39782
  */
39790
39783
  getRange(address?: string): Excel.Range;
39791
39784
  /**
@@ -41235,7 +41228,7 @@ declare namespace Excel {
41235
41228
  getDirectPrecedents(): Excel.WorkbookRangeAreas;
41236
41229
  /**
41237
41230
  * Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.
41238
- * Unlike `getCellProperties`, which only shows properties that are set directly for the cell, this returns properties that are displayed from indirect sources, such as conditional formatting or styles.
41231
+ Unlike `getCellProperties`, which only shows properties that are set directly for the cell, this returns properties that are displayed from indirect sources, such as conditional formatting or styles.
41239
41232
  *
41240
41233
  * @remarks
41241
41234
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60140,8 +60133,8 @@ declare namespace Excel {
60140
60133
  }
60141
60134
  /**
60142
60135
  * Represents a specific category or field of information that shares some common characteristics or attributes.
60143
- * A data domain is linked to a data provider that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
60144
- * A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
60136
+ A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
60137
+ A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
60145
60138
  *
60146
60139
  * @remarks
60147
60140
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60152,7 +60145,7 @@ declare namespace Excel {
60152
60145
  context: RequestContext;
60153
60146
  /**
60154
60147
  * Gets the name of the data provider for the linked entity data domain.
60155
- * This name can change based on the information from the data provider.
60148
+ This name can change based on the information provided by the data provider.
60156
60149
  *
60157
60150
  * @remarks
60158
60151
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60161,7 +60154,7 @@ declare namespace Excel {
60161
60154
  readonly dataProvider: string;
60162
60155
  /**
60163
60156
  * Gets the ID of the linked entity data domain defined by Office Add-ins.
60164
- * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60157
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60165
60158
  *
60166
60159
  * @remarks
60167
60160
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60170,7 +60163,7 @@ declare namespace Excel {
60170
60163
  readonly id: string;
60171
60164
  /**
60172
60165
  * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
60173
- * Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
60166
+ Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
60174
60167
  *
60175
60168
  * @remarks
60176
60169
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60189,7 +60182,7 @@ declare namespace Excel {
60189
60182
  readonly loadFunctionId: string;
60190
60183
  /**
60191
60184
  * Gets the name of the linked entity data domain.
60192
- * This name can change based on the information from the data provider.
60185
+ This name can change based on the information provided by the data provider.
60193
60186
  *
60194
60187
  * @remarks
60195
60188
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60198,7 +60191,7 @@ declare namespace Excel {
60198
60191
  readonly name: string;
60199
60192
  /**
60200
60193
  * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
60201
- * The refresh interval only applies if the `refreshMode` is set to "Periodic".
60194
+ The refresh interval only applies if the `refreshMode` is set to "Periodic".
60202
60195
  *
60203
60196
  * @remarks
60204
60197
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60207,8 +60200,8 @@ declare namespace Excel {
60207
60200
  readonly periodicRefreshInterval: number;
60208
60201
  /**
60209
60202
  * Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
60210
- * If the refresh mode being set isn't supported by this linked entity data domain, then the current refresh mode is not changed.
60211
- * If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
60203
+ If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
60204
+ If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
60212
60205
  *
60213
60206
  * @remarks
60214
60207
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60217,8 +60210,8 @@ declare namespace Excel {
60217
60210
  refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
60218
60211
  /**
60219
60212
  * Gets the service ID of the linked entity data domain.
60220
- * This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
60221
- * This ID never changes across user sessions.
60213
+ This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
60214
+ This ID never changes across user sessions.
60222
60215
  *
60223
60216
  * @remarks
60224
60217
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60227,7 +60220,7 @@ declare namespace Excel {
60227
60220
  readonly serviceId: number;
60228
60221
  /**
60229
60222
  * Gets all the refresh modes supported by the linked entity data domain.
60230
- * This array can change based on the information provided by the data provider.
60223
+ This array can change based on the information provided by the data provider.
60231
60224
  *
60232
60225
  * @remarks
60233
60226
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60236,8 +60229,8 @@ declare namespace Excel {
60236
60229
  readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];
60237
60230
  /**
60238
60231
  * Deletes this object from the `LinkedEntityDataDomainCollection`.
60239
- * Once the linked entity data domain is deleted, new `LinkedEntityCellValue` objects of this linked entity data domain can't be created and existing `LinkedEntityCellValue` objects can't be refreshed.
60240
- * An Office Add-in can only delete linked entity data domains that it created.
60232
+ Once the linked entity data domain is deleted, new `LinkedEntityCellValue` objects of this linked entity data domain can't be created and existing `LinkedEntityCellValue` objects can't be refreshed.
60233
+ An Office Add-in can only delete linked entity data domains that it created.
60241
60234
  *
60242
60235
  * @remarks
60243
60236
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60246,7 +60239,7 @@ declare namespace Excel {
60246
60239
  delete(): void;
60247
60240
  /**
60248
60241
  * Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.
60249
- * The refresh request can fail if the data provider is busy or temporarily inaccessible.
60242
+ The refresh request can fail if the data provider is busy or temporarily inaccessible.
60250
60243
  *
60251
60244
  * @remarks
60252
60245
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60290,7 +60283,7 @@ declare namespace Excel {
60290
60283
  interface LinkedEntityDataDomainAddedEventArgs {
60291
60284
  /**
60292
60285
  * Gets the ID of the linked entity data domain that was just added to the workbook. This ID is defined by Office Add-ins.
60293
- * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60286
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60294
60287
  *
60295
60288
  * @remarks
60296
60289
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60324,7 +60317,7 @@ declare namespace Excel {
60324
60317
  }
60325
60318
  /**
60326
60319
  * Represents a collection of `LinkedEntityDataDomain` objects.
60327
- * The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
60320
+ The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
60328
60321
  *
60329
60322
  * @remarks
60330
60323
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60337,7 +60330,7 @@ declare namespace Excel {
60337
60330
  readonly items: Excel.LinkedEntityDataDomain[];
60338
60331
  /**
60339
60332
  * Adds a linked entity data domain object defined by the Office Add-in to the collection.
60340
- * Once the linked entity data domain is added, it can be used to create `LinkedEntityCellValue` objects.
60333
+ Once the linked entity data domain is added, it can be used to create `LinkedEntityCellValue` objects.
60341
60334
  *
60342
60335
  * @remarks
60343
60336
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60389,8 +60382,8 @@ declare namespace Excel {
60389
60382
  getItemByName(name: string): Excel.LinkedEntityDataDomain;
60390
60383
  /**
60391
60384
  * Gets a linked entity data domain by its `name`.
60392
- * If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
60393
- * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
60385
+ If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
60386
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
60394
60387
  *
60395
60388
  * @remarks
60396
60389
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60402,8 +60395,8 @@ declare namespace Excel {
60402
60395
  getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;
60403
60396
  /**
60404
60397
  * Gets a linked entity data domain by its `id`.
60405
- * If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
60406
- * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
60398
+ If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
60399
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
60407
60400
  *
60408
60401
  * @remarks
60409
60402
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60415,7 +60408,7 @@ declare namespace Excel {
60415
60408
  getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
60416
60409
  /**
60417
60410
  * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
60418
- * The refresh request can fail if the data providers are busy or temporarily inaccessible.
60411
+ The refresh request can fail if the data providers are busy or temporarily inaccessible.
60419
60412
  *
60420
60413
  * @remarks
60421
60414
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60494,7 +60487,7 @@ declare namespace Excel {
60494
60487
  dataProvider: string;
60495
60488
  /**
60496
60489
  * Gets or sets the ID of the linked entity data domain.
60497
- * This ID must be unique across all linked entity data domains defined by this Office Add-in.
60490
+ This ID must be unique across all linked entity data domains defined by this Office Add-in.
60498
60491
  *
60499
60492
  * @remarks
60500
60493
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60512,7 +60505,7 @@ declare namespace Excel {
60512
60505
  loadFunctionId: string;
60513
60506
  /**
60514
60507
  * Gets or sets the name of the linked entity data domain.
60515
- * This name must be unique across all linked entity data domains defined by this Office Add-in.
60508
+ This name must be unique across all linked entity data domains defined by this Office Add-in.
60516
60509
  *
60517
60510
  * @remarks
60518
60511
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60521,8 +60514,8 @@ declare namespace Excel {
60521
60514
  name: string;
60522
60515
  /**
60523
60516
  * Gets or sets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300.
60524
- * This property is required if the `supportedRefreshModes` array contains the value "Periodic".
60525
- * This property only applies if the `refreshMode` of the linked entity data domain is set to "Periodic".
60517
+ This property is required if the `supportedRefreshModes` array contains the value "Periodic".
60518
+ This property only applies if the `refreshMode` of the linked entity data domain is set to "Periodic".
60526
60519
  *
60527
60520
  * @remarks
60528
60521
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60531,10 +60524,10 @@ declare namespace Excel {
60531
60524
  periodicRefreshInterval?: number;
60532
60525
  /**
60533
60526
  * Gets or sets all the refresh modes supported by the linked entity data domain.
60534
- * The default value is `["Manual"]`, which is always supported even if not specified.
60535
- * The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open.
60536
- * If the refresh mode wasn't saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain.
60537
- * If the array has the value "Periodic", the `periodicRefreshInterval` property must also be set for the linked entity data domain.
60527
+ The default value is `["Manual"]`, which is always supported even if not specified.
60528
+ The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open.
60529
+ If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain.
60530
+ If the array has the value "Periodic", the `periodicRefreshInterval` property must also be set for the linked entity data domain.
60538
60531
  *
60539
60532
  * @remarks
60540
60533
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60560,7 +60553,7 @@ declare namespace Excel {
60560
60553
  errors?: string[];
60561
60554
  /**
60562
60555
  * Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. This ID is defined by Office Add-ins.
60563
- * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60556
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60564
60557
  *
60565
60558
  * @remarks
60566
60559
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -60610,15 +60603,14 @@ declare namespace Excel {
60610
60603
  enum LinkedEntityDataDomainRefreshMode {
60611
60604
  /**
60612
60605
  * Refresh mode is unknown or unsupported.
60613
- *
60614
60606
  * @remarks
60615
60607
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
60616
60608
  * @beta
60617
60609
  */
60618
60610
  unknown = "Unknown",
60619
60611
  /**
60620
- * Manual refresh by the user. Refresh is not triggered automatically.
60621
- *
60612
+ * Manual refresh by the user.
60613
+ Refresh is not triggered automatically.
60622
60614
  * @remarks
60623
60615
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
60624
60616
  * @beta
@@ -60626,8 +60618,7 @@ declare namespace Excel {
60626
60618
  manual = "Manual",
60627
60619
  /**
60628
60620
  * Refresh on workbook load, applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60629
- * Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins.
60630
- *
60621
+ Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins.
60631
60622
  * @remarks
60632
60623
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
60633
60624
  * @beta
@@ -60635,9 +60626,8 @@ declare namespace Excel {
60635
60626
  onLoad = "OnLoad",
60636
60627
  /**
60637
60628
  * Refresh automatically based on the frequency, in seconds, specified by `periodicRefreshInterval`.
60638
- * For linked entity data domains defined by service data providers, such as Bing or Power BI, this value also initiates a refresh each time the workbook is opened.
60639
- * For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads.
60640
- *
60629
+ For linked entity data domains defined by service data providers, such as Bing or Power BI, this value also initiates a refresh each time the workbook is opened.
60630
+ For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads.
60641
60631
  * @remarks
60642
60632
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
60643
60633
  * @beta
@@ -60654,7 +60644,7 @@ declare namespace Excel {
60654
60644
  interface LinkedEntityDataDomainRefreshModeChangedEventArgs {
60655
60645
  /**
60656
60646
  * Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins.
60657
- * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60647
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
60658
60648
  *
60659
60649
  * @remarks
60660
60650
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -67943,7 +67933,9 @@ declare namespace Excel {
67943
67933
  */
67944
67934
  getItemAt(index: number): Excel.Note;
67945
67935
  /**
67946
- * Gets a note by its cell address. If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
67936
+ * Gets a note by its cell address.
67937
+ If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
67938
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
67947
67939
  *
67948
67940
  * @remarks
67949
67941
  * [Api set: ExcelApi 1.18]
@@ -84130,7 +84122,7 @@ declare namespace Excel {
84130
84122
  interface LinkedEntityDataDomainData {
84131
84123
  /**
84132
84124
  * Gets the name of the data provider for the linked entity data domain.
84133
- This name can change based on the information from the data provider.
84125
+ This name can change based on the information provided by the data provider.
84134
84126
  *
84135
84127
  * @remarks
84136
84128
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -84167,7 +84159,7 @@ declare namespace Excel {
84167
84159
  loadFunctionId?: string;
84168
84160
  /**
84169
84161
  * Gets the name of the linked entity data domain.
84170
- This name can change based on the information from the data provider.
84162
+ This name can change based on the information provided by the data provider.
84171
84163
  *
84172
84164
  * @remarks
84173
84165
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -96238,7 +96230,7 @@ declare namespace Excel {
96238
96230
  $all?: boolean;
96239
96231
  /**
96240
96232
  * Gets the name of the data provider for the linked entity data domain.
96241
- This name can change based on the information from the data provider.
96233
+ This name can change based on the information provided by the data provider.
96242
96234
  *
96243
96235
  * @remarks
96244
96236
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -96275,7 +96267,7 @@ declare namespace Excel {
96275
96267
  loadFunctionId?: boolean;
96276
96268
  /**
96277
96269
  * Gets the name of the linked entity data domain.
96278
- This name can change based on the information from the data provider.
96270
+ This name can change based on the information provided by the data provider.
96279
96271
  *
96280
96272
  * @remarks
96281
96273
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -96336,7 +96328,7 @@ declare namespace Excel {
96336
96328
  $all?: boolean;
96337
96329
  /**
96338
96330
  * For EACH ITEM in the collection: Gets the name of the data provider for the linked entity data domain.
96339
- This name can change based on the information from the data provider.
96331
+ This name can change based on the information provided by the data provider.
96340
96332
  *
96341
96333
  * @remarks
96342
96334
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -96373,7 +96365,7 @@ declare namespace Excel {
96373
96365
  loadFunctionId?: boolean;
96374
96366
  /**
96375
96367
  * For EACH ITEM in the collection: Gets the name of the linked entity data domain.
96376
- This name can change based on the information from the data provider.
96368
+ This name can change based on the information provided by the data provider.
96377
96369
  *
96378
96370
  * @remarks
96379
96371
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -100746,10 +100738,8 @@ declare namespace Word {
100746
100738
  * [Api set: WordApi 1.4]
100747
100739
  *
100748
100740
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
100749
- * Support for managing fields is similar to what's available in the Word UI.
100750
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
100751
- * To learn more about Word UI clients that more fully support fields,
100752
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
100741
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
100742
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
100753
100743
  */
100754
100744
  class Field extends OfficeExtension.ClientObject {
100755
100745
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -100950,10 +100940,8 @@ declare namespace Word {
100950
100940
  * [Api set: WordApi 1.4]
100951
100941
  *
100952
100942
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
100953
- * Support for managing fields is similar to what's available in the Word UI.
100954
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
100955
- * To learn more about Word UI clients that more fully support fields,
100956
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
100943
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
100944
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
100957
100945
  */
100958
100946
  class FieldCollection extends OfficeExtension.ClientObject {
100959
100947
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -107090,7 +107078,7 @@ declare namespace Word {
107090
107078
  */
107091
107079
  rotation: number;
107092
107080
  /**
107093
- * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
107081
+ * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
107094
107082
  *
107095
107083
  * @remarks
107096
107084
  * [Api set: WordApiDesktop 1.2]
@@ -107836,7 +107824,7 @@ declare namespace Word {
107836
107824
  toJSON(): Word.Interfaces.ShapeTextWrapData;
107837
107825
  }
107838
107826
  /**
107839
- * ChangeTracking mode.
107827
+ * Represents the possible change tracking modes.
107840
107828
  *
107841
107829
  * @remarks
107842
107830
  * [Api set: WordApi 1.4]
@@ -115051,7 +115039,7 @@ declare namespace Word {
115051
115039
  */
115052
115040
  rotation?: number;
115053
115041
  /**
115054
- * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
115042
+ * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
115055
115043
  *
115056
115044
  * @remarks
115057
115045
  * [Api set: WordApiDesktop 1.2]
@@ -117736,7 +117724,7 @@ declare namespace Word {
117736
117724
  */
117737
117725
  rotation?: number;
117738
117726
  /**
117739
- * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
117727
+ * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
117740
117728
  *
117741
117729
  * @remarks
117742
117730
  * [Api set: WordApiDesktop 1.2]
@@ -119343,10 +119331,8 @@ declare namespace Word {
119343
119331
  * [Api set: WordApi 1.4]
119344
119332
  *
119345
119333
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
119346
- * Support for managing fields is similar to what's available in the Word UI.
119347
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
119348
- * To learn more about Word UI clients that more fully support fields,
119349
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
119334
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
119335
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
119350
119336
  */
119351
119337
  interface FieldLoadOptions {
119352
119338
  /**
@@ -119461,10 +119447,8 @@ declare namespace Word {
119461
119447
  * [Api set: WordApi 1.4]
119462
119448
  *
119463
119449
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
119464
- * Support for managing fields is similar to what's available in the Word UI.
119465
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
119466
- * To learn more about Word UI clients that more fully support fields,
119467
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
119450
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
119451
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
119468
119452
  */
119469
119453
  interface FieldCollectionLoadOptions {
119470
119454
  /**
@@ -122603,7 +122587,7 @@ declare namespace Word {
122603
122587
  */
122604
122588
  rotation?: boolean;
122605
122589
  /**
122606
- * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
122590
+ * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
122607
122591
  *
122608
122592
  * @remarks
122609
122593
  * [Api set: WordApiDesktop 1.2]
@@ -122877,7 +122861,7 @@ declare namespace Word {
122877
122861
  */
122878
122862
  rotation?: boolean;
122879
122863
  /**
122880
- * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
122864
+ * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
122881
122865
  *
122882
122866
  * @remarks
122883
122867
  * [Api set: WordApiDesktop 1.2]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.589",
3
+ "version": "1.0.591",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "230382a67fcce404264fedda61aea00523b110a97d4852603ae4c21a34ef624e",
49
+ "typesPublisherContentHash": "06c435846eb6a22cf08eb82d238ab77c05e680c080e338f012149053e6507741",
50
50
  "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }