@types/office-js-preview 1.0.458 → 1.0.460

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.
@@ -29242,6 +29242,24 @@ declare namespace Excel {
29242
29242
  * [Api set: ExcelApi 1.14]
29243
29243
  */
29244
29244
  readonly rowsLoadedCount: number;
29245
+ /**
29246
+ * Deletes the query and associated connection.
29247
+ Tables associated with the query will no longer be connected.
29248
+ *
29249
+ * @remarks
29250
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29251
+ * @beta
29252
+ */
29253
+ delete(): void;
29254
+ /**
29255
+ * Refreshes the query.
29256
+ This only starts the refresh.
29257
+ *
29258
+ * @remarks
29259
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29260
+ * @beta
29261
+ */
29262
+ refresh(): void;
29245
29263
  /**
29246
29264
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
29247
29265
  *
@@ -29297,6 +29315,14 @@ declare namespace Excel {
29297
29315
  * @returns The query with the given name. If there is no query by that name, then an error is thrown.
29298
29316
  */
29299
29317
  getItem(key: string): Excel.Query;
29318
+ /**
29319
+ * Refresh all queries.
29320
+ *
29321
+ * @remarks
29322
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29323
+ * @beta
29324
+ */
29325
+ refreshAll(): void;
29300
29326
  /**
29301
29327
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
29302
29328
  *
@@ -29711,7 +29737,7 @@ declare namespace Excel {
29711
29737
  */
29712
29738
  readonly title: string;
29713
29739
  /**
29714
- * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
29740
+ * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
29715
29741
  *
29716
29742
  * @remarks
29717
29743
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -41190,6 +41216,7 @@ declare namespace Excel {
41190
41216
  markerForegroundColor: string;
41191
41217
  /**
41192
41218
  * Specifies the marker size of a chart series.
41219
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
41193
41220
  *
41194
41221
  * @remarks
41195
41222
  * [Api set: ExcelApi 1.7]
@@ -41571,6 +41598,7 @@ declare namespace Excel {
41571
41598
  markerForegroundColor: string;
41572
41599
  /**
41573
41600
  * Represents marker size of a data point.
41601
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
41574
41602
  *
41575
41603
  * @remarks
41576
41604
  * [Api set: ExcelApi 1.7]
@@ -66964,6 +66992,7 @@ declare namespace Excel {
66964
66992
  markerForegroundColor?: string;
66965
66993
  /**
66966
66994
  * Specifies the marker size of a chart series.
66995
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
66967
66996
  *
66968
66997
  * @remarks
66969
66998
  * [Api set: ExcelApi 1.7]
@@ -67114,6 +67143,7 @@ declare namespace Excel {
67114
67143
  markerForegroundColor?: string;
67115
67144
  /**
67116
67145
  * Represents marker size of a data point.
67146
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
67117
67147
  *
67118
67148
  * @remarks
67119
67149
  * [Api set: ExcelApi 1.7]
@@ -73035,6 +73065,7 @@ declare namespace Excel {
73035
73065
  markerForegroundColor?: string;
73036
73066
  /**
73037
73067
  * Specifies the marker size of a chart series.
73068
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
73038
73069
  *
73039
73070
  * @remarks
73040
73071
  * [Api set: ExcelApi 1.7]
@@ -73185,6 +73216,7 @@ declare namespace Excel {
73185
73216
  markerForegroundColor?: string;
73186
73217
  /**
73187
73218
  * Represents marker size of a data point.
73219
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
73188
73220
  *
73189
73221
  * @remarks
73190
73222
  * [Api set: ExcelApi 1.7]
@@ -77782,7 +77814,7 @@ declare namespace Excel {
77782
77814
  */
77783
77815
  title?: boolean;
77784
77816
  /**
77785
- * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
77817
+ * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
77786
77818
  *
77787
77819
  * @remarks
77788
77820
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -81446,6 +81478,7 @@ declare namespace Excel {
81446
81478
  markerForegroundColor?: boolean;
81447
81479
  /**
81448
81480
  * For EACH ITEM in the collection: Specifies the marker size of a chart series.
81481
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
81449
81482
  *
81450
81483
  * @remarks
81451
81484
  * [Api set: ExcelApi 1.7]
@@ -81775,6 +81808,7 @@ declare namespace Excel {
81775
81808
  markerForegroundColor?: boolean;
81776
81809
  /**
81777
81810
  * Specifies the marker size of a chart series.
81811
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
81778
81812
  *
81779
81813
  * @remarks
81780
81814
  * [Api set: ExcelApi 1.7]
@@ -81939,6 +81973,7 @@ declare namespace Excel {
81939
81973
  markerForegroundColor?: boolean;
81940
81974
  /**
81941
81975
  * For EACH ITEM in the collection: Represents marker size of a data point.
81976
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
81942
81977
  *
81943
81978
  * @remarks
81944
81979
  * [Api set: ExcelApi 1.7]
@@ -82007,6 +82042,7 @@ declare namespace Excel {
82007
82042
  markerForegroundColor?: boolean;
82008
82043
  /**
82009
82044
  * Represents marker size of a data point.
82045
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
82010
82046
  *
82011
82047
  * @remarks
82012
82048
  * [Api set: ExcelApi 1.7]
@@ -91456,7 +91492,7 @@ declare namespace Word {
91456
91492
  *
91457
91493
  * @param contentControlState State to be set.
91458
91494
  */
91459
- setState(contentControlState: "Error"): void;
91495
+ setState(contentControlState: "Error" | "Warning"): void;
91460
91496
  /**
91461
91497
  * Splits the content control into child ranges by using delimiters.
91462
91498
  *
@@ -99653,6 +99689,13 @@ declare namespace Word {
99653
99689
  * @beta
99654
99690
  */
99655
99691
  error = "Error",
99692
+ /**
99693
+ * Warning state.
99694
+ * @remarks
99695
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
99696
+ * @beta
99697
+ */
99698
+ warning = "Warning",
99656
99699
  }
