@types/office-js-preview 1.0.299 → 1.0.302

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.
@@ -1965,7 +1965,7 @@ declare namespace Office {
1965
1965
  *
1966
1966
  * **Hosts**: Excel, Outlook (in preview), PowerPoint, Word
1967
1967
  *
1968
- * `OfficeTheme` is only supported in Office on Windows.
1968
+ * `OfficeTheme` is only supported in Office on Windows, Mac, and the web.
1969
1969
  */
1970
1970
  interface OfficeTheme {
1971
1971
  /**
@@ -15589,7 +15589,7 @@ declare namespace Office {
15589
15589
  *
15590
15590
  * 3. The delegate opens the draft from the shared folder then continues composing.
15591
15591
  *
15592
- * b. **Shared mailbox**
15592
+ * b. **Shared mailbox (applies to Outlook on Windows only)**
15593
15593
  *
15594
15594
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
15595
15595
  *
@@ -15631,7 +15631,7 @@ declare namespace Office {
15631
15631
  *
15632
15632
  * 3. The delegate opens the draft from the shared folder then continues composing.
15633
15633
  *
15634
- * b. **Shared mailbox**
15634
+ * b. **Shared mailbox (applies to Outlook on Windows only)**
15635
15635
  *
15636
15636
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
15637
15637
  *
@@ -109179,6 +109179,43 @@ declare namespace PowerPoint {
109179
109179
  */
109180
109180
  readonly tags: PowerPoint.TagCollection;
109181
109181
  readonly title: string;
109182
+ /**
109183
+ * Returns the selected shapes in the current slide of the presentation.
109184
+ If no shapes are selected, an empty collection is returned.
109185
+ *
109186
+ * @remarks
109187
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
109188
+ * @beta
109189
+ */
109190
+ getSelectedShapes(): PowerPoint.ShapeScopedCollection;
109191
+ /**
109192
+ * Returns the selected slides in the current view of the presentation.
109193
+ The first item in the collection is the active slide that is visible in the editing area.
109194
+ If no slides are selected, an empty collection is returned.
109195
+ *
109196
+ * @remarks
109197
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
109198
+ * @beta
109199
+ */
109200
+ getSelectedSlides(): PowerPoint.SlideScopedCollection;
109201
+ /**
109202
+ * Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
109203
+ Throws an exception if no text is selected.
109204
+ *
109205
+ * @remarks
109206
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
109207
+ * @beta
109208
+ */
109209
+ getSelectedTextRange(): PowerPoint.TextRange;
109210
+ /**
109211
+ * Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
109212
+ If no text is selected, an object with an `isNullObject` property set to `true` is returned.
109213
+ *
109214
+ * @remarks
109215
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
109216
+ * @beta
109217
+ */
109218
+ getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;
109182
109219
  /**
109183
109220
  * Inserts the specified slides from a presentation into the current presentation.
109184
109221
  *
@@ -109189,6 +109226,16 @@ declare namespace PowerPoint {
109189
109226
  * @param options The options that define which slides will be inserted, where the new slides will go, and which presentation's formatting will be used.
109190
109227
  */
109191
109228
  insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void;
109229
+ /**
109230
+ * Selects the slides in the current view of the presentation. Existing slide selection is replaced with the new selection.
109231
+ *
109232
+ * @remarks
109233
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
109234
+ * @beta
109235
+ *
109236
+ * @param slideIds List of slide IDs to select in the presentation. If the list is empty, selection is cleared.
109237
+ */
109238
+ setSelectedSlides(slideIds: string[]): void;
109192
109239
  /**
109193
109240
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
109194
109241
  *
@@ -110733,342 +110780,365 @@ declare namespace PowerPoint {
110733
110780
  toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
110734
110781
  }
110735
110782
  /**
110736
- * Specifies a shape's fill type.
110783
+ * Represents the available options when adding shapes.
110737
110784
  *
110738
110785
  * @remarks
110739
110786
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110740
110787
  * @beta
110741
110788
  */
110742
- enum ShapeFillType {
110743
- /**
110744
- * Specifies that the shape should have no fill.
110745
- * @remarks
110746
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110747
- * @beta
110748
- */
110749
- noFill = "NoFill",
110750
- /**
110751
- * Specifies that the shape should have regular solid fill.
110752
- * @remarks
110753
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110754
- * @beta
110755
- */
110756
- solid = "Solid",
110789
+ interface ShapeAddOptions {
110757
110790
  /**
110758
- * Specifies that the shape should have gradient fill.
110791
+ * Specifies the height, in points, of the shape.
110792
+ When not provided, a default value will be used.
110793
+ Throws an `InvalidArgument` exception when set with a negative value.
110794
+ *
110759
110795
  * @remarks
110760
110796
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110761
110797
  * @beta
110762
110798
  */
110763
- gradient = "Gradient",
110799
+ height?: number;
110764
110800
  /**
110765
- * Specifies that the shape should have pattern fill.
110801
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
110802
+ When not provided, a default value will be used.
110803
+ *
110766
110804
  * @remarks
110767
110805
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110768
110806
  * @beta
110769
110807
  */
110770
- pattern = "Pattern",
110808
+ left?: number;
110771
110809
  /**
110772
- * Specifies that the shape should have picture or texture fill.
110810
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
110811
+ When not provided, a default value will be used.
110812
+ *
110773
110813
  * @remarks
110774
110814
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110775
110815
  * @beta
110776
110816
  */
110777
- pictureAndTexture = "PictureAndTexture",
110817
+ top?: number;
110778
110818
  /**
110779
- * Specifies that the shape should have slide background fill.
110819
+ * Specifies the width, in points, of the shape.
110820
+ When not provided, a default value will be used.
110821
+ Throws an `InvalidArgument` exception when set with a negative value.
110822
+ *
110780
110823
  * @remarks
110781
110824
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110782
110825
  * @beta
110783
110826
  */
110784
- slideBackground = "SlideBackground",
110827
+ width?: number;
110785
110828
  }
110786
110829
  /**
110787
- * Represents the fill formatting of a shape object.
110830
+ * Represents the collection of shapes.
110788
110831
  *
110789
110832
  * @remarks
110790
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110791
- * @beta
110833
+ * [Api set: PowerPointApi 1.3]
110792
110834
  */
110793
- class ShapeFill extends OfficeExtension.ClientObject {
110835
+ class ShapeCollection extends OfficeExtension.ClientObject {
110794
110836
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
110795
110837
  context: RequestContext;
110838
+ /** Gets the loaded child items in this collection. */
110839
+ readonly items: PowerPoint.Shape[];
110796
110840
  /**
110797
- * 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").
110841
+ * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
110798
110842
  *
110799
110843
  * @remarks
110800
110844
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110801
110845
  * @beta
110846
+ *
110847
+ * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
110848
+ * @param options An optional parameter to specify the additional options such as the position of the shape.
110849
+ * @returns The newly inserted shape.
110802
110850
  */
110803
- foregroundColor: string;
110851
+ addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
110804
110852
  /**
110805
- * 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.
110853
+ * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
110806
110854
  *
110807
110855
  * @remarks
110808
110856
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110809
110857
  * @beta
110858
+ *
110859
+ * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
110860
+ * @param options An optional parameter to specify the additional options such as the position of the shape.
110861
+ * @returns The newly inserted shape.
110810
110862
  */
110811
- transparency: number;
110863
+ 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;
110812
110864
  /**
110813
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
110865
+ * Adds a line to the slide. Returns a `Shape` object that represents the new line.
110814
110866
  *
110815
110867
  * @remarks
110816
110868
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110817
110869
  * @beta
110870
+ *
110871
+ * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
110872
+ * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
110873
+ * @returns The newly inserted shape.
110818
110874
  */
110819
- readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
110875
+ addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
110820
110876
  /**
110821
- * Clears the fill formatting of this shape.
110877
+ * Adds a line to the slide. Returns a `Shape` object that represents the new line.
110822
110878
  *
110823
110879
  * @remarks
110824
110880
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110825
110881
  * @beta
110882
+ *
110883
+ * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
110884
+ * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
110885
+ * @returns The newly inserted shape.
110826
110886
  */
110827
- clear(): void;
110887
+ addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
110828
110888
  /**
110829
- * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
110889
+ * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
110830
110890
  *
110831
110891
  * @remarks
110832
110892
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110833
110893
  * @beta
110834
110894
  *
110835
- * @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").
110895
+ * @param text Specifies the text that will be shown in the created text box.
110896
+ * @param options An optional parameter to specify the additional options such as the position of the text box.
110897
+ * @returns The newly inserted shape.
110836
110898
  */
110837
- setSolidColor(color: string): void;
110899
+ addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
110900
+ /**
110901
+ * Gets the number of shapes in the collection.
110902
+ *
110903
+ * @remarks
110904
+ * [Api set: PowerPointApi 1.3]
110905
+ * @returns The number of shapes in the collection.
110906
+ */
110907
+ getCount(): OfficeExtension.ClientResult<number>;
110908
+ /**
110909
+ * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
110910
+ *
110911
+ * @remarks
110912
+ * [Api set: PowerPointApi 1.3]
110913
+ *
110914
+ * @param key The ID of the shape.
110915
+ * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
110916
+ */
110917
+ getItem(key: string): PowerPoint.Shape;
110918
+ /**
110919
+ * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
110920
+ *
110921
+ * @remarks
110922
+ * [Api set: PowerPointApi 1.3]
110923
+ *
110924
+ * @param index The index of the shape in the collection.
110925
+ * @returns The shape at the given index. An error is thrown if index is out of range.
110926
+ */
110927
+ getItemAt(index: number): PowerPoint.Shape;
110928
+ /**
110929
+ * 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.
110930
+ *
110931
+ * @remarks
110932
+ * [Api set: PowerPointApi 1.3]
110933
+ *
110934
+ * @param id The ID of the shape.
110935
+ * @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.
110936
+ */
110937
+ getItemOrNullObject(id: string): PowerPoint.Shape;
110838
110938
  /**
110839
110939
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
110840
110940
  *
110841
110941
  * @param options Provides options for which properties of the object to load.
110842
110942
  */
110843
- load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
110943
+ load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
110844
110944
  /**
110845
110945
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
110846
110946
  *
110847
110947
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
110848
110948
  */
110849
- load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
110949
+ load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
110850
110950
  /**
110851
110951
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
110852
110952
  *
110853
110953
  * @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.
110854
110954
  */
110855
- load(propertyNamesAndPaths?: {
110856
- select?: string;
110857
- expand?: string;
110858
- }): PowerPoint.ShapeFill;
110955
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
110859
110956
  /**
110860
110957
  * 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.)
110861
- * 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.
110958
+ * 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.
110862
110959
  */
110863
- toJSON(): PowerPoint.Interfaces.ShapeFillData;
110960
+ toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
110864
110961
  }
110865
110962
  /**
110866
- * Specifies the style for a line.
110963
+ * Represents the layout of a slide.
110867
110964
  *
110868
110965
  * @remarks
110869
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110870
- * @beta
110966
+ * [Api set: PowerPointApi 1.3]
110871
110967
  */
110872
- enum ShapeLineStyle {
110968
+ class SlideLayout extends OfficeExtension.ClientObject {
110969
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
110970
+ context: RequestContext;
110873
110971
  /**
110874
- * Single line.
110972
+ * Returns a collection of shapes in the slide layout.
110973
+ *
110875
110974
  * @remarks
110876
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110877
- * @beta
110975
+ * [Api set: PowerPointApi 1.3]
110878
110976
  */
110879
- single = "Single",
110977
+ readonly shapes: PowerPoint.ShapeCollection;
110880
110978
  /**
110881
- * Thick line with a thin line on each side.
110979
+ * Gets the unique ID of the slide layout.
110980
+ *
110882
110981
  * @remarks
110883
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110884
- * @beta
110982
+ * [Api set: PowerPointApi 1.3]
110885
110983
  */
110886
- thickBetweenThin = "ThickBetweenThin",
110984
+ readonly id: string;
110887
110985
  /**
110888
- * 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.
110986
+ * Gets the name of the slide layout.
110987
+ *
110889
110988
  * @remarks
110890
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110891
- * @beta
110989
+ * [Api set: PowerPointApi 1.3]
110892
110990
  */
110893
- thickThin = "ThickThin",
110991
+ readonly name: string;
110894
110992
  /**
110895
- * 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.
110896
- * @remarks
110897
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110898
- * @beta
110993
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
110994
+ *
110995
+ * @param options Provides options for which properties of the object to load.
110899
110996
  */
110900
- thinThick = "ThinThick",
110997
+ load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
110901
110998
  /**
110902
- * Two thin lines.
110903
- * @remarks
110904
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110905
- * @beta
110999
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111000
+ *
111001
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
110906
111002
  */
110907
- thinThin = "ThinThin",
111003
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
111004
+ /**
111005
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111006
+ *
111007
+ * @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.
111008
+ */
111009
+ load(propertyNamesAndPaths?: {
111010
+ select?: string;
111011
+ expand?: string;
111012
+ }): PowerPoint.SlideLayout;
111013
+ /**
111014
+ * 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.)
111015
+ * 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.
111016
+ */
111017
+ toJSON(): PowerPoint.Interfaces.SlideLayoutData;
110908
111018
  }
110909
111019
  /**
110910
- * Specifies the dash style for a line.
111020
+ * Represents the collection of layouts provided by the Slide Master for slides.
110911
111021
  *
110912
111022
  * @remarks
110913
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110914
- * @beta
111023
+ * [Api set: PowerPointApi 1.3]
110915
111024
  */
110916
- enum ShapeLineDashStyle {
110917
- /**
110918
- * The dash line pattern
110919
- * @remarks
110920
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110921
- * @beta
110922
- */
110923
- dash = "Dash",
110924
- /**
110925
- * The dash-dot line pattern
110926
- * @remarks
110927
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110928
- * @beta
110929
- */
110930
- dashDot = "DashDot",
110931
- /**
110932
- * The dash-dot-dot line pattern
110933
- * @remarks
110934
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110935
- * @beta
110936
- */
110937
- dashDotDot = "DashDotDot",
110938
- /**
110939
- * The long dash line pattern
110940
- * @remarks
110941
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110942
- * @beta
110943
- */
110944
- longDash = "LongDash",
111025
+ class SlideLayoutCollection extends OfficeExtension.ClientObject {
111026
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111027
+ context: RequestContext;
111028
+ /** Gets the loaded child items in this collection. */
111029
+ readonly items: PowerPoint.SlideLayout[];
110945
111030
  /**
110946
- * The long dash-dot line pattern
111031
+ * Gets the number of layouts in the collection.
111032
+ *
110947
111033
  * @remarks
110948
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110949
- * @beta
111034
+ * [Api set: PowerPointApi 1.3]
111035
+ * @returns The number of layouts in the collection.
110950
111036
  */
110951
- longDashDot = "LongDashDot",
111037
+ getCount(): OfficeExtension.ClientResult<number>;
110952
111038
  /**
110953
- * The round dot line pattern
111039
+ * Gets a layout using its unique ID.
111040
+ *
110954
111041
  * @remarks
110955
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110956
- * @beta
111042
+ * [Api set: PowerPointApi 1.3]
111043
+ *
111044
+ * @param key The ID of the layout.
111045
+ * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
110957
111046
  */
110958
- roundDot = "RoundDot",
111047
+ getItem(key: string): PowerPoint.SlideLayout;
110959
111048
  /**
110960
- * The solid line pattern
111049
+ * Gets a layout using its zero-based index in the collection.
111050
+ *
110961
111051
  * @remarks
110962
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110963
- * @beta
111052
+ * [Api set: PowerPointApi 1.3]
111053
+ *
111054
+ * @param index The index of the layout in the collection.
111055
+ * @returns The layout at the given index. An error is thrown if index is out of range.
110964
111056
  */
110965
- solid = "Solid",
111057
+ getItemAt(index: number): PowerPoint.SlideLayout;
110966
111058
  /**
110967
- * The square dot line pattern
111059
+ * 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,
111060
+ see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
111061
+ *
110968
111062
  * @remarks
110969
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110970
- * @beta
111063
+ * [Api set: PowerPointApi 1.3]
111064
+ *
111065
+ * @param id The ID of the layout.
111066
+ * @returns The layout with the unique ID.
110971
111067
  */
110972
- squareDot = "SquareDot",
111068
+ getItemOrNullObject(id: string): PowerPoint.SlideLayout;
110973
111069
  /**
110974
- * The long dash-dot-dot line pattern
110975
- * @remarks
110976
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110977
- * @beta
111070
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111071
+ *
111072
+ * @param options Provides options for which properties of the object to load.
110978
111073
  */
110979
- longDashDotDot = "LongDashDotDot",
111074
+ load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
110980
111075
  /**
110981
- * The system dash line pattern
110982
- * @remarks
110983
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110984
- * @beta
111076
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111077
+ *
111078
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
110985
111079
  */
110986
- systemDash = "SystemDash",
111080
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
110987
111081
  /**
110988
- * The system dot line pattern
110989
- * @remarks
110990
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110991
- * @beta
111082
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111083
+ *
111084
+ * @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.
110992
111085
  */
110993
- systemDot = "SystemDot",
111086
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
110994
111087
  /**
110995
- * The system dash-dot line pattern
110996
- * @remarks
110997
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
110998
- * @beta
110999
- */
111000
- systemDashDot = "SystemDashDot",
111088
+ * 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.)
111089
+ * 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.
111090
+ */
111091
+ toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
111001
111092
  }
111002
111093
  /**
111003
- * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
111094
+ * Represents the Slide Master of a slide.
111004
111095
  *
111005
111096
  * @remarks
111006
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111007
- * @beta
111097
+ * [Api set: PowerPointApi 1.3]
111008
111098
  */
111009
- class ShapeLineFormat extends OfficeExtension.ClientObject {
111099
+ class SlideMaster extends OfficeExtension.ClientObject {
111010
111100
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111011
111101
  context: RequestContext;
111012
111102
  /**
111013
- * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
111014
- *
111015
- * @remarks
111016
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111017
- * @beta
111018
- */
111019
- color: string;
111020
- /**
111021
- * 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.
111022
- *
111023
- * @remarks
111024
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111025
- * @beta
111026
- */
111027
- dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
111028
- /**
111029
- * 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.
111103
+ * Gets the collection of layouts provided by the Slide Master for slides.
111030
111104
  *
111031
111105
  * @remarks
111032
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111033
- * @beta
111106
+ * [Api set: PowerPointApi 1.3]
111034
111107
  */
111035
- style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
111108
+ readonly layouts: PowerPoint.SlideLayoutCollection;
111036
111109
  /**
111037
- * 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.
111110
+ * Returns a collection of shapes in the Slide Master.
111038
111111
  *
111039
111112
  * @remarks
111040
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111041
- * @beta
111113
+ * [Api set: PowerPointApi 1.3]
111042
111114
  */
111043
- transparency: number;
111115
+ readonly shapes: PowerPoint.ShapeCollection;
111044
111116
  /**
111045
- * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
111117
+ * Gets the unique ID of the Slide Master.
111046
111118
  *
111047
111119
  * @remarks
111048
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111049
- * @beta
111120
+ * [Api set: PowerPointApi 1.3]
111050
111121
  */
111051
- visible: boolean;
111122
+ readonly id: string;
111052
111123
  /**
111053
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
111124
+ * Gets the unique name of the Slide Master.
111054
111125
  *
111055
111126
  * @remarks
111056
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111057
- * @beta
111127
+ * [Api set: PowerPointApi 1.3]
111058
111128
  */
111059
- weight: number;
111129
+ readonly name: string;
111060
111130
  /**
111061
111131
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111062
111132
  *
111063
111133
  * @param options Provides options for which properties of the object to load.
111064
111134
  */
111065
- load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;
111135
+ load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
111066
111136
  /**
111067
111137
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111068
111138
  *
111069
111139
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111070
111140
  */
111071
- load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;
111141
+ load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
111072
111142
  /**
111073
111143
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111074
111144
  *
@@ -111077,56 +111147,12 @@ declare namespace PowerPoint {
111077
111147
  load(propertyNamesAndPaths?: {
111078
111148
  select?: string;
111079
111149
  expand?: string;
111080
- }): PowerPoint.ShapeLineFormat;
111150
+ }): PowerPoint.SlideMaster;
111081
111151
  /**
111082
111152
  * 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.)
111083
- * 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.
111153
+ * 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.
111084
111154
  */
111085
- toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
111086
- }
111087
- /**
111088
- * Specifies the type of a shape.
111089
- *
111090
- * @remarks
111091
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111092
- * @beta
111093
- */
111094
- enum ShapeType {
111095
- /**
111096
- * The given shape's type is unsupported.
111097
- * @remarks
111098
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111099
- * @beta
111100
- */
111101
- unsupported = "Unsupported",
111102
- /**
111103
- * The shape is an image
111104
- * @remarks
111105
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111106
- * @beta
111107
- */
111108
- image = "Image",
111109
- /**
111110
- * The shape is a geometric shape such as rectangle
111111
- * @remarks
111112
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111113
- * @beta
111114
- */
111115
- geometricShape = "GeometricShape",
111116
- /**
111117
- * The shape is a group shape which contains sub-shapes
111118
- * @remarks
111119
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111120
- * @beta
111121
- */
111122
- group = "Group",
111123
- /**
111124
- * The shape is a line
111125
- * @remarks
111126
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111127
- * @beta
111128
- */
111129
- line = "Line",
111155
+ toJSON(): PowerPoint.Interfaces.SlideMasterData;
111130
111156
  }
111131
111157
  /**
111132
111158
  * Represents a single tag in the slide.
@@ -111271,293 +111297,430 @@ declare namespace PowerPoint {
111271
111297
  toJSON(): PowerPoint.Interfaces.TagCollectionData;
111272
111298
  }
111273
111299
  /**
111274
- * Determines the type of automatic sizing allowed.
111300
+ * Represents a single slide of a presentation.
111301
+ *
111302
+ * @remarks
111303
+ * [Api set: PowerPointApi 1.2]
111304
+ */
111305
+ class Slide extends OfficeExtension.ClientObject {
111306
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111307
+ context: RequestContext;
111308
+ /**
111309
+ * Gets the layout of the slide.
111310
+ *
111311
+ * @remarks
111312
+ * [Api set: PowerPointApi 1.3]
111313
+ */
111314
+ readonly layout: PowerPoint.SlideLayout;
111315
+ /**
111316
+ * Returns a collection of shapes in the slide.
111317
+ *
111318
+ * @remarks
111319
+ * [Api set: PowerPointApi 1.3]
111320
+ */
111321
+ readonly shapes: PowerPoint.ShapeCollection;
111322
+ /**
111323
+ * Gets the `SlideMaster` object that represents the slide's default content.
111324
+ *
111325
+ * @remarks
111326
+ * [Api set: PowerPointApi 1.3]
111327
+ */
111328
+ readonly slideMaster: PowerPoint.SlideMaster;
111329
+ /**
111330
+ * Returns a collection of tags in the slide.
111331
+ *
111332
+ * @remarks
111333
+ * [Api set: PowerPointApi 1.3]
111334
+ */
111335
+ readonly tags: PowerPoint.TagCollection;
111336
+ /**
111337
+ * Gets the unique ID of the slide.
111338
+ *
111339
+ * @remarks
111340
+ * [Api set: PowerPointApi 1.2]
111341
+ */
111342
+ readonly id: string;
111343
+ /**
111344
+ * Deletes the slide from the presentation. Does nothing if the slide does not exist.
111345
+ *
111346
+ * @remarks
111347
+ * [Api set: PowerPointApi 1.2]
111348
+ */
111349
+ delete(): void;
111350
+ /**
111351
+ * Selects the specified shapes. Existing shape selection is replaced with the new selection.
111352
+ *
111353
+ * @remarks
111354
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111355
+ * @beta
111356
+ *
111357
+ * @param shapeIds List of shape IDs to select in the slide. If the list is empty, the selection is cleared.
111358
+ */
111359
+ setSelectedShapes(shapeIds: string[]): void;
111360
+ /**
111361
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111362
+ *
111363
+ * @param options Provides options for which properties of the object to load.
111364
+ */
111365
+ load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
111366
+ /**
111367
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111368
+ *
111369
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111370
+ */
111371
+ load(propertyNames?: string | string[]): PowerPoint.Slide;
111372
+ /**
111373
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111374
+ *
111375
+ * @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.
111376
+ */
111377
+ load(propertyNamesAndPaths?: {
111378
+ select?: string;
111379
+ expand?: string;
111380
+ }): PowerPoint.Slide;
111381
+ /**
111382
+ * 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.)
111383
+ * 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.
111384
+ */
111385
+ toJSON(): PowerPoint.Interfaces.SlideData;
111386
+ }
111387
+ /**
111388
+ * Specifies a shape's fill type.
111275
111389
  *
111276
111390
  * @remarks
111277
111391
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111278
111392
  * @beta
111279
111393
  */
111280
- enum ShapeAutoSize {
111394
+ enum ShapeFillType {
111281
111395
  /**
111282
- * No autosizing.
111396
+ * Specifies that the shape should have no fill.
111283
111397
  * @remarks
111284
111398
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111285
111399
  * @beta
111286
111400
  */
111287
- autoSizeNone = "AutoSizeNone",
111401
+ noFill = "NoFill",
111288
111402
  /**
111289
- * The text is adjusted to fit the shape.
111403
+ * Specifies that the shape should have regular solid fill.
111290
111404
  * @remarks
111291
111405
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111292
111406
  * @beta
111293
111407
  */
111294
- autoSizeTextToFitShape = "AutoSizeTextToFitShape",
111408
+ solid = "Solid",
111295
111409
  /**
111296
- * The shape is adjusted to fit the text.
111410
+ * Specifies that the shape should have gradient fill.
111297
111411
  * @remarks
111298
111412
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111299
111413
  * @beta
111300
111414
  */
111301
- autoSizeShapeToFitText = "AutoSizeShapeToFitText",
111415
+ gradient = "Gradient",
111302
111416
  /**
111303
- * A combination of automatic sizing schemes are used.
111417
+ * Specifies that the shape should have pattern fill.
111304
111418
  * @remarks
111305
111419
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111306
111420
  * @beta
111307
111421
  */
111308
- autoSizeMixed = "AutoSizeMixed",
111422
+ pattern = "Pattern",
111423
+ /**
111424
+ * Specifies that the shape should have picture or texture fill.
111425
+ * @remarks
111426
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111427
+ * @beta
111428
+ */
111429
+ pictureAndTexture = "PictureAndTexture",
111430
+ /**
111431
+ * Specifies that the shape should have slide background fill.
111432
+ * @remarks
111433
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111434
+ * @beta
111435
+ */
111436
+ slideBackground = "SlideBackground",
111309
111437
  }
111310
111438
  /**
111311
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
111312
- If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
111313
- To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
111439
+ * Represents the fill formatting of a shape object.
111314
111440
  *
111315
111441
  * @remarks
111316
111442
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111317
111443
  * @beta
111318
111444
  */
111319
- enum TextVerticalAlignment {
111445
+ class ShapeFill extends OfficeExtension.ClientObject {
111446
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111447
+ context: RequestContext;
111320
111448
  /**
111321
- * Specifies that the `TextFrame` should be top aligned to the `Shape`.
111449
+ * 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").
111450
+ *
111322
111451
  * @remarks
111323
111452
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111324
111453
  * @beta
111325
111454
  */
111326
- top = "Top",
111455
+ foregroundColor: string;
111327
111456
  /**
111328
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
111457
+ * 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.
111458
+ *
111329
111459
  * @remarks
111330
111460
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111331
111461
  * @beta
111332
111462
  */
111333
- middle = "Middle",
111463
+ transparency: number;
111334
111464
  /**
111335
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
111465
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
111466
+ *
111336
111467
  * @remarks
111337
111468
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111338
111469
  * @beta
111339
111470
  */
111340
- bottom = "Bottom",
111471
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
111341
111472
  /**
111342
- * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111473
+ * Clears the fill formatting of this shape.
111474
+ *
111343
111475
  * @remarks
111344
111476
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111345
111477
  * @beta
111346
111478
  */
111347
- topCentered = "TopCentered",
111479
+ clear(): void;
111348
111480
  /**
111349
- * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111481
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
111482
+ *
111350
111483
  * @remarks
111351
111484
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111352
111485
  * @beta
111486
+ *
111487
+ * @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").
111353
111488
  */
111354
- middleCentered = "MiddleCentered",
111489
+ setSolidColor(color: string): void;
111355
111490
  /**
111356
- * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111357
- * @remarks
111358
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111359
- * @beta
111491
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111492
+ *
111493
+ * @param options Provides options for which properties of the object to load.
111360
111494
  */
111361
- bottomCentered = "BottomCentered",
111495
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
111496
+ /**
111497
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111498
+ *
111499
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111500
+ */
111501
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
111502
+ /**
111503
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111504
+ *
111505
+ * @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.
111506
+ */
111507
+ load(propertyNamesAndPaths?: {
111508
+ select?: string;
111509
+ expand?: string;
111510
+ }): PowerPoint.ShapeFill;
111511
+ /**
111512
+ * 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.)
111513
+ * 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.
111514
+ */
111515
+ toJSON(): PowerPoint.Interfaces.ShapeFillData;
111362
111516
  }
111363
111517
  /**
111364
- * The type of underline applied to a font.
111518
+ * Specifies the style for a line.
111365
111519
  *
111366
111520
  * @remarks
111367
111521
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111368
111522
  * @beta
111369
111523
  */
111370
- enum ShapeFontUnderlineStyle {
111524
+ enum ShapeLineStyle {
111371
111525
  /**
111372
- * No underlining.
111526
+ * Single line.
111373
111527
  * @remarks
111374
111528
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111375
111529
  * @beta
111376
111530
  */
111377
- none = "None",
111531
+ single = "Single",
111378
111532
  /**
111379
- * Regular single line underlining.
111533
+ * Thick line with a thin line on each side.
111380
111534
  * @remarks
111381
111535
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111382
111536
  * @beta
111383
111537
  */
111384
- single = "Single",
111538
+ thickBetweenThin = "ThickBetweenThin",
111385
111539
  /**
111386
- * Underlining of text with double lines.
111540
+ * 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.
111387
111541
  * @remarks
111388
111542
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111389
111543
  * @beta
111390
111544
  */
111391
- double = "Double",
111545
+ thickThin = "ThickThin",
111392
111546
  /**
111393
- * Underlining of text with a thick line.
111547
+ * 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.
111394
111548
  * @remarks
111395
111549
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111396
111550
  * @beta
111397
111551
  */
111398
- heavy = "Heavy",
111552
+ thinThick = "ThinThick",
111399
111553
  /**
111400
- * Underlining of text with a dotted line.
111554
+ * Two thin lines.
111401
111555
  * @remarks
111402
111556
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111403
111557
  * @beta
111404
111558
  */
111405
- dotted = "Dotted",
111559
+ thinThin = "ThinThin",
111560
+ }
111561
+ /**
111562
+ * Specifies the dash style for a line.
111563
+ *
111564
+ * @remarks
111565
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111566
+ * @beta
111567
+ */
111568
+ enum ShapeLineDashStyle {
111406
111569
  /**
111407
- * Underlining of text with a thick, dotted line.
111570
+ * The dash line pattern
111408
111571
  * @remarks
111409
111572
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111410
111573
  * @beta
111411
111574
  */
111412
- dottedHeavy = "DottedHeavy",
111575
+ dash = "Dash",
111413
111576
  /**
111414
- * Underlining of text with a line containing dashes.
111577
+ * The dash-dot line pattern
111415
111578
  * @remarks
111416
111579
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111417
111580
  * @beta
111418
111581
  */
111419
- dash = "Dash",
111582
+ dashDot = "DashDot",
111420
111583
  /**
111421
- * Underlining of text with a thick line containing dashes.
111584
+ * The dash-dot-dot line pattern
111422
111585
  * @remarks
111423
111586
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111424
111587
  * @beta
111425
111588
  */
111426
- dashHeavy = "DashHeavy",
111589
+ dashDotDot = "DashDotDot",
111427
111590
  /**
111428
- * Underlining of text with a line containing long dashes.
111591
+ * The long dash line pattern
111429
111592
  * @remarks
111430
111593
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111431
111594
  * @beta
111432
111595
  */
111433
- dashLong = "DashLong",
111596
+ longDash = "LongDash",
111434
111597
  /**
111435
- * Underlining of text with a thick line containing long dashes.
111598
+ * The long dash-dot line pattern
111436
111599
  * @remarks
111437
111600
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111438
111601
  * @beta
111439
111602
  */
111440
- dashLongHeavy = "DashLongHeavy",
111603
+ longDashDot = "LongDashDot",
111441
111604
  /**
111442
- * Underlining of text with a line containing dots and dashes.
111605
+ * The round dot line pattern
111443
111606
  * @remarks
111444
111607
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111445
111608
  * @beta
111446
111609
  */
111447
- dotDash = "DotDash",
111610
+ roundDot = "RoundDot",
111448
111611
  /**
111449
- * Underlining of text with a thick line containing dots and dashes.
111612
+ * The solid line pattern
111450
111613
  * @remarks
111451
111614
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111452
111615
  * @beta
111453
111616
  */
111454
- dotDashHeavy = "DotDashHeavy",
111617
+ solid = "Solid",
111455
111618
  /**
111456
- * Underlining of text with a line containing double dots and dashes.
111619
+ * The square dot line pattern
111457
111620
  * @remarks
111458
111621
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111459
111622
  * @beta
111460
111623
  */
111461
- dotDotDash = "DotDotDash",
111624
+ squareDot = "SquareDot",
111462
111625
  /**
111463
- * Underlining of text with a thick line containing double dots and dashes.
111626
+ * The long dash-dot-dot line pattern
111464
111627
  * @remarks
111465
111628
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111466
111629
  * @beta
111467
111630
  */
111468
- dotDotDashHeavy = "DotDotDashHeavy",
111631
+ longDashDotDot = "LongDashDotDot",
111469
111632
  /**
111470
- * Underlining of text with a wavy line.
111633
+ * The system dash line pattern
111471
111634
  * @remarks
111472
111635
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111473
111636
  * @beta
111474
111637
  */
111475
- wavy = "Wavy",
111638
+ systemDash = "SystemDash",
111476
111639
  /**
111477
- * Underlining of text with a thick, wavy line.
111640
+ * The system dot line pattern
111478
111641
  * @remarks
111479
111642
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111480
111643
  * @beta
111481
111644
  */
111482
- wavyHeavy = "WavyHeavy",
111645
+ systemDot = "SystemDot",
111483
111646
  /**
111484
- * Underlining of text with double wavy lines.
111647
+ * The system dash-dot line pattern
111485
111648
  * @remarks
111486
111649
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111487
111650
  * @beta
111488
111651
  */
111489
- wavyDouble = "WavyDouble",
111652
+ systemDashDot = "SystemDashDot",
111490
111653
  }
111491
111654
  /**
111492
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
111655
+ * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
111493
111656
  *
111494
111657
  * @remarks
111495
111658
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111496
111659
  * @beta
111497
111660
  */
111498
- class ShapeFont extends OfficeExtension.ClientObject {
111661
+ class ShapeLineFormat extends OfficeExtension.ClientObject {
111499
111662
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111500
111663
  context: RequestContext;
111501
111664
  /**
111502
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
111665
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
111503
111666
  *
111504
111667
  * @remarks
111505
111668
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111506
111669
  * @beta
111507
111670
  */
111508
- bold: boolean;
111671
+ color: string;
111509
111672
  /**
111510
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
111673
+ * 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.
111511
111674
  *
111512
111675
  * @remarks
111513
111676
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111514
111677
  * @beta
111515
111678
  */
111516
- color: string;
111679
+ dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
111517
111680
  /**
111518
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
111681
+ * 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.
111519
111682
  *
111520
111683
  * @remarks
111521
111684
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111522
111685
  * @beta
111523
111686
  */
111524
- italic: boolean;
111687
+ style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
111525
111688
  /**
111526
- * 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.
111689
+ * 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.
111527
111690
  *
111528
111691
  * @remarks
111529
111692
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111530
111693
  * @beta
111531
111694
  */
111532
- name: string;
111695
+ transparency: number;
111533
111696
  /**
111534
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
111697
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
111535
111698
  *
111536
111699
  * @remarks
111537
111700
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111538
111701
  * @beta
111539
111702
  */
111540
- size: number;
111703
+ visible: boolean;
111541
111704
  /**
111542
- * 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.
111705
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
111543
111706
  *
111544
111707
  * @remarks
111545
111708
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111546
111709
  * @beta
111547
111710
  */
111548
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
111711
+ weight: number;
111549
111712
  /**
111550
111713
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111551
111714
  *
111552
111715
  * @param options Provides options for which properties of the object to load.
111553
111716
  */
111554
- load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
111717
+ load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;
111555
111718
  /**
111556
111719
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111557
111720
  *
111558
111721
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111559
111722
  */
111560
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
111723
+ load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;
111561
111724
  /**
111562
111725
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111563
111726
  *
@@ -111566,316 +111729,345 @@ declare namespace PowerPoint {
111566
111729
  load(propertyNamesAndPaths?: {
111567
111730
  select?: string;
111568
111731
  expand?: string;
111569
- }): PowerPoint.ShapeFont;
111732
+ }): PowerPoint.ShapeLineFormat;
111570
111733
  /**
111571
111734
  * 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.)
111572
- * 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.
111735
+ * 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.
111573
111736
  */
111574
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
111737
+ toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
111575
111738
  }
111576
111739
  /**
111577
- * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
111740
+ * Specifies the type of a shape.
111578
111741
  *
111579
111742
  * @remarks
111580
111743
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111581
111744
  * @beta
111582
111745
  */
111583
- class TextRange extends OfficeExtension.ClientObject {
111584
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111585
- context: RequestContext;
111746
+ enum ShapeType {
111586
111747
  /**
111587
- * Returns a `ShapeFont` object that represents the font attributes for the text range.
111588
- *
111748
+ * The given shape's type is unsupported.
111589
111749
  * @remarks
111590
111750
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111591
111751
  * @beta
111592
111752
  */
111593
- readonly font: PowerPoint.ShapeFont;
111753
+ unsupported = "Unsupported",
111594
111754
  /**
111595
- * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
111596
- *
111755
+ * The shape is an image
111597
111756
  * @remarks
111598
111757
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111599
111758
  * @beta
111600
111759
  */
111601
- readonly paragraphFormat: PowerPoint.ParagraphFormat;
111760
+ image = "Image",
111602
111761
  /**
111603
- * Represents the plain text content of the text range.
111604
- *
111762
+ * The shape is a geometric shape such as rectangle
111605
111763
  * @remarks
111606
111764
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111607
111765
  * @beta
111608
111766
  */
111609
- text: string;
111767
+ geometricShape = "GeometricShape",
111610
111768
  /**
111611
- * Returns a `TextRange` object for the substring in the given range.
111612
- *
111769
+ * The shape is a group shape which contains sub-shapes
111613
111770
  * @remarks
111614
111771
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111615
111772
  * @beta
111616
- *
111617
- * @param start The zero-based index of the first character to get from the text range.
111618
- * @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.
111619
111773
  */
111620
- getSubstring(start: number, length?: number): PowerPoint.TextRange;
111774
+ group = "Group",
111621
111775
  /**
111622
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111623
- *
111624
- * @param options Provides options for which properties of the object to load.
111776
+ * The shape is a line.
111777
+ * @remarks
111778
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111779
+ * @beta
111625
111780
  */
111626
- load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;
111781
+ line = "Line",
111782
+ }
111783
+ /**
111784
+ * Determines the type of automatic sizing allowed.
111785
+ *
111786
+ * @remarks
111787
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111788
+ * @beta
111789
+ */
111790
+ enum ShapeAutoSize {
111627
111791
  /**
111628
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111629
- *
111630
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111792
+ * No autosizing.
111793
+ * @remarks
111794
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111795
+ * @beta
111631
111796
  */
111632
- load(propertyNames?: string | string[]): PowerPoint.TextRange;
111797
+ autoSizeNone = "AutoSizeNone",
111633
111798
  /**
111634
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111635
- *
111636
- * @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.
111799
+ * The text is adjusted to fit the shape.
111800
+ * @remarks
111801
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111802
+ * @beta
111637
111803
  */
111638
- load(propertyNamesAndPaths?: {
111639
- select?: string;
111640
- expand?: string;
111641
- }): PowerPoint.TextRange;
111804
+ autoSizeTextToFitShape = "AutoSizeTextToFitShape",
111642
111805
  /**
111643
- * 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.)
111644
- * 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.
111645
- */
111646
- toJSON(): PowerPoint.Interfaces.TextRangeData;
111806
+ * The shape is adjusted to fit the text.
111807
+ * @remarks
111808
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111809
+ * @beta
111810
+ */
111811
+ autoSizeShapeToFitText = "AutoSizeShapeToFitText",
111812
+ /**
111813
+ * A combination of automatic sizing schemes are used.
111814
+ * @remarks
111815
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111816
+ * @beta
111817
+ */
111818
+ autoSizeMixed = "AutoSizeMixed",
111647
111819
  }
111648
111820
  /**
111649
- * Represents the text frame of a shape object.
111821
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
111822
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
111823
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
111650
111824
  *
111651
111825
  * @remarks
111652
111826
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111653
111827
  * @beta
111654
111828
  */
111655
- class TextFrame extends OfficeExtension.ClientObject {
111656
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111657
- context: RequestContext;
111829
+ enum TextVerticalAlignment {
111658
111830
  /**
111659
- * 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.
111660
- *
111831
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
111661
111832
  * @remarks
111662
111833
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111663
111834
  * @beta
111664
111835
  */
111665
- readonly textRange: PowerPoint.TextRange;
111836
+ top = "Top",
111666
111837
  /**
111667
- * 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.
111668
- *
111838
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
111669
111839
  * @remarks
111670
111840
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111671
111841
  * @beta
111672
111842
  */
111673
- autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
111843
+ middle = "Middle",
111674
111844
  /**
111675
- * Represents the bottom margin, in points, of the text frame.
111676
- *
111845
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
111677
111846
  * @remarks
111678
111847
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111679
111848
  * @beta
111680
111849
  */
111681
- bottomMargin: number;
111850
+ bottom = "Bottom",
111682
111851
  /**
111683
- * Specifies if the text frame contains text.
111684
- *
111852
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111685
111853
  * @remarks
111686
111854
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111687
111855
  * @beta
111688
111856
  */
111689
- readonly hasText: boolean;
111857
+ topCentered = "TopCentered",
111690
111858
  /**
111691
- * Represents the left margin, in points, of the text frame.
111692
- *
111859
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111693
111860
  * @remarks
111694
111861
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111695
111862
  * @beta
111696
111863
  */
111697
- leftMargin: number;
111864
+ middleCentered = "MiddleCentered",
111698
111865
  /**
111699
- * Represents the right margin, in points, of the text frame.
111700
- *
111866
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
111701
111867
  * @remarks
111702
111868
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111703
111869
  * @beta
111704
111870
  */
111705
- rightMargin: number;
111871
+ bottomCentered = "BottomCentered",
111872
+ }
111873
+ /**
111874
+ * The type of underline applied to a font.
111875
+ *
111876
+ * @remarks
111877
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111878
+ * @beta
111879
+ */
111880
+ enum ShapeFontUnderlineStyle {
111706
111881
  /**
111707
- * Represents the top margin, in points, of the text frame.
111708
- *
111882
+ * No underlining.
111709
111883
  * @remarks
111710
111884
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111711
111885
  * @beta
111712
111886
  */
111713
- topMargin: number;
111887
+ none = "None",
111714
111888
  /**
111715
- * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
111716
- *
111889
+ * Regular single line underlining.
111717
111890
  * @remarks
111718
111891
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111719
111892
  * @beta
111720
111893
  */
111721
- verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
111894
+ single = "Single",
111722
111895
  /**
111723
- * Determines whether lines break automatically to fit text inside the shape.
111724
- *
111896
+ * Underlining of text with double lines.
111725
111897
  * @remarks
111726
111898
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111727
111899
  * @beta
111728
111900
  */
111729
- wordWrap: boolean;
111901
+ double = "Double",
111730
111902
  /**
111731
- * Deletes all the text in the text frame.
111732
- *
111903
+ * Underlining of text with a thick line.
111733
111904
  * @remarks
111734
111905
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111735
111906
  * @beta
111736
111907
  */
111737
- deleteText(): void;
111908
+ heavy = "Heavy",
111738
111909
  /**
111739
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111740
- *
111741
- * @param options Provides options for which properties of the object to load.
111910
+ * Underlining of text with a dotted line.
111911
+ * @remarks
111912
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111913
+ * @beta
111742
111914
  */
111743
- load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;
111915
+ dotted = "Dotted",
111744
111916
  /**
111745
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111746
- *
111747
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111917
+ * Underlining of text with a thick, dotted line.
111918
+ * @remarks
111919
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111920
+ * @beta
111748
111921
  */
111749
- load(propertyNames?: string | string[]): PowerPoint.TextFrame;
111922
+ dottedHeavy = "DottedHeavy",
111750
111923
  /**
111751
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111752
- *
111753
- * @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.
111924
+ * Underlining of text with a line containing dashes.
111925
+ * @remarks
111926
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111927
+ * @beta
111754
111928
  */
111755
- load(propertyNamesAndPaths?: {
111756
- select?: string;
111757
- expand?: string;
111758
- }): PowerPoint.TextFrame;
111929
+ dash = "Dash",
111759
111930
  /**
111760
- * 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.)
111761
- * 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.
111762
- */
111763
- toJSON(): PowerPoint.Interfaces.TextFrameData;
111764
- }
111765
- /**
111766
- * Represents a single shape in the slide.
111767
- *
111768
- * @remarks
111769
- * [Api set: PowerPointApi 1.3]
111770
- */
111771
- class Shape extends OfficeExtension.ClientObject {
111772
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111773
- context: RequestContext;
111931
+ * Underlining of text with a thick line containing dashes.
111932
+ * @remarks
111933
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111934
+ * @beta
111935
+ */
111936
+ dashHeavy = "DashHeavy",
111774
111937
  /**
111775
- * Returns the fill formatting of this shape.
111776
- *
111938
+ * Underlining of text with a line containing long dashes.
111777
111939
  * @remarks
111778
111940
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111779
111941
  * @beta
111780
111942
  */
111781
- readonly fill: PowerPoint.ShapeFill;
111943
+ dashLong = "DashLong",
111782
111944
  /**
111783
- * Returns the line formatting of this shape.
111784
- *
111945
+ * Underlining of text with a thick line containing long dashes.
111785
111946
  * @remarks
111786
111947
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111787
111948
  * @beta
111788
111949
  */
111789
- readonly lineFormat: PowerPoint.ShapeLineFormat;
111950
+ dashLongHeavy = "DashLongHeavy",
111790
111951
  /**
111791
- * Returns a collection of tags in the shape.
111792
- *
111952
+ * Underlining of text with a line containing dots and dashes.
111793
111953
  * @remarks
111794
- * [Api set: PowerPointApi 1.3]
111954
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111955
+ * @beta
111795
111956
  */
111796
- readonly tags: PowerPoint.TagCollection;
111957
+ dotDash = "DotDash",
111797
111958
  /**
111798
- * Returns the text frame object of this shape.
111799
- *
111959
+ * Underlining of text with a thick line containing dots and dashes.
111800
111960
  * @remarks
111801
111961
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111802
111962
  * @beta
111803
111963
  */
111804
- readonly textFrame: PowerPoint.TextFrame;
111964
+ dotDashHeavy = "DotDashHeavy",
111805
111965
  /**
111806
- * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
111807
- *
111966
+ * Underlining of text with a line containing double dots and dashes.
111808
111967
  * @remarks
111809
111968
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111810
111969
  * @beta
111811
111970
  */
111812
- height: number;
111971
+ dotDotDash = "DotDotDash",
111813
111972
  /**
111814
- * Gets the unique ID of the shape.
111815
- *
111973
+ * Underlining of text with a thick line containing double dots and dashes.
111816
111974
  * @remarks
111817
- * [Api set: PowerPointApi 1.3]
111975
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111976
+ * @beta
111818
111977
  */
111819
- readonly id: string;
111978
+ dotDotDashHeavy = "DotDotDashHeavy",
111820
111979
  /**
111821
- * The distance, in points, from the left side of the shape to the left side of the slide.
111980
+ * Underlining of text with a wavy line.
111981
+ * @remarks
111982
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111983
+ * @beta
111984
+ */
111985
+ wavy = "Wavy",
111986
+ /**
111987
+ * Underlining of text with a thick, wavy line.
111988
+ * @remarks
111989
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111990
+ * @beta
111991
+ */
111992
+ wavyHeavy = "WavyHeavy",
111993
+ /**
111994
+ * Underlining of text with double wavy lines.
111995
+ * @remarks
111996
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111997
+ * @beta
111998
+ */
111999
+ wavyDouble = "WavyDouble",
112000
+ }
112001
+ /**
112002
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
112003
+ *
112004
+ * @remarks
112005
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112006
+ * @beta
112007
+ */
112008
+ class ShapeFont extends OfficeExtension.ClientObject {
112009
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112010
+ context: RequestContext;
112011
+ /**
112012
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
111822
112013
  *
111823
112014
  * @remarks
111824
112015
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111825
112016
  * @beta
111826
112017
  */
111827
- left: number;
112018
+ bold: boolean;
111828
112019
  /**
111829
- * Specifies the name of this shape.
112020
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
111830
112021
  *
111831
112022
  * @remarks
111832
112023
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111833
112024
  * @beta
111834
112025
  */
111835
- name: string;
112026
+ color: string;
111836
112027
  /**
111837
- * The distance, in points, from the top edge of the shape to the top edge of the slide.
112028
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
111838
112029
  *
111839
112030
  * @remarks
111840
112031
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111841
112032
  * @beta
111842
112033
  */
111843
- top: number;
112034
+ italic: boolean;
111844
112035
  /**
111845
- * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
112036
+ * 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.
111846
112037
  *
111847
112038
  * @remarks
111848
112039
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111849
112040
  * @beta
111850
112041
  */
111851
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
112042
+ name: string;
111852
112043
  /**
111853
- * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
112044
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
111854
112045
  *
111855
112046
  * @remarks
111856
112047
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111857
112048
  * @beta
111858
112049
  */
111859
- width: number;
112050
+ size: number;
111860
112051
  /**
111861
- * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
112052
+ * 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.
111862
112053
  *
111863
112054
  * @remarks
111864
- * [Api set: PowerPointApi 1.3]
112055
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112056
+ * @beta
111865
112057
  */
111866
- delete(): void;
112058
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
111867
112059
  /**
111868
112060
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111869
112061
  *
111870
112062
  * @param options Provides options for which properties of the object to load.
111871
112063
  */
111872
- load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
112064
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
111873
112065
  /**
111874
112066
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111875
112067
  *
111876
112068
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
111877
112069
  */
111878
- load(propertyNames?: string | string[]): PowerPoint.Shape;
112070
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
111879
112071
  /**
111880
112072
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
111881
112073
  *
@@ -111884,491 +112076,602 @@ declare namespace PowerPoint {
111884
112076
  load(propertyNamesAndPaths?: {
111885
112077
  select?: string;
111886
112078
  expand?: string;
111887
- }): PowerPoint.Shape;
112079
+ }): PowerPoint.ShapeFont;
111888
112080
  /**
111889
112081
  * 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.)
111890
- * Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
112082
+ * 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.
111891
112083
  */
111892
- toJSON(): PowerPoint.Interfaces.ShapeData;
112084
+ toJSON(): PowerPoint.Interfaces.ShapeFontData;
111893
112085
  }
111894
112086
  /**
111895
- * Represents the available options when adding shapes.
112087
+ * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
111896
112088
  *
111897
112089
  * @remarks
111898
112090
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111899
112091
  * @beta
111900
112092
  */
111901
- interface ShapeAddOptions {
112093
+ class TextRange extends OfficeExtension.ClientObject {
112094
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112095
+ context: RequestContext;
111902
112096
  /**
111903
- * Specifies the height, in points, of the shape.
111904
- When not provided, a default value will be used.
111905
- Throws an `InvalidArgument` exception when set with a negative value.
112097
+ * Returns a `ShapeFont` object that represents the font attributes for the text range.
111906
112098
  *
111907
112099
  * @remarks
111908
112100
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111909
112101
  * @beta
111910
112102
  */
111911
- height?: number;
112103
+ readonly font: PowerPoint.ShapeFont;
111912
112104
  /**
111913
- * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
111914
- When not provided, a default value will be used.
112105
+ * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
111915
112106
  *
111916
112107
  * @remarks
111917
112108
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111918
112109
  * @beta
111919
112110
  */
111920
- left?: number;
112111
+ readonly paragraphFormat: PowerPoint.ParagraphFormat;
111921
112112
  /**
111922
- * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
111923
- When not provided, a default value will be used.
112113
+ * Gets or sets the length of the range that this `TextRange` represents.
112114
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
111924
112115
  *
111925
112116
  * @remarks
111926
112117
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111927
112118
  * @beta
111928
112119
  */
111929
- top?: number;
112120
+ length: number;
111930
112121
  /**
111931
- * Specifies the width, in points, of the shape.
111932
- When not provided, a default value will be used.
111933
- Throws an `InvalidArgument` exception when set with a negative value.
112122
+ * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
112123
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
111934
112124
  *
111935
112125
  * @remarks
111936
112126
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111937
112127
  * @beta
111938
112128
  */
111939
- width?: number;
112129
+ start: number;
112130
+ /**
112131
+ * Represents the plain text content of the text range.
112132
+ *
112133
+ * @remarks
112134
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112135
+ * @beta
112136
+ */
112137
+ text: string;
112138
+ /**
112139
+ * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`.
112140
+ *
112141
+ * @remarks
112142
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112143
+ * @beta
112144
+ */
112145
+ getParentTextFrame(): PowerPoint.TextFrame;
112146
+ /**
112147
+ * Returns a `TextRange` object for the substring in the given range.
112148
+ *
112149
+ * @remarks
112150
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112151
+ * @beta
112152
+ *
112153
+ * @param start The zero-based index of the first character to get from the text range.
112154
+ * @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.
112155
+ */
112156
+ getSubstring(start: number, length?: number): PowerPoint.TextRange;
112157
+ /**
112158
+ * Selects this `TextRange` in the current view.
112159
+ *
112160
+ * @remarks
112161
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112162
+ * @beta
112163
+ */
112164
+ setSelected(): void;
112165
+ /**
112166
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112167
+ *
112168
+ * @param options Provides options for which properties of the object to load.
112169
+ */
112170
+ load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;
112171
+ /**
112172
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112173
+ *
112174
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112175
+ */
112176
+ load(propertyNames?: string | string[]): PowerPoint.TextRange;
112177
+ /**
112178
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112179
+ *
112180
+ * @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.
112181
+ */
112182
+ load(propertyNamesAndPaths?: {
112183
+ select?: string;
112184
+ expand?: string;
112185
+ }): PowerPoint.TextRange;
112186
+ /**
112187
+ * 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.)
112188
+ * 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.
112189
+ */
112190
+ toJSON(): PowerPoint.Interfaces.TextRangeData;
111940
112191
  }
111941
112192
  /**
111942
- * Represents the collection of shapes.
112193
+ * Represents the text frame of a shape object.
111943
112194
  *
111944
112195
  * @remarks
111945
- * [Api set: PowerPointApi 1.3]
112196
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112197
+ * @beta
111946
112198
  */
111947
- class ShapeCollection extends OfficeExtension.ClientObject {
112199
+ class TextFrame extends OfficeExtension.ClientObject {
111948
112200
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
111949
112201
  context: RequestContext;
111950
- /** Gets the loaded child items in this collection. */
111951
- readonly items: PowerPoint.Shape[];
111952
112202
  /**
111953
- * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
112203
+ * 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.
111954
112204
  *
111955
112205
  * @remarks
111956
112206
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111957
112207
  * @beta
111958
- *
111959
- * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
111960
- * @param options An optional parameter to specify the additional options such as the position of the shape.
111961
- * @returns The newly inserted shape.
111962
112208
  */
111963
- addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
112209
+ readonly textRange: PowerPoint.TextRange;
111964
112210
  /**
111965
- * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
112211
+ * 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.
111966
112212
  *
111967
112213
  * @remarks
111968
112214
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111969
112215
  * @beta
111970
- *
111971
- * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
111972
- * @param options An optional parameter to specify the additional options such as the position of the shape.
111973
- * @returns The newly inserted shape.
111974
112216
  */
111975
- 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;
112217
+ autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
111976
112218
  /**
111977
- * Adds a line to the slide. Returns a `Shape` object that represents the new line.
112219
+ * Represents the bottom margin, in points, of the text frame.
111978
112220
  *
111979
112221
  * @remarks
111980
112222
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111981
112223
  * @beta
111982
- *
111983
- * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
111984
- * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
111985
- * @returns The newly inserted shape.
111986
112224
  */
111987
- addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
112225
+ bottomMargin: number;
111988
112226
  /**
111989
- * Adds a line to the slide. Returns a `Shape` object that represents the new line.
112227
+ * Specifies if the text frame contains text.
111990
112228
  *
111991
112229
  * @remarks
111992
112230
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
111993
112231
  * @beta
112232
+ */
112233
+ readonly hasText: boolean;
112234
+ /**
112235
+ * Represents the left margin, in points, of the text frame.
111994
112236
  *
111995
- * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
111996
- * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
111997
- * @returns The newly inserted shape.
112237
+ * @remarks
112238
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112239
+ * @beta
111998
112240
  */
111999
- addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
112241
+ leftMargin: number;
112000
112242
  /**
112001
- * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
112243
+ * Represents the right margin, in points, of the text frame.
112002
112244
  *
112003
112245
  * @remarks
112004
112246
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112005
112247
  * @beta
112248
+ */
112249
+ rightMargin: number;
112250
+ /**
112251
+ * Represents the top margin, in points, of the text frame.
112006
112252
  *
112007
- * @param text Specifies the text that will be shown in the created text box.
112008
- * @param options An optional parameter to specify the additional options such as the position of the text box.
112009
- * @returns The newly inserted shape.
112253
+ * @remarks
112254
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112255
+ * @beta
112010
112256
  */
112011
- addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
112257
+ topMargin: number;
112012
112258
  /**
112013
- * Gets the number of shapes in the collection.
112259
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
112014
112260
  *
112015
112261
  * @remarks
112016
- * [Api set: PowerPointApi 1.3]
112017
- * @returns The number of shapes in the collection.
112262
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112263
+ * @beta
112018
112264
  */
112019
- getCount(): OfficeExtension.ClientResult<number>;
112265
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
112020
112266
  /**
112021
- * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
112267
+ * Determines whether lines break automatically to fit text inside the shape.
112022
112268
  *
112023
112269
  * @remarks
112024
- * [Api set: PowerPointApi 1.3]
112025
- *
112026
- * @param key The ID of the shape.
112027
- * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
112270
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112271
+ * @beta
112028
112272
  */
112029
- getItem(key: string): PowerPoint.Shape;
112273
+ wordWrap: boolean;
112030
112274
  /**
112031
- * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
112275
+ * Deletes all the text in the text frame.
112032
112276
  *
112033
112277
  * @remarks
112034
- * [Api set: PowerPointApi 1.3]
112035
- *
112036
- * @param index The index of the shape in the collection.
112037
- * @returns The shape at the given index. An error is thrown if index is out of range.
112278
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112279
+ * @beta
112038
112280
  */
112039
- getItemAt(index: number): PowerPoint.Shape;
112281
+ deleteText(): void;
112040
112282
  /**
112041
- * 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.
112283
+ * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
112042
112284
  *
112043
112285
  * @remarks
112044
- * [Api set: PowerPointApi 1.3]
112045
- *
112046
- * @param id The ID of the shape.
112047
- * @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.
112286
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112287
+ * @beta
112048
112288
  */
112049
- getItemOrNullObject(id: string): PowerPoint.Shape;
112289
+ getParentShape(): PowerPoint.Shape;
112050
112290
  /**
112051
112291
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112052
112292
  *
112053
112293
  * @param options Provides options for which properties of the object to load.
112054
112294
  */
112055
- load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
112295
+ load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;
112056
112296
  /**
112057
112297
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112058
112298
  *
112059
112299
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112060
112300
  */
112061
- load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
112301
+ load(propertyNames?: string | string[]): PowerPoint.TextFrame;
112062
112302
  /**
112063
112303
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112064
112304
  *
112065
112305
  * @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.
112066
112306
  */
112067
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
112307
+ load(propertyNamesAndPaths?: {
112308
+ select?: string;
112309
+ expand?: string;
112310
+ }): PowerPoint.TextFrame;
112068
112311
  /**
112069
112312
  * 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.)
112070
- * 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.
112313
+ * 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.
112071
112314
  */
112072
- toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
112315
+ toJSON(): PowerPoint.Interfaces.TextFrameData;
112073
112316
  }
112074
112317
  /**
112075
- * Represents the layout of a slide.
112318
+ * Represents a single shape in the slide.
112076
112319
  *
112077
112320
  * @remarks
112078
112321
  * [Api set: PowerPointApi 1.3]
112079
112322
  */
112080
- class SlideLayout extends OfficeExtension.ClientObject {
112323
+ class Shape extends OfficeExtension.ClientObject {
112081
112324
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112082
112325
  context: RequestContext;
112083
112326
  /**
112084
- * Returns a collection of shapes in the slide layout.
112327
+ * Returns the fill formatting of this shape.
112328
+ *
112329
+ * @remarks
112330
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112331
+ * @beta
112332
+ */
112333
+ readonly fill: PowerPoint.ShapeFill;
112334
+ /**
112335
+ * Returns the line formatting of this shape.
112336
+ *
112337
+ * @remarks
112338
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112339
+ * @beta
112340
+ */
112341
+ readonly lineFormat: PowerPoint.ShapeLineFormat;
112342
+ /**
112343
+ * Returns a collection of tags in the shape.
112085
112344
  *
112086
112345
  * @remarks
112087
112346
  * [Api set: PowerPointApi 1.3]
112088
112347
  */
112089
- readonly shapes: PowerPoint.ShapeCollection;
112348
+ readonly tags: PowerPoint.TagCollection;
112090
112349
  /**
112091
- * Gets the unique ID of the slide layout.
112350
+ * Returns the text frame object of this shape.
112351
+ *
112352
+ * @remarks
112353
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112354
+ * @beta
112355
+ */
112356
+ readonly textFrame: PowerPoint.TextFrame;
112357
+ /**
112358
+ * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
112359
+ *
112360
+ * @remarks
112361
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112362
+ * @beta
112363
+ */
112364
+ height: number;
112365
+ /**
112366
+ * Gets the unique ID of the shape.
112092
112367
  *
112093
112368
  * @remarks
112094
112369
  * [Api set: PowerPointApi 1.3]
112095
112370
  */
112096
112371
  readonly id: string;
112097
112372
  /**
112098
- * Gets the name of the slide layout.
112373
+ * The distance, in points, from the left side of the shape to the left side of the slide.
112099
112374
  *
112100
112375
  * @remarks
112101
- * [Api set: PowerPointApi 1.3]
112376
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112377
+ * @beta
112102
112378
  */
112103
- readonly name: string;
112379
+ left: number;
112104
112380
  /**
112105
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112381
+ * Specifies the name of this shape.
112106
112382
  *
112107
- * @param options Provides options for which properties of the object to load.
112383
+ * @remarks
112384
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112385
+ * @beta
112108
112386
  */
112109
- load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
112387
+ name: string;
112110
112388
  /**
112111
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112389
+ * The distance, in points, from the top edge of the shape to the top edge of the slide.
112112
112390
  *
112113
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112391
+ * @remarks
112392
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112393
+ * @beta
112114
112394
  */
112115
- load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
112395
+ top: number;
112116
112396
  /**
112117
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112397
+ * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
112118
112398
  *
112119
- * @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.
112399
+ * @remarks
112400
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112401
+ * @beta
112120
112402
  */
112121
- load(propertyNamesAndPaths?: {
112122
- select?: string;
112123
- expand?: string;
112124
- }): PowerPoint.SlideLayout;
112403
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
112125
112404
  /**
112126
- * 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.)
112127
- * 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.
112128
- */
112129
- toJSON(): PowerPoint.Interfaces.SlideLayoutData;
112130
- }
112131
- /**
112132
- * Represents the collection of layouts provided by the Slide Master for slides.
112133
- *
112134
- * @remarks
112135
- * [Api set: PowerPointApi 1.3]
112136
- */
112137
- class SlideLayoutCollection extends OfficeExtension.ClientObject {
112138
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112139
- context: RequestContext;
112140
- /** Gets the loaded child items in this collection. */
112141
- readonly items: PowerPoint.SlideLayout[];
112405
+ * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
112406
+ *
112407
+ * @remarks
112408
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112409
+ * @beta
112410
+ */
112411
+ width: number;
112142
112412
  /**
112143
- * Gets the number of layouts in the collection.
112413
+ * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
112144
112414
  *
112145
112415
  * @remarks
112146
112416
  * [Api set: PowerPointApi 1.3]
112147
- * @returns The number of layouts in the collection.
112148
112417
  */
112149
- getCount(): OfficeExtension.ClientResult<number>;
112418
+ delete(): void;
112150
112419
  /**
112151
- * Gets a layout using its unique ID.
112420
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
112152
112421
  *
112153
112422
  * @remarks
112154
- * [Api set: PowerPointApi 1.3]
112423
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112424
+ * @beta
112425
+ */
112426
+ getParentSlide(): PowerPoint.Slide;
112427
+ /**
112428
+ * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
112155
112429
  *
112156
- * @param key The ID of the layout.
112157
- * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
112430
+ * @remarks
112431
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112432
+ * @beta
112158
112433
  */
112159
- getItem(key: string): PowerPoint.SlideLayout;
112434
+ getParentSlideLayout(): PowerPoint.SlideLayout;
112160
112435
  /**
112161
- * Gets a layout using its zero-based index in the collection.
112436
+ * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned.
112162
112437
  *
112163
112438
  * @remarks
112164
- * [Api set: PowerPointApi 1.3]
112439
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112440
+ * @beta
112441
+ */
112442
+ getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
112443
+ /**
112444
+ * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
112165
112445
  *
112166
- * @param index The index of the layout in the collection.
112167
- * @returns The layout at the given index. An error is thrown if index is out of range.
112446
+ * @remarks
112447
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112448
+ * @beta
112168
112449
  */
112169
- getItemAt(index: number): PowerPoint.SlideLayout;
112450
+ getParentSlideMaster(): PowerPoint.SlideMaster;
112170
112451
  /**
112171
- * 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,
112172
- see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
112452
+ * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned.
112173
112453
  *
112174
112454
  * @remarks
112175
- * [Api set: PowerPointApi 1.3]
112455
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112456
+ * @beta
112457
+ */
112458
+ getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
112459
+ /**
112460
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned.
112176
112461
  *
112177
- * @param id The ID of the layout.
112178
- * @returns The layout with the unique ID.
112462
+ * @remarks
112463
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112464
+ * @beta
112179
112465
  */
112180
- getItemOrNullObject(id: string): PowerPoint.SlideLayout;
112466
+ getParentSlideOrNullObject(): PowerPoint.Slide;
112181
112467
  /**
112182
112468
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112183
112469
  *
112184
112470
  * @param options Provides options for which properties of the object to load.
112185
112471
  */
112186
- load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
112472
+ load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
112187
112473
  /**
112188
112474
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112189
112475
  *
112190
112476
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112191
112477
  */
112192
- load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
112478
+ load(propertyNames?: string | string[]): PowerPoint.Shape;
112193
112479
  /**
112194
112480
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112195
112481
  *
112196
112482
  * @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.
112197
112483
  */
112198
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
112484
+ load(propertyNamesAndPaths?: {
112485
+ select?: string;
112486
+ expand?: string;
112487
+ }): PowerPoint.Shape;
112199
112488
  /**
112200
112489
  * 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.)
112201
- * 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.
112490
+ * Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
112202
112491
  */
112203
- toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
112492
+ toJSON(): PowerPoint.Interfaces.ShapeData;
112204
112493
  }
112205
112494
  /**
112206
- * Represents the Slide Master of a slide.
112495
+ * Represents a collection of shapes.
112207
112496
  *
112208
112497
  * @remarks
112209
- * [Api set: PowerPointApi 1.3]
112498
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112499
+ * @beta
112210
112500
  */
112211
- class SlideMaster extends OfficeExtension.ClientObject {
112501
+ class ShapeScopedCollection extends OfficeExtension.ClientObject {
112212
112502
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112213
112503
  context: RequestContext;
112504
+ /** Gets the loaded child items in this collection. */
112505
+ readonly items: PowerPoint.Shape[];
112214
112506
  /**
112215
- * Gets the collection of layouts provided by the Slide Master for slides.
112507
+ * Gets the number of shapes in the collection.
112216
112508
  *
112217
112509
  * @remarks
112218
- * [Api set: PowerPointApi 1.3]
112510
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112511
+ * @beta
112512
+ * @returns The number of shapes in the collection.
112219
112513
  */
112220
- readonly layouts: PowerPoint.SlideLayoutCollection;
112514
+ getCount(): OfficeExtension.ClientResult<number>;
112221
112515
  /**
112222
- * Returns a collection of shapes in the Slide Master.
112516
+ * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
112223
112517
  *
112224
112518
  * @remarks
112225
- * [Api set: PowerPointApi 1.3]
112519
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112520
+ * @beta
112521
+ *
112522
+ * @param key The ID of the shape.
112523
+ * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
112226
112524
  */
112227
- readonly shapes: PowerPoint.ShapeCollection;
112525
+ getItem(key: string): PowerPoint.Shape;
112228
112526
  /**
112229
- * Gets the unique ID of the Slide Master.
112527
+ * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
112230
112528
  *
112231
112529
  * @remarks
112232
- * [Api set: PowerPointApi 1.3]
112530
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112531
+ * @beta
112532
+ *
112533
+ * @param index The index of the shape in the collection.
112534
+ * @returns The shape at the given index. An error is thrown if index is out of range.
112233
112535
  */
112234
- readonly id: string;
112536
+ getItemAt(index: number): PowerPoint.Shape;
112235
112537
  /**
112236
- * Gets the unique name of the Slide Master.
112538
+ * 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.
112237
112539
  *
112238
112540
  * @remarks
112239
- * [Api set: PowerPointApi 1.3]
112541
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112542
+ * @beta
112543
+ *
112544
+ * @param id The ID of the shape.
112545
+ * @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.
112240
112546
  */
112241
- readonly name: string;
112547
+ getItemOrNullObject(id: string): PowerPoint.Shape;
112242
112548
  /**
112243
112549
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112244
112550
  *
112245
112551
  * @param options Provides options for which properties of the object to load.
112246
112552
  */
112247
- load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
112553
+ load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;
112248
112554
  /**
112249
112555
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112250
112556
  *
112251
112557
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112252
112558
  */
112253
- load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
112559
+ load(propertyNames?: string | string[]): PowerPoint.ShapeScopedCollection;
112254
112560
  /**
112255
112561
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112256
112562
  *
112257
112563
  * @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.
112258
112564
  */
112259
- load(propertyNamesAndPaths?: {
112260
- select?: string;
112261
- expand?: string;
112262
- }): PowerPoint.SlideMaster;
112565
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection;
112263
112566
  /**
112264
112567
  * 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.)
112265
- * 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.
112568
+ * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
112266
112569
  */
112267
- toJSON(): PowerPoint.Interfaces.SlideMasterData;
112570
+ toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
112268
112571
  }
112269
112572
  /**
112270
- * Represents a single slide of a presentation.
112573
+ * Represents the collection of slides in the presentation.
112271
112574
  *
112272
112575
  * @remarks
112273
112576
  * [Api set: PowerPointApi 1.2]
112274
112577
  */
112275
- class Slide extends OfficeExtension.ClientObject {
112578
+ class SlideCollection extends OfficeExtension.ClientObject {
112276
112579
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112277
112580
  context: RequestContext;
112581
+ /** Gets the loaded child items in this collection. */
112582
+ readonly items: PowerPoint.Slide[];
112278
112583
  /**
112279
- * Gets the layout of the slide.
112584
+ * Adds a new slide at the end of the collection.
112280
112585
  *
112281
112586
  * @remarks
112282
112587
  * [Api set: PowerPointApi 1.3]
112283
- */
112284
- readonly layout: PowerPoint.SlideLayout;
112285
- /**
112286
- * Returns a collection of shapes in the slide.
112287
112588
  *
112288
- * @remarks
112289
- * [Api set: PowerPointApi 1.3]
112589
+ * @param options The options that define the theme of the new slide.
112290
112590
  */
112291
- readonly shapes: PowerPoint.ShapeCollection;
112591
+ add(options?: PowerPoint.AddSlideOptions): void;
112292
112592
  /**
112293
- * Gets the `SlideMaster` object that represents the slide's default content.
112593
+ * Gets the number of slides in the collection.
112294
112594
  *
112295
112595
  * @remarks
112296
- * [Api set: PowerPointApi 1.3]
112596
+ * [Api set: PowerPointApi 1.2]
112597
+ * @returns The number of slides in the collection.
112297
112598
  */
112298
- readonly slideMaster: PowerPoint.SlideMaster;
112599
+ getCount(): OfficeExtension.ClientResult<number>;
112299
112600
  /**
112300
- * Returns a collection of tags in the slide.
112601
+ * Gets a slide using its unique ID.
112301
112602
  *
112302
112603
  * @remarks
112303
- * [Api set: PowerPointApi 1.3]
112604
+ * [Api set: PowerPointApi 1.2]
112605
+ *
112606
+ * @param key The ID of the slide.
112607
+ * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
112304
112608
  */
112305
- readonly tags: PowerPoint.TagCollection;
112609
+ getItem(key: string): PowerPoint.Slide;
112306
112610
  /**
112307
- * Gets the unique ID of the slide.
112611
+ * Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they
112612
+ are shown in the presentation.
112308
112613
  *
112309
112614
  * @remarks
112310
112615
  * [Api set: PowerPointApi 1.2]
112616
+ *
112617
+ * @param index The index of the slide in the collection.
112618
+ * @returns The slide at the given index. An error is thrown if index is out of range.
112311
112619
  */
112312
- readonly id: string;
112620
+ getItemAt(index: number): PowerPoint.Slide;
112313
112621
  /**
112314
- * Deletes the slide from the presentation. Does nothing if the slide does not exist.
112622
+ * Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information,
112623
+ see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods
112624
+ and properties}.
112315
112625
  *
112316
112626
  * @remarks
112317
112627
  * [Api set: PowerPointApi 1.2]
112628
+ *
112629
+ * @param id The ID of the slide.
112630
+ * @returns The slide with the unique ID.
112318
112631
  */
112319
- delete(): void;
112632
+ getItemOrNullObject(id: string): PowerPoint.Slide;
112320
112633
  /**
112321
112634
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112322
112635
  *
112323
112636
  * @param options Provides options for which properties of the object to load.
112324
112637
  */
112325
- load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
112638
+ load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;
112326
112639
  /**
112327
112640
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112328
112641
  *
112329
112642
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112330
112643
  */
112331
- load(propertyNames?: string | string[]): PowerPoint.Slide;
112644
+ load(propertyNames?: string | string[]): PowerPoint.SlideCollection;
112332
112645
  /**
112333
112646
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112334
112647
  *
112335
112648
  * @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.
112336
112649
  */
112337
- load(propertyNamesAndPaths?: {
112338
- select?: string;
112339
- expand?: string;
112340
- }): PowerPoint.Slide;
112650
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection;
112341
112651
  /**
112342
112652
  * 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.)
112343
- * 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.
112653
+ * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
112344
112654
  */
112345
- toJSON(): PowerPoint.Interfaces.SlideData;
112655
+ toJSON(): PowerPoint.Interfaces.SlideCollectionData;
112346
112656
  }
112347
112657
  /**
112348
- * Represents the collection of slides in the presentation.
112658
+ * Represents a collection of slides in the presentation.
112349
112659
  *
112350
112660
  * @remarks
112351
- * [Api set: PowerPointApi 1.2]
112661
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112662
+ * @beta
112352
112663
  */
112353
- class SlideCollection extends OfficeExtension.ClientObject {
112664
+ class SlideScopedCollection extends OfficeExtension.ClientObject {
112354
112665
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
112355
112666
  context: RequestContext;
112356
112667
  /** Gets the loaded child items in this collection. */
112357
112668
  readonly items: PowerPoint.Slide[];
112358
- /**
112359
- * Adds a new slide at the end of the collection.
112360
- *
112361
- * @remarks
112362
- * [Api set: PowerPointApi 1.3]
112363
- *
112364
- * @param options The options that define the theme of the new slide.
112365
- */
112366
- add(options?: PowerPoint.AddSlideOptions): void;
112367
112669
  /**
112368
112670
  * Gets the number of slides in the collection.
112369
112671
  *
112370
112672
  * @remarks
112371
- * [Api set: PowerPointApi 1.2]
112673
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112674
+ * @beta
112372
112675
  * @returns The number of slides in the collection.
112373
112676
  */
112374
112677
  getCount(): OfficeExtension.ClientResult<number>;
@@ -112376,18 +112679,19 @@ declare namespace PowerPoint {
112376
112679
  * Gets a slide using its unique ID.
112377
112680
  *
112378
112681
  * @remarks
112379
- * [Api set: PowerPointApi 1.2]
112682
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112683
+ * @beta
112380
112684
  *
112381
112685
  * @param key The ID of the slide.
112382
112686
  * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
112383
112687
  */
112384
112688
  getItem(key: string): PowerPoint.Slide;
112385
112689
  /**
112386
- * Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they
112387
- are shown in the presentation.
112690
+ * Gets a slide using its zero-based index in the collection.
112388
112691
  *
112389
112692
  * @remarks
112390
- * [Api set: PowerPointApi 1.2]
112693
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112694
+ * @beta
112391
112695
  *
112392
112696
  * @param index The index of the slide in the collection.
112393
112697
  * @returns The slide at the given index. An error is thrown if index is out of range.
@@ -112399,7 +112703,8 @@ declare namespace PowerPoint {
112399
112703
  and properties}.
112400
112704
  *
112401
112705
  * @remarks
112402
- * [Api set: PowerPointApi 1.2]
112706
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112707
+ * @beta
112403
112708
  *
112404
112709
  * @param id The ID of the slide.
112405
112710
  * @returns The slide with the unique ID.
@@ -112410,24 +112715,24 @@ declare namespace PowerPoint {
112410
112715
  *
112411
112716
  * @param options Provides options for which properties of the object to load.
112412
112717
  */
112413
- load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;
112718
+ load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;
112414
112719
  /**
112415
112720
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112416
112721
  *
112417
112722
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
112418
112723
  */
112419
- load(propertyNames?: string | string[]): PowerPoint.SlideCollection;
112724
+ load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;
112420
112725
  /**
112421
112726
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
112422
112727
  *
112423
112728
  * @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.
112424
112729
  */
112425
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection;
112730
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;
112426
112731
  /**
112427
112732
  * 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.)
112428
- * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
112733
+ * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
112429
112734
  */
112430
- toJSON(): PowerPoint.Interfaces.SlideCollectionData;
112735
+ toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;
112431
112736
  }
112432
112737
  /**
112433
112738
  * Represents the collection of Slide Masters in the presentation.
@@ -112542,6 +112847,28 @@ declare namespace PowerPoint {
112542
112847
  */
112543
112848
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
112544
112849
  }
112850
+ /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
112851
+ interface ShapeCollectionUpdateData {
112852
+ items?: PowerPoint.Interfaces.ShapeData[];
112853
+ }
112854
+ /** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
112855
+ interface SlideLayoutCollectionUpdateData {
112856
+ items?: PowerPoint.Interfaces.SlideLayoutData[];
112857
+ }
112858
+ /** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
112859
+ interface TagUpdateData {
112860
+ /**
112861
+ * Gets the value of the tag.
112862
+ *
112863
+ * @remarks
112864
+ * [Api set: PowerPointApi 1.3]
112865
+ */
112866
+ value?: string;
112867
+ }
112868
+ /** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
112869
+ interface TagCollectionUpdateData {
112870
+ items?: PowerPoint.Interfaces.TagData[];
112871
+ }
112545
112872
  /** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */
112546
112873
  interface ShapeFillUpdateData {
112547
112874
  /**
@@ -112612,20 +112939,6 @@ declare namespace PowerPoint {
112612
112939
  */
112613
112940
  weight?: number;
112614
112941
  }
112615
- /** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
112616
- interface TagUpdateData {
112617
- /**
112618
- * Gets the value of the tag.
112619
- *
112620
- * @remarks
112621
- * [Api set: PowerPointApi 1.3]
112622
- */
112623
- value?: string;
112624
- }
112625
- /** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
112626
- interface TagCollectionUpdateData {
112627
- items?: PowerPoint.Interfaces.TagData[];
112628
- }
112629
112942
  /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
112630
112943
  interface ShapeFontUpdateData {
112631
112944
  /**
@@ -112679,6 +112992,24 @@ declare namespace PowerPoint {
112679
112992
  }
112680
112993
  /** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
112681
112994
  interface TextRangeUpdateData {
112995
+ /**
112996
+ * Gets or sets the length of the range that this `TextRange` represents.
112997
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
112998
+ *
112999
+ * @remarks
113000
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113001
+ * @beta
113002
+ */
113003
+ length?: number;
113004
+ /**
113005
+ * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
113006
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
113007
+ *
113008
+ * @remarks
113009
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113010
+ * @beta
113011
+ */
113012
+ start?: number;
112682
113013
  /**
112683
113014
  * Represents the plain text content of the text range.
112684
113015
  *
@@ -112790,18 +113121,18 @@ declare namespace PowerPoint {
112790
113121
  */
112791
113122
  width?: number;
112792
113123
  }
112793
- /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
112794
- interface ShapeCollectionUpdateData {
113124
+ /** An interface for updating data on the ShapeScopedCollection object, for use in `shapeScopedCollection.set({ ... })`. */
113125
+ interface ShapeScopedCollectionUpdateData {
112795
113126
  items?: PowerPoint.Interfaces.ShapeData[];
112796
113127
  }
112797
- /** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
112798
- interface SlideLayoutCollectionUpdateData {
112799
- items?: PowerPoint.Interfaces.SlideLayoutData[];
112800
- }
112801
113128
  /** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
112802
113129
  interface SlideCollectionUpdateData {
112803
113130
  items?: PowerPoint.Interfaces.SlideData[];
112804
113131
  }
113132
+ /** An interface for updating data on the SlideScopedCollection object, for use in `slideScopedCollection.set({ ... })`. */
113133
+ interface SlideScopedCollectionUpdateData {
113134
+ items?: PowerPoint.Interfaces.SlideData[];
113135
+ }
112805
113136
  /** An interface for updating data on the SlideMasterCollection object, for use in `slideMasterCollection.set({ ... })`. */
112806
113137
  interface SlideMasterCollectionUpdateData {
112807
113138
  items?: PowerPoint.Interfaces.SlideMasterData[];
@@ -112832,6 +113163,79 @@ declare namespace PowerPoint {
112832
113163
  */
112833
113164
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
112834
113165
  }
113166
+ /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
113167
+ interface ShapeCollectionData {
113168
+ items?: PowerPoint.Interfaces.ShapeData[];
113169
+ }
113170
+ /** An interface describing the data returned by calling `slideLayout.toJSON()`. */
113171
+ interface SlideLayoutData {
113172
+ /**
113173
+ * Gets the unique ID of the slide layout.
113174
+ *
113175
+ * @remarks
113176
+ * [Api set: PowerPointApi 1.3]
113177
+ */
113178
+ id?: string;
113179
+ /**
113180
+ * Gets the name of the slide layout.
113181
+ *
113182
+ * @remarks
113183
+ * [Api set: PowerPointApi 1.3]
113184
+ */
113185
+ name?: string;
113186
+ }
113187
+ /** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
113188
+ interface SlideLayoutCollectionData {
113189
+ items?: PowerPoint.Interfaces.SlideLayoutData[];
113190
+ }
113191
+ /** An interface describing the data returned by calling `slideMaster.toJSON()`. */
113192
+ interface SlideMasterData {
113193
+ /**
113194
+ * Gets the unique ID of the Slide Master.
113195
+ *
113196
+ * @remarks
113197
+ * [Api set: PowerPointApi 1.3]
113198
+ */
113199
+ id?: string;
113200
+ /**
113201
+ * Gets the unique name of the Slide Master.
113202
+ *
113203
+ * @remarks
113204
+ * [Api set: PowerPointApi 1.3]
113205
+ */
113206
+ name?: string;
113207
+ }
113208
+ /** An interface describing the data returned by calling `tag.toJSON()`. */
113209
+ interface TagData {
113210
+ /**
113211
+ * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
113212
+ *
113213
+ * @remarks
113214
+ * [Api set: PowerPointApi 1.3]
113215
+ */
113216
+ key?: string;
113217
+ /**
113218
+ * Gets the value of the tag.
113219
+ *
113220
+ * @remarks
113221
+ * [Api set: PowerPointApi 1.3]
113222
+ */
113223
+ value?: string;
113224
+ }
113225
+ /** An interface describing the data returned by calling `tagCollection.toJSON()`. */
113226
+ interface TagCollectionData {
113227
+ items?: PowerPoint.Interfaces.TagData[];
113228
+ }
113229
+ /** An interface describing the data returned by calling `slide.toJSON()`. */
113230
+ interface SlideData {
113231
+ /**
113232
+ * Gets the unique ID of the slide.
113233
+ *
113234
+ * @remarks
113235
+ * [Api set: PowerPointApi 1.2]
113236
+ */
113237
+ id?: string;
113238
+ }
112835
113239
  /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
112836
113240
  interface ShapeFillData {
112837
113241
  /**
@@ -112910,27 +113314,6 @@ declare namespace PowerPoint {
112910
113314
  */
112911
113315
  weight?: number;
112912
113316
  }
112913
- /** An interface describing the data returned by calling `tag.toJSON()`. */
112914
- interface TagData {
112915
- /**
112916
- * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
112917
- *
112918
- * @remarks
112919
- * [Api set: PowerPointApi 1.3]
112920
- */
112921
- key?: string;
112922
- /**
112923
- * Gets the value of the tag.
112924
- *
112925
- * @remarks
112926
- * [Api set: PowerPointApi 1.3]
112927
- */
112928
- value?: string;
112929
- }
112930
- /** An interface describing the data returned by calling `tagCollection.toJSON()`. */
112931
- interface TagCollectionData {
112932
- items?: PowerPoint.Interfaces.TagData[];
112933
- }
112934
113317
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
112935
113318
  interface ShapeFontData {
112936
113319
  /**
@@ -112984,6 +113367,24 @@ declare namespace PowerPoint {
112984
113367
  }
112985
113368
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
112986
113369
  interface TextRangeData {
113370
+ /**
113371
+ * Gets or sets the length of the range that this `TextRange` represents.
113372
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
113373
+ *
113374
+ * @remarks
113375
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113376
+ * @beta
113377
+ */
113378
+ length?: number;
113379
+ /**
113380
+ * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
113381
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
113382
+ *
113383
+ * @remarks
113384
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113385
+ * @beta
113386
+ */
113387
+ start?: number;
112987
113388
  /**
112988
113389
  * Represents the plain text content of the text range.
112989
113390
  *
@@ -113118,69 +113519,25 @@ declare namespace PowerPoint {
113118
113519
  */
113119
113520
  width?: number;
113120
113521
  }
113121
- /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
113122
- interface ShapeCollectionData {
113522
+ /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
113523
+ interface ShapeScopedCollectionData {
113123
113524
  items?: PowerPoint.Interfaces.ShapeData[];
113124
113525
  }
113125
- /** An interface describing the data returned by calling `slideLayout.toJSON()`. */
113126
- interface SlideLayoutData {
113127
- /**
113128
- * Gets the unique ID of the slide layout.
113129
- *
113130
- * @remarks
113131
- * [Api set: PowerPointApi 1.3]
113132
- */
113133
- id?: string;
113134
- /**
113135
- * Gets the name of the slide layout.
113136
- *
113137
- * @remarks
113138
- * [Api set: PowerPointApi 1.3]
113139
- */
113140
- name?: string;
113141
- }
113142
- /** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
113143
- interface SlideLayoutCollectionData {
113144
- items?: PowerPoint.Interfaces.SlideLayoutData[];
113145
- }
113146
- /** An interface describing the data returned by calling `slideMaster.toJSON()`. */
113147
- interface SlideMasterData {
113148
- /**
113149
- * Gets the unique ID of the Slide Master.
113150
- *
113151
- * @remarks
113152
- * [Api set: PowerPointApi 1.3]
113153
- */
113154
- id?: string;
113155
- /**
113156
- * Gets the unique name of the Slide Master.
113157
- *
113158
- * @remarks
113159
- * [Api set: PowerPointApi 1.3]
113160
- */
113161
- name?: string;
113162
- }
113163
- /** An interface describing the data returned by calling `slide.toJSON()`. */
113164
- interface SlideData {
113165
- /**
113166
- * Gets the unique ID of the slide.
113167
- *
113168
- * @remarks
113169
- * [Api set: PowerPointApi 1.2]
113170
- */
113171
- id?: string;
113172
- }
113173
113526
  /** An interface describing the data returned by calling `slideCollection.toJSON()`. */
113174
113527
  interface SlideCollectionData {
113175
113528
  items?: PowerPoint.Interfaces.SlideData[];
113176
113529
  }
113530
+ /** An interface describing the data returned by calling `slideScopedCollection.toJSON()`. */
113531
+ interface SlideScopedCollectionData {
113532
+ items?: PowerPoint.Interfaces.SlideData[];
113533
+ }
113177
113534
  /** An interface describing the data returned by calling `slideMasterCollection.toJSON()`. */
113178
113535
  interface SlideMasterCollectionData {
113179
113536
  items?: PowerPoint.Interfaces.SlideMasterData[];
113180
113537
  }
113181
113538
  /**
113182
113539
  * @remarks
113183
- * [Api set: PowerPointApi 1.0]
113540
+ * [Api set: PowerPointApi 1.1]
113184
113541
  */
113185
113542
  interface PresentationLoadOptions {
113186
113543
  /**
@@ -113240,102 +113597,173 @@ declare namespace PowerPoint {
113240
113597
  horizontalAlignment?: boolean;
113241
113598
  }
113242
113599
  /**
113243
- * Represents the fill formatting of a shape object.
113600
+ * Represents the collection of shapes.
113244
113601
  *
113245
113602
  * @remarks
113246
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113247
- * @beta
113603
+ * [Api set: PowerPointApi 1.3]
113248
113604
  */
113249
- interface ShapeFillLoadOptions {
113605
+ interface ShapeCollectionLoadOptions {
113250
113606
  /**
113251
113607
  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`).
113252
113608
  */
113253
113609
  $all?: boolean;
113254
113610
  /**
113255
- * 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").
113611
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
113612
+ *
113613
+ * @remarks
113614
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113615
+ * @beta
113616
+ */
113617
+ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
113618
+ /**
113619
+ * For EACH ITEM in the collection: Returns the line formatting of this shape.
113620
+ *
113621
+ * @remarks
113622
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113623
+ * @beta
113624
+ */
113625
+ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
113626
+ /**
113627
+ * For EACH ITEM in the collection: Returns the text frame object of this shape.
113628
+ *
113629
+ * @remarks
113630
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113631
+ * @beta
113632
+ */
113633
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
113634
+ /**
113635
+ * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
113256
113636
  *
113257
113637
  * @remarks
113258
113638
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113259
113639
  * @beta
113260
113640
  */
113261
- foregroundColor?: boolean;
113641
+ height?: boolean;
113262
113642
  /**
113263
- * 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.
113643
+ * For EACH ITEM in the collection: Gets the unique ID of the shape.
113644
+ *
113645
+ * @remarks
113646
+ * [Api set: PowerPointApi 1.3]
113647
+ */
113648
+ id?: boolean;
113649
+ /**
113650
+ * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
113264
113651
  *
113265
113652
  * @remarks
113266
113653
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113267
113654
  * @beta
113268
113655
  */
113269
- transparency?: boolean;
113656
+ left?: boolean;
113270
113657
  /**
113271
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
113658
+ * For EACH ITEM in the collection: Specifies the name of this shape.
113659
+ *
113660
+ * @remarks
113661
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113662
+ * @beta
113663
+ */
113664
+ name?: boolean;
113665
+ /**
113666
+ * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
113667
+ *
113668
+ * @remarks
113669
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113670
+ * @beta
113671
+ */
113672
+ top?: boolean;
113673
+ /**
113674
+ * For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
113272
113675
  *
113273
113676
  * @remarks
113274
113677
  * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113275
113678
  * @beta
113276
113679
  */
113277
113680
  type?: boolean;
113681
+ /**
113682
+ * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
113683
+ *
113684
+ * @remarks
113685
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113686
+ * @beta
113687
+ */
113688
+ width?: boolean;
113278
113689
  }
113279
113690
  /**
113280
- * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
113691
+ * Represents the layout of a slide.
113281
113692
  *
113282
113693
  * @remarks
113283
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113284
- * @beta
113694
+ * [Api set: PowerPointApi 1.3]
113285
113695
  */
113286
- interface ShapeLineFormatLoadOptions {
113696
+ interface SlideLayoutLoadOptions {
113287
113697
  /**
113288
113698
  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`).
113289
113699
  */
113290
113700
  $all?: boolean;
113291
113701
  /**
113292
- * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
113702
+ * Gets the unique ID of the slide layout.
113293
113703
  *
113294
113704
  * @remarks
113295
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113296
- * @beta
113705
+ * [Api set: PowerPointApi 1.3]
113297
113706
  */
113298
- color?: boolean;
113707
+ id?: boolean;
113299
113708
  /**
113300
- * 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.
113709
+ * Gets the name of the slide layout.
113301
113710
  *
113302
113711
  * @remarks
113303
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113304
- * @beta
113712
+ * [Api set: PowerPointApi 1.3]
113305
113713
  */
113306
- dashStyle?: boolean;
113714
+ name?: boolean;
113715
+ }
113716
+ /**
113717
+ * Represents the collection of layouts provided by the Slide Master for slides.
113718
+ *
113719
+ * @remarks
113720
+ * [Api set: PowerPointApi 1.3]
113721
+ */
113722
+ interface SlideLayoutCollectionLoadOptions {
113307
113723
  /**
113308
- * 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.
113724
+ 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`).
113725
+ */
113726
+ $all?: boolean;
113727
+ /**
113728
+ * For EACH ITEM in the collection: Gets the unique ID of the slide layout.
113309
113729
  *
113310
113730
  * @remarks
113311
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113312
- * @beta
113731
+ * [Api set: PowerPointApi 1.3]
113313
113732
  */
113314
- style?: boolean;
113733
+ id?: boolean;
113315
113734
  /**
113316
- * 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.
113735
+ * For EACH ITEM in the collection: Gets the name of the slide layout.
113317
113736
  *
113318
113737
  * @remarks
113319
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113320
- * @beta
113738
+ * [Api set: PowerPointApi 1.3]
113321
113739
  */
113322
- transparency?: boolean;
113740
+ name?: boolean;
113741
+ }
113742
+ /**
113743
+ * Represents the Slide Master of a slide.
113744
+ *
113745
+ * @remarks
113746
+ * [Api set: PowerPointApi 1.3]
113747
+ */
113748
+ interface SlideMasterLoadOptions {
113323
113749
  /**
113324
- * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
113750
+ 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`).
113751
+ */
113752
+ $all?: boolean;
113753
+ /**
113754
+ * Gets the unique ID of the Slide Master.
113325
113755
  *
113326
113756
  * @remarks
113327
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113328
- * @beta
113757
+ * [Api set: PowerPointApi 1.3]
113329
113758
  */
113330
- visible?: boolean;
113759
+ id?: boolean;
113331
113760
  /**
113332
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
113761
+ * Gets the unique name of the Slide Master.
113333
113762
  *
113334
113763
  * @remarks
113335
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113336
- * @beta
113764
+ * [Api set: PowerPointApi 1.3]
113337
113765
  */
113338
- weight?: boolean;
113766
+ name?: boolean;
113339
113767
  }
113340
113768
  /**
113341
113769
  * Represents a single tag in the slide.
@@ -113389,6 +113817,137 @@ declare namespace PowerPoint {
113389
113817
  */
113390
113818
  value?: boolean;
113391
113819
  }
113820
+ /**
113821
+ * Represents a single slide of a presentation.
113822
+ *
113823
+ * @remarks
113824
+ * [Api set: PowerPointApi 1.2]
113825
+ */
113826
+ interface SlideLoadOptions {
113827
+ /**
113828
+ 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`).
113829
+ */
113830
+ $all?: boolean;
113831
+ /**
113832
+ * Gets the layout of the slide.
113833
+ *
113834
+ * @remarks
113835
+ * [Api set: PowerPointApi 1.3]
113836
+ */
113837
+ layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
113838
+ /**
113839
+ * Gets the `SlideMaster` object that represents the slide's default content.
113840
+ *
113841
+ * @remarks
113842
+ * [Api set: PowerPointApi 1.3]
113843
+ */
113844
+ slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
113845
+ /**
113846
+ * Gets the unique ID of the slide.
113847
+ *
113848
+ * @remarks
113849
+ * [Api set: PowerPointApi 1.2]
113850
+ */
113851
+ id?: boolean;
113852
+ }
113853
+ /**
113854
+ * Represents the fill formatting of a shape object.
113855
+ *
113856
+ * @remarks
113857
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113858
+ * @beta
113859
+ */
113860
+ interface ShapeFillLoadOptions {
113861
+ /**
113862
+ 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`).
113863
+ */
113864
+ $all?: boolean;
113865
+ /**
113866
+ * 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").
113867
+ *
113868
+ * @remarks
113869
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113870
+ * @beta
113871
+ */
113872
+ foregroundColor?: boolean;
113873
+ /**
113874
+ * 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.
113875
+ *
113876
+ * @remarks
113877
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113878
+ * @beta
113879
+ */
113880
+ transparency?: boolean;
113881
+ /**
113882
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
113883
+ *
113884
+ * @remarks
113885
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113886
+ * @beta
113887
+ */
113888
+ type?: boolean;
113889
+ }
113890
+ /**
113891
+ * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
113892
+ *
113893
+ * @remarks
113894
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113895
+ * @beta
113896
+ */
113897
+ interface ShapeLineFormatLoadOptions {
113898
+ /**
113899
+ 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`).
113900
+ */
113901
+ $all?: boolean;
113902
+ /**
113903
+ * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
113904
+ *
113905
+ * @remarks
113906
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113907
+ * @beta
113908
+ */
113909
+ color?: boolean;
113910
+ /**
113911
+ * 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.
113912
+ *
113913
+ * @remarks
113914
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113915
+ * @beta
113916
+ */
113917
+ dashStyle?: boolean;
113918
+ /**
113919
+ * 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.
113920
+ *
113921
+ * @remarks
113922
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113923
+ * @beta
113924
+ */
113925
+ style?: boolean;
113926
+ /**
113927
+ * 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.
113928
+ *
113929
+ * @remarks
113930
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113931
+ * @beta
113932
+ */
113933
+ transparency?: boolean;
113934
+ /**
113935
+ * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
113936
+ *
113937
+ * @remarks
113938
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113939
+ * @beta
113940
+ */
113941
+ visible?: boolean;
113942
+ /**
113943
+ * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
113944
+ *
113945
+ * @remarks
113946
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113947
+ * @beta
113948
+ */
113949
+ weight?: boolean;
113950
+ }
113392
113951
  /**
113393
113952
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
113394
113953
  *
@@ -113478,6 +114037,24 @@ declare namespace PowerPoint {
113478
114037
  * @beta
113479
114038
  */
113480
114039
  paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;
114040
+ /**
114041
+ * Gets or sets the length of the range that this `TextRange` represents.
114042
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
114043
+ *
114044
+ * @remarks
114045
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114046
+ * @beta
114047
+ */
114048
+ length?: boolean;
114049
+ /**
114050
+ * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
114051
+ Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
114052
+ *
114053
+ * @remarks
114054
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114055
+ * @beta
114056
+ */
114057
+ start?: boolean;
113481
114058
  /**
113482
114059
  * Represents the plain text content of the text range.
113483
114060
  *
@@ -113664,12 +114241,13 @@ declare namespace PowerPoint {
113664
114241
  width?: boolean;
113665
114242
  }
113666
114243
  /**
113667
- * Represents the collection of shapes.
114244
+ * Represents a collection of shapes.
113668
114245
  *
113669
114246
  * @remarks
113670
- * [Api set: PowerPointApi 1.3]
114247
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114248
+ * @beta
113671
114249
  */
113672
- interface ShapeCollectionLoadOptions {
114250
+ interface ShapeScopedCollectionLoadOptions {
113673
114251
  /**
113674
114252
  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`).
113675
114253
  */
@@ -113755,110 +114333,32 @@ declare namespace PowerPoint {
113755
114333
  width?: boolean;
113756
114334
  }
113757
114335
  /**
113758
- * Represents the layout of a slide.
113759
- *
113760
- * @remarks
113761
- * [Api set: PowerPointApi 1.3]
113762
- */
113763
- interface SlideLayoutLoadOptions {
113764
- /**
113765
- 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`).
113766
- */
113767
- $all?: boolean;
113768
- /**
113769
- * Gets the unique ID of the slide layout.
113770
- *
113771
- * @remarks
113772
- * [Api set: PowerPointApi 1.3]
113773
- */
113774
- id?: boolean;
113775
- /**
113776
- * Gets the name of the slide layout.
113777
- *
113778
- * @remarks
113779
- * [Api set: PowerPointApi 1.3]
113780
- */
113781
- name?: boolean;
113782
- }
113783
- /**
113784
- * Represents the collection of layouts provided by the Slide Master for slides.
113785
- *
113786
- * @remarks
113787
- * [Api set: PowerPointApi 1.3]
113788
- */
113789
- interface SlideLayoutCollectionLoadOptions {
113790
- /**
113791
- 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`).
113792
- */
113793
- $all?: boolean;
113794
- /**
113795
- * For EACH ITEM in the collection: Gets the unique ID of the slide layout.
113796
- *
113797
- * @remarks
113798
- * [Api set: PowerPointApi 1.3]
113799
- */
113800
- id?: boolean;
113801
- /**
113802
- * For EACH ITEM in the collection: Gets the name of the slide layout.
113803
- *
113804
- * @remarks
113805
- * [Api set: PowerPointApi 1.3]
113806
- */
113807
- name?: boolean;
113808
- }
113809
- /**
113810
- * Represents the Slide Master of a slide.
113811
- *
113812
- * @remarks
113813
- * [Api set: PowerPointApi 1.3]
113814
- */
113815
- interface SlideMasterLoadOptions {
113816
- /**
113817
- 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`).
113818
- */
113819
- $all?: boolean;
113820
- /**
113821
- * Gets the unique ID of the Slide Master.
113822
- *
113823
- * @remarks
113824
- * [Api set: PowerPointApi 1.3]
113825
- */
113826
- id?: boolean;
113827
- /**
113828
- * Gets the unique name of the Slide Master.
113829
- *
113830
- * @remarks
113831
- * [Api set: PowerPointApi 1.3]
113832
- */
113833
- name?: boolean;
113834
- }
113835
- /**
113836
- * Represents a single slide of a presentation.
114336
+ * Represents the collection of slides in the presentation.
113837
114337
  *
113838
114338
  * @remarks
113839
114339
  * [Api set: PowerPointApi 1.2]
113840
114340
  */
113841
- interface SlideLoadOptions {
114341
+ interface SlideCollectionLoadOptions {
113842
114342
  /**
113843
114343
  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`).
113844
114344
  */
113845
114345
  $all?: boolean;
113846
114346
  /**
113847
- * Gets the layout of the slide.
114347
+ * For EACH ITEM in the collection: Gets the layout of the slide.
113848
114348
  *
113849
114349
  * @remarks
113850
114350
  * [Api set: PowerPointApi 1.3]
113851
114351
  */
113852
114352
  layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
113853
114353
  /**
113854
- * Gets the `SlideMaster` object that represents the slide's default content.
114354
+ * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
113855
114355
  *
113856
114356
  * @remarks
113857
114357
  * [Api set: PowerPointApi 1.3]
113858
114358
  */
113859
114359
  slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
113860
114360
  /**
113861
- * Gets the unique ID of the slide.
114361
+ * For EACH ITEM in the collection: Gets the unique ID of the slide.
113862
114362
  *
113863
114363
  * @remarks
113864
114364
  * [Api set: PowerPointApi 1.2]
@@ -113866,12 +114366,13 @@ declare namespace PowerPoint {
113866
114366
  id?: boolean;
113867
114367
  }
113868
114368
  /**
113869
- * Represents the collection of slides in the presentation.
114369
+ * Represents a collection of slides in the presentation.
113870
114370
  *
113871
114371
  * @remarks
113872
- * [Api set: PowerPointApi 1.2]
114372
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114373
+ * @beta
113873
114374
  */
113874
- interface SlideCollectionLoadOptions {
114375
+ interface SlideScopedCollectionLoadOptions {
113875
114376
  /**
113876
114377
  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`).
113877
114378
  */