@types/office-js 1.0.492 → 1.0.494
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.
- office-js/README.md +1 -1
- office-js/index.d.ts +2511 -8
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -4561,7 +4561,7 @@ declare namespace Office {
|
|
|
4561
4561
|
*
|
|
4562
4562
|
* @remarks
|
|
4563
4563
|
*
|
|
4564
|
-
* The `contentLanguage` value reflects the **Editing Language** setting specified with **File**
|
|
4564
|
+
* The `contentLanguage` value reflects the **Editing Language** setting specified with **File** > **Options** > **Language** in the Office
|
|
4565
4565
|
* application.
|
|
4566
4566
|
*
|
|
4567
4567
|
* **Support details**
|
|
@@ -4597,7 +4597,7 @@ declare namespace Office {
|
|
|
4597
4597
|
*
|
|
4598
4598
|
* The returned value is a string in the RFC 1766 Language tag format, such as en-US.
|
|
4599
4599
|
*
|
|
4600
|
-
* The `displayLanguage` value reflects the current **Display Language** setting specified with **File**
|
|
4600
|
+
* The `displayLanguage` value reflects the current **Display Language** setting specified with **File** > **Options** > **Language** in the Office
|
|
4601
4601
|
* application.
|
|
4602
4602
|
*
|
|
4603
4603
|
* When using in Outlook, the applicable modes are Compose or Read.
|
|
@@ -7102,7 +7102,7 @@ declare namespace Office {
|
|
|
7102
7102
|
* Provides access to the properties for Office theme colors.
|
|
7103
7103
|
*
|
|
7104
7104
|
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
|
|
7105
|
-
* The user sets a theme in an Office application through **File**
|
|
7105
|
+
* The user sets a theme in an Office application through **File** > **Account** or **Office Account** > **Office Theme**.
|
|
7106
7106
|
* The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
|
|
7107
7107
|
* task pane add-ins.
|
|
7108
7108
|
*
|
|
@@ -8094,7 +8094,7 @@ declare namespace Office {
|
|
|
8094
8094
|
* </table>
|
|
8095
8095
|
*
|
|
8096
8096
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8097
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8097
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8098
8098
|
*
|
|
8099
8099
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8100
8100
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8148,7 +8148,7 @@ declare namespace Office {
|
|
|
8148
8148
|
* </table>
|
|
8149
8149
|
*
|
|
8150
8150
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8151
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8151
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8152
8152
|
*
|
|
8153
8153
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8154
8154
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8205,7 +8205,7 @@ declare namespace Office {
|
|
|
8205
8205
|
* </table>
|
|
8206
8206
|
*
|
|
8207
8207
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8208
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8208
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8209
8209
|
*
|
|
8210
8210
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8211
8211
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -8304,7 +8304,7 @@ declare namespace Office {
|
|
|
8304
8304
|
* </table>
|
|
8305
8305
|
*
|
|
8306
8306
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8307
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8307
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8308
8308
|
*
|
|
8309
8309
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8310
8310
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -125127,6 +125127,13 @@ declare namespace PowerPoint {
|
|
|
125127
125127
|
class Presentation extends OfficeExtension.ClientObject {
|
|
125128
125128
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
125129
125129
|
context: RequestContext;
|
|
125130
|
+
/**
|
|
125131
|
+
* Returns a collection of bindings that are associated with the presentation.
|
|
125132
|
+
*
|
|
125133
|
+
* @remarks
|
|
125134
|
+
* [Api set: PowerPointApi 1.8]
|
|
125135
|
+
*/
|
|
125136
|
+
readonly bindings: PowerPoint.BindingCollection;
|
|
125130
125137
|
/**
|
|
125131
125138
|
* Returns a collection of custom XML parts that are associated with the presentation.
|
|
125132
125139
|
*
|
|
@@ -125276,6 +125283,20 @@ declare namespace PowerPoint {
|
|
|
125276
125283
|
*/
|
|
125277
125284
|
slideMasterId?: string;
|
|
125278
125285
|
}
|
|
125286
|
+
/**
|
|
125287
|
+
* Represents the possible binding types.
|
|
125288
|
+
*
|
|
125289
|
+
* @remarks
|
|
125290
|
+
* [Api set: PowerPointApi 1.8]
|
|
125291
|
+
*/
|
|
125292
|
+
enum BindingType {
|
|
125293
|
+
/**
|
|
125294
|
+
* Represents a shape binding.
|
|
125295
|
+
* @remarks
|
|
125296
|
+
* [Api set: PowerPointApi 1.8]
|
|
125297
|
+
*/
|
|
125298
|
+
shape = "Shape",
|
|
125299
|
+
}
|
|
125279
125300
|
/**
|
|
125280
125301
|
* Represents a custom XML part object.
|
|
125281
125302
|
*
|
|
@@ -125511,6 +125532,134 @@ declare namespace PowerPoint {
|
|
|
125511
125532
|
*/
|
|
125512
125533
|
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
|
|
125513
125534
|
}
|
|
125535
|
+
/**
|
|
125536
|
+
* Specifies the type of a placeholder.
|
|
125537
|
+
*
|
|
125538
|
+
* @remarks
|
|
125539
|
+
* [Api set: PowerPointApi 1.8]
|
|
125540
|
+
*/
|
|
125541
|
+
enum PlaceholderType {
|
|
125542
|
+
/**
|
|
125543
|
+
* The placeholder is unsupported.
|
|
125544
|
+
* @remarks
|
|
125545
|
+
* [Api set: PowerPointApi 1.8]
|
|
125546
|
+
*/
|
|
125547
|
+
unsupported = "Unsupported",
|
|
125548
|
+
/**
|
|
125549
|
+
* The placeholder is for a date.
|
|
125550
|
+
* @remarks
|
|
125551
|
+
* [Api set: PowerPointApi 1.8]
|
|
125552
|
+
*/
|
|
125553
|
+
date = "Date",
|
|
125554
|
+
/**
|
|
125555
|
+
* The placeholder is for a slide number.
|
|
125556
|
+
* @remarks
|
|
125557
|
+
* [Api set: PowerPointApi 1.8]
|
|
125558
|
+
*/
|
|
125559
|
+
slideNumber = "SlideNumber",
|
|
125560
|
+
/**
|
|
125561
|
+
* The placeholder is for a footer.
|
|
125562
|
+
* @remarks
|
|
125563
|
+
* [Api set: PowerPointApi 1.8]
|
|
125564
|
+
*/
|
|
125565
|
+
footer = "Footer",
|
|
125566
|
+
/**
|
|
125567
|
+
* The placeholder is for a header.
|
|
125568
|
+
* @remarks
|
|
125569
|
+
* [Api set: PowerPointApi 1.8]
|
|
125570
|
+
*/
|
|
125571
|
+
header = "Header",
|
|
125572
|
+
/**
|
|
125573
|
+
* The placeholder is for a title.
|
|
125574
|
+
* @remarks
|
|
125575
|
+
* [Api set: PowerPointApi 1.8]
|
|
125576
|
+
*/
|
|
125577
|
+
title = "Title",
|
|
125578
|
+
/**
|
|
125579
|
+
* The placeholder is for a body.
|
|
125580
|
+
* @remarks
|
|
125581
|
+
* [Api set: PowerPointApi 1.8]
|
|
125582
|
+
*/
|
|
125583
|
+
body = "Body",
|
|
125584
|
+
/**
|
|
125585
|
+
* The placeholder is for a center title.
|
|
125586
|
+
* @remarks
|
|
125587
|
+
* [Api set: PowerPointApi 1.8]
|
|
125588
|
+
*/
|
|
125589
|
+
centerTitle = "CenterTitle",
|
|
125590
|
+
/**
|
|
125591
|
+
* The placeholder is for a subtitle.
|
|
125592
|
+
* @remarks
|
|
125593
|
+
* [Api set: PowerPointApi 1.8]
|
|
125594
|
+
*/
|
|
125595
|
+
subtitle = "Subtitle",
|
|
125596
|
+
/**
|
|
125597
|
+
* The placeholder is for a vertical title.
|
|
125598
|
+
* @remarks
|
|
125599
|
+
* [Api set: PowerPointApi 1.8]
|
|
125600
|
+
*/
|
|
125601
|
+
verticalTitle = "VerticalTitle",
|
|
125602
|
+
/**
|
|
125603
|
+
* The placeholder is for a vertical body.
|
|
125604
|
+
* @remarks
|
|
125605
|
+
* [Api set: PowerPointApi 1.8]
|
|
125606
|
+
*/
|
|
125607
|
+
verticalBody = "VerticalBody",
|
|
125608
|
+
/**
|
|
125609
|
+
* The placeholder is for generic content.
|
|
125610
|
+
* @remarks
|
|
125611
|
+
* [Api set: PowerPointApi 1.8]
|
|
125612
|
+
*/
|
|
125613
|
+
content = "Content",
|
|
125614
|
+
/**
|
|
125615
|
+
* The placeholder is for a chart.
|
|
125616
|
+
* @remarks
|
|
125617
|
+
* [Api set: PowerPointApi 1.8]
|
|
125618
|
+
*/
|
|
125619
|
+
chart = "Chart",
|
|
125620
|
+
/**
|
|
125621
|
+
* The placeholder is for a table.
|
|
125622
|
+
* @remarks
|
|
125623
|
+
* [Api set: PowerPointApi 1.8]
|
|
125624
|
+
*/
|
|
125625
|
+
table = "Table",
|
|
125626
|
+
/**
|
|
125627
|
+
* The placeholder is for an online picture.
|
|
125628
|
+
* @remarks
|
|
125629
|
+
* [Api set: PowerPointApi 1.8]
|
|
125630
|
+
*/
|
|
125631
|
+
onlinePicture = "OnlinePicture",
|
|
125632
|
+
/**
|
|
125633
|
+
* The placeholder is for a SmartArt.
|
|
125634
|
+
* @remarks
|
|
125635
|
+
* [Api set: PowerPointApi 1.8]
|
|
125636
|
+
*/
|
|
125637
|
+
smartArt = "SmartArt",
|
|
125638
|
+
/**
|
|
125639
|
+
* The placeholder is for media.
|
|
125640
|
+
* @remarks
|
|
125641
|
+
* [Api set: PowerPointApi 1.8]
|
|
125642
|
+
*/
|
|
125643
|
+
media = "Media",
|
|
125644
|
+
/**
|
|
125645
|
+
* The placeholder is for generic vertical content.
|
|
125646
|
+
* @remarks
|
|
125647
|
+
* [Api set: PowerPointApi 1.8]
|
|
125648
|
+
*/
|
|
125649
|
+
verticalContent = "VerticalContent",
|
|
125650
|
+
/**
|
|
125651
|
+
* The placeholder is for a picture.
|
|
125652
|
+
* @remarks
|
|
125653
|
+
* [Api set: PowerPointApi 1.8]
|
|
125654
|
+
*/
|
|
125655
|
+
picture = "Picture",
|
|
125656
|
+
/**
|
|
125657
|
+
* The placeholder is for a cameo.
|
|
125658
|
+
* @remarks
|
|
125659
|
+
* [Api set: PowerPointApi 1.8]
|
|
125660
|
+
*/
|
|
125661
|
+
cameo = "Cameo",
|
|
125662
|
+
}
|
|
125514
125663
|
/**
|
|
125515
125664
|
* Specifies the type of a shape.
|
|
125516
125665
|
*
|
|
@@ -125633,6 +125782,57 @@ declare namespace PowerPoint {
|
|
|
125633
125782
|
*/
|
|
125634
125783
|
textBox = "TextBox",
|
|
125635
125784
|
}
|
|
125785
|
+
/**
|
|
125786
|
+
* Represents the properties of a `placeholder` shape.
|
|
125787
|
+
*
|
|
125788
|
+
* @remarks
|
|
125789
|
+
* [Api set: PowerPointApi 1.8]
|
|
125790
|
+
*/
|
|
125791
|
+
class PlaceholderFormat extends OfficeExtension.ClientObject {
|
|
125792
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
125793
|
+
context: RequestContext;
|
|
125794
|
+
/**
|
|
125795
|
+
* Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
|
|
125796
|
+
Returns `null` if the placeholder is empty.
|
|
125797
|
+
*
|
|
125798
|
+
* @remarks
|
|
125799
|
+
* [Api set: PowerPointApi 1.8]
|
|
125800
|
+
*/
|
|
125801
|
+
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
125802
|
+
/**
|
|
125803
|
+
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
125804
|
+
*
|
|
125805
|
+
* @remarks
|
|
125806
|
+
* [Api set: PowerPointApi 1.8]
|
|
125807
|
+
*/
|
|
125808
|
+
readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
|
|
125809
|
+
/**
|
|
125810
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
125811
|
+
*
|
|
125812
|
+
* @param options Provides options for which properties of the object to load.
|
|
125813
|
+
*/
|
|
125814
|
+
load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;
|
|
125815
|
+
/**
|
|
125816
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
125817
|
+
*
|
|
125818
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
125819
|
+
*/
|
|
125820
|
+
load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat;
|
|
125821
|
+
/**
|
|
125822
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
125823
|
+
*
|
|
125824
|
+
* @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.
|
|
125825
|
+
*/
|
|
125826
|
+
load(propertyNamesAndPaths?: {
|
|
125827
|
+
select?: string;
|
|
125828
|
+
expand?: string;
|
|
125829
|
+
}): PowerPoint.PlaceholderFormat;
|
|
125830
|
+
/**
|
|
125831
|
+
* 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's passed to it.)
|
|
125832
|
+
* Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
125833
|
+
*/
|
|
125834
|
+
toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;
|
|
125835
|
+
}
|
|
125636
125836
|
/**
|
|
125637
125837
|
* Represents a single hyperlink.
|
|
125638
125838
|
*
|
|
@@ -127085,6 +127285,15 @@ declare namespace PowerPoint {
|
|
|
127085
127285
|
* [Api set: PowerPointApi 1.4]
|
|
127086
127286
|
*/
|
|
127087
127287
|
clear(): void;
|
|
127288
|
+
/**
|
|
127289
|
+
* Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
|
|
127290
|
+
*
|
|
127291
|
+
* @remarks
|
|
127292
|
+
* [Api set: PowerPointApi 1.8]
|
|
127293
|
+
*
|
|
127294
|
+
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
|
|
127295
|
+
*/
|
|
127296
|
+
setImage(base64EncodedImage: string): void;
|
|
127088
127297
|
/**
|
|
127089
127298
|
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
|
|
127090
127299
|
*
|
|
@@ -127240,6 +127449,19 @@ declare namespace PowerPoint {
|
|
|
127240
127449
|
class ShapeFont extends OfficeExtension.ClientObject {
|
|
127241
127450
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
127242
127451
|
context: RequestContext;
|
|
127452
|
+
/**
|
|
127453
|
+
* Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
|
|
127454
|
+
*
|
|
127455
|
+
* - `true`: All the text has the **All Caps** attribute.
|
|
127456
|
+
*
|
|
127457
|
+
* - `false`: None of the text has the **All Caps** attribute.
|
|
127458
|
+
*
|
|
127459
|
+
* - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
|
|
127460
|
+
*
|
|
127461
|
+
* @remarks
|
|
127462
|
+
* [Api set: PowerPointApi 1.8]
|
|
127463
|
+
*/
|
|
127464
|
+
allCaps: boolean | null;
|
|
127243
127465
|
/**
|
|
127244
127466
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
127245
127467
|
*
|
|
@@ -127260,6 +127482,19 @@ declare namespace PowerPoint {
|
|
|
127260
127482
|
* [Api set: PowerPointApi 1.4]
|
|
127261
127483
|
*/
|
|
127262
127484
|
color: string | null;
|
|
127485
|
+
/**
|
|
127486
|
+
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
127487
|
+
*
|
|
127488
|
+
* - `true`: All the text has the **Double strikethrough** attribute.
|
|
127489
|
+
*
|
|
127490
|
+
* - `false`: None of the text has the **Double strikethrough** attribute.
|
|
127491
|
+
*
|
|
127492
|
+
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
127493
|
+
*
|
|
127494
|
+
* @remarks
|
|
127495
|
+
* [Api set: PowerPointApi 1.8]
|
|
127496
|
+
*/
|
|
127497
|
+
doubleStrikethrough: boolean | null;
|
|
127263
127498
|
/**
|
|
127264
127499
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
127265
127500
|
*
|
|
@@ -127287,6 +127522,58 @@ declare namespace PowerPoint {
|
|
|
127287
127522
|
* [Api set: PowerPointApi 1.4]
|
|
127288
127523
|
*/
|
|
127289
127524
|
size: number | null;
|
|
127525
|
+
/**
|
|
127526
|
+
* Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
|
|
127527
|
+
*
|
|
127528
|
+
* - `true`: All the text has the **Small Caps** attribute.
|
|
127529
|
+
*
|
|
127530
|
+
* - `false`: None of the text has the **Small Caps** attribute.
|
|
127531
|
+
*
|
|
127532
|
+
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
127533
|
+
*
|
|
127534
|
+
* @remarks
|
|
127535
|
+
* [Api set: PowerPointApi 1.8]
|
|
127536
|
+
*/
|
|
127537
|
+
smallCaps: boolean | null;
|
|
127538
|
+
/**
|
|
127539
|
+
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
127540
|
+
*
|
|
127541
|
+
* - `true`: All the text has the **Strikethrough** attribute.
|
|
127542
|
+
*
|
|
127543
|
+
* - `false`: None of the text has the **Strikethrough** attribute.
|
|
127544
|
+
*
|
|
127545
|
+
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
127546
|
+
*
|
|
127547
|
+
* @remarks
|
|
127548
|
+
* [Api set: PowerPointApi 1.8]
|
|
127549
|
+
*/
|
|
127550
|
+
strikethrough: boolean | null;
|
|
127551
|
+
/**
|
|
127552
|
+
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
127553
|
+
*
|
|
127554
|
+
* - `true`: All the text has the **Subscript** attribute.
|
|
127555
|
+
*
|
|
127556
|
+
* - `false`: None of the text has the **Subscript** attribute.
|
|
127557
|
+
*
|
|
127558
|
+
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
127559
|
+
*
|
|
127560
|
+
* @remarks
|
|
127561
|
+
* [Api set: PowerPointApi 1.8]
|
|
127562
|
+
*/
|
|
127563
|
+
subscript: boolean | null;
|
|
127564
|
+
/**
|
|
127565
|
+
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
127566
|
+
*
|
|
127567
|
+
* - `true`: All the text has the **Superscript** attribute.
|
|
127568
|
+
*
|
|
127569
|
+
* - `false`: None of the text has the **Superscript** attribute.
|
|
127570
|
+
*
|
|
127571
|
+
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
127572
|
+
*
|
|
127573
|
+
* @remarks
|
|
127574
|
+
* [Api set: PowerPointApi 1.8]
|
|
127575
|
+
*/
|
|
127576
|
+
superscript: boolean | null;
|
|
127290
127577
|
/**
|
|
127291
127578
|
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
127292
127579
|
*
|
|
@@ -127321,6 +127608,120 @@ declare namespace PowerPoint {
|
|
|
127321
127608
|
*/
|
|
127322
127609
|
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
127323
127610
|
}
|
|
127611
|
+
/**
|
|
127612
|
+
* Represents the font attributes, such as font name, size, and color.
|
|
127613
|
+
*
|
|
127614
|
+
* @remarks
|
|
127615
|
+
* [Api set: PowerPointApi 1.8]
|
|
127616
|
+
*/
|
|
127617
|
+
interface FontProperties {
|
|
127618
|
+
/**
|
|
127619
|
+
* Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
|
|
127620
|
+
*
|
|
127621
|
+
* @remarks
|
|
127622
|
+
* [Api set: PowerPointApi 1.8]
|
|
127623
|
+
*/
|
|
127624
|
+
allCaps?: boolean | undefined;
|
|
127625
|
+
/**
|
|
127626
|
+
* Represents the bold status of font.
|
|
127627
|
+
*
|
|
127628
|
+
* @remarks
|
|
127629
|
+
* [Api set: PowerPointApi 1.8]
|
|
127630
|
+
*/
|
|
127631
|
+
bold?: boolean | undefined;
|
|
127632
|
+
/**
|
|
127633
|
+
* Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
|
|
127634
|
+
*
|
|
127635
|
+
* @remarks
|
|
127636
|
+
* [Api set: PowerPointApi 1.8]
|
|
127637
|
+
*/
|
|
127638
|
+
color?: string | undefined;
|
|
127639
|
+
/**
|
|
127640
|
+
* Represents the double-strikethrough status of the font.
|
|
127641
|
+
*
|
|
127642
|
+
* @remarks
|
|
127643
|
+
* [Api set: PowerPointApi 1.8]
|
|
127644
|
+
*/
|
|
127645
|
+
doubleStrikethrough?: boolean | undefined;
|
|
127646
|
+
/**
|
|
127647
|
+
* Represents the italic status of font.
|
|
127648
|
+
*
|
|
127649
|
+
* @remarks
|
|
127650
|
+
* [Api set: PowerPointApi 1.8]
|
|
127651
|
+
*/
|
|
127652
|
+
italic?: boolean | undefined;
|
|
127653
|
+
/**
|
|
127654
|
+
* Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
|
|
127655
|
+
*
|
|
127656
|
+
* @remarks
|
|
127657
|
+
* [Api set: PowerPointApi 1.8]
|
|
127658
|
+
*/
|
|
127659
|
+
name?: string | undefined;
|
|
127660
|
+
/**
|
|
127661
|
+
* Represents the font size in points (e.g., 11).
|
|
127662
|
+
*
|
|
127663
|
+
* @remarks
|
|
127664
|
+
* [Api set: PowerPointApi 1.8]
|
|
127665
|
+
*/
|
|
127666
|
+
size?: number | undefined;
|
|
127667
|
+
/**
|
|
127668
|
+
* Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
|
|
127669
|
+
*
|
|
127670
|
+
* @remarks
|
|
127671
|
+
* [Api set: PowerPointApi 1.8]
|
|
127672
|
+
*/
|
|
127673
|
+
smallCaps?: boolean | undefined;
|
|
127674
|
+
/**
|
|
127675
|
+
* Represents the strikethrough status of the font.
|
|
127676
|
+
*
|
|
127677
|
+
* @remarks
|
|
127678
|
+
* [Api set: PowerPointApi 1.8]
|
|
127679
|
+
*/
|
|
127680
|
+
strikethrough?: boolean | undefined;
|
|
127681
|
+
/**
|
|
127682
|
+
* Represents the subscript status of the font.
|
|
127683
|
+
*
|
|
127684
|
+
* @remarks
|
|
127685
|
+
* [Api set: PowerPointApi 1.8]
|
|
127686
|
+
*/
|
|
127687
|
+
subscript?: boolean | undefined;
|
|
127688
|
+
/**
|
|
127689
|
+
* Represents the superscript status of the font.
|
|
127690
|
+
*
|
|
127691
|
+
* @remarks
|
|
127692
|
+
* [Api set: PowerPointApi 1.8]
|
|
127693
|
+
*/
|
|
127694
|
+
superscript?: boolean | undefined;
|
|
127695
|
+
/**
|
|
127696
|
+
* Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
127697
|
+
*
|
|
127698
|
+
* @remarks
|
|
127699
|
+
* [Api set: PowerPointApi 1.8]
|
|
127700
|
+
*/
|
|
127701
|
+
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
|
|
127702
|
+
}
|
|
127703
|
+
/**
|
|
127704
|
+
* Represents a sequence of one or more characters with the same font attributes.
|
|
127705
|
+
*
|
|
127706
|
+
* @remarks
|
|
127707
|
+
* [Api set: PowerPointApi 1.8]
|
|
127708
|
+
*/
|
|
127709
|
+
interface TextRun {
|
|
127710
|
+
/**
|
|
127711
|
+
* The font attributes (such as font name, font size, and color) applied to this text run.
|
|
127712
|
+
*
|
|
127713
|
+
* @remarks
|
|
127714
|
+
* [Api set: PowerPointApi 1.8]
|
|
127715
|
+
*/
|
|
127716
|
+
font?: PowerPoint.FontProperties;
|
|
127717
|
+
/**
|
|
127718
|
+
* The text of this text run.
|
|
127719
|
+
*
|
|
127720
|
+
* @remarks
|
|
127721
|
+
* [Api set: PowerPointApi 1.8]
|
|
127722
|
+
*/
|
|
127723
|
+
text: string;
|
|
127724
|
+
}
|
|
127324
127725
|
/**
|
|
127325
127726
|
* Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
127326
127727
|
If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
|
|
@@ -127367,6 +127768,619 @@ declare namespace PowerPoint {
|
|
|
127367
127768
|
*/
|
|
127368
127769
|
bottomCentered = "BottomCentered",
|
|
127369
127770
|
}
|
|
127771
|
+
/**
|
|
127772
|
+
* Represents a table.
|
|
127773
|
+
*
|
|
127774
|
+
* @remarks
|
|
127775
|
+
* [Api set: PowerPointApi 1.8]
|
|
127776
|
+
*/
|
|
127777
|
+
class TableCell extends OfficeExtension.ClientObject {
|
|
127778
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
127779
|
+
context: RequestContext;
|
|
127780
|
+
/**
|
|
127781
|
+
* Gets the number of table columns this cell spans across.
|
|
127782
|
+
Will be greater than or equal to 1.
|
|
127783
|
+
*
|
|
127784
|
+
* @remarks
|
|
127785
|
+
* [Api set: PowerPointApi 1.8]
|
|
127786
|
+
*/
|
|
127787
|
+
readonly columnCount: number;
|
|
127788
|
+
/**
|
|
127789
|
+
* Gets the zero-based column index of the cell within the table.
|
|
127790
|
+
*
|
|
127791
|
+
* @remarks
|
|
127792
|
+
* [Api set: PowerPointApi 1.8]
|
|
127793
|
+
*/
|
|
127794
|
+
readonly columnIndex: number;
|
|
127795
|
+
/**
|
|
127796
|
+
* Gets the number of table rows this cell spans across.
|
|
127797
|
+
Will be greater than or equal to 1.
|
|
127798
|
+
*
|
|
127799
|
+
* @remarks
|
|
127800
|
+
* [Api set: PowerPointApi 1.8]
|
|
127801
|
+
*/
|
|
127802
|
+
readonly rowCount: number;
|
|
127803
|
+
/**
|
|
127804
|
+
* Gets the zero-based row index of the cell within the table.
|
|
127805
|
+
*
|
|
127806
|
+
* @remarks
|
|
127807
|
+
* [Api set: PowerPointApi 1.8]
|
|
127808
|
+
*/
|
|
127809
|
+
readonly rowIndex: number;
|
|
127810
|
+
/**
|
|
127811
|
+
* Specifies the text content of the table cell.
|
|
127812
|
+
*
|
|
127813
|
+
* @remarks
|
|
127814
|
+
* [Api set: PowerPointApi 1.8]
|
|
127815
|
+
*/
|
|
127816
|
+
text: string;
|
|
127817
|
+
/**
|
|
127818
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127819
|
+
*
|
|
127820
|
+
* @param options Provides options for which properties of the object to load.
|
|
127821
|
+
*/
|
|
127822
|
+
load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell;
|
|
127823
|
+
/**
|
|
127824
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127825
|
+
*
|
|
127826
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
127827
|
+
*/
|
|
127828
|
+
load(propertyNames?: string | string[]): PowerPoint.TableCell;
|
|
127829
|
+
/**
|
|
127830
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127831
|
+
*
|
|
127832
|
+
* @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.
|
|
127833
|
+
*/
|
|
127834
|
+
load(propertyNamesAndPaths?: {
|
|
127835
|
+
select?: string;
|
|
127836
|
+
expand?: string;
|
|
127837
|
+
}): PowerPoint.TableCell;
|
|
127838
|
+
/**
|
|
127839
|
+
* 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's passed to it.)
|
|
127840
|
+
* Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
|
|
127841
|
+
*/
|
|
127842
|
+
toJSON(): PowerPoint.Interfaces.TableCellData;
|
|
127843
|
+
}
|
|
127844
|
+
/**
|
|
127845
|
+
* Represents a collection of table cells.
|
|
127846
|
+
*
|
|
127847
|
+
* @remarks
|
|
127848
|
+
* [Api set: PowerPointApi 1.8]
|
|
127849
|
+
*/
|
|
127850
|
+
class TableCellCollection extends OfficeExtension.ClientObject {
|
|
127851
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
127852
|
+
context: RequestContext;
|
|
127853
|
+
/** Gets the loaded child items in this collection. */
|
|
127854
|
+
readonly items: PowerPoint.TableCell[];
|
|
127855
|
+
/**
|
|
127856
|
+
* Gets the number of table cells in the collection.
|
|
127857
|
+
*
|
|
127858
|
+
* @remarks
|
|
127859
|
+
* [Api set: PowerPointApi 1.8]
|
|
127860
|
+
* @returns The number of table cells in the collection.
|
|
127861
|
+
*/
|
|
127862
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
127863
|
+
/**
|
|
127864
|
+
* Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}.
|
|
127865
|
+
*
|
|
127866
|
+
* @remarks
|
|
127867
|
+
* [Api set: PowerPointApi 1.8]
|
|
127868
|
+
*
|
|
127869
|
+
* @param row Row index value of the table cell to be retrieved, as a zero-based index.
|
|
127870
|
+
* @param column Column index value of the table cell to be retrieved, as a zero-based index.
|
|
127871
|
+
* @returns The `TableCell` object.
|
|
127872
|
+
*/
|
|
127873
|
+
getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
|
|
127874
|
+
/**
|
|
127875
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127876
|
+
*
|
|
127877
|
+
* @param options Provides options for which properties of the object to load.
|
|
127878
|
+
*/
|
|
127879
|
+
load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection;
|
|
127880
|
+
/**
|
|
127881
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127882
|
+
*
|
|
127883
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
127884
|
+
*/
|
|
127885
|
+
load(propertyNames?: string | string[]): PowerPoint.TableCellCollection;
|
|
127886
|
+
/**
|
|
127887
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127888
|
+
*
|
|
127889
|
+
* @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.
|
|
127890
|
+
*/
|
|
127891
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection;
|
|
127892
|
+
/**
|
|
127893
|
+
* 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's passed to it.)
|
|
127894
|
+
* Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
127895
|
+
*/
|
|
127896
|
+
toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
|
|
127897
|
+
}
|
|
127898
|
+
/**
|
|
127899
|
+
* Represents the fill formatting of a table cell.
|
|
127900
|
+
*
|
|
127901
|
+
* @remarks
|
|
127902
|
+
* [Api set: PowerPointApi 1.8]
|
|
127903
|
+
*/
|
|
127904
|
+
interface FillProperties {
|
|
127905
|
+
/**
|
|
127906
|
+
* Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
|
|
127907
|
+
*
|
|
127908
|
+
* @remarks
|
|
127909
|
+
* [Api set: PowerPointApi 1.8]
|
|
127910
|
+
*/
|
|
127911
|
+
color?: string | undefined;
|
|
127912
|
+
/**
|
|
127913
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
127914
|
+
*
|
|
127915
|
+
* @remarks
|
|
127916
|
+
* [Api set: PowerPointApi 1.8]
|
|
127917
|
+
*/
|
|
127918
|
+
transparency?: number | undefined;
|
|
127919
|
+
}
|
|
127920
|
+
/**
|
|
127921
|
+
* Represents the properties for a table cell border.
|
|
127922
|
+
*
|
|
127923
|
+
* @remarks
|
|
127924
|
+
* [Api set: PowerPointApi 1.8]
|
|
127925
|
+
*/
|
|
127926
|
+
interface BorderProperties {
|
|
127927
|
+
/**
|
|
127928
|
+
* Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
|
|
127929
|
+
*
|
|
127930
|
+
* @remarks
|
|
127931
|
+
* [Api set: PowerPointApi 1.8]
|
|
127932
|
+
*/
|
|
127933
|
+
color?: string | undefined;
|
|
127934
|
+
/**
|
|
127935
|
+
* Represents the dash style of the line.
|
|
127936
|
+
*
|
|
127937
|
+
* @remarks
|
|
127938
|
+
* [Api set: PowerPointApi 1.8]
|
|
127939
|
+
*/
|
|
127940
|
+
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
|
|
127941
|
+
/**
|
|
127942
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
|
|
127943
|
+
*
|
|
127944
|
+
* @remarks
|
|
127945
|
+
* [Api set: PowerPointApi 1.8]
|
|
127946
|
+
*/
|
|
127947
|
+
transparency?: number | undefined;
|
|
127948
|
+
/**
|
|
127949
|
+
* Represents the weight of the line, in points.
|
|
127950
|
+
*
|
|
127951
|
+
* @remarks
|
|
127952
|
+
* [Api set: PowerPointApi 1.8]
|
|
127953
|
+
*/
|
|
127954
|
+
weight?: number | undefined;
|
|
127955
|
+
}
|
|
127956
|
+
/**
|
|
127957
|
+
* Represents the borders of a table cell.
|
|
127958
|
+
*
|
|
127959
|
+
* @remarks
|
|
127960
|
+
* [Api set: PowerPointApi 1.8]
|
|
127961
|
+
*/
|
|
127962
|
+
interface TableCellBorders {
|
|
127963
|
+
/**
|
|
127964
|
+
* Represents the bottom border.
|
|
127965
|
+
*
|
|
127966
|
+
* @remarks
|
|
127967
|
+
* [Api set: PowerPointApi 1.8]
|
|
127968
|
+
*/
|
|
127969
|
+
bottom?: PowerPoint.BorderProperties;
|
|
127970
|
+
/**
|
|
127971
|
+
* Represents the diagonal border (top-left to bottom-right).
|
|
127972
|
+
*
|
|
127973
|
+
* @remarks
|
|
127974
|
+
* [Api set: PowerPointApi 1.8]
|
|
127975
|
+
*/
|
|
127976
|
+
diagonalDown?: PowerPoint.BorderProperties;
|
|
127977
|
+
/**
|
|
127978
|
+
* Represents the diagonal border (bottom-left to top-right).
|
|
127979
|
+
*
|
|
127980
|
+
* @remarks
|
|
127981
|
+
* [Api set: PowerPointApi 1.8]
|
|
127982
|
+
*/
|
|
127983
|
+
diagonalUp?: PowerPoint.BorderProperties;
|
|
127984
|
+
/**
|
|
127985
|
+
* Represents the left border.
|
|
127986
|
+
*
|
|
127987
|
+
* @remarks
|
|
127988
|
+
* [Api set: PowerPointApi 1.8]
|
|
127989
|
+
*/
|
|
127990
|
+
left?: PowerPoint.BorderProperties;
|
|
127991
|
+
/**
|
|
127992
|
+
* Represents the right border.
|
|
127993
|
+
*
|
|
127994
|
+
* @remarks
|
|
127995
|
+
* [Api set: PowerPointApi 1.8]
|
|
127996
|
+
*/
|
|
127997
|
+
right?: PowerPoint.BorderProperties;
|
|
127998
|
+
/**
|
|
127999
|
+
* Represents the top border.
|
|
128000
|
+
*
|
|
128001
|
+
* @remarks
|
|
128002
|
+
* [Api set: PowerPointApi 1.8]
|
|
128003
|
+
*/
|
|
128004
|
+
top?: PowerPoint.BorderProperties;
|
|
128005
|
+
}
|
|
128006
|
+
/**
|
|
128007
|
+
* Represents the margins of a table cell.
|
|
128008
|
+
*
|
|
128009
|
+
* @remarks
|
|
128010
|
+
* [Api set: PowerPointApi 1.8]
|
|
128011
|
+
*/
|
|
128012
|
+
interface TableCellMargins {
|
|
128013
|
+
/**
|
|
128014
|
+
* Specifies the bottom margin in points.
|
|
128015
|
+
*
|
|
128016
|
+
* @remarks
|
|
128017
|
+
* [Api set: PowerPointApi 1.8]
|
|
128018
|
+
*/
|
|
128019
|
+
bottom?: number | undefined;
|
|
128020
|
+
/**
|
|
128021
|
+
* Specifies the left margin in points.
|
|
128022
|
+
*
|
|
128023
|
+
* @remarks
|
|
128024
|
+
* [Api set: PowerPointApi 1.8]
|
|
128025
|
+
*/
|
|
128026
|
+
left?: number | undefined;
|
|
128027
|
+
/**
|
|
128028
|
+
* Specifies the right margin in points.
|
|
128029
|
+
*
|
|
128030
|
+
* @remarks
|
|
128031
|
+
* [Api set: PowerPointApi 1.8]
|
|
128032
|
+
*/
|
|
128033
|
+
right?: number | undefined;
|
|
128034
|
+
/**
|
|
128035
|
+
* Specifies the top margin in points.
|
|
128036
|
+
*
|
|
128037
|
+
* @remarks
|
|
128038
|
+
* [Api set: PowerPointApi 1.8]
|
|
128039
|
+
*/
|
|
128040
|
+
top?: number | undefined;
|
|
128041
|
+
}
|
|
128042
|
+
/**
|
|
128043
|
+
* Represents the table cell properties to update.
|
|
128044
|
+
*
|
|
128045
|
+
* @remarks
|
|
128046
|
+
* [Api set: PowerPointApi 1.8]
|
|
128047
|
+
*/
|
|
128048
|
+
interface TableCellProperties {
|
|
128049
|
+
/**
|
|
128050
|
+
* Specifies the border formatting of the table cell.
|
|
128051
|
+
*
|
|
128052
|
+
* @remarks
|
|
128053
|
+
* [Api set: PowerPointApi 1.8]
|
|
128054
|
+
*/
|
|
128055
|
+
borders?: PowerPoint.TableCellBorders;
|
|
128056
|
+
/**
|
|
128057
|
+
* Specifies the fill formatting of the table cell.
|
|
128058
|
+
*
|
|
128059
|
+
* @remarks
|
|
128060
|
+
* [Api set: PowerPointApi 1.8]
|
|
128061
|
+
*/
|
|
128062
|
+
fill?: PowerPoint.FillProperties;
|
|
128063
|
+
/**
|
|
128064
|
+
* Specifies the font formatting of the table cell.
|
|
128065
|
+
*
|
|
128066
|
+
* @remarks
|
|
128067
|
+
* [Api set: PowerPointApi 1.8]
|
|
128068
|
+
*/
|
|
128069
|
+
font?: PowerPoint.FontProperties;
|
|
128070
|
+
/**
|
|
128071
|
+
* Represents the horizontal alignment of the table cell.
|
|
128072
|
+
*
|
|
128073
|
+
* @remarks
|
|
128074
|
+
* [Api set: PowerPointApi 1.8]
|
|
128075
|
+
*/
|
|
128076
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
|
|
128077
|
+
/**
|
|
128078
|
+
* Represents the indent level of the text in the table cell.
|
|
128079
|
+
*
|
|
128080
|
+
* @remarks
|
|
128081
|
+
* [Api set: PowerPointApi 1.8]
|
|
128082
|
+
*/
|
|
128083
|
+
indentLevel?: number | undefined;
|
|
128084
|
+
/**
|
|
128085
|
+
* Specifies the margin settings in the table cell.
|
|
128086
|
+
*
|
|
128087
|
+
* @remarks
|
|
128088
|
+
* [Api set: PowerPointApi 1.8]
|
|
128089
|
+
*/
|
|
128090
|
+
margins?: PowerPoint.TableCellMargins;
|
|
128091
|
+
/**
|
|
128092
|
+
* Specifies the text content of the table cell.
|
|
128093
|
+
|
|
128094
|
+
If a portion of the text requires different formatting, use the `textRuns` property instead.
|
|
128095
|
+
*
|
|
128096
|
+
* @remarks
|
|
128097
|
+
* [Api set: PowerPointApi 1.8]
|
|
128098
|
+
*/
|
|
128099
|
+
text?: string;
|
|
128100
|
+
/**
|
|
128101
|
+
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
128102
|
+
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
128103
|
+
*
|
|
128104
|
+
* @remarks
|
|
128105
|
+
* [Api set: PowerPointApi 1.8]
|
|
128106
|
+
*/
|
|
128107
|
+
textRuns?: PowerPoint.TextRun[];
|
|
128108
|
+
/**
|
|
128109
|
+
* Represents the vertical alignment of the table cell.
|
|
128110
|
+
*
|
|
128111
|
+
* @remarks
|
|
128112
|
+
* [Api set: PowerPointApi 1.8]
|
|
128113
|
+
*/
|
|
128114
|
+
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
|
|
128115
|
+
}
|
|
128116
|
+
/**
|
|
128117
|
+
* Represents a table.
|
|
128118
|
+
*
|
|
128119
|
+
* @remarks
|
|
128120
|
+
* [Api set: PowerPointApi 1.8]
|
|
128121
|
+
*/
|
|
128122
|
+
class Table extends OfficeExtension.ClientObject {
|
|
128123
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
128124
|
+
context: RequestContext;
|
|
128125
|
+
/**
|
|
128126
|
+
* Gets the number of columns in the table.
|
|
128127
|
+
*
|
|
128128
|
+
* @remarks
|
|
128129
|
+
* [Api set: PowerPointApi 1.8]
|
|
128130
|
+
*/
|
|
128131
|
+
readonly columnCount: number;
|
|
128132
|
+
/**
|
|
128133
|
+
* Gets the number of rows in the table.
|
|
128134
|
+
*
|
|
128135
|
+
* @remarks
|
|
128136
|
+
* [Api set: PowerPointApi 1.8]
|
|
128137
|
+
*/
|
|
128138
|
+
readonly rowCount: number;
|
|
128139
|
+
/**
|
|
128140
|
+
* Gets all of the values in the table.
|
|
128141
|
+
*
|
|
128142
|
+
* @remarks
|
|
128143
|
+
* [Api set: PowerPointApi 1.8]
|
|
128144
|
+
*/
|
|
128145
|
+
readonly values: string[][];
|
|
128146
|
+
/**
|
|
128147
|
+
* Gets the cell at the specified `rowIndex` and `columnIndex`.
|
|
128148
|
+
*
|
|
128149
|
+
* @remarks
|
|
128150
|
+
* [Api set: PowerPointApi 1.8]
|
|
128151
|
+
*
|
|
128152
|
+
* @param rowIndex The zero-based row index of the cell.
|
|
128153
|
+
* @param columnIndex The zero-based column index of the cell.
|
|
128154
|
+
* @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned.
|
|
128155
|
+
*/
|
|
128156
|
+
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
|
|
128157
|
+
/**
|
|
128158
|
+
* Gets a collection of cells that represent the merged areas of the table.
|
|
128159
|
+
*
|
|
128160
|
+
* @remarks
|
|
128161
|
+
* [Api set: PowerPointApi 1.8]
|
|
128162
|
+
* @returns a `TableCellCollection` with cells that represent the merged areas of the table.
|
|
128163
|
+
*/
|
|
128164
|
+
getMergedAreas(): PowerPoint.TableCellCollection;
|
|
128165
|
+
/**
|
|
128166
|
+
* Gets the shape object for the table.
|
|
128167
|
+
*
|
|
128168
|
+
* @remarks
|
|
128169
|
+
* [Api set: PowerPointApi 1.8]
|
|
128170
|
+
*/
|
|
128171
|
+
getShape(): PowerPoint.Shape;
|
|
128172
|
+
/**
|
|
128173
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
128174
|
+
*
|
|
128175
|
+
* @param options Provides options for which properties of the object to load.
|
|
128176
|
+
*/
|
|
128177
|
+
load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;
|
|
128178
|
+
/**
|
|
128179
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
128180
|
+
*
|
|
128181
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
128182
|
+
*/
|
|
128183
|
+
load(propertyNames?: string | string[]): PowerPoint.Table;
|
|
128184
|
+
/**
|
|
128185
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
128186
|
+
*
|
|
128187
|
+
* @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.
|
|
128188
|
+
*/
|
|
128189
|
+
load(propertyNamesAndPaths?: {
|
|
128190
|
+
select?: string;
|
|
128191
|
+
expand?: string;
|
|
128192
|
+
}): PowerPoint.Table;
|
|
128193
|
+
/**
|
|
128194
|
+
* 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's passed to it.)
|
|
128195
|
+
* Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
|
|
128196
|
+
*/
|
|
128197
|
+
toJSON(): PowerPoint.Interfaces.TableData;
|
|
128198
|
+
}
|
|
128199
|
+
/**
|
|
128200
|
+
* Provides the table column properties.
|
|
128201
|
+
*
|
|
128202
|
+
* @remarks
|
|
128203
|
+
* [Api set: PowerPointApi 1.8]
|
|
128204
|
+
*/
|
|
128205
|
+
interface TableColumnProperties {
|
|
128206
|
+
/**
|
|
128207
|
+
* Represents the desired width of each column in points, or is undefined.
|
|
128208
|
+
|
|
128209
|
+
When a table is being added, for columns whose width is undefined,
|
|
128210
|
+
the column width will be calculated by evenly dividing the remaining width
|
|
128211
|
+
of the table amongst those columns. If the table does not have a defined width,
|
|
128212
|
+
a default column width will be used.
|
|
128213
|
+
*
|
|
128214
|
+
* @remarks
|
|
128215
|
+
* [Api set: PowerPointApi 1.8]
|
|
128216
|
+
*/
|
|
128217
|
+
columnWidth?: number | undefined;
|
|
128218
|
+
}
|
|
128219
|
+
/**
|
|
128220
|
+
* Represents the properties of a merged area of cells in a table.
|
|
128221
|
+
*
|
|
128222
|
+
* @remarks
|
|
128223
|
+
* [Api set: PowerPointApi 1.8]
|
|
128224
|
+
*/
|
|
128225
|
+
interface TableMergedAreaProperties {
|
|
128226
|
+
/**
|
|
128227
|
+
* Specifies the number of columns for the merged cells area.
|
|
128228
|
+
Must be 1 or greater.
|
|
128229
|
+
*
|
|
128230
|
+
* @remarks
|
|
128231
|
+
* [Api set: PowerPointApi 1.8]
|
|
128232
|
+
*/
|
|
128233
|
+
columnCount: number;
|
|
128234
|
+
/**
|
|
128235
|
+
* Specifies the zero-based index of the column of the top left cell of the merged area.
|
|
128236
|
+
*
|
|
128237
|
+
* @remarks
|
|
128238
|
+
* [Api set: PowerPointApi 1.8]
|
|
128239
|
+
*/
|
|
128240
|
+
columnIndex: number;
|
|
128241
|
+
/**
|
|
128242
|
+
* Specifies the number of rows for the merged cells area.
|
|
128243
|
+
Must be 1 or greater.
|
|
128244
|
+
*
|
|
128245
|
+
* @remarks
|
|
128246
|
+
* [Api set: PowerPointApi 1.8]
|
|
128247
|
+
*/
|
|
128248
|
+
rowCount: number;
|
|
128249
|
+
/**
|
|
128250
|
+
* Specifies the zero-based index of the row of the top left cell of the merged area.
|
|
128251
|
+
*
|
|
128252
|
+
* @remarks
|
|
128253
|
+
* [Api set: PowerPointApi 1.8]
|
|
128254
|
+
*/
|
|
128255
|
+
rowIndex: number;
|
|
128256
|
+
}
|
|
128257
|
+
/**
|
|
128258
|
+
* Provides the table row properties.
|
|
128259
|
+
*
|
|
128260
|
+
* @remarks
|
|
128261
|
+
* [Api set: PowerPointApi 1.8]
|
|
128262
|
+
*/
|
|
128263
|
+
interface TableRowProperties {
|
|
128264
|
+
/**
|
|
128265
|
+
* Represents the desired height of each row in points, or is undefined.
|
|
128266
|
+
|
|
128267
|
+
When a table is being added, for rows whose height is undefined,
|
|
128268
|
+
the row height will be calculated by evenly dividing the remaining height
|
|
128269
|
+
of the table amongst those rows. If the table does not have a defined height,
|
|
128270
|
+
a default row height will be used.
|
|
128271
|
+
*
|
|
128272
|
+
* @remarks
|
|
128273
|
+
* [Api set: PowerPointApi 1.8]
|
|
128274
|
+
*/
|
|
128275
|
+
rowHeight?: number | undefined;
|
|
128276
|
+
}
|
|
128277
|
+
/**
|
|
128278
|
+
* Represents the available options when adding a table.
|
|
128279
|
+
*
|
|
128280
|
+
* @remarks
|
|
128281
|
+
* [Api set: PowerPointApi 1.8]
|
|
128282
|
+
*/
|
|
128283
|
+
interface TableAddOptions {
|
|
128284
|
+
/**
|
|
128285
|
+
* If provided, specifies properties for each column in the table.
|
|
128286
|
+
The array length must be equal to the number of columns in the table.
|
|
128287
|
+
Specify an empty object for columns that should use the default formatting.
|
|
128288
|
+
*
|
|
128289
|
+
* @remarks
|
|
128290
|
+
* [Api set: PowerPointApi 1.8]
|
|
128291
|
+
*/
|
|
128292
|
+
columns?: PowerPoint.TableColumnProperties[];
|
|
128293
|
+
/**
|
|
128294
|
+
* Specifies the height, in points, of the table.
|
|
128295
|
+
A default value is used when this parameter is not provided.
|
|
128296
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
128297
|
+
*
|
|
128298
|
+
* @remarks
|
|
128299
|
+
* [Api set: PowerPointApi 1.8]
|
|
128300
|
+
*/
|
|
128301
|
+
height?: number | undefined;
|
|
128302
|
+
/**
|
|
128303
|
+
* Specifies the distance, in points, from the left side of the table to the left side of the slide.
|
|
128304
|
+
The table is centered horizontally when this parameter is not provided.
|
|
128305
|
+
*
|
|
128306
|
+
* @remarks
|
|
128307
|
+
* [Api set: PowerPointApi 1.8]
|
|
128308
|
+
*/
|
|
128309
|
+
left?: number | undefined;
|
|
128310
|
+
/**
|
|
128311
|
+
* If specified, represents an rectangular area where multiple cells appear as a single cell.
|
|
128312
|
+
*
|
|
128313
|
+
* @remarks
|
|
128314
|
+
* [Api set: PowerPointApi 1.8]
|
|
128315
|
+
*/
|
|
128316
|
+
mergedAreas?: PowerPoint.TableMergedAreaProperties[];
|
|
128317
|
+
/**
|
|
128318
|
+
* If provided, specifies properties for each row in the table.
|
|
128319
|
+
The array length must be equal to the number of rows in the table.
|
|
128320
|
+
Specify an empty object for rows that should use the default formatting.
|
|
128321
|
+
*
|
|
128322
|
+
* @remarks
|
|
128323
|
+
* [Api set: PowerPointApi 1.8]
|
|
128324
|
+
*/
|
|
128325
|
+
rows?: PowerPoint.TableRowProperties[];
|
|
128326
|
+
/**
|
|
128327
|
+
* If provided, specifies properties for each cell in the table.
|
|
128328
|
+
|
|
128329
|
+
This should be an 2D array with the same number of rows and columns as the table.
|
|
128330
|
+
If a cell does not require specific formatting, specify an empty object for that cell.
|
|
128331
|
+
Only the top left cell of a merged are can have properties specified, which will be applied
|
|
128332
|
+
to the entire merged area. For the other cells in the merged area, an empty object should be provided.
|
|
128333
|
+
*
|
|
128334
|
+
* @remarks
|
|
128335
|
+
* [Api set: PowerPointApi 1.8]
|
|
128336
|
+
*/
|
|
128337
|
+
specificCellProperties?: PowerPoint.TableCellProperties[][];
|
|
128338
|
+
/**
|
|
128339
|
+
* Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
|
|
128340
|
+
A default value is used when this parameter is not provided.
|
|
128341
|
+
*
|
|
128342
|
+
* @remarks
|
|
128343
|
+
* [Api set: PowerPointApi 1.8]
|
|
128344
|
+
*/
|
|
128345
|
+
top?: number | undefined;
|
|
128346
|
+
/**
|
|
128347
|
+
* Specifies the formatting which applies uniformly to all of the table cells.
|
|
128348
|
+
|
|
128349
|
+
To apply specific formatting to individual cells, use specificCellProperties.
|
|
128350
|
+
|
|
128351
|
+
If both uniformCellProperties and specificCellProperties are undefined, the default formatting
|
|
128352
|
+
will be used, and the default table style will be applied. The table will have the same
|
|
128353
|
+
appearance as when the user adds a table through the PowerPoint UI.
|
|
128354
|
+
|
|
128355
|
+
To provide a plain appearance for the table, set this property to an empty object
|
|
128356
|
+
and do not specify specificCellProperties.
|
|
128357
|
+
*
|
|
128358
|
+
* @remarks
|
|
128359
|
+
* [Api set: PowerPointApi 1.8]
|
|
128360
|
+
*/
|
|
128361
|
+
uniformCellProperties?: PowerPoint.TableCellProperties;
|
|
128362
|
+
/**
|
|
128363
|
+
* If provided, specifies the values for the table.
|
|
128364
|
+
|
|
128365
|
+
When the table contains areas of merged cells,
|
|
128366
|
+
only the top left cell of each merged area can have a
|
|
128367
|
+
non-empty string value. The other cells
|
|
128368
|
+
in the merged area must be an empty string.
|
|
128369
|
+
*
|
|
128370
|
+
* @remarks
|
|
128371
|
+
* [Api set: PowerPointApi 1.8]
|
|
128372
|
+
*/
|
|
128373
|
+
values?: string[][];
|
|
128374
|
+
/**
|
|
128375
|
+
* Specifies the width, in points, of the table.
|
|
128376
|
+
A default value is used when this parameter is not provided.
|
|
128377
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
128378
|
+
*
|
|
128379
|
+
* @remarks
|
|
128380
|
+
* [Api set: PowerPointApi 1.8]
|
|
128381
|
+
*/
|
|
128382
|
+
width?: number | undefined;
|
|
128383
|
+
}
|
|
127370
128384
|
/**
|
|
127371
128385
|
* Represents the collection of shapes.
|
|
127372
128386
|
*
|
|
@@ -127400,6 +128414,16 @@ declare namespace PowerPoint {
|
|
|
127400
128414
|
* @returns The newly inserted shape.
|
|
127401
128415
|
*/
|
|
127402
128416
|
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;
|
|
128417
|
+
/**
|
|
128418
|
+
* Create a shape group for several shapes.
|
|
128419
|
+
*
|
|
128420
|
+
* @remarks
|
|
128421
|
+
* [Api set: PowerPointApi 1.8]
|
|
128422
|
+
*
|
|
128423
|
+
* @param values An array of shape IDs or `Shape` objects.
|
|
128424
|
+
* @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
|
|
128425
|
+
*/
|
|
128426
|
+
addGroup(values: Array<string | Shape>): PowerPoint.Shape;
|
|
127403
128427
|
/**
|
|
127404
128428
|
* Adds a line to the slide. Returns a `Shape` object that represents the new line.
|
|
127405
128429
|
*
|
|
@@ -127423,6 +128447,19 @@ declare namespace PowerPoint {
|
|
|
127423
128447
|
*/
|
|
127424
128448
|
addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
127425
128449
|
/**
|
|
128450
|
+
* Adds a table to the slide. Returns a `Shape` object that represents the new table.
|
|
128451
|
+
Use the `Shape.table` property to get the `Table` object for the shape.
|
|
128452
|
+
*
|
|
128453
|
+
* @remarks
|
|
128454
|
+
* [Api set: PowerPointApi 1.8]
|
|
128455
|
+
*
|
|
128456
|
+
* @param rowCount Number of rows in the table. Must be 1 or greater.
|
|
128457
|
+
* @param columnCount Number of columns in the table. Must be 1 or greater.
|
|
128458
|
+
* @param options Provides options describing the new table.
|
|
128459
|
+
* @returns The newly inserted shape.
|
|
128460
|
+
*/
|
|
128461
|
+
addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape;
|
|
128462
|
+
/**
|
|
127426
128463
|
* Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
|
|
127427
128464
|
*
|
|
127428
128465
|
* @remarks
|
|
@@ -127495,6 +128532,258 @@ declare namespace PowerPoint {
|
|
|
127495
128532
|
*/
|
|
127496
128533
|
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
127497
128534
|
}
|
|
128535
|
+
/**
|
|
128536
|
+
* Represents the available options when getting an image of a slide.
|
|
128537
|
+
*
|
|
128538
|
+
* @remarks
|
|
128539
|
+
* [Api set: PowerPointApi 1.8]
|
|
128540
|
+
*/
|
|
128541
|
+
interface SlideGetImageOptions {
|
|
128542
|
+
/**
|
|
128543
|
+
* The desired height of the resulting image in pixels.
|
|
128544
|
+
*
|
|
128545
|
+
* @remarks
|
|
128546
|
+
* [Api set: PowerPointApi 1.8]
|
|
128547
|
+
*/
|
|
128548
|
+
height?: number;
|
|
128549
|
+
/**
|
|
128550
|
+
* The desired width of the resulting image in pixels.
|
|
128551
|
+
*
|
|
128552
|
+
* @remarks
|
|
128553
|
+
* [Api set: PowerPointApi 1.8]
|
|
128554
|
+
*/
|
|
128555
|
+
width?: number;
|
|
128556
|
+
}
|
|
128557
|
+
/**
|
|
128558
|
+
* Specifies the type of a slide layout.
|
|
128559
|
+
*
|
|
128560
|
+
* @remarks
|
|
128561
|
+
* [Api set: PowerPointApi 1.8]
|
|
128562
|
+
*/
|
|
128563
|
+
enum SlideLayoutType {
|
|
128564
|
+
/**
|
|
128565
|
+
* Blank layout.
|
|
128566
|
+
* @remarks
|
|
128567
|
+
* [Api set: PowerPointApi 1.8]
|
|
128568
|
+
*/
|
|
128569
|
+
blank = "Blank",
|
|
128570
|
+
/**
|
|
128571
|
+
* Chart layout.
|
|
128572
|
+
* @remarks
|
|
128573
|
+
* [Api set: PowerPointApi 1.8]
|
|
128574
|
+
*/
|
|
128575
|
+
chart = "Chart",
|
|
128576
|
+
/**
|
|
128577
|
+
* Chart and text layout.
|
|
128578
|
+
* @remarks
|
|
128579
|
+
* [Api set: PowerPointApi 1.8]
|
|
128580
|
+
*/
|
|
128581
|
+
chartAndText = "ChartAndText",
|
|
128582
|
+
/**
|
|
128583
|
+
* ClipArt and text layout.
|
|
128584
|
+
* @remarks
|
|
128585
|
+
* [Api set: PowerPointApi 1.8]
|
|
128586
|
+
*/
|
|
128587
|
+
clipArtAndText = "ClipArtAndText",
|
|
128588
|
+
/**
|
|
128589
|
+
* ClipArt and vertical text layout.
|
|
128590
|
+
* @remarks
|
|
128591
|
+
* [Api set: PowerPointApi 1.8]
|
|
128592
|
+
*/
|
|
128593
|
+
clipArtAndVerticalText = "ClipArtAndVerticalText",
|
|
128594
|
+
/**
|
|
128595
|
+
* Comparison layout.
|
|
128596
|
+
* @remarks
|
|
128597
|
+
* [Api set: PowerPointApi 1.8]
|
|
128598
|
+
*/
|
|
128599
|
+
comparison = "Comparison",
|
|
128600
|
+
/**
|
|
128601
|
+
* Content with caption layout.
|
|
128602
|
+
* @remarks
|
|
128603
|
+
* [Api set: PowerPointApi 1.8]
|
|
128604
|
+
*/
|
|
128605
|
+
contentWithCaption = "ContentWithCaption",
|
|
128606
|
+
/**
|
|
128607
|
+
* Custom layout.
|
|
128608
|
+
* @remarks
|
|
128609
|
+
* [Api set: PowerPointApi 1.8]
|
|
128610
|
+
*/
|
|
128611
|
+
custom = "Custom",
|
|
128612
|
+
/**
|
|
128613
|
+
* Four objects layout.
|
|
128614
|
+
* @remarks
|
|
128615
|
+
* [Api set: PowerPointApi 1.8]
|
|
128616
|
+
*/
|
|
128617
|
+
fourObjects = "FourObjects",
|
|
128618
|
+
/**
|
|
128619
|
+
* Large object layout.
|
|
128620
|
+
* @remarks
|
|
128621
|
+
* [Api set: PowerPointApi 1.8]
|
|
128622
|
+
*/
|
|
128623
|
+
largeObject = "LargeObject",
|
|
128624
|
+
/**
|
|
128625
|
+
* MediaClip and text layout.
|
|
128626
|
+
* @remarks
|
|
128627
|
+
* [Api set: PowerPointApi 1.8]
|
|
128628
|
+
*/
|
|
128629
|
+
mediaClipAndText = "MediaClipAndText",
|
|
128630
|
+
/**
|
|
128631
|
+
* Mixed layout.
|
|
128632
|
+
* @remarks
|
|
128633
|
+
* [Api set: PowerPointApi 1.8]
|
|
128634
|
+
*/
|
|
128635
|
+
mixed = "Mixed",
|
|
128636
|
+
/**
|
|
128637
|
+
* Object layout.
|
|
128638
|
+
* @remarks
|
|
128639
|
+
* [Api set: PowerPointApi 1.8]
|
|
128640
|
+
*/
|
|
128641
|
+
object = "Object",
|
|
128642
|
+
/**
|
|
128643
|
+
* Object and text layout.
|
|
128644
|
+
* @remarks
|
|
128645
|
+
* [Api set: PowerPointApi 1.8]
|
|
128646
|
+
*/
|
|
128647
|
+
objectAndText = "ObjectAndText",
|
|
128648
|
+
/**
|
|
128649
|
+
* Object and two objects layout.
|
|
128650
|
+
* @remarks
|
|
128651
|
+
* [Api set: PowerPointApi 1.8]
|
|
128652
|
+
*/
|
|
128653
|
+
objectAndTwoObjects = "ObjectAndTwoObjects",
|
|
128654
|
+
/**
|
|
128655
|
+
* Object over text layout.
|
|
128656
|
+
* @remarks
|
|
128657
|
+
* [Api set: PowerPointApi 1.8]
|
|
128658
|
+
*/
|
|
128659
|
+
objectOverText = "ObjectOverText",
|
|
128660
|
+
/**
|
|
128661
|
+
* Organization chart layout.
|
|
128662
|
+
* @remarks
|
|
128663
|
+
* [Api set: PowerPointApi 1.8]
|
|
128664
|
+
*/
|
|
128665
|
+
organizationChart = "OrganizationChart",
|
|
128666
|
+
/**
|
|
128667
|
+
* Picture with caption layout.
|
|
128668
|
+
* @remarks
|
|
128669
|
+
* [Api set: PowerPointApi 1.8]
|
|
128670
|
+
*/
|
|
128671
|
+
pictureWithCaption = "PictureWithCaption",
|
|
128672
|
+
/**
|
|
128673
|
+
* Section header layout.
|
|
128674
|
+
* @remarks
|
|
128675
|
+
* [Api set: PowerPointApi 1.8]
|
|
128676
|
+
*/
|
|
128677
|
+
sectionHeader = "SectionHeader",
|
|
128678
|
+
/**
|
|
128679
|
+
* Table layout.
|
|
128680
|
+
* @remarks
|
|
128681
|
+
* [Api set: PowerPointApi 1.8]
|
|
128682
|
+
*/
|
|
128683
|
+
table = "Table",
|
|
128684
|
+
/**
|
|
128685
|
+
* Text layout.
|
|
128686
|
+
* @remarks
|
|
128687
|
+
* [Api set: PowerPointApi 1.8]
|
|
128688
|
+
*/
|
|
128689
|
+
text = "Text",
|
|
128690
|
+
/**
|
|
128691
|
+
* Text and chart layout.
|
|
128692
|
+
* @remarks
|
|
128693
|
+
* [Api set: PowerPointApi 1.8]
|
|
128694
|
+
*/
|
|
128695
|
+
textAndChart = "TextAndChart",
|
|
128696
|
+
/**
|
|
128697
|
+
* Text and ClipArt layout.
|
|
128698
|
+
* @remarks
|
|
128699
|
+
* [Api set: PowerPointApi 1.8]
|
|
128700
|
+
*/
|
|
128701
|
+
textAndClipArt = "TextAndClipArt",
|
|
128702
|
+
/**
|
|
128703
|
+
* Text and MediaClip layout.
|
|
128704
|
+
* @remarks
|
|
128705
|
+
* [Api set: PowerPointApi 1.8]
|
|
128706
|
+
*/
|
|
128707
|
+
textAndMediaClip = "TextAndMediaClip",
|
|
128708
|
+
/**
|
|
128709
|
+
* Text and object layout.
|
|
128710
|
+
* @remarks
|
|
128711
|
+
* [Api set: PowerPointApi 1.8]
|
|
128712
|
+
*/
|
|
128713
|
+
textAndObject = "TextAndObject",
|
|
128714
|
+
/**
|
|
128715
|
+
* Text and two objects layout.
|
|
128716
|
+
* @remarks
|
|
128717
|
+
* [Api set: PowerPointApi 1.8]
|
|
128718
|
+
*/
|
|
128719
|
+
textAndTwoObjects = "TextAndTwoObjects",
|
|
128720
|
+
/**
|
|
128721
|
+
* Text over object layout.
|
|
128722
|
+
* @remarks
|
|
128723
|
+
* [Api set: PowerPointApi 1.8]
|
|
128724
|
+
*/
|
|
128725
|
+
textOverObject = "TextOverObject",
|
|
128726
|
+
/**
|
|
128727
|
+
* Title layout.
|
|
128728
|
+
* @remarks
|
|
128729
|
+
* [Api set: PowerPointApi 1.8]
|
|
128730
|
+
*/
|
|
128731
|
+
title = "Title",
|
|
128732
|
+
/**
|
|
128733
|
+
* Title only layout.
|
|
128734
|
+
* @remarks
|
|
128735
|
+
* [Api set: PowerPointApi 1.8]
|
|
128736
|
+
*/
|
|
128737
|
+
titleOnly = "TitleOnly",
|
|
128738
|
+
/**
|
|
128739
|
+
* Two-column text layout.
|
|
128740
|
+
* @remarks
|
|
128741
|
+
* [Api set: PowerPointApi 1.8]
|
|
128742
|
+
*/
|
|
128743
|
+
twoColumnText = "TwoColumnText",
|
|
128744
|
+
/**
|
|
128745
|
+
* Two objects layout.
|
|
128746
|
+
* @remarks
|
|
128747
|
+
* [Api set: PowerPointApi 1.8]
|
|
128748
|
+
*/
|
|
128749
|
+
twoObjects = "TwoObjects",
|
|
128750
|
+
/**
|
|
128751
|
+
* Two objects and object layout.
|
|
128752
|
+
* @remarks
|
|
128753
|
+
* [Api set: PowerPointApi 1.8]
|
|
128754
|
+
*/
|
|
128755
|
+
twoObjectsAndObject = "TwoObjectsAndObject",
|
|
128756
|
+
/**
|
|
128757
|
+
* Two objects and text layout.
|
|
128758
|
+
* @remarks
|
|
128759
|
+
* [Api set: PowerPointApi 1.8]
|
|
128760
|
+
*/
|
|
128761
|
+
twoObjectsAndText = "TwoObjectsAndText",
|
|
128762
|
+
/**
|
|
128763
|
+
* Two objects over text layout.
|
|
128764
|
+
* @remarks
|
|
128765
|
+
* [Api set: PowerPointApi 1.8]
|
|
128766
|
+
*/
|
|
128767
|
+
twoObjectsOverText = "TwoObjectsOverText",
|
|
128768
|
+
/**
|
|
128769
|
+
* Vertical text layout.
|
|
128770
|
+
* @remarks
|
|
128771
|
+
* [Api set: PowerPointApi 1.8]
|
|
128772
|
+
*/
|
|
128773
|
+
verticalText = "VerticalText",
|
|
128774
|
+
/**
|
|
128775
|
+
* Vertical title and text layout.
|
|
128776
|
+
* @remarks
|
|
128777
|
+
* [Api set: PowerPointApi 1.8]
|
|
128778
|
+
*/
|
|
128779
|
+
verticalTitleAndText = "VerticalTitleAndText",
|
|
128780
|
+
/**
|
|
128781
|
+
* Vertical title and text over chart layout.
|
|
128782
|
+
* @remarks
|
|
128783
|
+
* [Api set: PowerPointApi 1.8]
|
|
128784
|
+
*/
|
|
128785
|
+
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
|
|
128786
|
+
}
|
|
127498
128787
|
/**
|
|
127499
128788
|
* Represents the layout of a slide.
|
|
127500
128789
|
*
|
|
@@ -127532,6 +128821,13 @@ declare namespace PowerPoint {
|
|
|
127532
128821
|
* [Api set: PowerPointApi 1.3]
|
|
127533
128822
|
*/
|
|
127534
128823
|
readonly name: string;
|
|
128824
|
+
/**
|
|
128825
|
+
* Returns the type of the slide layout.
|
|
128826
|
+
*
|
|
128827
|
+
* @remarks
|
|
128828
|
+
* [Api set: PowerPointApi 1.8]
|
|
128829
|
+
*/
|
|
128830
|
+
readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
|
|
127535
128831
|
/**
|
|
127536
128832
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
127537
128833
|
*
|
|
@@ -127904,6 +129200,22 @@ declare namespace PowerPoint {
|
|
|
127904
129200
|
* [Api set: PowerPointApi 1.2]
|
|
127905
129201
|
*/
|
|
127906
129202
|
readonly id: string;
|
|
129203
|
+
/**
|
|
129204
|
+
* Returns the zero-based index of the slide representing its position in the presentation.
|
|
129205
|
+
*
|
|
129206
|
+
* @remarks
|
|
129207
|
+
* [Api set: PowerPointApi 1.8]
|
|
129208
|
+
*/
|
|
129209
|
+
readonly index: number;
|
|
129210
|
+
/**
|
|
129211
|
+
* Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
|
|
129212
|
+
*
|
|
129213
|
+
* @remarks
|
|
129214
|
+
* [Api set: PowerPointApi 1.8]
|
|
129215
|
+
*
|
|
129216
|
+
* @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
|
|
129217
|
+
*/
|
|
129218
|
+
applyLayout(slideLayout: PowerPoint.SlideLayout): void;
|
|
127907
129219
|
/**
|
|
127908
129220
|
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
|
|
127909
129221
|
*
|
|
@@ -127911,6 +129223,34 @@ declare namespace PowerPoint {
|
|
|
127911
129223
|
* [Api set: PowerPointApi 1.2]
|
|
127912
129224
|
*/
|
|
127913
129225
|
delete(): void;
|
|
129226
|
+
/**
|
|
129227
|
+
* Exports the slide to its own presentation file, returned as Base64-encoded data.
|
|
129228
|
+
*
|
|
129229
|
+
* @remarks
|
|
129230
|
+
* [Api set: PowerPointApi 1.8]
|
|
129231
|
+
*/
|
|
129232
|
+
exportAsBase64(): OfficeExtension.ClientResult<string>;
|
|
129233
|
+
/**
|
|
129234
|
+
* Renders an image of the slide. The image is scaled to fit into the desired dimensions.
|
|
129235
|
+
If width and height aren't specified, the true size of the slide is used. If only one
|
|
129236
|
+
of either width or height is specified, the other will be calculated to preserve aspect ratio.
|
|
129237
|
+
*
|
|
129238
|
+
* @remarks
|
|
129239
|
+
* [Api set: PowerPointApi 1.8]
|
|
129240
|
+
*
|
|
129241
|
+
* @param options Optional. Options to specify the desired size of the slide image.
|
|
129242
|
+
* @returns A Base64 string of the slide image in PNG format.
|
|
129243
|
+
*/
|
|
129244
|
+
getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;
|
|
129245
|
+
/**
|
|
129246
|
+
* Moves the slide to a new position within the presentation.
|
|
129247
|
+
*
|
|
129248
|
+
* @remarks
|
|
129249
|
+
* [Api set: PowerPointApi 1.8]
|
|
129250
|
+
*
|
|
129251
|
+
* @param slideIndex The zero-based index where the slide should be moved.
|
|
129252
|
+
*/
|
|
129253
|
+
moveTo(slideIndex: number): void;
|
|
127914
129254
|
/**
|
|
127915
129255
|
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
|
|
127916
129256
|
*
|
|
@@ -127996,6 +129336,15 @@ declare namespace PowerPoint {
|
|
|
127996
129336
|
* @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.
|
|
127997
129337
|
*/
|
|
127998
129338
|
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
129339
|
+
/**
|
|
129340
|
+
* Groups all shapes in this collection into a single shape.
|
|
129341
|
+
If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
|
|
129342
|
+
*
|
|
129343
|
+
* @remarks
|
|
129344
|
+
* [Api set: PowerPointApi 1.8]
|
|
129345
|
+
* @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
|
|
129346
|
+
*/
|
|
129347
|
+
group(): PowerPoint.Shape;
|
|
127999
129348
|
/**
|
|
128000
129349
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
128001
129350
|
*
|
|
@@ -128020,6 +129369,70 @@ declare namespace PowerPoint {
|
|
|
128020
129369
|
*/
|
|
128021
129370
|
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
|
|
128022
129371
|
}
|
|
129372
|
+
/**
|
|
129373
|
+
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
|
|
129374
|
+
*
|
|
129375
|
+
* @remarks
|
|
129376
|
+
* [Api set: PowerPointApi 1.8]
|
|
129377
|
+
*/
|
|
129378
|
+
class ShapeGroup extends OfficeExtension.ClientObject {
|
|
129379
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
129380
|
+
context: RequestContext;
|
|
129381
|
+
/**
|
|
129382
|
+
* Returns the `Shape` object associated with the group.
|
|
129383
|
+
*
|
|
129384
|
+
* @remarks
|
|
129385
|
+
* [Api set: PowerPointApi 1.8]
|
|
129386
|
+
*/
|
|
129387
|
+
readonly shape: PowerPoint.Shape;
|
|
129388
|
+
/**
|
|
129389
|
+
* Returns the collection of `Shape` objects in the group.
|
|
129390
|
+
*
|
|
129391
|
+
* @remarks
|
|
129392
|
+
* [Api set: PowerPointApi 1.8]
|
|
129393
|
+
*/
|
|
129394
|
+
readonly shapes: PowerPoint.ShapeScopedCollection;
|
|
129395
|
+
/**
|
|
129396
|
+
* Gets the unique ID of the shape group.
|
|
129397
|
+
*
|
|
129398
|
+
* @remarks
|
|
129399
|
+
* [Api set: PowerPointApi 1.8]
|
|
129400
|
+
*/
|
|
129401
|
+
readonly id: string;
|
|
129402
|
+
/**
|
|
129403
|
+
* Ungroups any grouped shapes in the specified shape group.
|
|
129404
|
+
*
|
|
129405
|
+
* @remarks
|
|
129406
|
+
* [Api set: PowerPointApi 1.8]
|
|
129407
|
+
*/
|
|
129408
|
+
ungroup(): void;
|
|
129409
|
+
/**
|
|
129410
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
129411
|
+
*
|
|
129412
|
+
* @param options Provides options for which properties of the object to load.
|
|
129413
|
+
*/
|
|
129414
|
+
load(options?: PowerPoint.Interfaces.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;
|
|
129415
|
+
/**
|
|
129416
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
129417
|
+
*
|
|
129418
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
129419
|
+
*/
|
|
129420
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeGroup;
|
|
129421
|
+
/**
|
|
129422
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
129423
|
+
*
|
|
129424
|
+
* @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.
|
|
129425
|
+
*/
|
|
129426
|
+
load(propertyNamesAndPaths?: {
|
|
129427
|
+
select?: string;
|
|
129428
|
+
expand?: string;
|
|
129429
|
+
}): PowerPoint.ShapeGroup;
|
|
129430
|
+
/**
|
|
129431
|
+
* 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's passed to it.)
|
|
129432
|
+
* Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
129433
|
+
*/
|
|
129434
|
+
toJSON(): PowerPoint.Interfaces.ShapeGroupData;
|
|
129435
|
+
}
|
|
128023
129436
|
/**
|
|
128024
129437
|
* Specifies the style for a line.
|
|
128025
129438
|
*
|
|
@@ -128471,6 +129884,38 @@ declare namespace PowerPoint {
|
|
|
128471
129884
|
*/
|
|
128472
129885
|
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
128473
129886
|
}
|
|
129887
|
+
/**
|
|
129888
|
+
* Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
129889
|
+
*
|
|
129890
|
+
* @remarks
|
|
129891
|
+
* [Api set: PowerPointApi 1.8]
|
|
129892
|
+
*/
|
|
129893
|
+
enum ShapeZOrder {
|
|
129894
|
+
/**
|
|
129895
|
+
* Brings the shape forward one spot in the z-order.
|
|
129896
|
+
* @remarks
|
|
129897
|
+
* [Api set: PowerPointApi 1.8]
|
|
129898
|
+
*/
|
|
129899
|
+
bringForward = "BringForward",
|
|
129900
|
+
/**
|
|
129901
|
+
* Brings the shape to the front of the z-order.
|
|
129902
|
+
* @remarks
|
|
129903
|
+
* [Api set: PowerPointApi 1.8]
|
|
129904
|
+
*/
|
|
129905
|
+
bringToFront = "BringToFront",
|
|
129906
|
+
/**
|
|
129907
|
+
* Sends the shape backward one spot in the z-order.
|
|
129908
|
+
* @remarks
|
|
129909
|
+
* [Api set: PowerPointApi 1.8]
|
|
129910
|
+
*/
|
|
129911
|
+
sendBackward = "SendBackward",
|
|
129912
|
+
/**
|
|
129913
|
+
* Sends the shape to the back of the z-order.
|
|
129914
|
+
* @remarks
|
|
129915
|
+
* [Api set: PowerPointApi 1.8]
|
|
129916
|
+
*/
|
|
129917
|
+
sendToBack = "SendToBack",
|
|
129918
|
+
}
|
|
128474
129919
|
/**
|
|
128475
129920
|
* Represents a single shape in the slide.
|
|
128476
129921
|
*
|
|
@@ -128494,6 +129939,14 @@ declare namespace PowerPoint {
|
|
|
128494
129939
|
* [Api set: PowerPointApi 1.4]
|
|
128495
129940
|
*/
|
|
128496
129941
|
readonly fill: PowerPoint.ShapeFill;
|
|
129942
|
+
/**
|
|
129943
|
+
* Returns the `ShapeGroup` associated with the shape.
|
|
129944
|
+
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
129945
|
+
*
|
|
129946
|
+
* @remarks
|
|
129947
|
+
* [Api set: PowerPointApi 1.8]
|
|
129948
|
+
*/
|
|
129949
|
+
readonly group: PowerPoint.ShapeGroup;
|
|
128497
129950
|
/**
|
|
128498
129951
|
* Returns the line formatting of this shape.
|
|
128499
129952
|
*
|
|
@@ -128501,6 +129954,22 @@ declare namespace PowerPoint {
|
|
|
128501
129954
|
* [Api set: PowerPointApi 1.4]
|
|
128502
129955
|
*/
|
|
128503
129956
|
readonly lineFormat: PowerPoint.ShapeLineFormat;
|
|
129957
|
+
/**
|
|
129958
|
+
* Returns the parent group of this shape.
|
|
129959
|
+
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
129960
|
+
*
|
|
129961
|
+
* @remarks
|
|
129962
|
+
* [Api set: PowerPointApi 1.8]
|
|
129963
|
+
*/
|
|
129964
|
+
readonly parentGroup: PowerPoint.Shape;
|
|
129965
|
+
/**
|
|
129966
|
+
* Returns the properties that apply specifically to this placeholder.
|
|
129967
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
129968
|
+
*
|
|
129969
|
+
* @remarks
|
|
129970
|
+
* [Api set: PowerPointApi 1.8]
|
|
129971
|
+
*/
|
|
129972
|
+
readonly placeholderFormat: PowerPoint.PlaceholderFormat;
|
|
128504
129973
|
/**
|
|
128505
129974
|
* Returns a collection of tags in the shape.
|
|
128506
129975
|
*
|
|
@@ -128536,6 +130005,19 @@ declare namespace PowerPoint {
|
|
|
128536
130005
|
* [Api set: PowerPointApi 1.4]
|
|
128537
130006
|
*/
|
|
128538
130007
|
left: number;
|
|
130008
|
+
/**
|
|
130009
|
+
* Returns the level of the specified shape.
|
|
130010
|
+
|
|
130011
|
+
- A level of 0 means the shape isn't part of a group.
|
|
130012
|
+
|
|
130013
|
+
- A level of 1 means the shape is part of a top-level group.
|
|
130014
|
+
|
|
130015
|
+
- A level greater than 1 indicates the shape is a nested group.
|
|
130016
|
+
*
|
|
130017
|
+
* @remarks
|
|
130018
|
+
* [Api set: PowerPointApi 1.8]
|
|
130019
|
+
*/
|
|
130020
|
+
readonly level: number;
|
|
128539
130021
|
/**
|
|
128540
130022
|
* Specifies the name of this shape.
|
|
128541
130023
|
*
|
|
@@ -128564,6 +130046,14 @@ declare namespace PowerPoint {
|
|
|
128564
130046
|
* [Api set: PowerPointApi 1.4]
|
|
128565
130047
|
*/
|
|
128566
130048
|
width: number;
|
|
130049
|
+
/**
|
|
130050
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
130051
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
130052
|
+
*
|
|
130053
|
+
* @remarks
|
|
130054
|
+
* [Api set: PowerPointApi 1.8]
|
|
130055
|
+
*/
|
|
130056
|
+
readonly zOrderPosition: number;
|
|
128567
130057
|
/**
|
|
128568
130058
|
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
|
|
128569
130059
|
*
|
|
@@ -128613,6 +130103,31 @@ declare namespace PowerPoint {
|
|
|
128613
130103
|
* [Api set: PowerPointApi 1.5]
|
|
128614
130104
|
*/
|
|
128615
130105
|
getParentSlideOrNullObject(): PowerPoint.Slide;
|
|
130106
|
+
/**
|
|
130107
|
+
* Returns the `Table` object if this shape is a table.
|
|
130108
|
+
*
|
|
130109
|
+
* @remarks
|
|
130110
|
+
* [Api set: PowerPointApi 1.8]
|
|
130111
|
+
*/
|
|
130112
|
+
getTable(): PowerPoint.Table;
|
|
130113
|
+
/**
|
|
130114
|
+
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
130115
|
+
*
|
|
130116
|
+
* @remarks
|
|
130117
|
+
* [Api set: PowerPointApi 1.8]
|
|
130118
|
+
*
|
|
130119
|
+
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
|
|
130120
|
+
*/
|
|
130121
|
+
setZOrder(position: PowerPoint.ShapeZOrder): void;
|
|
130122
|
+
/**
|
|
130123
|
+
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
130124
|
+
*
|
|
130125
|
+
* @remarks
|
|
130126
|
+
* [Api set: PowerPointApi 1.8]
|
|
130127
|
+
*
|
|
130128
|
+
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
|
|
130129
|
+
*/
|
|
130130
|
+
setZOrder(position: "BringForward" | "BringToFront" | "SendBackward" | "SendToBack"): void;
|
|
128616
130131
|
/**
|
|
128617
130132
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
128618
130133
|
*
|
|
@@ -128640,6 +130155,184 @@ declare namespace PowerPoint {
|
|
|
128640
130155
|
*/
|
|
128641
130156
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
128642
130157
|
}
|
|
130158
|
+
/**
|
|
130159
|
+
* Represents an Office.js binding that is defined in the presentation.
|
|
130160
|
+
*
|
|
130161
|
+
* @remarks
|
|
130162
|
+
* [Api set: PowerPointApi 1.8]
|
|
130163
|
+
*/
|
|
130164
|
+
class Binding extends OfficeExtension.ClientObject {
|
|
130165
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
130166
|
+
context: RequestContext;
|
|
130167
|
+
/**
|
|
130168
|
+
* Represents the binding identifier.
|
|
130169
|
+
*
|
|
130170
|
+
* @remarks
|
|
130171
|
+
* [Api set: PowerPointApi 1.8]
|
|
130172
|
+
*/
|
|
130173
|
+
readonly id: string;
|
|
130174
|
+
/**
|
|
130175
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
130176
|
+
*
|
|
130177
|
+
* @remarks
|
|
130178
|
+
* [Api set: PowerPointApi 1.8]
|
|
130179
|
+
*/
|
|
130180
|
+
readonly type: PowerPoint.BindingType | "Shape";
|
|
130181
|
+
/**
|
|
130182
|
+
* Deletes the binding.
|
|
130183
|
+
*
|
|
130184
|
+
* @remarks
|
|
130185
|
+
* [Api set: PowerPointApi 1.8]
|
|
130186
|
+
*/
|
|
130187
|
+
delete(): void;
|
|
130188
|
+
/**
|
|
130189
|
+
* Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
|
|
130190
|
+
*
|
|
130191
|
+
* @remarks
|
|
130192
|
+
* [Api set: PowerPointApi 1.8]
|
|
130193
|
+
*/
|
|
130194
|
+
getShape(): PowerPoint.Shape;
|
|
130195
|
+
/**
|
|
130196
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130197
|
+
*
|
|
130198
|
+
* @param options Provides options for which properties of the object to load.
|
|
130199
|
+
*/
|
|
130200
|
+
load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding;
|
|
130201
|
+
/**
|
|
130202
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130203
|
+
*
|
|
130204
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
130205
|
+
*/
|
|
130206
|
+
load(propertyNames?: string | string[]): PowerPoint.Binding;
|
|
130207
|
+
/**
|
|
130208
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130209
|
+
*
|
|
130210
|
+
* @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.
|
|
130211
|
+
*/
|
|
130212
|
+
load(propertyNamesAndPaths?: {
|
|
130213
|
+
select?: string;
|
|
130214
|
+
expand?: string;
|
|
130215
|
+
}): PowerPoint.Binding;
|
|
130216
|
+
/**
|
|
130217
|
+
* 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's passed to it.)
|
|
130218
|
+
* Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
130219
|
+
*/
|
|
130220
|
+
toJSON(): PowerPoint.Interfaces.BindingData;
|
|
130221
|
+
}
|
|
130222
|
+
/**
|
|
130223
|
+
* Represents the collection of all the binding objects that are part of the presentation.
|
|
130224
|
+
*
|
|
130225
|
+
* @remarks
|
|
130226
|
+
* [Api set: PowerPointApi 1.8]
|
|
130227
|
+
*/
|
|
130228
|
+
class BindingCollection extends OfficeExtension.ClientObject {
|
|
130229
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
130230
|
+
context: RequestContext;
|
|
130231
|
+
/** Gets the loaded child items in this collection. */
|
|
130232
|
+
readonly items: PowerPoint.Binding[];
|
|
130233
|
+
/**
|
|
130234
|
+
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
|
|
130235
|
+
*
|
|
130236
|
+
* @remarks
|
|
130237
|
+
* [Api set: PowerPointApi 1.8]
|
|
130238
|
+
*
|
|
130239
|
+
* @param shape Shape to which the binding is added.
|
|
130240
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
130241
|
+
* @param id ID of the binding.
|
|
130242
|
+
*/
|
|
130243
|
+
add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
|
|
130244
|
+
/**
|
|
130245
|
+
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
|
|
130246
|
+
*
|
|
130247
|
+
* @remarks
|
|
130248
|
+
* [Api set: PowerPointApi 1.8]
|
|
130249
|
+
*
|
|
130250
|
+
* @param shape Shape to which the binding is added.
|
|
130251
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
130252
|
+
* @param id ID of the binding.
|
|
130253
|
+
*/
|
|
130254
|
+
add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding;
|
|
130255
|
+
/**
|
|
130256
|
+
* Adds a new binding based on the current selection.
|
|
130257
|
+
If the selection has multiple areas, the `InvalidReference` error will be returned.
|
|
130258
|
+
*
|
|
130259
|
+
* @remarks
|
|
130260
|
+
* [Api set: PowerPointApi 1.8]
|
|
130261
|
+
*
|
|
130262
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
130263
|
+
* @param id ID of the binding.
|
|
130264
|
+
*/
|
|
130265
|
+
addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
|
|
130266
|
+
/**
|
|
130267
|
+
* Adds a new binding based on the current selection.
|
|
130268
|
+
If the selection has multiple areas, the `InvalidReference` error will be returned.
|
|
130269
|
+
*
|
|
130270
|
+
* @remarks
|
|
130271
|
+
* [Api set: PowerPointApi 1.8]
|
|
130272
|
+
*
|
|
130273
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
130274
|
+
* @param id ID of the binding.
|
|
130275
|
+
*/
|
|
130276
|
+
addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding;
|
|
130277
|
+
/**
|
|
130278
|
+
* Gets the number of bindings in the collection.
|
|
130279
|
+
*
|
|
130280
|
+
* @remarks
|
|
130281
|
+
* [Api set: PowerPointApi 1.8]
|
|
130282
|
+
*/
|
|
130283
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
130284
|
+
/**
|
|
130285
|
+
* Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
|
|
130286
|
+
*
|
|
130287
|
+
* @remarks
|
|
130288
|
+
* [Api set: PowerPointApi 1.8]
|
|
130289
|
+
*
|
|
130290
|
+
* @param key ID of the binding object to be retrieved.
|
|
130291
|
+
*/
|
|
130292
|
+
getItem(key: string): PowerPoint.Binding;
|
|
130293
|
+
/**
|
|
130294
|
+
* Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
|
|
130295
|
+
*
|
|
130296
|
+
* @remarks
|
|
130297
|
+
* [Api set: PowerPointApi 1.8]
|
|
130298
|
+
*
|
|
130299
|
+
* @param index Index value of the object to be retrieved. Zero-indexed.
|
|
130300
|
+
*/
|
|
130301
|
+
getItemAt(index: number): PowerPoint.Binding;
|
|
130302
|
+
/**
|
|
130303
|
+
* Gets a binding object by ID. If the binding object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
130304
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
130305
|
+
*
|
|
130306
|
+
* @remarks
|
|
130307
|
+
* [Api set: PowerPointApi 1.8]
|
|
130308
|
+
*
|
|
130309
|
+
* @param id ID of the binding object to be retrieved.
|
|
130310
|
+
*/
|
|
130311
|
+
getItemOrNullObject(id: string): PowerPoint.Binding;
|
|
130312
|
+
/**
|
|
130313
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130314
|
+
*
|
|
130315
|
+
* @param options Provides options for which properties of the object to load.
|
|
130316
|
+
*/
|
|
130317
|
+
load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;
|
|
130318
|
+
/**
|
|
130319
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130320
|
+
*
|
|
130321
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
130322
|
+
*/
|
|
130323
|
+
load(propertyNames?: string | string[]): PowerPoint.BindingCollection;
|
|
130324
|
+
/**
|
|
130325
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
130326
|
+
*
|
|
130327
|
+
* @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.
|
|
130328
|
+
*/
|
|
130329
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection;
|
|
130330
|
+
/**
|
|
130331
|
+
* 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's passed to it.)
|
|
130332
|
+
* Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
130333
|
+
*/
|
|
130334
|
+
toJSON(): PowerPoint.Interfaces.BindingCollectionData;
|
|
130335
|
+
}
|
|
128643
130336
|
/**
|
|
128644
130337
|
* Specifies the document property type for custom properties.
|
|
128645
130338
|
*
|
|
@@ -129195,7 +130888,7 @@ declare namespace PowerPoint {
|
|
|
129195
130888
|
getItemAt(index: number): PowerPoint.SlideMaster;
|
|
129196
130889
|
/**
|
|
129197
130890
|
* Gets a Slide Master using its unique ID. If such a Slide Master does not exist, an object with an `isNullObject` property set to true is returned.
|
|
129198
|
-
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
130891
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
129199
130892
|
*
|
|
129200
130893
|
* @remarks
|
|
129201
130894
|
* [Api set: PowerPointApi 1.3]
|
|
@@ -129293,6 +130986,19 @@ declare namespace PowerPoint {
|
|
|
129293
130986
|
}
|
|
129294
130987
|
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
|
|
129295
130988
|
interface ShapeFontUpdateData {
|
|
130989
|
+
/**
|
|
130990
|
+
* Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
|
|
130991
|
+
*
|
|
130992
|
+
* - `true`: All the text has the **All Caps** attribute.
|
|
130993
|
+
*
|
|
130994
|
+
* - `false`: None of the text has the **All Caps**attribute.
|
|
130995
|
+
*
|
|
130996
|
+
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
|
|
130997
|
+
*
|
|
130998
|
+
* @remarks
|
|
130999
|
+
* [Api set: PowerPointApi 1.8]
|
|
131000
|
+
*/
|
|
131001
|
+
allCaps?: boolean | null;
|
|
129296
131002
|
/**
|
|
129297
131003
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
129298
131004
|
*
|
|
@@ -129313,6 +131019,19 @@ declare namespace PowerPoint {
|
|
|
129313
131019
|
* [Api set: PowerPointApi 1.4]
|
|
129314
131020
|
*/
|
|
129315
131021
|
color?: string | null;
|
|
131022
|
+
/**
|
|
131023
|
+
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
131024
|
+
*
|
|
131025
|
+
* - `true`: All the text has the **Double strikethrough** attribute.
|
|
131026
|
+
*
|
|
131027
|
+
* - `false`: None of the text has the **Double strikethrough** attribute.
|
|
131028
|
+
*
|
|
131029
|
+
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
131030
|
+
*
|
|
131031
|
+
* @remarks
|
|
131032
|
+
* [Api set: PowerPointApi 1.8]
|
|
131033
|
+
*/
|
|
131034
|
+
doubleStrikethrough?: boolean | null;
|
|
129316
131035
|
/**
|
|
129317
131036
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
129318
131037
|
*
|
|
@@ -129340,6 +131059,58 @@ declare namespace PowerPoint {
|
|
|
129340
131059
|
* [Api set: PowerPointApi 1.4]
|
|
129341
131060
|
*/
|
|
129342
131061
|
size?: number | null;
|
|
131062
|
+
/**
|
|
131063
|
+
* Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
|
|
131064
|
+
*
|
|
131065
|
+
* - `true`: All the text has the **Small Caps** attribute.
|
|
131066
|
+
*
|
|
131067
|
+
* - `false`: None of the text has the **Small Caps** attribute.
|
|
131068
|
+
*
|
|
131069
|
+
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
131070
|
+
*
|
|
131071
|
+
* @remarks
|
|
131072
|
+
* [Api set: PowerPointApi 1.8]
|
|
131073
|
+
*/
|
|
131074
|
+
smallCaps?: boolean | null;
|
|
131075
|
+
/**
|
|
131076
|
+
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
131077
|
+
*
|
|
131078
|
+
* - `true`: All the text has the **Strikethrough** attribute.
|
|
131079
|
+
*
|
|
131080
|
+
* - `false`: None of the text has the **Strikethrough** attribute.
|
|
131081
|
+
*
|
|
131082
|
+
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
131083
|
+
*
|
|
131084
|
+
* @remarks
|
|
131085
|
+
* [Api set: PowerPointApi 1.8]
|
|
131086
|
+
*/
|
|
131087
|
+
strikethrough?: boolean | null;
|
|
131088
|
+
/**
|
|
131089
|
+
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
131090
|
+
*
|
|
131091
|
+
* - `true`: All the text has the **Subscript** attribute.
|
|
131092
|
+
*
|
|
131093
|
+
* - `false`: None of the text has the **Subscript** attribute.
|
|
131094
|
+
*
|
|
131095
|
+
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
131096
|
+
*
|
|
131097
|
+
* @remarks
|
|
131098
|
+
* [Api set: PowerPointApi 1.8]
|
|
131099
|
+
*/
|
|
131100
|
+
subscript?: boolean | null;
|
|
131101
|
+
/**
|
|
131102
|
+
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
131103
|
+
*
|
|
131104
|
+
* - `true`: All the text has the **Superscript** attribute.
|
|
131105
|
+
*
|
|
131106
|
+
* - `false`: None of the text has the **Superscript** attribute.
|
|
131107
|
+
*
|
|
131108
|
+
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
131109
|
+
*
|
|
131110
|
+
* @remarks
|
|
131111
|
+
* [Api set: PowerPointApi 1.8]
|
|
131112
|
+
*/
|
|
131113
|
+
superscript?: boolean | null;
|
|
129343
131114
|
/**
|
|
129344
131115
|
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
129345
131116
|
*
|
|
@@ -129348,6 +131119,20 @@ declare namespace PowerPoint {
|
|
|
129348
131119
|
*/
|
|
129349
131120
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
|
|
129350
131121
|
}
|
|
131122
|
+
/** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
|
|
131123
|
+
interface TableCellUpdateData {
|
|
131124
|
+
/**
|
|
131125
|
+
* Specifies the text content of the table cell.
|
|
131126
|
+
*
|
|
131127
|
+
* @remarks
|
|
131128
|
+
* [Api set: PowerPointApi 1.8]
|
|
131129
|
+
*/
|
|
131130
|
+
text?: string;
|
|
131131
|
+
}
|
|
131132
|
+
/** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
|
|
131133
|
+
interface TableCellCollectionUpdateData {
|
|
131134
|
+
items?: PowerPoint.Interfaces.TableCellData[];
|
|
131135
|
+
}
|
|
129351
131136
|
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
129352
131137
|
interface ShapeCollectionUpdateData {
|
|
129353
131138
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -129555,6 +131340,10 @@ declare namespace PowerPoint {
|
|
|
129555
131340
|
*/
|
|
129556
131341
|
width?: number;
|
|
129557
131342
|
}
|
|
131343
|
+
/** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
|
|
131344
|
+
interface BindingCollectionUpdateData {
|
|
131345
|
+
items?: PowerPoint.Interfaces.BindingData[];
|
|
131346
|
+
}
|
|
129558
131347
|
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
|
|
129559
131348
|
interface CustomPropertyUpdateData {
|
|
129560
131349
|
/**
|
|
@@ -129684,6 +131473,24 @@ declare namespace PowerPoint {
|
|
|
129684
131473
|
interface CustomXmlPartCollectionData {
|
|
129685
131474
|
items?: PowerPoint.Interfaces.CustomXmlPartData[];
|
|
129686
131475
|
}
|
|
131476
|
+
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
|
|
131477
|
+
interface PlaceholderFormatData {
|
|
131478
|
+
/**
|
|
131479
|
+
* Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
|
|
131480
|
+
Returns `null` if the placeholder is empty.
|
|
131481
|
+
*
|
|
131482
|
+
* @remarks
|
|
131483
|
+
* [Api set: PowerPointApi 1.8]
|
|
131484
|
+
*/
|
|
131485
|
+
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
131486
|
+
/**
|
|
131487
|
+
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
131488
|
+
*
|
|
131489
|
+
* @remarks
|
|
131490
|
+
* [Api set: PowerPointApi 1.8]
|
|
131491
|
+
*/
|
|
131492
|
+
type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
|
|
131493
|
+
}
|
|
129687
131494
|
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
|
|
129688
131495
|
interface HyperlinkData {
|
|
129689
131496
|
/**
|
|
@@ -129732,6 +131539,19 @@ declare namespace PowerPoint {
|
|
|
129732
131539
|
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
|
|
129733
131540
|
interface ShapeFontData {
|
|
129734
131541
|
/**
|
|
131542
|
+
* Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
|
|
131543
|
+
*
|
|
131544
|
+
* - `true`: All the text has the **All Caps** attribute.
|
|
131545
|
+
*
|
|
131546
|
+
* - `false`: None of the text has the **All Caps**attribute.
|
|
131547
|
+
*
|
|
131548
|
+
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
|
|
131549
|
+
*
|
|
131550
|
+
* @remarks
|
|
131551
|
+
* [Api set: PowerPointApi 1.8]
|
|
131552
|
+
*/
|
|
131553
|
+
allCaps?: boolean | null;
|
|
131554
|
+
/**
|
|
129735
131555
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
129736
131556
|
*
|
|
129737
131557
|
* - `true`: All the text is bold.
|
|
@@ -129751,6 +131571,19 @@ declare namespace PowerPoint {
|
|
|
129751
131571
|
* [Api set: PowerPointApi 1.4]
|
|
129752
131572
|
*/
|
|
129753
131573
|
color?: string | null;
|
|
131574
|
+
/**
|
|
131575
|
+
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
131576
|
+
*
|
|
131577
|
+
* - `true`: All the text has the **Double strikethrough** attribute.
|
|
131578
|
+
*
|
|
131579
|
+
* - `false`: None of the text has the **Double strikethrough** attribute.
|
|
131580
|
+
*
|
|
131581
|
+
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
131582
|
+
*
|
|
131583
|
+
* @remarks
|
|
131584
|
+
* [Api set: PowerPointApi 1.8]
|
|
131585
|
+
*/
|
|
131586
|
+
doubleStrikethrough?: boolean | null;
|
|
129754
131587
|
/**
|
|
129755
131588
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
129756
131589
|
*
|
|
@@ -129778,6 +131611,58 @@ declare namespace PowerPoint {
|
|
|
129778
131611
|
* [Api set: PowerPointApi 1.4]
|
|
129779
131612
|
*/
|
|
129780
131613
|
size?: number | null;
|
|
131614
|
+
/**
|
|
131615
|
+
* Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
|
|
131616
|
+
*
|
|
131617
|
+
* - `true`: All the text has the **Small Caps** attribute.
|
|
131618
|
+
*
|
|
131619
|
+
* - `false`: None of the text has the **Small Caps** attribute.
|
|
131620
|
+
*
|
|
131621
|
+
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
131622
|
+
*
|
|
131623
|
+
* @remarks
|
|
131624
|
+
* [Api set: PowerPointApi 1.8]
|
|
131625
|
+
*/
|
|
131626
|
+
smallCaps?: boolean | null;
|
|
131627
|
+
/**
|
|
131628
|
+
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
131629
|
+
*
|
|
131630
|
+
* - `true`: All the text has the **Strikethrough** attribute.
|
|
131631
|
+
*
|
|
131632
|
+
* - `false`: None of the text has the **Strikethrough** attribute.
|
|
131633
|
+
*
|
|
131634
|
+
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
131635
|
+
*
|
|
131636
|
+
* @remarks
|
|
131637
|
+
* [Api set: PowerPointApi 1.8]
|
|
131638
|
+
*/
|
|
131639
|
+
strikethrough?: boolean | null;
|
|
131640
|
+
/**
|
|
131641
|
+
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
131642
|
+
*
|
|
131643
|
+
* - `true`: All the text has the **Subscript** attribute.
|
|
131644
|
+
*
|
|
131645
|
+
* - `false`: None of the text has the **Subscript** attribute.
|
|
131646
|
+
*
|
|
131647
|
+
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
131648
|
+
*
|
|
131649
|
+
* @remarks
|
|
131650
|
+
* [Api set: PowerPointApi 1.8]
|
|
131651
|
+
*/
|
|
131652
|
+
subscript?: boolean | null;
|
|
131653
|
+
/**
|
|
131654
|
+
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
131655
|
+
*
|
|
131656
|
+
* - `true`: All the text has the **Superscript** attribute.
|
|
131657
|
+
*
|
|
131658
|
+
* - `false`: None of the text has the **Superscript** attribute.
|
|
131659
|
+
*
|
|
131660
|
+
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
131661
|
+
*
|
|
131662
|
+
* @remarks
|
|
131663
|
+
* [Api set: PowerPointApi 1.8]
|
|
131664
|
+
*/
|
|
131665
|
+
superscript?: boolean | null;
|
|
129781
131666
|
/**
|
|
129782
131667
|
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
129783
131668
|
*
|
|
@@ -129786,6 +131671,74 @@ declare namespace PowerPoint {
|
|
|
129786
131671
|
*/
|
|
129787
131672
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
|
|
129788
131673
|
}
|
|
131674
|
+
/** An interface describing the data returned by calling `tableCell.toJSON()`. */
|
|
131675
|
+
interface TableCellData {
|
|
131676
|
+
/**
|
|
131677
|
+
* Gets the number of table columns this cell spans across.
|
|
131678
|
+
Will be greater than or equal to 1.
|
|
131679
|
+
*
|
|
131680
|
+
* @remarks
|
|
131681
|
+
* [Api set: PowerPointApi 1.8]
|
|
131682
|
+
*/
|
|
131683
|
+
columnCount?: number;
|
|
131684
|
+
/**
|
|
131685
|
+
* Gets the zero-based column index of the cell within the table.
|
|
131686
|
+
*
|
|
131687
|
+
* @remarks
|
|
131688
|
+
* [Api set: PowerPointApi 1.8]
|
|
131689
|
+
*/
|
|
131690
|
+
columnIndex?: number;
|
|
131691
|
+
/**
|
|
131692
|
+
* Gets the number of table rows this cell spans across.
|
|
131693
|
+
Will be greater than or equal to 1.
|
|
131694
|
+
*
|
|
131695
|
+
* @remarks
|
|
131696
|
+
* [Api set: PowerPointApi 1.8]
|
|
131697
|
+
*/
|
|
131698
|
+
rowCount?: number;
|
|
131699
|
+
/**
|
|
131700
|
+
* Gets the zero-based row index of the cell within the table.
|
|
131701
|
+
*
|
|
131702
|
+
* @remarks
|
|
131703
|
+
* [Api set: PowerPointApi 1.8]
|
|
131704
|
+
*/
|
|
131705
|
+
rowIndex?: number;
|
|
131706
|
+
/**
|
|
131707
|
+
* Specifies the text content of the table cell.
|
|
131708
|
+
*
|
|
131709
|
+
* @remarks
|
|
131710
|
+
* [Api set: PowerPointApi 1.8]
|
|
131711
|
+
*/
|
|
131712
|
+
text?: string;
|
|
131713
|
+
}
|
|
131714
|
+
/** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
|
|
131715
|
+
interface TableCellCollectionData {
|
|
131716
|
+
items?: PowerPoint.Interfaces.TableCellData[];
|
|
131717
|
+
}
|
|
131718
|
+
/** An interface describing the data returned by calling `table.toJSON()`. */
|
|
131719
|
+
interface TableData {
|
|
131720
|
+
/**
|
|
131721
|
+
* Gets the number of columns in the table.
|
|
131722
|
+
*
|
|
131723
|
+
* @remarks
|
|
131724
|
+
* [Api set: PowerPointApi 1.8]
|
|
131725
|
+
*/
|
|
131726
|
+
columnCount?: number;
|
|
131727
|
+
/**
|
|
131728
|
+
* Gets the number of rows in the table.
|
|
131729
|
+
*
|
|
131730
|
+
* @remarks
|
|
131731
|
+
* [Api set: PowerPointApi 1.8]
|
|
131732
|
+
*/
|
|
131733
|
+
rowCount?: number;
|
|
131734
|
+
/**
|
|
131735
|
+
* Gets all of the values in the table.
|
|
131736
|
+
*
|
|
131737
|
+
* @remarks
|
|
131738
|
+
* [Api set: PowerPointApi 1.8]
|
|
131739
|
+
*/
|
|
131740
|
+
values?: string[][];
|
|
131741
|
+
}
|
|
129789
131742
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
129790
131743
|
interface ShapeCollectionData {
|
|
129791
131744
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -129806,6 +131759,13 @@ declare namespace PowerPoint {
|
|
|
129806
131759
|
* [Api set: PowerPointApi 1.3]
|
|
129807
131760
|
*/
|
|
129808
131761
|
name?: string;
|
|
131762
|
+
/**
|
|
131763
|
+
* Returns the type of the slide layout.
|
|
131764
|
+
*
|
|
131765
|
+
* @remarks
|
|
131766
|
+
* [Api set: PowerPointApi 1.8]
|
|
131767
|
+
*/
|
|
131768
|
+
type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
|
|
129809
131769
|
}
|
|
129810
131770
|
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
|
|
129811
131771
|
interface SlideLayoutCollectionData {
|
|
@@ -129858,11 +131818,28 @@ declare namespace PowerPoint {
|
|
|
129858
131818
|
* [Api set: PowerPointApi 1.2]
|
|
129859
131819
|
*/
|
|
129860
131820
|
id?: string;
|
|
131821
|
+
/**
|
|
131822
|
+
* Returns the zero-based index of the slide representing its position in the presentation.
|
|
131823
|
+
*
|
|
131824
|
+
* @remarks
|
|
131825
|
+
* [Api set: PowerPointApi 1.8]
|
|
131826
|
+
*/
|
|
131827
|
+
index?: number;
|
|
129861
131828
|
}
|
|
129862
131829
|
/** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
|
|
129863
131830
|
interface ShapeScopedCollectionData {
|
|
129864
131831
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
129865
131832
|
}
|
|
131833
|
+
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
|
|
131834
|
+
interface ShapeGroupData {
|
|
131835
|
+
/**
|
|
131836
|
+
* Gets the unique ID of the shape group.
|
|
131837
|
+
*
|
|
131838
|
+
* @remarks
|
|
131839
|
+
* [Api set: PowerPointApi 1.8]
|
|
131840
|
+
*/
|
|
131841
|
+
id?: string;
|
|
131842
|
+
}
|
|
129866
131843
|
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
|
|
129867
131844
|
interface ShapeLineFormatData {
|
|
129868
131845
|
/**
|
|
@@ -130036,6 +132013,19 @@ declare namespace PowerPoint {
|
|
|
130036
132013
|
* [Api set: PowerPointApi 1.4]
|
|
130037
132014
|
*/
|
|
130038
132015
|
left?: number;
|
|
132016
|
+
/**
|
|
132017
|
+
* Returns the level of the specified shape.
|
|
132018
|
+
|
|
132019
|
+
- A level of 0 means the shape isn't part of a group.
|
|
132020
|
+
|
|
132021
|
+
- A level of 1 means the shape is part of a top-level group.
|
|
132022
|
+
|
|
132023
|
+
- A level greater than 1 indicates the shape is a nested group.
|
|
132024
|
+
*
|
|
132025
|
+
* @remarks
|
|
132026
|
+
* [Api set: PowerPointApi 1.8]
|
|
132027
|
+
*/
|
|
132028
|
+
level?: number;
|
|
130039
132029
|
/**
|
|
130040
132030
|
* Specifies the name of this shape.
|
|
130041
132031
|
*
|
|
@@ -130064,6 +132054,35 @@ declare namespace PowerPoint {
|
|
|
130064
132054
|
* [Api set: PowerPointApi 1.4]
|
|
130065
132055
|
*/
|
|
130066
132056
|
width?: number;
|
|
132057
|
+
/**
|
|
132058
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
132059
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
132060
|
+
*
|
|
132061
|
+
* @remarks
|
|
132062
|
+
* [Api set: PowerPointApi 1.8]
|
|
132063
|
+
*/
|
|
132064
|
+
zOrderPosition?: number;
|
|
132065
|
+
}
|
|
132066
|
+
/** An interface describing the data returned by calling `binding.toJSON()`. */
|
|
132067
|
+
interface BindingData {
|
|
132068
|
+
/**
|
|
132069
|
+
* Represents the binding identifier.
|
|
132070
|
+
*
|
|
132071
|
+
* @remarks
|
|
132072
|
+
* [Api set: PowerPointApi 1.8]
|
|
132073
|
+
*/
|
|
132074
|
+
id?: string;
|
|
132075
|
+
/**
|
|
132076
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
132077
|
+
*
|
|
132078
|
+
* @remarks
|
|
132079
|
+
* [Api set: PowerPointApi 1.8]
|
|
132080
|
+
*/
|
|
132081
|
+
type?: PowerPoint.BindingType | "Shape";
|
|
132082
|
+
}
|
|
132083
|
+
/** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
|
|
132084
|
+
interface BindingCollectionData {
|
|
132085
|
+
items?: PowerPoint.Interfaces.BindingData[];
|
|
130067
132086
|
}
|
|
130068
132087
|
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
|
|
130069
132088
|
interface CustomPropertyData {
|
|
@@ -130291,6 +132310,33 @@ declare namespace PowerPoint {
|
|
|
130291
132310
|
*/
|
|
130292
132311
|
namespaceUri?: boolean;
|
|
130293
132312
|
}
|
|
132313
|
+
/**
|
|
132314
|
+
* Represents the properties of a `placeholder` shape.
|
|
132315
|
+
*
|
|
132316
|
+
* @remarks
|
|
132317
|
+
* [Api set: PowerPointApi 1.8]
|
|
132318
|
+
*/
|
|
132319
|
+
interface PlaceholderFormatLoadOptions {
|
|
132320
|
+
/**
|
|
132321
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
132322
|
+
*/
|
|
132323
|
+
$all?: boolean;
|
|
132324
|
+
/**
|
|
132325
|
+
* Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
|
|
132326
|
+
Returns `null` if the placeholder is empty.
|
|
132327
|
+
*
|
|
132328
|
+
* @remarks
|
|
132329
|
+
* [Api set: PowerPointApi 1.8]
|
|
132330
|
+
*/
|
|
132331
|
+
containedType?: boolean;
|
|
132332
|
+
/**
|
|
132333
|
+
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
132334
|
+
*
|
|
132335
|
+
* @remarks
|
|
132336
|
+
* [Api set: PowerPointApi 1.8]
|
|
132337
|
+
*/
|
|
132338
|
+
type?: boolean;
|
|
132339
|
+
}
|
|
130294
132340
|
/**
|
|
130295
132341
|
* Represents a single hyperlink.
|
|
130296
132342
|
*
|
|
@@ -130387,6 +132433,19 @@ declare namespace PowerPoint {
|
|
|
130387
132433
|
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
130388
132434
|
*/
|
|
130389
132435
|
$all?: boolean;
|
|
132436
|
+
/**
|
|
132437
|
+
* Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
|
|
132438
|
+
*
|
|
132439
|
+
* - `true`: All the text has the **All Caps** attribute.
|
|
132440
|
+
*
|
|
132441
|
+
* - `false`: None of the text has the **All Caps**attribute.
|
|
132442
|
+
*
|
|
132443
|
+
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
|
|
132444
|
+
*
|
|
132445
|
+
* @remarks
|
|
132446
|
+
* [Api set: PowerPointApi 1.8]
|
|
132447
|
+
*/
|
|
132448
|
+
allCaps?: boolean;
|
|
130390
132449
|
/**
|
|
130391
132450
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
130392
132451
|
*
|
|
@@ -130407,6 +132466,19 @@ declare namespace PowerPoint {
|
|
|
130407
132466
|
* [Api set: PowerPointApi 1.4]
|
|
130408
132467
|
*/
|
|
130409
132468
|
color?: boolean;
|
|
132469
|
+
/**
|
|
132470
|
+
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
132471
|
+
*
|
|
132472
|
+
* - `true`: All the text has the **Double strikethrough** attribute.
|
|
132473
|
+
*
|
|
132474
|
+
* - `false`: None of the text has the **Double strikethrough** attribute.
|
|
132475
|
+
*
|
|
132476
|
+
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
132477
|
+
*
|
|
132478
|
+
* @remarks
|
|
132479
|
+
* [Api set: PowerPointApi 1.8]
|
|
132480
|
+
*/
|
|
132481
|
+
doubleStrikethrough?: boolean;
|
|
130410
132482
|
/**
|
|
130411
132483
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
130412
132484
|
*
|
|
@@ -130434,6 +132506,58 @@ declare namespace PowerPoint {
|
|
|
130434
132506
|
* [Api set: PowerPointApi 1.4]
|
|
130435
132507
|
*/
|
|
130436
132508
|
size?: boolean;
|
|
132509
|
+
/**
|
|
132510
|
+
* Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
|
|
132511
|
+
*
|
|
132512
|
+
* - `true`: All the text has the **Small Caps** attribute.
|
|
132513
|
+
*
|
|
132514
|
+
* - `false`: None of the text has the **Small Caps** attribute.
|
|
132515
|
+
*
|
|
132516
|
+
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
132517
|
+
*
|
|
132518
|
+
* @remarks
|
|
132519
|
+
* [Api set: PowerPointApi 1.8]
|
|
132520
|
+
*/
|
|
132521
|
+
smallCaps?: boolean;
|
|
132522
|
+
/**
|
|
132523
|
+
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
132524
|
+
*
|
|
132525
|
+
* - `true`: All the text has the **Strikethrough** attribute.
|
|
132526
|
+
*
|
|
132527
|
+
* - `false`: None of the text has the **Strikethrough** attribute.
|
|
132528
|
+
*
|
|
132529
|
+
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
132530
|
+
*
|
|
132531
|
+
* @remarks
|
|
132532
|
+
* [Api set: PowerPointApi 1.8]
|
|
132533
|
+
*/
|
|
132534
|
+
strikethrough?: boolean;
|
|
132535
|
+
/**
|
|
132536
|
+
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
132537
|
+
*
|
|
132538
|
+
* - `true`: All the text has the **Subscript** attribute.
|
|
132539
|
+
*
|
|
132540
|
+
* - `false`: None of the text has the **Subscript** attribute.
|
|
132541
|
+
*
|
|
132542
|
+
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
132543
|
+
*
|
|
132544
|
+
* @remarks
|
|
132545
|
+
* [Api set: PowerPointApi 1.8]
|
|
132546
|
+
*/
|
|
132547
|
+
subscript?: boolean;
|
|
132548
|
+
/**
|
|
132549
|
+
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
132550
|
+
*
|
|
132551
|
+
* - `true`: All the text has the **Superscript** attribute.
|
|
132552
|
+
*
|
|
132553
|
+
* - `false`: None of the text has the **Superscript** attribute.
|
|
132554
|
+
*
|
|
132555
|
+
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
132556
|
+
*
|
|
132557
|
+
* @remarks
|
|
132558
|
+
* [Api set: PowerPointApi 1.8]
|
|
132559
|
+
*/
|
|
132560
|
+
superscript?: boolean;
|
|
130437
132561
|
/**
|
|
130438
132562
|
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
130439
132563
|
*
|
|
@@ -130442,6 +132566,137 @@ declare namespace PowerPoint {
|
|
|
130442
132566
|
*/
|
|
130443
132567
|
underline?: boolean;
|
|
130444
132568
|
}
|
|
132569
|
+
/**
|
|
132570
|
+
* Represents a table.
|
|
132571
|
+
*
|
|
132572
|
+
* @remarks
|
|
132573
|
+
* [Api set: PowerPointApi 1.8]
|
|
132574
|
+
*/
|
|
132575
|
+
interface TableCellLoadOptions {
|
|
132576
|
+
/**
|
|
132577
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
132578
|
+
*/
|
|
132579
|
+
$all?: boolean;
|
|
132580
|
+
/**
|
|
132581
|
+
* Gets the number of table columns this cell spans across.
|
|
132582
|
+
Will be greater than or equal to 1.
|
|
132583
|
+
*
|
|
132584
|
+
* @remarks
|
|
132585
|
+
* [Api set: PowerPointApi 1.8]
|
|
132586
|
+
*/
|
|
132587
|
+
columnCount?: boolean;
|
|
132588
|
+
/**
|
|
132589
|
+
* Gets the zero-based column index of the cell within the table.
|
|
132590
|
+
*
|
|
132591
|
+
* @remarks
|
|
132592
|
+
* [Api set: PowerPointApi 1.8]
|
|
132593
|
+
*/
|
|
132594
|
+
columnIndex?: boolean;
|
|
132595
|
+
/**
|
|
132596
|
+
* Gets the number of table rows this cell spans across.
|
|
132597
|
+
Will be greater than or equal to 1.
|
|
132598
|
+
*
|
|
132599
|
+
* @remarks
|
|
132600
|
+
* [Api set: PowerPointApi 1.8]
|
|
132601
|
+
*/
|
|
132602
|
+
rowCount?: boolean;
|
|
132603
|
+
/**
|
|
132604
|
+
* Gets the zero-based row index of the cell within the table.
|
|
132605
|
+
*
|
|
132606
|
+
* @remarks
|
|
132607
|
+
* [Api set: PowerPointApi 1.8]
|
|
132608
|
+
*/
|
|
132609
|
+
rowIndex?: boolean;
|
|
132610
|
+
/**
|
|
132611
|
+
* Specifies the text content of the table cell.
|
|
132612
|
+
*
|
|
132613
|
+
* @remarks
|
|
132614
|
+
* [Api set: PowerPointApi 1.8]
|
|
132615
|
+
*/
|
|
132616
|
+
text?: boolean;
|
|
132617
|
+
}
|
|
132618
|
+
/**
|
|
132619
|
+
* Represents a collection of table cells.
|
|
132620
|
+
*
|
|
132621
|
+
* @remarks
|
|
132622
|
+
* [Api set: PowerPointApi 1.8]
|
|
132623
|
+
*/
|
|
132624
|
+
interface TableCellCollectionLoadOptions {
|
|
132625
|
+
/**
|
|
132626
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
132627
|
+
*/
|
|
132628
|
+
$all?: boolean;
|
|
132629
|
+
/**
|
|
132630
|
+
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
|
|
132631
|
+
Will be greater than or equal to 1.
|
|
132632
|
+
*
|
|
132633
|
+
* @remarks
|
|
132634
|
+
* [Api set: PowerPointApi 1.8]
|
|
132635
|
+
*/
|
|
132636
|
+
columnCount?: boolean;
|
|
132637
|
+
/**
|
|
132638
|
+
* For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
|
|
132639
|
+
*
|
|
132640
|
+
* @remarks
|
|
132641
|
+
* [Api set: PowerPointApi 1.8]
|
|
132642
|
+
*/
|
|
132643
|
+
columnIndex?: boolean;
|
|
132644
|
+
/**
|
|
132645
|
+
* For EACH ITEM in the collection: Gets the number of table rows this cell spans across.
|
|
132646
|
+
Will be greater than or equal to 1.
|
|
132647
|
+
*
|
|
132648
|
+
* @remarks
|
|
132649
|
+
* [Api set: PowerPointApi 1.8]
|
|
132650
|
+
*/
|
|
132651
|
+
rowCount?: boolean;
|
|
132652
|
+
/**
|
|
132653
|
+
* For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
|
|
132654
|
+
*
|
|
132655
|
+
* @remarks
|
|
132656
|
+
* [Api set: PowerPointApi 1.8]
|
|
132657
|
+
*/
|
|
132658
|
+
rowIndex?: boolean;
|
|
132659
|
+
/**
|
|
132660
|
+
* For EACH ITEM in the collection: Specifies the text content of the table cell.
|
|
132661
|
+
*
|
|
132662
|
+
* @remarks
|
|
132663
|
+
* [Api set: PowerPointApi 1.8]
|
|
132664
|
+
*/
|
|
132665
|
+
text?: boolean;
|
|
132666
|
+
}
|
|
132667
|
+
/**
|
|
132668
|
+
* Represents a table.
|
|
132669
|
+
*
|
|
132670
|
+
* @remarks
|
|
132671
|
+
* [Api set: PowerPointApi 1.8]
|
|
132672
|
+
*/
|
|
132673
|
+
interface TableLoadOptions {
|
|
132674
|
+
/**
|
|
132675
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
132676
|
+
*/
|
|
132677
|
+
$all?: boolean;
|
|
132678
|
+
/**
|
|
132679
|
+
* Gets the number of columns in the table.
|
|
132680
|
+
*
|
|
132681
|
+
* @remarks
|
|
132682
|
+
* [Api set: PowerPointApi 1.8]
|
|
132683
|
+
*/
|
|
132684
|
+
columnCount?: boolean;
|
|
132685
|
+
/**
|
|
132686
|
+
* Gets the number of rows in the table.
|
|
132687
|
+
*
|
|
132688
|
+
* @remarks
|
|
132689
|
+
* [Api set: PowerPointApi 1.8]
|
|
132690
|
+
*/
|
|
132691
|
+
rowCount?: boolean;
|
|
132692
|
+
/**
|
|
132693
|
+
* Gets all of the values in the table.
|
|
132694
|
+
*
|
|
132695
|
+
* @remarks
|
|
132696
|
+
* [Api set: PowerPointApi 1.8]
|
|
132697
|
+
*/
|
|
132698
|
+
values?: boolean;
|
|
132699
|
+
}
|
|
130445
132700
|
/**
|
|
130446
132701
|
* Represents the collection of shapes.
|
|
130447
132702
|
*
|
|
@@ -130460,6 +132715,14 @@ declare namespace PowerPoint {
|
|
|
130460
132715
|
* [Api set: PowerPointApi 1.4]
|
|
130461
132716
|
*/
|
|
130462
132717
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
132718
|
+
/**
|
|
132719
|
+
* For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
|
|
132720
|
+
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
132721
|
+
*
|
|
132722
|
+
* @remarks
|
|
132723
|
+
* [Api set: PowerPointApi 1.8]
|
|
132724
|
+
*/
|
|
132725
|
+
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
130463
132726
|
/**
|
|
130464
132727
|
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
130465
132728
|
*
|
|
@@ -130467,6 +132730,22 @@ declare namespace PowerPoint {
|
|
|
130467
132730
|
* [Api set: PowerPointApi 1.4]
|
|
130468
132731
|
*/
|
|
130469
132732
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
132733
|
+
/**
|
|
132734
|
+
* For EACH ITEM in the collection: Returns the parent group of this shape.
|
|
132735
|
+
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
132736
|
+
*
|
|
132737
|
+
* @remarks
|
|
132738
|
+
* [Api set: PowerPointApi 1.8]
|
|
132739
|
+
*/
|
|
132740
|
+
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
132741
|
+
/**
|
|
132742
|
+
* For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
|
|
132743
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
132744
|
+
*
|
|
132745
|
+
* @remarks
|
|
132746
|
+
* [Api set: PowerPointApi 1.8]
|
|
132747
|
+
*/
|
|
132748
|
+
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
130470
132749
|
/**
|
|
130471
132750
|
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
130472
132751
|
*
|
|
@@ -130495,6 +132774,19 @@ declare namespace PowerPoint {
|
|
|
130495
132774
|
* [Api set: PowerPointApi 1.4]
|
|
130496
132775
|
*/
|
|
130497
132776
|
left?: boolean;
|
|
132777
|
+
/**
|
|
132778
|
+
* For EACH ITEM in the collection: Returns the level of the specified shape.
|
|
132779
|
+
|
|
132780
|
+
- A level of 0 means the shape isn't part of a group.
|
|
132781
|
+
|
|
132782
|
+
- A level of 1 means the shape is part of a top-level group.
|
|
132783
|
+
|
|
132784
|
+
- A level greater than 1 indicates the shape is a nested group.
|
|
132785
|
+
*
|
|
132786
|
+
* @remarks
|
|
132787
|
+
* [Api set: PowerPointApi 1.8]
|
|
132788
|
+
*/
|
|
132789
|
+
level?: boolean;
|
|
130498
132790
|
/**
|
|
130499
132791
|
* For EACH ITEM in the collection: Specifies the name of this shape.
|
|
130500
132792
|
*
|
|
@@ -130523,6 +132815,14 @@ declare namespace PowerPoint {
|
|
|
130523
132815
|
* [Api set: PowerPointApi 1.4]
|
|
130524
132816
|
*/
|
|
130525
132817
|
width?: boolean;
|
|
132818
|
+
/**
|
|
132819
|
+
* For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
132820
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
132821
|
+
*
|
|
132822
|
+
* @remarks
|
|
132823
|
+
* [Api set: PowerPointApi 1.8]
|
|
132824
|
+
*/
|
|
132825
|
+
zOrderPosition?: boolean;
|
|
130526
132826
|
}
|
|
130527
132827
|
/**
|
|
130528
132828
|
* Represents the layout of a slide.
|
|
@@ -130549,6 +132849,13 @@ declare namespace PowerPoint {
|
|
|
130549
132849
|
* [Api set: PowerPointApi 1.3]
|
|
130550
132850
|
*/
|
|
130551
132851
|
name?: boolean;
|
|
132852
|
+
/**
|
|
132853
|
+
* Returns the type of the slide layout.
|
|
132854
|
+
*
|
|
132855
|
+
* @remarks
|
|
132856
|
+
* [Api set: PowerPointApi 1.8]
|
|
132857
|
+
*/
|
|
132858
|
+
type?: boolean;
|
|
130552
132859
|
}
|
|
130553
132860
|
/**
|
|
130554
132861
|
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
@@ -130575,6 +132882,13 @@ declare namespace PowerPoint {
|
|
|
130575
132882
|
* [Api set: PowerPointApi 1.3]
|
|
130576
132883
|
*/
|
|
130577
132884
|
name?: boolean;
|
|
132885
|
+
/**
|
|
132886
|
+
* For EACH ITEM in the collection: Returns the type of the slide layout.
|
|
132887
|
+
*
|
|
132888
|
+
* @remarks
|
|
132889
|
+
* [Api set: PowerPointApi 1.8]
|
|
132890
|
+
*/
|
|
132891
|
+
type?: boolean;
|
|
130578
132892
|
}
|
|
130579
132893
|
/**
|
|
130580
132894
|
* Represents the Slide Master of a slide.
|
|
@@ -130686,6 +133000,13 @@ declare namespace PowerPoint {
|
|
|
130686
133000
|
* [Api set: PowerPointApi 1.2]
|
|
130687
133001
|
*/
|
|
130688
133002
|
id?: boolean;
|
|
133003
|
+
/**
|
|
133004
|
+
* Returns the zero-based index of the slide representing its position in the presentation.
|
|
133005
|
+
*
|
|
133006
|
+
* @remarks
|
|
133007
|
+
* [Api set: PowerPointApi 1.8]
|
|
133008
|
+
*/
|
|
133009
|
+
index?: boolean;
|
|
130689
133010
|
}
|
|
130690
133011
|
/**
|
|
130691
133012
|
* Represents a collection of shapes.
|
|
@@ -130705,6 +133026,14 @@ declare namespace PowerPoint {
|
|
|
130705
133026
|
* [Api set: PowerPointApi 1.5]
|
|
130706
133027
|
*/
|
|
130707
133028
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
133029
|
+
/**
|
|
133030
|
+
* For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
|
|
133031
|
+
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
133032
|
+
*
|
|
133033
|
+
* @remarks
|
|
133034
|
+
* [Api set: PowerPointApi 1.8]
|
|
133035
|
+
*/
|
|
133036
|
+
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
130708
133037
|
/**
|
|
130709
133038
|
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
130710
133039
|
*
|
|
@@ -130712,6 +133041,22 @@ declare namespace PowerPoint {
|
|
|
130712
133041
|
* [Api set: PowerPointApi 1.5]
|
|
130713
133042
|
*/
|
|
130714
133043
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
133044
|
+
/**
|
|
133045
|
+
* For EACH ITEM in the collection: Returns the parent group of this shape.
|
|
133046
|
+
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
133047
|
+
*
|
|
133048
|
+
* @remarks
|
|
133049
|
+
* [Api set: PowerPointApi 1.8]
|
|
133050
|
+
*/
|
|
133051
|
+
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
133052
|
+
/**
|
|
133053
|
+
* For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
|
|
133054
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
133055
|
+
*
|
|
133056
|
+
* @remarks
|
|
133057
|
+
* [Api set: PowerPointApi 1.8]
|
|
133058
|
+
*/
|
|
133059
|
+
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
130715
133060
|
/**
|
|
130716
133061
|
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
130717
133062
|
*
|
|
@@ -130740,6 +133085,19 @@ declare namespace PowerPoint {
|
|
|
130740
133085
|
* [Api set: PowerPointApi 1.4]
|
|
130741
133086
|
*/
|
|
130742
133087
|
left?: boolean;
|
|
133088
|
+
/**
|
|
133089
|
+
* For EACH ITEM in the collection: Returns the level of the specified shape.
|
|
133090
|
+
|
|
133091
|
+
- A level of 0 means the shape isn't part of a group.
|
|
133092
|
+
|
|
133093
|
+
- A level of 1 means the shape is part of a top-level group.
|
|
133094
|
+
|
|
133095
|
+
- A level greater than 1 indicates the shape is a nested group.
|
|
133096
|
+
*
|
|
133097
|
+
* @remarks
|
|
133098
|
+
* [Api set: PowerPointApi 1.8]
|
|
133099
|
+
*/
|
|
133100
|
+
level?: boolean;
|
|
130743
133101
|
/**
|
|
130744
133102
|
* For EACH ITEM in the collection: Specifies the name of this shape.
|
|
130745
133103
|
*
|
|
@@ -130768,6 +133126,40 @@ declare namespace PowerPoint {
|
|
|
130768
133126
|
* [Api set: PowerPointApi 1.4]
|
|
130769
133127
|
*/
|
|
130770
133128
|
width?: boolean;
|
|
133129
|
+
/**
|
|
133130
|
+
* For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
133131
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
133132
|
+
*
|
|
133133
|
+
* @remarks
|
|
133134
|
+
* [Api set: PowerPointApi 1.8]
|
|
133135
|
+
*/
|
|
133136
|
+
zOrderPosition?: boolean;
|
|
133137
|
+
}
|
|
133138
|
+
/**
|
|
133139
|
+
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
|
|
133140
|
+
*
|
|
133141
|
+
* @remarks
|
|
133142
|
+
* [Api set: PowerPointApi 1.8]
|
|
133143
|
+
*/
|
|
133144
|
+
interface ShapeGroupLoadOptions {
|
|
133145
|
+
/**
|
|
133146
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
133147
|
+
*/
|
|
133148
|
+
$all?: boolean;
|
|
133149
|
+
/**
|
|
133150
|
+
* Returns the `Shape` object associated with the group.
|
|
133151
|
+
*
|
|
133152
|
+
* @remarks
|
|
133153
|
+
* [Api set: PowerPointApi 1.8]
|
|
133154
|
+
*/
|
|
133155
|
+
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
133156
|
+
/**
|
|
133157
|
+
* Gets the unique ID of the shape group.
|
|
133158
|
+
*
|
|
133159
|
+
* @remarks
|
|
133160
|
+
* [Api set: PowerPointApi 1.8]
|
|
133161
|
+
*/
|
|
133162
|
+
id?: boolean;
|
|
130771
133163
|
}
|
|
130772
133164
|
/**
|
|
130773
133165
|
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
|
|
@@ -131010,6 +133402,14 @@ declare namespace PowerPoint {
|
|
|
131010
133402
|
* [Api set: PowerPointApi 1.4]
|
|
131011
133403
|
*/
|
|
131012
133404
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
133405
|
+
/**
|
|
133406
|
+
* Returns the `ShapeGroup` associated with the shape.
|
|
133407
|
+
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
133408
|
+
*
|
|
133409
|
+
* @remarks
|
|
133410
|
+
* [Api set: PowerPointApi 1.8]
|
|
133411
|
+
*/
|
|
133412
|
+
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
131013
133413
|
/**
|
|
131014
133414
|
* Returns the line formatting of this shape.
|
|
131015
133415
|
*
|
|
@@ -131017,6 +133417,22 @@ declare namespace PowerPoint {
|
|
|
131017
133417
|
* [Api set: PowerPointApi 1.4]
|
|
131018
133418
|
*/
|
|
131019
133419
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
133420
|
+
/**
|
|
133421
|
+
* Returns the parent group of this shape.
|
|
133422
|
+
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
133423
|
+
*
|
|
133424
|
+
* @remarks
|
|
133425
|
+
* [Api set: PowerPointApi 1.8]
|
|
133426
|
+
*/
|
|
133427
|
+
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
133428
|
+
/**
|
|
133429
|
+
* Returns the properties that apply specifically to this placeholder.
|
|
133430
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
133431
|
+
*
|
|
133432
|
+
* @remarks
|
|
133433
|
+
* [Api set: PowerPointApi 1.8]
|
|
133434
|
+
*/
|
|
133435
|
+
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
131020
133436
|
/**
|
|
131021
133437
|
* Returns the text frame object of this shape.
|
|
131022
133438
|
*
|
|
@@ -131046,6 +133462,19 @@ declare namespace PowerPoint {
|
|
|
131046
133462
|
*/
|
|
131047
133463
|
left?: boolean;
|
|
131048
133464
|
/**
|
|
133465
|
+
* Returns the level of the specified shape.
|
|
133466
|
+
|
|
133467
|
+
- A level of 0 means the shape isn't part of a group.
|
|
133468
|
+
|
|
133469
|
+
- A level of 1 means the shape is part of a top-level group.
|
|
133470
|
+
|
|
133471
|
+
- A level greater than 1 indicates the shape is a nested group.
|
|
133472
|
+
*
|
|
133473
|
+
* @remarks
|
|
133474
|
+
* [Api set: PowerPointApi 1.8]
|
|
133475
|
+
*/
|
|
133476
|
+
level?: boolean;
|
|
133477
|
+
/**
|
|
131049
133478
|
* Specifies the name of this shape.
|
|
131050
133479
|
*
|
|
131051
133480
|
* @remarks
|
|
@@ -131073,6 +133502,66 @@ declare namespace PowerPoint {
|
|
|
131073
133502
|
* [Api set: PowerPointApi 1.4]
|
|
131074
133503
|
*/
|
|
131075
133504
|
width?: boolean;
|
|
133505
|
+
/**
|
|
133506
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
133507
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
133508
|
+
*
|
|
133509
|
+
* @remarks
|
|
133510
|
+
* [Api set: PowerPointApi 1.8]
|
|
133511
|
+
*/
|
|
133512
|
+
zOrderPosition?: boolean;
|
|
133513
|
+
}
|
|
133514
|
+
/**
|
|
133515
|
+
* Represents an Office.js binding that is defined in the presentation.
|
|
133516
|
+
*
|
|
133517
|
+
* @remarks
|
|
133518
|
+
* [Api set: PowerPointApi 1.8]
|
|
133519
|
+
*/
|
|
133520
|
+
interface BindingLoadOptions {
|
|
133521
|
+
/**
|
|
133522
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
133523
|
+
*/
|
|
133524
|
+
$all?: boolean;
|
|
133525
|
+
/**
|
|
133526
|
+
* Represents the binding identifier.
|
|
133527
|
+
*
|
|
133528
|
+
* @remarks
|
|
133529
|
+
* [Api set: PowerPointApi 1.8]
|
|
133530
|
+
*/
|
|
133531
|
+
id?: boolean;
|
|
133532
|
+
/**
|
|
133533
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
133534
|
+
*
|
|
133535
|
+
* @remarks
|
|
133536
|
+
* [Api set: PowerPointApi 1.8]
|
|
133537
|
+
*/
|
|
133538
|
+
type?: boolean;
|
|
133539
|
+
}
|
|
133540
|
+
/**
|
|
133541
|
+
* Represents the collection of all the binding objects that are part of the presentation.
|
|
133542
|
+
*
|
|
133543
|
+
* @remarks
|
|
133544
|
+
* [Api set: PowerPointApi 1.8]
|
|
133545
|
+
*/
|
|
133546
|
+
interface BindingCollectionLoadOptions {
|
|
133547
|
+
/**
|
|
133548
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
133549
|
+
*/
|
|
133550
|
+
$all?: boolean;
|
|
133551
|
+
/**
|
|
133552
|
+
* For EACH ITEM in the collection: Represents the binding identifier.
|
|
133553
|
+
*
|
|
133554
|
+
* @remarks
|
|
133555
|
+
* [Api set: PowerPointApi 1.8]
|
|
133556
|
+
*/
|
|
133557
|
+
id?: boolean;
|
|
133558
|
+
/**
|
|
133559
|
+
* For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
|
|
133560
|
+
*
|
|
133561
|
+
* @remarks
|
|
133562
|
+
* [Api set: PowerPointApi 1.8]
|
|
133563
|
+
*/
|
|
133564
|
+
type?: boolean;
|
|
131076
133565
|
}
|
|
131077
133566
|
/**
|
|
131078
133567
|
* Represents a custom property.
|
|
@@ -131263,6 +133752,13 @@ declare namespace PowerPoint {
|
|
|
131263
133752
|
* [Api set: PowerPointApi 1.2]
|
|
131264
133753
|
*/
|
|
131265
133754
|
id?: boolean;
|
|
133755
|
+
/**
|
|
133756
|
+
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
|
|
133757
|
+
*
|
|
133758
|
+
* @remarks
|
|
133759
|
+
* [Api set: PowerPointApi 1.8]
|
|
133760
|
+
*/
|
|
133761
|
+
index?: boolean;
|
|
131266
133762
|
}
|
|
131267
133763
|
/**
|
|
131268
133764
|
* Represents a collection of slides in the presentation.
|
|
@@ -131296,6 +133792,13 @@ declare namespace PowerPoint {
|
|
|
131296
133792
|
* [Api set: PowerPointApi 1.2]
|
|
131297
133793
|
*/
|
|
131298
133794
|
id?: boolean;
|
|
133795
|
+
/**
|
|
133796
|
+
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
|
|
133797
|
+
*
|
|
133798
|
+
* @remarks
|
|
133799
|
+
* [Api set: PowerPointApi 1.8]
|
|
133800
|
+
*/
|
|
133801
|
+
index?: boolean;
|
|
131299
133802
|
}
|
|
131300
133803
|
/**
|
|
131301
133804
|
* Represents the collection of Slide Masters in the presentation.
|