99657
99700
  /**
99658
99701
  * The supported styles for underline format.
@@ -121293,6 +121336,13 @@ declare namespace PowerPoint {
121293
121336
  * [Api set: PowerPointApi 1.3]
121294
121337
  */
121295
121338
  readonly tags: PowerPoint.TagCollection;
121339
+ /**
121340
+ * Gets the ID of the presentation.
121341
+ *
121342
+ * @remarks
121343
+ * [Api set: PowerPointApi 1.5]
121344
+ */
121345
+ readonly id: string;
121296
121346
  readonly title: string;
121297
121347
  /**
121298
121348
  * Returns the selected shapes in the current slide of the presentation.
@@ -121400,49 +121450,6 @@ declare namespace PowerPoint {
121400
121450
  */
121401
121451
  slideMasterId?: string;
121402
121452
  }
121403
- /**
121404
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
121405
- *
121406
- * @remarks
121407
- * [Api set: PowerPointApi 1.4]
121408
- */
121409
- class BulletFormat extends OfficeExtension.ClientObject {
121410
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
121411
- context: RequestContext;
121412
- /**
121413
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
121414
- *
121415
- * @remarks
121416
- * [Api set: PowerPointApi 1.4]
121417
- */
121418
- visible: boolean;
121419
- /**
121420
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121421
- *
121422
- * @param options Provides options for which properties of the object to load.
121423
- */
121424
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
121425
- /**
121426
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121427
- *
121428
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
121429
- */
121430
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
121431
- /**
121432
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121433
- *
121434
- * @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.
121435
- */
121436
- load(propertyNamesAndPaths?: {
121437
- select?: string;
121438
- expand?: string;
121439
- }): PowerPoint.BulletFormat;
121440
- /**
121441
- * 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.)
121442
- * Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
121443
- */
121444
- toJSON(): PowerPoint.Interfaces.BulletFormatData;
121445
- }
121446
121453
  /**
121447
121454
  * Specifies the connector type for line shapes.
121448
121455
  *
@@ -122540,59 +122547,236 @@ declare namespace PowerPoint {
122540
122547
  chartPlus = "ChartPlus",
122541
122548
  }
122542
122549
  /**
122543
- * Specifies the formatting options for when slides are inserted.
122550
+ * Represents the available options when adding shapes.
122544
122551
  *
122545
122552
  * @remarks
122546
- * [Api set: PowerPointApi 1.2]
122553
+ * [Api set: PowerPointApi 1.4]
122547
122554
  */
