@types/office-js-preview 1.0.498 → 1.0.499

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: Wed, 14 Aug 2024 20:07:48 GMT
11
+ * Last updated: Tue, 20 Aug 2024 17:07:30 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -122569,6 +122569,14 @@ declare namespace PowerPoint {
122569
122569
  class Presentation extends OfficeExtension.ClientObject {
122570
122570
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122571
122571
  context: RequestContext;
122572
+ /**
122573
+ * Returns a collection of custom XML parts that are associated with the presentation.
122574
+ *
122575
+ * @remarks
122576
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122577
+ * @beta
122578
+ */
122579
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
122572
122580
  /**
122573
122581
  * Returns the collection of `SlideMaster` objects that are in the presentation.
122574
122582
  *
@@ -122704,6 +122712,368 @@ declare namespace PowerPoint {
122704
122712
  */
122705
122713
  slideMasterId?: string;
122706
122714
  }
122715
+ /**
122716
+ * Represents a custom XML part object.
122717
+ *
122718
+ * @remarks
122719
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122720
+ * @beta
122721
+ */
122722
+ class CustomXmlPart extends OfficeExtension.ClientObject {
122723
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122724
+ context: RequestContext;
122725
+ /**
122726
+ * The ID of the custom XML part.
122727
+ *
122728
+ * @remarks
122729
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122730
+ * @beta
122731
+ */
122732
+ readonly id: string;
122733
+ /**
122734
+ * The namespace URI of the custom XML part.
122735
+ *
122736
+ * @remarks
122737
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122738
+ * @beta
122739
+ */
122740
+ readonly namespaceUri: string;
122741
+ /**
122742
+ * Deletes the custom XML part.
122743
+ *
122744
+ * @remarks
122745
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122746
+ * @beta
122747
+ */
122748
+ delete(): void;
122749
+ /**
122750
+ * Gets the XML content of the custom XML part.
122751
+ *
122752
+ * @remarks
122753
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122754
+ * @beta
122755
+ */
122756
+ getXml(): OfficeExtension.ClientResult<string>;
122757
+ /**
122758
+ * Sets the XML content for the custom XML part.
122759
+ *
122760
+ * @remarks
122761
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122762
+ * @beta
122763
+ *
122764
+ * @param xml XML content for the part.
122765
+ */
122766
+ setXml(xml: string): void;
122767
+ /**
122768
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122769
+ *
122770
+ * @param options Provides options for which properties of the object to load.
122771
+ */
122772
+ load(options?: PowerPoint.Interfaces.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;
122773
+ /**
122774
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122775
+ *
122776
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122777
+ */
122778
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPart;
122779
+ /**
122780
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122781
+ *
122782
+ * @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.
122783
+ */
122784
+ load(propertyNamesAndPaths?: {
122785
+ select?: string;
122786
+ expand?: string;
122787
+ }): PowerPoint.CustomXmlPart;
122788
+ /**
122789
+ * 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.)
122790
+ * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
122791
+ */
122792
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartData;
122793
+ }
122794
+ /**
122795
+ * A scoped collection of custom XML parts.
122796
+ A scoped collection is the result of some operation (such as filtering by namespace).
122797
+ A scoped collection cannot be scoped any further.
122798
+ *
122799
+ * @remarks
122800
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122801
+ * @beta
122802
+ */
122803
+ class CustomXmlPartScopedCollection extends OfficeExtension.ClientObject {
122804
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122805
+ context: RequestContext;
122806
+ /** Gets the loaded child items in this collection. */
122807
+ readonly items: PowerPoint.CustomXmlPart[];
122808
+ /**
122809
+ * Gets the number of custom XML parts in this collection.
122810
+ *
122811
+ * @remarks
122812
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122813
+ * @beta
122814
+ * @returns The number of custom XML parts in the collection.
122815
+ */
122816
+ getCount(): OfficeExtension.ClientResult<number>;
122817
+ /**
122818
+ * Gets a `CustomXmlPart` based on its ID.
122819
+ *
122820
+ * @remarks
122821
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122822
+ * @beta
122823
+ *
122824
+ * @param id ID of the object to be retrieved.
122825
+ */
122826
+ getItem(id: string): PowerPoint.CustomXmlPart;
122827
+ /**
122828
+ * Gets a `CustomXmlPart` based on its ID.
122829
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
122830
+ 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}.
122831
+ *
122832
+ * @remarks
122833
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122834
+ * @beta
122835
+ *
122836
+ * @param id ID of the object to be retrieved.
122837
+ */
122838
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
122839
+ /**
122840
+ * If the collection contains exactly one item, this method returns it.
122841
+ If the collection contains no items or more than one item, then this method returns the `GeneralException` error.
122842
+ *
122843
+ * @remarks
122844
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122845
+ * @beta
122846
+ */
122847
+ getOnlyItem(): PowerPoint.CustomXmlPart;
122848
+ /**
122849
+ * If the collection contains exactly one item, this method returns it.
122850
+ Otherwise, this method returns `null`.
122851
+ *
122852
+ * @remarks
122853
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122854
+ * @beta
122855
+ */
122856
+ getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;
122857
+ /**
122858
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122859
+ *
122860
+ * @param options Provides options for which properties of the object to load.
122861
+ */
122862
+ load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;
122863
+ /**
122864
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122865
+ *
122866
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122867
+ */
122868
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartScopedCollection;
122869
+ /**
122870
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122871
+ *
122872
+ * @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.
122873
+ */
122874
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;
122875
+ /**
122876
+ * 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.)
122877
+ * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
122878
+ */
122879
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;
122880
+ }
122881
+ /**
122882
+ * A collection of custom XML parts.
122883
+ *
122884
+ * @remarks
122885
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122886
+ * @beta
122887
+ */
122888
+ class CustomXmlPartCollection extends OfficeExtension.ClientObject {
122889
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122890
+ context: RequestContext;
122891
+ /** Gets the loaded child items in this collection. */
122892
+ readonly items: PowerPoint.CustomXmlPart[];
122893
+ /**
122894
+ * Adds a new `CustomXmlPart` to the collection.
122895
+ *
122896
+ * @remarks
122897
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122898
+ * @beta
122899
+ *
122900
+ * @param xml XML content. Must be a valid XML fragment. If the XML fragment is invalid, then this method returns the `GeneralException` error.
122901
+ */
122902
+ add(xml: string): PowerPoint.CustomXmlPart;
122903
+ /**
122904
+ * Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.
122905
+ *
122906
+ * @remarks
122907
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122908
+ * @beta
122909
+ *
122910
+ * @param namespaceUri This must be a fully qualified schema URI, such as "http://schemas.contoso.com/review/1.0".
122911
+ */
122912
+ getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;
122913
+ /**
122914
+ * Gets the number of custom XML parts in the collection.
122915
+ *
122916
+ * @remarks
122917
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122918
+ * @beta
122919
+ * @returns The number of custom XML parts in the collection.
122920
+ */
122921
+ getCount(): OfficeExtension.ClientResult<number>;
122922
+ /**
122923
+ * Gets a `CustomXmlPart` based on its ID.
122924
+ *
122925
+ * @remarks
122926
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122927
+ * @beta
122928
+ *
122929
+ * @param id ID of the object to be retrieved.
122930
+ */
122931
+ getItem(id: string): PowerPoint.CustomXmlPart;
122932
+ /**
122933
+ * Gets a `CustomXmlPart` based on its ID.
122934
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
122935
+ 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}.
122936
+ *
122937
+ * @remarks
122938
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122939
+ * @beta
122940
+ *
122941
+ * @param id ID of the object to be retrieved.
122942
+ */
122943
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
122944
+ /**
122945
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122946
+ *
122947
+ * @param options Provides options for which properties of the object to load.
122948
+ */
122949
+ load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;
122950
+ /**
122951
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122952
+ *
122953
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122954
+ */
122955
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartCollection;
122956
+ /**
122957
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122958
+ *
122959
+ * @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.
122960
+ */
122961
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection;
122962
+ /**
122963
+ * 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.)
122964
+ * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
122965
+ */
122966
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
122967
+ }
122968
+ /**
122969
+ * Represents a single hyperlink.
122970
+ *
122971
+ * @remarks
122972
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122973
+ * @beta
122974
+ */
122975
+ class Hyperlink extends OfficeExtension.ClientObject {
122976
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122977
+ context: RequestContext;
122978
+ /**
122979
+ * Specifies the URL target of the hyperlink.
122980
+ *
122981
+ * @remarks
122982
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122983
+ * @beta
122984
+ */
122985
+ address: string;
122986
+ /**
122987
+ * Specifies the string displayed when hovering over the hyperlink.
122988
+ *
122989
+ * @remarks
122990
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122991
+ * @beta
122992
+ */
122993
+ screenTip: string;
122994
+ /**
122995
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122996
+ *
122997
+ * @param options Provides options for which properties of the object to load.
122998
+ */
122999
+ load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
123000
+ /**
123001
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123002
+ *
123003
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123004
+ */
123005
+ load(propertyNames?: string | string[]): PowerPoint.Hyperlink;
123006
+ /**
123007
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123008
+ *
123009
+ * @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.
123010
+ */
123011
+ load(propertyNamesAndPaths?: {
123012
+ select?: string;
123013
+ expand?: string;
123014
+ }): PowerPoint.Hyperlink;
123015
+ /**
123016
+ * 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.)
123017
+ * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
123018
+ */
123019
+ toJSON(): PowerPoint.Interfaces.HyperlinkData;
123020
+ }
123021
+ /**
123022
+ * Represents a collection of hyperlinks.
123023
+ *
123024
+ * @remarks
123025
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123026
+ * @beta
123027
+ */
123028
+ class HyperlinkCollection extends OfficeExtension.ClientObject {
123029
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123030
+ context: RequestContext;
123031
+ /** Gets the loaded child items in this collection. */
123032
+ readonly items: PowerPoint.Hyperlink[];
123033
+ /**
123034
+ * Gets the number of hyperlinks in the collection.
123035
+ *
123036
+ * @remarks
123037
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123038
+ * @beta
123039
+ * @returns The number of hyperlinks in the collection.
123040
+ */
123041
+ getCount(): OfficeExtension.ClientResult<number>;
123042
+ /**
123043
+ * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range.
123044
+ *
123045
+ * @remarks
123046
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123047
+ * @beta
123048
+ *
123049
+ * @param index The index of the hyperlink in the collection.
123050
+ * @returns The hyperlink at the given index. An error is thrown if index is out of range.
123051
+ */
123052
+ getItemAt(index: number): PowerPoint.Hyperlink;
123053
+ /**
123054
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123055
+ *
123056
+ * @param options Provides options for which properties of the object to load.
123057
+ */
123058
+ load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;
123059
+ /**
123060
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123061
+ *
123062
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123063
+ */
123064
+ load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;
123065
+ /**
123066
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123067
+ *
123068
+ * @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.
123069
+ */
123070
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
123071
+ /**
123072
+ * 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.)
123073
+ * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
123074
+ */
123075
+ toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;
123076
+ }
122707
123077
  /**
122708
123078
  * Specifies the connector type for line shapes.
122709
123079
  *
@@ -124290,6 +124660,14 @@ declare namespace PowerPoint {
124290
124660
  class SlideLayout extends OfficeExtension.ClientObject {
124291
124661
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124292
124662
  context: RequestContext;
124663
+ /**
124664
+ * Returns a collection of custom XML parts in the slide layout.
124665
+ *
124666
+ * @remarks
124667
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
124668
+ * @beta
124669
+ */
124670
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
124293
124671
  /**
124294
124672
  * Returns a collection of shapes in the slide layout.
124295
124673
  *
@@ -124421,6 +124799,14 @@ declare namespace PowerPoint {
124421
124799
  class SlideMaster extends OfficeExtension.ClientObject {
124422
124800
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124423
124801
  context: RequestContext;
124802
+ /**
124803
+ * Returns a collection of custom XML parts in the Slide Master.
124804
+ *
124805
+ * @remarks
124806
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
124807
+ * @beta
124808
+ */
124809
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
124424
124810
  /**
124425
124811
  * Gets the collection of layouts provided by the Slide Master for slides.
124426
124812
  *
@@ -124627,6 +125013,22 @@ declare namespace PowerPoint {
124627
125013
  class Slide extends OfficeExtension.ClientObject {
124628
125014
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124629
125015
  context: RequestContext;
125016
+ /**
125017
+ * Returns a collection of custom XML parts in the slide.
125018
+ *
125019
+ * @remarks
125020
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125021
+ * @beta
125022
+ */
125023
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
125024
+ /**
125025
+ * Returns a collection of hyperlinks in the slide.
125026
+ *
125027
+ * @remarks
125028
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125029
+ * @beta
125030
+ */
125031
+ readonly hyperlinks: PowerPoint.HyperlinkCollection;
124630
125032
  /**
124631
125033
  * Gets the layout of the slide.
124632
125034
  *
@@ -125425,6 +125827,14 @@ declare namespace PowerPoint {
125425
125827
  class Shape extends OfficeExtension.ClientObject {
125426
125828
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
125427
125829
  context: RequestContext;
125830
+ /**
125831
+ * Returns a collection of custom XML parts in the shape.
125832
+ *
125833
+ * @remarks
125834
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125835
+ * @beta
125836
+ */
125837
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
125428
125838
  /**
125429
125839
  * Returns the fill formatting of this shape.
125430
125840
  *
@@ -125957,6 +126367,37 @@ declare namespace PowerPoint {
125957
126367
  */
125958
126368
  $skip?: number;
125959
126369
  }
126370
+ /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
126371
+ interface CustomXmlPartScopedCollectionUpdateData {
126372
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126373
+ }
126374
+ /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */
126375
+ interface CustomXmlPartCollectionUpdateData {
126376
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126377
+ }
126378
+ /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */
126379
+ interface HyperlinkUpdateData {
126380
+ /**
126381
+ * Specifies the URL target of the hyperlink.
126382
+ *
126383
+ * @remarks
126384
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126385
+ * @beta
126386
+ */
126387
+ address?: string;
126388
+ /**
126389
+ * Specifies the string displayed when hovering over the hyperlink.
126390
+ *
126391
+ * @remarks
126392
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126393
+ * @beta
126394
+ */
126395
+ screenTip?: string;
126396
+ }
126397
+ /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */
126398
+ interface HyperlinkCollectionUpdateData {
126399
+ items?: PowerPoint.Interfaces.HyperlinkData[];
126400
+ }
125960
126401
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
125961
126402
  interface ShapeCollectionUpdateData {
125962
126403
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126249,6 +126690,56 @@ declare namespace PowerPoint {
126249
126690
  id?: string;
126250
126691
  title?: string;
126251
126692
  }
126693
+ /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
126694
+ interface CustomXmlPartData {
126695
+ /**
126696
+ * The ID of the custom XML part.
126697
+ *
126698
+ * @remarks
126699
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126700
+ * @beta
126701
+ */
126702
+ id?: string;
126703
+ /**
126704
+ * The namespace URI of the custom XML part.
126705
+ *
126706
+ * @remarks
126707
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126708
+ * @beta
126709
+ */
126710
+ namespaceUri?: string;
126711
+ }
126712
+ /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */
126713
+ interface CustomXmlPartScopedCollectionData {
126714
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126715
+ }
126716
+ /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
126717
+ interface CustomXmlPartCollectionData {
126718
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126719
+ }
126720
+ /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
126721
+ interface HyperlinkData {
126722
+ /**
126723
+ * Specifies the URL target of the hyperlink.
126724
+ *
126725
+ * @remarks
126726
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126727
+ * @beta
126728
+ */
126729
+ address?: string;
126730
+ /**
126731
+ * Specifies the string displayed when hovering over the hyperlink.
126732
+ *
126733
+ * @remarks
126734
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126735
+ * @beta
126736
+ */
126737
+ screenTip?: string;
126738
+ }
126739
+ /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
126740
+ interface HyperlinkCollectionData {
126741
+ items?: PowerPoint.Interfaces.HyperlinkData[];
126742
+ }
126252
126743
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
126253
126744
  interface ShapeCollectionData {
126254
126745
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126627,6 +127118,153 @@ declare namespace PowerPoint {
126627
127118
  id?: boolean;
126628
127119
  title?: boolean;
126629
127120
  }
127121
+ /**
127122
+ * Represents a custom XML part object.
127123
+ *
127124
+ * @remarks
127125
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127126
+ * @beta
127127
+ */
127128
+ interface CustomXmlPartLoadOptions {
127129
+ /**
127130
+ 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`).
127131
+ */
127132
+ $all?: boolean;
127133
+ /**
127134
+ * The ID of the custom XML part.
127135
+ *
127136
+ * @remarks
127137
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127138
+ * @beta
127139
+ */
127140
+ id?: boolean;
127141
+ /**
127142
+ * The namespace URI of the custom XML part.
127143
+ *
127144
+ * @remarks
127145
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127146
+ * @beta
127147
+ */
127148
+ namespaceUri?: boolean;
127149
+ }
127150
+ /**
127151
+ * A scoped collection of custom XML parts.
127152
+ A scoped collection is the result of some operation (such as filtering by namespace).
127153
+ A scoped collection cannot be scoped any further.
127154
+ *
127155
+ * @remarks
127156
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127157
+ * @beta
127158
+ */
127159
+ interface CustomXmlPartScopedCollectionLoadOptions {
127160
+ /**
127161
+ 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`).
127162
+ */
127163
+ $all?: boolean;
127164
+ /**
127165
+ * For EACH ITEM in the collection: The ID of the custom XML part.
127166
+ *
127167
+ * @remarks
127168
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127169
+ * @beta
127170
+ */
127171
+ id?: boolean;
127172
+ /**
127173
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
127174
+ *
127175
+ * @remarks
127176
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127177
+ * @beta
127178
+ */
127179
+ namespaceUri?: boolean;
127180
+ }
127181
+ /**
127182
+ * A collection of custom XML parts.
127183
+ *
127184
+ * @remarks
127185
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127186
+ * @beta
127187
+ */
127188
+ interface CustomXmlPartCollectionLoadOptions {
127189
+ /**
127190
+ 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`).
127191
+ */
127192
+ $all?: boolean;
127193
+ /**
127194
+ * For EACH ITEM in the collection: The ID of the custom XML part.
127195
+ *
127196
+ * @remarks
127197
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127198
+ * @beta
127199
+ */
127200
+ id?: boolean;
127201
+ /**
127202
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
127203
+ *
127204
+ * @remarks
127205
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127206
+ * @beta
127207
+ */
127208
+ namespaceUri?: boolean;
127209
+ }
127210
+ /**
127211
+ * Represents a single hyperlink.
127212
+ *
127213
+ * @remarks
127214
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127215
+ * @beta
127216
+ */
127217
+ interface HyperlinkLoadOptions {
127218
+ /**
127219
+ 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`).
127220
+ */
127221
+ $all?: boolean;
127222
+ /**
127223
+ * Specifies the URL target of the hyperlink.
127224
+ *
127225
+ * @remarks
127226
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127227
+ * @beta
127228
+ */
127229
+ address?: boolean;
127230
+ /**
127231
+ * Specifies the string displayed when hovering over the hyperlink.
127232
+ *
127233
+ * @remarks
127234
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127235
+ * @beta
127236
+ */
127237
+ screenTip?: boolean;
127238
+ }
127239
+ /**
127240
+ * Represents a collection of hyperlinks.
127241
+ *
127242
+ * @remarks
127243
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127244
+ * @beta
127245
+ */
127246
+ interface HyperlinkCollectionLoadOptions {
127247
+ /**
127248
+ 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`).
127249
+ */
127250
+ $all?: boolean;
127251
+ /**
127252
+ * For EACH ITEM in the collection: Specifies the URL target of the hyperlink.
127253
+ *
127254
+ * @remarks
127255
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127256
+ * @beta
127257
+ */
127258
+ address?: boolean;
127259
+ /**
127260
+ * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
127261
+ *
127262
+ * @remarks
127263
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127264
+ * @beta
127265
+ */
127266
+ screenTip?: boolean;
127267
+ }
126630
127268
  /**
126631
127269
  * Represents the collection of shapes.
126632
127270
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.498",
3
+ "version": "1.0.499",
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": "f10ebb9813b13cd0e001f18d303985972240127ed41137e855d9897a12646e47",
48
+ "typesPublisherContentHash": "cdf42a38202782a3c665d31f3e6e4cf1d9265c88a163eaa5319877c503e7301a",
49
49
  "typeScriptVersion": "4.8",
50
50
  "nonNpm": true
51
51
  }