@types/office-js 1.0.248 → 1.0.251

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +284 -284
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -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.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 19 Apr 2022 21:31:36 GMT
11
+ * Last updated: Wed, 04 May 2022 00:01:36 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -1850,7 +1850,7 @@ declare namespace Office {
1850
1850
  *
1851
1851
  * **Hosts**: Excel, Outlook (in preview), PowerPoint, Word
1852
1852
  *
1853
- * `OfficeTheme` is only supported in Office on Windows.
1853
+ * `OfficeTheme` is only supported in Office on Windows, Mac, and the web.
1854
1854
  */
1855
1855
  interface OfficeTheme {
1856
1856
  /**
@@ -13980,7 +13980,7 @@ declare namespace Office {
13980
13980
  *
13981
13981
  * The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls.
13982
13982
  *
13983
- * You can pass both the token and either an attachment identifier or item identifier to a third-party system. The third-party system uses
13983
+ * You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
13984
13984
  * the token as a bearer authorization token to call the Exchange Web Services (EWS)
13985
13985
  * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or
13986
13986
  * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
@@ -14020,7 +14020,7 @@ declare namespace Office {
14020
14020
  *
14021
14021
  * The token is returned as a string in the `asyncResult.value` property.
14022
14022
  *
14023
- * You can pass both the token and either an attachment identifier or item identifier to a third-party system. The third-party system uses
14023
+ * You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
14024
14024
  * the token as a bearer authorization token to call the Exchange Web Services (EWS)
14025
14025
  * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or
14026
14026
  * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an
@@ -14068,7 +14068,7 @@ declare namespace Office {
14068
14068
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
14069
14069
  *
14070
14070
  * The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
14071
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with a third-party system}.
14071
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with an external system}.
14072
14072
  *
14073
14073
  * **Errors**:
14074
14074
  *
@@ -96990,189 +96990,120 @@ declare namespace PowerPoint {
96990
96990
  targetSlideId?: string;
96991
96991
  }
96992
96992
  /**
96993
- * Represents a single tag in the slide.
96994
- *
96995
- * @remarks
96996
- * [Api set: PowerPointApi 1.3]
96997
- */
96998
- class Tag extends OfficeExtension.ClientObject {
96999
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97000
- context: RequestContext;
97001
- /**
97002
- * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97003
- *
97004
- * @remarks
97005
- * [Api set: PowerPointApi 1.3]
97006
- */
97007
- readonly key: string;
97008
- /**
97009
- * Gets the value of the tag.
97010
- *
97011
- * @remarks
97012
- * [Api set: PowerPointApi 1.3]
97013
- */
97014
- value: string;
97015
- /**
97016
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97017
- *
97018
- * @param options Provides options for which properties of the object to load.
97019
- */
97020
- load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;
97021
- /**
97022
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97023
- *
97024
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97025
- */
97026
- load(propertyNames?: string | string[]): PowerPoint.Tag;
97027
- /**
97028
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97029
- *
97030
- * @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.
97031
- */
97032
- load(propertyNamesAndPaths?: {
97033
- select?: string;
97034
- expand?: string;
97035
- }): PowerPoint.Tag;
97036
- /**
97037
- * 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.)
97038
- * Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
97039
- */
97040
- toJSON(): PowerPoint.Interfaces.TagData;
97041
- }
97042
- /**
97043
- * Represents the collection of tags.
96993
+ * Represents the collection of shapes.
97044
96994
  *
97045
96995
  * @remarks
97046
96996
  * [Api set: PowerPointApi 1.3]
97047
96997
  */
97048
- class TagCollection extends OfficeExtension.ClientObject {
96998
+ class ShapeCollection extends OfficeExtension.ClientObject {
97049
96999
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97050
97000
  context: RequestContext;
97051
97001
  /** Gets the loaded child items in this collection. */
97052
- readonly items: PowerPoint.Tag[];
97053
- /**
97054
- * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
97055
- *
97056
- * @remarks
97057
- * [Api set: PowerPointApi 1.3]
97058
- *
97059
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
97060
- * @param value The value of the tag.
97061
- */
97062
- add(key: string, value: string): void;
97063
- /**
97064
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
97065
- *
97066
- * @remarks
97067
- * [Api set: PowerPointApi 1.3]
97068
- *
97069
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
97070
- */
97071
- delete(key: string): void;
97002
+ readonly items: PowerPoint.Shape[];
97072
97003
  /**
97073
- * Gets the number of tags in the collection.
97004
+ * Gets the number of shapes in the collection.
97074
97005
  *
97075
97006
  * @remarks
97076
97007
  * [Api set: PowerPointApi 1.3]
97077
- * @returns The number of tags in the collection.
97008
+ * @returns The number of shapes in the collection.
97078
97009
  */
97079
97010
  getCount(): OfficeExtension.ClientResult<number>;
97080
97011
  /**
97081
- * Gets a tag using its unique ID. An error is thrown if the tag does not exist.
97012
+ * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
97082
97013
  *
97083
97014
  * @remarks
97084
97015
  * [Api set: PowerPointApi 1.3]
97085
97016
  *
97086
- * @param key The ID of the tag.
97087
- * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
97017
+ * @param key The ID of the shape.
97018
+ * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
97088
97019
  */
97089
- getItem(key: string): PowerPoint.Tag;
97020
+ getItem(key: string): PowerPoint.Shape;
97090
97021
  /**
97091
- * Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.
97022
+ * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
97092
97023
  *
97093
97024
  * @remarks
97094
97025
  * [Api set: PowerPointApi 1.3]
97095
97026
  *
97096
- * @param index The index of the tag in the collection.
97097
- * @returns The tag at the given index. An error is thrown if index is out of range.
97027
+ * @param index The index of the shape in the collection.
97028
+ * @returns The shape at the given index. An error is thrown if index is out of range.
97098
97029
  */
97099
- getItemAt(index: number): PowerPoint.Tag;
97030
+ getItemAt(index: number): PowerPoint.Shape;
97100
97031
  /**
97101
- * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
97032
+ * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
97102
97033
  *
97103
97034
  * @remarks
97104
97035
  * [Api set: PowerPointApi 1.3]
97105
97036
  *
97106
- * @param key The ID of the tag.
97107
- * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
97037
+ * @param id The ID of the shape.
97038
+ * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
97108
97039
  */
97109
- getItemOrNullObject(key: string): PowerPoint.Tag;
97040
+ getItemOrNullObject(id: string): PowerPoint.Shape;
97110
97041
  /**
97111
97042
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97112
97043
  *
97113
97044
  * @param options Provides options for which properties of the object to load.
97114
97045
  */
97115
- load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
97046
+ load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
97116
97047
  /**
97117
97048
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97118
97049
  *
97119
97050
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97120
97051
  */
97121
- load(propertyNames?: string | string[]): PowerPoint.TagCollection;
97052
+ load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
97122
97053
  /**
97123
97054
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97124
97055
  *
97125
97056
  * @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.
97126
97057
  */
97127
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
97058
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
97128
97059
  /**
97129
97060
  * 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.)
97130
- * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97061
+ * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97131
97062
  */
97132
- toJSON(): PowerPoint.Interfaces.TagCollectionData;
97063
+ toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
97133
97064
  }
97134
97065
  /**
97135
- * Represents a single shape in the slide.
97066
+ * Represents the layout of a slide.
97136
97067
  *
97137
97068
  * @remarks
97138
97069
  * [Api set: PowerPointApi 1.3]
97139
97070
  */
97140
- class Shape extends OfficeExtension.ClientObject {
97071
+ class SlideLayout extends OfficeExtension.ClientObject {
97141
97072
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97142
97073
  context: RequestContext;
97143
97074
  /**
97144
- * Returns a collection of tags in the shape.
97075
+ * Returns a collection of shapes in the slide layout.
97145
97076
  *
97146
97077
  * @remarks
97147
97078
  * [Api set: PowerPointApi 1.3]
97148
97079
  */
97149
- readonly tags: PowerPoint.TagCollection;
97080
+ readonly shapes: PowerPoint.ShapeCollection;
97150
97081
  /**
97151
- * Gets the unique ID of the shape.
97082
+ * Gets the unique ID of the slide layout.
97152
97083
  *
97153
97084
  * @remarks
97154
97085
  * [Api set: PowerPointApi 1.3]
97155
97086
  */
97156
97087
  readonly id: string;
97157
97088
  /**
97158
- * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
97089
+ * Gets the name of the slide layout.
97159
97090
  *
97160
97091
  * @remarks
97161
97092
  * [Api set: PowerPointApi 1.3]
97162
97093
  */
97163
- delete(): void;
97094
+ readonly name: string;
97164
97095
  /**
97165
97096
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97166
97097
  *
97167
97098
  * @param options Provides options for which properties of the object to load.
97168
97099
  */
97169
- load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
97100
+ load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
97170
97101
  /**
97171
97102
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97172
97103
  *
97173
97104
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97174
97105
  */
97175
- load(propertyNames?: string | string[]): PowerPoint.Shape;
97106
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
97176
97107
  /**
97177
97108
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97178
97109
  *
@@ -97181,111 +97112,119 @@ declare namespace PowerPoint {
97181
97112
  load(propertyNamesAndPaths?: {
97182
97113
  select?: string;
97183
97114
  expand?: string;
97184
- }): PowerPoint.Shape;
97115
+ }): PowerPoint.SlideLayout;
97185
97116
  /**
97186
97117
  * 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.)
97187
- * Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
97118
+ * Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
97188
97119
  */
97189
- toJSON(): PowerPoint.Interfaces.ShapeData;
97120
+ toJSON(): PowerPoint.Interfaces.SlideLayoutData;
97190
97121
  }
97191
97122
  /**
97192
- * Represents the collection of shapes.
97123
+ * Represents the collection of layouts provided by the Slide Master for slides.
97193
97124
  *
97194
97125
  * @remarks
97195
97126
  * [Api set: PowerPointApi 1.3]
97196
97127
  */
97197
- class ShapeCollection extends OfficeExtension.ClientObject {
97128
+ class SlideLayoutCollection extends OfficeExtension.ClientObject {
97198
97129
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97199
97130
  context: RequestContext;
97200
97131
  /** Gets the loaded child items in this collection. */
97201
- readonly items: PowerPoint.Shape[];
97132
+ readonly items: PowerPoint.SlideLayout[];
97202
97133
  /**
97203
- * Gets the number of shapes in the collection.
97134
+ * Gets the number of layouts in the collection.
97204
97135
  *
97205
97136
  * @remarks
97206
97137
  * [Api set: PowerPointApi 1.3]
97207
- * @returns The number of shapes in the collection.
97138
+ * @returns The number of layouts in the collection.
97208
97139
  */
97209
97140
  getCount(): OfficeExtension.ClientResult<number>;
97210
97141
  /**
97211
- * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
97142
+ * Gets a layout using its unique ID.
97212
97143
  *
97213
97144
  * @remarks
97214
97145
  * [Api set: PowerPointApi 1.3]
97215
97146
  *
97216
- * @param key The ID of the shape.
97217
- * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
97147
+ * @param key The ID of the layout.
97148
+ * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
97218
97149
  */
97219
- getItem(key: string): PowerPoint.Shape;
97150
+ getItem(key: string): PowerPoint.SlideLayout;
97220
97151
  /**
97221
- * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
97152
+ * Gets a layout using its zero-based index in the collection.
97222
97153
  *
97223
97154
  * @remarks
97224
97155
  * [Api set: PowerPointApi 1.3]
97225
97156
  *
97226
- * @param index The index of the shape in the collection.
97227
- * @returns The shape at the given index. An error is thrown if index is out of range.
97157
+ * @param index The index of the layout in the collection.
97158
+ * @returns The layout at the given index. An error is thrown if index is out of range.
97228
97159
  */
97229
- getItemAt(index: number): PowerPoint.Shape;
97160
+ getItemAt(index: number): PowerPoint.SlideLayout;
97230
97161
  /**
97231
- * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
97162
+ * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
97163
+ see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
97232
97164
  *
97233
97165
  * @remarks
97234
97166
  * [Api set: PowerPointApi 1.3]
97235
97167
  *
97236
- * @param id The ID of the shape.
97237
- * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
97168
+ * @param id The ID of the layout.
97169
+ * @returns The layout with the unique ID.
97238
97170
  */
97239
- getItemOrNullObject(id: string): PowerPoint.Shape;
97171
+ getItemOrNullObject(id: string): PowerPoint.SlideLayout;
97240
97172
  /**
97241
97173
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97242
97174
  *
97243
97175
  * @param options Provides options for which properties of the object to load.
97244
97176
  */
97245
- load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
97177
+ load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
97246
97178
  /**
97247
97179
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97248
97180
  *
97249
97181
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97250
97182
  */
97251
- load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
97183
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
97252
97184
  /**
97253
97185
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97254
97186
  *
97255
97187
  * @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.
97256
97188
  */
97257
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
97189
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
97258
97190
  /**
97259
97191
  * 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.)
97260
- * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97192
+ * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97261
97193
  */
97262
- toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
97194
+ toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
97263
97195
  }
97264
97196
  /**
97265
- * Represents the layout of a slide.
97197
+ * Represents the Slide Master of a slide.
97266
97198
  *
97267
97199
  * @remarks
97268
97200
  * [Api set: PowerPointApi 1.3]
97269
97201
  */
97270
- class SlideLayout extends OfficeExtension.ClientObject {
97202
+ class SlideMaster extends OfficeExtension.ClientObject {
97271
97203
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97272
97204
  context: RequestContext;
97273
97205
  /**
97274
- * Returns a collection of shapes in the slide layout.
97206
+ * Gets the collection of layouts provided by the Slide Master for slides.
97207
+ *
97208
+ * @remarks
97209
+ * [Api set: PowerPointApi 1.3]
97210
+ */
97211
+ readonly layouts: PowerPoint.SlideLayoutCollection;
97212
+ /**
97213
+ * Returns a collection of shapes in the Slide Master.
97275
97214
  *
97276
97215
  * @remarks
97277
97216
  * [Api set: PowerPointApi 1.3]
97278
97217
  */
97279
97218
  readonly shapes: PowerPoint.ShapeCollection;
97280
97219
  /**
97281
- * Gets the unique ID of the slide layout.
97220
+ * Gets the unique ID of the Slide Master.
97282
97221
  *
97283
97222
  * @remarks
97284
97223
  * [Api set: PowerPointApi 1.3]
97285
97224
  */
97286
97225
  readonly id: string;
97287
97226
  /**
97288
- * Gets the name of the slide layout.
97227
+ * Gets the unique name of the Slide Master.
97289
97228
  *
97290
97229
  * @remarks
97291
97230
  * [Api set: PowerPointApi 1.3]
@@ -97296,13 +97235,13 @@ declare namespace PowerPoint {
97296
97235
  *
97297
97236
  * @param options Provides options for which properties of the object to load.
97298
97237
  */
97299
- load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
97238
+ load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
97300
97239
  /**
97301
97240
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97302
97241
  *
97303
97242
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97304
97243
  */
97305
- load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
97244
+ load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
97306
97245
  /**
97307
97246
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97308
97247
  *
@@ -97311,150 +97250,154 @@ declare namespace PowerPoint {
97311
97250
  load(propertyNamesAndPaths?: {
97312
97251
  select?: string;
97313
97252
  expand?: string;
97314
- }): PowerPoint.SlideLayout;
97253
+ }): PowerPoint.SlideMaster;
97315
97254
  /**
97316
97255
  * 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.)
97317
- * Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
97256
+ * Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
97318
97257
  */
97319
- toJSON(): PowerPoint.Interfaces.SlideLayoutData;
97258
+ toJSON(): PowerPoint.Interfaces.SlideMasterData;
97320
97259
  }
97321
97260
  /**
97322
- * Represents the collection of layouts provided by the Slide Master for slides.
97261
+ * Represents a single tag in the slide.
97323
97262
  *
97324
97263
  * @remarks
97325
97264
  * [Api set: PowerPointApi 1.3]
97326
97265
  */
97327
- class SlideLayoutCollection extends OfficeExtension.ClientObject {
97266
+ class Tag extends OfficeExtension.ClientObject {
97328
97267
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97329
97268
  context: RequestContext;
97330
- /** Gets the loaded child items in this collection. */
97331
- readonly items: PowerPoint.SlideLayout[];
97332
- /**
97333
- * Gets the number of layouts in the collection.
97334
- *
97335
- * @remarks
97336
- * [Api set: PowerPointApi 1.3]
97337
- * @returns The number of layouts in the collection.
97338
- */
97339
- getCount(): OfficeExtension.ClientResult<number>;
97340
97269
  /**
97341
- * Gets a layout using its unique ID.
97342
- *
97343
- * @remarks
97344
- * [Api set: PowerPointApi 1.3]
97345
- *
97346
- * @param key The ID of the layout.
97347
- * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
97348
- */
97349
- getItem(key: string): PowerPoint.SlideLayout;
97350
- /**
97351
- * Gets a layout using its zero-based index in the collection.
97270
+ * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97352
97271
  *
97353
97272
  * @remarks
97354
97273
  * [Api set: PowerPointApi 1.3]
97355
- *
97356
- * @param index The index of the layout in the collection.
97357
- * @returns The layout at the given index. An error is thrown if index is out of range.
97358
97274
  */
97359
- getItemAt(index: number): PowerPoint.SlideLayout;
97275
+ readonly key: string;
97360
97276
  /**
97361
- * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
97362
- see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
97277
+ * Gets the value of the tag.
97363
97278
  *
97364
97279
  * @remarks
97365
97280
  * [Api set: PowerPointApi 1.3]
97366
- *
97367
- * @param id The ID of the layout.
97368
- * @returns The layout with the unique ID.
97369
97281
  */
97370
- getItemOrNullObject(id: string): PowerPoint.SlideLayout;
97282
+ value: string;
97371
97283
  /**
97372
97284
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97373
97285
  *
97374
97286
  * @param options Provides options for which properties of the object to load.
97375
97287
  */
97376
- load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
97288
+ load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;
97377
97289
  /**
97378
97290
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97379
97291
  *
97380
97292
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97381
97293
  */
97382
- load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
97294
+ load(propertyNames?: string | string[]): PowerPoint.Tag;
97383
97295
  /**
97384
97296
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97385
97297
  *
97386
97298
  * @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.
97387
97299
  */
97388
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
97300
+ load(propertyNamesAndPaths?: {
97301
+ select?: string;
97302
+ expand?: string;
97303
+ }): PowerPoint.Tag;
97389
97304
  /**
97390
97305
  * 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.)
97391
- * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97306
+ * Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
97392
97307
  */
97393
- toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
97308
+ toJSON(): PowerPoint.Interfaces.TagData;
97394
97309
  }
97395
97310
  /**
97396
- * Represents the Slide Master of a slide.
97311
+ * Represents the collection of tags.
97397
97312
  *
97398
97313
  * @remarks
97399
97314
  * [Api set: PowerPointApi 1.3]
97400
97315
  */
97401
- class SlideMaster extends OfficeExtension.ClientObject {
97316
+ class TagCollection extends OfficeExtension.ClientObject {
97402
97317
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97403
97318
  context: RequestContext;
97319
+ /** Gets the loaded child items in this collection. */
97320
+ readonly items: PowerPoint.Tag[];
97404
97321
  /**
97405
- * Gets the collection of layouts provided by the Slide Master for slides.
97322
+ * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
97406
97323
  *
97407
97324
  * @remarks
97408
97325
  * [Api set: PowerPointApi 1.3]
97326
+ *
97327
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
97328
+ * @param value The value of the tag.
97409
97329
  */
97410
- readonly layouts: PowerPoint.SlideLayoutCollection;
97330
+ add(key: string, value: string): void;
97411
97331
  /**
97412
- * Returns a collection of shapes in the Slide Master.
97332
+ * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
97413
97333
  *
97414
97334
  * @remarks
97415
97335
  * [Api set: PowerPointApi 1.3]
97336
+ *
97337
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
97416
97338
  */
97417
- readonly shapes: PowerPoint.ShapeCollection;
97339
+ delete(key: string): void;
97418
97340
  /**
97419
- * Gets the unique ID of the Slide Master.
97341
+ * Gets the number of tags in the collection.
97420
97342
  *
97421
97343
  * @remarks
97422
97344
  * [Api set: PowerPointApi 1.3]
97345
+ * @returns The number of tags in the collection.
97423
97346
  */
97424
- readonly id: string;
97347
+ getCount(): OfficeExtension.ClientResult<number>;
97425
97348
  /**
97426
- * Gets the unique name of the Slide Master.
97349
+ * Gets a tag using its unique ID. An error is thrown if the tag does not exist.
97427
97350
  *
97428
97351
  * @remarks
97429
97352
  * [Api set: PowerPointApi 1.3]
97353
+ *
97354
+ * @param key The ID of the tag.
97355
+ * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
97430
97356
  */
97431
- readonly name: string;
97357
+ getItem(key: string): PowerPoint.Tag;
97358
+ /**
97359
+ * Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.
97360
+ *
97361
+ * @remarks
97362
+ * [Api set: PowerPointApi 1.3]
97363
+ *
97364
+ * @param index The index of the tag in the collection.
97365
+ * @returns The tag at the given index. An error is thrown if index is out of range.
97366
+ */
97367
+ getItemAt(index: number): PowerPoint.Tag;
97368
+ /**
97369
+ * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
97370
+ *
97371
+ * @remarks
97372
+ * [Api set: PowerPointApi 1.3]
97373
+ *
97374
+ * @param key The ID of the tag.
97375
+ * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
97376
+ */
97377
+ getItemOrNullObject(key: string): PowerPoint.Tag;
97432
97378
  /**
97433
97379
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97434
97380
  *
97435
97381
  * @param options Provides options for which properties of the object to load.
97436
97382
  */
97437
- load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
97383
+ load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
97438
97384
  /**
97439
97385
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97440
97386
  *
97441
97387
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97442
97388
  */
97443
- load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
97389
+ load(propertyNames?: string | string[]): PowerPoint.TagCollection;
97444
97390
  /**
97445
97391
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97446
97392
  *
97447
97393
  * @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.
97448
97394
  */
97449
- load(propertyNamesAndPaths?: {
97450
- select?: string;
97451
- expand?: string;
97452
- }): PowerPoint.SlideMaster;
97395
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
97453
97396
  /**
97454
97397
  * 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.)
97455
- * Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
97398
+ * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
97456
97399
  */
97457
- toJSON(): PowerPoint.Interfaces.SlideMasterData;
97400
+ toJSON(): PowerPoint.Interfaces.TagCollectionData;
97458
97401
  }
97459
97402
  /**
97460
97403
  * Represents a single slide of a presentation.
@@ -97534,6 +97477,63 @@ declare namespace PowerPoint {
97534
97477
  */
97535
97478
  toJSON(): PowerPoint.Interfaces.SlideData;
97536
97479
  }
97480
+ /**
97481
+ * Represents a single shape in the slide.
97482
+ *
97483
+ * @remarks
97484
+ * [Api set: PowerPointApi 1.3]
97485
+ */
97486
+ class Shape extends OfficeExtension.ClientObject {
97487
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97488
+ context: RequestContext;
97489
+ /**
97490
+ * Returns a collection of tags in the shape.
97491
+ *
97492
+ * @remarks
97493
+ * [Api set: PowerPointApi 1.3]
97494
+ */
97495
+ readonly tags: PowerPoint.TagCollection;
97496
+ /**
97497
+ * Gets the unique ID of the shape.
97498
+ *
97499
+ * @remarks
97500
+ * [Api set: PowerPointApi 1.3]
97501
+ */
97502
+ readonly id: string;
97503
+ /**
97504
+ * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
97505
+ *
97506
+ * @remarks
97507
+ * [Api set: PowerPointApi 1.3]
97508
+ */
97509
+ delete(): void;
97510
+ /**
97511
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97512
+ *
97513
+ * @param options Provides options for which properties of the object to load.
97514
+ */
97515
+ load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
97516
+ /**
97517
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97518
+ *
97519
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
97520
+ */
97521
+ load(propertyNames?: string | string[]): PowerPoint.Shape;
97522
+ /**
97523
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
97524
+ *
97525
+ * @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.
97526
+ */
97527
+ load(propertyNamesAndPaths?: {
97528
+ select?: string;
97529
+ expand?: string;
97530
+ }): PowerPoint.Shape;
97531
+ /**
97532
+ * 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.)
97533
+ * Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
97534
+ */
97535
+ toJSON(): PowerPoint.Interfaces.ShapeData;
97536
+ }
97537
97537
  /**
97538
97538
  * Represents the collection of slides in the presentation.
97539
97539
  *
@@ -97710,6 +97710,14 @@ declare namespace PowerPoint {
97710
97710
  */
97711
97711
  $skip?: number;
97712
97712
  }
97713
+ /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
97714
+ interface ShapeCollectionUpdateData {
97715
+ items?: PowerPoint.Interfaces.ShapeData[];
97716
+ }
97717
+ /** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
97718
+ interface SlideLayoutCollectionUpdateData {
97719
+ items?: PowerPoint.Interfaces.SlideLayoutData[];
97720
+ }
97713
97721
  /** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
97714
97722
  interface TagUpdateData {
97715
97723
  /**
@@ -97724,14 +97732,6 @@ declare namespace PowerPoint {
97724
97732
  interface TagCollectionUpdateData {
97725
97733
  items?: PowerPoint.Interfaces.TagData[];
97726
97734
  }
97727
- /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
97728
- interface ShapeCollectionUpdateData {
97729
- items?: PowerPoint.Interfaces.ShapeData[];
97730
- }
97731
- /** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
97732
- interface SlideLayoutCollectionUpdateData {
97733
- items?: PowerPoint.Interfaces.SlideLayoutData[];
97734
- }
97735
97735
  /** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
97736
97736
  interface SlideCollectionUpdateData {
97737
97737
  items?: PowerPoint.Interfaces.SlideData[];
@@ -97744,37 +97744,6 @@ declare namespace PowerPoint {
97744
97744
  interface PresentationData {
97745
97745
  title?: string;
97746
97746
  }
97747
- /** An interface describing the data returned by calling `tag.toJSON()`. */
97748
- interface TagData {
97749
- /**
97750
- * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97751
- *
97752
- * @remarks
97753
- * [Api set: PowerPointApi 1.3]
97754
- */
97755
- key?: string;
97756
- /**
97757
- * Gets the value of the tag.
97758
- *
97759
- * @remarks
97760
- * [Api set: PowerPointApi 1.3]
97761
- */
97762
- value?: string;
97763
- }
97764
- /** An interface describing the data returned by calling `tagCollection.toJSON()`. */
97765
- interface TagCollectionData {
97766
- items?: PowerPoint.Interfaces.TagData[];
97767
- }
97768
- /** An interface describing the data returned by calling `shape.toJSON()`. */
97769
- interface ShapeData {
97770
- /**
97771
- * Gets the unique ID of the shape.
97772
- *
97773
- * @remarks
97774
- * [Api set: PowerPointApi 1.3]
97775
- */
97776
- id?: string;
97777
- }
97778
97747
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
97779
97748
  interface ShapeCollectionData {
97780
97749
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -97817,6 +97786,27 @@ declare namespace PowerPoint {
97817
97786
  */
97818
97787
  name?: string;
97819
97788
  }
97789
+ /** An interface describing the data returned by calling `tag.toJSON()`. */
97790
+ interface TagData {
97791
+ /**
97792
+ * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97793
+ *
97794
+ * @remarks
97795
+ * [Api set: PowerPointApi 1.3]
97796
+ */
97797
+ key?: string;
97798
+ /**
97799
+ * Gets the value of the tag.
97800
+ *
97801
+ * @remarks
97802
+ * [Api set: PowerPointApi 1.3]
97803
+ */
97804
+ value?: string;
97805
+ }
97806
+ /** An interface describing the data returned by calling `tagCollection.toJSON()`. */
97807
+ interface TagCollectionData {
97808
+ items?: PowerPoint.Interfaces.TagData[];
97809
+ }
97820
97810
  /** An interface describing the data returned by calling `slide.toJSON()`. */
97821
97811
  interface SlideData {
97822
97812
  /**
@@ -97827,6 +97817,16 @@ declare namespace PowerPoint {
97827
97817
  */
97828
97818
  id?: string;
97829
97819
  }
97820
+ /** An interface describing the data returned by calling `shape.toJSON()`. */
97821
+ interface ShapeData {
97822
+ /**
97823
+ * Gets the unique ID of the shape.
97824
+ *
97825
+ * @remarks
97826
+ * [Api set: PowerPointApi 1.3]
97827
+ */
97828
+ id?: string;
97829
+ }
97830
97830
  /** An interface describing the data returned by calling `slideCollection.toJSON()`. */
97831
97831
  interface SlideCollectionData {
97832
97832
  items?: PowerPoint.Interfaces.SlideData[];
@@ -97847,115 +97847,96 @@ declare namespace PowerPoint {
97847
97847
  title?: boolean;
97848
97848
  }
97849
97849
  /**
97850
- * Represents a single tag in the slide.
97850
+ * Represents the collection of shapes.
97851
97851
  *
97852
97852
  * @remarks
97853
97853
  * [Api set: PowerPointApi 1.3]
97854
97854
  */
97855
- interface TagLoadOptions {
97855
+ interface ShapeCollectionLoadOptions {
97856
97856
  /**
97857
97857
  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`).
97858
97858
  */
97859
97859
  $all?: boolean;
97860
97860
  /**
97861
- * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97862
- *
97863
- * @remarks
97864
- * [Api set: PowerPointApi 1.3]
97865
- */
97866
- key?: boolean;
97867
- /**
97868
- * Gets the value of the tag.
97861
+ * For EACH ITEM in the collection: Gets the unique ID of the shape.
97869
97862
  *
97870
97863
  * @remarks
97871
97864
  * [Api set: PowerPointApi 1.3]
97872
97865
  */
97873
- value?: boolean;
97866
+ id?: boolean;
97874
97867
  }
97875
97868
  /**
97876
- * Represents the collection of tags.
97869
+ * Represents the layout of a slide.
97877
97870
  *
97878
97871
  * @remarks
97879
97872
  * [Api set: PowerPointApi 1.3]
97880
97873
  */
97881
- interface TagCollectionLoadOptions {
97874
+ interface SlideLayoutLoadOptions {
97882
97875
  /**
97883
97876
  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`).
97884
97877
  */
97885
97878
  $all?: boolean;
97886
97879
  /**
97887
- * For EACH ITEM in the collection: Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97880
+ * Gets the unique ID of the slide layout.
97888
97881
  *
97889
97882
  * @remarks
97890
97883
  * [Api set: PowerPointApi 1.3]
97891
97884
  */
97892
- key?: boolean;
97885
+ id?: boolean;
97893
97886
  /**
97894
- * For EACH ITEM in the collection: Gets the value of the tag.
97887
+ * Gets the name of the slide layout.
97895
97888
  *
97896
97889
  * @remarks
97897
97890
  * [Api set: PowerPointApi 1.3]
97898
97891
  */
97899
- value?: boolean;
97892
+ name?: boolean;
97900
97893
  }
97901
97894
  /**
97902
- * Represents a single shape in the slide.
97895
+ * Represents the collection of layouts provided by the Slide Master for slides.
97903
97896
  *
97904
97897
  * @remarks
97905
97898
  * [Api set: PowerPointApi 1.3]
97906
97899
  */
97907
- interface ShapeLoadOptions {
97900
+ interface SlideLayoutCollectionLoadOptions {
97908
97901
  /**
97909
97902
  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`).
97910
97903
  */
97911
97904
  $all?: boolean;
97912
97905
  /**
97913
- * Gets the unique ID of the shape.
97906
+ * For EACH ITEM in the collection: Gets the unique ID of the slide layout.
97914
97907
  *
97915
97908
  * @remarks
97916
97909
  * [Api set: PowerPointApi 1.3]
97917
97910
  */
97918
97911
  id?: boolean;
97919
- }
97920
- /**
97921
- * Represents the collection of shapes.
97922
- *
97923
- * @remarks
97924
- * [Api set: PowerPointApi 1.3]
97925
- */
97926
- interface ShapeCollectionLoadOptions {
97927
97912
  /**
97928
- 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`).
97929
- */
97930
- $all?: boolean;
97931
- /**
97932
- * For EACH ITEM in the collection: Gets the unique ID of the shape.
97913
+ * For EACH ITEM in the collection: Gets the name of the slide layout.
97933
97914
  *
97934
97915
  * @remarks
97935
97916
  * [Api set: PowerPointApi 1.3]
97936
97917
  */
97937
- id?: boolean;
97918
+ name?: boolean;
97938
97919
  }
97939
97920
  /**
97940
- * Represents the layout of a slide.
97921
+ * Represents the Slide Master of a slide.
97941
97922
  *
97942
97923
  * @remarks
97943
97924
  * [Api set: PowerPointApi 1.3]
97944
97925
  */
97945
- interface SlideLayoutLoadOptions {
97926
+ interface SlideMasterLoadOptions {
97946
97927
  /**
97947
97928
  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`).
97948
97929
  */
97949
97930
  $all?: boolean;
97950
97931
  /**
97951
- * Gets the unique ID of the slide layout.
97932
+ * Gets the unique ID of the Slide Master.
97952
97933
  *
97953
97934
  * @remarks
97954
97935
  * [Api set: PowerPointApi 1.3]
97955
97936
  */
97956
97937
  id?: boolean;
97957
97938
  /**
97958
- * Gets the name of the slide layout.
97939
+ * Gets the unique name of the Slide Master.
97959
97940
  *
97960
97941
  * @remarks
97961
97942
  * [Api set: PowerPointApi 1.3]
@@ -97963,56 +97944,56 @@ declare namespace PowerPoint {
97963
97944
  name?: boolean;
97964
97945
  }
97965
97946
  /**
97966
- * Represents the collection of layouts provided by the Slide Master for slides.
97947
+ * Represents a single tag in the slide.
97967
97948
  *
97968
97949
  * @remarks
97969
97950
  * [Api set: PowerPointApi 1.3]
97970
97951
  */
97971
- interface SlideLayoutCollectionLoadOptions {
97952
+ interface TagLoadOptions {
97972
97953
  /**
97973
97954
  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`).
97974
97955
  */
97975
97956
  $all?: boolean;
97976
97957
  /**
97977
- * For EACH ITEM in the collection: Gets the unique ID of the slide layout.
97958
+ * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
97978
97959
  *
97979
97960
  * @remarks
97980
97961
  * [Api set: PowerPointApi 1.3]
97981
97962
  */
97982
- id?: boolean;
97963
+ key?: boolean;
97983
97964
  /**
97984
- * For EACH ITEM in the collection: Gets the name of the slide layout.
97965
+ * Gets the value of the tag.
97985
97966
  *
97986
97967
  * @remarks
97987
97968
  * [Api set: PowerPointApi 1.3]
97988
97969
  */
97989
- name?: boolean;
97970
+ value?: boolean;
97990
97971
  }
97991
97972
  /**
97992
- * Represents the Slide Master of a slide.
97973
+ * Represents the collection of tags.
97993
97974
  *
97994
97975
  * @remarks
97995
97976
  * [Api set: PowerPointApi 1.3]
97996
97977
  */
97997
- interface SlideMasterLoadOptions {
97978
+ interface TagCollectionLoadOptions {
97998
97979
  /**
97999
97980
  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`).
98000
97981
  */
98001
97982
  $all?: boolean;
98002
97983
  /**
98003
- * Gets the unique ID of the Slide Master.
97984
+ * For EACH ITEM in the collection: Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
98004
97985
  *
98005
97986
  * @remarks
98006
97987
  * [Api set: PowerPointApi 1.3]
98007
97988
  */
98008
- id?: boolean;
97989
+ key?: boolean;
98009
97990
  /**
98010
- * Gets the unique name of the Slide Master.
97991
+ * For EACH ITEM in the collection: Gets the value of the tag.
98011
97992
  *
98012
97993
  * @remarks
98013
97994
  * [Api set: PowerPointApi 1.3]
98014
97995
  */
98015
- name?: boolean;
97996
+ value?: boolean;
98016
97997
  }
98017
97998
  /**
98018
97999
  * Represents a single slide of a presentation.
@@ -98047,6 +98028,25 @@ declare namespace PowerPoint {
98047
98028
  */
98048
98029
  id?: boolean;
98049
98030
  }
98031
+ /**
98032
+ * Represents a single shape in the slide.
98033
+ *
98034
+ * @remarks
98035
+ * [Api set: PowerPointApi 1.3]
98036
+ */
98037
+ interface ShapeLoadOptions {
98038
+ /**
98039
+ 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`).
98040
+ */
98041
+ $all?: boolean;
98042
+ /**
98043
+ * Gets the unique ID of the shape.
98044
+ *
98045
+ * @remarks
98046
+ * [Api set: PowerPointApi 1.3]
98047
+ */
98048
+ id?: boolean;
98049
+ }
98050
98050
  /**
98051
98051
  * Represents the collection of slides in the presentation.
98052
98052
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.248",
3
+ "version": "1.0.251",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "86dfb3a483d4cdf29d56e97e62496931c4a064a465dfc49469b5b4469d0a9d61",
48
+ "typesPublisherContentHash": "ce8af17effe1ba31c7fa40afa18085a4a2b722db7f20d88f36e7d3e9de4968dd",
49
49
  "typeScriptVersion": "3.9"
50
50
  }