@types/office-js-preview 1.0.516 → 1.0.517

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: Mon, 30 Sep 2024 17:36:57 GMT
11
+ * Last updated: Mon, 30 Sep 2024 22:07:46 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -48890,7 +48890,7 @@ declare namespace Excel {
48890
48890
  */
48891
48891
  category: string;
48892
48892
  /**
48893
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
48893
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
48894
48894
  *
48895
48895
  * @remarks
48896
48896
  * [Api set: ExcelApi 1.7]
@@ -69811,7 +69811,7 @@ declare namespace Excel {
69811
69811
  */
69812
69812
  category?: string;
69813
69813
  /**
69814
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
69814
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
69815
69815
  *
69816
69816
  * @remarks
69817
69817
  * [Api set: ExcelApi 1.7]
@@ -76335,7 +76335,7 @@ declare namespace Excel {
76335
76335
  */
76336
76336
  category?: string;
76337
76337
  /**
76338
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
76338
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
76339
76339
  *
76340
76340
  * @remarks
76341
76341
  * [Api set: ExcelApi 1.7]
@@ -86114,7 +86114,7 @@ declare namespace Excel {
86114
86114
  */
86115
86115
  category?: boolean;
86116
86116
  /**
86117
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
86117
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork.
86118
86118
  *
86119
86119
  * @remarks
86120
86120
  * [Api set: ExcelApi 1.7]
@@ -122457,6 +122457,14 @@ declare namespace PowerPoint {
122457
122457
  * @beta
122458
122458
  */
122459
122459
  readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
122460
+ /**
122461
+ * Gets the properties of the presentation.
122462
+ *
122463
+ * @remarks
122464
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122465
+ * @beta
122466
+ */
122467
+ readonly properties: PowerPoint.DocumentProperties;
122460
122468
  /**
122461
122469
  * Returns the collection of `SlideMaster` objects that are in the presentation.
122462
122470
  *
@@ -124092,86 +124100,6 @@ declare namespace PowerPoint {
124092
124100
  */
124093
124101
  width?: number;
124094
124102
  }
124095
- /**
124096
- * Specifies the dash style for a line.
124097
- *
124098
- * @remarks
124099
- * [Api set: PowerPointApi 1.4]
124100
- */
124101
- enum ShapeLineDashStyle {
124102
- /**
124103
- * The dash line pattern
124104
- * @remarks
124105
- * [Api set: PowerPointApi 1.4]
124106
- */
124107
- dash = "Dash",
124108
- /**
124109
- * The dash-dot line pattern
124110
- * @remarks
124111
- * [Api set: PowerPointApi 1.4]
124112
- */
124113
- dashDot = "DashDot",
124114
- /**
124115
- * The dash-dot-dot line pattern
124116
- * @remarks
124117
- * [Api set: PowerPointApi 1.4]
124118
- */
124119
- dashDotDot = "DashDotDot",
124120
- /**
124121
- * The long dash line pattern
124122
- * @remarks
124123
- * [Api set: PowerPointApi 1.4]
124124
- */
124125
- longDash = "LongDash",
124126
- /**
124127
- * The long dash-dot line pattern
124128
- * @remarks
124129
- * [Api set: PowerPointApi 1.4]
124130
- */
124131
- longDashDot = "LongDashDot",
124132
- /**
124133
- * The round dot line pattern
124134
- * @remarks
124135
- * [Api set: PowerPointApi 1.4]
124136
- */
124137
- roundDot = "RoundDot",
124138
- /**
124139
- * The solid line pattern
124140
- * @remarks
124141
- * [Api set: PowerPointApi 1.4]
124142
- */
124143
- solid = "Solid",
124144
- /**
124145
- * The square dot line pattern
124146
- * @remarks
124147
- * [Api set: PowerPointApi 1.4]
124148
- */
124149
- squareDot = "SquareDot",
124150
- /**
124151
- * The long dash-dot-dot line pattern
124152
- * @remarks
124153
- * [Api set: PowerPointApi 1.4]
124154
- */
124155
- longDashDotDot = "LongDashDotDot",
124156
- /**
124157
- * The system dash line pattern
124158
- * @remarks
124159
- * [Api set: PowerPointApi 1.4]
124160
- */
124161
- systemDash = "SystemDash",
124162
- /**
124163
- * The system dot line pattern
124164
- * @remarks
124165
- * [Api set: PowerPointApi 1.4]
124166
- */
124167
- systemDot = "SystemDot",
124168
- /**
124169
- * The system dash-dot line pattern
124170
- * @remarks
124171
- * [Api set: PowerPointApi 1.4]
124172
- */
124173
- systemDashDot = "SystemDashDot",
124174
- }
124175
124103
  /**
124176
124104
  * The type of underline applied to a font.
124177
124105
  *
@@ -124332,6 +124260,86 @@ declare namespace PowerPoint {
124332
124260
  */
