@types/office-js 1.0.261 → 1.0.264

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +3524 -437
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -1035,7 +1035,7 @@ declare namespace Office {
1035
1035
  */
1036
1036
  interface EventCompletedOptions {
1037
1037
  /**
1038
- * A boolean value. When the completed method is used to signal completion of an event handler,
1038
+ * When the completed method is used to signal completion of an event handler,
1039
1039
  * this value indicates if the handled event should continue execution or be canceled.
1040
1040
  * For example, an add-in that handles the `ItemSend` event can set `allowEvent` to `false` to cancel sending of the message.
1041
1041
  */
@@ -10616,9 +10616,9 @@ declare namespace Office {
10616
10616
  *
10617
10617
  * - Windows: 500 members
10618
10618
  *
10619
- * - Mac: 100 members
10619
+ * - Classic Mac UI: 100 members
10620
10620
  *
10621
- * - Other: No limit
10621
+ * - New Mac UI, web browser, Android: No limit
10622
10622
  *
10623
10623
  * *Compose mode*
10624
10624
  *
@@ -10654,9 +10654,9 @@ declare namespace Office {
10654
10654
  *
10655
10655
  * - Windows: 500 members
10656
10656
  *
10657
- * - Mac: 100 members
10657
+ * - Classic Mac UI: 100 members
10658
10658
  *
10659
- * - Other: No limit
10659
+ * - New Mac UI, web browser, Android: No limit
10660
10660
  *
10661
10661
  * *Compose mode*
10662
10662
  *
@@ -10928,9 +10928,9 @@ declare namespace Office {
10928
10928
  *
10929
10929
  * - Windows: 500 members
10930
10930
  *
10931
- * - Mac: 100 members
10931
+ * - Classic Mac UI: 100 members
10932
10932
  *
10933
- * - Other: No limit
10933
+ * - New Mac UI, web browser, Android: No limit
10934
10934
  *
10935
10935
  * @remarks
10936
10936
  *
@@ -10976,9 +10976,9 @@ declare namespace Office {
10976
10976
  *
10977
10977
  * - Windows: 500 members
10978
10978
  *
10979
- * - Mac: 100 members
10979
+ * - Classic Mac UI: 100 members
10980
10980
  *
10981
- * - Other: No limit
10981
+ * - New Mac UI, web browser, Android: No limit
10982
10982
  *
10983
10983
  * @remarks
10984
10984
  *
@@ -15551,11 +15551,11 @@ declare namespace Office {
15551
15551
  *
15552
15552
  * - Windows: 500 members
15553
15553
  *
15554
- * - Mac: 100 members
15554
+ * - Classic Mac UI: 100 members
15555
15555
  *
15556
15556
  * - Web browser: 20 members
15557
15557
  *
15558
- * - Other: No limit
15558
+ * - New Mac UI, Android: No limit
15559
15559
  *
15560
15560
  * @remarks
15561
15561
  *
@@ -15849,11 +15849,11 @@ declare namespace Office {
15849
15849
  *
15850
15850
  * - Windows: 500 members
15851
15851
  *
15852
- * - Mac: 100 members
15852
+ * - Classic Mac UI: 100 members
15853
15853
  *
15854
15854
  * - Web browser: 20 members
15855
15855
  *
15856
- * - Other: No limit
15856
+ * - New Mac UI, Android: No limit
15857
15857
  *
15858
15858
  * @remarks
15859
15859
  *
@@ -16802,9 +16802,9 @@ declare namespace Office {
16802
16802
  * - Windows: 100 recipients.
16803
16803
  * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
16804
16804
  *
16805
- * - Mac, web browser: 100 recipients
16805
+ * - Classic Mac UI, web browser: 100 recipients
16806
16806
  *
16807
- * - Other: No limit
16807
+ * - New Mac UI, Android: No limit
16808
16808
  *
16809
16809
  * @remarks
16810
16810
  * [Api set: Mailbox 1.1]
@@ -16840,9 +16840,9 @@ declare namespace Office {
16840
16840
  * - Windows: 100 recipients.
16841
16841
  * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
16842
16842
  *
16843
- * - Mac, web browser: 100 recipients
16843
+ * - Classic Mac UI, web browser: 100 recipients
16844
16844
  *
16845
- * - Other: No limit
16845
+ * - New Mac UI, Android: No limit
16846
16846
  *
16847
16847
  * @remarks
16848
16848
  * [Api set: Mailbox 1.1]
@@ -16866,9 +16866,9 @@ declare namespace Office {
16866
16866
  * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
16867
16867
  * objects. Collection size limits:
16868
16868
  *
16869
- * - Windows, Mac, web browser: 500 members
16869
+ * - Windows, classic Mac UI, web browser: 500 members
16870
16870
  *
16871
- * - Other: No limit
16871
+ * - New Mac UI, Android: No limit
16872
16872
  *
16873
16873
  * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
16874
16874
  * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
@@ -16894,9 +16894,9 @@ declare namespace Office {
16894
16894
  * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
16895
16895
  * objects. Collection size limits:
16896
16896
  *
16897
- * - Windows, Mac, web browser: 500 members
16897
+ * - Windows, classic Mac UI, web browser: 500 members
16898
16898
  *
16899
- * - Other: No limit
16899
+ * - New Mac UI, Android: No limit
16900
16900
  *
16901
16901
  * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
16902
16902
  * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
@@ -16929,9 +16929,12 @@ declare namespace Office {
16929
16929
  *
16930
16930
  * Maximum number that can be set:
16931
16931
  *
16932
- * - Windows, Mac, web browser: 100 recipients
16932
+ * - Windows: 100 recipients.
16933
+ * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
16933
16934
  *
16934
- * - Other: No limit
16935
+ * - Classic Mac UI, web browser: 100 recipients
16936
+ *
16937
+ * - New Mac UI, Android: No limit
16935
16938
  *
16936
16939
  * @remarks
16937
16940
  * [Api set: Mailbox 1.1]
@@ -16967,9 +16970,12 @@ declare namespace Office {
16967
16970
  *
16968
16971
  * Maximum number that can be set:
16969
16972
  *
16970
- * - Windows, Mac, web browser: 100 recipients
16973
+ * - Windows: 100 recipients.
16974
+ * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
16975
+ *
16976
+ * - Classic Mac UI, web browser: 100 recipients
16971
16977
  *
16972
- * - Other: No limit
16978
+ * - New Mac UI, Android: No limit
16973
16979
  *
16974
16980
  * @remarks
16975
16981
  * [Api set: Mailbox 1.1]
@@ -98822,574 +98828,2763 @@ declare namespace PowerPoint {
98822
98828
  slideMasterId?: string;
98823
98829
  }
98824
98830
  /**
98825
- * Specifies the formatting options for when slides are inserted.
98831
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
98826
98832
  *
98827
98833
  * @remarks
98828
- * [Api set: PowerPointApi 1.2]
98834
+ * [Api set: PowerPointApi 1.4]
98829
98835
  */
98830
- enum InsertSlideFormatting {
98836
+ class BulletFormat extends OfficeExtension.ClientObject {
98837
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
98838
+ context: RequestContext;
98831
98839
  /**
98832
- * Copy the source theme into the target presentation and use that theme.
98840
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
98841
+ *
98833
98842
  * @remarks
98834
- * [Api set: PowerPointApi 1.2]
98843
+ * [Api set: PowerPointApi 1.4]
98835
98844
  */
98836
- keepSourceFormatting = "KeepSourceFormatting",
98845
+ visible: boolean;
98837
98846
  /**
98838
- * Use the existing theme in the target presentation.
98839
- * @remarks
98840
- * [Api set: PowerPointApi 1.2]
98847
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98848
+ *
98849
+ * @param options Provides options for which properties of the object to load.
98841
98850
  */
98842
- useDestinationTheme = "UseDestinationTheme",
98851
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
98852
+ /**
98853
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98854
+ *
98855
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
98856
+ */
98857
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
98858
+ /**
98859
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98860
+ *
98861
+ * @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.
98862
+ */
98863
+ load(propertyNamesAndPaths?: {
98864
+ select?: string;
98865
+ expand?: string;
98866
+ }): PowerPoint.BulletFormat;
98867
+ /**
98868
+ * 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.)
98869
+ * Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
98870
+ */
98871
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
98843
98872
  }
98844
98873
  /**
98845
- * Represents the available options when inserting slides.
98874
+ * Specifies the connector type for line shapes.
98846
98875
  *
98847
98876
  * @remarks
98848
- * [Api set: PowerPointApi 1.2]
98877
+ * [Api set: PowerPointApi 1.4]
98849
98878
  */
98850
- interface InsertSlideOptions {
98879
+ enum ConnectorType {
98851
98880
  /**
98852
- * Specifies which formatting to use during slide insertion.
98853
- The default option is to use "KeepSourceFormatting".
98854
- *
98881
+ * Straight connector type
98855
98882
  * @remarks
98856
- * [Api set: PowerPointApi 1.2]
98883
+ * [Api set: PowerPointApi 1.4]
98857
98884
  */
98858
- formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
98885
+ straight = "Straight",
98859
98886
  /**
98860
- * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
98861
- The order of these slides is preserved during the insertion.
98862
- If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
98863
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
98864
- *
98887
+ * Elbow connector type
98865
98888
  * @remarks
98866
- * [Api set: PowerPointApi 1.2]
98889
+ * [Api set: PowerPointApi 1.4]
98867
98890
  */
98868
- sourceSlideIds?: string[];
98891
+ elbow = "Elbow",
98869
98892
  /**
98870
- * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
98871
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
98872
- If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
98873
- *
98893
+ * Curve connector type
98874
98894
  * @remarks
98875
- * [Api set: PowerPointApi 1.2]
98895
+ * [Api set: PowerPointApi 1.4]
98876
98896
  */
98877
- targetSlideId?: string;
98897
+ curve = "Curve",
98878
98898
  }
98879
98899
  /**
98880
- * Represents the collection of shapes.
98900
+ * Specifies the shape type for a `GeometricShape` object.
98881
98901
  *
98882
98902
  * @remarks
98883
- * [Api set: PowerPointApi 1.3]
98903
+ * [Api set: PowerPointApi 1.4]
98884
98904
  */
98885
- class ShapeCollection extends OfficeExtension.ClientObject {
98886
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
98887
- context: RequestContext;
98888
- /** Gets the loaded child items in this collection. */
98889
- readonly items: PowerPoint.Shape[];
98905
+ enum GeometricShapeType {
98890
98906
  /**
98891
- * Gets the number of shapes in the collection.
98892
- *
98907
+ * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape
98893
98908
  * @remarks
98894
- * [Api set: PowerPointApi 1.3]
98895
- * @returns The number of shapes in the collection.
98909
+ * [Api set: PowerPointApi 1.4]
98896
98910
  */
98897
- getCount(): OfficeExtension.ClientResult<number>;
98911
+ lineInverse = "LineInverse",
98898
98912
  /**
98899
- * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
98900
- *
98913
+ * Isosceles Triangle
98901
98914
  * @remarks
98902
- * [Api set: PowerPointApi 1.3]
98903
- *
98904
- * @param key The ID of the shape.
98905
- * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
98915
+ * [Api set: PowerPointApi 1.4]
98906
98916
  */
98907
- getItem(key: string): PowerPoint.Shape;
98917
+ triangle = "Triangle",
98908
98918
  /**
98909
- * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
98910
- *
98919
+ * Right Triangle
98911
98920
  * @remarks
98912
- * [Api set: PowerPointApi 1.3]
98913
- *
98914
- * @param index The index of the shape in the collection.
98915
- * @returns The shape at the given index. An error is thrown if index is out of range.
98921
+ * [Api set: PowerPointApi 1.4]
98916
98922
  */
98917
- getItemAt(index: number): PowerPoint.Shape;
98923
+ rightTriangle = "RightTriangle",
98918
98924
  /**
98919
- * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
98920
- *
98925
+ * Rectangle
98921
98926
  * @remarks
98922
- * [Api set: PowerPointApi 1.3]
98923
- *
98924
- * @param id The ID of the shape.
98925
- * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
98927
+ * [Api set: PowerPointApi 1.4]
98926
98928
  */
98927
- getItemOrNullObject(id: string): PowerPoint.Shape;
98929
+ rectangle = "Rectangle",
98928
98930
  /**
98929
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98930
- *
98931
- * @param options Provides options for which properties of the object to load.
98931
+ * Diamond
98932
+ * @remarks
98933
+ * [Api set: PowerPointApi 1.4]
98932
98934
  */
98933
- load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
98935
+ diamond = "Diamond",
98934
98936
  /**
98935
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98936
- *
98937
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
98937
+ * Parallelogram
98938
+ * @remarks
98939
+ * [Api set: PowerPointApi 1.4]
98938
98940
  */
98939
- load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
98941
+ parallelogram = "Parallelogram",
98940
98942
  /**
98941
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98942
- *
98943
- * @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.
98943
+ * Trapezoid
98944
+ * @remarks
98945
+ * [Api set: PowerPointApi 1.4]
98944
98946
  */
98945
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
98946
- /**
98947
- * 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.)
98948
- * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
98949
- */
98950
- toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
98951
- }
98952
- /**
98953
- * Represents the layout of a slide.
98954
- *
98955
- * @remarks
98956
- * [Api set: PowerPointApi 1.3]
98957
- */
98958
- class SlideLayout extends OfficeExtension.ClientObject {
98959
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
98960
- context: RequestContext;
98947
+ trapezoid = "Trapezoid",
98961
98948
  /**
98962
- * Returns a collection of shapes in the slide layout.
98963
- *
98949
+ * Trapezoid which may have Non-Equal Sides
98964
98950
  * @remarks
98965
- * [Api set: PowerPointApi 1.3]
98951
+ * [Api set: PowerPointApi 1.4]
98966
98952
  */
98967
- readonly shapes: PowerPoint.ShapeCollection;
98953
+ nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
98968
98954
  /**
98969
- * Gets the unique ID of the slide layout.
98970
- *
98955
+ * Pentagon
98971
98956
  * @remarks
98972
- * [Api set: PowerPointApi 1.3]
98957
+ * [Api set: PowerPointApi 1.4]
98973
98958
  */
98974
- readonly id: string;
98959
+ pentagon = "Pentagon",
98975
98960
  /**
98976
- * Gets the name of the slide layout.
98977
- *
98961
+ * Hexagon
98978
98962
  * @remarks
98979
- * [Api set: PowerPointApi 1.3]
98963
+ * [Api set: PowerPointApi 1.4]
98980
98964
  */
98981
- readonly name: string;
98965
+ hexagon = "Hexagon",
98982
98966
  /**
98983
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98984
- *
98985
- * @param options Provides options for which properties of the object to load.
98967
+ * Heptagon
98968
+ * @remarks
98969
+ * [Api set: PowerPointApi 1.4]
98986
98970
  */
98987
- load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
98971
+ heptagon = "Heptagon",
98988
98972
  /**
98989
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98990
- *
98991
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
98973
+ * Octagon
98974
+ * @remarks
98975
+ * [Api set: PowerPointApi 1.4]
98992
98976
  */
98993
- load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
98977
+ octagon = "Octagon",
98994
98978
  /**
98995
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
98996
- *
98997
- * @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.
98979
+ * Decagon
98980
+ * @remarks
98981
+ * [Api set: PowerPointApi 1.4]
98998
98982
  */
98999
- load(propertyNamesAndPaths?: {
99000
- select?: string;
99001
- expand?: string;
99002
- }): PowerPoint.SlideLayout;
99003
- /**
99004
- * 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.)
99005
- * Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
99006
- */
99007
- toJSON(): PowerPoint.Interfaces.SlideLayoutData;
99008
- }
99009
- /**
99010
- * Represents the collection of layouts provided by the Slide Master for slides.
99011
- *
99012
- * @remarks
99013
- * [Api set: PowerPointApi 1.3]
99014
- */
99015
- class SlideLayoutCollection extends OfficeExtension.ClientObject {
99016
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99017
- context: RequestContext;
99018
- /** Gets the loaded child items in this collection. */
99019
- readonly items: PowerPoint.SlideLayout[];
98983
+ decagon = "Decagon",
99020
98984
  /**
99021
- * Gets the number of layouts in the collection.
99022
- *
98985
+ * Dodecagon
99023
98986
  * @remarks
99024
- * [Api set: PowerPointApi 1.3]
99025
- * @returns The number of layouts in the collection.
98987
+ * [Api set: PowerPointApi 1.4]
99026
98988
  */
99027
- getCount(): OfficeExtension.ClientResult<number>;
98989
+ dodecagon = "Dodecagon",
99028
98990
  /**
99029
- * Gets a layout using its unique ID.
99030
- *
98991
+ * Star: 4 Points
99031
98992
  * @remarks
99032
- * [Api set: PowerPointApi 1.3]
99033
- *
99034
- * @param key The ID of the layout.
99035
- * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
98993
+ * [Api set: PowerPointApi 1.4]
99036
98994
  */
99037
- getItem(key: string): PowerPoint.SlideLayout;
98995
+ star4 = "Star4",
99038
98996
  /**
99039
- * Gets a layout using its zero-based index in the collection.
99040
- *
98997
+ * Star: 5 Points
99041
98998
  * @remarks
99042
- * [Api set: PowerPointApi 1.3]
99043
- *
99044
- * @param index The index of the layout in the collection.
99045
- * @returns The layout at the given index. An error is thrown if index is out of range.
98999
+ * [Api set: PowerPointApi 1.4]
99046
99000
  */
99047
- getItemAt(index: number): PowerPoint.SlideLayout;
99001
+ star5 = "Star5",
99048
99002
  /**
99049
- * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
99050
- see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
99051
- *
99003
+ * Star: 6 Points
99052
99004
  * @remarks
99053
- * [Api set: PowerPointApi 1.3]
99054
- *
99055
- * @param id The ID of the layout.
99056
- * @returns The layout with the unique ID.
99005
+ * [Api set: PowerPointApi 1.4]
99057
99006
  */
99058
- getItemOrNullObject(id: string): PowerPoint.SlideLayout;
99007
+ star6 = "Star6",
99059
99008
  /**
99060
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99061
- *
99062
- * @param options Provides options for which properties of the object to load.
99009
+ * Star: 7 Points
99010
+ * @remarks
99011
+ * [Api set: PowerPointApi 1.4]
99063
99012
  */
99064
- load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
99013
+ star7 = "Star7",
99065
99014
  /**
99066
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99067
- *
99068
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
99015
+ * Star: 8 Points
99016
+ * @remarks
99017
+ * [Api set: PowerPointApi 1.4]
99069
99018
  */
99070
- load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
99019
+ star8 = "Star8",
99071
99020
  /**
99072
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99073
- *
99074
- * @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.
99021
+ * Star: 10 Points
99022
+ * @remarks
99023
+ * [Api set: PowerPointApi 1.4]
99075
99024
  */
99076
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
99077
- /**
99078
- * 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.)
99079
- * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
99080
- */
99081
- toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
99082
- }
99083
- /**
99084
- * Represents the Slide Master of a slide.
99085
- *
99086
- * @remarks
99087
- * [Api set: PowerPointApi 1.3]
99088
- */
99089
- class SlideMaster extends OfficeExtension.ClientObject {
99090
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99091
- context: RequestContext;
99025
+ star10 = "Star10",
99092
99026
  /**
99093
- * Gets the collection of layouts provided by the Slide Master for slides.
99094
- *
99027
+ * Star: 12 Points
99095
99028
  * @remarks
99096
- * [Api set: PowerPointApi 1.3]
99029
+ * [Api set: PowerPointApi 1.4]
99097
99030
  */
99098
- readonly layouts: PowerPoint.SlideLayoutCollection;
99031
+ star12 = "Star12",
99099
99032
  /**
99100
- * Returns a collection of shapes in the Slide Master.
99101
- *
99033
+ * Star: 16 Points
99102
99034
  * @remarks
99103
- * [Api set: PowerPointApi 1.3]
99035
+ * [Api set: PowerPointApi 1.4]
99104
99036
  */
99105
- readonly shapes: PowerPoint.ShapeCollection;
99037
+ star16 = "Star16",
99106
99038
  /**
99107
- * Gets the unique ID of the Slide Master.
99108
- *
99039
+ * Star: 24 Points
99109
99040
  * @remarks
99110
- * [Api set: PowerPointApi 1.3]
99041
+ * [Api set: PowerPointApi 1.4]
99111
99042
  */
99112
- readonly id: string;
99043
+ star24 = "Star24",
99113
99044
  /**
99114
- * Gets the unique name of the Slide Master.
99115
- *
99045
+ * Star: 32 Points
99116
99046
  * @remarks
99117
- * [Api set: PowerPointApi 1.3]
99047
+ * [Api set: PowerPointApi 1.4]
99118
99048
  */
99119
- readonly name: string;
99049
+ star32 = "Star32",
99120
99050
  /**
99121
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99122
- *
99123
- * @param options Provides options for which properties of the object to load.
99051
+ * Rectangle: Rounded Corners
99052
+ * @remarks
99053
+ * [Api set: PowerPointApi 1.4]
99124
99054
  */
99125
- load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
99055
+ roundRectangle = "RoundRectangle",
99126
99056
  /**
99127
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99128
- *
99129
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
99057
+ * Rectangle: Single Corner Rounded
99058
+ * @remarks
99059
+ * [Api set: PowerPointApi 1.4]
99130
99060
  */
99131
- load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
99061
+ round1Rectangle = "Round1Rectangle",
99132
99062
  /**
99133
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99134
- *
99135
- * @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.
99063
+ * Rectangle: Top Corners Rounded
99064
+ * @remarks
99065
+ * [Api set: PowerPointApi 1.4]
99136
99066
  */
99137
- load(propertyNamesAndPaths?: {
99138
- select?: string;
99139
- expand?: string;
99140
- }): PowerPoint.SlideMaster;
99141
- /**
99142
- * 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.)
99143
- * Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
99144
- */
99145
- toJSON(): PowerPoint.Interfaces.SlideMasterData;
99146
- }
99147
- /**
99148
- * Represents a single tag in the slide.
99149
- *
99150
- * @remarks
99151
- * [Api set: PowerPointApi 1.3]
99152
- */
99153
- class Tag extends OfficeExtension.ClientObject {
99154
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99155
- context: RequestContext;
99067
+ round2SameRectangle = "Round2SameRectangle",
99156
99068
  /**
99157
- * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
99158
- *
99069
+ * Rectangle: Diagonal Corners Rounded
99159
99070
  * @remarks
99160
- * [Api set: PowerPointApi 1.3]
99071
+ * [Api set: PowerPointApi 1.4]
99161
99072
  */
99162
- readonly key: string;
99073
+ round2DiagonalRectangle = "Round2DiagonalRectangle",
99163
99074
  /**
99164
- * Gets the value of the tag.
99165
- *
99075
+ * Rectangle: Top Corners One Rounded and One Snipped
99166
99076
  * @remarks
99167
- * [Api set: PowerPointApi 1.3]
99077
+ * [Api set: PowerPointApi 1.4]
99168
99078
  */
99169
- value: string;
99079
+ snipRoundRectangle = "SnipRoundRectangle",
99170
99080
  /**
99171
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99172
- *
99173
- * @param options Provides options for which properties of the object to load.
99081
+ * Rectangle: Single Corner Snipped
99082
+ * @remarks
99083
+ * [Api set: PowerPointApi 1.4]
99174
99084
  */
99175
- load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;
99085
+ snip1Rectangle = "Snip1Rectangle",
99176
99086
  /**
99177
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99178
- *
99179
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
99087
+ * Rectangle: Top Corners Snipped
99088
+ * @remarks
99089
+ * [Api set: PowerPointApi 1.4]
99180
99090
  */
99181
- load(propertyNames?: string | string[]): PowerPoint.Tag;
99091
+ snip2SameRectangle = "Snip2SameRectangle",
99182
99092
  /**
99183
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99184
- *
99185
- * @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.
99093
+ * Rectangle: Diagonal Corners Snipped
99094
+ * @remarks
99095
+ * [Api set: PowerPointApi 1.4]
99186
99096
  */
99187
- load(propertyNamesAndPaths?: {
99188
- select?: string;
99189
- expand?: string;
99190
- }): PowerPoint.Tag;
99191
- /**
99192
- * 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.)
99193
- * Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
99194
- */
99195
- toJSON(): PowerPoint.Interfaces.TagData;
99196
- }
99197
- /**
99198
- * Represents the collection of tags.
99199
- *
99200
- * @remarks
99201
- * [Api set: PowerPointApi 1.3]
99202
- */
99203
- class TagCollection extends OfficeExtension.ClientObject {
99204
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99205
- context: RequestContext;
99206
- /** Gets the loaded child items in this collection. */
99207
- readonly items: PowerPoint.Tag[];
99097
+ snip2DiagonalRectangle = "Snip2DiagonalRectangle",
99208
99098
  /**
99209
- * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
99210
- *
99099
+ * Plaque
99211
99100
  * @remarks
99212
- * [Api set: PowerPointApi 1.3]
99213
- *
99214
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
99215
- * @param value The value of the tag.
99101
+ * [Api set: PowerPointApi 1.4]
99216
99102
  */
99217
- add(key: string, value: string): void;
99103
+ plaque = "Plaque",
99218
99104
  /**
99219
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
99220
- *
99105
+ * Oval
99221
99106
  * @remarks
99222
- * [Api set: PowerPointApi 1.3]
99223
- *
99224
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
99107
+ * [Api set: PowerPointApi 1.4]
99225
99108
  */
99226
- delete(key: string): void;
99109
+ ellipse = "Ellipse",
99227
99110
  /**
99228
- * Gets the number of tags in the collection.
99229
- *
99111
+ * Teardrop
99230
99112
  * @remarks
99231
- * [Api set: PowerPointApi 1.3]
99232
- * @returns The number of tags in the collection.
99113
+ * [Api set: PowerPointApi 1.4]
99233
99114
  */
99234
- getCount(): OfficeExtension.ClientResult<number>;
99115
+ teardrop = "Teardrop",
99235
99116
  /**
99236
- * Gets a tag using its unique ID. An error is thrown if the tag does not exist.
99237
- *
99117
+ * Arrow: Pentagon
99238
99118
  * @remarks
99239
- * [Api set: PowerPointApi 1.3]
99240
- *
99241
- * @param key The ID of the tag.
99242
- * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
99119
+ * [Api set: PowerPointApi 1.4]
99243
99120
  */
99244
- getItem(key: string): PowerPoint.Tag;
99121
+ homePlate = "HomePlate",
99245
99122
  /**
99246
- * Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.
99247
- *
99123
+ * Arrow: Chevron
99248
99124
  * @remarks
99249
- * [Api set: PowerPointApi 1.3]
99250
- *
99251
- * @param index The index of the tag in the collection.
99252
- * @returns The tag at the given index. An error is thrown if index is out of range.
99125
+ * [Api set: PowerPointApi 1.4]
99253
99126
  */
99254
- getItemAt(index: number): PowerPoint.Tag;
99127
+ chevron = "Chevron",
99255
99128
  /**
99256
- * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
99257
- *
99129
+ * Partial Circle
99258
99130
  * @remarks
99259
- * [Api set: PowerPointApi 1.3]
99260
- *
99261
- * @param key The ID of the tag.
99262
- * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
99131
+ * [Api set: PowerPointApi 1.4]
99263
99132
  */
99264
- getItemOrNullObject(key: string): PowerPoint.Tag;
99133
+ pieWedge = "PieWedge",
99265
99134
  /**
99266
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99267
- *
99268
- * @param options Provides options for which properties of the object to load.
99135
+ * Partial Circle with Adjustable Spanning Area
99136
+ * @remarks
99137
+ * [Api set: PowerPointApi 1.4]
99269
99138
  */
99270
- load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
99139
+ pie = "Pie",
99271
99140
  /**
99272
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99273
- *
99274
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
99141
+ * Block Arc
99142
+ * @remarks
99143
+ * [Api set: PowerPointApi 1.4]
99275
99144
  */
99276
- load(propertyNames?: string | string[]): PowerPoint.TagCollection;
99145
+ blockArc = "BlockArc",
99277
99146
  /**
99278
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99279
- *
99280
- * @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.
99147
+ * Circle: Hollow
99148
+ * @remarks
99149
+ * [Api set: PowerPointApi 1.4]
99281
99150
  */
99282
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
99283
- /**
99284
- * 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.)
99285
- * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
99286
- */
99287
- toJSON(): PowerPoint.Interfaces.TagCollectionData;
99288
- }
99289
- /**
99290
- * Represents a single slide of a presentation.
99291
- *
99292
- * @remarks
99293
- * [Api set: PowerPointApi 1.2]
99294
- */
99295
- class Slide extends OfficeExtension.ClientObject {
99296
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99297
- context: RequestContext;
99151
+ donut = "Donut",
99298
99152
  /**
99299
- * Gets the layout of the slide.
99300
- *
99153
+ * "Not Allowed" Symbol
99301
99154
  * @remarks
99302
- * [Api set: PowerPointApi 1.3]
99155
+ * [Api set: PowerPointApi 1.4]
99303
99156
  */
99304
- readonly layout: PowerPoint.SlideLayout;
99157
+ noSmoking = "NoSmoking",
99305
99158
  /**
99306
- * Returns a collection of shapes in the slide.
99307
- *
99159
+ * Arrow: Right
99308
99160
  * @remarks
99309
- * [Api set: PowerPointApi 1.3]
99161
+ * [Api set: PowerPointApi 1.4]
99310
99162
  */
99311
- readonly shapes: PowerPoint.ShapeCollection;
99163
+ rightArrow = "RightArrow",
99312
99164
  /**
99313
- * Gets the `SlideMaster` object that represents the slide's default content.
99314
- *
99165
+ * Arrow: Left
99315
99166
  * @remarks
99316
- * [Api set: PowerPointApi 1.3]
99167
+ * [Api set: PowerPointApi 1.4]
99317
99168
  */
99318
- readonly slideMaster: PowerPoint.SlideMaster;
99169
+ leftArrow = "LeftArrow",
99319
99170
  /**
99320
- * Returns a collection of tags in the slide.
99321
- *
99171
+ * Arrow: Up
99322
99172
  * @remarks
99323
- * [Api set: PowerPointApi 1.3]
99173
+ * [Api set: PowerPointApi 1.4]
99324
99174
  */
99325
- readonly tags: PowerPoint.TagCollection;
99175
+ upArrow = "UpArrow",
99326
99176
  /**
99327
- * Gets the unique ID of the slide.
99328
- *
99177
+ * Arrow: Down
99329
99178
  * @remarks
99330
- * [Api set: PowerPointApi 1.2]
99179
+ * [Api set: PowerPointApi 1.4]
99331
99180
  */
99332
- readonly id: string;
99181
+ downArrow = "DownArrow",
99333
99182
  /**
99334
- * Deletes the slide from the presentation. Does nothing if the slide does not exist.
99335
- *
99183
+ * Arrow: Striped Right
99336
99184
  * @remarks
99337
- * [Api set: PowerPointApi 1.2]
99185
+ * [Api set: PowerPointApi 1.4]
99338
99186
  */
99339
- delete(): void;
99187
+ stripedRightArrow = "StripedRightArrow",
99340
99188
  /**
99341
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99342
- *
99343
- * @param options Provides options for which properties of the object to load.
99189
+ * Arrow: Notched Right
99190
+ * @remarks
99191
+ * [Api set: PowerPointApi 1.4]
99344
99192
  */
99345
- load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
99193
+ notchedRightArrow = "NotchedRightArrow",
99346
99194
  /**
99347
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99348
- *
99349
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
99195
+ * Arrow: Bent-Up
99196
+ * @remarks
99197
+ * [Api set: PowerPointApi 1.4]
99350
99198
  */
99351
- load(propertyNames?: string | string[]): PowerPoint.Slide;
99199
+ bentUpArrow = "BentUpArrow",
99352
99200
  /**
99353
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
99354
- *
99355
- * @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.
99201
+ * Arrow: Left-Right
99202
+ * @remarks
99203
+ * [Api set: PowerPointApi 1.4]
99356
99204
  */
99357
- load(propertyNamesAndPaths?: {
99358
- select?: string;
99359
- expand?: string;
99360
- }): PowerPoint.Slide;
99361
- /**
99362
- * 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.)
99363
- * Whereas the original PowerPoint.Slide object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
99364
- */
99365
- toJSON(): PowerPoint.Interfaces.SlideData;
99366
- }
99367
- /**
99368
- * Represents a single shape in the slide.
99369
- *
99370
- * @remarks
99371
- * [Api set: PowerPointApi 1.3]
99372
- */
99373
- class Shape extends OfficeExtension.ClientObject {
99374
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
99375
- context: RequestContext;
99205
+ leftRightArrow = "LeftRightArrow",
99376
99206
  /**
99377
- * Returns a collection of tags in the shape.
99378
- *
99207
+ * Arrow: Up-Down
99379
99208
  * @remarks
99380
- * [Api set: PowerPointApi 1.3]
99209
+ * [Api set: PowerPointApi 1.4]
99381
99210
  */
99382
- readonly tags: PowerPoint.TagCollection;
99211
+ upDownArrow = "UpDownArrow",
99383
99212
  /**
99384
- * Gets the unique ID of the shape.
99385
- *
99213
+ * Arrow: Left-Up
99386
99214
  * @remarks
99387
- * [Api set: PowerPointApi 1.3]
99215
+ * [Api set: PowerPointApi 1.4]
99388
99216
  */
99389
- readonly id: string;
99217
+ leftUpArrow = "LeftUpArrow",
99390
99218
  /**
99391
- * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
99392
- *
99219
+ * Arrow: Left-Right-Up
99220
+ * @remarks
99221
+ * [Api set: PowerPointApi 1.4]
99222
+ */
99223
+ leftRightUpArrow = "LeftRightUpArrow",
99224
+ /**
99225
+ * Arrow: Quad
99226
+ * @remarks
99227
+ * [Api set: PowerPointApi 1.4]
99228
+ */
99229
+ quadArrow = "QuadArrow",
99230
+ /**
99231
+ * Callout: Left Arrow
99232
+ * @remarks
99233
+ * [Api set: PowerPointApi 1.4]
99234
+ */
99235
+ leftArrowCallout = "LeftArrowCallout",
99236
+ /**
99237
+ * Callout: Right Arrow
99238
+ * @remarks
99239
+ * [Api set: PowerPointApi 1.4]
99240
+ */
99241
+ rightArrowCallout = "RightArrowCallout",
99242
+ /**
99243
+ * Callout: Up Arrow
99244
+ * @remarks
99245
+ * [Api set: PowerPointApi 1.4]
99246
+ */
99247
+ upArrowCallout = "UpArrowCallout",
99248
+ /**
99249
+ * Callout: Down Arrow
99250
+ * @remarks
99251
+ * [Api set: PowerPointApi 1.4]
99252
+ */
99253
+ downArrowCallout = "DownArrowCallout",
99254
+ /**
99255
+ * Callout: Left-Right Arrow
99256
+ * @remarks
99257
+ * [Api set: PowerPointApi 1.4]
99258
+ */
99259
+ leftRightArrowCallout = "LeftRightArrowCallout",
99260
+ /**
99261
+ * Callout: Up-Down Arrow
99262
+ * @remarks
99263
+ * [Api set: PowerPointApi 1.4]
99264
+ */
99265
+ upDownArrowCallout = "UpDownArrowCallout",
99266
+ /**
99267
+ * Callout: Quad Arrow
99268
+ * @remarks
99269
+ * [Api set: PowerPointApi 1.4]
99270
+ */
99271
+ quadArrowCallout = "QuadArrowCallout",
99272
+ /**
99273
+ * Arrow: Bent
99274
+ * @remarks
99275
+ * [Api set: PowerPointApi 1.4]
99276
+ */
99277
+ bentArrow = "BentArrow",
99278
+ /**
99279
+ * Arrow: U-Turn
99280
+ * @remarks
99281
+ * [Api set: PowerPointApi 1.4]
99282
+ */
99283
+ uturnArrow = "UturnArrow",
99284
+ /**
99285
+ * Arrow: Circular
99286
+ * @remarks
99287
+ * [Api set: PowerPointApi 1.4]
99288
+ */
99289
+ circularArrow = "CircularArrow",
99290
+ /**
99291
+ * Arrow: Circular with Opposite Arrow Direction
99292
+ * @remarks
99293
+ * [Api set: PowerPointApi 1.4]
99294
+ */
99295
+ leftCircularArrow = "LeftCircularArrow",
99296
+ /**
99297
+ * Arrow: Circular with Two Arrows in Both Directions
99298
+ * @remarks
99299
+ * [Api set: PowerPointApi 1.4]
99300
+ */
99301
+ leftRightCircularArrow = "LeftRightCircularArrow",
99302
+ /**
99303
+ * Arrow: Curved Right
99304
+ * @remarks
99305
+ * [Api set: PowerPointApi 1.4]
99306
+ */
99307
+ curvedRightArrow = "CurvedRightArrow",
99308
+ /**
99309
+ * Arrow: Curved Left
99310
+ * @remarks
99311
+ * [Api set: PowerPointApi 1.4]
99312
+ */
99313
+ curvedLeftArrow = "CurvedLeftArrow",
99314
+ /**
99315
+ * Arrow: Curved Up
99316
+ * @remarks
99317
+ * [Api set: PowerPointApi 1.4]
99318
+ */
99319
+ curvedUpArrow = "CurvedUpArrow",
99320
+ /**
99321
+ * Arrow: Curved Down
99322
+ * @remarks
99323
+ * [Api set: PowerPointApi 1.4]
99324
+ */
99325
+ curvedDownArrow = "CurvedDownArrow",
99326
+ /**
99327
+ * Arrow: Curved Right Arrow with Varying Width
99328
+ * @remarks
99329
+ * [Api set: PowerPointApi 1.4]
99330
+ */
99331
+ swooshArrow = "SwooshArrow",
99332
+ /**
99333
+ * Cube
99334
+ * @remarks
99335
+ * [Api set: PowerPointApi 1.4]
99336
+ */
99337
+ cube = "Cube",
99338
+ /**
99339
+ * Cylinder
99340
+ * @remarks
99341
+ * [Api set: PowerPointApi 1.4]
99342
+ */
99343
+ can = "Can",
99344
+ /**
99345
+ * Lightning Bolt
99346
+ * @remarks
99347
+ * [Api set: PowerPointApi 1.4]
99348
+ */
99349
+ lightningBolt = "LightningBolt",
99350
+ /**
99351
+ * Heart
99352
+ * @remarks
99353
+ * [Api set: PowerPointApi 1.4]
99354
+ */
99355
+ heart = "Heart",
99356
+ /**
99357
+ * Sun
99358
+ * @remarks
99359
+ * [Api set: PowerPointApi 1.4]
99360
+ */
99361
+ sun = "Sun",
99362
+ /**
99363
+ * Moon
99364
+ * @remarks
99365
+ * [Api set: PowerPointApi 1.4]
99366
+ */
99367
+ moon = "Moon",
99368
+ /**
99369
+ * Smiley Face
99370
+ * @remarks
99371
+ * [Api set: PowerPointApi 1.4]
99372
+ */
99373
+ smileyFace = "SmileyFace",
99374
+ /**
99375
+ * Explosion: 8 Points
99376
+ * @remarks
99377
+ * [Api set: PowerPointApi 1.4]
99378
+ */
99379
+ irregularSeal1 = "IrregularSeal1",
99380
+ /**
99381
+ * Explosion: 14 Points
99382
+ * @remarks
99383
+ * [Api set: PowerPointApi 1.4]
99384
+ */
99385
+ irregularSeal2 = "IrregularSeal2",
99386
+ /**
99387
+ * Rectangle: Folded Corner
99388
+ * @remarks
99389
+ * [Api set: PowerPointApi 1.4]
99390
+ */
99391
+ foldedCorner = "FoldedCorner",
99392
+ /**
99393
+ * Rectangle: Beveled
99394
+ * @remarks
99395
+ * [Api set: PowerPointApi 1.4]
99396
+ */
99397
+ bevel = "Bevel",
99398
+ /**
99399
+ * Frame
99400
+ * @remarks
99401
+ * [Api set: PowerPointApi 1.4]
99402
+ */
99403
+ frame = "Frame",
99404
+ /**
99405
+ * Half Frame
99406
+ * @remarks
99407
+ * [Api set: PowerPointApi 1.4]
99408
+ */
99409
+ halfFrame = "HalfFrame",
99410
+ /**
99411
+ * L-Shape
99412
+ * @remarks
99413
+ * [Api set: PowerPointApi 1.4]
99414
+ */
99415
+ corner = "Corner",
99416
+ /**
99417
+ * Diagonal Stripe
99418
+ * @remarks
99419
+ * [Api set: PowerPointApi 1.4]
99420
+ */
99421
+ diagonalStripe = "DiagonalStripe",
99422
+ /**
99423
+ * Chord
99424
+ * @remarks
99425
+ * [Api set: PowerPointApi 1.4]
99426
+ */
99427
+ chord = "Chord",
99428
+ /**
99429
+ * Arc
99430
+ * @remarks
99431
+ * [Api set: PowerPointApi 1.4]
99432
+ */
99433
+ arc = "Arc",
99434
+ /**
99435
+ * Left Bracket
99436
+ * @remarks
99437
+ * [Api set: PowerPointApi 1.4]
99438
+ */
99439
+ leftBracket = "LeftBracket",
99440
+ /**
99441
+ * Right Bracket
99442
+ * @remarks
99443
+ * [Api set: PowerPointApi 1.4]
99444
+ */
99445
+ rightBracket = "RightBracket",
99446
+ /**
99447
+ * Left Brace
99448
+ * @remarks
99449
+ * [Api set: PowerPointApi 1.4]
99450
+ */
99451
+ leftBrace = "LeftBrace",
99452
+ /**
99453
+ * Right Brace
99454
+ * @remarks
99455
+ * [Api set: PowerPointApi 1.4]
99456
+ */
99457
+ rightBrace = "RightBrace",
99458
+ /**
99459
+ * Double Bracket
99460
+ * @remarks
99461
+ * [Api set: PowerPointApi 1.4]
99462
+ */
99463
+ bracketPair = "BracketPair",
99464
+ /**
99465
+ * Double Brace
99466
+ * @remarks
99467
+ * [Api set: PowerPointApi 1.4]
99468
+ */
99469
+ bracePair = "BracePair",
99470
+ /**
99471
+ * Callout: Line with No Border
99472
+ * @remarks
99473
+ * [Api set: PowerPointApi 1.4]
99474
+ */
99475
+ callout1 = "Callout1",
99476
+ /**
99477
+ * Callout: Bent Line with No Border
99478
+ * @remarks
99479
+ * [Api set: PowerPointApi 1.4]
99480
+ */
99481
+ callout2 = "Callout2",
99482
+ /**
99483
+ * Callout: Double Bent Line with No Border
99484
+ * @remarks
99485
+ * [Api set: PowerPointApi 1.4]
99486
+ */
99487
+ callout3 = "Callout3",
99488
+ /**
99489
+ * Callout: Line with Accent Bar
99490
+ * @remarks
99491
+ * [Api set: PowerPointApi 1.4]
99492
+ */
99493
+ accentCallout1 = "AccentCallout1",
99494
+ /**
99495
+ * Callout: Bent Line with Accent Bar
99496
+ * @remarks
99497
+ * [Api set: PowerPointApi 1.4]
99498
+ */
99499
+ accentCallout2 = "AccentCallout2",
99500
+ /**
99501
+ * Callout: Double Bent Line with Accent Bar
99502
+ * @remarks
99503
+ * [Api set: PowerPointApi 1.4]
99504
+ */
99505
+ accentCallout3 = "AccentCallout3",
99506
+ /**
99507
+ * Callout: Line
99508
+ * @remarks
99509
+ * [Api set: PowerPointApi 1.4]
99510
+ */
99511
+ borderCallout1 = "BorderCallout1",
99512
+ /**
99513
+ * Callout: Bent Line
99514
+ * @remarks
99515
+ * [Api set: PowerPointApi 1.4]
99516
+ */
99517
+ borderCallout2 = "BorderCallout2",
99518
+ /**
99519
+ * Callout: Double Bent Line
99520
+ * @remarks
99521
+ * [Api set: PowerPointApi 1.4]
99522
+ */
99523
+ borderCallout3 = "BorderCallout3",
99524
+ /**
99525
+ * Callout: Line with Border and Accent Bar
99526
+ * @remarks
99527
+ * [Api set: PowerPointApi 1.4]
99528
+ */
99529
+ accentBorderCallout1 = "AccentBorderCallout1",
99530
+ /**
99531
+ * Callout: Bent Line with Border and Accent Bar
99532
+ * @remarks
99533
+ * [Api set: PowerPointApi 1.4]
99534
+ */
99535
+ accentBorderCallout2 = "AccentBorderCallout2",
99536
+ /**
99537
+ * Callout: Double Bent Line with Border and Accent Bar
99538
+ * @remarks
99539
+ * [Api set: PowerPointApi 1.4]
99540
+ */
99541
+ accentBorderCallout3 = "AccentBorderCallout3",
99542
+ /**
99543
+ * Speech Bubble: Rectangle
99544
+ * @remarks
99545
+ * [Api set: PowerPointApi 1.4]
99546
+ */
99547
+ wedgeRectCallout = "WedgeRectCallout",
99548
+ /**
99549
+ * Speech Bubble: Rectangle with Corners Rounded
99550
+ * @remarks
99551
+ * [Api set: PowerPointApi 1.4]
99552
+ */
99553
+ wedgeRRectCallout = "WedgeRRectCallout",
99554
+ /**
99555
+ * Speech Bubble: Oval
99556
+ * @remarks
99557
+ * [Api set: PowerPointApi 1.4]
99558
+ */
99559
+ wedgeEllipseCallout = "WedgeEllipseCallout",
99560
+ /**
99561
+ * Thought Bubble: Cloud
99562
+ * @remarks
99563
+ * [Api set: PowerPointApi 1.4]
99564
+ */
99565
+ cloudCallout = "CloudCallout",
99566
+ /**
99567
+ * Cloud
99568
+ * @remarks
99569
+ * [Api set: PowerPointApi 1.4]
99570
+ */
99571
+ cloud = "Cloud",
99572
+ /**
99573
+ * Ribbon: Tilted Down
99574
+ * @remarks
99575
+ * [Api set: PowerPointApi 1.4]
99576
+ */
99577
+ ribbon = "Ribbon",
99578
+ /**
99579
+ * Ribbon: Tilted Up
99580
+ * @remarks
99581
+ * [Api set: PowerPointApi 1.4]
99582
+ */
99583
+ ribbon2 = "Ribbon2",
99584
+ /**
99585
+ * Ribbon: Curved and Tilted Down
99586
+ * @remarks
99587
+ * [Api set: PowerPointApi 1.4]
99588
+ */
99589
+ ellipseRibbon = "EllipseRibbon",
99590
+ /**
99591
+ * Ribbon: Curved and Tilted Up
99592
+ * @remarks
99593
+ * [Api set: PowerPointApi 1.4]
99594
+ */
99595
+ ellipseRibbon2 = "EllipseRibbon2",
99596
+ /**
99597
+ * Ribbon: Straight with Both Left and Right Arrows
99598
+ * @remarks
99599
+ * [Api set: PowerPointApi 1.4]
99600
+ */
99601
+ leftRightRibbon = "LeftRightRibbon",
99602
+ /**
99603
+ * Scroll: Vertical
99604
+ * @remarks
99605
+ * [Api set: PowerPointApi 1.4]
99606
+ */
99607
+ verticalScroll = "VerticalScroll",
99608
+ /**
99609
+ * Scroll: Horizontal
99610
+ * @remarks
99611
+ * [Api set: PowerPointApi 1.4]
99612
+ */
99613
+ horizontalScroll = "HorizontalScroll",
99614
+ /**
99615
+ * Wave
99616
+ * @remarks
99617
+ * [Api set: PowerPointApi 1.4]
99618
+ */
99619
+ wave = "Wave",
99620
+ /**
99621
+ * Double Wave
99622
+ * @remarks
99623
+ * [Api set: PowerPointApi 1.4]
99624
+ */
99625
+ doubleWave = "DoubleWave",
99626
+ /**
99627
+ * Cross
99628
+ * @remarks
99629
+ * [Api set: PowerPointApi 1.4]
99630
+ */
99631
+ plus = "Plus",
99632
+ /**
99633
+ * Flowchart: Process
99634
+ * @remarks
99635
+ * [Api set: PowerPointApi 1.4]
99636
+ */
99637
+ flowChartProcess = "FlowChartProcess",
99638
+ /**
99639
+ * Flowchart: Decision
99640
+ * @remarks
99641
+ * [Api set: PowerPointApi 1.4]
99642
+ */
99643
+ flowChartDecision = "FlowChartDecision",
99644
+ /**
99645
+ * Flowchart: Data
99646
+ * @remarks
99647
+ * [Api set: PowerPointApi 1.4]
99648
+ */
99649
+ flowChartInputOutput = "FlowChartInputOutput",
99650
+ /**
99651
+ * Flowchart: Predefined Process
99652
+ * @remarks
99653
+ * [Api set: PowerPointApi 1.4]
99654
+ */
99655
+ flowChartPredefinedProcess = "FlowChartPredefinedProcess",
99656
+ /**
99657
+ * Flowchart: Internal Storage
99658
+ * @remarks
99659
+ * [Api set: PowerPointApi 1.4]
99660
+ */
99661
+ flowChartInternalStorage = "FlowChartInternalStorage",
99662
+ /**
99663
+ * Flowchart: Document
99664
+ * @remarks
99665
+ * [Api set: PowerPointApi 1.4]
99666
+ */
99667
+ flowChartDocument = "FlowChartDocument",
99668
+ /**
99669
+ * Flowchart: Multidocument
99670
+ * @remarks
99671
+ * [Api set: PowerPointApi 1.4]
99672
+ */
99673
+ flowChartMultidocument = "FlowChartMultidocument",
99674
+ /**
99675
+ * Flowchart: Terminator
99676
+ * @remarks
99677
+ * [Api set: PowerPointApi 1.4]
99678
+ */
99679
+ flowChartTerminator = "FlowChartTerminator",
99680
+ /**
99681
+ * Flowchart: Preparation
99682
+ * @remarks
99683
+ * [Api set: PowerPointApi 1.4]
99684
+ */
99685
+ flowChartPreparation = "FlowChartPreparation",
99686
+ /**
99687
+ * Flowchart: Manual Input
99688
+ * @remarks
99689
+ * [Api set: PowerPointApi 1.4]
99690
+ */
99691
+ flowChartManualInput = "FlowChartManualInput",
99692
+ /**
99693
+ * Flowchart: Manual Operation
99694
+ * @remarks
99695
+ * [Api set: PowerPointApi 1.4]
99696
+ */
99697
+ flowChartManualOperation = "FlowChartManualOperation",
99698
+ /**
99699
+ * Flowchart: Connector
99700
+ * @remarks
99701
+ * [Api set: PowerPointApi 1.4]
99702
+ */
99703
+ flowChartConnector = "FlowChartConnector",
99704
+ /**
99705
+ * Flowchart: Card
99706
+ * @remarks
99707
+ * [Api set: PowerPointApi 1.4]
99708
+ */
99709
+ flowChartPunchedCard = "FlowChartPunchedCard",
99710
+ /**
99711
+ * Flowchart: Punched Tape
99712
+ * @remarks
99713
+ * [Api set: PowerPointApi 1.4]
99714
+ */
99715
+ flowChartPunchedTape = "FlowChartPunchedTape",
99716
+ /**
99717
+ * Flowchart: Summing Junction
99718
+ * @remarks
99719
+ * [Api set: PowerPointApi 1.4]
99720
+ */
99721
+ flowChartSummingJunction = "FlowChartSummingJunction",
99722
+ /**
99723
+ * Flowchart: Or
99724
+ * @remarks
99725
+ * [Api set: PowerPointApi 1.4]
99726
+ */
99727
+ flowChartOr = "FlowChartOr",
99728
+ /**
99729
+ * Flowchart: Collate
99730
+ * @remarks
99731
+ * [Api set: PowerPointApi 1.4]
99732
+ */
99733
+ flowChartCollate = "FlowChartCollate",
99734
+ /**
99735
+ * Flowchart: Sort
99736
+ * @remarks
99737
+ * [Api set: PowerPointApi 1.4]
99738
+ */
99739
+ flowChartSort = "FlowChartSort",
99740
+ /**
99741
+ * Flowchart: Extract
99742
+ * @remarks
99743
+ * [Api set: PowerPointApi 1.4]
99744
+ */
99745
+ flowChartExtract = "FlowChartExtract",
99746
+ /**
99747
+ * Flowchart: Merge
99748
+ * @remarks
99749
+ * [Api set: PowerPointApi 1.4]
99750
+ */
99751
+ flowChartMerge = "FlowChartMerge",
99752
+ /**
99753
+ * FlowChart: Offline Storage
99754
+ * @remarks
99755
+ * [Api set: PowerPointApi 1.4]
99756
+ */
99757
+ flowChartOfflineStorage = "FlowChartOfflineStorage",
99758
+ /**
99759
+ * Flowchart: Stored Data
99760
+ * @remarks
99761
+ * [Api set: PowerPointApi 1.4]
99762
+ */
99763
+ flowChartOnlineStorage = "FlowChartOnlineStorage",
99764
+ /**
99765
+ * Flowchart: Sequential Access Storage
99766
+ * @remarks
99767
+ * [Api set: PowerPointApi 1.4]
99768
+ */
99769
+ flowChartMagneticTape = "FlowChartMagneticTape",
99770
+ /**
99771
+ * Flowchart: Magnetic Disk
99772
+ * @remarks
99773
+ * [Api set: PowerPointApi 1.4]
99774
+ */
99775
+ flowChartMagneticDisk = "FlowChartMagneticDisk",
99776
+ /**
99777
+ * Flowchart: Direct Access Storage
99778
+ * @remarks
99779
+ * [Api set: PowerPointApi 1.4]
99780
+ */
99781
+ flowChartMagneticDrum = "FlowChartMagneticDrum",
99782
+ /**
99783
+ * Flowchart: Display
99784
+ * @remarks
99785
+ * [Api set: PowerPointApi 1.4]
99786
+ */
99787
+ flowChartDisplay = "FlowChartDisplay",
99788
+ /**
99789
+ * Flowchart: Delay
99790
+ * @remarks
99791
+ * [Api set: PowerPointApi 1.4]
99792
+ */
99793
+ flowChartDelay = "FlowChartDelay",
99794
+ /**
99795
+ * Flowchart: Alternate Process
99796
+ * @remarks
99797
+ * [Api set: PowerPointApi 1.4]
99798
+ */
99799
+ flowChartAlternateProcess = "FlowChartAlternateProcess",
99800
+ /**
99801
+ * Flowchart: Off-page Connector
99802
+ * @remarks
99803
+ * [Api set: PowerPointApi 1.4]
99804
+ */
99805
+ flowChartOffpageConnector = "FlowChartOffpageConnector",
99806
+ /**
99807
+ * Action Button: Blank
99808
+ * @remarks
99809
+ * [Api set: PowerPointApi 1.4]
99810
+ */
99811
+ actionButtonBlank = "ActionButtonBlank",
99812
+ /**
99813
+ * Action Button: Go Home
99814
+ * @remarks
99815
+ * [Api set: PowerPointApi 1.4]
99816
+ */
99817
+ actionButtonHome = "ActionButtonHome",
99818
+ /**
99819
+ * Action Button: Help
99820
+ * @remarks
99821
+ * [Api set: PowerPointApi 1.4]
99822
+ */
99823
+ actionButtonHelp = "ActionButtonHelp",
99824
+ /**
99825
+ * Action Button: Get Information
99826
+ * @remarks
99827
+ * [Api set: PowerPointApi 1.4]
99828
+ */
99829
+ actionButtonInformation = "ActionButtonInformation",
99830
+ /**
99831
+ * Action Button: Go Forward or Next
99832
+ * @remarks
99833
+ * [Api set: PowerPointApi 1.4]
99834
+ */
99835
+ actionButtonForwardNext = "ActionButtonForwardNext",
99836
+ /**
99837
+ * Action Button: Go Back or Previous
99838
+ * @remarks
99839
+ * [Api set: PowerPointApi 1.4]
99840
+ */
99841
+ actionButtonBackPrevious = "ActionButtonBackPrevious",
99842
+ /**
99843
+ * Action Button: Go to End
99844
+ * @remarks
99845
+ * [Api set: PowerPointApi 1.4]
99846
+ */
99847
+ actionButtonEnd = "ActionButtonEnd",
99848
+ /**
99849
+ * Action Button: Go to Beginning
99850
+ * @remarks
99851
+ * [Api set: PowerPointApi 1.4]
99852
+ */
99853
+ actionButtonBeginning = "ActionButtonBeginning",
99854
+ /**
99855
+ * Action Button: Return
99856
+ * @remarks
99857
+ * [Api set: PowerPointApi 1.4]
99858
+ */
99859
+ actionButtonReturn = "ActionButtonReturn",
99860
+ /**
99861
+ * Action Button: Document
99862
+ * @remarks
99863
+ * [Api set: PowerPointApi 1.4]
99864
+ */
99865
+ actionButtonDocument = "ActionButtonDocument",
99866
+ /**
99867
+ * Action Button: Sound
99868
+ * @remarks
99869
+ * [Api set: PowerPointApi 1.4]
99870
+ */
99871
+ actionButtonSound = "ActionButtonSound",
99872
+ /**
99873
+ * Action Button: Video
99874
+ * @remarks
99875
+ * [Api set: PowerPointApi 1.4]
99876
+ */
99877
+ actionButtonMovie = "ActionButtonMovie",
99878
+ /**
99879
+ * Gear: A Gear with Six Teeth
99880
+ * @remarks
99881
+ * [Api set: PowerPointApi 1.4]
99882
+ */
99883
+ gear6 = "Gear6",
99884
+ /**
99885
+ * Gear: A Gear with Nine Teeth
99886
+ * @remarks
99887
+ * [Api set: PowerPointApi 1.4]
99888
+ */
99889
+ gear9 = "Gear9",
99890
+ /**
99891
+ * Funnel
99892
+ * @remarks
99893
+ * [Api set: PowerPointApi 1.4]
99894
+ */
99895
+ funnel = "Funnel",
99896
+ /**
99897
+ * Plus Sign
99898
+ * @remarks
99899
+ * [Api set: PowerPointApi 1.4]
99900
+ */
99901
+ mathPlus = "MathPlus",
99902
+ /**
99903
+ * Minus Sign
99904
+ * @remarks
99905
+ * [Api set: PowerPointApi 1.4]
99906
+ */
99907
+ mathMinus = "MathMinus",
99908
+ /**
99909
+ * Multiplication Sign
99910
+ * @remarks
99911
+ * [Api set: PowerPointApi 1.4]
99912
+ */
99913
+ mathMultiply = "MathMultiply",
99914
+ /**
99915
+ * Division Sign
99916
+ * @remarks
99917
+ * [Api set: PowerPointApi 1.4]
99918
+ */
99919
+ mathDivide = "MathDivide",
99920
+ /**
99921
+ * Equals
99922
+ * @remarks
99923
+ * [Api set: PowerPointApi 1.4]
99924
+ */
99925
+ mathEqual = "MathEqual",
99926
+ /**
99927
+ * Not Equal
99928
+ * @remarks
99929
+ * [Api set: PowerPointApi 1.4]
99930
+ */
99931
+ mathNotEqual = "MathNotEqual",
99932
+ /**
99933
+ * Four Right Triangles that Define a Rectangular Shape
99934
+ * @remarks
99935
+ * [Api set: PowerPointApi 1.4]
99936
+ */
99937
+ cornerTabs = "CornerTabs",
99938
+ /**
99939
+ * Four Small Squares that Define a Rectangular Shape.
99940
+ * @remarks
99941
+ * [Api set: PowerPointApi 1.4]
99942
+ */
99943
+ squareTabs = "SquareTabs",
99944
+ /**
99945
+ * Four Quarter Circles that Define a Rectangular Shape.
99946
+ * @remarks
99947
+ * [Api set: PowerPointApi 1.4]
99948
+ */
99949
+ plaqueTabs = "PlaqueTabs",
99950
+ /**
99951
+ * A Rectangle Divided into Four Parts Along Diagonal Lines.
99952
+ * @remarks
99953
+ * [Api set: PowerPointApi 1.4]
99954
+ */
99955
+ chartX = "ChartX",
99956
+ /**
99957
+ * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines.
99958
+ * @remarks
99959
+ * [Api set: PowerPointApi 1.4]
99960
+ */
99961
+ chartStar = "ChartStar",
99962
+ /**
99963
+ * A Rectangle Divided Vertically and Horizontally into Four Quarters.
99964
+ * @remarks
99965
+ * [Api set: PowerPointApi 1.4]
99966
+ */
99967
+ chartPlus = "ChartPlus",
99968
+ }
99969
+ /**
99970
+ * Specifies the formatting options for when slides are inserted.
99971
+ *
99972
+ * @remarks
99973
+ * [Api set: PowerPointApi 1.2]
99974
+ */
99975
+ enum InsertSlideFormatting {
99976
+ /**
99977
+ * Copy the source theme into the target presentation and use that theme.
99978
+ * @remarks
99979
+ * [Api set: PowerPointApi 1.2]
99980
+ */
99981
+ keepSourceFormatting = "KeepSourceFormatting",
99982
+ /**
99983
+ * Use the existing theme in the target presentation.
99984
+ * @remarks
99985
+ * [Api set: PowerPointApi 1.2]
99986
+ */
99987
+ useDestinationTheme = "UseDestinationTheme",
99988
+ }
99989
+ /**
99990
+ * Represents the available options when inserting slides.
99991
+ *
99992
+ * @remarks
99993
+ * [Api set: PowerPointApi 1.2]
99994
+ */
99995
+ interface InsertSlideOptions {
99996
+ /**
99997
+ * Specifies which formatting to use during slide insertion.
99998
+ The default option is to use "KeepSourceFormatting".
99999
+ *
100000
+ * @remarks
100001
+ * [Api set: PowerPointApi 1.2]
100002
+ */
100003
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
100004
+ /**
100005
+ * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
100006
+ The order of these slides is preserved during the insertion.
100007
+ If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
100008
+ All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
100009
+ *
100010
+ * @remarks
100011
+ * [Api set: PowerPointApi 1.2]
100012
+ */
100013
+ sourceSlideIds?: string[];
100014
+ /**
100015
+ * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
100016
+ If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
100017
+ If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
100018
+ *
100019
+ * @remarks
100020
+ * [Api set: PowerPointApi 1.2]
100021
+ */
100022
+ targetSlideId?: string;
100023
+ }
100024
+ /**
100025
+ * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
100026
+ *
100027
+ * @remarks
100028
+ * [Api set: PowerPointApi 1.4]
100029
+ */
100030
+ enum ParagraphHorizontalAlignment {
100031
+ /**
100032
+ * Align text to the left margin.
100033
+ * @remarks
100034
+ * [Api set: PowerPointApi 1.4]
100035
+ */
100036
+ left = "Left",
100037
+ /**
100038
+ * Align text in the center.
100039
+ * @remarks
100040
+ * [Api set: PowerPointApi 1.4]
100041
+ */
100042
+ center = "Center",
100043
+ /**
100044
+ * Align text to the right margin.
100045
+ * @remarks
100046
+ * [Api set: PowerPointApi 1.4]
100047
+ */
100048
+ right = "Right",
100049
+ /**
100050
+ * Align text so that it is justified across the whole line.
100051
+ * @remarks
100052
+ * [Api set: PowerPointApi 1.4]
100053
+ */
100054
+ justify = "Justify",
100055
+ /**
100056
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
100057
+ * @remarks
100058
+ * [Api set: PowerPointApi 1.4]
100059
+ */
100060
+ justifyLow = "JustifyLow",
100061
+ /**
100062
+ * Distributes the text words across an entire text line.
100063
+ * @remarks
100064
+ * [Api set: PowerPointApi 1.4]
100065
+ */
100066
+ distributed = "Distributed",
100067
+ /**
100068
+ * Distributes Thai text specially, because each character is treated as a word.
100069
+ * @remarks
100070
+ * [Api set: PowerPointApi 1.4]
100071
+ */
100072
+ thaiDistributed = "ThaiDistributed",
100073
+ }
100074
+ /**
100075
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
100076
+ *
100077
+ * @remarks
100078
+ * [Api set: PowerPointApi 1.4]
100079
+ */
100080
+ class ParagraphFormat extends OfficeExtension.ClientObject {
100081
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100082
+ context: RequestContext;
100083
+ /**
100084
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
100085
+ *
100086
+ * @remarks
100087
+ * [Api set: PowerPointApi 1.4]
100088
+ */
100089
+ readonly bulletFormat: PowerPoint.BulletFormat;
100090
+ /**
100091
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
100092
+ *
100093
+ * @remarks
100094
+ * [Api set: PowerPointApi 1.4]
100095
+ */
100096
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
100097
+ /**
100098
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100099
+ *
100100
+ * @param options Provides options for which properties of the object to load.
100101
+ */
100102
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
100103
+ /**
100104
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100105
+ *
100106
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100107
+ */
100108
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
100109
+ /**
100110
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100111
+ *
100112
+ * @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.
100113
+ */
100114
+ load(propertyNamesAndPaths?: {
100115
+ select?: string;
100116
+ expand?: string;
100117
+ }): PowerPoint.ParagraphFormat;
100118
+ /**
100119
+ * 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.)
100120
+ * Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
100121
+ */
100122
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
100123
+ }
100124
+ /**
100125
+ * Represents the available options when adding shapes.
100126
+ *
100127
+ * @remarks
100128
+ * [Api set: PowerPointApi 1.4]
100129
+ */
100130
+ interface ShapeAddOptions {
100131
+ /**
100132
+ * Specifies the height, in points, of the shape.
100133
+ When not provided, a default value will be used.
100134
+ Throws an `InvalidArgument` exception when set with a negative value.
100135
+ *
100136
+ * @remarks
100137
+ * [Api set: PowerPointApi 1.4]
100138
+ */
100139
+ height?: number;
100140
+ /**
100141
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
100142
+ When not provided, a default value will be used.
100143
+ *
100144
+ * @remarks
100145
+ * [Api set: PowerPointApi 1.4]
100146
+ */
100147
+ left?: number;
100148
+ /**
100149
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
100150
+ When not provided, a default value will be used.
100151
+ *
100152
+ * @remarks
100153
+ * [Api set: PowerPointApi 1.4]
100154
+ */
100155
+ top?: number;
100156
+ /**
100157
+ * Specifies the width, in points, of the shape.
100158
+ When not provided, a default value will be used.
100159
+ Throws an `InvalidArgument` exception when set with a negative value.
100160
+ *
100161
+ * @remarks
100162
+ * [Api set: PowerPointApi 1.4]
100163
+ */
100164
+ width?: number;
100165
+ }
100166
+ /**
100167
+ * Represents the collection of shapes.
100168
+ *
100169
+ * @remarks
100170
+ * [Api set: PowerPointApi 1.3]
100171
+ */
100172
+ class ShapeCollection extends OfficeExtension.ClientObject {
100173
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100174
+ context: RequestContext;
100175
+ /** Gets the loaded child items in this collection. */
100176
+ readonly items: PowerPoint.Shape[];
100177
+ /**
100178
+ * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
100179
+ *
100180
+ * @remarks
100181
+ * [Api set: PowerPointApi 1.4]
100182
+ *
100183
+ * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
100184
+ * @param options An optional parameter to specify the additional options such as the position of the shape.
100185
+ * @returns The newly inserted shape.
100186
+ */
100187
+ addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
100188
+ /**
100189
+ * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
100190
+ *
100191
+ * @remarks
100192
+ * [Api set: PowerPointApi 1.4]
100193
+ *
100194
+ * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
100195
+ * @param options An optional parameter to specify the additional options such as the position of the shape.
100196
+ * @returns The newly inserted shape.
100197
+ */
100198
+ addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
100199
+ /**
100200
+ * Adds a line to the slide. Returns a `Shape` object that represents the new line.
100201
+ *
100202
+ * @remarks
100203
+ * [Api set: PowerPointApi 1.4]
100204
+ *
100205
+ * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
100206
+ * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
100207
+ * @returns The newly inserted shape.
100208
+ */
100209
+ addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
100210
+ /**
100211
+ * Adds a line to the slide. Returns a `Shape` object that represents the new line.
100212
+ *
100213
+ * @remarks
100214
+ * [Api set: PowerPointApi 1.4]
100215
+ *
100216
+ * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
100217
+ * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
100218
+ * @returns The newly inserted shape.
100219
+ */
100220
+ addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
100221
+ /**
100222
+ * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
100223
+ *
100224
+ * @remarks
100225
+ * [Api set: PowerPointApi 1.4]
100226
+ *
100227
+ * @param text Specifies the text that will be shown in the created text box.
100228
+ * @param options An optional parameter to specify the additional options such as the position of the text box.
100229
+ * @returns The newly inserted shape.
100230
+ */
100231
+ addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
100232
+ /**
100233
+ * Gets the number of shapes in the collection.
100234
+ *
100235
+ * @remarks
100236
+ * [Api set: PowerPointApi 1.3]
100237
+ * @returns The number of shapes in the collection.
100238
+ */
100239
+ getCount(): OfficeExtension.ClientResult<number>;
100240
+ /**
100241
+ * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
100242
+ *
100243
+ * @remarks
100244
+ * [Api set: PowerPointApi 1.3]
100245
+ *
100246
+ * @param key The ID of the shape.
100247
+ * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
100248
+ */
100249
+ getItem(key: string): PowerPoint.Shape;
100250
+ /**
100251
+ * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
100252
+ *
100253
+ * @remarks
100254
+ * [Api set: PowerPointApi 1.3]
100255
+ *
100256
+ * @param index The index of the shape in the collection.
100257
+ * @returns The shape at the given index. An error is thrown if index is out of range.
100258
+ */
100259
+ getItemAt(index: number): PowerPoint.Shape;
100260
+ /**
100261
+ * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
100262
+ *
100263
+ * @remarks
100264
+ * [Api set: PowerPointApi 1.3]
100265
+ *
100266
+ * @param id The ID of the shape.
100267
+ * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
100268
+ */
100269
+ getItemOrNullObject(id: string): PowerPoint.Shape;
100270
+ /**
100271
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100272
+ *
100273
+ * @param options Provides options for which properties of the object to load.
100274
+ */
100275
+ load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
100276
+ /**
100277
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100278
+ *
100279
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100280
+ */
100281
+ load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
100282
+ /**
100283
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100284
+ *
100285
+ * @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.
100286
+ */
100287
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
100288
+ /**
100289
+ * 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.)
100290
+ * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
100291
+ */
100292
+ toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
100293
+ }
100294
+ /**
100295
+ * Represents the layout of a slide.
100296
+ *
100297
+ * @remarks
100298
+ * [Api set: PowerPointApi 1.3]
100299
+ */
100300
+ class SlideLayout extends OfficeExtension.ClientObject {
100301
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100302
+ context: RequestContext;
100303
+ /**
100304
+ * Returns a collection of shapes in the slide layout.
100305
+ *
100306
+ * @remarks
100307
+ * [Api set: PowerPointApi 1.3]
100308
+ */
100309
+ readonly shapes: PowerPoint.ShapeCollection;
100310
+ /**
100311
+ * Gets the unique ID of the slide layout.
100312
+ *
100313
+ * @remarks
100314
+ * [Api set: PowerPointApi 1.3]
100315
+ */
100316
+ readonly id: string;
100317
+ /**
100318
+ * Gets the name of the slide layout.
100319
+ *
100320
+ * @remarks
100321
+ * [Api set: PowerPointApi 1.3]
100322
+ */
100323
+ readonly name: string;
100324
+ /**
100325
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100326
+ *
100327
+ * @param options Provides options for which properties of the object to load.
100328
+ */
100329
+ load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
100330
+ /**
100331
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100332
+ *
100333
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100334
+ */
100335
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
100336
+ /**
100337
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100338
+ *
100339
+ * @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.
100340
+ */
100341
+ load(propertyNamesAndPaths?: {
100342
+ select?: string;
100343
+ expand?: string;
100344
+ }): PowerPoint.SlideLayout;
100345
+ /**
100346
+ * 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.)
100347
+ * Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
100348
+ */
100349
+ toJSON(): PowerPoint.Interfaces.SlideLayoutData;
100350
+ }
100351
+ /**
100352
+ * Represents the collection of layouts provided by the Slide Master for slides.
100353
+ *
100354
+ * @remarks
100355
+ * [Api set: PowerPointApi 1.3]
100356
+ */
100357
+ class SlideLayoutCollection extends OfficeExtension.ClientObject {
100358
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100359
+ context: RequestContext;
100360
+ /** Gets the loaded child items in this collection. */
100361
+ readonly items: PowerPoint.SlideLayout[];
100362
+ /**
100363
+ * Gets the number of layouts in the collection.
100364
+ *
100365
+ * @remarks
100366
+ * [Api set: PowerPointApi 1.3]
100367
+ * @returns The number of layouts in the collection.
100368
+ */
100369
+ getCount(): OfficeExtension.ClientResult<number>;
100370
+ /**
100371
+ * Gets a layout using its unique ID.
100372
+ *
100373
+ * @remarks
100374
+ * [Api set: PowerPointApi 1.3]
100375
+ *
100376
+ * @param key The ID of the layout.
100377
+ * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
100378
+ */
100379
+ getItem(key: string): PowerPoint.SlideLayout;
100380
+ /**
100381
+ * Gets a layout using its zero-based index in the collection.
100382
+ *
100383
+ * @remarks
100384
+ * [Api set: PowerPointApi 1.3]
100385
+ *
100386
+ * @param index The index of the layout in the collection.
100387
+ * @returns The layout at the given index. An error is thrown if index is out of range.
100388
+ */
100389
+ getItemAt(index: number): PowerPoint.SlideLayout;
100390
+ /**
100391
+ * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
100392
+ see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
100393
+ *
100394
+ * @remarks
100395
+ * [Api set: PowerPointApi 1.3]
100396
+ *
100397
+ * @param id The ID of the layout.
100398
+ * @returns The layout with the unique ID.
100399
+ */
100400
+ getItemOrNullObject(id: string): PowerPoint.SlideLayout;
100401
+ /**
100402
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100403
+ *
100404
+ * @param options Provides options for which properties of the object to load.
100405
+ */
100406
+ load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
100407
+ /**
100408
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100409
+ *
100410
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100411
+ */
100412
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
100413
+ /**
100414
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100415
+ *
100416
+ * @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.
100417
+ */
100418
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
100419
+ /**
100420
+ * 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.)
100421
+ * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
100422
+ */
100423
+ toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
100424
+ }
100425
+ /**
100426
+ * Represents the Slide Master of a slide.
100427
+ *
100428
+ * @remarks
100429
+ * [Api set: PowerPointApi 1.3]
100430
+ */
100431
+ class SlideMaster extends OfficeExtension.ClientObject {
100432
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100433
+ context: RequestContext;
100434
+ /**
100435
+ * Gets the collection of layouts provided by the Slide Master for slides.
100436
+ *
100437
+ * @remarks
100438
+ * [Api set: PowerPointApi 1.3]
100439
+ */
100440
+ readonly layouts: PowerPoint.SlideLayoutCollection;
100441
+ /**
100442
+ * Returns a collection of shapes in the Slide Master.
100443
+ *
100444
+ * @remarks
100445
+ * [Api set: PowerPointApi 1.3]
100446
+ */
100447
+ readonly shapes: PowerPoint.ShapeCollection;
100448
+ /**
100449
+ * Gets the unique ID of the Slide Master.
100450
+ *
100451
+ * @remarks
100452
+ * [Api set: PowerPointApi 1.3]
100453
+ */
100454
+ readonly id: string;
100455
+ /**
100456
+ * Gets the unique name of the Slide Master.
100457
+ *
100458
+ * @remarks
100459
+ * [Api set: PowerPointApi 1.3]
100460
+ */
100461
+ readonly name: string;
100462
+ /**
100463
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100464
+ *
100465
+ * @param options Provides options for which properties of the object to load.
100466
+ */
100467
+ load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
100468
+ /**
100469
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100470
+ *
100471
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100472
+ */
100473
+ load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
100474
+ /**
100475
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100476
+ *
100477
+ * @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.
100478
+ */
100479
+ load(propertyNamesAndPaths?: {
100480
+ select?: string;
100481
+ expand?: string;
100482
+ }): PowerPoint.SlideMaster;
100483
+ /**
100484
+ * 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.)
100485
+ * Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
100486
+ */
100487
+ toJSON(): PowerPoint.Interfaces.SlideMasterData;
100488
+ }
100489
+ /**
100490
+ * Represents a single tag in the slide.
100491
+ *
100492
+ * @remarks
100493
+ * [Api set: PowerPointApi 1.3]
100494
+ */
100495
+ class Tag extends OfficeExtension.ClientObject {
100496
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100497
+ context: RequestContext;
100498
+ /**
100499
+ * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
100500
+ *
100501
+ * @remarks
100502
+ * [Api set: PowerPointApi 1.3]
100503
+ */
100504
+ readonly key: string;
100505
+ /**
100506
+ * Gets the value of the tag.
100507
+ *
100508
+ * @remarks
100509
+ * [Api set: PowerPointApi 1.3]
100510
+ */
100511
+ value: string;
100512
+ /**
100513
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100514
+ *
100515
+ * @param options Provides options for which properties of the object to load.
100516
+ */
100517
+ load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;
100518
+ /**
100519
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100520
+ *
100521
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100522
+ */
100523
+ load(propertyNames?: string | string[]): PowerPoint.Tag;
100524
+ /**
100525
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100526
+ *
100527
+ * @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.
100528
+ */
100529
+ load(propertyNamesAndPaths?: {
100530
+ select?: string;
100531
+ expand?: string;
100532
+ }): PowerPoint.Tag;
100533
+ /**
100534
+ * 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.)
100535
+ * Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
100536
+ */
100537
+ toJSON(): PowerPoint.Interfaces.TagData;
100538
+ }
100539
+ /**
100540
+ * Represents the collection of tags.
100541
+ *
100542
+ * @remarks
100543
+ * [Api set: PowerPointApi 1.3]
100544
+ */
100545
+ class TagCollection extends OfficeExtension.ClientObject {
100546
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100547
+ context: RequestContext;
100548
+ /** Gets the loaded child items in this collection. */
100549
+ readonly items: PowerPoint.Tag[];
100550
+ /**
100551
+ * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
100552
+ *
100553
+ * @remarks
100554
+ * [Api set: PowerPointApi 1.3]
100555
+ *
100556
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
100557
+ * @param value The value of the tag.
100558
+ */
100559
+ add(key: string, value: string): void;
100560
+ /**
100561
+ * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
100562
+ *
100563
+ * @remarks
100564
+ * [Api set: PowerPointApi 1.3]
100565
+ *
100566
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
100567
+ */
100568
+ delete(key: string): void;
100569
+ /**
100570
+ * Gets the number of tags in the collection.
100571
+ *
100572
+ * @remarks
100573
+ * [Api set: PowerPointApi 1.3]
100574
+ * @returns The number of tags in the collection.
100575
+ */
100576
+ getCount(): OfficeExtension.ClientResult<number>;
100577
+ /**
100578
+ * Gets a tag using its unique ID. An error is thrown if the tag does not exist.
100579
+ *
100580
+ * @remarks
100581
+ * [Api set: PowerPointApi 1.3]
100582
+ *
100583
+ * @param key The ID of the tag.
100584
+ * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
100585
+ */
100586
+ getItem(key: string): PowerPoint.Tag;
100587
+ /**
100588
+ * Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.
100589
+ *
100590
+ * @remarks
100591
+ * [Api set: PowerPointApi 1.3]
100592
+ *
100593
+ * @param index The index of the tag in the collection.
100594
+ * @returns The tag at the given index. An error is thrown if index is out of range.
100595
+ */
100596
+ getItemAt(index: number): PowerPoint.Tag;
100597
+ /**
100598
+ * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
100599
+ *
100600
+ * @remarks
100601
+ * [Api set: PowerPointApi 1.3]
100602
+ *
100603
+ * @param key The ID of the tag.
100604
+ * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
100605
+ */
100606
+ getItemOrNullObject(key: string): PowerPoint.Tag;
100607
+ /**
100608
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100609
+ *
100610
+ * @param options Provides options for which properties of the object to load.
100611
+ */
100612
+ load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
100613
+ /**
100614
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100615
+ *
100616
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100617
+ */
100618
+ load(propertyNames?: string | string[]): PowerPoint.TagCollection;
100619
+ /**
100620
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100621
+ *
100622
+ * @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.
100623
+ */
100624
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
100625
+ /**
100626
+ * 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.)
100627
+ * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
100628
+ */
100629
+ toJSON(): PowerPoint.Interfaces.TagCollectionData;
100630
+ }
100631
+ /**
100632
+ * Represents a single slide of a presentation.
100633
+ *
100634
+ * @remarks
100635
+ * [Api set: PowerPointApi 1.2]
100636
+ */
100637
+ class Slide extends OfficeExtension.ClientObject {
100638
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100639
+ context: RequestContext;
100640
+ /**
100641
+ * Gets the layout of the slide.
100642
+ *
100643
+ * @remarks
100644
+ * [Api set: PowerPointApi 1.3]
100645
+ */
100646
+ readonly layout: PowerPoint.SlideLayout;
100647
+ /**
100648
+ * Returns a collection of shapes in the slide.
100649
+ *
100650
+ * @remarks
100651
+ * [Api set: PowerPointApi 1.3]
100652
+ */
100653
+ readonly shapes: PowerPoint.ShapeCollection;
100654
+ /**
100655
+ * Gets the `SlideMaster` object that represents the slide's default content.
100656
+ *
100657
+ * @remarks
100658
+ * [Api set: PowerPointApi 1.3]
100659
+ */
100660
+ readonly slideMaster: PowerPoint.SlideMaster;
100661
+ /**
100662
+ * Returns a collection of tags in the slide.
100663
+ *
100664
+ * @remarks
100665
+ * [Api set: PowerPointApi 1.3]
100666
+ */
100667
+ readonly tags: PowerPoint.TagCollection;
100668
+ /**
100669
+ * Gets the unique ID of the slide.
100670
+ *
100671
+ * @remarks
100672
+ * [Api set: PowerPointApi 1.2]
100673
+ */
100674
+ readonly id: string;
100675
+ /**
100676
+ * Deletes the slide from the presentation. Does nothing if the slide does not exist.
100677
+ *
100678
+ * @remarks
100679
+ * [Api set: PowerPointApi 1.2]
100680
+ */
100681
+ delete(): void;
100682
+ /**
100683
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100684
+ *
100685
+ * @param options Provides options for which properties of the object to load.
100686
+ */
100687
+ load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
100688
+ /**
100689
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100690
+ *
100691
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100692
+ */
100693
+ load(propertyNames?: string | string[]): PowerPoint.Slide;
100694
+ /**
100695
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100696
+ *
100697
+ * @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.
100698
+ */
100699
+ load(propertyNamesAndPaths?: {
100700
+ select?: string;
100701
+ expand?: string;
100702
+ }): PowerPoint.Slide;
100703
+ /**
100704
+ * 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.)
100705
+ * Whereas the original PowerPoint.Slide object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
100706
+ */
100707
+ toJSON(): PowerPoint.Interfaces.SlideData;
100708
+ }
100709
+ /**
100710
+ * Specifies a shape's fill type.
100711
+ *
100712
+ * @remarks
100713
+ * [Api set: PowerPointApi 1.4]
100714
+ */
100715
+ enum ShapeFillType {
100716
+ /**
100717
+ * Specifies that the shape should have no fill.
100718
+ * @remarks
100719
+ * [Api set: PowerPointApi 1.4]
100720
+ */
100721
+ noFill = "NoFill",
100722
+ /**
100723
+ * Specifies that the shape should have regular solid fill.
100724
+ * @remarks
100725
+ * [Api set: PowerPointApi 1.4]
100726
+ */
100727
+ solid = "Solid",
100728
+ /**
100729
+ * Specifies that the shape should have gradient fill.
100730
+ * @remarks
100731
+ * [Api set: PowerPointApi 1.4]
100732
+ */
100733
+ gradient = "Gradient",
100734
+ /**
100735
+ * Specifies that the shape should have pattern fill.
100736
+ * @remarks
100737
+ * [Api set: PowerPointApi 1.4]
100738
+ */
100739
+ pattern = "Pattern",
100740
+ /**
100741
+ * Specifies that the shape should have picture or texture fill.
100742
+ * @remarks
100743
+ * [Api set: PowerPointApi 1.4]
100744
+ */
100745
+ pictureAndTexture = "PictureAndTexture",
100746
+ /**
100747
+ * Specifies that the shape should have slide background fill.
100748
+ * @remarks
100749
+ * [Api set: PowerPointApi 1.4]
100750
+ */
100751
+ slideBackground = "SlideBackground",
100752
+ }
100753
+ /**
100754
+ * Represents the fill formatting of a shape object.
100755
+ *
100756
+ * @remarks
100757
+ * [Api set: PowerPointApi 1.4]
100758
+ */
100759
+ class ShapeFill extends OfficeExtension.ClientObject {
100760
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100761
+ context: RequestContext;
100762
+ /**
100763
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
100764
+ *
100765
+ * @remarks
100766
+ * [Api set: PowerPointApi 1.4]
100767
+ */
100768
+ foregroundColor: string;
100769
+ /**
100770
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
100771
+ *
100772
+ * @remarks
100773
+ * [Api set: PowerPointApi 1.4]
100774
+ */
100775
+ transparency: number;
100776
+ /**
100777
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
100778
+ *
100779
+ * @remarks
100780
+ * [Api set: PowerPointApi 1.4]
100781
+ */
100782
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
100783
+ /**
100784
+ * Clears the fill formatting of this shape.
100785
+ *
100786
+ * @remarks
100787
+ * [Api set: PowerPointApi 1.4]
100788
+ */
100789
+ clear(): void;
100790
+ /**
100791
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
100792
+ *
100793
+ * @remarks
100794
+ * [Api set: PowerPointApi 1.4]
100795
+ *
100796
+ * @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
100797
+ */
100798
+ setSolidColor(color: string): void;
100799
+ /**
100800
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100801
+ *
100802
+ * @param options Provides options for which properties of the object to load.
100803
+ */
100804
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
100805
+ /**
100806
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100807
+ *
100808
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
100809
+ */
100810
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
100811
+ /**
100812
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100813
+ *
100814
+ * @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.
100815
+ */
100816
+ load(propertyNamesAndPaths?: {
100817
+ select?: string;
100818
+ expand?: string;
100819
+ }): PowerPoint.ShapeFill;
100820
+ /**
100821
+ * 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.)
100822
+ * Whereas the original PowerPoint.ShapeFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
100823
+ */
100824
+ toJSON(): PowerPoint.Interfaces.ShapeFillData;
100825
+ }
100826
+ /**
100827
+ * Specifies the style for a line.
100828
+ *
100829
+ * @remarks
100830
+ * [Api set: PowerPointApi 1.4]
100831
+ */
100832
+ enum ShapeLineStyle {
100833
+ /**
100834
+ * Single line.
100835
+ * @remarks
100836
+ * [Api set: PowerPointApi 1.4]
100837
+ */
100838
+ single = "Single",
100839
+ /**
100840
+ * Thick line with a thin line on each side.
100841
+ * @remarks
100842
+ * [Api set: PowerPointApi 1.4]
100843
+ */
100844
+ thickBetweenThin = "ThickBetweenThin",
100845
+ /**
100846
+ * Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the thick line is to the left of the thin line.
100847
+ * @remarks
100848
+ * [Api set: PowerPointApi 1.4]
100849
+ */
100850
+ thickThin = "ThickThin",
100851
+ /**
100852
+ * Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the thick line is to the right of the thin line.
100853
+ * @remarks
100854
+ * [Api set: PowerPointApi 1.4]
100855
+ */
100856
+ thinThick = "ThinThick",
100857
+ /**
100858
+ * Two thin lines.
100859
+ * @remarks
100860
+ * [Api set: PowerPointApi 1.4]
100861
+ */
100862
+ thinThin = "ThinThin",
100863
+ }
100864
+ /**
100865
+ * Specifies the dash style for a line.
100866
+ *
100867
+ * @remarks
100868
+ * [Api set: PowerPointApi 1.4]
100869
+ */
100870
+ enum ShapeLineDashStyle {
100871
+ /**
100872
+ * The dash line pattern
100873
+ * @remarks
100874
+ * [Api set: PowerPointApi 1.4]
100875
+ */
100876
+ dash = "Dash",
100877
+ /**
100878
+ * The dash-dot line pattern
100879
+ * @remarks
100880
+ * [Api set: PowerPointApi 1.4]
100881
+ */
100882
+ dashDot = "DashDot",
100883
+ /**
100884
+ * The dash-dot-dot line pattern
100885
+ * @remarks
100886
+ * [Api set: PowerPointApi 1.4]
100887
+ */
100888
+ dashDotDot = "DashDotDot",
100889
+ /**
100890
+ * The long dash line pattern
100891
+ * @remarks
100892
+ * [Api set: PowerPointApi 1.4]
100893
+ */
100894
+ longDash = "LongDash",
100895
+ /**
100896
+ * The long dash-dot line pattern
100897
+ * @remarks
100898
+ * [Api set: PowerPointApi 1.4]
100899
+ */
100900
+ longDashDot = "LongDashDot",
100901
+ /**
100902
+ * The round dot line pattern
100903
+ * @remarks
100904
+ * [Api set: PowerPointApi 1.4]
100905
+ */
100906
+ roundDot = "RoundDot",
100907
+ /**
100908
+ * The solid line pattern
100909
+ * @remarks
100910
+ * [Api set: PowerPointApi 1.4]
100911
+ */
100912
+ solid = "Solid",
100913
+ /**
100914
+ * The square dot line pattern
100915
+ * @remarks
100916
+ * [Api set: PowerPointApi 1.4]
100917
+ */
100918
+ squareDot = "SquareDot",
100919
+ /**
100920
+ * The long dash-dot-dot line pattern
100921
+ * @remarks
100922
+ * [Api set: PowerPointApi 1.4]
100923
+ */
100924
+ longDashDotDot = "LongDashDotDot",
100925
+ /**
100926
+ * The system dash line pattern
100927
+ * @remarks
100928
+ * [Api set: PowerPointApi 1.4]
100929
+ */
100930
+ systemDash = "SystemDash",
100931
+ /**
100932
+ * The system dot line pattern
100933
+ * @remarks
100934
+ * [Api set: PowerPointApi 1.4]
100935
+ */
100936
+ systemDot = "SystemDot",
100937
+ /**
100938
+ * The system dash-dot line pattern
100939
+ * @remarks
100940
+ * [Api set: PowerPointApi 1.4]
100941
+ */
100942
+ systemDashDot = "SystemDashDot",
100943
+ }
100944
+ /**
100945
+ * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
100946
+ *
100947
+ * @remarks
100948
+ * [Api set: PowerPointApi 1.4]
100949
+ */
100950
+ class ShapeLineFormat extends OfficeExtension.ClientObject {
100951
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
100952
+ context: RequestContext;
100953
+ /**
100954
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
100955
+ *
100956
+ * @remarks
100957
+ * [Api set: PowerPointApi 1.4]
100958
+ */
100959
+ color: string;
100960
+ /**
100961
+ * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
100962
+ *
100963
+ * @remarks
100964
+ * [Api set: PowerPointApi 1.4]
100965
+ */
100966
+ dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
100967
+ /**
100968
+ * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
100969
+ *
100970
+ * @remarks
100971
+ * [Api set: PowerPointApi 1.4]
100972
+ */
100973
+ style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
100974
+ /**
100975
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
100976
+ *
100977
+ * @remarks
100978
+ * [Api set: PowerPointApi 1.4]
100979
+ */
100980
+ transparency: number;
100981
+ /**
100982
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
100983
+ *
100984
+ * @remarks
100985
+ * [Api set: PowerPointApi 1.4]
100986
+ */
100987
+ visible: boolean;
100988
+ /**
100989
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
100990
+ *
100991
+ * @remarks
100992
+ * [Api set: PowerPointApi 1.4]
100993
+ */
100994
+ weight: number;
100995
+ /**
100996
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
100997
+ *
100998
+ * @param options Provides options for which properties of the object to load.
100999
+ */
101000
+ load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;
101001
+ /**
101002
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101003
+ *
101004
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
101005
+ */
101006
+ load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;
101007
+ /**
101008
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101009
+ *
101010
+ * @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.
101011
+ */
101012
+ load(propertyNamesAndPaths?: {
101013
+ select?: string;
101014
+ expand?: string;
101015
+ }): PowerPoint.ShapeLineFormat;
101016
+ /**
101017
+ * 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.)
101018
+ * Whereas the original PowerPoint.ShapeLineFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object.
101019
+ */
101020
+ toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
101021
+ }
101022
+ /**
101023
+ * Specifies the type of a shape.
101024
+ *
101025
+ * @remarks
101026
+ * [Api set: PowerPointApi 1.4]
101027
+ */
101028
+ enum ShapeType {
101029
+ /**
101030
+ * The given shape's type is unsupported.
101031
+ * @remarks
101032
+ * [Api set: PowerPointApi 1.4]
101033
+ */
101034
+ unsupported = "Unsupported",
101035
+ /**
101036
+ * The shape is an image
101037
+ * @remarks
101038
+ * [Api set: PowerPointApi 1.4]
101039
+ */
101040
+ image = "Image",
101041
+ /**
101042
+ * The shape is a geometric shape such as rectangle
101043
+ * @remarks
101044
+ * [Api set: PowerPointApi 1.4]
101045
+ */
101046
+ geometricShape = "GeometricShape",
101047
+ /**
101048
+ * The shape is a group shape which contains sub-shapes
101049
+ * @remarks
101050
+ * [Api set: PowerPointApi 1.4]
101051
+ */
101052
+ group = "Group",
101053
+ /**
101054
+ * The shape is a line
101055
+ * @remarks
101056
+ * [Api set: PowerPointApi 1.4]
101057
+ */
101058
+ line = "Line",
101059
+ }
101060
+ /**
101061
+ * Determines the type of automatic sizing allowed.
101062
+ *
101063
+ * @remarks
101064
+ * [Api set: PowerPointApi 1.4]
101065
+ */
101066
+ enum ShapeAutoSize {
101067
+ /**
101068
+ * No autosizing.
101069
+ * @remarks
101070
+ * [Api set: PowerPointApi 1.4]
101071
+ */
101072
+ autoSizeNone = "AutoSizeNone",
101073
+ /**
101074
+ * The text is adjusted to fit the shape.
101075
+ * @remarks
101076
+ * [Api set: PowerPointApi 1.4]
101077
+ */
101078
+ autoSizeTextToFitShape = "AutoSizeTextToFitShape",
101079
+ /**
101080
+ * The shape is adjusted to fit the text.
101081
+ * @remarks
101082
+ * [Api set: PowerPointApi 1.4]
101083
+ */
101084
+ autoSizeShapeToFitText = "AutoSizeShapeToFitText",
101085
+ /**
101086
+ * A combination of automatic sizing schemes are used.
101087
+ * @remarks
101088
+ * [Api set: PowerPointApi 1.4]
101089
+ */
101090
+ autoSizeMixed = "AutoSizeMixed",
101091
+ }
101092
+ /**
101093
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
101094
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
101095
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
101096
+ *
101097
+ * @remarks
101098
+ * [Api set: PowerPointApi 1.4]
101099
+ */
101100
+ enum TextVerticalAlignment {
101101
+ /**
101102
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
101103
+ * @remarks
101104
+ * [Api set: PowerPointApi 1.4]
101105
+ */
101106
+ top = "Top",
101107
+ /**
101108
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
101109
+ * @remarks
101110
+ * [Api set: PowerPointApi 1.4]
101111
+ */
101112
+ middle = "Middle",
101113
+ /**
101114
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
101115
+ * @remarks
101116
+ * [Api set: PowerPointApi 1.4]
101117
+ */
101118
+ bottom = "Bottom",
101119
+ /**
101120
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
101121
+ * @remarks
101122
+ * [Api set: PowerPointApi 1.4]
101123
+ */
101124
+ topCentered = "TopCentered",
101125
+ /**
101126
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
101127
+ * @remarks
101128
+ * [Api set: PowerPointApi 1.4]
101129
+ */
101130
+ middleCentered = "MiddleCentered",
101131
+ /**
101132
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
101133
+ * @remarks
101134
+ * [Api set: PowerPointApi 1.4]
101135
+ */
101136
+ bottomCentered = "BottomCentered",
101137
+ }
101138
+ /**
101139
+ * The type of underline applied to a font.
101140
+ *
101141
+ * @remarks
101142
+ * [Api set: PowerPointApi 1.4]
101143
+ */
101144
+ enum ShapeFontUnderlineStyle {
101145
+ /**
101146
+ * No underlining.
101147
+ * @remarks
101148
+ * [Api set: PowerPointApi 1.4]
101149
+ */
101150
+ none = "None",
101151
+ /**
101152
+ * Regular single line underlining.
101153
+ * @remarks
101154
+ * [Api set: PowerPointApi 1.4]
101155
+ */
101156
+ single = "Single",
101157
+ /**
101158
+ * Underlining of text with double lines.
101159
+ * @remarks
101160
+ * [Api set: PowerPointApi 1.4]
101161
+ */
101162
+ double = "Double",
101163
+ /**
101164
+ * Underlining of text with a thick line.
101165
+ * @remarks
101166
+ * [Api set: PowerPointApi 1.4]
101167
+ */
101168
+ heavy = "Heavy",
101169
+ /**
101170
+ * Underlining of text with a dotted line.
101171
+ * @remarks
101172
+ * [Api set: PowerPointApi 1.4]
101173
+ */
101174
+ dotted = "Dotted",
101175
+ /**
101176
+ * Underlining of text with a thick, dotted line.
101177
+ * @remarks
101178
+ * [Api set: PowerPointApi 1.4]
101179
+ */
101180
+ dottedHeavy = "DottedHeavy",
101181
+ /**
101182
+ * Underlining of text with a line containing dashes.
101183
+ * @remarks
101184
+ * [Api set: PowerPointApi 1.4]
101185
+ */
101186
+ dash = "Dash",
101187
+ /**
101188
+ * Underlining of text with a thick line containing dashes.
101189
+ * @remarks
101190
+ * [Api set: PowerPointApi 1.4]
101191
+ */
101192
+ dashHeavy = "DashHeavy",
101193
+ /**
101194
+ * Underlining of text with a line containing long dashes.
101195
+ * @remarks
101196
+ * [Api set: PowerPointApi 1.4]
101197
+ */
101198
+ dashLong = "DashLong",
101199
+ /**
101200
+ * Underlining of text with a thick line containing long dashes.
101201
+ * @remarks
101202
+ * [Api set: PowerPointApi 1.4]
101203
+ */
101204
+ dashLongHeavy = "DashLongHeavy",
101205
+ /**
101206
+ * Underlining of text with a line containing dots and dashes.
101207
+ * @remarks
101208
+ * [Api set: PowerPointApi 1.4]
101209
+ */
101210
+ dotDash = "DotDash",
101211
+ /**
101212
+ * Underlining of text with a thick line containing dots and dashes.
101213
+ * @remarks
101214
+ * [Api set: PowerPointApi 1.4]
101215
+ */
101216
+ dotDashHeavy = "DotDashHeavy",
101217
+ /**
101218
+ * Underlining of text with a line containing double dots and dashes.
101219
+ * @remarks
101220
+ * [Api set: PowerPointApi 1.4]
101221
+ */
101222
+ dotDotDash = "DotDotDash",
101223
+ /**
101224
+ * Underlining of text with a thick line containing double dots and dashes.
101225
+ * @remarks
101226
+ * [Api set: PowerPointApi 1.4]
101227
+ */
101228
+ dotDotDashHeavy = "DotDotDashHeavy",
101229
+ /**
101230
+ * Underlining of text with a wavy line.
101231
+ * @remarks
101232
+ * [Api set: PowerPointApi 1.4]
101233
+ */
101234
+ wavy = "Wavy",
101235
+ /**
101236
+ * Underlining of text with a thick, wavy line.
101237
+ * @remarks
101238
+ * [Api set: PowerPointApi 1.4]
101239
+ */
101240
+ wavyHeavy = "WavyHeavy",
101241
+ /**
101242
+ * Underlining of text with double wavy lines.
101243
+ * @remarks
101244
+ * [Api set: PowerPointApi 1.4]
101245
+ */
101246
+ wavyDouble = "WavyDouble",
101247
+ }
101248
+ /**
101249
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
101250
+ *
101251
+ * @remarks
101252
+ * [Api set: PowerPointApi 1.4]
101253
+ */
101254
+ class ShapeFont extends OfficeExtension.ClientObject {
101255
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
101256
+ context: RequestContext;
101257
+ /**
101258
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
101259
+ *
101260
+ * @remarks
101261
+ * [Api set: PowerPointApi 1.4]
101262
+ */
101263
+ bold: boolean;
101264
+ /**
101265
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
101266
+ *
101267
+ * @remarks
101268
+ * [Api set: PowerPointApi 1.4]
101269
+ */
101270
+ color: string;
101271
+ /**
101272
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
101273
+ *
101274
+ * @remarks
101275
+ * [Api set: PowerPointApi 1.4]
101276
+ */
101277
+ italic: boolean;
101278
+ /**
101279
+ * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
101280
+ *
101281
+ * @remarks
101282
+ * [Api set: PowerPointApi 1.4]
101283
+ */
101284
+ name: string;
101285
+ /**
101286
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
101287
+ *
101288
+ * @remarks
101289
+ * [Api set: PowerPointApi 1.4]
101290
+ */
101291
+ size: number;
101292
+ /**
101293
+ * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
101294
+ *
101295
+ * @remarks
101296
+ * [Api set: PowerPointApi 1.4]
101297
+ */
101298
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
101299
+ /**
101300
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101301
+ *
101302
+ * @param options Provides options for which properties of the object to load.
101303
+ */
101304
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
101305
+ /**
101306
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101307
+ *
101308
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
101309
+ */
101310
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
101311
+ /**
101312
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101313
+ *
101314
+ * @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.
101315
+ */
101316
+ load(propertyNamesAndPaths?: {
101317
+ select?: string;
101318
+ expand?: string;
101319
+ }): PowerPoint.ShapeFont;
101320
+ /**
101321
+ * 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.)
101322
+ * Whereas the original PowerPoint.ShapeFont object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
101323
+ */
101324
+ toJSON(): PowerPoint.Interfaces.ShapeFontData;
101325
+ }
101326
+ /**
101327
+ * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
101328
+ *
101329
+ * @remarks
101330
+ * [Api set: PowerPointApi 1.4]
101331
+ */
101332
+ class TextRange extends OfficeExtension.ClientObject {
101333
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
101334
+ context: RequestContext;
101335
+ /**
101336
+ * Returns a `ShapeFont` object that represents the font attributes for the text range.
101337
+ *
101338
+ * @remarks
101339
+ * [Api set: PowerPointApi 1.4]
101340
+ */
101341
+ readonly font: PowerPoint.ShapeFont;
101342
+ /**
101343
+ * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
101344
+ *
101345
+ * @remarks
101346
+ * [Api set: PowerPointApi 1.4]
101347
+ */
101348
+ readonly paragraphFormat: PowerPoint.ParagraphFormat;
101349
+ /**
101350
+ * Represents the plain text content of the text range.
101351
+ *
101352
+ * @remarks
101353
+ * [Api set: PowerPointApi 1.4]
101354
+ */
101355
+ text: string;
101356
+ /**
101357
+ * Returns a `TextRange` object for the substring in the given range.
101358
+ *
101359
+ * @remarks
101360
+ * [Api set: PowerPointApi 1.4]
101361
+ *
101362
+ * @param start The zero-based index of the first character to get from the text range.
101363
+ * @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned.
101364
+ */
101365
+ getSubstring(start: number, length?: number): PowerPoint.TextRange;
101366
+ /**
101367
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101368
+ *
101369
+ * @param options Provides options for which properties of the object to load.
101370
+ */
101371
+ load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;
101372
+ /**
101373
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101374
+ *
101375
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
101376
+ */
101377
+ load(propertyNames?: string | string[]): PowerPoint.TextRange;
101378
+ /**
101379
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101380
+ *
101381
+ * @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.
101382
+ */
101383
+ load(propertyNamesAndPaths?: {
101384
+ select?: string;
101385
+ expand?: string;
101386
+ }): PowerPoint.TextRange;
101387
+ /**
101388
+ * 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.)
101389
+ * Whereas the original PowerPoint.TextRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object.
101390
+ */
101391
+ toJSON(): PowerPoint.Interfaces.TextRangeData;
101392
+ }
101393
+ /**
101394
+ * Represents the text frame of a shape object.
101395
+ *
101396
+ * @remarks
101397
+ * [Api set: PowerPointApi 1.4]
101398
+ */
101399
+ class TextFrame extends OfficeExtension.ClientObject {
101400
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
101401
+ context: RequestContext;
101402
+ /**
101403
+ * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details.
101404
+ *
101405
+ * @remarks
101406
+ * [Api set: PowerPointApi 1.4]
101407
+ */
101408
+ readonly textRange: PowerPoint.TextRange;
101409
+ /**
101410
+ * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
101411
+ *
101412
+ * @remarks
101413
+ * [Api set: PowerPointApi 1.4]
101414
+ */
101415
+ autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
101416
+ /**
101417
+ * Represents the bottom margin, in points, of the text frame.
101418
+ *
101419
+ * @remarks
101420
+ * [Api set: PowerPointApi 1.4]
101421
+ */
101422
+ bottomMargin: number;
101423
+ /**
101424
+ * Specifies if the text frame contains text.
101425
+ *
101426
+ * @remarks
101427
+ * [Api set: PowerPointApi 1.4]
101428
+ */
101429
+ readonly hasText: boolean;
101430
+ /**
101431
+ * Represents the left margin, in points, of the text frame.
101432
+ *
101433
+ * @remarks
101434
+ * [Api set: PowerPointApi 1.4]
101435
+ */
101436
+ leftMargin: number;
101437
+ /**
101438
+ * Represents the right margin, in points, of the text frame.
101439
+ *
101440
+ * @remarks
101441
+ * [Api set: PowerPointApi 1.4]
101442
+ */
101443
+ rightMargin: number;
101444
+ /**
101445
+ * Represents the top margin, in points, of the text frame.
101446
+ *
101447
+ * @remarks
101448
+ * [Api set: PowerPointApi 1.4]
101449
+ */
101450
+ topMargin: number;
101451
+ /**
101452
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
101453
+ *
101454
+ * @remarks
101455
+ * [Api set: PowerPointApi 1.4]
101456
+ */
101457
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
101458
+ /**
101459
+ * Determines whether lines break automatically to fit text inside the shape.
101460
+ *
101461
+ * @remarks
101462
+ * [Api set: PowerPointApi 1.4]
101463
+ */
101464
+ wordWrap: boolean;
101465
+ /**
101466
+ * Deletes all the text in the text frame.
101467
+ *
101468
+ * @remarks
101469
+ * [Api set: PowerPointApi 1.4]
101470
+ */
101471
+ deleteText(): void;
101472
+ /**
101473
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101474
+ *
101475
+ * @param options Provides options for which properties of the object to load.
101476
+ */
101477
+ load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;
101478
+ /**
101479
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101480
+ *
101481
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
101482
+ */
101483
+ load(propertyNames?: string | string[]): PowerPoint.TextFrame;
101484
+ /**
101485
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
101486
+ *
101487
+ * @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.
101488
+ */
101489
+ load(propertyNamesAndPaths?: {
101490
+ select?: string;
101491
+ expand?: string;
101492
+ }): PowerPoint.TextFrame;
101493
+ /**
101494
+ * 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.)
101495
+ * Whereas the original PowerPoint.TextFrame object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object.
101496
+ */
101497
+ toJSON(): PowerPoint.Interfaces.TextFrameData;
101498
+ }
101499
+ /**
101500
+ * Represents a single shape in the slide.
101501
+ *
101502
+ * @remarks
101503
+ * [Api set: PowerPointApi 1.3]
101504
+ */
101505
+ class Shape extends OfficeExtension.ClientObject {
101506
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
101507
+ context: RequestContext;
101508
+ /**
101509
+ * Returns the fill formatting of this shape.
101510
+ *
101511
+ * @remarks
101512
+ * [Api set: PowerPointApi 1.4]
101513
+ */
101514
+ readonly fill: PowerPoint.ShapeFill;
101515
+ /**
101516
+ * Returns the line formatting of this shape.
101517
+ *
101518
+ * @remarks
101519
+ * [Api set: PowerPointApi 1.4]
101520
+ */
101521
+ readonly lineFormat: PowerPoint.ShapeLineFormat;
101522
+ /**
101523
+ * Returns a collection of tags in the shape.
101524
+ *
101525
+ * @remarks
101526
+ * [Api set: PowerPointApi 1.3]
101527
+ */
101528
+ readonly tags: PowerPoint.TagCollection;
101529
+ /**
101530
+ * Returns the text frame object of this shape.
101531
+ *
101532
+ * @remarks
101533
+ * [Api set: PowerPointApi 1.4]
101534
+ */
101535
+ readonly textFrame: PowerPoint.TextFrame;
101536
+ /**
101537
+ * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
101538
+ *
101539
+ * @remarks
101540
+ * [Api set: PowerPointApi 1.4]
101541
+ */
101542
+ height: number;
101543
+ /**
101544
+ * Gets the unique ID of the shape.
101545
+ *
101546
+ * @remarks
101547
+ * [Api set: PowerPointApi 1.3]
101548
+ */
101549
+ readonly id: string;
101550
+ /**
101551
+ * The distance, in points, from the left side of the shape to the left side of the slide.
101552
+ *
101553
+ * @remarks
101554
+ * [Api set: PowerPointApi 1.4]
101555
+ */
101556
+ left: number;
101557
+ /**
101558
+ * Specifies the name of this shape.
101559
+ *
101560
+ * @remarks
101561
+ * [Api set: PowerPointApi 1.4]
101562
+ */
101563
+ name: string;
101564
+ /**
101565
+ * The distance, in points, from the top edge of the shape to the top edge of the slide.
101566
+ *
101567
+ * @remarks
101568
+ * [Api set: PowerPointApi 1.4]
101569
+ */
101570
+ top: number;
101571
+ /**
101572
+ * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
101573
+ *
101574
+ * @remarks
101575
+ * [Api set: PowerPointApi 1.4]
101576
+ */
101577
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
101578
+ /**
101579
+ * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
101580
+ *
101581
+ * @remarks
101582
+ * [Api set: PowerPointApi 1.4]
101583
+ */
101584
+ width: number;
101585
+ /**
101586
+ * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
101587
+ *
99393
101588
  * @remarks
99394
101589
  * [Api set: PowerPointApi 1.3]
99395
101590
  */
@@ -99597,6 +101792,26 @@ declare namespace PowerPoint {
99597
101792
  */
99598
101793
  $skip?: number;
99599
101794
  }
101795
+ /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
101796
+ interface BulletFormatUpdateData {
101797
+ /**
101798
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
101799
+ *
101800
+ * @remarks
101801
+ * [Api set: PowerPointApi 1.4]
101802
+ */
101803
+ visible?: boolean;
101804
+ }
101805
+ /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
101806
+ interface ParagraphFormatUpdateData {
101807
+ /**
101808
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
101809
+ *
101810
+ * @remarks
101811
+ * [Api set: PowerPointApi 1.4]
101812
+ */
101813
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
101814
+ }
99600
101815
  /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
99601
101816
  interface ShapeCollectionUpdateData {
99602
101817
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -99608,16 +101823,223 @@ declare namespace PowerPoint {
99608
101823
  /** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
99609
101824
  interface TagUpdateData {
99610
101825
  /**
99611
- * Gets the value of the tag.
101826
+ * Gets the value of the tag.
101827
+ *
101828
+ * @remarks
101829
+ * [Api set: PowerPointApi 1.3]
101830
+ */
101831
+ value?: string;
101832
+ }
101833
+ /** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
101834
+ interface TagCollectionUpdateData {
101835
+ items?: PowerPoint.Interfaces.TagData[];
101836
+ }
101837
+ /** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */
101838
+ interface ShapeFillUpdateData {
101839
+ /**
101840
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
101841
+ *
101842
+ * @remarks
101843
+ * [Api set: PowerPointApi 1.4]
101844
+ */
101845
+ foregroundColor?: string;
101846
+ /**
101847
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
101848
+ *
101849
+ * @remarks
101850
+ * [Api set: PowerPointApi 1.4]
101851
+ */
101852
+ transparency?: number;
101853
+ }
101854
+ /** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */
101855
+ interface ShapeLineFormatUpdateData {
101856
+ /**
101857
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
101858
+ *
101859
+ * @remarks
101860
+ * [Api set: PowerPointApi 1.4]
101861
+ */
101862
+ color?: string;
101863
+ /**
101864
+ * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
101865
+ *
101866
+ * @remarks
101867
+ * [Api set: PowerPointApi 1.4]
101868
+ */
101869
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
101870
+ /**
101871
+ * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
101872
+ *
101873
+ * @remarks
101874
+ * [Api set: PowerPointApi 1.4]
101875
+ */
101876
+ style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
101877
+ /**
101878
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
101879
+ *
101880
+ * @remarks
101881
+ * [Api set: PowerPointApi 1.4]
101882
+ */
101883
+ transparency?: number;
101884
+ /**
101885
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
101886
+ *
101887
+ * @remarks
101888
+ * [Api set: PowerPointApi 1.4]
101889
+ */
101890
+ visible?: boolean;
101891
+ /**
101892
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
101893
+ *
101894
+ * @remarks
101895
+ * [Api set: PowerPointApi 1.4]
101896
+ */
101897
+ weight?: number;
101898
+ }
101899
+ /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
101900
+ interface ShapeFontUpdateData {
101901
+ /**
101902
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
101903
+ *
101904
+ * @remarks
101905
+ * [Api set: PowerPointApi 1.4]
101906
+ */
101907
+ bold?: boolean;
101908
+ /**
101909
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
101910
+ *
101911
+ * @remarks
101912
+ * [Api set: PowerPointApi 1.4]
101913
+ */
101914
+ color?: string;
101915
+ /**
101916
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
101917
+ *
101918
+ * @remarks
101919
+ * [Api set: PowerPointApi 1.4]
101920
+ */
101921
+ italic?: boolean;
101922
+ /**
101923
+ * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
101924
+ *
101925
+ * @remarks
101926
+ * [Api set: PowerPointApi 1.4]
101927
+ */
101928
+ name?: string;
101929
+ /**
101930
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
101931
+ *
101932
+ * @remarks
101933
+ * [Api set: PowerPointApi 1.4]
101934
+ */
101935
+ size?: number;
101936
+ /**
101937
+ * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
101938
+ *
101939
+ * @remarks
101940
+ * [Api set: PowerPointApi 1.4]
101941
+ */
101942
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
101943
+ }
101944
+ /** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
101945
+ interface TextRangeUpdateData {
101946
+ /**
101947
+ * Represents the plain text content of the text range.
101948
+ *
101949
+ * @remarks
101950
+ * [Api set: PowerPointApi 1.4]
101951
+ */
101952
+ text?: string;
101953
+ }
101954
+ /** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */
101955
+ interface TextFrameUpdateData {
101956
+ /**
101957
+ * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
101958
+ *
101959
+ * @remarks
101960
+ * [Api set: PowerPointApi 1.4]
101961
+ */
101962
+ autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
101963
+ /**
101964
+ * Represents the bottom margin, in points, of the text frame.
101965
+ *
101966
+ * @remarks
101967
+ * [Api set: PowerPointApi 1.4]
101968
+ */
101969
+ bottomMargin?: number;
101970
+ /**
101971
+ * Represents the left margin, in points, of the text frame.
101972
+ *
101973
+ * @remarks
101974
+ * [Api set: PowerPointApi 1.4]
101975
+ */
101976
+ leftMargin?: number;
101977
+ /**
101978
+ * Represents the right margin, in points, of the text frame.
101979
+ *
101980
+ * @remarks
101981
+ * [Api set: PowerPointApi 1.4]
101982
+ */
101983
+ rightMargin?: number;
101984
+ /**
101985
+ * Represents the top margin, in points, of the text frame.
101986
+ *
101987
+ * @remarks
101988
+ * [Api set: PowerPointApi 1.4]
101989
+ */
101990
+ topMargin?: number;
101991
+ /**
101992
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
101993
+ *
101994
+ * @remarks
101995
+ * [Api set: PowerPointApi 1.4]
101996
+ */
101997
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
101998
+ /**
101999
+ * Determines whether lines break automatically to fit text inside the shape.
102000
+ *
102001
+ * @remarks
102002
+ * [Api set: PowerPointApi 1.4]
102003
+ */
102004
+ wordWrap?: boolean;
102005
+ }
102006
+ /** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
102007
+ interface ShapeUpdateData {
102008
+ /**
102009
+ * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102010
+ *
102011
+ * @remarks
102012
+ * [Api set: PowerPointApi 1.4]
102013
+ */
102014
+ height?: number;
102015
+ /**
102016
+ * The distance, in points, from the left side of the shape to the left side of the slide.
102017
+ *
102018
+ * @remarks
102019
+ * [Api set: PowerPointApi 1.4]
102020
+ */
102021
+ left?: number;
102022
+ /**
102023
+ * Specifies the name of this shape.
102024
+ *
102025
+ * @remarks
102026
+ * [Api set: PowerPointApi 1.4]
102027
+ */
102028
+ name?: string;
102029
+ /**
102030
+ * The distance, in points, from the top edge of the shape to the top edge of the slide.
102031
+ *
102032
+ * @remarks
102033
+ * [Api set: PowerPointApi 1.4]
102034
+ */
102035
+ top?: number;
102036
+ /**
102037
+ * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
99612
102038
  *
99613
102039
  * @remarks
99614
- * [Api set: PowerPointApi 1.3]
102040
+ * [Api set: PowerPointApi 1.4]
99615
102041
  */
99616
- value?: string;
99617
- }
99618
- /** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
99619
- interface TagCollectionUpdateData {
99620
- items?: PowerPoint.Interfaces.TagData[];
102042
+ width?: number;
99621
102043
  }
99622
102044
  /** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
99623
102045
  interface SlideCollectionUpdateData {
@@ -99631,6 +102053,26 @@ declare namespace PowerPoint {
99631
102053
  interface PresentationData {
99632
102054
  title?: string;
99633
102055
  }
102056
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
102057
+ interface BulletFormatData {
102058
+ /**
102059
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
102060
+ *
102061
+ * @remarks
102062
+ * [Api set: PowerPointApi 1.4]
102063
+ */
102064
+ visible?: boolean;
102065
+ }
102066
+ /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
102067
+ interface ParagraphFormatData {
102068
+ /**
102069
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
102070
+ *
102071
+ * @remarks
102072
+ * [Api set: PowerPointApi 1.4]
102073
+ */
102074
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
102075
+ }
99634
102076
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
99635
102077
  interface ShapeCollectionData {
99636
102078
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -99704,8 +102146,198 @@ declare namespace PowerPoint {
99704
102146
  */
99705
102147
  id?: string;
99706
102148
  }
102149
+ /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
102150
+ interface ShapeFillData {
102151
+ /**
102152
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
102153
+ *
102154
+ * @remarks
102155
+ * [Api set: PowerPointApi 1.4]
102156
+ */
102157
+ foregroundColor?: string;
102158
+ /**
102159
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
102160
+ *
102161
+ * @remarks
102162
+ * [Api set: PowerPointApi 1.4]
102163
+ */
102164
+ transparency?: number;
102165
+ /**
102166
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
102167
+ *
102168
+ * @remarks
102169
+ * [Api set: PowerPointApi 1.4]
102170
+ */
102171
+ type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
102172
+ }
102173
+ /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
102174
+ interface ShapeLineFormatData {
102175
+ /**
102176
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
102177
+ *
102178
+ * @remarks
102179
+ * [Api set: PowerPointApi 1.4]
102180
+ */
102181
+ color?: string;
102182
+ /**
102183
+ * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
102184
+ *
102185
+ * @remarks
102186
+ * [Api set: PowerPointApi 1.4]
102187
+ */
102188
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
102189
+ /**
102190
+ * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
102191
+ *
102192
+ * @remarks
102193
+ * [Api set: PowerPointApi 1.4]
102194
+ */
102195
+ style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
102196
+ /**
102197
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
102198
+ *
102199
+ * @remarks
102200
+ * [Api set: PowerPointApi 1.4]
102201
+ */
102202
+ transparency?: number;
102203
+ /**
102204
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
102205
+ *
102206
+ * @remarks
102207
+ * [Api set: PowerPointApi 1.4]
102208
+ */
102209
+ visible?: boolean;
102210
+ /**
102211
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
102212
+ *
102213
+ * @remarks
102214
+ * [Api set: PowerPointApi 1.4]
102215
+ */
102216
+ weight?: number;
102217
+ }
102218
+ /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
102219
+ interface ShapeFontData {
102220
+ /**
102221
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
102222
+ *
102223
+ * @remarks
102224
+ * [Api set: PowerPointApi 1.4]
102225
+ */
102226
+ bold?: boolean;
102227
+ /**
102228
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
102229
+ *
102230
+ * @remarks
102231
+ * [Api set: PowerPointApi 1.4]
102232
+ */
102233
+ color?: string;
102234
+ /**
102235
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
102236
+ *
102237
+ * @remarks
102238
+ * [Api set: PowerPointApi 1.4]
102239
+ */
102240
+ italic?: boolean;
102241
+ /**
102242
+ * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
102243
+ *
102244
+ * @remarks
102245
+ * [Api set: PowerPointApi 1.4]
102246
+ */
102247
+ name?: string;
102248
+ /**
102249
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
102250
+ *
102251
+ * @remarks
102252
+ * [Api set: PowerPointApi 1.4]
102253
+ */
102254
+ size?: number;
102255
+ /**
102256
+ * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
102257
+ *
102258
+ * @remarks
102259
+ * [Api set: PowerPointApi 1.4]
102260
+ */
102261
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
102262
+ }
102263
+ /** An interface describing the data returned by calling `textRange.toJSON()`. */
102264
+ interface TextRangeData {
102265
+ /**
102266
+ * Represents the plain text content of the text range.
102267
+ *
102268
+ * @remarks
102269
+ * [Api set: PowerPointApi 1.4]
102270
+ */
102271
+ text?: string;
102272
+ }
102273
+ /** An interface describing the data returned by calling `textFrame.toJSON()`. */
102274
+ interface TextFrameData {
102275
+ /**
102276
+ * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
102277
+ *
102278
+ * @remarks
102279
+ * [Api set: PowerPointApi 1.4]
102280
+ */
102281
+ autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
102282
+ /**
102283
+ * Represents the bottom margin, in points, of the text frame.
102284
+ *
102285
+ * @remarks
102286
+ * [Api set: PowerPointApi 1.4]
102287
+ */
102288
+ bottomMargin?: number;
102289
+ /**
102290
+ * Specifies if the text frame contains text.
102291
+ *
102292
+ * @remarks
102293
+ * [Api set: PowerPointApi 1.4]
102294
+ */
102295
+ hasText?: boolean;
102296
+ /**
102297
+ * Represents the left margin, in points, of the text frame.
102298
+ *
102299
+ * @remarks
102300
+ * [Api set: PowerPointApi 1.4]
102301
+ */
102302
+ leftMargin?: number;
102303
+ /**
102304
+ * Represents the right margin, in points, of the text frame.
102305
+ *
102306
+ * @remarks
102307
+ * [Api set: PowerPointApi 1.4]
102308
+ */
102309
+ rightMargin?: number;
102310
+ /**
102311
+ * Represents the top margin, in points, of the text frame.
102312
+ *
102313
+ * @remarks
102314
+ * [Api set: PowerPointApi 1.4]
102315
+ */
102316
+ topMargin?: number;
102317
+ /**
102318
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
102319
+ *
102320
+ * @remarks
102321
+ * [Api set: PowerPointApi 1.4]
102322
+ */
102323
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
102324
+ /**
102325
+ * Determines whether lines break automatically to fit text inside the shape.
102326
+ *
102327
+ * @remarks
102328
+ * [Api set: PowerPointApi 1.4]
102329
+ */
102330
+ wordWrap?: boolean;
102331
+ }
99707
102332
  /** An interface describing the data returned by calling `shape.toJSON()`. */
99708
102333
  interface ShapeData {
102334
+ /**
102335
+ * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102336
+ *
102337
+ * @remarks
102338
+ * [Api set: PowerPointApi 1.4]
102339
+ */
102340
+ height?: number;
99709
102341
  /**
99710
102342
  * Gets the unique ID of the shape.
99711
102343
  *
@@ -99713,6 +102345,41 @@ declare namespace PowerPoint {
99713
102345
  * [Api set: PowerPointApi 1.3]
99714
102346
  */
99715
102347
  id?: string;
102348
+ /**
102349
+ * The distance, in points, from the left side of the shape to the left side of the slide.
102350
+ *
102351
+ * @remarks
102352
+ * [Api set: PowerPointApi 1.4]
102353
+ */
102354
+ left?: number;
102355
+ /**
102356
+ * Specifies the name of this shape.
102357
+ *
102358
+ * @remarks
102359
+ * [Api set: PowerPointApi 1.4]
102360
+ */
102361
+ name?: string;
102362
+ /**
102363
+ * The distance, in points, from the top edge of the shape to the top edge of the slide.
102364
+ *
102365
+ * @remarks
102366
+ * [Api set: PowerPointApi 1.4]
102367
+ */
102368
+ top?: number;
102369
+ /**
102370
+ * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
102371
+ *
102372
+ * @remarks
102373
+ * [Api set: PowerPointApi 1.4]
102374
+ */
102375
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
102376
+ /**
102377
+ * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102378
+ *
102379
+ * @remarks
102380
+ * [Api set: PowerPointApi 1.4]
102381
+ */
102382
+ width?: number;
99716
102383
  }
99717
102384
  /** An interface describing the data returned by calling `slideCollection.toJSON()`. */
99718
102385
  interface SlideCollectionData {
@@ -99733,6 +102400,51 @@ declare namespace PowerPoint {
99733
102400
  $all?: boolean;
99734
102401
  title?: boolean;
99735
102402
  }
102403
+ /**
102404
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
102405
+ *
102406
+ * @remarks
102407
+ * [Api set: PowerPointApi 1.4]
102408
+ */
102409
+ interface BulletFormatLoadOptions {
102410
+ /**
102411
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102412
+ */
102413
+ $all?: boolean;
102414
+ /**
102415
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
102416
+ *
102417
+ * @remarks
102418
+ * [Api set: PowerPointApi 1.4]
102419
+ */
102420
+ visible?: boolean;
102421
+ }
102422
+ /**
102423
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
102424
+ *
102425
+ * @remarks
102426
+ * [Api set: PowerPointApi 1.4]
102427
+ */
102428
+ interface ParagraphFormatLoadOptions {
102429
+ /**
102430
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102431
+ */
102432
+ $all?: boolean;
102433
+ /**
102434
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
102435
+ *
102436
+ * @remarks
102437
+ * [Api set: PowerPointApi 1.4]
102438
+ */
102439
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
102440
+ /**
102441
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
102442
+ *
102443
+ * @remarks
102444
+ * [Api set: PowerPointApi 1.4]
102445
+ */
102446
+ horizontalAlignment?: boolean;
102447
+ }
99736
102448
  /**
99737
102449
  * Represents the collection of shapes.
99738
102450
  *
@@ -99744,6 +102456,34 @@ declare namespace PowerPoint {
99744
102456
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
99745
102457
  */
99746
102458
  $all?: boolean;
102459
+ /**
102460
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
102461
+ *
102462
+ * @remarks
102463
+ * [Api set: PowerPointApi 1.4]
102464
+ */
102465
+ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
102466
+ /**
102467
+ * For EACH ITEM in the collection: Returns the line formatting of this shape.
102468
+ *
102469
+ * @remarks
102470
+ * [Api set: PowerPointApi 1.4]
102471
+ */
102472
+ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
102473
+ /**
102474
+ * For EACH ITEM in the collection: Returns the text frame object of this shape.
102475
+ *
102476
+ * @remarks
102477
+ * [Api set: PowerPointApi 1.4]
102478
+ */
102479
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
102480
+ /**
102481
+ * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102482
+ *
102483
+ * @remarks
102484
+ * [Api set: PowerPointApi 1.4]
102485
+ */
102486
+ height?: boolean;
99747
102487
  /**
99748
102488
  * For EACH ITEM in the collection: Gets the unique ID of the shape.
99749
102489
  *
@@ -99751,6 +102491,41 @@ declare namespace PowerPoint {
99751
102491
  * [Api set: PowerPointApi 1.3]
99752
102492
  */
99753
102493
  id?: boolean;
102494
+ /**
102495
+ * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
102496
+ *
102497
+ * @remarks
102498
+ * [Api set: PowerPointApi 1.4]
102499
+ */
102500
+ left?: boolean;
102501
+ /**
102502
+ * For EACH ITEM in the collection: Specifies the name of this shape.
102503
+ *
102504
+ * @remarks
102505
+ * [Api set: PowerPointApi 1.4]
102506
+ */
102507
+ name?: boolean;
102508
+ /**
102509
+ * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
102510
+ *
102511
+ * @remarks
102512
+ * [Api set: PowerPointApi 1.4]
102513
+ */
102514
+ top?: boolean;
102515
+ /**
102516
+ * For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
102517
+ *
102518
+ * @remarks
102519
+ * [Api set: PowerPointApi 1.4]
102520
+ */
102521
+ type?: boolean;
102522
+ /**
102523
+ * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102524
+ *
102525
+ * @remarks
102526
+ * [Api set: PowerPointApi 1.4]
102527
+ */
102528
+ width?: boolean;
99754
102529
  }
99755
102530
  /**
99756
102531
  * Represents the layout of a slide.
@@ -99915,6 +102690,255 @@ declare namespace PowerPoint {
99915
102690
  */
99916
102691
  id?: boolean;
99917
102692
  }
102693
+ /**
102694
+ * Represents the fill formatting of a shape object.
102695
+ *
102696
+ * @remarks
102697
+ * [Api set: PowerPointApi 1.4]
102698
+ */
102699
+ interface ShapeFillLoadOptions {
102700
+ /**
102701
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102702
+ */
102703
+ $all?: boolean;
102704
+ /**
102705
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
102706
+ *
102707
+ * @remarks
102708
+ * [Api set: PowerPointApi 1.4]
102709
+ */
102710
+ foregroundColor?: boolean;
102711
+ /**
102712
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
102713
+ *
102714
+ * @remarks
102715
+ * [Api set: PowerPointApi 1.4]
102716
+ */
102717
+ transparency?: boolean;
102718
+ /**
102719
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
102720
+ *
102721
+ * @remarks
102722
+ * [Api set: PowerPointApi 1.4]
102723
+ */
102724
+ type?: boolean;
102725
+ }
102726
+ /**
102727
+ * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
102728
+ *
102729
+ * @remarks
102730
+ * [Api set: PowerPointApi 1.4]
102731
+ */
102732
+ interface ShapeLineFormatLoadOptions {
102733
+ /**
102734
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102735
+ */
102736
+ $all?: boolean;
102737
+ /**
102738
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
102739
+ *
102740
+ * @remarks
102741
+ * [Api set: PowerPointApi 1.4]
102742
+ */
102743
+ color?: boolean;
102744
+ /**
102745
+ * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
102746
+ *
102747
+ * @remarks
102748
+ * [Api set: PowerPointApi 1.4]
102749
+ */
102750
+ dashStyle?: boolean;
102751
+ /**
102752
+ * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
102753
+ *
102754
+ * @remarks
102755
+ * [Api set: PowerPointApi 1.4]
102756
+ */
102757
+ style?: boolean;
102758
+ /**
102759
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
102760
+ *
102761
+ * @remarks
102762
+ * [Api set: PowerPointApi 1.4]
102763
+ */
102764
+ transparency?: boolean;
102765
+ /**
102766
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
102767
+ *
102768
+ * @remarks
102769
+ * [Api set: PowerPointApi 1.4]
102770
+ */
102771
+ visible?: boolean;
102772
+ /**
102773
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
102774
+ *
102775
+ * @remarks
102776
+ * [Api set: PowerPointApi 1.4]
102777
+ */
102778
+ weight?: boolean;
102779
+ }
102780
+ /**
102781
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
102782
+ *
102783
+ * @remarks
102784
+ * [Api set: PowerPointApi 1.4]
102785
+ */
102786
+ interface ShapeFontLoadOptions {
102787
+ /**
102788
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102789
+ */
102790
+ $all?: boolean;
102791
+ /**
102792
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
102793
+ *
102794
+ * @remarks
102795
+ * [Api set: PowerPointApi 1.4]
102796
+ */
102797
+ bold?: boolean;
102798
+ /**
102799
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
102800
+ *
102801
+ * @remarks
102802
+ * [Api set: PowerPointApi 1.4]
102803
+ */
102804
+ color?: boolean;
102805
+ /**
102806
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
102807
+ *
102808
+ * @remarks
102809
+ * [Api set: PowerPointApi 1.4]
102810
+ */
102811
+ italic?: boolean;
102812
+ /**
102813
+ * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
102814
+ *
102815
+ * @remarks
102816
+ * [Api set: PowerPointApi 1.4]
102817
+ */
102818
+ name?: boolean;
102819
+ /**
102820
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
102821
+ *
102822
+ * @remarks
102823
+ * [Api set: PowerPointApi 1.4]
102824
+ */
102825
+ size?: boolean;
102826
+ /**
102827
+ * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
102828
+ *
102829
+ * @remarks
102830
+ * [Api set: PowerPointApi 1.4]
102831
+ */
102832
+ underline?: boolean;
102833
+ }
102834
+ /**
102835
+ * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
102836
+ *
102837
+ * @remarks
102838
+ * [Api set: PowerPointApi 1.4]
102839
+ */
102840
+ interface TextRangeLoadOptions {
102841
+ /**
102842
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102843
+ */
102844
+ $all?: boolean;
102845
+ /**
102846
+ * Returns a `ShapeFont` object that represents the font attributes for the text range.
102847
+ *
102848
+ * @remarks
102849
+ * [Api set: PowerPointApi 1.4]
102850
+ */
102851
+ font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
102852
+ /**
102853
+ * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
102854
+ *
102855
+ * @remarks
102856
+ * [Api set: PowerPointApi 1.4]
102857
+ */
102858
+ paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;
102859
+ /**
102860
+ * Represents the plain text content of the text range.
102861
+ *
102862
+ * @remarks
102863
+ * [Api set: PowerPointApi 1.4]
102864
+ */
102865
+ text?: boolean;
102866
+ }
102867
+ /**
102868
+ * Represents the text frame of a shape object.
102869
+ *
102870
+ * @remarks
102871
+ * [Api set: PowerPointApi 1.4]
102872
+ */
102873
+ interface TextFrameLoadOptions {
102874
+ /**
102875
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
102876
+ */
102877
+ $all?: boolean;
102878
+ /**
102879
+ * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details.
102880
+ *
102881
+ * @remarks
102882
+ * [Api set: PowerPointApi 1.4]
102883
+ */
102884
+ textRange?: PowerPoint.Interfaces.TextRangeLoadOptions;
102885
+ /**
102886
+ * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
102887
+ *
102888
+ * @remarks
102889
+ * [Api set: PowerPointApi 1.4]
102890
+ */
102891
+ autoSizeSetting?: boolean;
102892
+ /**
102893
+ * Represents the bottom margin, in points, of the text frame.
102894
+ *
102895
+ * @remarks
102896
+ * [Api set: PowerPointApi 1.4]
102897
+ */
102898
+ bottomMargin?: boolean;
102899
+ /**
102900
+ * Specifies if the text frame contains text.
102901
+ *
102902
+ * @remarks
102903
+ * [Api set: PowerPointApi 1.4]
102904
+ */
102905
+ hasText?: boolean;
102906
+ /**
102907
+ * Represents the left margin, in points, of the text frame.
102908
+ *
102909
+ * @remarks
102910
+ * [Api set: PowerPointApi 1.4]
102911
+ */
102912
+ leftMargin?: boolean;
102913
+ /**
102914
+ * Represents the right margin, in points, of the text frame.
102915
+ *
102916
+ * @remarks
102917
+ * [Api set: PowerPointApi 1.4]
102918
+ */
102919
+ rightMargin?: boolean;
102920
+ /**
102921
+ * Represents the top margin, in points, of the text frame.
102922
+ *
102923
+ * @remarks
102924
+ * [Api set: PowerPointApi 1.4]
102925
+ */
102926
+ topMargin?: boolean;
102927
+ /**
102928
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
102929
+ *
102930
+ * @remarks
102931
+ * [Api set: PowerPointApi 1.4]
102932
+ */
102933
+ verticalAlignment?: boolean;
102934
+ /**
102935
+ * Determines whether lines break automatically to fit text inside the shape.
102936
+ *
102937
+ * @remarks
102938
+ * [Api set: PowerPointApi 1.4]
102939
+ */
102940
+ wordWrap?: boolean;
102941
+ }
99918
102942
  /**
99919
102943
  * Represents a single shape in the slide.
99920
102944
  *
@@ -99926,6 +102950,34 @@ declare namespace PowerPoint {
99926
102950
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
99927
102951
  */
99928
102952
  $all?: boolean;
102953
+ /**
102954
+ * Returns the fill formatting of this shape.
102955
+ *
102956
+ * @remarks
102957
+ * [Api set: PowerPointApi 1.4]
102958
+ */
102959
+ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
102960
+ /**
102961
+ * Returns the line formatting of this shape.
102962
+ *
102963
+ * @remarks
102964
+ * [Api set: PowerPointApi 1.4]
102965
+ */
102966
+ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
102967
+ /**
102968
+ * Returns the text frame object of this shape.
102969
+ *
102970
+ * @remarks
102971
+ * [Api set: PowerPointApi 1.4]
102972
+ */
102973
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
102974
+ /**
102975
+ * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
102976
+ *
102977
+ * @remarks
102978
+ * [Api set: PowerPointApi 1.4]
102979
+ */
102980
+ height?: boolean;
99929
102981
  /**
99930
102982
  * Gets the unique ID of the shape.
99931
102983
  *
@@ -99933,6 +102985,41 @@ declare namespace PowerPoint {
99933
102985
  * [Api set: PowerPointApi 1.3]
99934
102986
  */
99935
102987
  id?: boolean;
102988
+ /**
102989
+ * The distance, in points, from the left side of the shape to the left side of the slide.
102990
+ *
102991
+ * @remarks
102992
+ * [Api set: PowerPointApi 1.4]
102993
+ */
102994
+ left?: boolean;
102995
+ /**
102996
+ * Specifies the name of this shape.
102997
+ *
102998
+ * @remarks
102999
+ * [Api set: PowerPointApi 1.4]
103000
+ */
103001
+ name?: boolean;
103002
+ /**
103003
+ * The distance, in points, from the top edge of the shape to the top edge of the slide.
103004
+ *
103005
+ * @remarks
103006
+ * [Api set: PowerPointApi 1.4]
103007
+ */
103008
+ top?: boolean;
103009
+ /**
103010
+ * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
103011
+ *
103012
+ * @remarks
103013
+ * [Api set: PowerPointApi 1.4]
103014
+ */
103015
+ type?: boolean;
103016
+ /**
103017
+ * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
103018
+ *
103019
+ * @remarks
103020
+ * [Api set: PowerPointApi 1.4]
103021
+ */
103022
+ width?: boolean;
99936
103023
  }
99937
103024
  /**
99938
103025
  * Represents the collection of slides in the presentation.