122548
- enum InsertSlideFormatting {
122555
+ interface ShapeAddOptions {
122549
122556
  /**
122550
- * Copy the source theme into the target presentation and use that theme.
122557
+ * Specifies the height, in points, of the shape.
122558
+ When not provided, a default value will be used.
122559
+ Throws an `InvalidArgument` exception when set with a negative value.
122560
+ *
122551
122561
  * @remarks
122552
- * [Api set: PowerPointApi 1.2]
122562
+ * [Api set: PowerPointApi 1.4]
122553
122563
  */
122554
- keepSourceFormatting = "KeepSourceFormatting",
122564
+ height?: number;
122555
122565
  /**
122556
- * Use the existing theme in the target presentation.
122566
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
122567
+ When not provided, a default value will be used.
122568
+ *
122557
122569
  * @remarks
122558
- * [Api set: PowerPointApi 1.2]
122570
+ * [Api set: PowerPointApi 1.4]
122559
122571
  */
122560
- useDestinationTheme = "UseDestinationTheme",
122572
+ left?: number;
122573
+ /**
122574
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
122575
+ When not provided, a default value will be used.
122576
+ *
122577
+ * @remarks
122578
+ * [Api set: PowerPointApi 1.4]
122579
+ */
122580
+ top?: number;
122581
+ /**
122582
+ * Specifies the width, in points, of the shape.
122583
+ When not provided, a default value will be used.
122584
+ Throws an `InvalidArgument` exception when set with a negative value.
122585
+ *
122586
+ * @remarks
122587
+ * [Api set: PowerPointApi 1.4]
122588
+ */
122589
+ width?: number;
122561
122590
  }
122562
122591
  /**
122563
- * Represents the available options when inserting slides.
122592
+ * Specifies the dash style for a line.
122564
122593
  *
122565
122594
  * @remarks
122566
- * [Api set: PowerPointApi 1.2]
122595
+ * [Api set: PowerPointApi 1.4]
122567
122596
  */
122568
- interface InsertSlideOptions {
122597
+ enum ShapeLineDashStyle {
122569
122598
  /**
122570
- * Specifies which formatting to use during slide insertion.
122571
- The default option is to use "KeepSourceFormatting".
122572
- *
122599
+ * The dash line pattern
122573
122600
  * @remarks
122574
- * [Api set: PowerPointApi 1.2]
122601
+ * [Api set: PowerPointApi 1.4]
122575
122602
  */
122576
- formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
122603
+ dash = "Dash",
122577
122604
  /**
122578
- * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
122579
- The order of these slides is preserved during the insertion.
122580
- If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
122581
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
122582
- *
122605
+ * The dash-dot line pattern
122583
122606
  * @remarks
122584
- * [Api set: PowerPointApi 1.2]
122607
+ * [Api set: PowerPointApi 1.4]
122585
122608
  */
122586
- sourceSlideIds?: string[];
122609
+ dashDot = "DashDot",
122587
122610
  /**
122588
- * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
122589
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
122590
- If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
122591
- *
122611
+ * The dash-dot-dot line pattern
122592
122612
  * @remarks
122593
- * [Api set: PowerPointApi 1.2]
122613
+ * [Api set: PowerPointApi 1.4]
122594
122614
  */
122595
- targetSlideId?: string;
122615
+ dashDotDot = "DashDotDot",
122616
+ /**
122617
+ * The long dash line pattern
122618
+ * @remarks
122619
+ * [Api set: PowerPointApi 1.4]
122620
+ */
122621
+ longDash = "LongDash",
122622
+ /**
122623
+ * The long dash-dot line pattern
122624
+ * @remarks
122625
+ * [Api set: PowerPointApi 1.4]
122626
+ */
122627
+ longDashDot = "LongDashDot",
122628
+ /**
122629
+ * The round dot line pattern
122630
+ * @remarks
122631
+ * [Api set: PowerPointApi 1.4]
122632
+ */
122633
+ roundDot = "RoundDot",
122634
+ /**
122635
+ * The solid line pattern
122636
+ * @remarks
122637
+ * [Api set: PowerPointApi 1.4]
122638
+ */
122639
+ solid = "Solid",
122640
+ /**
122641
+ * The square dot line pattern
122642
+ * @remarks
122643
+ * [Api set: PowerPointApi 1.4]
122644
+ */
122645
+ squareDot = "SquareDot",
122646
+ /**
122647
+ * The long dash-dot-dot line pattern
122648
+ * @remarks
122649
+ * [Api set: PowerPointApi 1.4]
122650
+ */
122651
+ longDashDotDot = "LongDashDotDot",
122652
+ /**
122653
+ * The system dash line pattern
122654
+ * @remarks
122655
+ * [Api set: PowerPointApi 1.4]
122656
+ */
122657
+ systemDash = "SystemDash",
122658
+ /**
122659
+ * The system dot line pattern
122660
+ * @remarks
122661
+ * [Api set: PowerPointApi 1.4]
122662
+ */
122663
+ systemDot = "SystemDot",
122664
+ /**
122665
+ * The system dash-dot line pattern
122666
+ * @remarks
122667
+ * [Api set: PowerPointApi 1.4]
122668
+ */
122669
+ systemDashDot = "SystemDashDot",
122670
+ }
122671
+ /**
122672
+ * The type of underline applied to a font.
122673
+ *
122674
+ * @remarks
122675
+ * [Api set: PowerPointApi 1.4]
122676
+ */
122677
+ enum ShapeFontUnderlineStyle {
122678
+ /**
122679
+ * No underlining.
122680
+ * @remarks
122681
+ * [Api set: PowerPointApi 1.4]
122682
+ */
122683
+ none = "None",
122684
+ /**
122685
+ * Regular single line underlining.
122686
+ * @remarks
122687
+ * [Api set: PowerPointApi 1.4]
122688
+ */
122689
+ single = "Single",
122690
+ /**
122691
+ * Underlining of text with double lines.
122692
+ * @remarks
122693
+ * [Api set: PowerPointApi 1.4]
122694
+ */
122695
+ double = "Double",
122696
+ /**
122697
+ * Underlining of text with a thick line.
122698
+ * @remarks
122699
+ * [Api set: PowerPointApi 1.4]
122700
+ */
122701
+ heavy = "Heavy",
122702
+ /**
122703
+ * Underlining of text with a dotted line.
122704
+ * @remarks
122705
+ * [Api set: PowerPointApi 1.4]
122706
+ */
122707
+ dotted = "Dotted",
122708
+ /**
122709
+ * Underlining of text with a thick, dotted line.
122710
+ * @remarks
122711
+ * [Api set: PowerPointApi 1.4]
122712
+ */
122713
+ dottedHeavy = "DottedHeavy",
122714
+ /**
122715
+ * Underlining of text with a line containing dashes.
122716
+ * @remarks
122717
+ * [Api set: PowerPointApi 1.4]
122718
+ */
122719
+ dash = "Dash",
122720
+ /**
122721
+ * Underlining of text with a thick line containing dashes.
122722
+ * @remarks
122723
+ * [Api set: PowerPointApi 1.4]
122724
+ */
122725
+ dashHeavy = "DashHeavy",
122726
+ /**
122727
+ * Underlining of text with a line containing long dashes.
122728
+ * @remarks
122729
+ * [Api set: PowerPointApi 1.4]
122730
+ */
122731
+ dashLong = "DashLong",
122732
+ /**
122733
+ * Underlining of text with a thick line containing long dashes.
122734
+ * @remarks
122735
+ * [Api set: PowerPointApi 1.4]
122736
+ */
122737
+ dashLongHeavy = "DashLongHeavy",
122738
+ /**
122739
+ * Underlining of text with a line containing dots and dashes.
122740
+ * @remarks
122741
+ * [Api set: PowerPointApi 1.4]
122742
+ */
122743
+ dotDash = "DotDash",
122744
+ /**
122745
+ * Underlining of text with a thick line containing dots and dashes.
122746
+ * @remarks
122747
+ * [Api set: PowerPointApi 1.4]
122748
+ */
122749
+ dotDashHeavy = "DotDashHeavy",
122750
+ /**
122751
+ * Underlining of text with a line containing double dots and dashes.
122752
+ * @remarks
122753
+ * [Api set: PowerPointApi 1.4]
122754
+ */
122755
+ dotDotDash = "DotDotDash",
122756
+ /**
122757
+ * Underlining of text with a thick line containing double dots and dashes.
122758
+ * @remarks
122759
+ * [Api set: PowerPointApi 1.4]
122760
+ */
122761
+ dotDotDashHeavy = "DotDotDashHeavy",
122762
+ /**
122763
+ * Underlining of text with a wavy line.
122764
+ * @remarks
122765
+ * [Api set: PowerPointApi 1.4]
122766
+ */
122767
+ wavy = "Wavy",
122768
+ /**
122769
+ * Underlining of text with a thick, wavy line.
122770
+ * @remarks
122771
+ * [Api set: PowerPointApi 1.4]
122772
+ */
122773
+ wavyHeavy = "WavyHeavy",
122774
+ /**
122775
+ * Underlining of text with double wavy lines.
122776
+ * @remarks
122777
+ * [Api set: PowerPointApi 1.4]
122778
+ */
122779
+ wavyDouble = "WavyDouble",
122596
122780
  }
122597
122781
  /**
122598
122782
  * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -122645,96 +122829,50 @@ declare namespace PowerPoint {
122645
122829
  thaiDistributed = "ThaiDistributed",
122646
122830
  }
122647
122831
  /**
122648
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
122832
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
122833
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
122834
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
122649
122835
  *
122650
122836
  * @remarks
122651
122837
  * [Api set: PowerPointApi 1.4]
122652
122838
  */
122653
- class ParagraphFormat extends OfficeExtension.ClientObject {
122654
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122655
- context: RequestContext;
122839
+ enum TextVerticalAlignment {
122656
122840
  /**
122657
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
122658
- *
122841
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
122659
122842
  * @remarks
122660
122843
  * [Api set: PowerPointApi 1.4]
122661
122844
  */
122662
- readonly bulletFormat: PowerPoint.BulletFormat;
122845
+ top = "Top",
122663
122846
  /**
122664
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
122665
- *
122847
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
122666
122848
  * @remarks
122667
122849
  * [Api set: PowerPointApi 1.4]
122668
122850
  */
122669
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
122670
- /**
122671
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122672
- *
122673
- * @param options Provides options for which properties of the object to load.
122674
- */
122675
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
122676
- /**
122677
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122678
- *
122679
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122680
- */
122681
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
122682
- /**
122683
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122684
- *
122685
- * @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.
122686
- */
122687
- load(propertyNamesAndPaths?: {
122688
- select?: string;
122689
- expand?: string;
122690
- }): PowerPoint.ParagraphFormat;
122691
- /**
122692
- * 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.)
122693
- * Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
122694
- */
122695
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
122696
- }
122697
- /**
122698
- * Represents the available options when adding shapes.
122699
- *
122700
- * @remarks
122701
- * [Api set: PowerPointApi 1.4]
122702
- */
122703
- interface ShapeAddOptions {
122851
+ middle = "Middle",
122704
122852
  /**
122705
- * Specifies the height, in points, of the shape.
122706
- When not provided, a default value will be used.
122707
- Throws an `InvalidArgument` exception when set with a negative value.
122708
- *
122853
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
122709
122854
  * @remarks
122710
122855
  * [Api set: PowerPointApi 1.4]
122711
122856
  */
122712
- height?: number;
122857
+ bottom = "Bottom",
122713
122858
  /**
122714
- * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
122715
- When not provided, a default value will be used.
122716
- *
122859
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122717
122860
  * @remarks
122718
122861
  * [Api set: PowerPointApi 1.4]
122719
122862
  */
122720
- left?: number;
122863
+ topCentered = "TopCentered",
122721
122864
  /**
122722
- * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
122723
- When not provided, a default value will be used.
122724
- *
122865
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122725
122866
  * @remarks
122726
122867
  * [Api set: PowerPointApi 1.4]
122727
122868
  */
122728
- top?: number;
122869
+ middleCentered = "MiddleCentered",
122729
122870
  /**
122730
- * Specifies the width, in points, of the shape.
122731
- When not provided, a default value will be used.
122732
- Throws an `InvalidArgument` exception when set with a negative value.
122733
- *
122871
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122734
122872
  * @remarks
122735
122873
  * [Api set: PowerPointApi 1.4]
122736
122874
  */
122737
- width?: number;
122875
+ bottomCentered = "BottomCentered",
122738
122876
  }
122739
122877
  /**
122740
122878
  * Represents the collection of shapes.
@@ -122864,6 +123002,31 @@ declare namespace PowerPoint {
122864
123002
  */
122865
123003
  toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
122866
123004
  }
123005
+ /**
123006
+ * Represents the available options when getting an image of a slide.
123007
+ *
123008
+ * @remarks
123009
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123010
+ * @beta
123011
+ */
123012
+ interface SlideGetImageOptions {
123013
+ /**
123014
+ * The desired height of the resulting image in pixels.
123015
+ *
123016
+ * @remarks
123017
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123018
+ * @beta
123019
+ */
123020
+ height?: number;
123021
+ /**
123022
+ * The desired width of the resulting image in pixels.
123023
+ *
123024
+ * @remarks
123025
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123026
+ * @beta
123027
+ */
123028
+ width?: number;
123029
+ }
122867
123030
  /**
122868
123031
  * Represents the layout of a slide.
122869
123032
  *
@@ -123121,22 +123284,22 @@ declare namespace PowerPoint {
123121
123284
  /** Gets the loaded child items in this collection. */
123122
123285
  readonly items: PowerPoint.Tag[];
123123
123286
  /**
123124
- * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
123287
+ * Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given `value`.
123125
123288
  *
123126
123289
  * @remarks
123127
123290
  * [Api set: PowerPointApi 1.3]
123128
123291
  *
123129
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
123292
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. The key string is capitalized when saved in the document.
123130
123293
  * @param value The value of the tag.
123131
123294
  */
123132
123295
  add(key: string, value: string): void;
123133
123296
  /**
123134
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
123297
+ * Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
123135
123298
  *
123136
123299
  * @remarks
123137
123300
  * [Api set: PowerPointApi 1.3]
123138
123301
  *
123139
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
123302
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. This parameter is case-insensitive.
123140
123303
  */
123141
123304
  delete(key: string): void;
123142
123305
  /**
@@ -123153,7 +123316,7 @@ declare namespace PowerPoint {
123153
123316
  * @remarks
123154
123317
  * [Api set: PowerPointApi 1.3]
123155
123318
  *
123156
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
123319
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
123157
123320
  * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
123158
123321
  */
123159
123322
  getItem(key: string): PowerPoint.Tag;
@@ -123173,7 +123336,7 @@ declare namespace PowerPoint {
123173
123336
  * @remarks
123174
123337
  * [Api set: PowerPointApi 1.3]
123175
123338
  *
123176
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
123339
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
123177
123340
  * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
123178
123341
  */
123179
123342
  getItemOrNullObject(key: string): PowerPoint.Tag;
@@ -123252,6 +123415,27 @@ declare namespace PowerPoint {
123252
123415
  * [Api set: PowerPointApi 1.2]
123253
123416
  */
123254
123417
  delete(): void;
123418
+ /**
123419
+ * Exports the slide to its own presentation file, returned as base64-encoded data.
123420
+ *
123421
+ * @remarks
123422
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123423
+ * @beta
123424
+ */
123425
+ exportAsBase64(): OfficeExtension.ClientResult<string>;
123426
+ /**
123427
+ * Renders an image of the slide. The image is scaled to fit into the desired dimensions.
123428
+ If width and height aren't specified, the true size of the slide is used. If only one
123429
+ of either width or height is specified, the other will be calculated to preserve aspect ratio.
123430
+ *
123431
+ * @remarks
123432
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123433
+ * @beta
123434
+ *
123435
+ * @param options Optional. Options to specify the desired size of the slide image.
123436
+ * @returns A base64 string of the slide image in PNG format.
123437
+ */
123438
+ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;
123255
123439
  /**
123256
123440
  * Selects the specified shapes. Existing shape selection is replaced with the new selection.
123257
123441
  *
@@ -123443,86 +123627,6 @@ declare namespace PowerPoint {
123443
123627
  */
123444
123628
  thinThin = "ThinThin",
123445
123629
  }
123446
- /**
123447
- * Specifies the dash style for a line.
123448
- *
123449
- * @remarks
123450
- * [Api set: PowerPointApi 1.4]
123451
- */
123452
- enum ShapeLineDashStyle {
123453
- /**
123454
- * The dash line pattern
123455
- * @remarks
123456
- * [Api set: PowerPointApi 1.4]
123457
- */
123458
- dash = "Dash",
123459
- /**
123460
- * The dash-dot line pattern
123461
- * @remarks
123462
- * [Api set: PowerPointApi 1.4]
123463
- */
123464
- dashDot = "DashDot",
123465
- /**
123466
- * The dash-dot-dot line pattern
123467
- * @remarks
123468
- * [Api set: PowerPointApi 1.4]
123469
- */
123470
- dashDotDot = "DashDotDot",
123471
- /**
123472
- * The long dash line pattern
123473
- * @remarks
123474
- * [Api set: PowerPointApi 1.4]
123475
- */
123476
- longDash = "LongDash",
123477
- /**
123478
- * The long dash-dot line pattern
123479
- * @remarks
123480
- * [Api set: PowerPointApi 1.4]
123481
- */
123482
- longDashDot = "LongDashDot",
123483
- /**
123484
- * The round dot line pattern
123485
- * @remarks
123486
- * [Api set: PowerPointApi 1.4]
123487
- */
123488
- roundDot = "RoundDot",
123489
- /**
123490
- * The solid line pattern
123491
- * @remarks
123492
- * [Api set: PowerPointApi 1.4]
123493
- */
123494
- solid = "Solid",
123495
- /**
123496
- * The square dot line pattern
123497
- * @remarks
123498
- * [Api set: PowerPointApi 1.4]
123499
- */
123500
- squareDot = "SquareDot",
123501
- /**
123502
- * The long dash-dot-dot line pattern
123503
- * @remarks
123504
- * [Api set: PowerPointApi 1.4]
123505
- */
123506
- longDashDotDot = "LongDashDotDot",
123507
- /**
123508
- * The system dash line pattern
123509
- * @remarks
123510
- * [Api set: PowerPointApi 1.4]
123511
- */
123512
- systemDash = "SystemDash",
123513
- /**
123514
- * The system dot line pattern
123515
- * @remarks
123516
- * [Api set: PowerPointApi 1.4]
123517
- */
123518
- systemDot = "SystemDot",
123519
- /**
123520
- * The system dash-dot line pattern
123521
- * @remarks
123522
- * [Api set: PowerPointApi 1.4]
123523
- */
123524
- systemDashDot = "SystemDashDot",
123525
- }
123526
123630
  /**
123527
123631
  * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
123528
123632
  *
@@ -123638,6 +123742,12 @@ declare namespace PowerPoint {
123638
123742
  * [Api set: PowerPointApi 1.4]
123639
123743
  */
123640
123744
  line = "Line",
123745
+ /**
123746
+ * The shape is a table
123747
+ * @remarks
123748
+ * [Api set: PowerPointApi 1.4]
123749
+ */
123750
+ table = "Table",
123641
123751
  }
123642
123752
  /**
123643
123753
  * Determines the type of automatic sizing allowed.
@@ -123672,160 +123782,97 @@ declare namespace PowerPoint {
123672
123782
  autoSizeMixed = "AutoSizeMixed",
123673
123783
  }
123674
123784
  /**
123675
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
123676
- If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
123677
- To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
123785
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
123678
123786
  *
123679
123787
  * @remarks
123680
123788
  * [Api set: PowerPointApi 1.4]
123681
123789
  */
123682
- enum TextVerticalAlignment {
123683
- /**
123684
- * Specifies that the `TextFrame` should be top aligned to the `Shape`.
123685
- * @remarks
123686
- * [Api set: PowerPointApi 1.4]
123687
- */
123688
- top = "Top",
123790
+ class BulletFormat extends OfficeExtension.ClientObject {
123791
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123792
+ context: RequestContext;
123689
123793
  /**
123690
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
123794
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
123795
+ *
123691
123796
  * @remarks
123692
123797
  * [Api set: PowerPointApi 1.4]
123693
123798
  */
123694
- middle = "Middle",
123799
+ visible: boolean;
123695
123800
  /**
123696
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
123697
- * @remarks
123698
- * [Api set: PowerPointApi 1.4]
123801
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123802
+ *
123803
+ * @param options Provides options for which properties of the object to load.
123699
123804
  */
123700
- bottom = "Bottom",
123805
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
123701
123806
  /**
123702
- * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123703
- * @remarks
123704
- * [Api set: PowerPointApi 1.4]
123807
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123808
+ *
123809
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123705
123810
  */
123706
- topCentered = "TopCentered",
123811
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
123707
123812
  /**
123708
- * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123709
- * @remarks
123710
- * [Api set: PowerPointApi 1.4]
123813
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123814
+ *
123815
+ * @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.
123711
123816
  */
123712
- middleCentered = "MiddleCentered",
123817
+ load(propertyNamesAndPaths?: {
123818
+ select?: string;
123819
+ expand?: string;
123820
+ }): PowerPoint.BulletFormat;
123713
123821
  /**
123714
- * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123715
- * @remarks
123716
- * [Api set: PowerPointApi 1.4]
123717
- */
123718
- bottomCentered = "BottomCentered",
123822
+ * 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.)
123823
+ * Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
123824
+ */
123825
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
123719
123826
  }
123720
123827
  /**
123721
- * The type of underline applied to a font.
123828
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
123722
123829
  *
123723
123830
  * @remarks
123724
123831
  * [Api set: PowerPointApi 1.4]
123725
123832
  */
123726
- enum ShapeFontUnderlineStyle {
123727
- /**
123728
- * No underlining.
123729
- * @remarks
123730
- * [Api set: PowerPointApi 1.4]
123731
- */
123732
- none = "None",
123733
- /**
123734
- * Regular single line underlining.
123735
- * @remarks
123736
- * [Api set: PowerPointApi 1.4]
123737
- */
123738
- single = "Single",
123739
- /**
123740
- * Underlining of text with double lines.
123741
- * @remarks
123742
- * [Api set: PowerPointApi 1.4]
123743
- */
123744
- double = "Double",
123745
- /**
123746
- * Underlining of text with a thick line.
123747
- * @remarks
123748
- * [Api set: PowerPointApi 1.4]
123749
- */
123750
- heavy = "Heavy",
123751
- /**
123752
- * Underlining of text with a dotted line.
123753
- * @remarks
123754
- * [Api set: PowerPointApi 1.4]
123755
- */
123756
- dotted = "Dotted",
123757
- /**
123758
- * Underlining of text with a thick, dotted line.
123759
- * @remarks
123760
- * [Api set: PowerPointApi 1.4]
123761
- */
123762
- dottedHeavy = "DottedHeavy",
123763
- /**
123764
- * Underlining of text with a line containing dashes.
123765
- * @remarks
123766
- * [Api set: PowerPointApi 1.4]
123767
- */
123768
- dash = "Dash",
123769
- /**
123770
- * Underlining of text with a thick line containing dashes.
123771
- * @remarks
123772
- * [Api set: PowerPointApi 1.4]
123773
- */
123774
- dashHeavy = "DashHeavy",
123775
- /**
123776
- * Underlining of text with a line containing long dashes.
123777
- * @remarks
123778
- * [Api set: PowerPointApi 1.4]
123779
- */
123780
- dashLong = "DashLong",
123781
- /**
123782
- * Underlining of text with a thick line containing long dashes.
123783
- * @remarks
123784
- * [Api set: PowerPointApi 1.4]
123785
- */
123786
- dashLongHeavy = "DashLongHeavy",
123787
- /**
123788
- * Underlining of text with a line containing dots and dashes.
123789
- * @remarks
123790
- * [Api set: PowerPointApi 1.4]
123791
- */
123792
- dotDash = "DotDash",
123833
+ class ParagraphFormat extends OfficeExtension.ClientObject {
123834
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123835
+ context: RequestContext;
123793
123836
  /**
123794
- * Underlining of text with a thick line containing dots and dashes.
123837
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
123838
+ *
123795
123839
  * @remarks
123796
123840
  * [Api set: PowerPointApi 1.4]
123797
123841
  */
123798
- dotDashHeavy = "DotDashHeavy",
123842
+ readonly bulletFormat: PowerPoint.BulletFormat;
123799
123843
  /**
123800
- * Underlining of text with a line containing double dots and dashes.
123844
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
123845
+ *
123801
123846
  * @remarks
123802
123847
  * [Api set: PowerPointApi 1.4]
123803
123848
  */
123804
- dotDotDash = "DotDotDash",
123849
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
123805
123850
  /**
123806
- * Underlining of text with a thick line containing double dots and dashes.
123807
- * @remarks
123808
- * [Api set: PowerPointApi 1.4]
123851
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123852
+ *
123853
+ * @param options Provides options for which properties of the object to load.
123809
123854
  */
123810
- dotDotDashHeavy = "DotDotDashHeavy",
123855
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
123811
123856
  /**
123812
- * Underlining of text with a wavy line.
123813
- * @remarks
123814
- * [Api set: PowerPointApi 1.4]
123857
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123858
+ *
123859
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123815
123860
  */
123816
- wavy = "Wavy",
123861
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
123817
123862
  /**
123818
- * Underlining of text with a thick, wavy line.
123819
- * @remarks
123820
- * [Api set: PowerPointApi 1.4]
123863
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123864
+ *
123865
+ * @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.
123821
123866
  */
123822
- wavyHeavy = "WavyHeavy",
123867
+ load(propertyNamesAndPaths?: {
123868
+ select?: string;
123869
+ expand?: string;
123870
+ }): PowerPoint.ParagraphFormat;
123823
123871
  /**
123824
- * Underlining of text with double wavy lines.
123825
- * @remarks
123826
- * [Api set: PowerPointApi 1.4]
123827
- */
123828
- wavyDouble = "WavyDouble",
123872
+ * 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.)
123873
+ * Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
123874
+ */
123875
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
123829
123876
  }
123830
123877
  /**
123831
123878
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -124193,7 +124240,7 @@ declare namespace PowerPoint {
124193
124240
  * @remarks
124194
124241
  * [Api set: PowerPointApi 1.4]
124195
124242
  */
124196
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
124243
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
124197
124244
  /**
124198
124245
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
124199
124246
  *
@@ -124277,6 +124324,61 @@ declare namespace PowerPoint {
124277
124324
  */
124278
124325
  toJSON(): PowerPoint.Interfaces.ShapeData;
124279
124326
  }
124327
+ /**
124328
+ * Specifies the formatting options for when slides are inserted.
124329
+ *
124330
+ * @remarks
124331
+ * [Api set: PowerPointApi 1.2]
124332
+ */
124333
+ enum InsertSlideFormatting {
124334
+ /**
124335
+ * Copy the source theme into the target presentation and use that theme.
124336
+ * @remarks
124337
+ * [Api set: PowerPointApi 1.2]
124338
+ */
124339
+ keepSourceFormatting = "KeepSourceFormatting",
124340
+ /**
124341
+ * Use the existing theme in the target presentation.
124342
+ * @remarks
124343
+ * [Api set: PowerPointApi 1.2]
124344
+ */
124345
+ useDestinationTheme = "UseDestinationTheme",
124346
+ }
124347
+ /**
124348
+ * Represents the available options when inserting slides.
124349
+ *
124350
+ * @remarks
124351
+ * [Api set: PowerPointApi 1.2]
124352
+ */
124353
+ interface InsertSlideOptions {
124354
+ /**
124355
+ * Specifies which formatting to use during slide insertion.
124356
+ The default option is to use "KeepSourceFormatting".
124357
+ *
124358
+ * @remarks
124359
+ * [Api set: PowerPointApi 1.2]
124360
+ */
124361
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
124362
+ /**
124363
+ * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
124364
+ The order of these slides is preserved during the insertion.
124365
+ If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
124366
+ All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
124367
+ *
124368
+ * @remarks
124369
+ * [Api set: PowerPointApi 1.2]
124370
+ */
124371
+ sourceSlideIds?: string[];
124372
+ /**
124373
+ * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
124374
+ If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
124375
+ If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
124376
+ *
124377
+ * @remarks
124378
+ * [Api set: PowerPointApi 1.2]
124379
+ */
124380
+ targetSlideId?: string;
124381
+ }
124280
124382
  /**
124281
124383
  * Represents a collection of shapes.
124282
124384
  *
@@ -124601,26 +124703,6 @@ declare namespace PowerPoint {
124601
124703
  */
124602
124704
  $skip?: number;
124603
124705
  }