124333
124261
  thaiDistributed = "ThaiDistributed",
124334
124262
  }
124263
+ /**
124264
+ * Specifies the dash style for a line.
124265
+ *
124266
+ * @remarks
124267
+ * [Api set: PowerPointApi 1.4]
124268
+ */
124269
+ enum ShapeLineDashStyle {
124270
+ /**
124271
+ * The dash line pattern.
124272
+ * @remarks
124273
+ * [Api set: PowerPointApi 1.4]
124274
+ */
124275
+ dash = "Dash",
124276
+ /**
124277
+ * The dash-dot line pattern.
124278
+ * @remarks
124279
+ * [Api set: PowerPointApi 1.4]
124280
+ */
124281
+ dashDot = "DashDot",
124282
+ /**
124283
+ * The dash-dot-dot line pattern.
124284
+ * @remarks
124285
+ * [Api set: PowerPointApi 1.4]
124286
+ */
124287
+ dashDotDot = "DashDotDot",
124288
+ /**
124289
+ * The long dash line pattern.
124290
+ * @remarks
124291
+ * [Api set: PowerPointApi 1.4]
124292
+ */
124293
+ longDash = "LongDash",
124294
+ /**
124295
+ * The long dash-dot line pattern.
124296
+ * @remarks
124297
+ * [Api set: PowerPointApi 1.4]
124298
+ */
124299
+ longDashDot = "LongDashDot",
124300
+ /**
124301
+ * The round dot line pattern.
124302
+ * @remarks
124303
+ * [Api set: PowerPointApi 1.4]
124304
+ */
124305
+ roundDot = "RoundDot",
124306
+ /**
124307
+ * The solid line pattern.
124308
+ * @remarks
124309
+ * [Api set: PowerPointApi 1.4]
124310
+ */
124311
+ solid = "Solid",
124312
+ /**
124313
+ * The square dot line pattern.
124314
+ * @remarks
124315
+ * [Api set: PowerPointApi 1.4]
124316
+ */
124317
+ squareDot = "SquareDot",
124318
+ /**
124319
+ * The long dash-dot-dot line pattern.
124320
+ * @remarks
124321
+ * [Api set: PowerPointApi 1.4]
124322
+ */
124323
+ longDashDotDot = "LongDashDotDot",
124324
+ /**
124325
+ * The system dash line pattern.
124326
+ * @remarks
124327
+ * [Api set: PowerPointApi 1.4]
124328
+ */
124329
+ systemDash = "SystemDash",
124330
+ /**
124331
+ * The system dot line pattern.
124332
+ * @remarks
124333
+ * [Api set: PowerPointApi 1.4]
124334
+ */
124335
+ systemDot = "SystemDot",
124336
+ /**
124337
+ * The system dash-dot line pattern.
124338
+ * @remarks
124339
+ * [Api set: PowerPointApi 1.4]
124340
+ */
124341
+ systemDashDot = "SystemDashDot",
124342
+ }
124335
124343
  /**
124336
124344
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
124337
124345
  If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
@@ -125868,6 +125876,336 @@ declare namespace PowerPoint {
125868
125876
  */
125869
125877
  toJSON(): PowerPoint.Interfaces.ShapeData;
125870
125878
  }
