@types/office-js-preview 1.0.498 → 1.0.500

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: Thu, 22 Aug 2024 23:07:34 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -12781,10 +12781,16 @@ declare namespace Office {
12781
12781
  *
12782
12782
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12783
12783
  *
12784
- * **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12784
+ * **Important**:
12785
+ *
12786
+ * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12785
12787
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
12786
12788
  * render efficiently with its rendering engine.
12787
12789
  *
12790
+ * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12791
+ * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
12792
+ * Otherwise, you may receive an unexpected value, such as an empty string.
12793
+ *
12788
12794
  * @param coercionType - The format for the returned body.
12789
12795
  * @param options - An object literal that contains one or more of the following properties:-
12790
12796
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -12804,10 +12810,16 @@ declare namespace Office {
12804
12810
  *
12805
12811
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12806
12812
  *
12807
- * **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12813
+ * **Important**:
12814
+ *
12815
+ * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12808
12816
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
12809
12817
  * render efficiently with its rendering engine.
12810
12818
  *
12819
+ * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12820
+ * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
12821
+ * Otherwise, you may receive an unexpected value, such as an empty string.
12822
+ *
12811
12823
  * @param coercionType - The format for the returned body.
12812
12824
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12813
12825
  * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
@@ -122569,6 +122581,14 @@ declare namespace PowerPoint {
122569
122581
  class Presentation extends OfficeExtension.ClientObject {
122570
122582
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122571
122583
  context: RequestContext;
122584
+ /**
122585
+ * Returns a collection of custom XML parts that are associated with the presentation.
122586
+ *
122587
+ * @remarks
122588
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122589
+ * @beta
122590
+ */
122591
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
122572
122592
  /**
122573
122593
  * Returns the collection of `SlideMaster` objects that are in the presentation.
122574
122594
  *
@@ -122704,6 +122724,368 @@ declare namespace PowerPoint {
122704
122724
  */
122705
122725
  slideMasterId?: string;
122706
122726
  }
122727
+ /**
122728
+ * Represents a custom XML part object.
122729
+ *
122730
+ * @remarks
122731
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122732
+ * @beta
122733
+ */
122734
+ class CustomXmlPart extends OfficeExtension.ClientObject {
122735
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122736
+ context: RequestContext;
122737
+ /**
122738
+ * The ID of the custom XML part.
122739
+ *
122740
+ * @remarks
122741
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122742
+ * @beta
122743
+ */
122744
+ readonly id: string;
122745
+ /**
122746
+ * The namespace URI of the custom XML part.
122747
+ *
122748
+ * @remarks
122749
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122750
+ * @beta
122751
+ */
122752
+ readonly namespaceUri: string;
122753
+ /**
122754
+ * Deletes the custom XML part.
122755
+ *
122756
+ * @remarks
122757
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122758
+ * @beta
122759
+ */
122760
+ delete(): void;
122761
+ /**
122762
+ * Gets the XML content of the custom XML part.
122763
+ *
122764
+ * @remarks
122765
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122766
+ * @beta
122767
+ */
122768
+ getXml(): OfficeExtension.ClientResult<string>;
122769
+ /**
122770
+ * Sets the XML content for the custom XML part.
122771
+ *
122772
+ * @remarks
122773
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122774
+ * @beta
122775
+ *
122776
+ * @param xml XML content for the part.
122777
+ */
122778
+ setXml(xml: string): void;
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 options Provides options for which properties of the object to load.
122783
+ */
122784
+ load(options?: PowerPoint.Interfaces.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;
122785
+ /**
122786
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122787
+ *
122788
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122789
+ */
122790
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPart;
122791
+ /**
122792
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122793
+ *
122794
+ * @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.
122795
+ */
122796
+ load(propertyNamesAndPaths?: {
122797
+ select?: string;
122798
+ expand?: string;
122799
+ }): PowerPoint.CustomXmlPart;
122800
+ /**
122801
+ * 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.)
122802
+ * 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.
122803
+ */
122804
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartData;
122805
+ }
122806
+ /**
122807
+ * A scoped collection of custom XML parts.
122808
+ A scoped collection is the result of some operation (such as filtering by namespace).
122809
+ A scoped collection cannot be scoped any further.
122810
+ *
122811
+ * @remarks
122812
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122813
+ * @beta
122814
+ */
122815
+ class CustomXmlPartScopedCollection extends OfficeExtension.ClientObject {
122816
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122817
+ context: RequestContext;
122818
+ /** Gets the loaded child items in this collection. */
122819
+ readonly items: PowerPoint.CustomXmlPart[];
122820
+ /**
122821
+ * Gets the number of custom XML parts in this collection.
122822
+ *
122823
+ * @remarks
122824
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122825
+ * @beta
122826
+ * @returns The number of custom XML parts in the collection.
122827
+ */
122828
+ getCount(): OfficeExtension.ClientResult<number>;
122829
+ /**
122830
+ * Gets a `CustomXmlPart` based on its ID.
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
+ getItem(id: string): PowerPoint.CustomXmlPart;
122839
+ /**
122840
+ * Gets a `CustomXmlPart` based on its ID.
122841
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
122842
+ 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}.
122843
+ *
122844
+ * @remarks
122845
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122846
+ * @beta
122847
+ *
122848
+ * @param id ID of the object to be retrieved.
122849
+ */
122850
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
122851
+ /**
122852
+ * If the collection contains exactly one item, this method returns it.
122853
+ If the collection contains no items or more than one item, then this method returns the `GeneralException` error.
122854
+ *
122855
+ * @remarks
122856
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122857
+ * @beta
122858
+ */
122859
+ getOnlyItem(): PowerPoint.CustomXmlPart;
122860
+ /**
122861
+ * If the collection contains exactly one item, this method returns it.
122862
+ Otherwise, this method returns `null`.
122863
+ *
122864
+ * @remarks
122865
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122866
+ * @beta
122867
+ */
122868
+ getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;
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 options Provides options for which properties of the object to load.
122873
+ */
122874
+ load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;
122875
+ /**
122876
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122877
+ *
122878
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122879
+ */
122880
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartScopedCollection;
122881
+ /**
122882
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122883
+ *
122884
+ * @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.
122885
+ */
122886
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;
122887
+ /**
122888
+ * 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.)
122889
+ * 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.
122890
+ */
122891
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;
122892
+ }
122893
+ /**
122894
+ * A collection of custom XML parts.
122895
+ *
122896
+ * @remarks
122897
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122898
+ * @beta
122899
+ */
122900
+ class CustomXmlPartCollection extends OfficeExtension.ClientObject {
122901
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122902
+ context: RequestContext;
122903
+ /** Gets the loaded child items in this collection. */
122904
+ readonly items: PowerPoint.CustomXmlPart[];
122905
+ /**
122906
+ * Adds a new `CustomXmlPart` to the collection.
122907
+ *
122908
+ * @remarks
122909
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122910
+ * @beta
122911
+ *
122912
+ * @param xml XML content. Must be a valid XML fragment. If the XML fragment is invalid, then this method returns the `GeneralException` error.
122913
+ */
122914
+ add(xml: string): PowerPoint.CustomXmlPart;
122915
+ /**
122916
+ * Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.
122917
+ *
122918
+ * @remarks
122919
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122920
+ * @beta
122921
+ *
122922
+ * @param namespaceUri This must be a fully qualified schema URI, such as "http://schemas.contoso.com/review/1.0".
122923
+ */
122924
+ getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;
122925
+ /**
122926
+ * Gets the number of custom XML parts in the collection.
122927
+ *
122928
+ * @remarks
122929
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122930
+ * @beta
122931
+ * @returns The number of custom XML parts in the collection.
122932
+ */
122933
+ getCount(): OfficeExtension.ClientResult<number>;
122934
+ /**
122935
+ * Gets a `CustomXmlPart` based on its ID.
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
+ getItem(id: string): PowerPoint.CustomXmlPart;
122944
+ /**
122945
+ * Gets a `CustomXmlPart` based on its ID.
122946
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
122947
+ 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}.
122948
+ *
122949
+ * @remarks
122950
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122951
+ * @beta
122952
+ *
122953
+ * @param id ID of the object to be retrieved.
122954
+ */
122955
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
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 options Provides options for which properties of the object to load.
122960
+ */
122961
+ load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;
122962
+ /**
122963
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122964
+ *
122965
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122966
+ */
122967
+ load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartCollection;
122968
+ /**
122969
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122970
+ *
122971
+ * @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.
122972
+ */
122973
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection;
122974
+ /**
122975
+ * 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.)
122976
+ * 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.
122977
+ */
122978
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
122979
+ }
122980
+ /**
122981
+ * Represents a single hyperlink.
122982
+ *
122983
+ * @remarks
122984
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122985
+ * @beta
122986
+ */
122987
+ class Hyperlink extends OfficeExtension.ClientObject {
122988
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122989
+ context: RequestContext;
122990
+ /**
122991
+ * Specifies the URL target of the hyperlink.
122992
+ *
122993
+ * @remarks
122994
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
122995
+ * @beta
122996
+ */
122997
+ address: string;
122998
+ /**
122999
+ * Specifies the string displayed when hovering over the hyperlink.
123000
+ *
123001
+ * @remarks
123002
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123003
+ * @beta
123004
+ */
123005
+ screenTip: string;
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 options Provides options for which properties of the object to load.
123010
+ */
123011
+ load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
123012
+ /**
123013
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123014
+ *
123015
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123016
+ */
123017
+ load(propertyNames?: string | string[]): PowerPoint.Hyperlink;
123018
+ /**
123019
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123020
+ *
123021
+ * @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.
123022
+ */
123023
+ load(propertyNamesAndPaths?: {
123024
+ select?: string;
123025
+ expand?: string;
123026
+ }): PowerPoint.Hyperlink;
123027
+ /**
123028
+ * 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.)
123029
+ * 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.
123030
+ */
123031
+ toJSON(): PowerPoint.Interfaces.HyperlinkData;
123032
+ }
123033
+ /**
123034
+ * Represents a collection of hyperlinks.
123035
+ *
123036
+ * @remarks
123037
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123038
+ * @beta
123039
+ */
123040
+ class HyperlinkCollection extends OfficeExtension.ClientObject {
123041
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123042
+ context: RequestContext;
123043
+ /** Gets the loaded child items in this collection. */
123044
+ readonly items: PowerPoint.Hyperlink[];
123045
+ /**
123046
+ * Gets the number of hyperlinks in the collection.
123047
+ *
123048
+ * @remarks
123049
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123050
+ * @beta
123051
+ * @returns The number of hyperlinks in the collection.
123052
+ */
123053
+ getCount(): OfficeExtension.ClientResult<number>;
123054
+ /**
123055
+ * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range.
123056
+ *
123057
+ * @remarks
123058
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123059
+ * @beta
123060
+ *
123061
+ * @param index The index of the hyperlink in the collection.
123062
+ * @returns The hyperlink at the given index. An error is thrown if index is out of range.
123063
+ */
123064
+ getItemAt(index: number): PowerPoint.Hyperlink;
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 options Provides options for which properties of the object to load.
123069
+ */
123070
+ load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;
123071
+ /**
123072
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123073
+ *
123074
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123075
+ */
123076
+ load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;
123077
+ /**
123078
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123079
+ *
123080
+ * @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.
123081
+ */
123082
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
123083
+ /**
123084
+ * 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.)
123085
+ * 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.
123086
+ */
123087
+ toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;
123088
+ }
122707
123089
  /**
122708
123090
  * Specifies the connector type for line shapes.
122709
123091
  *
@@ -124290,6 +124672,14 @@ declare namespace PowerPoint {
124290
124672
  class SlideLayout extends OfficeExtension.ClientObject {
124291
124673
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124292
124674
  context: RequestContext;
124675
+ /**
124676
+ * Returns a collection of custom XML parts in the slide layout.
124677
+ *
124678
+ * @remarks
124679
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
124680
+ * @beta
124681
+ */
124682
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
124293
124683
  /**
124294
124684
  * Returns a collection of shapes in the slide layout.
124295
124685
  *
@@ -124421,6 +124811,14 @@ declare namespace PowerPoint {
124421
124811
  class SlideMaster extends OfficeExtension.ClientObject {
124422
124812
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124423
124813
  context: RequestContext;
124814
+ /**
124815
+ * Returns a collection of custom XML parts in the Slide Master.
124816
+ *
124817
+ * @remarks
124818
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
124819
+ * @beta
124820
+ */
124821
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
124424
124822
  /**
124425
124823
  * Gets the collection of layouts provided by the Slide Master for slides.
124426
124824
  *
@@ -124627,6 +125025,22 @@ declare namespace PowerPoint {
124627
125025
  class Slide extends OfficeExtension.ClientObject {
124628
125026
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
124629
125027
  context: RequestContext;
125028
+ /**
125029
+ * Returns a collection of custom XML parts in the slide.
125030
+ *
125031
+ * @remarks
125032
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125033
+ * @beta
125034
+ */
125035
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
125036
+ /**
125037
+ * Returns a collection of hyperlinks in the slide.
125038
+ *
125039
+ * @remarks
125040
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125041
+ * @beta
125042
+ */
125043
+ readonly hyperlinks: PowerPoint.HyperlinkCollection;
124630
125044
  /**
124631
125045
  * Gets the layout of the slide.
124632
125046
  *
@@ -125425,6 +125839,14 @@ declare namespace PowerPoint {
125425
125839
  class Shape extends OfficeExtension.ClientObject {
125426
125840
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
125427
125841
  context: RequestContext;
125842
+ /**
125843
+ * Returns a collection of custom XML parts in the shape.
125844
+ *
125845
+ * @remarks
125846
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
125847
+ * @beta
125848
+ */
125849
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
125428
125850
  /**
125429
125851
  * Returns the fill formatting of this shape.
125430
125852
  *
@@ -125957,6 +126379,37 @@ declare namespace PowerPoint {
125957
126379
  */
125958
126380
  $skip?: number;
125959
126381
  }
126382
+ /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
126383
+ interface CustomXmlPartScopedCollectionUpdateData {
126384
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126385
+ }
126386
+ /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */
126387
+ interface CustomXmlPartCollectionUpdateData {
126388
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126389
+ }
126390
+ /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */
126391
+ interface HyperlinkUpdateData {
126392
+ /**
126393
+ * Specifies the URL target of the hyperlink.
126394
+ *
126395
+ * @remarks
126396
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126397
+ * @beta
126398
+ */
126399
+ address?: string;
126400
+ /**
126401
+ * Specifies the string displayed when hovering over the hyperlink.
126402
+ *
126403
+ * @remarks
126404
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126405
+ * @beta
126406
+ */
126407
+ screenTip?: string;
126408
+ }
126409
+ /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */
126410
+ interface HyperlinkCollectionUpdateData {
126411
+ items?: PowerPoint.Interfaces.HyperlinkData[];
126412
+ }
125960
126413
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
125961
126414
  interface ShapeCollectionUpdateData {
125962
126415
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126249,6 +126702,56 @@ declare namespace PowerPoint {
126249
126702
  id?: string;
126250
126703
  title?: string;
126251
126704
  }
126705
+ /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
126706
+ interface CustomXmlPartData {
126707
+ /**
126708
+ * The ID of the custom XML part.
126709
+ *
126710
+ * @remarks
126711
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126712
+ * @beta
126713
+ */
126714
+ id?: string;
126715
+ /**
126716
+ * The namespace URI of the custom XML part.
126717
+ *
126718
+ * @remarks
126719
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126720
+ * @beta
126721
+ */
126722
+ namespaceUri?: string;
126723
+ }
126724
+ /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */
126725
+ interface CustomXmlPartScopedCollectionData {
126726
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126727
+ }
126728
+ /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
126729
+ interface CustomXmlPartCollectionData {
126730
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
126731
+ }
126732
+ /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
126733
+ interface HyperlinkData {
126734
+ /**
126735
+ * Specifies the URL target of the hyperlink.
126736
+ *
126737
+ * @remarks
126738
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126739
+ * @beta
126740
+ */
126741
+ address?: string;
126742
+ /**
126743
+ * Specifies the string displayed when hovering over the hyperlink.
126744
+ *
126745
+ * @remarks
126746
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
126747
+ * @beta
126748
+ */
126749
+ screenTip?: string;
126750
+ }
126751
+ /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
126752
+ interface HyperlinkCollectionData {
126753
+ items?: PowerPoint.Interfaces.HyperlinkData[];
126754
+ }
126252
126755
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
126253
126756
  interface ShapeCollectionData {
126254
126757
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -126627,6 +127130,153 @@ declare namespace PowerPoint {
126627
127130
  id?: boolean;
126628
127131
  title?: boolean;
126629
127132
  }
127133
+ /**
127134
+ * Represents a custom XML part object.
127135
+ *
127136
+ * @remarks
127137
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127138
+ * @beta
127139
+ */
127140
+ interface CustomXmlPartLoadOptions {
127141
+ /**
127142
+ 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`).
127143
+ */
127144
+ $all?: boolean;
127145
+ /**
127146
+ * The ID of the custom XML part.
127147
+ *
127148
+ * @remarks
127149
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127150
+ * @beta
127151
+ */
127152
+ id?: boolean;
127153
+ /**
127154
+ * The namespace URI of the custom XML part.
127155
+ *
127156
+ * @remarks
127157
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127158
+ * @beta
127159
+ */
127160
+ namespaceUri?: boolean;
127161
+ }
127162
+ /**
127163
+ * A scoped collection of custom XML parts.
127164
+ A scoped collection is the result of some operation (such as filtering by namespace).
127165
+ A scoped collection cannot be scoped any further.
127166
+ *
127167
+ * @remarks
127168
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127169
+ * @beta
127170
+ */
127171
+ interface CustomXmlPartScopedCollectionLoadOptions {
127172
+ /**
127173
+ 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`).
127174
+ */
127175
+ $all?: boolean;
127176
+ /**
127177
+ * For EACH ITEM in the collection: The ID of the custom XML part.
127178
+ *
127179
+ * @remarks
127180
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127181
+ * @beta
127182
+ */
127183
+ id?: boolean;
127184
+ /**
127185
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
127186
+ *
127187
+ * @remarks
127188
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127189
+ * @beta
127190
+ */
127191
+ namespaceUri?: boolean;
127192
+ }
127193
+ /**
127194
+ * A collection of custom XML parts.
127195
+ *
127196
+ * @remarks
127197
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127198
+ * @beta
127199
+ */
127200
+ interface CustomXmlPartCollectionLoadOptions {
127201
+ /**
127202
+ 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`).
127203
+ */
127204
+ $all?: boolean;
127205
+ /**
127206
+ * For EACH ITEM in the collection: The ID of the custom XML part.
127207
+ *
127208
+ * @remarks
127209
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127210
+ * @beta
127211
+ */
127212
+ id?: boolean;
127213
+ /**
127214
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
127215
+ *
127216
+ * @remarks
127217
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127218
+ * @beta
127219
+ */
127220
+ namespaceUri?: boolean;
127221
+ }
127222
+ /**
127223
+ * Represents a single hyperlink.
127224
+ *
127225
+ * @remarks
127226
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127227
+ * @beta
127228
+ */
127229
+ interface HyperlinkLoadOptions {
127230
+ /**
127231
+ 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`).
127232
+ */
127233
+ $all?: boolean;
127234
+ /**
127235
+ * Specifies the URL target of the hyperlink.
127236
+ *
127237
+ * @remarks
127238
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127239
+ * @beta
127240
+ */
127241
+ address?: boolean;
127242
+ /**
127243
+ * Specifies the string displayed when hovering over the hyperlink.
127244
+ *
127245
+ * @remarks
127246
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127247
+ * @beta
127248
+ */
127249
+ screenTip?: boolean;
127250
+ }
127251
+ /**
127252
+ * Represents a collection of hyperlinks.
127253
+ *
127254
+ * @remarks
127255
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127256
+ * @beta
127257
+ */
127258
+ interface HyperlinkCollectionLoadOptions {
127259
+ /**
127260
+ 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`).
127261
+ */
127262
+ $all?: boolean;
127263
+ /**
127264
+ * For EACH ITEM in the collection: Specifies the URL target of the hyperlink.
127265
+ *
127266
+ * @remarks
127267
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127268
+ * @beta
127269
+ */
127270
+ address?: boolean;
127271
+ /**
127272
+ * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
127273
+ *
127274
+ * @remarks
127275
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
127276
+ * @beta
127277
+ */
127278
+ screenTip?: boolean;
127279
+ }
126630
127280
  /**
126631
127281
  * Represents the collection of shapes.
126632
127282
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.498",
3
+ "version": "1.0.500",
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": "a8dd7ddc1bed51c5568ce5f4a202b9a5baed5014e4184da5b614815156875730",
49
49
  "typeScriptVersion": "4.8",
50
50
  "nonNpm": true
51
51
  }