124604
- /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
124605
- interface BulletFormatUpdateData {
124606
- /**
124607
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124608
- *
124609
- * @remarks
124610
- * [Api set: PowerPointApi 1.4]
124611
- */
124612
- visible?: boolean;
124613
- }
124614
- /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
124615
- interface ParagraphFormatUpdateData {
124616
- /**
124617
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
124618
- *
124619
- * @remarks
124620
- * [Api set: PowerPointApi 1.4]
124621
- */
124622
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124623
- }
124624
124706
  /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
124625
124707
  interface ShapeCollectionUpdateData {
124626
124708
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -124705,6 +124787,26 @@ declare namespace PowerPoint {
124705
124787
  */
124706
124788
  weight?: number;
124707
124789
  }
124790
+ /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
124791
+ interface BulletFormatUpdateData {
124792
+ /**
124793
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124794
+ *
124795
+ * @remarks
124796
+ * [Api set: PowerPointApi 1.4]
124797
+ */
124798
+ visible?: boolean;
124799
+ }
124800
+ /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
124801
+ interface ParagraphFormatUpdateData {
124802
+ /**
124803
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
124804
+ *
124805
+ * @remarks
124806
+ * [Api set: PowerPointApi 1.4]
124807
+ */
124808
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124809
+ }
124708
124810
  /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
124709
124811
  interface ShapeFontUpdateData {
124710
124812
  /**
@@ -124884,27 +124986,14 @@ declare namespace PowerPoint {
124884
124986
  }
124885
124987
  /** An interface describing the data returned by calling `presentation.toJSON()`. */
124886
124988
  interface PresentationData {
124887
- title?: string;
124888
- }
124889
- /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
124890
- interface BulletFormatData {
124891
- /**
124892
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124893
- *
124894
- * @remarks
124895
- * [Api set: PowerPointApi 1.4]
124896
- */
124897
- visible?: boolean;
124898
- }
124899
- /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
124900
- interface ParagraphFormatData {
124901
124989
  /**
124902
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
124990
+ * Gets the ID of the presentation.
124903
124991
  *
124904
124992
  * @remarks
124905
- * [Api set: PowerPointApi 1.4]
124993
+ * [Api set: PowerPointApi 1.5]
124906
124994
  */
124907
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124995
+ id?: string;
124996
+ title?: string;
124908
124997
  }
124909
124998
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
124910
124999
  interface ShapeCollectionData {
@@ -125048,6 +125137,26 @@ declare namespace PowerPoint {
125048
125137
  */
125049
125138
  weight?: number;
125050
125139
  }
125140
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
125141
+ interface BulletFormatData {
125142
+ /**
125143
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125144
+ *
125145
+ * @remarks
125146
+ * [Api set: PowerPointApi 1.4]
125147
+ */
125148
+ visible?: boolean;
125149
+ }
125150
+ /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
125151
+ interface ParagraphFormatData {
125152
+ /**
125153
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
125154
+ *
125155
+ * @remarks
125156
+ * [Api set: PowerPointApi 1.4]
125157
+ */
125158
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
125159
+ }
125051
125160
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
125052
125161
  interface ShapeFontData {
125053
125162
  /**
@@ -125221,7 +125330,7 @@ declare namespace PowerPoint {
125221
125330
  * @remarks
125222
125331
  * [Api set: PowerPointApi 1.4]
125223
125332
  */
125224
- type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
125333
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
125225
125334
  /**
125226
125335
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
125227
125336
  *
@@ -125251,56 +125360,18 @@ declare namespace PowerPoint {
125251
125360
  * [Api set: PowerPointApi 1.0]
125252
125361
  */
125253
125362
  interface PresentationLoadOptions {
125254
- /**
125255
- 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`).
125256
- */
125257
- $all?: boolean;
125258
- title?: boolean;
125259
- }
125260
- /**
125261
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
125262
- *
125263
- * @remarks
125264
- * [Api set: PowerPointApi 1.4]
125265
- */
125266
- interface BulletFormatLoadOptions {
125267
125363
  /**
125268
125364
  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`).
125269
125365
  */
125270
125366
  $all?: boolean;
125271
125367
  /**
125272
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125368
+ * Gets the ID of the presentation.
125273
125369
  *
125274
125370
  * @remarks
125275
- * [Api set: PowerPointApi 1.4]
125276
- */
125277
- visible?: boolean;
125278
- }
125279
- /**
125280
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
125281
- *
125282
- * @remarks
125283
- * [Api set: PowerPointApi 1.4]
125284
- */
125285
- interface ParagraphFormatLoadOptions {
125286
- /**
125287
- 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`).
125288
- */
125289
- $all?: boolean;
125290
- /**
125291
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
125292
- *
125293
- * @remarks
125294
- * [Api set: PowerPointApi 1.4]
125295
- */
125296
- bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
125297
- /**
125298
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
125299
- *
125300
- * @remarks
125301
- * [Api set: PowerPointApi 1.4]
125371
+ * [Api set: PowerPointApi 1.5]
125302
125372
  */
125303
- horizontalAlignment?: boolean;
125373
+ id?: boolean;
125374
+ title?: boolean;
125304
125375
  }
125305
125376
  /**
125306
125377
  * Represents the collection of shapes.
@@ -125634,6 +125705,51 @@ declare namespace PowerPoint {
125634
125705
  */
125635
125706
  weight?: boolean;
125636
125707
  }
125708
+ /**
125709
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
125710
+ *
125711
+ * @remarks
125712
+ * [Api set: PowerPointApi 1.4]
125713
+ */
125714
+ interface BulletFormatLoadOptions {
125715
+ /**
125716
+ 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`).
125717
+ */
125718
+ $all?: boolean;
125719
+ /**
125720
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125721
+ *
125722
+ * @remarks
125723
+ * [Api set: PowerPointApi 1.4]
125724
+ */
125725
+ visible?: boolean;
125726
+ }
125727
+ /**
125728
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
125729
+ *
125730
+ * @remarks
125731
+ * [Api set: PowerPointApi 1.4]
125732
+ */
125733
+ interface ParagraphFormatLoadOptions {
125734
+ /**
125735
+ 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`).
125736
+ */
125737
+ $all?: boolean;
125738
+ /**
125739
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
125740
+ *
125741
+ * @remarks
125742
+ * [Api set: PowerPointApi 1.4]
125743
+ */
125744
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
125745
+ /**
125746
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
125747
+ *
125748
+ * @remarks
125749
+ * [Api set: PowerPointApi 1.4]
125750
+ */
125751
+ horizontalAlignment?: boolean;
125752
+ }
125637
125753
  /**
125638
125754
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
125639
125755
  *