125879
+ /**
125880
+ * Specifies the document property type for custom properties.
125881
+ *
125882
+ * @remarks
125883
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125884
+ * @beta
125885
+ */
125886
+ enum DocumentPropertyType {
125887
+ /**
125888
+ * The Boolean document property type.
125889
+ * @remarks
125890
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125891
+ * @beta
125892
+ */
125893
+ boolean = "Boolean",
125894
+ /**
125895
+ * The Date document property type.
125896
+ * @remarks
125897
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125898
+ * @beta
125899
+ */
125900
+ date = "Date",
125901
+ /**
125902
+ * The Number document property type.
125903
+ * @remarks
125904
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125905
+ * @beta
125906
+ */
125907
+ number = "Number",
125908
+ /**
125909
+ * The String document property type.
125910
+ * @remarks
125911
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125912
+ * @beta
125913
+ */
125914
+ string = "String",
125915
+ }
125916
+ /**
125917
+ * Represents a custom property.
125918
+ *
125919
+ * @remarks
125920
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125921
+ * @beta
125922
+ */
125923
+ class CustomProperty extends OfficeExtension.ClientObject {
125924
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
125925
+ context: RequestContext;
125926
+ /**
125927
+ * The string that uniquely identifies the custom property.
125928
+ *
125929
+ * @remarks
125930
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125931
+ * @beta
125932
+ */
125933
+ readonly key: string;
125934
+ /**
125935
+ * The type of the value used for the custom property.
125936
+ *
125937
+ * @remarks
125938
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125939
+ * @beta
125940
+ */
125941
+ readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";
125942
+ /**
125943
+ * The value of the custom property.
125944
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
125945
+ *
125946
+ * @remarks
125947
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125948
+ * @beta
125949
+ */
125950
+ value: boolean | Date | number | string;
125951
+ /**
125952
+ * Deletes the custom property.
125953
+ *
125954
+ * @remarks
125955
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125956
+ * @beta
125957
+ */
125958
+ delete(): void;
125959
+ /**
125960
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
125961
+ *
125962
+ * @param options Provides options for which properties of the object to load.
125963
+ */
125964
+ load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions): PowerPoint.CustomProperty;
125965
+ /**
125966
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
125967
+ *
125968
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
125969
+ */
125970
+ load(propertyNames?: string | string[]): PowerPoint.CustomProperty;
125971
+ /**
125972
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
125973
+ *
125974
+ * @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.
125975
+ */
125976
+ load(propertyNamesAndPaths?: {
125977
+ select?: string;
125978
+ expand?: string;
125979
+ }): PowerPoint.CustomProperty;
125980
+ /**
125981
+ * 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.)
125982
+ * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
125983
+ */
125984
+ toJSON(): PowerPoint.Interfaces.CustomPropertyData;
125985
+ }
125986
+ /**
125987
+ * A collection of custom properties.
125988
+ *
125989
+ * @remarks
125990
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125991
+ * @beta
125992
+ */
125993
+ class CustomPropertyCollection extends OfficeExtension.ClientObject {
125994
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
125995
+ context: RequestContext;
125996
+ /** Gets the loaded child items in this collection. */
125997
+ readonly items: PowerPoint.CustomProperty[];
125998
+ /**
125999
+ * Creates a new `CustomProperty` or updates the property with the given key.
126000
+ *
126001
+ * @remarks
126002
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126003
+ * @beta
126004
+ *
126005
+ * @param key The string that identifies the `CustomProperty` object. It's case-insensitive.
126006
+ * The maximum key length is 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
126007
+ * @param value The value of the `CustomProperty`.
126008
+ * If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
126009
+ */
126010
+ add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;
126011
+ /**
126012
+ * Deletes all custom properties in this collection.
126013
+ *
126014
+ * @remarks
126015
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126016
+ * @beta
126017
+ */
126018
+ deleteAll(): void;
126019
+ /**
126020
+ * Gets the number of custom properties in the collection.
126021
+ *
126022
+ * @remarks
126023
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126024
+ * @beta
126025
+ * @returns The number of custom properties in the collection.
126026
+ */
126027
+ getCount(): OfficeExtension.ClientResult<number>;
126028
+ /**
126029
+ * Gets a `CustomProperty` by its key.
126030
+ *
126031
+ * @remarks
126032
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126033
+ * @beta
126034
+ *
126035
+ * @param key The string that identifies the `CustomProperty` object. It's case-insensitive.
126036
+ * Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error.
126037
+ */
126038
+ getItem(key: string): PowerPoint.CustomProperty;
126039
+ /**
126040
+ * Gets a `CustomProperty` by its key.
126041
+ If the `CustomProperty` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
126042
+ 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}.
126043
+ *
126044
+ * @remarks
126045
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126046
+ * @beta
126047
+ *
126048
+ * @param key The string that identifies the `CustomProperty` object. It's case-insensitive.
126049
+ * Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error.
126050
+ */
126051
+ getItemOrNullObject(key: string): PowerPoint.CustomProperty;
126052
+ /**
126053
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126054
+ *
126055
+ * @param options Provides options for which properties of the object to load.
126056
+ */
126057
+ load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;
126058
+ /**
126059
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126060
+ *
126061
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
126062
+ */
126063
+ load(propertyNames?: string | string[]): PowerPoint.CustomPropertyCollection;
126064
+ /**
126065
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126066
+ *
126067
+ * @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.
126068
+ */
126069
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;
126070
+ /**
126071
+ * 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's passed to it.)
126072
+ * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
126073
+ */
126074
+ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;
126075
+ }
126076
+ /**
126077
+ * Represents presentation properties.
126078
+ *
126079
+ * @remarks
126080
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126081
+ * @beta
126082
+ */
126083
+ class DocumentProperties extends OfficeExtension.ClientObject {
126084
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
126085
+ context: RequestContext;
126086
+ /**
126087
+ * The collection of custom properties of the presentation.
126088
+ *
126089
+ * @remarks
126090
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126091
+ * @beta
126092
+ */
126093
+ readonly customProperties: PowerPoint.CustomPropertyCollection;
126094
+ /**
126095
+ * The author of the presentation.
126096
+ *
126097
+ * @remarks
126098
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126099
+ * @beta
126100
+ */
126101
+ author: string;
126102
+ /**
126103
+ * The category of the presentation.
126104
+ *
126105
+ * @remarks
126106
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126107
+ * @beta
126108
+ */
126109
+ category: string;
126110
+ /**
126111
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
126112
+ *
126113
+ * @remarks
126114
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126115
+ * @beta
126116
+ */
126117
+ comments: string;
126118
+ /**
126119
+ * The company of the presentation.
126120
+ *
126121
+ * @remarks
126122
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126123
+ * @beta
126124
+ */
126125
+ company: string;
126126
+ /**
126127
+ * The creation date of the presentation.
126128
+ *
126129
+ * @remarks
126130
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126131
+ * @beta
126132
+ */
126133
+ readonly creationDate: Date;
126134
+ /**
126135
+ * The keywords of the presentation.
126136
+ *
126137
+ * @remarks
126138
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126139
+ * @beta
126140
+ */
126141
+ keywords: string;
126142
+ /**
126143
+ * The last author of the presentation.
126144
+ *
126145
+ * @remarks
126146
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126147
+ * @beta
126148
+ */
126149
+ readonly lastAuthor: string;
126150
+ /**
126151
+ * The manager of the presentation.
126152
+ *
126153
+ * @remarks
126154
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126155
+ * @beta
126156
+ */
126157
+ manager: string;
126158
+ /**
126159
+ * The revision number of the presentation.
126160
+ *
126161
+ * @remarks
126162
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126163
+ * @beta
126164
+ */
126165
+ revisionNumber: number;
126166
+ /**
126167
+ * The subject of the presentation.
126168
+ *
126169
+ * @remarks
126170
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126171
+ * @beta
126172
+ */
126173
+ subject: string;
126174
+ /**
126175
+ * The title of the presentation.
126176
+ *
126177
+ * @remarks
126178
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126179
+ * @beta
126180
+ */
126181
+ title: string;
126182
+ /**
126183
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126184
+ *
126185
+ * @param options Provides options for which properties of the object to load.
126186
+ */
126187
+ load(options?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions): PowerPoint.DocumentProperties;
126188
+ /**
126189
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126190
+ *
126191
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
126192
+ */
126193
+ load(propertyNames?: string | string[]): PowerPoint.DocumentProperties;
126194
+ /**
126195
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
126196
+ *
126197
+ * @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.
126198
+ */
126199
+ load(propertyNamesAndPaths?: {
126200
+ select?: string;
126201
+ expand?: string;
126202
+ }): PowerPoint.DocumentProperties;
126203
+ /**
126204
+ * 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's passed to it.)
126205
+ * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
126206
+ */
126207
+ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;
126208
+ }
125871
126209
  /**
125872
126210
  * Specifies the formatting options for when slides are inserted.
125873
126211
  *
@@ -126543,6 +126881,97 @@ declare namespace PowerPoint {
126543
126881
  */
126544
126882
  width?: number;
126545
126883
  }
126884
+ /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
126885
+ interface CustomPropertyUpdateData {
126886
+ /**
126887
+ * The value of the custom property.
126888
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
126889
+ *
126890
+ * @remarks
126891
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126892
+ * @beta
126893
+ */
126894
+ value?: boolean | Date | number | string;
126895
+ }
126896
+ /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */
126897
+ interface CustomPropertyCollectionUpdateData {
126898
+ items?: PowerPoint.Interfaces.CustomPropertyData[];
126899
+ }
126900
+ /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */
126901
+ interface DocumentPropertiesUpdateData {
126902
+ /**
126903
+ * The author of the presentation.
126904
+ *
126905
+ * @remarks
126906
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126907
+ * @beta
126908
+ */
126909
+ author?: string;
126910
+ /**
126911
+ * The category of the presentation.
126912
+ *
126913
+ * @remarks
126914
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126915
+ * @beta
126916
+ */
126917
+ category?: string;
126918
+ /**
126919
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
126920
+ *
126921
+ * @remarks
126922
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126923
+ * @beta
126924
+ */
126925
+ comments?: string;
126926
+ /**
126927
+ * The company of the presentation.
126928
+ *
126929
+ * @remarks
126930
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126931
+ * @beta
126932
+ */
126933
+ company?: string;
126934
+ /**
126935
+ * The keywords of the presentation.
126936
+ *
126937
+ * @remarks
126938
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126939
+ * @beta
126940
+ */
126941
+ keywords?: string;
126942
+ /**
126943
+ * The manager of the presentation.
126944
+ *
126945
+ * @remarks
126946
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126947
+ * @beta
126948
+ */
126949
+ manager?: string;
126950
+ /**
126951
+ * The revision number of the presentation.
126952
+ *
126953
+ * @remarks
126954
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126955
+ * @beta
126956
+ */
126957
+ revisionNumber?: number;
126958
+ /**
126959
+ * The subject of the presentation.
126960
+ *
126961
+ * @remarks
126962
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126963
+ * @beta
126964
+ */
126965
+ subject?: string;
126966
+ /**
126967
+ * The title of the presentation.
126968
+ *
126969
+ * @remarks
126970
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126971
+ * @beta
126972
+ */
126973
+ title?: string;
126974
+ }
126546
126975
  /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
126547
126976
  interface ShapeScopedCollectionUpdateData {
126548
126977
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126964,6 +127393,129 @@ declare namespace PowerPoint {
126964
127393
  */
126965
127394
  width?: number;
126966
127395
  }
127396
+ /** An interface describing the data returned by calling `customProperty.toJSON()`. */
127397
+ interface CustomPropertyData {
127398
+ /**
127399
+ * The string that uniquely identifies the custom property.
127400
+ *
127401
+ * @remarks
127402
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127403
+ * @beta
127404
+ */
127405
+ key?: string;
127406
+ /**
127407
+ * The type of the value used for the custom property.
127408
+ *
127409
+ * @remarks
127410
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127411
+ * @beta
127412
+ */
127413
+ type?: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";
127414
+ /**
127415
+ * The value of the custom property.
127416
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
127417
+ *
127418
+ * @remarks
127419
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127420
+ * @beta
127421
+ */
127422
+ value?: boolean | Date | number | string;
127423
+ }
127424
+ /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */
127425
+ interface CustomPropertyCollectionData {
127426
+ items?: PowerPoint.Interfaces.CustomPropertyData[];
127427
+ }
127428
+ /** An interface describing the data returned by calling `documentProperties.toJSON()`. */
127429
+ interface DocumentPropertiesData {
127430
+ /**
127431
+ * The author of the presentation.
127432
+ *
127433
+ * @remarks
127434
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127435
+ * @beta
127436
+ */
127437
+ author?: string;
127438
+ /**
127439
+ * The category of the presentation.
127440
+ *
127441
+ * @remarks
127442
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127443
+ * @beta
127444
+ */
127445
+ category?: string;
127446
+ /**
127447
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
127448
+ *
127449
+ * @remarks
127450
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127451
+ * @beta
127452
+ */
127453
+ comments?: string;
127454
+ /**
127455
+ * The company of the presentation.
127456
+ *
127457
+ * @remarks
127458
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127459
+ * @beta
127460
+ */
127461
+ company?: string;
127462
+ /**
127463
+ * The creation date of the presentation.
127464
+ *
127465
+ * @remarks
127466
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127467
+ * @beta
127468
+ */
127469
+ creationDate?: Date;
127470
+ /**
127471
+ * The keywords of the presentation.
127472
+ *
127473
+ * @remarks
127474
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127475
+ * @beta
127476
+ */
127477
+ keywords?: string;
127478
+ /**
127479
+ * The last author of the presentation.
127480
+ *
127481
+ * @remarks
127482
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127483
+ * @beta
127484
+ */
127485
+ lastAuthor?: string;
127486
+ /**
127487
+ * The manager of the presentation.
127488
+ *
127489
+ * @remarks
127490
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127491
+ * @beta
127492
+ */
127493
+ manager?: string;
127494
+ /**
127495
+ * The revision number of the presentation.
127496
+ *
127497
+ * @remarks
127498
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127499
+ * @beta
127500
+ */
127501
+ revisionNumber?: number;
127502
+ /**
127503
+ * The subject of the presentation.
127504
+ *
127505
+ * @remarks
127506
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127507
+ * @beta
127508
+ */
127509
+ subject?: string;
127510
+ /**
127511
+ * The title of the presentation.
127512
+ *
127513
+ * @remarks
127514
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127515
+ * @beta
127516
+ */
127517
+ title?: string;
127518
+ }
126967
127519
  /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
126968
127520
  interface ShapeScopedCollectionData {
126969
127521
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126989,6 +127541,14 @@ declare namespace PowerPoint {
126989
127541
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
126990
127542
  */
126991
127543
  $all?: boolean;
127544
+ /**
127545
+ * Gets the properties of the presentation.
127546
+ *
127547
+ * @remarks
127548
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127549
+ * @beta
127550
+ */
127551
+ properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
126992
127552
  /**
126993
127553
  * Gets the ID of the presentation.
126994
127554
  *
@@ -127782,6 +128342,183 @@ declare namespace PowerPoint {
127782
128342
  */
127783
128343
  width?: boolean;
127784
128344
  }
128345
+ /**
128346
+ * Represents a custom property.
128347
+ *
128348
+ * @remarks
128349
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128350
+ * @beta
128351
+ */
128352
+ interface CustomPropertyLoadOptions {
128353
+ /**
128354
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
128355
+ */
128356
+ $all?: boolean;
128357
+ /**
128358
+ * The string that uniquely identifies the custom property.
128359
+ *
128360
+ * @remarks
128361
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128362
+ * @beta
128363
+ */
128364
+ key?: boolean;
128365
+ /**
128366
+ * The type of the value used for the custom property.
128367
+ *
128368
+ * @remarks
128369
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128370
+ * @beta
128371
+ */
128372
+ type?: boolean;
128373
+ /**
128374
+ * The value of the custom property.
128375
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
128376
+ *
128377
+ * @remarks
128378
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128379
+ * @beta
128380
+ */
128381
+ value?: boolean;
128382
+ }
128383
+ /**
128384
+ * A collection of custom properties.
128385
+ *
128386
+ * @remarks
128387
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128388
+ * @beta
128389
+ */
128390
+ interface CustomPropertyCollectionLoadOptions {
128391
+ /**
128392
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
128393
+ */
128394
+ $all?: boolean;
128395
+ /**
128396
+ * For EACH ITEM in the collection: The string that uniquely identifies the custom property.
128397
+ *
128398
+ * @remarks
128399
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128400
+ * @beta
128401
+ */
128402
+ key?: boolean;
128403
+ /**
128404
+ * For EACH ITEM in the collection: The type of the value used for the custom property.
128405
+ *
128406
+ * @remarks
128407
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128408
+ * @beta
128409
+ */
128410
+ type?: boolean;
128411
+ /**
128412
+ * For EACH ITEM in the collection: The value of the custom property.
128413
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
128414
+ *
128415
+ * @remarks
128416
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128417
+ * @beta
128418
+ */
128419
+ value?: boolean;
128420
+ }
128421
+ /**
128422
+ * Represents presentation properties.
128423
+ *
128424
+ * @remarks
128425
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128426
+ * @beta
128427
+ */
128428
+ interface DocumentPropertiesLoadOptions {
128429
+ /**
128430
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
128431
+ */
128432
+ $all?: boolean;
128433
+ /**
128434
+ * The author of the presentation.
128435
+ *
128436
+ * @remarks
128437
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128438
+ * @beta
128439
+ */
128440
+ author?: boolean;
128441
+ /**
128442
+ * The category of the presentation.
128443
+ *
128444
+ * @remarks
128445
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128446
+ * @beta
128447
+ */
128448
+ category?: boolean;
128449
+ /**
128450
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
128451
+ *
128452
+ * @remarks
128453
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128454
+ * @beta
128455
+ */
128456
+ comments?: boolean;
128457
+ /**
128458
+ * The company of the presentation.
128459
+ *
128460
+ * @remarks
128461
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128462
+ * @beta
128463
+ */
128464
+ company?: boolean;
128465
+ /**
128466
+ * The creation date of the presentation.
128467
+ *
128468
+ * @remarks
128469
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128470
+ * @beta
128471
+ */
128472
+ creationDate?: boolean;
128473
+ /**
128474
+ * The keywords of the presentation.
128475
+ *
128476
+ * @remarks
128477
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128478
+ * @beta
128479
+ */
128480
+ keywords?: boolean;
128481
+ /**
128482
+ * The last author of the presentation.
128483
+ *
128484
+ * @remarks
128485
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128486
+ * @beta
128487
+ */
128488
+ lastAuthor?: boolean;
128489
+ /**
128490
+ * The manager of the presentation.
128491
+ *
128492
+ * @remarks
128493
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128494
+ * @beta
128495
+ */
128496
+ manager?: boolean;
128497
+ /**
128498
+ * The revision number of the presentation.
128499
+ *
128500
+ * @remarks
128501
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128502
+ * @beta
128503
+ */
128504
+ revisionNumber?: boolean;
128505
+ /**
128506
+ * The subject of the presentation.
128507
+ *
128508
+ * @remarks
128509
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128510
+ * @beta
128511
+ */
128512
+ subject?: boolean;
128513
+ /**
128514
+ * The title of the presentation.
128515
+ *
128516
+ * @remarks
128517
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
128518
+ * @beta
128519
+ */
128520
+ title?: boolean;
128521
+ }
127785
128522
  /**
127786
128523
  * Represents a collection of shapes.
127787
128524
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.516",
3
+ "version": "1.0.517",
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",
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "f96283860a85841a509288f0b57583cbf4558f2cba8f7cdca773f1e232c37273",
48
+ "typesPublisherContentHash": "b5226546b9e95d625f82c89521d90e6c3ae452367e0ff96ab961ce6cc77a579c",
49
49
  "typeScriptVersion": "4.8",
50
50
  "nonNpm": true
51
51
  }