@types/office-js 1.0.562 → 1.0.564
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 +3290 -336
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -16454,8 +16454,9 @@ declare namespace Office {
|
|
|
16454
16454
|
*
|
|
16455
16455
|
* **Important**:
|
|
16456
16456
|
*
|
|
16457
|
-
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
16458
|
-
* In
|
|
16457
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
16458
|
+
* In this case, the `from` property returns the delegator's email address and the `sender` property returns the delegate's address. For information about mailbox delegation, see
|
|
16459
|
+
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
16459
16460
|
*
|
|
16460
16461
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
16461
16462
|
*/
|
|
@@ -16659,8 +16660,9 @@ declare namespace Office {
|
|
|
16659
16660
|
*
|
|
16660
16661
|
* **Important**:
|
|
16661
16662
|
*
|
|
16662
|
-
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
16663
|
-
* In
|
|
16663
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
16664
|
+
* In this case, the `from` property returns the delegator's email address and the `sender` property returns the delegate's address. For information about mailbox delegation, see
|
|
16665
|
+
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
16664
16666
|
*
|
|
16665
16667
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
16666
16668
|
*/
|
|
@@ -20630,11 +20632,6 @@ declare namespace Office {
|
|
|
20630
20632
|
/**
|
|
20631
20633
|
* Gets the email address of the sender of a message.
|
|
20632
20634
|
*
|
|
20633
|
-
* The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
20634
|
-
* In that case, the `from` property represents the delegator, and the `sender` property represents the delegate.
|
|
20635
|
-
*
|
|
20636
|
-
* **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
20637
|
-
*
|
|
20638
20635
|
* The `from` property returns an `EmailAddressDetails` object.
|
|
20639
20636
|
*
|
|
20640
20637
|
* @remarks
|
|
@@ -20642,6 +20639,15 @@ declare namespace Office {
|
|
|
20642
20639
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
20643
20640
|
*
|
|
20644
20641
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20642
|
+
*
|
|
20643
|
+
*
|
|
20644
|
+
* **Important**:
|
|
20645
|
+
*
|
|
20646
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
20647
|
+
* In this case, the `from` property returns the delegator's email address and the `sender` property returns the delegate's address. For information about mailbox delegation, see
|
|
20648
|
+
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
20649
|
+
*
|
|
20650
|
+
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
20645
20651
|
*/
|
|
20646
20652
|
from: EmailAddressDetails;
|
|
20647
20653
|
/**
|
|
@@ -20824,16 +20830,19 @@ declare namespace Office {
|
|
|
20824
20830
|
/**
|
|
20825
20831
|
* Gets the email address of the sender of an email message.
|
|
20826
20832
|
*
|
|
20827
|
-
* The `from` and `sender` properties represent the same person unless the message is sent by a delegate.
|
|
20828
|
-
* In that case, the `from` property represents the delegator, and the `sender` property represents the delegate.
|
|
20829
|
-
*
|
|
20830
|
-
* **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
20831
|
-
*
|
|
20832
20833
|
* @remarks
|
|
20833
20834
|
*
|
|
20834
20835
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
20835
20836
|
*
|
|
20836
20837
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
20838
|
+
*
|
|
20839
|
+
* **Important**:
|
|
20840
|
+
*
|
|
20841
|
+
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
20842
|
+
* In this case, the `from` property returns the delegator's email address and the `sender` property returns the delegate's address. For information about mailbox delegation, see
|
|
20843
|
+
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
20844
|
+
*
|
|
20845
|
+
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
20837
20846
|
*/
|
|
20838
20847
|
sender: EmailAddressDetails;
|
|
20839
20848
|
/**
|
|
@@ -177883,9 +177892,9 @@ declare namespace PowerPoint {
|
|
|
177883
177892
|
*/
|
|
177884
177893
|
static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application;
|
|
177885
177894
|
/**
|
|
177886
|
-
|
|
177887
|
-
|
|
177888
|
-
|
|
177895
|
+
* 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.)
|
|
177896
|
+
* Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
177897
|
+
*/
|
|
177889
177898
|
toJSON(): {
|
|
177890
177899
|
[key: string]: string;
|
|
177891
177900
|
};
|
|
@@ -177915,6 +177924,13 @@ declare namespace PowerPoint {
|
|
|
177915
177924
|
* [Api set: PowerPointApi 1.7]
|
|
177916
177925
|
*/
|
|
177917
177926
|
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
|
|
177927
|
+
/**
|
|
177928
|
+
* Returns the page setup information whose properties control slide setup attributes for the presentation.
|
|
177929
|
+
*
|
|
177930
|
+
* @remarks
|
|
177931
|
+
* [Api set: PowerPointApi 1.10]
|
|
177932
|
+
*/
|
|
177933
|
+
readonly pageSetup: PowerPoint.PageSetup;
|
|
177918
177934
|
/**
|
|
177919
177935
|
* Gets the properties of the presentation.
|
|
177920
177936
|
*
|
|
@@ -178032,9 +178048,9 @@ declare namespace PowerPoint {
|
|
|
178032
178048
|
expand?: string;
|
|
178033
178049
|
}): PowerPoint.Presentation;
|
|
178034
178050
|
/**
|
|
178035
|
-
|
|
178036
|
-
|
|
178037
|
-
|
|
178051
|
+
* 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.)
|
|
178052
|
+
* Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178053
|
+
*/
|
|
178038
178054
|
toJSON(): PowerPoint.Interfaces.PresentationData;
|
|
178039
178055
|
}
|
|
178040
178056
|
/**
|
|
@@ -178064,6 +178080,71 @@ declare namespace PowerPoint {
|
|
|
178064
178080
|
*/
|
|
178065
178081
|
slideMasterId?: string;
|
|
178066
178082
|
}
|
|
178083
|
+
/**
|
|
178084
|
+
* Represents the adjustment values for a shape.
|
|
178085
|
+
*
|
|
178086
|
+
* @remarks
|
|
178087
|
+
* [Api set: PowerPointApi 1.10]
|
|
178088
|
+
*/
|
|
178089
|
+
class Adjustments extends OfficeExtension.ClientObject {
|
|
178090
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
178091
|
+
context: RequestContext;
|
|
178092
|
+
/**
|
|
178093
|
+
* Specifies the number of adjustment points.
|
|
178094
|
+
*
|
|
178095
|
+
* @remarks
|
|
178096
|
+
* [Api set: PowerPointApi 1.10]
|
|
178097
|
+
*/
|
|
178098
|
+
readonly count: number;
|
|
178099
|
+
/**
|
|
178100
|
+
* Gets the adjustment value at the specified zero-based index.
|
|
178101
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
178102
|
+
*
|
|
178103
|
+
* @remarks
|
|
178104
|
+
* [Api set: PowerPointApi 1.10]
|
|
178105
|
+
*
|
|
178106
|
+
* @param index The index of the adjustment to retrieve.
|
|
178107
|
+
* @returns The adjustment value at the given index.
|
|
178108
|
+
*/
|
|
178109
|
+
get(index: number): OfficeExtension.ClientResult<number>;
|
|
178110
|
+
/**
|
|
178111
|
+
* Sets the adjustment value at the specified zero-based index.
|
|
178112
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
178113
|
+
*
|
|
178114
|
+
* @remarks
|
|
178115
|
+
* [Api set: PowerPointApi 1.10]
|
|
178116
|
+
*
|
|
178117
|
+
* @param index The index of the adjustment to set.
|
|
178118
|
+
* @param value The adjustment value to set.
|
|
178119
|
+
*/
|
|
178120
|
+
set(index: number, value: number): void;
|
|
178121
|
+
/**
|
|
178122
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178123
|
+
*
|
|
178124
|
+
* @param options Provides options for which properties of the object to load.
|
|
178125
|
+
*/
|
|
178126
|
+
load(options?: PowerPoint.Interfaces.AdjustmentsLoadOptions): PowerPoint.Adjustments;
|
|
178127
|
+
/**
|
|
178128
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178129
|
+
*
|
|
178130
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
178131
|
+
*/
|
|
178132
|
+
load(propertyNames?: string | string[]): PowerPoint.Adjustments;
|
|
178133
|
+
/**
|
|
178134
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178135
|
+
*
|
|
178136
|
+
* @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.
|
|
178137
|
+
*/
|
|
178138
|
+
load(propertyNamesAndPaths?: {
|
|
178139
|
+
select?: string;
|
|
178140
|
+
expand?: string;
|
|
178141
|
+
}): PowerPoint.Adjustments;
|
|
178142
|
+
/**
|
|
178143
|
+
* 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.)
|
|
178144
|
+
* Whereas the original `PowerPoint.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178145
|
+
*/
|
|
178146
|
+
toJSON(): PowerPoint.Interfaces.AdjustmentsData;
|
|
178147
|
+
}
|
|
178067
178148
|
/**
|
|
178068
178149
|
* Represents the possible binding types.
|
|
178069
178150
|
*
|
|
@@ -178146,9 +178227,9 @@ declare namespace PowerPoint {
|
|
|
178146
178227
|
expand?: string;
|
|
178147
178228
|
}): PowerPoint.CustomXmlPart;
|
|
178148
178229
|
/**
|
|
178149
|
-
|
|
178150
|
-
|
|
178151
|
-
|
|
178230
|
+
* 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.)
|
|
178231
|
+
* Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178232
|
+
*/
|
|
178152
178233
|
toJSON(): PowerPoint.Interfaces.CustomXmlPartData;
|
|
178153
178234
|
}
|
|
178154
178235
|
/**
|
|
@@ -178181,6 +178262,17 @@ declare namespace PowerPoint {
|
|
|
178181
178262
|
* @param id ID of the object to be retrieved.
|
|
178182
178263
|
*/
|
|
178183
178264
|
getItem(id: string): PowerPoint.CustomXmlPart;
|
|
178265
|
+
/**
|
|
178266
|
+
* Gets a `CustomXmlPart` by its zero-based index in the collection.
|
|
178267
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
178268
|
+
*
|
|
178269
|
+
* @remarks
|
|
178270
|
+
* [Api set: PowerPointApi 1.10]
|
|
178271
|
+
*
|
|
178272
|
+
* @param index The index of the custom XML part in the collection.
|
|
178273
|
+
* @returns The custom XML part at the given index.
|
|
178274
|
+
*/
|
|
178275
|
+
getItemAt(index: number): PowerPoint.CustomXmlPart;
|
|
178184
178276
|
/**
|
|
178185
178277
|
* Gets a `CustomXmlPart` based on its ID.
|
|
178186
178278
|
If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
@@ -178227,9 +178319,9 @@ declare namespace PowerPoint {
|
|
|
178227
178319
|
*/
|
|
178228
178320
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;
|
|
178229
178321
|
/**
|
|
178230
|
-
|
|
178231
|
-
|
|
178232
|
-
|
|
178322
|
+
* 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.)
|
|
178323
|
+
* Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
178324
|
+
*/
|
|
178233
178325
|
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;
|
|
178234
178326
|
}
|
|
178235
178327
|
/**
|
|
@@ -178278,6 +178370,17 @@ declare namespace PowerPoint {
|
|
|
178278
178370
|
* @param id ID of the object to be retrieved.
|
|
178279
178371
|
*/
|
|
178280
178372
|
getItem(id: string): PowerPoint.CustomXmlPart;
|
|
178373
|
+
/**
|
|
178374
|
+
* Gets a `CustomXmlPart` by its zero-based index in the collection.
|
|
178375
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
178376
|
+
*
|
|
178377
|
+
* @remarks
|
|
178378
|
+
* [Api set: PowerPointApi 1.10]
|
|
178379
|
+
*
|
|
178380
|
+
* @param index The index of the custom XML part in the collection.
|
|
178381
|
+
* @returns The custom XML part at the given index.
|
|
178382
|
+
*/
|
|
178383
|
+
getItemAt(index: number): PowerPoint.CustomXmlPart;
|
|
178281
178384
|
/**
|
|
178282
178385
|
* Gets a `CustomXmlPart` based on its ID.
|
|
178283
178386
|
If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
@@ -178308,11 +178411,87 @@ declare namespace PowerPoint {
|
|
|
178308
178411
|
*/
|
|
178309
178412
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection;
|
|
178310
178413
|
/**
|
|
178311
|
-
|
|
178312
|
-
|
|
178313
|
-
|
|
178414
|
+
* 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.)
|
|
178415
|
+
* Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
178416
|
+
*/
|
|
178314
178417
|
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
|
|
178315
178418
|
}
|
|
178419
|
+
/**
|
|
178420
|
+
* Represents the available options when adding a {@link PowerPoint.Hyperlink}.
|
|
178421
|
+
*
|
|
178422
|
+
* @remarks
|
|
178423
|
+
* [Api set: PowerPointApi 1.10]
|
|
178424
|
+
*/
|
|
178425
|
+
interface HyperlinkAddOptions {
|
|
178426
|
+
/**
|
|
178427
|
+
* Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
|
|
178428
|
+
*
|
|
178429
|
+
* @remarks
|
|
178430
|
+
* [Api set: PowerPointApi 1.10]
|
|
178431
|
+
*/
|
|
178432
|
+
address?: string;
|
|
178433
|
+
/**
|
|
178434
|
+
* Specifies the string displayed when hovering over the hyperlink.
|
|
178435
|
+
*
|
|
178436
|
+
* @remarks
|
|
178437
|
+
* [Api set: PowerPointApi 1.10]
|
|
178438
|
+
*/
|
|
178439
|
+
screenTip?: string;
|
|
178440
|
+
}
|
|
178441
|
+
/**
|
|
178442
|
+
* Represents a scoped collection of hyperlinks.
|
|
178443
|
+
*
|
|
178444
|
+
* @remarks
|
|
178445
|
+
* [Api set: PowerPointApi 1.10]
|
|
178446
|
+
*/
|
|
178447
|
+
class HyperlinkScopedCollection extends OfficeExtension.ClientObject {
|
|
178448
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
178449
|
+
context: RequestContext;
|
|
178450
|
+
/** Gets the loaded child items in this collection. */
|
|
178451
|
+
readonly items: PowerPoint.Hyperlink[];
|
|
178452
|
+
/**
|
|
178453
|
+
* Gets the number of hyperlinks in the collection.
|
|
178454
|
+
*
|
|
178455
|
+
* @remarks
|
|
178456
|
+
* [Api set: PowerPointApi 1.10]
|
|
178457
|
+
* @returns The number of hyperlinks in the collection.
|
|
178458
|
+
*/
|
|
178459
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
178460
|
+
/**
|
|
178461
|
+
* Gets a hyperlink using its zero-based index in the collection.
|
|
178462
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
178463
|
+
*
|
|
178464
|
+
* @remarks
|
|
178465
|
+
* [Api set: PowerPointApi 1.10]
|
|
178466
|
+
*
|
|
178467
|
+
* @param index The index of the hyperlink in the collection.
|
|
178468
|
+
* @returns The hyperlink at the given index.
|
|
178469
|
+
*/
|
|
178470
|
+
getItemAt(index: number): PowerPoint.Hyperlink;
|
|
178471
|
+
/**
|
|
178472
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178473
|
+
*
|
|
178474
|
+
* @param options Provides options for which properties of the object to load.
|
|
178475
|
+
*/
|
|
178476
|
+
load(options?: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkScopedCollection;
|
|
178477
|
+
/**
|
|
178478
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178479
|
+
*
|
|
178480
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
178481
|
+
*/
|
|
178482
|
+
load(propertyNames?: string | string[]): PowerPoint.HyperlinkScopedCollection;
|
|
178483
|
+
/**
|
|
178484
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178485
|
+
*
|
|
178486
|
+
* @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.
|
|
178487
|
+
*/
|
|
178488
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection;
|
|
178489
|
+
/**
|
|
178490
|
+
* 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.)
|
|
178491
|
+
* Whereas the original `PowerPoint.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
178492
|
+
*/
|
|
178493
|
+
toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;
|
|
178494
|
+
}
|
|
178316
178495
|
/**
|
|
178317
178496
|
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
178318
178497
|
*
|
|
@@ -178363,6 +178542,298 @@ declare namespace PowerPoint {
|
|
|
178363
178542
|
*/
|
|
178364
178543
|
thaiDistributed = "ThaiDistributed",
|
|
178365
178544
|
}
|
|
178545
|
+
/**
|
|
178546
|
+
* Specifies the style of a bullet.
|
|
178547
|
+
*
|
|
178548
|
+
* @remarks
|
|
178549
|
+
* [Api set: PowerPointApi 1.10]
|
|
178550
|
+
*/
|
|
178551
|
+
enum BulletStyle {
|
|
178552
|
+
/**
|
|
178553
|
+
* Style is unsupported.
|
|
178554
|
+
* @remarks
|
|
178555
|
+
* [Api set: PowerPointApi 1.10]
|
|
178556
|
+
*/
|
|
178557
|
+
unsupported = "Unsupported",
|
|
178558
|
+
/**
|
|
178559
|
+
* Lowercase alphabetical characters with a period.
|
|
178560
|
+
* @remarks
|
|
178561
|
+
* [Api set: PowerPointApi 1.10]
|
|
178562
|
+
*/
|
|
178563
|
+
alphabetLowercasePeriod = "AlphabetLowercasePeriod",
|
|
178564
|
+
/**
|
|
178565
|
+
* Uppercase alphabetical characters with a period.
|
|
178566
|
+
* @remarks
|
|
178567
|
+
* [Api set: PowerPointApi 1.10]
|
|
178568
|
+
*/
|
|
178569
|
+
alphabetUppercasePeriod = "AlphabetUppercasePeriod",
|
|
178570
|
+
/**
|
|
178571
|
+
* Arabic numerals with closing parenthesis.
|
|
178572
|
+
* @remarks
|
|
178573
|
+
* [Api set: PowerPointApi 1.10]
|
|
178574
|
+
*/
|
|
178575
|
+
arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
|
|
178576
|
+
/**
|
|
178577
|
+
* Arabic numerals with a period.
|
|
178578
|
+
* @remarks
|
|
178579
|
+
* [Api set: PowerPointApi 1.10]
|
|
178580
|
+
*/
|
|
178581
|
+
arabicNumeralPeriod = "ArabicNumeralPeriod",
|
|
178582
|
+
/**
|
|
178583
|
+
* Lowercase Roman numerals with both parentheses.
|
|
178584
|
+
* @remarks
|
|
178585
|
+
* [Api set: PowerPointApi 1.10]
|
|
178586
|
+
*/
|
|
178587
|
+
romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
|
|
178588
|
+
/**
|
|
178589
|
+
* Lowercase Roman numerals with closing parenthesis.
|
|
178590
|
+
* @remarks
|
|
178591
|
+
* [Api set: PowerPointApi 1.10]
|
|
178592
|
+
*/
|
|
178593
|
+
romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
|
|
178594
|
+
/**
|
|
178595
|
+
* Lowercase Roman numerals with period.
|
|
178596
|
+
* @remarks
|
|
178597
|
+
* [Api set: PowerPointApi 1.10]
|
|
178598
|
+
*/
|
|
178599
|
+
romanLowercasePeriod = "RomanLowercasePeriod",
|
|
178600
|
+
/**
|
|
178601
|
+
* Uppercase Roman numerals with period.
|
|
178602
|
+
* @remarks
|
|
178603
|
+
* [Api set: PowerPointApi 1.10]
|
|
178604
|
+
*/
|
|
178605
|
+
romanUppercasePeriod = "RomanUppercasePeriod",
|
|
178606
|
+
/**
|
|
178607
|
+
* Lowercase alphabetical characters with both parentheses.
|
|
178608
|
+
* @remarks
|
|
178609
|
+
* [Api set: PowerPointApi 1.10]
|
|
178610
|
+
*/
|
|
178611
|
+
alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
|
|
178612
|
+
/**
|
|
178613
|
+
* Lowercase alphabetical characters with closing parenthesis.
|
|
178614
|
+
* @remarks
|
|
178615
|
+
* [Api set: PowerPointApi 1.10]
|
|
178616
|
+
*/
|
|
178617
|
+
alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
|
|
178618
|
+
/**
|
|
178619
|
+
* Uppercase alphabetical characters with both parentheses.
|
|
178620
|
+
* @remarks
|
|
178621
|
+
* [Api set: PowerPointApi 1.10]
|
|
178622
|
+
*/
|
|
178623
|
+
alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
|
|
178624
|
+
/**
|
|
178625
|
+
* Uppercase alphabetical characters with closing parenthesis.
|
|
178626
|
+
* @remarks
|
|
178627
|
+
* [Api set: PowerPointApi 1.10]
|
|
178628
|
+
*/
|
|
178629
|
+
alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
|
|
178630
|
+
/**
|
|
178631
|
+
* Arabic numerals with both parentheses.
|
|
178632
|
+
* @remarks
|
|
178633
|
+
* [Api set: PowerPointApi 1.10]
|
|
178634
|
+
*/
|
|
178635
|
+
arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
|
|
178636
|
+
/**
|
|
178637
|
+
* Arabic numerals.
|
|
178638
|
+
* @remarks
|
|
178639
|
+
* [Api set: PowerPointApi 1.10]
|
|
178640
|
+
*/
|
|
178641
|
+
arabicNumeralPlain = "ArabicNumeralPlain",
|
|
178642
|
+
/**
|
|
178643
|
+
* Uppercase Roman numerals with both parentheses.
|
|
178644
|
+
* @remarks
|
|
178645
|
+
* [Api set: PowerPointApi 1.10]
|
|
178646
|
+
*/
|
|
178647
|
+
romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
|
|
178648
|
+
/**
|
|
178649
|
+
* Uppercase Roman numerals with closing parenthesis.
|
|
178650
|
+
* @remarks
|
|
178651
|
+
* [Api set: PowerPointApi 1.10]
|
|
178652
|
+
*/
|
|
178653
|
+
romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
|
|
178654
|
+
/**
|
|
178655
|
+
* Simplified Chinese without a period.
|
|
178656
|
+
* @remarks
|
|
178657
|
+
* [Api set: PowerPointApi 1.10]
|
|
178658
|
+
*/
|
|
178659
|
+
simplifiedChinesePlain = "SimplifiedChinesePlain",
|
|
178660
|
+
/**
|
|
178661
|
+
* Simplified Chinese with a period.
|
|
178662
|
+
* @remarks
|
|
178663
|
+
* [Api set: PowerPointApi 1.10]
|
|
178664
|
+
*/
|
|
178665
|
+
simplifiedChinesePeriod = "SimplifiedChinesePeriod",
|
|
178666
|
+
/**
|
|
178667
|
+
* Double-byte circled number for values up to 10.
|
|
178668
|
+
* @remarks
|
|
178669
|
+
* [Api set: PowerPointApi 1.10]
|
|
178670
|
+
*/
|
|
178671
|
+
circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
|
|
178672
|
+
/**
|
|
178673
|
+
* Text colored number with same color circle drawn around it.
|
|
178674
|
+
* @remarks
|
|
178675
|
+
* [Api set: PowerPointApi 1.10]
|
|
178676
|
+
*/
|
|
178677
|
+
circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
|
|
178678
|
+
/**
|
|
178679
|
+
* Shadow color number with circular background of normal text color.
|
|
178680
|
+
* @remarks
|
|
178681
|
+
* [Api set: PowerPointApi 1.10]
|
|
178682
|
+
*/
|
|
178683
|
+
circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
|
|
178684
|
+
/**
|
|
178685
|
+
* Traditional Chinese without a period.
|
|
178686
|
+
* @remarks
|
|
178687
|
+
* [Api set: PowerPointApi 1.10]
|
|
178688
|
+
*/
|
|
178689
|
+
traditionalChinesePlain = "TraditionalChinesePlain",
|
|
178690
|
+
/**
|
|
178691
|
+
* Traditional Chinese with a period.
|
|
178692
|
+
* @remarks
|
|
178693
|
+
* [Api set: PowerPointApi 1.10]
|
|
178694
|
+
*/
|
|
178695
|
+
traditionalChinesePeriod = "TraditionalChinesePeriod",
|
|
178696
|
+
/**
|
|
178697
|
+
* Arabic alphabet with a dash.
|
|
178698
|
+
* @remarks
|
|
178699
|
+
* [Api set: PowerPointApi 1.10]
|
|
178700
|
+
*/
|
|
178701
|
+
arabicAlphabetDash = "ArabicAlphabetDash",
|
|
178702
|
+
/**
|
|
178703
|
+
* Arabic Abjad alphabet with a dash.
|
|
178704
|
+
* @remarks
|
|
178705
|
+
* [Api set: PowerPointApi 1.10]
|
|
178706
|
+
*/
|
|
178707
|
+
arabicAbjadDash = "ArabicAbjadDash",
|
|
178708
|
+
/**
|
|
178709
|
+
* Hebrew alphabet with a dash.
|
|
178710
|
+
* @remarks
|
|
178711
|
+
* [Api set: PowerPointApi 1.10]
|
|
178712
|
+
*/
|
|
178713
|
+
hebrewAlphabetDash = "HebrewAlphabetDash",
|
|
178714
|
+
/**
|
|
178715
|
+
* Japanese/Korean numbers without a period.
|
|
178716
|
+
* @remarks
|
|
178717
|
+
* [Api set: PowerPointApi 1.10]
|
|
178718
|
+
*/
|
|
178719
|
+
kanjiKoreanPlain = "KanjiKoreanPlain",
|
|
178720
|
+
/**
|
|
178721
|
+
* Japanese/Korean numbers with a period.
|
|
178722
|
+
* @remarks
|
|
178723
|
+
* [Api set: PowerPointApi 1.10]
|
|
178724
|
+
*/
|
|
178725
|
+
kanjiKoreanPeriod = "KanjiKoreanPeriod",
|
|
178726
|
+
/**
|
|
178727
|
+
* Double-byte Arabic numbering scheme (no punctuation).
|
|
178728
|
+
* @remarks
|
|
178729
|
+
* [Api set: PowerPointApi 1.10]
|
|
178730
|
+
*/
|
|
178731
|
+
arabicDoubleBytePlain = "ArabicDoubleBytePlain",
|
|
178732
|
+
/**
|
|
178733
|
+
* Double-byte Arabic numbering scheme with double-byte period.
|
|
178734
|
+
* @remarks
|
|
178735
|
+
* [Api set: PowerPointApi 1.10]
|
|
178736
|
+
*/
|
|
178737
|
+
arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
|
|
178738
|
+
/**
|
|
178739
|
+
* Thai alphabet with a period.
|
|
178740
|
+
* @remarks
|
|
178741
|
+
* [Api set: PowerPointApi 1.10]
|
|
178742
|
+
*/
|
|
178743
|
+
thaiAlphabetPeriod = "ThaiAlphabetPeriod",
|
|
178744
|
+
/**
|
|
178745
|
+
* Thai alphabet with closing parenthesis.
|
|
178746
|
+
* @remarks
|
|
178747
|
+
* [Api set: PowerPointApi 1.10]
|
|
178748
|
+
*/
|
|
178749
|
+
thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
|
|
178750
|
+
/**
|
|
178751
|
+
* Thai alphabet with both parentheses.
|
|
178752
|
+
* @remarks
|
|
178753
|
+
* [Api set: PowerPointApi 1.10]
|
|
178754
|
+
*/
|
|
178755
|
+
thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
|
|
178756
|
+
/**
|
|
178757
|
+
* Thai numerals with a period.
|
|
178758
|
+
* @remarks
|
|
178759
|
+
* [Api set: PowerPointApi 1.10]
|
|
178760
|
+
*/
|
|
178761
|
+
thaiNumeralPeriod = "ThaiNumeralPeriod",
|
|
178762
|
+
/**
|
|
178763
|
+
* Thai numerals with closing parenthesis.
|
|
178764
|
+
* @remarks
|
|
178765
|
+
* [Api set: PowerPointApi 1.10]
|
|
178766
|
+
*/
|
|
178767
|
+
thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
|
|
178768
|
+
/**
|
|
178769
|
+
* Thai numerals with both parentheses.
|
|
178770
|
+
* @remarks
|
|
178771
|
+
* [Api set: PowerPointApi 1.10]
|
|
178772
|
+
*/
|
|
178773
|
+
thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
|
|
178774
|
+
/**
|
|
178775
|
+
* Hindi alphabet (vowels) with a period.
|
|
178776
|
+
* @remarks
|
|
178777
|
+
* [Api set: PowerPointApi 1.10]
|
|
178778
|
+
*/
|
|
178779
|
+
hindiAlphabetPeriod = "HindiAlphabetPeriod",
|
|
178780
|
+
/**
|
|
178781
|
+
* Hindi numerals with a period.
|
|
178782
|
+
* @remarks
|
|
178783
|
+
* [Api set: PowerPointApi 1.10]
|
|
178784
|
+
*/
|
|
178785
|
+
hindiNumeralPeriod = "HindiNumeralPeriod",
|
|
178786
|
+
/**
|
|
178787
|
+
* Kanji Simplified Chinese with double-byte period.
|
|
178788
|
+
* @remarks
|
|
178789
|
+
* [Api set: PowerPointApi 1.10]
|
|
178790
|
+
*/
|
|
178791
|
+
kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
|
|
178792
|
+
/**
|
|
178793
|
+
* Hindi numerals with closing parenthesis.
|
|
178794
|
+
* @remarks
|
|
178795
|
+
* [Api set: PowerPointApi 1.10]
|
|
178796
|
+
*/
|
|
178797
|
+
hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
|
|
178798
|
+
/**
|
|
178799
|
+
* Hindi alphabet (consonants) with a period.
|
|
178800
|
+
* @remarks
|
|
178801
|
+
* [Api set: PowerPointApi 1.10]
|
|
178802
|
+
*/
|
|
178803
|
+
hindiAlphabet1Period = "HindiAlphabet1Period",
|
|
178804
|
+
}
|
|
178805
|
+
/**
|
|
178806
|
+
* Specifies the type of a bullet.
|
|
178807
|
+
*
|
|
178808
|
+
* @remarks
|
|
178809
|
+
* [Api set: PowerPointApi 1.10]
|
|
178810
|
+
*/
|
|
178811
|
+
enum BulletType {
|
|
178812
|
+
/**
|
|
178813
|
+
* Type is unsupported.
|
|
178814
|
+
* @remarks
|
|
178815
|
+
* [Api set: PowerPointApi 1.10]
|
|
178816
|
+
*/
|
|
178817
|
+
unsupported = "Unsupported",
|
|
178818
|
+
/**
|
|
178819
|
+
* No bullets.
|
|
178820
|
+
* @remarks
|
|
178821
|
+
* [Api set: PowerPointApi 1.10]
|
|
178822
|
+
*/
|
|
178823
|
+
none = "None",
|
|
178824
|
+
/**
|
|
178825
|
+
* Numbered bullet (e.g., 1, 2, 3 or a, b, c).
|
|
178826
|
+
* @remarks
|
|
178827
|
+
* [Api set: PowerPointApi 1.10]
|
|
178828
|
+
*/
|
|
178829
|
+
numbered = "Numbered",
|
|
178830
|
+
/**
|
|
178831
|
+
* Symbol-based bullet (e.g., disc, circle, square).
|
|
178832
|
+
* @remarks
|
|
178833
|
+
* [Api set: PowerPointApi 1.10]
|
|
178834
|
+
*/
|
|
178835
|
+
unnumbered = "Unnumbered",
|
|
178836
|
+
}
|
|
178366
178837
|
/**
|
|
178367
178838
|
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
178368
178839
|
*
|
|
@@ -178372,6 +178843,22 @@ declare namespace PowerPoint {
|
|
|
178372
178843
|
class BulletFormat extends OfficeExtension.ClientObject {
|
|
178373
178844
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
178374
178845
|
context: RequestContext;
|
|
178846
|
+
/**
|
|
178847
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
178848
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
178849
|
+
*
|
|
178850
|
+
* @remarks
|
|
178851
|
+
* [Api set: PowerPointApi 1.10]
|
|
178852
|
+
*/
|
|
178853
|
+
style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
178854
|
+
/**
|
|
178855
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
178856
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
178857
|
+
*
|
|
178858
|
+
* @remarks
|
|
178859
|
+
* [Api set: PowerPointApi 1.10]
|
|
178860
|
+
*/
|
|
178861
|
+
type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
178375
178862
|
/**
|
|
178376
178863
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
178377
178864
|
*
|
|
@@ -178401,9 +178888,9 @@ declare namespace PowerPoint {
|
|
|
178401
178888
|
expand?: string;
|
|
178402
178889
|
}): PowerPoint.BulletFormat;
|
|
178403
178890
|
/**
|
|
178404
|
-
|
|
178405
|
-
|
|
178406
|
-
|
|
178891
|
+
* 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.)
|
|
178892
|
+
* Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178893
|
+
*/
|
|
178407
178894
|
toJSON(): PowerPoint.Interfaces.BulletFormatData;
|
|
178408
178895
|
}
|
|
178409
178896
|
/**
|
|
@@ -178429,6 +178916,13 @@ declare namespace PowerPoint {
|
|
|
178429
178916
|
* [Api set: PowerPointApi 1.4]
|
|
178430
178917
|
*/
|
|
178431
178918
|
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
178919
|
+
/**
|
|
178920
|
+
* Represents the indent level of the paragraph.
|
|
178921
|
+
*
|
|
178922
|
+
* @remarks
|
|
178923
|
+
* [Api set: PowerPointApi 1.10]
|
|
178924
|
+
*/
|
|
178925
|
+
indentLevel: number;
|
|
178432
178926
|
/**
|
|
178433
178927
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178434
178928
|
*
|
|
@@ -178451,9 +178945,9 @@ declare namespace PowerPoint {
|
|
|
178451
178945
|
expand?: string;
|
|
178452
178946
|
}): PowerPoint.ParagraphFormat;
|
|
178453
178947
|
/**
|
|
178454
|
-
|
|
178455
|
-
|
|
178456
|
-
|
|
178948
|
+
* 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.)
|
|
178949
|
+
* Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178950
|
+
*/
|
|
178457
178951
|
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
|
|
178458
178952
|
}
|
|
178459
178953
|
/**
|
|
@@ -178729,9 +179223,9 @@ declare namespace PowerPoint {
|
|
|
178729
179223
|
expand?: string;
|
|
178730
179224
|
}): PowerPoint.ShapeFont;
|
|
178731
179225
|
/**
|
|
178732
|
-
|
|
178733
|
-
|
|
178734
|
-
|
|
179226
|
+
* 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.)
|
|
179227
|
+
* Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
|
|
179228
|
+
*/
|
|
178735
179229
|
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
178736
179230
|
}
|
|
178737
179231
|
/**
|
|
@@ -178920,9 +179414,9 @@ declare namespace PowerPoint {
|
|
|
178920
179414
|
expand?: string;
|
|
178921
179415
|
}): PowerPoint.TextFrame;
|
|
178922
179416
|
/**
|
|
178923
|
-
|
|
178924
|
-
|
|
178925
|
-
|
|
179417
|
+
* 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.)
|
|
179418
|
+
* Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object.
|
|
179419
|
+
*/
|
|
178926
179420
|
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
178927
179421
|
}
|
|
178928
179422
|
/**
|
|
@@ -178941,6 +179435,13 @@ declare namespace PowerPoint {
|
|
|
178941
179435
|
* [Api set: PowerPointApi 1.4]
|
|
178942
179436
|
*/
|
|
178943
179437
|
readonly font: PowerPoint.ShapeFont;
|
|
179438
|
+
/**
|
|
179439
|
+
* Returns a collection of hyperlinks that exist on this `TextRange`.
|
|
179440
|
+
*
|
|
179441
|
+
* @remarks
|
|
179442
|
+
* [Api set: PowerPointApi 1.10]
|
|
179443
|
+
*/
|
|
179444
|
+
readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;
|
|
178944
179445
|
/**
|
|
178945
179446
|
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
|
|
178946
179447
|
*
|
|
@@ -178988,6 +179489,16 @@ declare namespace PowerPoint {
|
|
|
178988
179489
|
* @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned.
|
|
178989
179490
|
*/
|
|
178990
179491
|
getSubstring(start: number, length?: number): PowerPoint.TextRange;
|
|
179492
|
+
/**
|
|
179493
|
+
* Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`.
|
|
179494
|
+
*
|
|
179495
|
+
* @remarks
|
|
179496
|
+
* [Api set: PowerPointApi 1.10]
|
|
179497
|
+
*
|
|
179498
|
+
* @param options Optional. The options for the hyperlink.
|
|
179499
|
+
* @returns The newly created {@link PowerPoint.Hyperlink} object.
|
|
179500
|
+
*/
|
|
179501
|
+
setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
|
|
178991
179502
|
/**
|
|
178992
179503
|
* Selects this `TextRange` in the current view.
|
|
178993
179504
|
*
|
|
@@ -179017,11 +179528,31 @@ declare namespace PowerPoint {
|
|
|
179017
179528
|
expand?: string;
|
|
179018
179529
|
}): PowerPoint.TextRange;
|
|
179019
179530
|
/**
|
|
179020
|
-
|
|
179021
|
-
|
|
179022
|
-
|
|
179531
|
+
* 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.)
|
|
179532
|
+
* Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
179533
|
+
*/
|
|
179023
179534
|
toJSON(): PowerPoint.Interfaces.TextRangeData;
|
|
179024
179535
|
}
|
|
179536
|
+
/**
|
|
179537
|
+
* Specifies the type of object that a hyperlink is applied to.
|
|
179538
|
+
*
|
|
179539
|
+
* @remarks
|
|
179540
|
+
* [Api set: PowerPointApi 1.10]
|
|
179541
|
+
*/
|
|
179542
|
+
enum HyperlinkType {
|
|
179543
|
+
/**
|
|
179544
|
+
* Specifies that the hyperlink is applied to a TextRange.
|
|
179545
|
+
* @remarks
|
|
179546
|
+
* [Api set: PowerPointApi 1.10]
|
|
179547
|
+
*/
|
|
179548
|
+
textRange = "TextRange",
|
|
179549
|
+
/**
|
|
179550
|
+
* Specifies that the hyperlink is applied to a Shape.
|
|
179551
|
+
* @remarks
|
|
179552
|
+
* [Api set: PowerPointApi 1.10]
|
|
179553
|
+
*/
|
|
179554
|
+
shape = "Shape",
|
|
179555
|
+
}
|
|
179025
179556
|
/**
|
|
179026
179557
|
* Represents a single hyperlink.
|
|
179027
179558
|
*
|
|
@@ -179045,6 +179576,38 @@ declare namespace PowerPoint {
|
|
|
179045
179576
|
* [Api set: PowerPointApi 1.6]
|
|
179046
179577
|
*/
|
|
179047
179578
|
screenTip: string;
|
|
179579
|
+
/**
|
|
179580
|
+
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
|
|
179581
|
+
*
|
|
179582
|
+
* @remarks
|
|
179583
|
+
* [Api set: PowerPointApi 1.10]
|
|
179584
|
+
*/
|
|
179585
|
+
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
|
|
179586
|
+
/**
|
|
179587
|
+
* Deletes the hyperlink.
|
|
179588
|
+
*
|
|
179589
|
+
* @remarks
|
|
179590
|
+
* [Api set: PowerPointApi 1.10]
|
|
179591
|
+
*/
|
|
179592
|
+
delete(): void;
|
|
179593
|
+
/**
|
|
179594
|
+
* Returns the {@link PowerPoint.Shape} object that the hyperlink is applied to.
|
|
179595
|
+
If the hyperlink is not of type `shape`, or it is within a domain that does not currently support a {@link PowerPoint.Shape}, then this method returns an object with its `isNullObject` property set to `true`.
|
|
179596
|
+
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}.
|
|
179597
|
+
*
|
|
179598
|
+
* @remarks
|
|
179599
|
+
* [Api set: PowerPointApi 1.10]
|
|
179600
|
+
*/
|
|
179601
|
+
getLinkedShapeOrNullObject(): PowerPoint.Shape;
|
|
179602
|
+
/**
|
|
179603
|
+
* Returns the {@link PowerPoint.TextRange} object that the hyperlink is applied to.
|
|
179604
|
+
If the hyperlink is not of type `textRange`, or it is within a domain that does not currently support a {@link PowerPoint.TextRange}, then this method returns an object with its `isNullObject` property set to `true`.
|
|
179605
|
+
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}.
|
|
179606
|
+
*
|
|
179607
|
+
* @remarks
|
|
179608
|
+
* [Api set: PowerPointApi 1.10]
|
|
179609
|
+
*/
|
|
179610
|
+
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
|
|
179048
179611
|
/**
|
|
179049
179612
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
179050
179613
|
*
|
|
@@ -179067,9 +179630,9 @@ declare namespace PowerPoint {
|
|
|
179067
179630
|
expand?: string;
|
|
179068
179631
|
}): PowerPoint.Hyperlink;
|
|
179069
179632
|
/**
|
|
179070
|
-
|
|
179071
|
-
|
|
179072
|
-
|
|
179633
|
+
* 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.)
|
|
179634
|
+
* Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
|
|
179635
|
+
*/
|
|
179073
179636
|
toJSON(): PowerPoint.Interfaces.HyperlinkData;
|
|
179074
179637
|
}
|
|
179075
179638
|
/**
|
|
@@ -179384,6 +179947,18 @@ declare namespace PowerPoint {
|
|
|
179384
179947
|
context: RequestContext;
|
|
179385
179948
|
/** Gets the loaded child items in this collection. */
|
|
179386
179949
|
readonly items: PowerPoint.Hyperlink[];
|
|
179950
|
+
/**
|
|
179951
|
+
* Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted.
|
|
179952
|
+
The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
|
|
179953
|
+
*
|
|
179954
|
+
* @remarks
|
|
179955
|
+
* [Api set: PowerPointApi 1.10]
|
|
179956
|
+
*
|
|
179957
|
+
* @param target The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}.
|
|
179958
|
+
* @param options Optional. The options for the hyperlink.
|
|
179959
|
+
* @returns The newly created {@link PowerPoint.Hyperlink} object.
|
|
179960
|
+
*/
|
|
179961
|
+
add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
|
|
179387
179962
|
/**
|
|
179388
179963
|
* Gets the number of hyperlinks in the collection.
|
|
179389
179964
|
*
|
|
@@ -179422,9 +179997,9 @@ declare namespace PowerPoint {
|
|
|
179422
179997
|
*/
|
|
179423
179998
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
|
|
179424
179999
|
/**
|
|
179425
|
-
|
|
179426
|
-
|
|
179427
|
-
|
|
180000
|
+
* 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.)
|
|
180001
|
+
* Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
180002
|
+
*/
|
|
179428
180003
|
toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;
|
|
179429
180004
|
}
|
|
179430
180005
|
/**
|
|
@@ -180782,9 +181357,9 @@ declare namespace PowerPoint {
|
|
|
180782
181357
|
expand?: string;
|
|
180783
181358
|
}): PowerPoint.Borders;
|
|
180784
181359
|
/**
|
|
180785
|
-
|
|
180786
|
-
|
|
180787
|
-
|
|
181360
|
+
* 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.)
|
|
181361
|
+
* Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
|
|
181362
|
+
*/
|
|
180788
181363
|
toJSON(): PowerPoint.Interfaces.BordersData;
|
|
180789
181364
|
}
|
|
180790
181365
|
/**
|
|
@@ -180846,9 +181421,9 @@ declare namespace PowerPoint {
|
|
|
180846
181421
|
expand?: string;
|
|
180847
181422
|
}): PowerPoint.Margins;
|
|
180848
181423
|
/**
|
|
180849
|
-
|
|
180850
|
-
|
|
180851
|
-
|
|
181424
|
+
* 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.)
|
|
181425
|
+
* Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
181426
|
+
*/
|
|
180852
181427
|
toJSON(): PowerPoint.Interfaces.MarginsData;
|
|
180853
181428
|
}
|
|
180854
181429
|
/**
|
|
@@ -181239,9 +181814,9 @@ declare namespace PowerPoint {
|
|
|
181239
181814
|
expand?: string;
|
|
181240
181815
|
}): PowerPoint.TableCell;
|
|
181241
181816
|
/**
|
|
181242
|
-
|
|
181243
|
-
|
|
181244
|
-
|
|
181817
|
+
* 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.)
|
|
181818
|
+
* 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.
|
|
181819
|
+
*/
|
|
181245
181820
|
toJSON(): PowerPoint.Interfaces.TableCellData;
|
|
181246
181821
|
}
|
|
181247
181822
|
/**
|
|
@@ -181293,9 +181868,9 @@ declare namespace PowerPoint {
|
|
|
181293
181868
|
*/
|
|
181294
181869
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection;
|
|
181295
181870
|
/**
|
|
181296
|
-
|
|
181297
|
-
|
|
181298
|
-
|
|
181871
|
+
* 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.)
|
|
181872
|
+
* 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.
|
|
181873
|
+
*/
|
|
181299
181874
|
toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
|
|
181300
181875
|
}
|
|
181301
181876
|
/**
|
|
@@ -181350,9 +181925,9 @@ declare namespace PowerPoint {
|
|
|
181350
181925
|
expand?: string;
|
|
181351
181926
|
}): PowerPoint.TableColumn;
|
|
181352
181927
|
/**
|
|
181353
|
-
|
|
181354
|
-
|
|
181355
|
-
|
|
181928
|
+
* 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.)
|
|
181929
|
+
* Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
|
|
181930
|
+
*/
|
|
181356
181931
|
toJSON(): PowerPoint.Interfaces.TableColumnData;
|
|
181357
181932
|
}
|
|
181358
181933
|
/**
|
|
@@ -181423,9 +181998,9 @@ declare namespace PowerPoint {
|
|
|
181423
181998
|
*/
|
|
181424
181999
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
|
|
181425
182000
|
/**
|
|
181426
|
-
|
|
181427
|
-
|
|
181428
|
-
|
|
182001
|
+
* 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.)
|
|
182002
|
+
* Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
182003
|
+
*/
|
|
181429
182004
|
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
|
|
181430
182005
|
}
|
|
181431
182006
|
/**
|
|
@@ -181516,9 +182091,9 @@ declare namespace PowerPoint {
|
|
|
181516
182091
|
expand?: string;
|
|
181517
182092
|
}): PowerPoint.TableRow;
|
|
181518
182093
|
/**
|
|
181519
|
-
|
|
181520
|
-
|
|
181521
|
-
|
|
182094
|
+
* 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.)
|
|
182095
|
+
* Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
|
|
182096
|
+
*/
|
|
181522
182097
|
toJSON(): PowerPoint.Interfaces.TableRowData;
|
|
181523
182098
|
}
|
|
181524
182099
|
/**
|
|
@@ -181589,9 +182164,9 @@ declare namespace PowerPoint {
|
|
|
181589
182164
|
*/
|
|
181590
182165
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
|
|
181591
182166
|
/**
|
|
181592
|
-
|
|
181593
|
-
|
|
181594
|
-
|
|
182167
|
+
* 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.)
|
|
182168
|
+
* Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
182169
|
+
*/
|
|
181595
182170
|
toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
|
|
181596
182171
|
}
|
|
181597
182172
|
/**
|
|
@@ -182126,9 +182701,9 @@ declare namespace PowerPoint {
|
|
|
182126
182701
|
expand?: string;
|
|
182127
182702
|
}): PowerPoint.TableStyleSettings;
|
|
182128
182703
|
/**
|
|
182129
|
-
|
|
182130
|
-
|
|
182131
|
-
|
|
182704
|
+
* 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.)
|
|
182705
|
+
* Whereas the original `PowerPoint.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
182706
|
+
*/
|
|
182132
182707
|
toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
|
|
182133
182708
|
}
|
|
182134
182709
|
/**
|
|
@@ -182251,9 +182826,9 @@ declare namespace PowerPoint {
|
|
|
182251
182826
|
expand?: string;
|
|
182252
182827
|
}): PowerPoint.Table;
|
|
182253
182828
|
/**
|
|
182254
|
-
|
|
182255
|
-
|
|
182256
|
-
|
|
182829
|
+
* 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.)
|
|
182830
|
+
* 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.
|
|
182831
|
+
*/
|
|
182257
182832
|
toJSON(): PowerPoint.Interfaces.TableData;
|
|
182258
182833
|
}
|
|
182259
182834
|
/**
|
|
@@ -182818,11 +183393,896 @@ declare namespace PowerPoint {
|
|
|
182818
183393
|
*/
|
|
182819
183394
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
|
|
182820
183395
|
/**
|
|
182821
|
-
|
|
182822
|
-
|
|
182823
|
-
|
|
183396
|
+
* 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.)
|
|
183397
|
+
* Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
183398
|
+
*/
|
|
182824
183399
|
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
182825
183400
|
}
|
|
183401
|
+
/**
|
|
183402
|
+
* Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
|
|
183403
|
+
*
|
|
183404
|
+
* @remarks
|
|
183405
|
+
* [Api set: PowerPointApi 1.10]
|
|
183406
|
+
*/
|
|
183407
|
+
enum SlideBackgroundGradientFillType {
|
|
183408
|
+
/**
|
|
183409
|
+
* Unsupported gradient fill.
|
|
183410
|
+
* @remarks
|
|
183411
|
+
* [Api set: PowerPointApi 1.10]
|
|
183412
|
+
*/
|
|
183413
|
+
unsupported = "Unsupported",
|
|
183414
|
+
/**
|
|
183415
|
+
* Linear gradient fill.
|
|
183416
|
+
* @remarks
|
|
183417
|
+
* [Api set: PowerPointApi 1.10]
|
|
183418
|
+
*/
|
|
183419
|
+
linear = "Linear",
|
|
183420
|
+
/**
|
|
183421
|
+
* Radial gradient fill.
|
|
183422
|
+
* @remarks
|
|
183423
|
+
* [Api set: PowerPointApi 1.10]
|
|
183424
|
+
*/
|
|
183425
|
+
radial = "Radial",
|
|
183426
|
+
/**
|
|
183427
|
+
* Rectangular gradient fill.
|
|
183428
|
+
* @remarks
|
|
183429
|
+
* [Api set: PowerPointApi 1.10]
|
|
183430
|
+
*/
|
|
183431
|
+
rectangular = "Rectangular",
|
|
183432
|
+
/**
|
|
183433
|
+
* Path gradient fill.
|
|
183434
|
+
* @remarks
|
|
183435
|
+
* [Api set: PowerPointApi 1.10]
|
|
183436
|
+
*/
|
|
183437
|
+
path = "Path",
|
|
183438
|
+
/**
|
|
183439
|
+
* Shade from title gradient fill.
|
|
183440
|
+
* @remarks
|
|
183441
|
+
* [Api set: PowerPointApi 1.10]
|
|
183442
|
+
*/
|
|
183443
|
+
shadeFromTitle = "ShadeFromTitle",
|
|
183444
|
+
}
|
|
183445
|
+
/**
|
|
183446
|
+
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
|
|
183447
|
+
*
|
|
183448
|
+
* @remarks
|
|
183449
|
+
* [Api set: PowerPointApi 1.10]
|
|
183450
|
+
*/
|
|
183451
|
+
class SlideBackgroundGradientFill extends OfficeExtension.ClientObject {
|
|
183452
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183453
|
+
context: RequestContext;
|
|
183454
|
+
/**
|
|
183455
|
+
* Specifies the type of gradient fill.
|
|
183456
|
+
*
|
|
183457
|
+
* @remarks
|
|
183458
|
+
* [Api set: PowerPointApi 1.10]
|
|
183459
|
+
*/
|
|
183460
|
+
type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
183461
|
+
/**
|
|
183462
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183463
|
+
*
|
|
183464
|
+
* @param options Provides options for which properties of the object to load.
|
|
183465
|
+
*/
|
|
183466
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions): PowerPoint.SlideBackgroundGradientFill;
|
|
183467
|
+
/**
|
|
183468
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183469
|
+
*
|
|
183470
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
183471
|
+
*/
|
|
183472
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundGradientFill;
|
|
183473
|
+
/**
|
|
183474
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183475
|
+
*
|
|
183476
|
+
* @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.
|
|
183477
|
+
*/
|
|
183478
|
+
load(propertyNamesAndPaths?: {
|
|
183479
|
+
select?: string;
|
|
183480
|
+
expand?: string;
|
|
183481
|
+
}): PowerPoint.SlideBackgroundGradientFill;
|
|
183482
|
+
/**
|
|
183483
|
+
* 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.)
|
|
183484
|
+
* Whereas the original `PowerPoint.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
183485
|
+
*/
|
|
183486
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
|
|
183487
|
+
}
|
|
183488
|
+
/**
|
|
183489
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
|
|
183490
|
+
*
|
|
183491
|
+
* @remarks
|
|
183492
|
+
* [Api set: PowerPointApi 1.10]
|
|
183493
|
+
*/
|
|
183494
|
+
interface SlideBackgroundGradientFillOptions {
|
|
183495
|
+
/**
|
|
183496
|
+
* If provided, specifies the type of gradient fill.
|
|
183497
|
+
*
|
|
183498
|
+
* @remarks
|
|
183499
|
+
* [Api set: PowerPointApi 1.10]
|
|
183500
|
+
*/
|
|
183501
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
183502
|
+
}
|
|
183503
|
+
/**
|
|
183504
|
+
* Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
|
|
183505
|
+
*
|
|
183506
|
+
* @remarks
|
|
183507
|
+
* [Api set: PowerPointApi 1.10]
|
|
183508
|
+
*/
|
|
183509
|
+
enum SlideBackgroundPatternFillType {
|
|
183510
|
+
/**
|
|
183511
|
+
* Unsupported pattern fill.
|
|
183512
|
+
* @remarks
|
|
183513
|
+
* [Api set: PowerPointApi 1.10]
|
|
183514
|
+
*/
|
|
183515
|
+
unsupported = "Unsupported",
|
|
183516
|
+
/**
|
|
183517
|
+
* 5 percent pattern fill.
|
|
183518
|
+
* @remarks
|
|
183519
|
+
* [Api set: PowerPointApi 1.10]
|
|
183520
|
+
*/
|
|
183521
|
+
percent5 = "Percent5",
|
|
183522
|
+
/**
|
|
183523
|
+
* 10 percent pattern fill.
|
|
183524
|
+
* @remarks
|
|
183525
|
+
* [Api set: PowerPointApi 1.10]
|
|
183526
|
+
*/
|
|
183527
|
+
percent10 = "Percent10",
|
|
183528
|
+
/**
|
|
183529
|
+
* 20 percent pattern fill.
|
|
183530
|
+
* @remarks
|
|
183531
|
+
* [Api set: PowerPointApi 1.10]
|
|
183532
|
+
*/
|
|
183533
|
+
percent20 = "Percent20",
|
|
183534
|
+
/**
|
|
183535
|
+
* 25 percent pattern fill.
|
|
183536
|
+
* @remarks
|
|
183537
|
+
* [Api set: PowerPointApi 1.10]
|
|
183538
|
+
*/
|
|
183539
|
+
percent25 = "Percent25",
|
|
183540
|
+
/**
|
|
183541
|
+
* 30 percent pattern fill.
|
|
183542
|
+
* @remarks
|
|
183543
|
+
* [Api set: PowerPointApi 1.10]
|
|
183544
|
+
*/
|
|
183545
|
+
percent30 = "Percent30",
|
|
183546
|
+
/**
|
|
183547
|
+
* 40 percent pattern fill.
|
|
183548
|
+
* @remarks
|
|
183549
|
+
* [Api set: PowerPointApi 1.10]
|
|
183550
|
+
*/
|
|
183551
|
+
percent40 = "Percent40",
|
|
183552
|
+
/**
|
|
183553
|
+
* 50 percent pattern fill.
|
|
183554
|
+
* @remarks
|
|
183555
|
+
* [Api set: PowerPointApi 1.10]
|
|
183556
|
+
*/
|
|
183557
|
+
percent50 = "Percent50",
|
|
183558
|
+
/**
|
|
183559
|
+
* 60 percent pattern fill.
|
|
183560
|
+
* @remarks
|
|
183561
|
+
* [Api set: PowerPointApi 1.10]
|
|
183562
|
+
*/
|
|
183563
|
+
percent60 = "Percent60",
|
|
183564
|
+
/**
|
|
183565
|
+
* 70 percent pattern fill.
|
|
183566
|
+
* @remarks
|
|
183567
|
+
* [Api set: PowerPointApi 1.10]
|
|
183568
|
+
*/
|
|
183569
|
+
percent70 = "Percent70",
|
|
183570
|
+
/**
|
|
183571
|
+
* 75 percent pattern fill.
|
|
183572
|
+
* @remarks
|
|
183573
|
+
* [Api set: PowerPointApi 1.10]
|
|
183574
|
+
*/
|
|
183575
|
+
percent75 = "Percent75",
|
|
183576
|
+
/**
|
|
183577
|
+
* 80 percent pattern fill.
|
|
183578
|
+
* @remarks
|
|
183579
|
+
* [Api set: PowerPointApi 1.10]
|
|
183580
|
+
*/
|
|
183581
|
+
percent80 = "Percent80",
|
|
183582
|
+
/**
|
|
183583
|
+
* 90 percent pattern fill.
|
|
183584
|
+
* @remarks
|
|
183585
|
+
* [Api set: PowerPointApi 1.10]
|
|
183586
|
+
*/
|
|
183587
|
+
percent90 = "Percent90",
|
|
183588
|
+
/**
|
|
183589
|
+
* Horizontal pattern fill.
|
|
183590
|
+
* @remarks
|
|
183591
|
+
* [Api set: PowerPointApi 1.10]
|
|
183592
|
+
*/
|
|
183593
|
+
horizontal = "Horizontal",
|
|
183594
|
+
/**
|
|
183595
|
+
* Vertical pattern fill.
|
|
183596
|
+
* @remarks
|
|
183597
|
+
* [Api set: PowerPointApi 1.10]
|
|
183598
|
+
*/
|
|
183599
|
+
vertical = "Vertical",
|
|
183600
|
+
/**
|
|
183601
|
+
* Light horizontal pattern fill.
|
|
183602
|
+
* @remarks
|
|
183603
|
+
* [Api set: PowerPointApi 1.10]
|
|
183604
|
+
*/
|
|
183605
|
+
lightHorizontal = "LightHorizontal",
|
|
183606
|
+
/**
|
|
183607
|
+
* Light vertical pattern fill.
|
|
183608
|
+
* @remarks
|
|
183609
|
+
* [Api set: PowerPointApi 1.10]
|
|
183610
|
+
*/
|
|
183611
|
+
lightVertical = "LightVertical",
|
|
183612
|
+
/**
|
|
183613
|
+
* Dark horizontal pattern fill.
|
|
183614
|
+
* @remarks
|
|
183615
|
+
* [Api set: PowerPointApi 1.10]
|
|
183616
|
+
*/
|
|
183617
|
+
darkHorizontal = "DarkHorizontal",
|
|
183618
|
+
/**
|
|
183619
|
+
* Dark vertical pattern fill.
|
|
183620
|
+
* @remarks
|
|
183621
|
+
* [Api set: PowerPointApi 1.10]
|
|
183622
|
+
*/
|
|
183623
|
+
darkVertical = "DarkVertical",
|
|
183624
|
+
/**
|
|
183625
|
+
* Narrow horizontal pattern fill.
|
|
183626
|
+
* @remarks
|
|
183627
|
+
* [Api set: PowerPointApi 1.10]
|
|
183628
|
+
*/
|
|
183629
|
+
narrowHorizontal = "NarrowHorizontal",
|
|
183630
|
+
/**
|
|
183631
|
+
* Narrow vertical pattern fill.
|
|
183632
|
+
* @remarks
|
|
183633
|
+
* [Api set: PowerPointApi 1.10]
|
|
183634
|
+
*/
|
|
183635
|
+
narrowVertical = "NarrowVertical",
|
|
183636
|
+
/**
|
|
183637
|
+
* Dashed horizontal pattern fill.
|
|
183638
|
+
* @remarks
|
|
183639
|
+
* [Api set: PowerPointApi 1.10]
|
|
183640
|
+
*/
|
|
183641
|
+
dashedHorizontal = "DashedHorizontal",
|
|
183642
|
+
/**
|
|
183643
|
+
* Dashed vertical pattern fill.
|
|
183644
|
+
* @remarks
|
|
183645
|
+
* [Api set: PowerPointApi 1.10]
|
|
183646
|
+
*/
|
|
183647
|
+
dashedVertical = "DashedVertical",
|
|
183648
|
+
/**
|
|
183649
|
+
* Cross pattern fill.
|
|
183650
|
+
* @remarks
|
|
183651
|
+
* [Api set: PowerPointApi 1.10]
|
|
183652
|
+
*/
|
|
183653
|
+
cross = "Cross",
|
|
183654
|
+
/**
|
|
183655
|
+
* Downward diagonal pattern fill.
|
|
183656
|
+
* @remarks
|
|
183657
|
+
* [Api set: PowerPointApi 1.10]
|
|
183658
|
+
*/
|
|
183659
|
+
downwardDiagonal = "DownwardDiagonal",
|
|
183660
|
+
/**
|
|
183661
|
+
* Upward diagonal pattern fill.
|
|
183662
|
+
* @remarks
|
|
183663
|
+
* [Api set: PowerPointApi 1.10]
|
|
183664
|
+
*/
|
|
183665
|
+
upwardDiagonal = "UpwardDiagonal",
|
|
183666
|
+
/**
|
|
183667
|
+
* Light downward diagonal pattern fill.
|
|
183668
|
+
* @remarks
|
|
183669
|
+
* [Api set: PowerPointApi 1.10]
|
|
183670
|
+
*/
|
|
183671
|
+
lightDownwardDiagonal = "LightDownwardDiagonal",
|
|
183672
|
+
/**
|
|
183673
|
+
* Light upward diagonal pattern fill.
|
|
183674
|
+
* @remarks
|
|
183675
|
+
* [Api set: PowerPointApi 1.10]
|
|
183676
|
+
*/
|
|
183677
|
+
lightUpwardDiagonal = "LightUpwardDiagonal",
|
|
183678
|
+
/**
|
|
183679
|
+
* Dark downward diagonal pattern fill.
|
|
183680
|
+
* @remarks
|
|
183681
|
+
* [Api set: PowerPointApi 1.10]
|
|
183682
|
+
*/
|
|
183683
|
+
darkDownwardDiagonal = "DarkDownwardDiagonal",
|
|
183684
|
+
/**
|
|
183685
|
+
* Dark upward diagonal pattern fill.
|
|
183686
|
+
* @remarks
|
|
183687
|
+
* [Api set: PowerPointApi 1.10]
|
|
183688
|
+
*/
|
|
183689
|
+
darkUpwardDiagonal = "DarkUpwardDiagonal",
|
|
183690
|
+
/**
|
|
183691
|
+
* Wide downward diagonal pattern fill.
|
|
183692
|
+
* @remarks
|
|
183693
|
+
* [Api set: PowerPointApi 1.10]
|
|
183694
|
+
*/
|
|
183695
|
+
wideDownwardDiagonal = "WideDownwardDiagonal",
|
|
183696
|
+
/**
|
|
183697
|
+
* Wide upward diagonal pattern fill.
|
|
183698
|
+
* @remarks
|
|
183699
|
+
* [Api set: PowerPointApi 1.10]
|
|
183700
|
+
*/
|
|
183701
|
+
wideUpwardDiagonal = "WideUpwardDiagonal",
|
|
183702
|
+
/**
|
|
183703
|
+
* Dashed downward diagonal pattern fill.
|
|
183704
|
+
* @remarks
|
|
183705
|
+
* [Api set: PowerPointApi 1.10]
|
|
183706
|
+
*/
|
|
183707
|
+
dashedDownwardDiagonal = "DashedDownwardDiagonal",
|
|
183708
|
+
/**
|
|
183709
|
+
* Dashed upward diagonal pattern fill.
|
|
183710
|
+
* @remarks
|
|
183711
|
+
* [Api set: PowerPointApi 1.10]
|
|
183712
|
+
*/
|
|
183713
|
+
dashedUpwardDiagonal = "DashedUpwardDiagonal",
|
|
183714
|
+
/**
|
|
183715
|
+
* Diagonal cross pattern fill.
|
|
183716
|
+
* @remarks
|
|
183717
|
+
* [Api set: PowerPointApi 1.10]
|
|
183718
|
+
*/
|
|
183719
|
+
diagonalCross = "DiagonalCross",
|
|
183720
|
+
/**
|
|
183721
|
+
* Small checker board pattern fill.
|
|
183722
|
+
* @remarks
|
|
183723
|
+
* [Api set: PowerPointApi 1.10]
|
|
183724
|
+
*/
|
|
183725
|
+
smallCheckerBoard = "SmallCheckerBoard",
|
|
183726
|
+
/**
|
|
183727
|
+
* Large checker board pattern fill.
|
|
183728
|
+
* @remarks
|
|
183729
|
+
* [Api set: PowerPointApi 1.10]
|
|
183730
|
+
*/
|
|
183731
|
+
largeCheckerBoard = "LargeCheckerBoard",
|
|
183732
|
+
/**
|
|
183733
|
+
* Small grid pattern fill.
|
|
183734
|
+
* @remarks
|
|
183735
|
+
* [Api set: PowerPointApi 1.10]
|
|
183736
|
+
*/
|
|
183737
|
+
smallGrid = "SmallGrid",
|
|
183738
|
+
/**
|
|
183739
|
+
* Large grid pattern fill.
|
|
183740
|
+
* @remarks
|
|
183741
|
+
* [Api set: PowerPointApi 1.10]
|
|
183742
|
+
*/
|
|
183743
|
+
largeGrid = "LargeGrid",
|
|
183744
|
+
/**
|
|
183745
|
+
* Dotted grid pattern fill.
|
|
183746
|
+
* @remarks
|
|
183747
|
+
* [Api set: PowerPointApi 1.10]
|
|
183748
|
+
*/
|
|
183749
|
+
dottedGrid = "DottedGrid",
|
|
183750
|
+
/**
|
|
183751
|
+
* Small confetti pattern fill.
|
|
183752
|
+
* @remarks
|
|
183753
|
+
* [Api set: PowerPointApi 1.10]
|
|
183754
|
+
*/
|
|
183755
|
+
smallConfetti = "SmallConfetti",
|
|
183756
|
+
/**
|
|
183757
|
+
* Large confetti pattern fill.
|
|
183758
|
+
* @remarks
|
|
183759
|
+
* [Api set: PowerPointApi 1.10]
|
|
183760
|
+
*/
|
|
183761
|
+
largeConfetti = "LargeConfetti",
|
|
183762
|
+
/**
|
|
183763
|
+
* Horizontal brick pattern fill.
|
|
183764
|
+
* @remarks
|
|
183765
|
+
* [Api set: PowerPointApi 1.10]
|
|
183766
|
+
*/
|
|
183767
|
+
horizontalBrick = "HorizontalBrick",
|
|
183768
|
+
/**
|
|
183769
|
+
* Diagonal brick pattern fill.
|
|
183770
|
+
* @remarks
|
|
183771
|
+
* [Api set: PowerPointApi 1.10]
|
|
183772
|
+
*/
|
|
183773
|
+
diagonalBrick = "DiagonalBrick",
|
|
183774
|
+
/**
|
|
183775
|
+
* Solid diamond pattern fill.
|
|
183776
|
+
* @remarks
|
|
183777
|
+
* [Api set: PowerPointApi 1.10]
|
|
183778
|
+
*/
|
|
183779
|
+
solidDiamond = "SolidDiamond",
|
|
183780
|
+
/**
|
|
183781
|
+
* Outlined diamond pattern fill.
|
|
183782
|
+
* @remarks
|
|
183783
|
+
* [Api set: PowerPointApi 1.10]
|
|
183784
|
+
*/
|
|
183785
|
+
outlinedDiamond = "OutlinedDiamond",
|
|
183786
|
+
/**
|
|
183787
|
+
* Dotted diamond pattern fill.
|
|
183788
|
+
* @remarks
|
|
183789
|
+
* [Api set: PowerPointApi 1.10]
|
|
183790
|
+
*/
|
|
183791
|
+
dottedDiamond = "DottedDiamond",
|
|
183792
|
+
/**
|
|
183793
|
+
* Plaid pattern fill.
|
|
183794
|
+
* @remarks
|
|
183795
|
+
* [Api set: PowerPointApi 1.10]
|
|
183796
|
+
*/
|
|
183797
|
+
plaid = "Plaid",
|
|
183798
|
+
/**
|
|
183799
|
+
* Sphere pattern fill.
|
|
183800
|
+
* @remarks
|
|
183801
|
+
* [Api set: PowerPointApi 1.10]
|
|
183802
|
+
*/
|
|
183803
|
+
sphere = "Sphere",
|
|
183804
|
+
/**
|
|
183805
|
+
* Weave pattern fill.
|
|
183806
|
+
* @remarks
|
|
183807
|
+
* [Api set: PowerPointApi 1.10]
|
|
183808
|
+
*/
|
|
183809
|
+
weave = "Weave",
|
|
183810
|
+
/**
|
|
183811
|
+
* Divot pattern fill.
|
|
183812
|
+
* @remarks
|
|
183813
|
+
* [Api set: PowerPointApi 1.10]
|
|
183814
|
+
*/
|
|
183815
|
+
divot = "Divot",
|
|
183816
|
+
/**
|
|
183817
|
+
* Shingle pattern fill.
|
|
183818
|
+
* @remarks
|
|
183819
|
+
* [Api set: PowerPointApi 1.10]
|
|
183820
|
+
*/
|
|
183821
|
+
shingle = "Shingle",
|
|
183822
|
+
/**
|
|
183823
|
+
* Wave pattern fill.
|
|
183824
|
+
* @remarks
|
|
183825
|
+
* [Api set: PowerPointApi 1.10]
|
|
183826
|
+
*/
|
|
183827
|
+
wave = "Wave",
|
|
183828
|
+
/**
|
|
183829
|
+
* Trellis pattern fill.
|
|
183830
|
+
* @remarks
|
|
183831
|
+
* [Api set: PowerPointApi 1.10]
|
|
183832
|
+
*/
|
|
183833
|
+
trellis = "Trellis",
|
|
183834
|
+
/**
|
|
183835
|
+
* Zig zag pattern fill.
|
|
183836
|
+
* @remarks
|
|
183837
|
+
* [Api set: PowerPointApi 1.10]
|
|
183838
|
+
*/
|
|
183839
|
+
zigZag = "ZigZag",
|
|
183840
|
+
}
|
|
183841
|
+
/**
|
|
183842
|
+
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
|
|
183843
|
+
*
|
|
183844
|
+
* @remarks
|
|
183845
|
+
* [Api set: PowerPointApi 1.10]
|
|
183846
|
+
*/
|
|
183847
|
+
class SlideBackgroundPatternFill extends OfficeExtension.ClientObject {
|
|
183848
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183849
|
+
context: RequestContext;
|
|
183850
|
+
/**
|
|
183851
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
183852
|
+
*
|
|
183853
|
+
* @remarks
|
|
183854
|
+
* [Api set: PowerPointApi 1.10]
|
|
183855
|
+
*/
|
|
183856
|
+
backgroundColor: string;
|
|
183857
|
+
/**
|
|
183858
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
183859
|
+
*
|
|
183860
|
+
* @remarks
|
|
183861
|
+
* [Api set: PowerPointApi 1.10]
|
|
183862
|
+
*/
|
|
183863
|
+
foregroundColor: string;
|
|
183864
|
+
/**
|
|
183865
|
+
* Specifies the pattern type.
|
|
183866
|
+
*
|
|
183867
|
+
* @remarks
|
|
183868
|
+
* [Api set: PowerPointApi 1.10]
|
|
183869
|
+
*/
|
|
183870
|
+
pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
183871
|
+
/**
|
|
183872
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183873
|
+
*
|
|
183874
|
+
* @param options Provides options for which properties of the object to load.
|
|
183875
|
+
*/
|
|
183876
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions): PowerPoint.SlideBackgroundPatternFill;
|
|
183877
|
+
/**
|
|
183878
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183879
|
+
*
|
|
183880
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
183881
|
+
*/
|
|
183882
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPatternFill;
|
|
183883
|
+
/**
|
|
183884
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183885
|
+
*
|
|
183886
|
+
* @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.
|
|
183887
|
+
*/
|
|
183888
|
+
load(propertyNamesAndPaths?: {
|
|
183889
|
+
select?: string;
|
|
183890
|
+
expand?: string;
|
|
183891
|
+
}): PowerPoint.SlideBackgroundPatternFill;
|
|
183892
|
+
/**
|
|
183893
|
+
* 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.)
|
|
183894
|
+
* Whereas the original `PowerPoint.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
183895
|
+
*/
|
|
183896
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
|
|
183897
|
+
}
|
|
183898
|
+
/**
|
|
183899
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
|
|
183900
|
+
*
|
|
183901
|
+
* @remarks
|
|
183902
|
+
* [Api set: PowerPointApi 1.10]
|
|
183903
|
+
*/
|
|
183904
|
+
interface SlideBackgroundPatternFillOptions {
|
|
183905
|
+
/**
|
|
183906
|
+
* If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
183907
|
+
*
|
|
183908
|
+
* @remarks
|
|
183909
|
+
* [Api set: PowerPointApi 1.10]
|
|
183910
|
+
*/
|
|
183911
|
+
backgroundColor?: string;
|
|
183912
|
+
/**
|
|
183913
|
+
* If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
183914
|
+
*
|
|
183915
|
+
* @remarks
|
|
183916
|
+
* [Api set: PowerPointApi 1.10]
|
|
183917
|
+
*/
|
|
183918
|
+
foregroundColor?: string;
|
|
183919
|
+
/**
|
|
183920
|
+
* If provided, specifies the pattern type.
|
|
183921
|
+
*
|
|
183922
|
+
* @remarks
|
|
183923
|
+
* [Api set: PowerPointApi 1.10]
|
|
183924
|
+
*/
|
|
183925
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
183926
|
+
}
|
|
183927
|
+
/**
|
|
183928
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
|
|
183929
|
+
*
|
|
183930
|
+
* @remarks
|
|
183931
|
+
* [Api set: PowerPointApi 1.10]
|
|
183932
|
+
*/
|
|
183933
|
+
class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject {
|
|
183934
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183935
|
+
context: RequestContext;
|
|
183936
|
+
/**
|
|
183937
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
183938
|
+
*
|
|
183939
|
+
* @remarks
|
|
183940
|
+
* [Api set: PowerPointApi 1.10]
|
|
183941
|
+
*/
|
|
183942
|
+
transparency: number;
|
|
183943
|
+
/**
|
|
183944
|
+
* Sets the image used to fill.
|
|
183945
|
+
*
|
|
183946
|
+
* @remarks
|
|
183947
|
+
* [Api set: PowerPointApi 1.10]
|
|
183948
|
+
*
|
|
183949
|
+
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
|
|
183950
|
+
*/
|
|
183951
|
+
setImage(base64EncodedImage: string): void;
|
|
183952
|
+
/**
|
|
183953
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183954
|
+
*
|
|
183955
|
+
* @param options Provides options for which properties of the object to load.
|
|
183956
|
+
*/
|
|
183957
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
183958
|
+
/**
|
|
183959
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183960
|
+
*
|
|
183961
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
183962
|
+
*/
|
|
183963
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
183964
|
+
/**
|
|
183965
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
183966
|
+
*
|
|
183967
|
+
* @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.
|
|
183968
|
+
*/
|
|
183969
|
+
load(propertyNamesAndPaths?: {
|
|
183970
|
+
select?: string;
|
|
183971
|
+
expand?: string;
|
|
183972
|
+
}): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
183973
|
+
/**
|
|
183974
|
+
* 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.)
|
|
183975
|
+
* Whereas the original `PowerPoint.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
183976
|
+
*/
|
|
183977
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
|
|
183978
|
+
}
|
|
183979
|
+
/**
|
|
183980
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
|
|
183981
|
+
*
|
|
183982
|
+
* @remarks
|
|
183983
|
+
* [Api set: PowerPointApi 1.10]
|
|
183984
|
+
*/
|
|
183985
|
+
interface SlideBackgroundPictureOrTextureFillOptions {
|
|
183986
|
+
/**
|
|
183987
|
+
* If provided, specifies the Base64-encoded image data for the fill.
|
|
183988
|
+
*
|
|
183989
|
+
* @remarks
|
|
183990
|
+
* [Api set: PowerPointApi 1.10]
|
|
183991
|
+
*/
|
|
183992
|
+
imageBase64?: string;
|
|
183993
|
+
/**
|
|
183994
|
+
* If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
183995
|
+
*
|
|
183996
|
+
* @remarks
|
|
183997
|
+
* [Api set: PowerPointApi 1.10]
|
|
183998
|
+
*/
|
|
183999
|
+
transparency: number;
|
|
184000
|
+
}
|
|
184001
|
+
/**
|
|
184002
|
+
* Specifies the fill type for a {@link PowerPoint.SlideBackground}.
|
|
184003
|
+
*
|
|
184004
|
+
* @remarks
|
|
184005
|
+
* [Api set: PowerPointApi 1.10]
|
|
184006
|
+
*/
|
|
184007
|
+
enum SlideBackgroundFillType {
|
|
184008
|
+
/**
|
|
184009
|
+
* Unsupported slide background fill.
|
|
184010
|
+
* @remarks
|
|
184011
|
+
* [Api set: PowerPointApi 1.10]
|
|
184012
|
+
*/
|
|
184013
|
+
unsupported = "Unsupported",
|
|
184014
|
+
/**
|
|
184015
|
+
* Specifies that the slide background should have regular solid fill.
|
|
184016
|
+
* @remarks
|
|
184017
|
+
* [Api set: PowerPointApi 1.10]
|
|
184018
|
+
*/
|
|
184019
|
+
solid = "Solid",
|
|
184020
|
+
/**
|
|
184021
|
+
* Specifies that the slide background should have gradient fill.
|
|
184022
|
+
* @remarks
|
|
184023
|
+
* [Api set: PowerPointApi 1.10]
|
|
184024
|
+
*/
|
|
184025
|
+
gradient = "Gradient",
|
|
184026
|
+
/**
|
|
184027
|
+
* Specifies that the slide background should have picture or texture fill.
|
|
184028
|
+
* @remarks
|
|
184029
|
+
* [Api set: PowerPointApi 1.10]
|
|
184030
|
+
*/
|
|
184031
|
+
pictureOrTexture = "PictureOrTexture",
|
|
184032
|
+
/**
|
|
184033
|
+
* Specifies that the slide background should have pattern fill.
|
|
184034
|
+
* @remarks
|
|
184035
|
+
* [Api set: PowerPointApi 1.10]
|
|
184036
|
+
*/
|
|
184037
|
+
pattern = "Pattern",
|
|
184038
|
+
}
|
|
184039
|
+
/**
|
|
184040
|
+
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
|
|
184041
|
+
*
|
|
184042
|
+
* @remarks
|
|
184043
|
+
* [Api set: PowerPointApi 1.10]
|
|
184044
|
+
*/
|
|
184045
|
+
class SlideBackgroundSolidFill extends OfficeExtension.ClientObject {
|
|
184046
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184047
|
+
context: RequestContext;
|
|
184048
|
+
/**
|
|
184049
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
184050
|
+
*
|
|
184051
|
+
* @remarks
|
|
184052
|
+
* [Api set: PowerPointApi 1.10]
|
|
184053
|
+
*/
|
|
184054
|
+
color: string;
|
|
184055
|
+
/**
|
|
184056
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
184057
|
+
*
|
|
184058
|
+
* @remarks
|
|
184059
|
+
* [Api set: PowerPointApi 1.10]
|
|
184060
|
+
*/
|
|
184061
|
+
transparency: number;
|
|
184062
|
+
/**
|
|
184063
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184064
|
+
*
|
|
184065
|
+
* @param options Provides options for which properties of the object to load.
|
|
184066
|
+
*/
|
|
184067
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;
|
|
184068
|
+
/**
|
|
184069
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184070
|
+
*
|
|
184071
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
184072
|
+
*/
|
|
184073
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundSolidFill;
|
|
184074
|
+
/**
|
|
184075
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184076
|
+
*
|
|
184077
|
+
* @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.
|
|
184078
|
+
*/
|
|
184079
|
+
load(propertyNamesAndPaths?: {
|
|
184080
|
+
select?: string;
|
|
184081
|
+
expand?: string;
|
|
184082
|
+
}): PowerPoint.SlideBackgroundSolidFill;
|
|
184083
|
+
/**
|
|
184084
|
+
* 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.)
|
|
184085
|
+
* Whereas the original `PowerPoint.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184086
|
+
*/
|
|
184087
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
|
|
184088
|
+
}
|
|
184089
|
+
/**
|
|
184090
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
|
|
184091
|
+
*
|
|
184092
|
+
* @remarks
|
|
184093
|
+
* [Api set: PowerPointApi 1.10]
|
|
184094
|
+
*/
|
|
184095
|
+
interface SlideBackgroundSolidFillOptions {
|
|
184096
|
+
/**
|
|
184097
|
+
* If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
184098
|
+
*
|
|
184099
|
+
* @remarks
|
|
184100
|
+
* [Api set: PowerPointApi 1.10]
|
|
184101
|
+
*/
|
|
184102
|
+
color?: string;
|
|
184103
|
+
/**
|
|
184104
|
+
* If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
184105
|
+
*
|
|
184106
|
+
* @remarks
|
|
184107
|
+
* [Api set: PowerPointApi 1.10]
|
|
184108
|
+
*/
|
|
184109
|
+
transparency?: number;
|
|
184110
|
+
}
|
|
184111
|
+
/**
|
|
184112
|
+
* Represents the fill formatting of a slide background object.
|
|
184113
|
+
*
|
|
184114
|
+
* @remarks
|
|
184115
|
+
* [Api set: PowerPointApi 1.10]
|
|
184116
|
+
*/
|
|
184117
|
+
class SlideBackgroundFill extends OfficeExtension.ClientObject {
|
|
184118
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184119
|
+
context: RequestContext;
|
|
184120
|
+
/**
|
|
184121
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
184122
|
+
*
|
|
184123
|
+
* @remarks
|
|
184124
|
+
* [Api set: PowerPointApi 1.10]
|
|
184125
|
+
*/
|
|
184126
|
+
readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
|
|
184127
|
+
/**
|
|
184128
|
+
* Gets the gradient fill properties. If the fill type is not `gradient`, an object with an `isNullObject` property set to `true` is returned.
|
|
184129
|
+
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}.
|
|
184130
|
+
*
|
|
184131
|
+
* @remarks
|
|
184132
|
+
* [Api set: PowerPointApi 1.10]
|
|
184133
|
+
*/
|
|
184134
|
+
getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
|
|
184135
|
+
/**
|
|
184136
|
+
* Gets the pattern fill properties. If the fill type is not `pattern`, an object with an `isNullObject` property set to `true` is returned.
|
|
184137
|
+
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}.
|
|
184138
|
+
*
|
|
184139
|
+
* @remarks
|
|
184140
|
+
* [Api set: PowerPointApi 1.10]
|
|
184141
|
+
*/
|
|
184142
|
+
getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
|
|
184143
|
+
/**
|
|
184144
|
+
* Gets the picture or texture fill properties. If the fill type is not `pictureOrTexture`, an object with an `isNullObject` property set to `true` is returned.
|
|
184145
|
+
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}.
|
|
184146
|
+
*
|
|
184147
|
+
* @remarks
|
|
184148
|
+
* [Api set: PowerPointApi 1.10]
|
|
184149
|
+
*/
|
|
184150
|
+
getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
184151
|
+
/**
|
|
184152
|
+
* Gets the solid fill properties. If the fill type is not `solid`, an object with an `isNullObject` property set to `true` is returned.
|
|
184153
|
+
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}.
|
|
184154
|
+
*
|
|
184155
|
+
* @remarks
|
|
184156
|
+
* [Api set: PowerPointApi 1.10]
|
|
184157
|
+
*/
|
|
184158
|
+
getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
|
|
184159
|
+
/**
|
|
184160
|
+
* Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
|
|
184161
|
+
*
|
|
184162
|
+
* @remarks
|
|
184163
|
+
* [Api set: PowerPointApi 1.10]
|
|
184164
|
+
*
|
|
184165
|
+
* @param options Options for the gradient fill.
|
|
184166
|
+
*/
|
|
184167
|
+
setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;
|
|
184168
|
+
/**
|
|
184169
|
+
* Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
|
|
184170
|
+
*
|
|
184171
|
+
* @remarks
|
|
184172
|
+
* [Api set: PowerPointApi 1.10]
|
|
184173
|
+
*
|
|
184174
|
+
* @param options Options for the pattern fill.
|
|
184175
|
+
*/
|
|
184176
|
+
setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;
|
|
184177
|
+
/**
|
|
184178
|
+
* Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
|
|
184179
|
+
*
|
|
184180
|
+
* @remarks
|
|
184181
|
+
* [Api set: PowerPointApi 1.10]
|
|
184182
|
+
*
|
|
184183
|
+
* @param options Options for the picture or texture fill.
|
|
184184
|
+
*/
|
|
184185
|
+
setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;
|
|
184186
|
+
/**
|
|
184187
|
+
* Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
|
|
184188
|
+
*
|
|
184189
|
+
* @remarks
|
|
184190
|
+
* [Api set: PowerPointApi 1.10]
|
|
184191
|
+
*
|
|
184192
|
+
* @param options Options for the solid fill.
|
|
184193
|
+
*/
|
|
184194
|
+
setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void;
|
|
184195
|
+
/**
|
|
184196
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184197
|
+
*
|
|
184198
|
+
* @param options Provides options for which properties of the object to load.
|
|
184199
|
+
*/
|
|
184200
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;
|
|
184201
|
+
/**
|
|
184202
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184203
|
+
*
|
|
184204
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
184205
|
+
*/
|
|
184206
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill;
|
|
184207
|
+
/**
|
|
184208
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184209
|
+
*
|
|
184210
|
+
* @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.
|
|
184211
|
+
*/
|
|
184212
|
+
load(propertyNamesAndPaths?: {
|
|
184213
|
+
select?: string;
|
|
184214
|
+
expand?: string;
|
|
184215
|
+
}): PowerPoint.SlideBackgroundFill;
|
|
184216
|
+
/**
|
|
184217
|
+
* 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.)
|
|
184218
|
+
* Whereas the original `PowerPoint.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184219
|
+
*/
|
|
184220
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
|
|
184221
|
+
}
|
|
184222
|
+
/**
|
|
184223
|
+
* Represents a background of a slide.
|
|
184224
|
+
*
|
|
184225
|
+
* @remarks
|
|
184226
|
+
* [Api set: PowerPointApi 1.10]
|
|
184227
|
+
*/
|
|
184228
|
+
class SlideBackground extends OfficeExtension.ClientObject {
|
|
184229
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184230
|
+
context: RequestContext;
|
|
184231
|
+
/**
|
|
184232
|
+
* Returns the fill formatting of the background.
|
|
184233
|
+
*
|
|
184234
|
+
* @remarks
|
|
184235
|
+
* [Api set: PowerPointApi 1.10]
|
|
184236
|
+
*/
|
|
184237
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
184238
|
+
/**
|
|
184239
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
184240
|
+
*
|
|
184241
|
+
* @remarks
|
|
184242
|
+
* [Api set: PowerPointApi 1.10]
|
|
184243
|
+
*/
|
|
184244
|
+
areBackgroundGraphicsHidden: boolean;
|
|
184245
|
+
/**
|
|
184246
|
+
* Specifies if the slide background follows the slide master background.
|
|
184247
|
+
*
|
|
184248
|
+
* @remarks
|
|
184249
|
+
* [Api set: PowerPointApi 1.10]
|
|
184250
|
+
*/
|
|
184251
|
+
isMasterBackgroundFollowed: boolean;
|
|
184252
|
+
/**
|
|
184253
|
+
* Resets the fill formatting of the slide background.
|
|
184254
|
+
*
|
|
184255
|
+
* @remarks
|
|
184256
|
+
* [Api set: PowerPointApi 1.10]
|
|
184257
|
+
*/
|
|
184258
|
+
reset(): void;
|
|
184259
|
+
/**
|
|
184260
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184261
|
+
*
|
|
184262
|
+
* @param options Provides options for which properties of the object to load.
|
|
184263
|
+
*/
|
|
184264
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;
|
|
184265
|
+
/**
|
|
184266
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184267
|
+
*
|
|
184268
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
184269
|
+
*/
|
|
184270
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackground;
|
|
184271
|
+
/**
|
|
184272
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184273
|
+
*
|
|
184274
|
+
* @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.
|
|
184275
|
+
*/
|
|
184276
|
+
load(propertyNamesAndPaths?: {
|
|
184277
|
+
select?: string;
|
|
184278
|
+
expand?: string;
|
|
184279
|
+
}): PowerPoint.SlideBackground;
|
|
184280
|
+
/**
|
|
184281
|
+
* 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.)
|
|
184282
|
+
* Whereas the original `PowerPoint.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184283
|
+
*/
|
|
184284
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
|
|
184285
|
+
}
|
|
182826
184286
|
/**
|
|
182827
184287
|
* Represents the available options when getting an image of a slide.
|
|
182828
184288
|
*
|
|
@@ -182845,6 +184305,70 @@ declare namespace PowerPoint {
|
|
|
182845
184305
|
*/
|
|
182846
184306
|
width?: number;
|
|
182847
184307
|
}
|
|
184308
|
+
/**
|
|
184309
|
+
* Represents the background of a slide layout.
|
|
184310
|
+
*
|
|
184311
|
+
* @remarks
|
|
184312
|
+
* [Api set: PowerPointApi 1.10]
|
|
184313
|
+
*/
|
|
184314
|
+
class SlideLayoutBackground extends OfficeExtension.ClientObject {
|
|
184315
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184316
|
+
context: RequestContext;
|
|
184317
|
+
/**
|
|
184318
|
+
* Returns the fill formatting of the background.
|
|
184319
|
+
*
|
|
184320
|
+
* @remarks
|
|
184321
|
+
* [Api set: PowerPointApi 1.10]
|
|
184322
|
+
*/
|
|
184323
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
184324
|
+
/**
|
|
184325
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
184326
|
+
*
|
|
184327
|
+
* @remarks
|
|
184328
|
+
* [Api set: PowerPointApi 1.10]
|
|
184329
|
+
*/
|
|
184330
|
+
areBackgroundGraphicsHidden: boolean;
|
|
184331
|
+
/**
|
|
184332
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
184333
|
+
*
|
|
184334
|
+
* @remarks
|
|
184335
|
+
* [Api set: PowerPointApi 1.10]
|
|
184336
|
+
*/
|
|
184337
|
+
isMasterBackgroundFollowed: boolean;
|
|
184338
|
+
/**
|
|
184339
|
+
* Resets the fill formatting of the slide layout background.
|
|
184340
|
+
*
|
|
184341
|
+
* @remarks
|
|
184342
|
+
* [Api set: PowerPointApi 1.10]
|
|
184343
|
+
*/
|
|
184344
|
+
reset(): void;
|
|
184345
|
+
/**
|
|
184346
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184347
|
+
*
|
|
184348
|
+
* @param options Provides options for which properties of the object to load.
|
|
184349
|
+
*/
|
|
184350
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground;
|
|
184351
|
+
/**
|
|
184352
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184353
|
+
*
|
|
184354
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
184355
|
+
*/
|
|
184356
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayoutBackground;
|
|
184357
|
+
/**
|
|
184358
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184359
|
+
*
|
|
184360
|
+
* @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.
|
|
184361
|
+
*/
|
|
184362
|
+
load(propertyNamesAndPaths?: {
|
|
184363
|
+
select?: string;
|
|
184364
|
+
expand?: string;
|
|
184365
|
+
}): PowerPoint.SlideLayoutBackground;
|
|
184366
|
+
/**
|
|
184367
|
+
* 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.)
|
|
184368
|
+
* Whereas the original `PowerPoint.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184369
|
+
*/
|
|
184370
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
|
|
184371
|
+
}
|
|
182848
184372
|
/**
|
|
182849
184373
|
* Specifies the type of a slide layout.
|
|
182850
184374
|
*
|
|
@@ -183075,6 +184599,155 @@ declare namespace PowerPoint {
|
|
|
183075
184599
|
*/
|
|
183076
184600
|
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
|
|
183077
184601
|
}
|
|
184602
|
+
/**
|
|
184603
|
+
* Specifies the theme colors used in PowerPoint.
|
|
184604
|
+
*
|
|
184605
|
+
* @remarks
|
|
184606
|
+
* [Api set: PowerPointApi 1.10]
|
|
184607
|
+
*/
|
|
184608
|
+
enum ThemeColor {
|
|
184609
|
+
/**
|
|
184610
|
+
* Specifies a mixed theme color.
|
|
184611
|
+
* @remarks
|
|
184612
|
+
* [Api set: PowerPointApi 1.10]
|
|
184613
|
+
*/
|
|
184614
|
+
mixed = "Mixed",
|
|
184615
|
+
/**
|
|
184616
|
+
* Specifies no theme color.
|
|
184617
|
+
* @remarks
|
|
184618
|
+
* [Api set: PowerPointApi 1.10]
|
|
184619
|
+
*/
|
|
184620
|
+
none = "None",
|
|
184621
|
+
/**
|
|
184622
|
+
* Specifies the Accent 1 theme color.
|
|
184623
|
+
* @remarks
|
|
184624
|
+
* [Api set: PowerPointApi 1.10]
|
|
184625
|
+
*/
|
|
184626
|
+
accent1 = "Accent1",
|
|
184627
|
+
/**
|
|
184628
|
+
* Specifies the Accent 2 theme color.
|
|
184629
|
+
* @remarks
|
|
184630
|
+
* [Api set: PowerPointApi 1.10]
|
|
184631
|
+
*/
|
|
184632
|
+
accent2 = "Accent2",
|
|
184633
|
+
/**
|
|
184634
|
+
* Specifies the Accent 3 theme color.
|
|
184635
|
+
* @remarks
|
|
184636
|
+
* [Api set: PowerPointApi 1.10]
|
|
184637
|
+
*/
|
|
184638
|
+
accent3 = "Accent3",
|
|
184639
|
+
/**
|
|
184640
|
+
* Specifies the Accent 4 theme color.
|
|
184641
|
+
* @remarks
|
|
184642
|
+
* [Api set: PowerPointApi 1.10]
|
|
184643
|
+
*/
|
|
184644
|
+
accent4 = "Accent4",
|
|
184645
|
+
/**
|
|
184646
|
+
* Specifies the Accent 5 theme color.
|
|
184647
|
+
* @remarks
|
|
184648
|
+
* [Api set: PowerPointApi 1.10]
|
|
184649
|
+
*/
|
|
184650
|
+
accent5 = "Accent5",
|
|
184651
|
+
/**
|
|
184652
|
+
* Specifies the Accent 6 theme color.
|
|
184653
|
+
* @remarks
|
|
184654
|
+
* [Api set: PowerPointApi 1.10]
|
|
184655
|
+
*/
|
|
184656
|
+
accent6 = "Accent6",
|
|
184657
|
+
/**
|
|
184658
|
+
* Specifies the Dark 1 theme color.
|
|
184659
|
+
* @remarks
|
|
184660
|
+
* [Api set: PowerPointApi 1.10]
|
|
184661
|
+
*/
|
|
184662
|
+
dark1 = "Dark1",
|
|
184663
|
+
/**
|
|
184664
|
+
* Specifies the Dark 2 theme color.
|
|
184665
|
+
* @remarks
|
|
184666
|
+
* [Api set: PowerPointApi 1.10]
|
|
184667
|
+
*/
|
|
184668
|
+
dark2 = "Dark2",
|
|
184669
|
+
/**
|
|
184670
|
+
* Specifies the clicked hyperlink theme color.
|
|
184671
|
+
* @remarks
|
|
184672
|
+
* [Api set: PowerPointApi 1.10]
|
|
184673
|
+
*/
|
|
184674
|
+
followedHyperlink = "FollowedHyperlink",
|
|
184675
|
+
/**
|
|
184676
|
+
* Specifies the hyperlink theme color.
|
|
184677
|
+
* @remarks
|
|
184678
|
+
* [Api set: PowerPointApi 1.10]
|
|
184679
|
+
*/
|
|
184680
|
+
hyperlink = "Hyperlink",
|
|
184681
|
+
/**
|
|
184682
|
+
* Specifies the Light 1 theme color.
|
|
184683
|
+
* @remarks
|
|
184684
|
+
* [Api set: PowerPointApi 1.10]
|
|
184685
|
+
*/
|
|
184686
|
+
light1 = "Light1",
|
|
184687
|
+
/**
|
|
184688
|
+
* Specifies the Light 2 theme color.
|
|
184689
|
+
* @remarks
|
|
184690
|
+
* [Api set: PowerPointApi 1.10]
|
|
184691
|
+
*/
|
|
184692
|
+
light2 = "Light2",
|
|
184693
|
+
}
|
|
184694
|
+
/**
|
|
184695
|
+
* Represents a theme color scheme.
|
|
184696
|
+
*
|
|
184697
|
+
* @remarks
|
|
184698
|
+
* [Api set: PowerPointApi 1.10]
|
|
184699
|
+
*/
|
|
184700
|
+
class ThemeColorScheme extends OfficeExtension.ClientObject {
|
|
184701
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184702
|
+
context: RequestContext;
|
|
184703
|
+
/**
|
|
184704
|
+
* Gets the color value for the specified `ThemeColor`.
|
|
184705
|
+
*
|
|
184706
|
+
* @remarks
|
|
184707
|
+
* [Api set: PowerPointApi 1.10]
|
|
184708
|
+
*
|
|
184709
|
+
* @param color The theme color.
|
|
184710
|
+
* @returns The color value in #RRGGBB format (e.g., "FFA500").
|
|
184711
|
+
*/
|
|
184712
|
+
getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult<string>;
|
|
184713
|
+
/**
|
|
184714
|
+
* Gets the color value for the specified `ThemeColor`.
|
|
184715
|
+
*
|
|
184716
|
+
* @remarks
|
|
184717
|
+
* [Api set: PowerPointApi 1.10]
|
|
184718
|
+
*
|
|
184719
|
+
* @param color The theme color.
|
|
184720
|
+
* @returns The color value in #RRGGBB format (e.g., "FFA500").
|
|
184721
|
+
*/
|
|
184722
|
+
getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult<string>;
|
|
184723
|
+
/**
|
|
184724
|
+
* Sets the color value for the specified `ThemeColor`.
|
|
184725
|
+
*
|
|
184726
|
+
* @remarks
|
|
184727
|
+
* [Api set: PowerPointApi 1.10]
|
|
184728
|
+
*
|
|
184729
|
+
* @param color The theme color.
|
|
184730
|
+
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
184731
|
+
*/
|
|
184732
|
+
setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;
|
|
184733
|
+
/**
|
|
184734
|
+
* Sets the color value for the specified `ThemeColor`.
|
|
184735
|
+
*
|
|
184736
|
+
* @remarks
|
|
184737
|
+
* [Api set: PowerPointApi 1.10]
|
|
184738
|
+
*
|
|
184739
|
+
* @param color The theme color.
|
|
184740
|
+
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
184741
|
+
*/
|
|
184742
|
+
setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
|
|
184743
|
+
/**
|
|
184744
|
+
* 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.)
|
|
184745
|
+
* Whereas the original `PowerPoint.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184746
|
+
*/
|
|
184747
|
+
toJSON(): {
|
|
184748
|
+
[key: string]: string;
|
|
184749
|
+
};
|
|
184750
|
+
}
|
|
183078
184751
|
/**
|
|
183079
184752
|
* Represents the layout of a slide.
|
|
183080
184753
|
*
|
|
@@ -183084,6 +184757,13 @@ declare namespace PowerPoint {
|
|
|
183084
184757
|
class SlideLayout extends OfficeExtension.ClientObject {
|
|
183085
184758
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183086
184759
|
context: RequestContext;
|
|
184760
|
+
/**
|
|
184761
|
+
* Gets the background of the slide layout.
|
|
184762
|
+
*
|
|
184763
|
+
* @remarks
|
|
184764
|
+
* [Api set: PowerPointApi 1.10]
|
|
184765
|
+
*/
|
|
184766
|
+
readonly background: PowerPoint.SlideLayoutBackground;
|
|
183087
184767
|
/**
|
|
183088
184768
|
* Returns a collection of custom XML parts in the slide layout.
|
|
183089
184769
|
*
|
|
@@ -183098,6 +184778,13 @@ declare namespace PowerPoint {
|
|
|
183098
184778
|
* [Api set: PowerPointApi 1.3]
|
|
183099
184779
|
*/
|
|
183100
184780
|
readonly shapes: PowerPoint.ShapeCollection;
|
|
184781
|
+
/**
|
|
184782
|
+
* Returns the `ThemeColorScheme` of the slide layout.
|
|
184783
|
+
*
|
|
184784
|
+
* @remarks
|
|
184785
|
+
* [Api set: PowerPointApi 1.10]
|
|
184786
|
+
*/
|
|
184787
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
183101
184788
|
/**
|
|
183102
184789
|
* Gets the unique ID of the slide layout.
|
|
183103
184790
|
*
|
|
@@ -183141,9 +184828,9 @@ declare namespace PowerPoint {
|
|
|
183141
184828
|
expand?: string;
|
|
183142
184829
|
}): PowerPoint.SlideLayout;
|
|
183143
184830
|
/**
|
|
183144
|
-
|
|
183145
|
-
|
|
183146
|
-
|
|
184831
|
+
* 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.)
|
|
184832
|
+
* Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184833
|
+
*/
|
|
183147
184834
|
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
183148
184835
|
}
|
|
183149
184836
|
/**
|
|
@@ -183215,11 +184902,54 @@ declare namespace PowerPoint {
|
|
|
183215
184902
|
*/
|
|
183216
184903
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
|
|
183217
184904
|
/**
|
|
183218
|
-
|
|
183219
|
-
|
|
183220
|
-
|
|
184905
|
+
* 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.)
|
|
184906
|
+
* Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
184907
|
+
*/
|
|
183221
184908
|
toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
|
|
183222
184909
|
}
|
|
184910
|
+
/**
|
|
184911
|
+
* Represents the background of a slide master.
|
|
184912
|
+
*
|
|
184913
|
+
* @remarks
|
|
184914
|
+
* [Api set: PowerPointApi 1.10]
|
|
184915
|
+
*/
|
|
184916
|
+
class SlideMasterBackground extends OfficeExtension.ClientObject {
|
|
184917
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
184918
|
+
context: RequestContext;
|
|
184919
|
+
/**
|
|
184920
|
+
* Returns the fill formatting of the background.
|
|
184921
|
+
*
|
|
184922
|
+
* @remarks
|
|
184923
|
+
* [Api set: PowerPointApi 1.10]
|
|
184924
|
+
*/
|
|
184925
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
184926
|
+
/**
|
|
184927
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184928
|
+
*
|
|
184929
|
+
* @param options Provides options for which properties of the object to load.
|
|
184930
|
+
*/
|
|
184931
|
+
load(options?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions): PowerPoint.SlideMasterBackground;
|
|
184932
|
+
/**
|
|
184933
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184934
|
+
*
|
|
184935
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
184936
|
+
*/
|
|
184937
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideMasterBackground;
|
|
184938
|
+
/**
|
|
184939
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
184940
|
+
*
|
|
184941
|
+
* @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.
|
|
184942
|
+
*/
|
|
184943
|
+
load(propertyNamesAndPaths?: {
|
|
184944
|
+
select?: string;
|
|
184945
|
+
expand?: string;
|
|
184946
|
+
}): PowerPoint.SlideMasterBackground;
|
|
184947
|
+
/**
|
|
184948
|
+
* 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.)
|
|
184949
|
+
* Whereas the original `PowerPoint.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
184950
|
+
*/
|
|
184951
|
+
toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
|
|
184952
|
+
}
|
|
183223
184953
|
/**
|
|
183224
184954
|
* Represents the Slide Master of a slide.
|
|
183225
184955
|
*
|
|
@@ -183229,6 +184959,13 @@ declare namespace PowerPoint {
|
|
|
183229
184959
|
class SlideMaster extends OfficeExtension.ClientObject {
|
|
183230
184960
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183231
184961
|
context: RequestContext;
|
|
184962
|
+
/**
|
|
184963
|
+
* Gets the background of the Slide Master.
|
|
184964
|
+
*
|
|
184965
|
+
* @remarks
|
|
184966
|
+
* [Api set: PowerPointApi 1.10]
|
|
184967
|
+
*/
|
|
184968
|
+
readonly background: PowerPoint.SlideMasterBackground;
|
|
183232
184969
|
/**
|
|
183233
184970
|
* Returns a collection of custom XML parts in the Slide Master.
|
|
183234
184971
|
*
|
|
@@ -183250,6 +184987,13 @@ declare namespace PowerPoint {
|
|
|
183250
184987
|
* [Api set: PowerPointApi 1.3]
|
|
183251
184988
|
*/
|
|
183252
184989
|
readonly shapes: PowerPoint.ShapeCollection;
|
|
184990
|
+
/**
|
|
184991
|
+
* Returns the `ThemeColorScheme` of the Slide Master.
|
|
184992
|
+
*
|
|
184993
|
+
* @remarks
|
|
184994
|
+
* [Api set: PowerPointApi 1.10]
|
|
184995
|
+
*/
|
|
184996
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
183253
184997
|
/**
|
|
183254
184998
|
* Gets the unique ID of the Slide Master.
|
|
183255
184999
|
*
|
|
@@ -183286,9 +185030,9 @@ declare namespace PowerPoint {
|
|
|
183286
185030
|
expand?: string;
|
|
183287
185031
|
}): PowerPoint.SlideMaster;
|
|
183288
185032
|
/**
|
|
183289
|
-
|
|
183290
|
-
|
|
183291
|
-
|
|
185033
|
+
* 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.)
|
|
185034
|
+
* Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
185035
|
+
*/
|
|
183292
185036
|
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
183293
185037
|
}
|
|
183294
185038
|
/**
|
|
@@ -183336,9 +185080,9 @@ declare namespace PowerPoint {
|
|
|
183336
185080
|
expand?: string;
|
|
183337
185081
|
}): PowerPoint.Tag;
|
|
183338
185082
|
/**
|
|
183339
|
-
|
|
183340
|
-
|
|
183341
|
-
|
|
185083
|
+
* 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.)
|
|
185084
|
+
* Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
|
|
185085
|
+
*/
|
|
183342
185086
|
toJSON(): PowerPoint.Interfaces.TagData;
|
|
183343
185087
|
}
|
|
183344
185088
|
/**
|
|
@@ -183428,9 +185172,9 @@ declare namespace PowerPoint {
|
|
|
183428
185172
|
*/
|
|
183429
185173
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
|
|
183430
185174
|
/**
|
|
183431
|
-
|
|
183432
|
-
|
|
183433
|
-
|
|
185175
|
+
* 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.)
|
|
185176
|
+
* Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
185177
|
+
*/
|
|
183434
185178
|
toJSON(): PowerPoint.Interfaces.TagCollectionData;
|
|
183435
185179
|
}
|
|
183436
185180
|
/**
|
|
@@ -183442,6 +185186,13 @@ declare namespace PowerPoint {
|
|
|
183442
185186
|
class Slide extends OfficeExtension.ClientObject {
|
|
183443
185187
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183444
185188
|
context: RequestContext;
|
|
185189
|
+
/**
|
|
185190
|
+
* Gets the background of the slide.
|
|
185191
|
+
*
|
|
185192
|
+
* @remarks
|
|
185193
|
+
* [Api set: PowerPointApi 1.10]
|
|
185194
|
+
*/
|
|
185195
|
+
readonly background: PowerPoint.SlideBackground;
|
|
183445
185196
|
/**
|
|
183446
185197
|
* Returns a collection of custom XML parts in the slide.
|
|
183447
185198
|
*
|
|
@@ -183484,6 +185235,13 @@ declare namespace PowerPoint {
|
|
|
183484
185235
|
* [Api set: PowerPointApi 1.3]
|
|
183485
185236
|
*/
|
|
183486
185237
|
readonly tags: PowerPoint.TagCollection;
|
|
185238
|
+
/**
|
|
185239
|
+
* Returns the `ThemeColorScheme` of the slide.
|
|
185240
|
+
*
|
|
185241
|
+
* @remarks
|
|
185242
|
+
* [Api set: PowerPointApi 1.10]
|
|
185243
|
+
*/
|
|
185244
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
183487
185245
|
/**
|
|
183488
185246
|
* Gets the unique ID of the slide.
|
|
183489
185247
|
*
|
|
@@ -183575,11 +185333,59 @@ declare namespace PowerPoint {
|
|
|
183575
185333
|
expand?: string;
|
|
183576
185334
|
}): PowerPoint.Slide;
|
|
183577
185335
|
/**
|
|
183578
|
-
|
|
183579
|
-
|
|
183580
|
-
|
|
185336
|
+
* 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.)
|
|
185337
|
+
* Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
|
|
185338
|
+
*/
|
|
183581
185339
|
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
183582
185340
|
}
|
|
185341
|
+
/**
|
|
185342
|
+
* Represents the format of an image.
|
|
185343
|
+
*
|
|
185344
|
+
* @remarks
|
|
185345
|
+
* [Api set: PowerPointApi 1.10]
|
|
185346
|
+
*/
|
|
185347
|
+
enum ShapeGetImageFormatType {
|
|
185348
|
+
/**
|
|
185349
|
+
* The picture is in PNG format.
|
|
185350
|
+
* @remarks
|
|
185351
|
+
* [Api set: PowerPointApi 1.10]
|
|
185352
|
+
*/
|
|
185353
|
+
png = "Png",
|
|
185354
|
+
}
|
|
185355
|
+
/**
|
|
185356
|
+
* Represents the available options when getting an image of a shape.
|
|
185357
|
+
The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used.
|
|
185358
|
+
If only one of either width or height is specified, the other will be calculated to preserve aspect ratio.
|
|
185359
|
+
The resulting dimensions will automatically be clamped to the maximum supported size if too large.
|
|
185360
|
+
*
|
|
185361
|
+
* @remarks
|
|
185362
|
+
* [Api set: PowerPointApi 1.10]
|
|
185363
|
+
*/
|
|
185364
|
+
interface ShapeGetImageOptions {
|
|
185365
|
+
/**
|
|
185366
|
+
* The desired format of the resulting image.
|
|
185367
|
+
*
|
|
185368
|
+
* @remarks
|
|
185369
|
+
* [Api set: PowerPointApi 1.10]
|
|
185370
|
+
*/
|
|
185371
|
+
format?: PowerPoint.ShapeGetImageFormatType | "Png";
|
|
185372
|
+
/**
|
|
185373
|
+
* The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
|
|
185374
|
+
Throws an `InvalidArgument` exception when set with a non-positive integer.
|
|
185375
|
+
*
|
|
185376
|
+
* @remarks
|
|
185377
|
+
* [Api set: PowerPointApi 1.10]
|
|
185378
|
+
*/
|
|
185379
|
+
height?: number;
|
|
185380
|
+
/**
|
|
185381
|
+
* The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
|
|
185382
|
+
Throws an `InvalidArgument` exception when set with a non-positive integer.
|
|
185383
|
+
*
|
|
185384
|
+
* @remarks
|
|
185385
|
+
* [Api set: PowerPointApi 1.10]
|
|
185386
|
+
*/
|
|
185387
|
+
width?: number;
|
|
185388
|
+
}
|
|
183583
185389
|
/**
|
|
183584
185390
|
* Represents a collection of shapes.
|
|
183585
185391
|
*
|
|
@@ -183657,9 +185463,9 @@ declare namespace PowerPoint {
|
|
|
183657
185463
|
*/
|
|
183658
185464
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection;
|
|
183659
185465
|
/**
|
|
183660
|
-
|
|
183661
|
-
|
|
183662
|
-
|
|
185466
|
+
* 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.)
|
|
185467
|
+
* Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
185468
|
+
*/
|
|
183663
185469
|
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
|
|
183664
185470
|
}
|
|
183665
185471
|
/**
|
|
@@ -183685,6 +185491,13 @@ declare namespace PowerPoint {
|
|
|
183685
185491
|
* [Api set: PowerPointApi 1.8]
|
|
183686
185492
|
*/
|
|
183687
185493
|
readonly shapes: PowerPoint.ShapeScopedCollection;
|
|
185494
|
+
/**
|
|
185495
|
+
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
|
|
185496
|
+
*
|
|
185497
|
+
* @remarks
|
|
185498
|
+
* [Api set: PowerPointApi 1.10]
|
|
185499
|
+
*/
|
|
185500
|
+
readonly creationId: string | null;
|
|
183688
185501
|
/**
|
|
183689
185502
|
* Gets the unique ID of the shape group.
|
|
183690
185503
|
*
|
|
@@ -183837,9 +185650,9 @@ declare namespace PowerPoint {
|
|
|
183837
185650
|
expand?: string;
|
|
183838
185651
|
}): PowerPoint.ShapeLineFormat;
|
|
183839
185652
|
/**
|
|
183840
|
-
|
|
183841
|
-
|
|
183842
|
-
|
|
185653
|
+
* 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.)
|
|
185654
|
+
* Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
185655
|
+
*/
|
|
183843
185656
|
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
|
|
183844
185657
|
}
|
|
183845
185658
|
/**
|
|
@@ -183883,6 +185696,13 @@ declare namespace PowerPoint {
|
|
|
183883
185696
|
class Shape extends OfficeExtension.ClientObject {
|
|
183884
185697
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
183885
185698
|
context: RequestContext;
|
|
185699
|
+
/**
|
|
185700
|
+
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
|
|
185701
|
+
*
|
|
185702
|
+
* @remarks
|
|
185703
|
+
* [Api set: PowerPointApi 1.10]
|
|
185704
|
+
*/
|
|
185705
|
+
readonly adjustments: PowerPoint.Adjustments;
|
|
183886
185706
|
/**
|
|
183887
185707
|
* Returns a collection of custom XML parts in the shape.
|
|
183888
185708
|
*
|
|
@@ -183942,6 +185762,34 @@ declare namespace PowerPoint {
|
|
|
183942
185762
|
* [Api set: PowerPointApi 1.4]
|
|
183943
185763
|
*/
|
|
183944
185764
|
readonly textFrame: PowerPoint.TextFrame;
|
|
185765
|
+
/**
|
|
185766
|
+
* The alt text description of the Shape.
|
|
185767
|
+
|
|
185768
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
185769
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
185770
|
+
*
|
|
185771
|
+
* @remarks
|
|
185772
|
+
* [Api set: PowerPointApi 1.10]
|
|
185773
|
+
*/
|
|
185774
|
+
altTextDescription: string;
|
|
185775
|
+
/**
|
|
185776
|
+
* The alt text title of the Shape.
|
|
185777
|
+
|
|
185778
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
185779
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
185780
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
185781
|
+
*
|
|
185782
|
+
* @remarks
|
|
185783
|
+
* [Api set: PowerPointApi 1.10]
|
|
185784
|
+
*/
|
|
185785
|
+
altTextTitle: string;
|
|
185786
|
+
/**
|
|
185787
|
+
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
185788
|
+
*
|
|
185789
|
+
* @remarks
|
|
185790
|
+
* [Api set: PowerPointApi 1.10]
|
|
185791
|
+
*/
|
|
185792
|
+
readonly creationId: string | null;
|
|
183945
185793
|
/**
|
|
183946
185794
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
183947
185795
|
*
|
|
@@ -183956,6 +185804,16 @@ declare namespace PowerPoint {
|
|
|
183956
185804
|
* [Api set: PowerPointApi 1.3]
|
|
183957
185805
|
*/
|
|
183958
185806
|
readonly id: string;
|
|
185807
|
+
/**
|
|
185808
|
+
* Represents whether the shape is decorative or not.
|
|
185809
|
+
|
|
185810
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
185811
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
185812
|
+
*
|
|
185813
|
+
* @remarks
|
|
185814
|
+
* [Api set: PowerPointApi 1.10]
|
|
185815
|
+
*/
|
|
185816
|
+
isDecorative: boolean;
|
|
183959
185817
|
/**
|
|
183960
185818
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
183961
185819
|
*
|
|
@@ -183983,6 +185841,14 @@ declare namespace PowerPoint {
|
|
|
183983
185841
|
* [Api set: PowerPointApi 1.4]
|
|
183984
185842
|
*/
|
|
183985
185843
|
name: string;
|
|
185844
|
+
/**
|
|
185845
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
185846
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
185847
|
+
*
|
|
185848
|
+
* @remarks
|
|
185849
|
+
* [Api set: PowerPointApi 1.10]
|
|
185850
|
+
*/
|
|
185851
|
+
rotation: number;
|
|
183986
185852
|
/**
|
|
183987
185853
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
183988
185854
|
*
|
|
@@ -183997,6 +185863,13 @@ declare namespace PowerPoint {
|
|
|
183997
185863
|
* [Api set: PowerPointApi 1.4]
|
|
183998
185864
|
*/
|
|
183999
185865
|
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
|
|
185866
|
+
/**
|
|
185867
|
+
* Specifies if the shape is visible.
|
|
185868
|
+
*
|
|
185869
|
+
* @remarks
|
|
185870
|
+
* [Api set: PowerPointApi 1.10]
|
|
185871
|
+
*/
|
|
185872
|
+
visible: boolean;
|
|
184000
185873
|
/**
|
|
184001
185874
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
184002
185875
|
*
|
|
@@ -184019,6 +185892,16 @@ declare namespace PowerPoint {
|
|
|
184019
185892
|
* [Api set: PowerPointApi 1.3]
|
|
184020
185893
|
*/
|
|
184021
185894
|
delete(): void;
|
|
185895
|
+
/**
|
|
185896
|
+
* Renders an image of the shape.
|
|
185897
|
+
*
|
|
185898
|
+
* @remarks
|
|
185899
|
+
* [Api set: PowerPointApi 1.10]
|
|
185900
|
+
*
|
|
185901
|
+
* @param options Optional. Options to specify the desired output image properties.
|
|
185902
|
+
* @returns A Base64-encoded string of the shape image in the specified format.
|
|
185903
|
+
*/
|
|
185904
|
+
getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions): OfficeExtension.ClientResult<string>;
|
|
184022
185905
|
/**
|
|
184023
185906
|
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
|
|
184024
185907
|
*
|
|
@@ -184068,6 +185951,24 @@ declare namespace PowerPoint {
|
|
|
184068
185951
|
* [Api set: PowerPointApi 1.8]
|
|
184069
185952
|
*/
|
|
184070
185953
|
getTable(): PowerPoint.Table;
|
|
185954
|
+
/**
|
|
185955
|
+
* Returns the {@link PowerPoint.TextFrame} object of this `Shape`. If the shape doesn't support a `TextFrame`, an object with an `isNullObject` property set to `true` is returned.
|
|
185956
|
+
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}.
|
|
185957
|
+
*
|
|
185958
|
+
* @remarks
|
|
185959
|
+
* [Api set: PowerPointApi 1.10]
|
|
185960
|
+
*/
|
|
185961
|
+
getTextFrameOrNullObject(): PowerPoint.TextFrame;
|
|
185962
|
+
/**
|
|
185963
|
+
* Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`.
|
|
185964
|
+
*
|
|
185965
|
+
* @remarks
|
|
185966
|
+
* [Api set: PowerPointApi 1.10]
|
|
185967
|
+
*
|
|
185968
|
+
* @param options Optional. The options for the hyperlink.
|
|
185969
|
+
* @returns The newly created {@link PowerPoint.Hyperlink} object.
|
|
185970
|
+
*/
|
|
185971
|
+
setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
|
|
184071
185972
|
/**
|
|
184072
185973
|
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
184073
185974
|
*
|
|
@@ -184108,9 +186009,9 @@ declare namespace PowerPoint {
|
|
|
184108
186009
|
expand?: string;
|
|
184109
186010
|
}): PowerPoint.Shape;
|
|
184110
186011
|
/**
|
|
184111
|
-
|
|
184112
|
-
|
|
184113
|
-
|
|
186012
|
+
* 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.)
|
|
186013
|
+
* Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
186014
|
+
*/
|
|
184114
186015
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
184115
186016
|
}
|
|
184116
186017
|
/**
|
|
@@ -184383,9 +186284,9 @@ declare namespace PowerPoint {
|
|
|
184383
186284
|
expand?: string;
|
|
184384
186285
|
}): PowerPoint.CustomProperty;
|
|
184385
186286
|
/**
|
|
184386
|
-
|
|
184387
|
-
|
|
184388
|
-
|
|
186287
|
+
* 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.)
|
|
186288
|
+
* Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
186289
|
+
*/
|
|
184389
186290
|
toJSON(): PowerPoint.Interfaces.CustomPropertyData;
|
|
184390
186291
|
}
|
|
184391
186292
|
/**
|
|
@@ -184436,6 +186337,17 @@ declare namespace PowerPoint {
|
|
|
184436
186337
|
* Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error.
|
|
184437
186338
|
*/
|
|
184438
186339
|
getItem(key: string): PowerPoint.CustomProperty;
|
|
186340
|
+
/**
|
|
186341
|
+
* Gets a `CustomProperty` by its zero-based index in the collection.
|
|
186342
|
+
Throws an `InvalidArgument` exception when the index is out of range.
|
|
186343
|
+
*
|
|
186344
|
+
* @remarks
|
|
186345
|
+
* [Api set: PowerPointApi 1.10]
|
|
186346
|
+
*
|
|
186347
|
+
* @param index The index of the custom property in the collection.
|
|
186348
|
+
* @returns The custom property at the given index.
|
|
186349
|
+
*/
|
|
186350
|
+
getItemAt(index: number): PowerPoint.CustomProperty;
|
|
184439
186351
|
/**
|
|
184440
186352
|
* Gets a `CustomProperty` by its key.
|
|
184441
186353
|
If the `CustomProperty` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
@@ -184467,9 +186379,9 @@ declare namespace PowerPoint {
|
|
|
184467
186379
|
*/
|
|
184468
186380
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;
|
|
184469
186381
|
/**
|
|
184470
|
-
|
|
184471
|
-
|
|
184472
|
-
|
|
186382
|
+
* 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.)
|
|
186383
|
+
* Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
186384
|
+
*/
|
|
184473
186385
|
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;
|
|
184474
186386
|
}
|
|
184475
186387
|
/**
|
|
@@ -184587,9 +186499,9 @@ declare namespace PowerPoint {
|
|
|
184587
186499
|
expand?: string;
|
|
184588
186500
|
}): PowerPoint.DocumentProperties;
|
|
184589
186501
|
/**
|
|
184590
|
-
|
|
184591
|
-
|
|
184592
|
-
|
|
186502
|
+
* 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.)
|
|
186503
|
+
* Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
|
|
186504
|
+
*/
|
|
184593
186505
|
toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;
|
|
184594
186506
|
}
|
|
184595
186507
|
/**
|
|
@@ -184647,6 +186559,56 @@ declare namespace PowerPoint {
|
|
|
184647
186559
|
*/
|
|
184648
186560
|
targetSlideId?: string;
|
|
184649
186561
|
}
|
|
186562
|
+
/**
|
|
186563
|
+
* Represents the page setup information for the presentation.
|
|
186564
|
+
*
|
|
186565
|
+
* @remarks
|
|
186566
|
+
* [Api set: PowerPointApi 1.10]
|
|
186567
|
+
*/
|
|
186568
|
+
class PageSetup extends OfficeExtension.ClientObject {
|
|
186569
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
186570
|
+
context: RequestContext;
|
|
186571
|
+
/**
|
|
186572
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
186573
|
+
*
|
|
186574
|
+
* @remarks
|
|
186575
|
+
* [Api set: PowerPointApi 1.10]
|
|
186576
|
+
*/
|
|
186577
|
+
slideHeight: number;
|
|
186578
|
+
/**
|
|
186579
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
186580
|
+
*
|
|
186581
|
+
* @remarks
|
|
186582
|
+
* [Api set: PowerPointApi 1.10]
|
|
186583
|
+
*/
|
|
186584
|
+
slideWidth: number;
|
|
186585
|
+
/**
|
|
186586
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
186587
|
+
*
|
|
186588
|
+
* @param options Provides options for which properties of the object to load.
|
|
186589
|
+
*/
|
|
186590
|
+
load(options?: PowerPoint.Interfaces.PageSetupLoadOptions): PowerPoint.PageSetup;
|
|
186591
|
+
/**
|
|
186592
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
186593
|
+
*
|
|
186594
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
186595
|
+
*/
|
|
186596
|
+
load(propertyNames?: string | string[]): PowerPoint.PageSetup;
|
|
186597
|
+
/**
|
|
186598
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
186599
|
+
*
|
|
186600
|
+
* @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.
|
|
186601
|
+
*/
|
|
186602
|
+
load(propertyNamesAndPaths?: {
|
|
186603
|
+
select?: string;
|
|
186604
|
+
expand?: string;
|
|
186605
|
+
}): PowerPoint.PageSetup;
|
|
186606
|
+
/**
|
|
186607
|
+
* 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.)
|
|
186608
|
+
* Whereas the original `PowerPoint.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
186609
|
+
*/
|
|
186610
|
+
toJSON(): PowerPoint.Interfaces.PageSetupData;
|
|
186611
|
+
}
|
|
184650
186612
|
/**
|
|
184651
186613
|
* Represents the collection of slides in the presentation.
|
|
184652
186614
|
*
|
|
@@ -184667,6 +186629,17 @@ declare namespace PowerPoint {
|
|
|
184667
186629
|
* @param options Optional. Options for configuring the properties of the new slide.
|
|
184668
186630
|
*/
|
|
184669
186631
|
add(options?: PowerPoint.AddSlideOptions): void;
|
|
186632
|
+
/**
|
|
186633
|
+
* Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
|
|
186634
|
+
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
|
|
186635
|
+
*
|
|
186636
|
+
* @remarks
|
|
186637
|
+
* [Api set: PowerPointApi 1.10]
|
|
186638
|
+
*
|
|
186639
|
+
* @param values An array of slide IDs or `Slide` objects.
|
|
186640
|
+
* @returns A Base64-encoded string.
|
|
186641
|
+
*/
|
|
186642
|
+
exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;
|
|
184670
186643
|
/**
|
|
184671
186644
|
* Gets the number of slides in the collection.
|
|
184672
186645
|
*
|
|
@@ -184726,9 +186699,9 @@ declare namespace PowerPoint {
|
|
|
184726
186699
|
*/
|
|
184727
186700
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection;
|
|
184728
186701
|
/**
|
|
184729
|
-
|
|
184730
|
-
|
|
184731
|
-
|
|
186702
|
+
* 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.)
|
|
186703
|
+
* Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
186704
|
+
*/
|
|
184732
186705
|
toJSON(): PowerPoint.Interfaces.SlideCollectionData;
|
|
184733
186706
|
}
|
|
184734
186707
|
/**
|
|
@@ -184742,6 +186715,14 @@ declare namespace PowerPoint {
|
|
|
184742
186715
|
context: RequestContext;
|
|
184743
186716
|
/** Gets the loaded child items in this collection. */
|
|
184744
186717
|
readonly items: PowerPoint.Slide[];
|
|
186718
|
+
/**
|
|
186719
|
+
* Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
|
|
186720
|
+
*
|
|
186721
|
+
* @remarks
|
|
186722
|
+
* [Api set: PowerPointApi 1.10]
|
|
186723
|
+
* @returns A Base64-encoded string.
|
|
186724
|
+
*/
|
|
186725
|
+
exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;
|
|
184745
186726
|
/**
|
|
184746
186727
|
* Gets the number of slides in the collection.
|
|
184747
186728
|
*
|
|
@@ -184800,9 +186781,9 @@ declare namespace PowerPoint {
|
|
|
184800
186781
|
*/
|
|
184801
186782
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;
|
|
184802
186783
|
/**
|
|
184803
|
-
|
|
184804
|
-
|
|
184805
|
-
|
|
186784
|
+
* 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.)
|
|
186785
|
+
* Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
186786
|
+
*/
|
|
184806
186787
|
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;
|
|
184807
186788
|
}
|
|
184808
186789
|
/**
|
|
@@ -184874,9 +186855,9 @@ declare namespace PowerPoint {
|
|
|
184874
186855
|
*/
|
|
184875
186856
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideMasterCollection;
|
|
184876
186857
|
/**
|
|
184877
|
-
|
|
184878
|
-
|
|
184879
|
-
|
|
186858
|
+
* 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.)
|
|
186859
|
+
* Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
186860
|
+
*/
|
|
184880
186861
|
toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData;
|
|
184881
186862
|
}
|
|
184882
186863
|
enum ErrorCodes {
|
|
@@ -184904,8 +186885,28 @@ declare namespace PowerPoint {
|
|
|
184904
186885
|
interface CustomXmlPartCollectionUpdateData {
|
|
184905
186886
|
items?: PowerPoint.Interfaces.CustomXmlPartData[];
|
|
184906
186887
|
}
|
|
186888
|
+
/** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
|
|
186889
|
+
interface HyperlinkScopedCollectionUpdateData {
|
|
186890
|
+
items?: PowerPoint.Interfaces.HyperlinkData[];
|
|
186891
|
+
}
|
|
184907
186892
|
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
|
|
184908
186893
|
interface BulletFormatUpdateData {
|
|
186894
|
+
/**
|
|
186895
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
186896
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
186897
|
+
*
|
|
186898
|
+
* @remarks
|
|
186899
|
+
* [Api set: PowerPointApi 1.10]
|
|
186900
|
+
*/
|
|
186901
|
+
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
186902
|
+
/**
|
|
186903
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
186904
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
186905
|
+
*
|
|
186906
|
+
* @remarks
|
|
186907
|
+
* [Api set: PowerPointApi 1.10]
|
|
186908
|
+
*/
|
|
186909
|
+
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
184909
186910
|
/**
|
|
184910
186911
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
184911
186912
|
*
|
|
@@ -184923,17 +186924,24 @@ declare namespace PowerPoint {
|
|
|
184923
186924
|
* [Api set: PowerPointApi 1.4]
|
|
184924
186925
|
*/
|
|
184925
186926
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
186927
|
+
/**
|
|
186928
|
+
* Represents the indent level of the paragraph.
|
|
186929
|
+
*
|
|
186930
|
+
* @remarks
|
|
186931
|
+
* [Api set: PowerPointApi 1.10]
|
|
186932
|
+
*/
|
|
186933
|
+
indentLevel?: number;
|
|
184926
186934
|
}
|
|
184927
186935
|
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
|
|
184928
186936
|
interface ShapeFontUpdateData {
|
|
184929
186937
|
/**
|
|
184930
186938
|
* 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:
|
|
184931
186939
|
|
|
184932
|
-
|
|
186940
|
+
- `true`: All the text has the **All Caps** attribute.
|
|
184933
186941
|
|
|
184934
|
-
|
|
186942
|
+
- `false`: None of the text has the **All Caps** attribute.
|
|
184935
186943
|
|
|
184936
|
-
|
|
186944
|
+
- `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
|
|
184937
186945
|
*
|
|
184938
186946
|
* @remarks
|
|
184939
186947
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -184942,11 +186950,11 @@ declare namespace PowerPoint {
|
|
|
184942
186950
|
/**
|
|
184943
186951
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
184944
186952
|
|
|
184945
|
-
|
|
186953
|
+
- `true`: All the text is bold.
|
|
184946
186954
|
|
|
184947
|
-
|
|
186955
|
+
- `false`: None of the text is bold.
|
|
184948
186956
|
|
|
184949
|
-
|
|
186957
|
+
- `null`: Returned if some, but not all, of the text is bold.
|
|
184950
186958
|
*
|
|
184951
186959
|
* @remarks
|
|
184952
186960
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -184962,11 +186970,11 @@ declare namespace PowerPoint {
|
|
|
184962
186970
|
/**
|
|
184963
186971
|
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
184964
186972
|
|
|
184965
|
-
|
|
186973
|
+
- `true`: All the text has the **Double strikethrough** attribute.
|
|
184966
186974
|
|
|
184967
|
-
|
|
186975
|
+
- `false`: None of the text has the **Double strikethrough** attribute.
|
|
184968
186976
|
|
|
184969
|
-
|
|
186977
|
+
- `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
184970
186978
|
*
|
|
184971
186979
|
* @remarks
|
|
184972
186980
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -184975,11 +186983,11 @@ declare namespace PowerPoint {
|
|
|
184975
186983
|
/**
|
|
184976
186984
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
184977
186985
|
|
|
184978
|
-
|
|
186986
|
+
- `true`: All the text is italicized.
|
|
184979
186987
|
|
|
184980
|
-
|
|
186988
|
+
- `false`: None of the text is italicized.
|
|
184981
186989
|
|
|
184982
|
-
|
|
186990
|
+
- `null`: Returned if some, but not all, of the text is italicized.
|
|
184983
186991
|
*
|
|
184984
186992
|
* @remarks
|
|
184985
186993
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -185002,11 +187010,11 @@ declare namespace PowerPoint {
|
|
|
185002
187010
|
/**
|
|
185003
187011
|
* 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:
|
|
185004
187012
|
|
|
185005
|
-
|
|
187013
|
+
- `true`: All the text has the **Small Caps** attribute.
|
|
185006
187014
|
|
|
185007
|
-
|
|
187015
|
+
- `false`: None of the text has the **Small Caps** attribute.
|
|
185008
187016
|
|
|
185009
|
-
|
|
187017
|
+
- `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
185010
187018
|
*
|
|
185011
187019
|
* @remarks
|
|
185012
187020
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185015,11 +187023,11 @@ declare namespace PowerPoint {
|
|
|
185015
187023
|
/**
|
|
185016
187024
|
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
185017
187025
|
|
|
185018
|
-
|
|
187026
|
+
- `true`: All the text has the **Strikethrough** attribute.
|
|
185019
187027
|
|
|
185020
|
-
|
|
187028
|
+
- `false`: None of the text has the **Strikethrough** attribute.
|
|
185021
187029
|
|
|
185022
|
-
|
|
187030
|
+
- `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
185023
187031
|
*
|
|
185024
187032
|
* @remarks
|
|
185025
187033
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185028,11 +187036,11 @@ declare namespace PowerPoint {
|
|
|
185028
187036
|
/**
|
|
185029
187037
|
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
185030
187038
|
|
|
185031
|
-
|
|
187039
|
+
- `true`: All the text has the **Subscript** attribute.
|
|
185032
187040
|
|
|
185033
|
-
|
|
187041
|
+
- `false`: None of the text has the **Subscript** attribute.
|
|
185034
187042
|
|
|
185035
|
-
|
|
187043
|
+
- `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
185036
187044
|
*
|
|
185037
187045
|
* @remarks
|
|
185038
187046
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185041,11 +187049,11 @@ declare namespace PowerPoint {
|
|
|
185041
187049
|
/**
|
|
185042
187050
|
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
185043
187051
|
|
|
185044
|
-
|
|
187052
|
+
- `true`: All the text has the **Superscript** attribute.
|
|
185045
187053
|
|
|
185046
|
-
|
|
187054
|
+
- `false`: None of the text has the **Superscript** attribute.
|
|
185047
187055
|
|
|
185048
|
-
|
|
187056
|
+
- `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
185049
187057
|
*
|
|
185050
187058
|
* @remarks
|
|
185051
187059
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185364,6 +187372,101 @@ declare namespace PowerPoint {
|
|
|
185364
187372
|
interface ShapeCollectionUpdateData {
|
|
185365
187373
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
185366
187374
|
}
|
|
187375
|
+
/** An interface for updating data on the `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
|
|
187376
|
+
interface SlideBackgroundGradientFillUpdateData {
|
|
187377
|
+
/**
|
|
187378
|
+
* Specifies the type of gradient fill.
|
|
187379
|
+
*
|
|
187380
|
+
* @remarks
|
|
187381
|
+
* [Api set: PowerPointApi 1.10]
|
|
187382
|
+
*/
|
|
187383
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
187384
|
+
}
|
|
187385
|
+
/** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
|
|
187386
|
+
interface SlideBackgroundPatternFillUpdateData {
|
|
187387
|
+
/**
|
|
187388
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
187389
|
+
*
|
|
187390
|
+
* @remarks
|
|
187391
|
+
* [Api set: PowerPointApi 1.10]
|
|
187392
|
+
*/
|
|
187393
|
+
backgroundColor?: string;
|
|
187394
|
+
/**
|
|
187395
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
187396
|
+
*
|
|
187397
|
+
* @remarks
|
|
187398
|
+
* [Api set: PowerPointApi 1.10]
|
|
187399
|
+
*/
|
|
187400
|
+
foregroundColor?: string;
|
|
187401
|
+
/**
|
|
187402
|
+
* Specifies the pattern type.
|
|
187403
|
+
*
|
|
187404
|
+
* @remarks
|
|
187405
|
+
* [Api set: PowerPointApi 1.10]
|
|
187406
|
+
*/
|
|
187407
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
187408
|
+
}
|
|
187409
|
+
/** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
|
|
187410
|
+
interface SlideBackgroundPictureOrTextureFillUpdateData {
|
|
187411
|
+
/**
|
|
187412
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
187413
|
+
*
|
|
187414
|
+
* @remarks
|
|
187415
|
+
* [Api set: PowerPointApi 1.10]
|
|
187416
|
+
*/
|
|
187417
|
+
transparency?: number;
|
|
187418
|
+
}
|
|
187419
|
+
/** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
|
|
187420
|
+
interface SlideBackgroundSolidFillUpdateData {
|
|
187421
|
+
/**
|
|
187422
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
187423
|
+
*
|
|
187424
|
+
* @remarks
|
|
187425
|
+
* [Api set: PowerPointApi 1.10]
|
|
187426
|
+
*/
|
|
187427
|
+
color?: string;
|
|
187428
|
+
/**
|
|
187429
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
187430
|
+
*
|
|
187431
|
+
* @remarks
|
|
187432
|
+
* [Api set: PowerPointApi 1.10]
|
|
187433
|
+
*/
|
|
187434
|
+
transparency?: number;
|
|
187435
|
+
}
|
|
187436
|
+
/** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
|
|
187437
|
+
interface SlideBackgroundUpdateData {
|
|
187438
|
+
/**
|
|
187439
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
187440
|
+
*
|
|
187441
|
+
* @remarks
|
|
187442
|
+
* [Api set: PowerPointApi 1.10]
|
|
187443
|
+
*/
|
|
187444
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
187445
|
+
/**
|
|
187446
|
+
* Specifies if the slide background follows the slide master background.
|
|
187447
|
+
*
|
|
187448
|
+
* @remarks
|
|
187449
|
+
* [Api set: PowerPointApi 1.10]
|
|
187450
|
+
*/
|
|
187451
|
+
isMasterBackgroundFollowed?: boolean;
|
|
187452
|
+
}
|
|
187453
|
+
/** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
|
|
187454
|
+
interface SlideLayoutBackgroundUpdateData {
|
|
187455
|
+
/**
|
|
187456
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
187457
|
+
*
|
|
187458
|
+
* @remarks
|
|
187459
|
+
* [Api set: PowerPointApi 1.10]
|
|
187460
|
+
*/
|
|
187461
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
187462
|
+
/**
|
|
187463
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
187464
|
+
*
|
|
187465
|
+
* @remarks
|
|
187466
|
+
* [Api set: PowerPointApi 1.10]
|
|
187467
|
+
*/
|
|
187468
|
+
isMasterBackgroundFollowed?: boolean;
|
|
187469
|
+
}
|
|
185367
187470
|
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
185368
187471
|
interface SlideLayoutCollectionUpdateData {
|
|
185369
187472
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
@@ -185433,6 +187536,27 @@ declare namespace PowerPoint {
|
|
|
185433
187536
|
}
|
|
185434
187537
|
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
185435
187538
|
interface ShapeUpdateData {
|
|
187539
|
+
/**
|
|
187540
|
+
* The alt text description of the Shape.
|
|
187541
|
+
|
|
187542
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
187543
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
187544
|
+
*
|
|
187545
|
+
* @remarks
|
|
187546
|
+
* [Api set: PowerPointApi 1.10]
|
|
187547
|
+
*/
|
|
187548
|
+
altTextDescription?: string;
|
|
187549
|
+
/**
|
|
187550
|
+
* The alt text title of the Shape.
|
|
187551
|
+
|
|
187552
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
187553
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
187554
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
187555
|
+
*
|
|
187556
|
+
* @remarks
|
|
187557
|
+
* [Api set: PowerPointApi 1.10]
|
|
187558
|
+
*/
|
|
187559
|
+
altTextTitle?: string;
|
|
185436
187560
|
/**
|
|
185437
187561
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
185438
187562
|
*
|
|
@@ -185440,6 +187564,16 @@ declare namespace PowerPoint {
|
|
|
185440
187564
|
* [Api set: PowerPointApi 1.4]
|
|
185441
187565
|
*/
|
|
185442
187566
|
height?: number;
|
|
187567
|
+
/**
|
|
187568
|
+
* Represents whether the shape is decorative or not.
|
|
187569
|
+
|
|
187570
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
187571
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
187572
|
+
*
|
|
187573
|
+
* @remarks
|
|
187574
|
+
* [Api set: PowerPointApi 1.10]
|
|
187575
|
+
*/
|
|
187576
|
+
isDecorative?: boolean;
|
|
185443
187577
|
/**
|
|
185444
187578
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
185445
187579
|
*
|
|
@@ -185454,6 +187588,14 @@ declare namespace PowerPoint {
|
|
|
185454
187588
|
* [Api set: PowerPointApi 1.4]
|
|
185455
187589
|
*/
|
|
185456
187590
|
name?: string;
|
|
187591
|
+
/**
|
|
187592
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
187593
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
187594
|
+
*
|
|
187595
|
+
* @remarks
|
|
187596
|
+
* [Api set: PowerPointApi 1.10]
|
|
187597
|
+
*/
|
|
187598
|
+
rotation?: number;
|
|
185457
187599
|
/**
|
|
185458
187600
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
185459
187601
|
*
|
|
@@ -185461,6 +187603,13 @@ declare namespace PowerPoint {
|
|
|
185461
187603
|
* [Api set: PowerPointApi 1.4]
|
|
185462
187604
|
*/
|
|
185463
187605
|
top?: number;
|
|
187606
|
+
/**
|
|
187607
|
+
* Specifies if the shape is visible.
|
|
187608
|
+
*
|
|
187609
|
+
* @remarks
|
|
187610
|
+
* [Api set: PowerPointApi 1.10]
|
|
187611
|
+
*/
|
|
187612
|
+
visible?: boolean;
|
|
185464
187613
|
/**
|
|
185465
187614
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
185466
187615
|
*
|
|
@@ -185554,6 +187703,23 @@ declare namespace PowerPoint {
|
|
|
185554
187703
|
*/
|
|
185555
187704
|
title?: string;
|
|
185556
187705
|
}
|
|
187706
|
+
/** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
|
|
187707
|
+
interface PageSetupUpdateData {
|
|
187708
|
+
/**
|
|
187709
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
187710
|
+
*
|
|
187711
|
+
* @remarks
|
|
187712
|
+
* [Api set: PowerPointApi 1.10]
|
|
187713
|
+
*/
|
|
187714
|
+
slideHeight?: number;
|
|
187715
|
+
/**
|
|
187716
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
187717
|
+
*
|
|
187718
|
+
* @remarks
|
|
187719
|
+
* [Api set: PowerPointApi 1.10]
|
|
187720
|
+
*/
|
|
187721
|
+
slideWidth?: number;
|
|
187722
|
+
}
|
|
185557
187723
|
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
|
|
185558
187724
|
interface SlideCollectionUpdateData {
|
|
185559
187725
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -185583,6 +187749,16 @@ declare namespace PowerPoint {
|
|
|
185583
187749
|
*/
|
|
185584
187750
|
title?: string;
|
|
185585
187751
|
}
|
|
187752
|
+
/** An interface describing the data returned by calling `adjustments.toJSON()`. */
|
|
187753
|
+
interface AdjustmentsData {
|
|
187754
|
+
/**
|
|
187755
|
+
* Specifies the number of adjustment points.
|
|
187756
|
+
*
|
|
187757
|
+
* @remarks
|
|
187758
|
+
* [Api set: PowerPointApi 1.10]
|
|
187759
|
+
*/
|
|
187760
|
+
count?: number;
|
|
187761
|
+
}
|
|
185586
187762
|
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
|
|
185587
187763
|
interface CustomXmlPartData {
|
|
185588
187764
|
/**
|
|
@@ -185608,8 +187784,28 @@ declare namespace PowerPoint {
|
|
|
185608
187784
|
interface CustomXmlPartCollectionData {
|
|
185609
187785
|
items?: PowerPoint.Interfaces.CustomXmlPartData[];
|
|
185610
187786
|
}
|
|
187787
|
+
/** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
|
|
187788
|
+
interface HyperlinkScopedCollectionData {
|
|
187789
|
+
items?: PowerPoint.Interfaces.HyperlinkData[];
|
|
187790
|
+
}
|
|
185611
187791
|
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
|
|
185612
187792
|
interface BulletFormatData {
|
|
187793
|
+
/**
|
|
187794
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
187795
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
187796
|
+
*
|
|
187797
|
+
* @remarks
|
|
187798
|
+
* [Api set: PowerPointApi 1.10]
|
|
187799
|
+
*/
|
|
187800
|
+
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
187801
|
+
/**
|
|
187802
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
187803
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
187804
|
+
*
|
|
187805
|
+
* @remarks
|
|
187806
|
+
* [Api set: PowerPointApi 1.10]
|
|
187807
|
+
*/
|
|
187808
|
+
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
185613
187809
|
/**
|
|
185614
187810
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
185615
187811
|
*
|
|
@@ -185627,17 +187823,24 @@ declare namespace PowerPoint {
|
|
|
185627
187823
|
* [Api set: PowerPointApi 1.4]
|
|
185628
187824
|
*/
|
|
185629
187825
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
187826
|
+
/**
|
|
187827
|
+
* Represents the indent level of the paragraph.
|
|
187828
|
+
*
|
|
187829
|
+
* @remarks
|
|
187830
|
+
* [Api set: PowerPointApi 1.10]
|
|
187831
|
+
*/
|
|
187832
|
+
indentLevel?: number;
|
|
185630
187833
|
}
|
|
185631
187834
|
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
|
|
185632
187835
|
interface ShapeFontData {
|
|
185633
187836
|
/**
|
|
185634
187837
|
* 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:
|
|
185635
187838
|
|
|
185636
|
-
|
|
187839
|
+
- `true`: All the text has the **All Caps** attribute.
|
|
185637
187840
|
|
|
185638
|
-
|
|
187841
|
+
- `false`: None of the text has the **All Caps** attribute.
|
|
185639
187842
|
|
|
185640
|
-
|
|
187843
|
+
- `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
|
|
185641
187844
|
*
|
|
185642
187845
|
* @remarks
|
|
185643
187846
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185646,11 +187849,11 @@ declare namespace PowerPoint {
|
|
|
185646
187849
|
/**
|
|
185647
187850
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
185648
187851
|
|
|
185649
|
-
|
|
187852
|
+
- `true`: All the text is bold.
|
|
185650
187853
|
|
|
185651
|
-
|
|
187854
|
+
- `false`: None of the text is bold.
|
|
185652
187855
|
|
|
185653
|
-
|
|
187856
|
+
- `null`: Returned if some, but not all, of the text is bold.
|
|
185654
187857
|
*
|
|
185655
187858
|
* @remarks
|
|
185656
187859
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -185666,11 +187869,11 @@ declare namespace PowerPoint {
|
|
|
185666
187869
|
/**
|
|
185667
187870
|
* Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
|
|
185668
187871
|
|
|
185669
|
-
|
|
187872
|
+
- `true`: All the text has the **Double strikethrough** attribute.
|
|
185670
187873
|
|
|
185671
|
-
|
|
187874
|
+
- `false`: None of the text has the **Double strikethrough** attribute.
|
|
185672
187875
|
|
|
185673
|
-
|
|
187876
|
+
- `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
|
|
185674
187877
|
*
|
|
185675
187878
|
* @remarks
|
|
185676
187879
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185679,11 +187882,11 @@ declare namespace PowerPoint {
|
|
|
185679
187882
|
/**
|
|
185680
187883
|
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
185681
187884
|
|
|
185682
|
-
|
|
187885
|
+
- `true`: All the text is italicized.
|
|
185683
187886
|
|
|
185684
|
-
|
|
187887
|
+
- `false`: None of the text is italicized.
|
|
185685
187888
|
|
|
185686
|
-
|
|
187889
|
+
- `null`: Returned if some, but not all, of the text is italicized.
|
|
185687
187890
|
*
|
|
185688
187891
|
* @remarks
|
|
185689
187892
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -185706,11 +187909,11 @@ declare namespace PowerPoint {
|
|
|
185706
187909
|
/**
|
|
185707
187910
|
* 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:
|
|
185708
187911
|
|
|
185709
|
-
|
|
187912
|
+
- `true`: All the text has the **Small Caps** attribute.
|
|
185710
187913
|
|
|
185711
|
-
|
|
187914
|
+
- `false`: None of the text has the **Small Caps** attribute.
|
|
185712
187915
|
|
|
185713
|
-
|
|
187916
|
+
- `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
|
|
185714
187917
|
*
|
|
185715
187918
|
* @remarks
|
|
185716
187919
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185719,11 +187922,11 @@ declare namespace PowerPoint {
|
|
|
185719
187922
|
/**
|
|
185720
187923
|
* Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
|
|
185721
187924
|
|
|
185722
|
-
|
|
187925
|
+
- `true`: All the text has the **Strikethrough** attribute.
|
|
185723
187926
|
|
|
185724
|
-
|
|
187927
|
+
- `false`: None of the text has the **Strikethrough** attribute.
|
|
185725
187928
|
|
|
185726
|
-
|
|
187929
|
+
- `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
|
|
185727
187930
|
*
|
|
185728
187931
|
* @remarks
|
|
185729
187932
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185732,11 +187935,11 @@ declare namespace PowerPoint {
|
|
|
185732
187935
|
/**
|
|
185733
187936
|
* Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
|
|
185734
187937
|
|
|
185735
|
-
|
|
187938
|
+
- `true`: All the text has the **Subscript** attribute.
|
|
185736
187939
|
|
|
185737
|
-
|
|
187940
|
+
- `false`: None of the text has the **Subscript** attribute.
|
|
185738
187941
|
|
|
185739
|
-
|
|
187942
|
+
- `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
|
|
185740
187943
|
*
|
|
185741
187944
|
* @remarks
|
|
185742
187945
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185745,11 +187948,11 @@ declare namespace PowerPoint {
|
|
|
185745
187948
|
/**
|
|
185746
187949
|
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
185747
187950
|
|
|
185748
|
-
|
|
187951
|
+
- `true`: All the text has the **Superscript** attribute.
|
|
185749
187952
|
|
|
185750
|
-
|
|
187953
|
+
- `false`: None of the text has the **Superscript** attribute.
|
|
185751
187954
|
|
|
185752
|
-
|
|
187955
|
+
- `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
185753
187956
|
*
|
|
185754
187957
|
* @remarks
|
|
185755
187958
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -185864,6 +188067,13 @@ declare namespace PowerPoint {
|
|
|
185864
188067
|
* [Api set: PowerPointApi 1.6]
|
|
185865
188068
|
*/
|
|
185866
188069
|
screenTip?: string;
|
|
188070
|
+
/**
|
|
188071
|
+
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
|
|
188072
|
+
*
|
|
188073
|
+
* @remarks
|
|
188074
|
+
* [Api set: PowerPointApi 1.10]
|
|
188075
|
+
*/
|
|
188076
|
+
type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";
|
|
185867
188077
|
}
|
|
185868
188078
|
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
|
|
185869
188079
|
interface PlaceholderFormatData {
|
|
@@ -186178,6 +188388,111 @@ declare namespace PowerPoint {
|
|
|
186178
188388
|
interface ShapeCollectionData {
|
|
186179
188389
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
186180
188390
|
}
|
|
188391
|
+
/** An interface describing the data returned by calling `slideBackgroundGradientFill.toJSON()`. */
|
|
188392
|
+
interface SlideBackgroundGradientFillData {
|
|
188393
|
+
/**
|
|
188394
|
+
* Specifies the type of gradient fill.
|
|
188395
|
+
*
|
|
188396
|
+
* @remarks
|
|
188397
|
+
* [Api set: PowerPointApi 1.10]
|
|
188398
|
+
*/
|
|
188399
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
188400
|
+
}
|
|
188401
|
+
/** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
|
|
188402
|
+
interface SlideBackgroundPatternFillData {
|
|
188403
|
+
/**
|
|
188404
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
188405
|
+
*
|
|
188406
|
+
* @remarks
|
|
188407
|
+
* [Api set: PowerPointApi 1.10]
|
|
188408
|
+
*/
|
|
188409
|
+
backgroundColor?: string;
|
|
188410
|
+
/**
|
|
188411
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
188412
|
+
*
|
|
188413
|
+
* @remarks
|
|
188414
|
+
* [Api set: PowerPointApi 1.10]
|
|
188415
|
+
*/
|
|
188416
|
+
foregroundColor?: string;
|
|
188417
|
+
/**
|
|
188418
|
+
* Specifies the pattern type.
|
|
188419
|
+
*
|
|
188420
|
+
* @remarks
|
|
188421
|
+
* [Api set: PowerPointApi 1.10]
|
|
188422
|
+
*/
|
|
188423
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
188424
|
+
}
|
|
188425
|
+
/** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
|
|
188426
|
+
interface SlideBackgroundPictureOrTextureFillData {
|
|
188427
|
+
/**
|
|
188428
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
188429
|
+
*
|
|
188430
|
+
* @remarks
|
|
188431
|
+
* [Api set: PowerPointApi 1.10]
|
|
188432
|
+
*/
|
|
188433
|
+
transparency?: number;
|
|
188434
|
+
}
|
|
188435
|
+
/** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
|
|
188436
|
+
interface SlideBackgroundSolidFillData {
|
|
188437
|
+
/**
|
|
188438
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
188439
|
+
*
|
|
188440
|
+
* @remarks
|
|
188441
|
+
* [Api set: PowerPointApi 1.10]
|
|
188442
|
+
*/
|
|
188443
|
+
color?: string;
|
|
188444
|
+
/**
|
|
188445
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
188446
|
+
*
|
|
188447
|
+
* @remarks
|
|
188448
|
+
* [Api set: PowerPointApi 1.10]
|
|
188449
|
+
*/
|
|
188450
|
+
transparency?: number;
|
|
188451
|
+
}
|
|
188452
|
+
/** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
|
|
188453
|
+
interface SlideBackgroundFillData {
|
|
188454
|
+
/**
|
|
188455
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
188456
|
+
*
|
|
188457
|
+
* @remarks
|
|
188458
|
+
* [Api set: PowerPointApi 1.10]
|
|
188459
|
+
*/
|
|
188460
|
+
type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
|
|
188461
|
+
}
|
|
188462
|
+
/** An interface describing the data returned by calling `slideBackground.toJSON()`. */
|
|
188463
|
+
interface SlideBackgroundData {
|
|
188464
|
+
/**
|
|
188465
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
188466
|
+
*
|
|
188467
|
+
* @remarks
|
|
188468
|
+
* [Api set: PowerPointApi 1.10]
|
|
188469
|
+
*/
|
|
188470
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
188471
|
+
/**
|
|
188472
|
+
* Specifies if the slide background follows the slide master background.
|
|
188473
|
+
*
|
|
188474
|
+
* @remarks
|
|
188475
|
+
* [Api set: PowerPointApi 1.10]
|
|
188476
|
+
*/
|
|
188477
|
+
isMasterBackgroundFollowed?: boolean;
|
|
188478
|
+
}
|
|
188479
|
+
/** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
|
|
188480
|
+
interface SlideLayoutBackgroundData {
|
|
188481
|
+
/**
|
|
188482
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
188483
|
+
*
|
|
188484
|
+
* @remarks
|
|
188485
|
+
* [Api set: PowerPointApi 1.10]
|
|
188486
|
+
*/
|
|
188487
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
188488
|
+
/**
|
|
188489
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
188490
|
+
*
|
|
188491
|
+
* @remarks
|
|
188492
|
+
* [Api set: PowerPointApi 1.10]
|
|
188493
|
+
*/
|
|
188494
|
+
isMasterBackgroundFollowed?: boolean;
|
|
188495
|
+
}
|
|
186181
188496
|
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
|
|
186182
188497
|
interface SlideLayoutData {
|
|
186183
188498
|
/**
|
|
@@ -186206,6 +188521,9 @@ declare namespace PowerPoint {
|
|
|
186206
188521
|
interface SlideLayoutCollectionData {
|
|
186207
188522
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
186208
188523
|
}
|
|
188524
|
+
/** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
|
|
188525
|
+
interface SlideMasterBackgroundData {
|
|
188526
|
+
}
|
|
186209
188527
|
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
|
|
186210
188528
|
interface SlideMasterData {
|
|
186211
188529
|
/**
|
|
@@ -186267,6 +188585,13 @@ declare namespace PowerPoint {
|
|
|
186267
188585
|
}
|
|
186268
188586
|
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
|
|
186269
188587
|
interface ShapeGroupData {
|
|
188588
|
+
/**
|
|
188589
|
+
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
|
|
188590
|
+
*
|
|
188591
|
+
* @remarks
|
|
188592
|
+
* [Api set: PowerPointApi 1.10]
|
|
188593
|
+
*/
|
|
188594
|
+
creationId?: string | null;
|
|
186270
188595
|
/**
|
|
186271
188596
|
* Gets the unique ID of the shape group.
|
|
186272
188597
|
*
|
|
@@ -186322,6 +188647,34 @@ declare namespace PowerPoint {
|
|
|
186322
188647
|
}
|
|
186323
188648
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
186324
188649
|
interface ShapeData {
|
|
188650
|
+
/**
|
|
188651
|
+
* The alt text description of the Shape.
|
|
188652
|
+
|
|
188653
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
188654
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
188655
|
+
*
|
|
188656
|
+
* @remarks
|
|
188657
|
+
* [Api set: PowerPointApi 1.10]
|
|
188658
|
+
*/
|
|
188659
|
+
altTextDescription?: string;
|
|
188660
|
+
/**
|
|
188661
|
+
* The alt text title of the Shape.
|
|
188662
|
+
|
|
188663
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
188664
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
188665
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
188666
|
+
*
|
|
188667
|
+
* @remarks
|
|
188668
|
+
* [Api set: PowerPointApi 1.10]
|
|
188669
|
+
*/
|
|
188670
|
+
altTextTitle?: string;
|
|
188671
|
+
/**
|
|
188672
|
+
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
188673
|
+
*
|
|
188674
|
+
* @remarks
|
|
188675
|
+
* [Api set: PowerPointApi 1.10]
|
|
188676
|
+
*/
|
|
188677
|
+
creationId?: string | null;
|
|
186325
188678
|
/**
|
|
186326
188679
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
186327
188680
|
*
|
|
@@ -186336,6 +188689,16 @@ declare namespace PowerPoint {
|
|
|
186336
188689
|
* [Api set: PowerPointApi 1.3]
|
|
186337
188690
|
*/
|
|
186338
188691
|
id?: string;
|
|
188692
|
+
/**
|
|
188693
|
+
* Represents whether the shape is decorative or not.
|
|
188694
|
+
|
|
188695
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
188696
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
188697
|
+
*
|
|
188698
|
+
* @remarks
|
|
188699
|
+
* [Api set: PowerPointApi 1.10]
|
|
188700
|
+
*/
|
|
188701
|
+
isDecorative?: boolean;
|
|
186339
188702
|
/**
|
|
186340
188703
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
186341
188704
|
*
|
|
@@ -186363,6 +188726,14 @@ declare namespace PowerPoint {
|
|
|
186363
188726
|
* [Api set: PowerPointApi 1.4]
|
|
186364
188727
|
*/
|
|
186365
188728
|
name?: string;
|
|
188729
|
+
/**
|
|
188730
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
188731
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
188732
|
+
*
|
|
188733
|
+
* @remarks
|
|
188734
|
+
* [Api set: PowerPointApi 1.10]
|
|
188735
|
+
*/
|
|
188736
|
+
rotation?: number;
|
|
186366
188737
|
/**
|
|
186367
188738
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
186368
188739
|
*
|
|
@@ -186377,6 +188748,13 @@ declare namespace PowerPoint {
|
|
|
186377
188748
|
* [Api set: PowerPointApi 1.4]
|
|
186378
188749
|
*/
|
|
186379
188750
|
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
|
|
188751
|
+
/**
|
|
188752
|
+
* Specifies if the shape is visible.
|
|
188753
|
+
*
|
|
188754
|
+
* @remarks
|
|
188755
|
+
* [Api set: PowerPointApi 1.10]
|
|
188756
|
+
*/
|
|
188757
|
+
visible?: boolean;
|
|
186380
188758
|
/**
|
|
186381
188759
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
186382
188760
|
*
|
|
@@ -186523,6 +188901,23 @@ declare namespace PowerPoint {
|
|
|
186523
188901
|
*/
|
|
186524
188902
|
title?: string;
|
|
186525
188903
|
}
|
|
188904
|
+
/** An interface describing the data returned by calling `pageSetup.toJSON()`. */
|
|
188905
|
+
interface PageSetupData {
|
|
188906
|
+
/**
|
|
188907
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
188908
|
+
*
|
|
188909
|
+
* @remarks
|
|
188910
|
+
* [Api set: PowerPointApi 1.10]
|
|
188911
|
+
*/
|
|
188912
|
+
slideHeight?: number;
|
|
188913
|
+
/**
|
|
188914
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
188915
|
+
*
|
|
188916
|
+
* @remarks
|
|
188917
|
+
* [Api set: PowerPointApi 1.10]
|
|
188918
|
+
*/
|
|
188919
|
+
slideWidth?: number;
|
|
188920
|
+
}
|
|
186526
188921
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
186527
188922
|
interface SlideCollectionData {
|
|
186528
188923
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -186549,11 +188944,18 @@ declare namespace PowerPoint {
|
|
|
186549
188944
|
*/
|
|
186550
188945
|
$all?: boolean;
|
|
186551
188946
|
/**
|
|
186552
|
-
|
|
186553
|
-
|
|
186554
|
-
|
|
186555
|
-
|
|
186556
|
-
|
|
188947
|
+
* Returns the page setup information whose properties control slide setup attributes for the presentation.
|
|
188948
|
+
*
|
|
188949
|
+
* @remarks
|
|
188950
|
+
* [Api set: PowerPointApi 1.10]
|
|
188951
|
+
*/
|
|
188952
|
+
pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
|
|
188953
|
+
/**
|
|
188954
|
+
* Gets the properties of the presentation.
|
|
188955
|
+
*
|
|
188956
|
+
* @remarks
|
|
188957
|
+
* [Api set: PowerPointApi 1.7]
|
|
188958
|
+
*/
|
|
186557
188959
|
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
|
|
186558
188960
|
/**
|
|
186559
188961
|
* Gets the ID of the presentation.
|
|
@@ -186570,6 +188972,25 @@ declare namespace PowerPoint {
|
|
|
186570
188972
|
*/
|
|
186571
188973
|
title?: boolean;
|
|
186572
188974
|
}
|
|
188975
|
+
/**
|
|
188976
|
+
* Represents the adjustment values for a shape.
|
|
188977
|
+
*
|
|
188978
|
+
* @remarks
|
|
188979
|
+
* [Api set: PowerPointApi 1.10]
|
|
188980
|
+
*/
|
|
188981
|
+
interface AdjustmentsLoadOptions {
|
|
188982
|
+
/**
|
|
188983
|
+
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`).
|
|
188984
|
+
*/
|
|
188985
|
+
$all?: boolean;
|
|
188986
|
+
/**
|
|
188987
|
+
* Specifies the number of adjustment points.
|
|
188988
|
+
*
|
|
188989
|
+
* @remarks
|
|
188990
|
+
* [Api set: PowerPointApi 1.10]
|
|
188991
|
+
*/
|
|
188992
|
+
count?: boolean;
|
|
188993
|
+
}
|
|
186573
188994
|
/**
|
|
186574
188995
|
* Represents a custom XML part object.
|
|
186575
188996
|
*
|
|
@@ -186650,6 +189071,39 @@ declare namespace PowerPoint {
|
|
|
186650
189071
|
*/
|
|
186651
189072
|
namespaceUri?: boolean;
|
|
186652
189073
|
}
|
|
189074
|
+
/**
|
|
189075
|
+
* Represents a scoped collection of hyperlinks.
|
|
189076
|
+
*
|
|
189077
|
+
* @remarks
|
|
189078
|
+
* [Api set: PowerPointApi 1.10]
|
|
189079
|
+
*/
|
|
189080
|
+
interface HyperlinkScopedCollectionLoadOptions {
|
|
189081
|
+
/**
|
|
189082
|
+
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`).
|
|
189083
|
+
*/
|
|
189084
|
+
$all?: boolean;
|
|
189085
|
+
/**
|
|
189086
|
+
* For EACH ITEM in the collection: Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
|
|
189087
|
+
*
|
|
189088
|
+
* @remarks
|
|
189089
|
+
* [Api set: PowerPointApi 1.6]
|
|
189090
|
+
*/
|
|
189091
|
+
address?: boolean;
|
|
189092
|
+
/**
|
|
189093
|
+
* For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
|
|
189094
|
+
*
|
|
189095
|
+
* @remarks
|
|
189096
|
+
* [Api set: PowerPointApi 1.6]
|
|
189097
|
+
*/
|
|
189098
|
+
screenTip?: boolean;
|
|
189099
|
+
/**
|
|
189100
|
+
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
|
|
189101
|
+
*
|
|
189102
|
+
* @remarks
|
|
189103
|
+
* [Api set: PowerPointApi 1.10]
|
|
189104
|
+
*/
|
|
189105
|
+
type?: boolean;
|
|
189106
|
+
}
|
|
186653
189107
|
/**
|
|
186654
189108
|
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
186655
189109
|
*
|
|
@@ -186661,6 +189115,22 @@ declare namespace PowerPoint {
|
|
|
186661
189115
|
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`).
|
|
186662
189116
|
*/
|
|
186663
189117
|
$all?: boolean;
|
|
189118
|
+
/**
|
|
189119
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
189120
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
189121
|
+
*
|
|
189122
|
+
* @remarks
|
|
189123
|
+
* [Api set: PowerPointApi 1.10]
|
|
189124
|
+
*/
|
|
189125
|
+
style?: boolean;
|
|
189126
|
+
/**
|
|
189127
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
189128
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
189129
|
+
*
|
|
189130
|
+
* @remarks
|
|
189131
|
+
* [Api set: PowerPointApi 1.10]
|
|
189132
|
+
*/
|
|
189133
|
+
type?: boolean;
|
|
186664
189134
|
/**
|
|
186665
189135
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
186666
189136
|
*
|
|
@@ -186694,6 +189164,13 @@ declare namespace PowerPoint {
|
|
|
186694
189164
|
* [Api set: PowerPointApi 1.4]
|
|
186695
189165
|
*/
|
|
186696
189166
|
horizontalAlignment?: boolean;
|
|
189167
|
+
/**
|
|
189168
|
+
* Represents the indent level of the paragraph.
|
|
189169
|
+
*
|
|
189170
|
+
* @remarks
|
|
189171
|
+
* [Api set: PowerPointApi 1.10]
|
|
189172
|
+
*/
|
|
189173
|
+
indentLevel?: boolean;
|
|
186697
189174
|
}
|
|
186698
189175
|
/**
|
|
186699
189176
|
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
|
|
@@ -186988,6 +189465,13 @@ declare namespace PowerPoint {
|
|
|
186988
189465
|
* [Api set: PowerPointApi 1.6]
|
|
186989
189466
|
*/
|
|
186990
189467
|
screenTip?: boolean;
|
|
189468
|
+
/**
|
|
189469
|
+
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
|
|
189470
|
+
*
|
|
189471
|
+
* @remarks
|
|
189472
|
+
* [Api set: PowerPointApi 1.10]
|
|
189473
|
+
*/
|
|
189474
|
+
type?: boolean;
|
|
186991
189475
|
}
|
|
186992
189476
|
/**
|
|
186993
189477
|
* Represents the properties of a `placeholder` shape.
|
|
@@ -187041,6 +189525,13 @@ declare namespace PowerPoint {
|
|
|
187041
189525
|
* [Api set: PowerPointApi 1.6]
|
|
187042
189526
|
*/
|
|
187043
189527
|
screenTip?: boolean;
|
|
189528
|
+
/**
|
|
189529
|
+
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
|
|
189530
|
+
*
|
|
189531
|
+
* @remarks
|
|
189532
|
+
* [Api set: PowerPointApi 1.10]
|
|
189533
|
+
*/
|
|
189534
|
+
type?: boolean;
|
|
187044
189535
|
}
|
|
187045
189536
|
/**
|
|
187046
189537
|
* Represents the properties for a table cell border.
|
|
@@ -187094,46 +189585,46 @@ declare namespace PowerPoint {
|
|
|
187094
189585
|
*/
|
|
187095
189586
|
$all?: boolean;
|
|
187096
189587
|
/**
|
|
187097
|
-
|
|
187098
|
-
|
|
187099
|
-
|
|
187100
|
-
|
|
187101
|
-
|
|
189588
|
+
* Gets the bottom border.
|
|
189589
|
+
*
|
|
189590
|
+
* @remarks
|
|
189591
|
+
* [Api set: PowerPointApi 1.9]
|
|
189592
|
+
*/
|
|
187102
189593
|
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187103
189594
|
/**
|
|
187104
|
-
|
|
187105
|
-
|
|
187106
|
-
|
|
187107
|
-
|
|
187108
|
-
|
|
189595
|
+
* Gets the diagonal border (top-left to bottom-right).
|
|
189596
|
+
*
|
|
189597
|
+
* @remarks
|
|
189598
|
+
* [Api set: PowerPointApi 1.9]
|
|
189599
|
+
*/
|
|
187109
189600
|
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187110
189601
|
/**
|
|
187111
|
-
|
|
187112
|
-
|
|
187113
|
-
|
|
187114
|
-
|
|
187115
|
-
|
|
189602
|
+
* Gets the diagonal border (bottom-left to top-right).
|
|
189603
|
+
*
|
|
189604
|
+
* @remarks
|
|
189605
|
+
* [Api set: PowerPointApi 1.9]
|
|
189606
|
+
*/
|
|
187116
189607
|
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187117
189608
|
/**
|
|
187118
|
-
|
|
187119
|
-
|
|
187120
|
-
|
|
187121
|
-
|
|
187122
|
-
|
|
189609
|
+
* Gets the left border.
|
|
189610
|
+
*
|
|
189611
|
+
* @remarks
|
|
189612
|
+
* [Api set: PowerPointApi 1.9]
|
|
189613
|
+
*/
|
|
187123
189614
|
left?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187124
189615
|
/**
|
|
187125
|
-
|
|
187126
|
-
|
|
187127
|
-
|
|
187128
|
-
|
|
187129
|
-
|
|
189616
|
+
* Gets the right border.
|
|
189617
|
+
*
|
|
189618
|
+
* @remarks
|
|
189619
|
+
* [Api set: PowerPointApi 1.9]
|
|
189620
|
+
*/
|
|
187130
189621
|
right?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187131
189622
|
/**
|
|
187132
|
-
|
|
187133
|
-
|
|
187134
|
-
|
|
187135
|
-
|
|
187136
|
-
|
|
189623
|
+
* Gets the top border.
|
|
189624
|
+
*
|
|
189625
|
+
* @remarks
|
|
189626
|
+
* [Api set: PowerPointApi 1.9]
|
|
189627
|
+
*/
|
|
187137
189628
|
top?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
187138
189629
|
}
|
|
187139
189630
|
/**
|
|
@@ -187221,32 +189712,32 @@ declare namespace PowerPoint {
|
|
|
187221
189712
|
*/
|
|
187222
189713
|
$all?: boolean;
|
|
187223
189714
|
/**
|
|
187224
|
-
|
|
187225
|
-
|
|
187226
|
-
|
|
187227
|
-
|
|
187228
|
-
|
|
189715
|
+
* Gets the collection of borders for the table cell.
|
|
189716
|
+
*
|
|
189717
|
+
* @remarks
|
|
189718
|
+
* [Api set: PowerPointApi 1.9]
|
|
189719
|
+
*/
|
|
187229
189720
|
borders?: PowerPoint.Interfaces.BordersLoadOptions;
|
|
187230
189721
|
/**
|
|
187231
|
-
|
|
187232
|
-
|
|
187233
|
-
|
|
187234
|
-
|
|
187235
|
-
|
|
189722
|
+
* Gets the fill color of the table cell.
|
|
189723
|
+
*
|
|
189724
|
+
* @remarks
|
|
189725
|
+
* [Api set: PowerPointApi 1.9]
|
|
189726
|
+
*/
|
|
187236
189727
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
187237
189728
|
/**
|
|
187238
|
-
|
|
187239
|
-
|
|
187240
|
-
|
|
187241
|
-
|
|
187242
|
-
|
|
189729
|
+
* Gets the font of the table cell.
|
|
189730
|
+
*
|
|
189731
|
+
* @remarks
|
|
189732
|
+
* [Api set: PowerPointApi 1.9]
|
|
189733
|
+
*/
|
|
187243
189734
|
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
|
|
187244
189735
|
/**
|
|
187245
|
-
|
|
187246
|
-
|
|
187247
|
-
|
|
187248
|
-
|
|
187249
|
-
|
|
189736
|
+
* Gets the set of margins in the table cell.
|
|
189737
|
+
*
|
|
189738
|
+
* @remarks
|
|
189739
|
+
* [Api set: PowerPointApi 1.9]
|
|
189740
|
+
*/
|
|
187250
189741
|
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
|
|
187251
189742
|
/**
|
|
187252
189743
|
* Gets the number of table columns this cell spans across.
|
|
@@ -187327,32 +189818,32 @@ declare namespace PowerPoint {
|
|
|
187327
189818
|
*/
|
|
187328
189819
|
$all?: boolean;
|
|
187329
189820
|
/**
|
|
187330
|
-
|
|
187331
|
-
|
|
187332
|
-
|
|
187333
|
-
|
|
187334
|
-
|
|
189821
|
+
* For EACH ITEM in the collection: Gets the collection of borders for the table cell.
|
|
189822
|
+
*
|
|
189823
|
+
* @remarks
|
|
189824
|
+
* [Api set: PowerPointApi 1.9]
|
|
189825
|
+
*/
|
|
187335
189826
|
borders?: PowerPoint.Interfaces.BordersLoadOptions;
|
|
187336
189827
|
/**
|
|
187337
|
-
|
|
187338
|
-
|
|
187339
|
-
|
|
187340
|
-
|
|
187341
|
-
|
|
189828
|
+
* For EACH ITEM in the collection: Gets the fill color of the table cell.
|
|
189829
|
+
*
|
|
189830
|
+
* @remarks
|
|
189831
|
+
* [Api set: PowerPointApi 1.9]
|
|
189832
|
+
*/
|
|
187342
189833
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
187343
189834
|
/**
|
|
187344
|
-
|
|
187345
|
-
|
|
187346
|
-
|
|
187347
|
-
|
|
187348
|
-
|
|
189835
|
+
* For EACH ITEM in the collection: Gets the font of the table cell.
|
|
189836
|
+
*
|
|
189837
|
+
* @remarks
|
|
189838
|
+
* [Api set: PowerPointApi 1.9]
|
|
189839
|
+
*/
|
|
187349
189840
|
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
|
|
187350
189841
|
/**
|
|
187351
|
-
|
|
187352
|
-
|
|
187353
|
-
|
|
187354
|
-
|
|
187355
|
-
|
|
189842
|
+
* For EACH ITEM in the collection: Gets the set of margins in the table cell.
|
|
189843
|
+
*
|
|
189844
|
+
* @remarks
|
|
189845
|
+
* [Api set: PowerPointApi 1.9]
|
|
189846
|
+
*/
|
|
187356
189847
|
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
|
|
187357
189848
|
/**
|
|
187358
189849
|
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
|
|
@@ -187612,11 +190103,11 @@ declare namespace PowerPoint {
|
|
|
187612
190103
|
*/
|
|
187613
190104
|
$all?: boolean;
|
|
187614
190105
|
/**
|
|
187615
|
-
|
|
187616
|
-
|
|
187617
|
-
|
|
187618
|
-
|
|
187619
|
-
|
|
190106
|
+
* Gets the table style settings.
|
|
190107
|
+
*
|
|
190108
|
+
* @remarks
|
|
190109
|
+
* [Api set: PowerPointApi 1.9]
|
|
190110
|
+
*/
|
|
187620
190111
|
styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
|
|
187621
190112
|
/**
|
|
187622
190113
|
* Gets the number of columns in the table.
|
|
@@ -187652,11 +190143,18 @@ declare namespace PowerPoint {
|
|
|
187652
190143
|
*/
|
|
187653
190144
|
$all?: boolean;
|
|
187654
190145
|
/**
|
|
187655
|
-
|
|
187656
|
-
|
|
187657
|
-
|
|
187658
|
-
|
|
187659
|
-
|
|
190146
|
+
* For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
|
|
190147
|
+
*
|
|
190148
|
+
* @remarks
|
|
190149
|
+
* [Api set: PowerPointApi 1.10]
|
|
190150
|
+
*/
|
|
190151
|
+
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
|
|
190152
|
+
/**
|
|
190153
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
190154
|
+
*
|
|
190155
|
+
* @remarks
|
|
190156
|
+
* [Api set: PowerPointApi 1.4]
|
|
190157
|
+
*/
|
|
187660
190158
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
187661
190159
|
/**
|
|
187662
190160
|
* For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
|
|
@@ -187667,11 +190165,11 @@ declare namespace PowerPoint {
|
|
|
187667
190165
|
*/
|
|
187668
190166
|
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
187669
190167
|
/**
|
|
187670
|
-
|
|
187671
|
-
|
|
187672
|
-
|
|
187673
|
-
|
|
187674
|
-
|
|
190168
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
190169
|
+
*
|
|
190170
|
+
* @remarks
|
|
190171
|
+
* [Api set: PowerPointApi 1.4]
|
|
190172
|
+
*/
|
|
187675
190173
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
187676
190174
|
/**
|
|
187677
190175
|
* For EACH ITEM in the collection: Returns the parent group of this shape.
|
|
@@ -187691,11 +190189,39 @@ declare namespace PowerPoint {
|
|
|
187691
190189
|
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
187692
190190
|
/**
|
|
187693
190191
|
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
190192
|
+
*
|
|
190193
|
+
* @remarks
|
|
190194
|
+
* [Api set: PowerPointApi 1.4]
|
|
190195
|
+
*/
|
|
190196
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
190197
|
+
/**
|
|
190198
|
+
* For EACH ITEM in the collection: The alt text description of the Shape.
|
|
190199
|
+
|
|
190200
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
190201
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
187694
190202
|
*
|
|
187695
190203
|
* @remarks
|
|
187696
|
-
* [Api set: PowerPointApi 1.
|
|
190204
|
+
* [Api set: PowerPointApi 1.10]
|
|
187697
190205
|
*/
|
|
187698
|
-
|
|
190206
|
+
altTextDescription?: boolean;
|
|
190207
|
+
/**
|
|
190208
|
+
* For EACH ITEM in the collection: The alt text title of the Shape.
|
|
190209
|
+
|
|
190210
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
190211
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
190212
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
190213
|
+
*
|
|
190214
|
+
* @remarks
|
|
190215
|
+
* [Api set: PowerPointApi 1.10]
|
|
190216
|
+
*/
|
|
190217
|
+
altTextTitle?: boolean;
|
|
190218
|
+
/**
|
|
190219
|
+
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
190220
|
+
*
|
|
190221
|
+
* @remarks
|
|
190222
|
+
* [Api set: PowerPointApi 1.10]
|
|
190223
|
+
*/
|
|
190224
|
+
creationId?: boolean;
|
|
187699
190225
|
/**
|
|
187700
190226
|
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
187701
190227
|
*
|
|
@@ -187710,6 +190236,16 @@ declare namespace PowerPoint {
|
|
|
187710
190236
|
* [Api set: PowerPointApi 1.3]
|
|
187711
190237
|
*/
|
|
187712
190238
|
id?: boolean;
|
|
190239
|
+
/**
|
|
190240
|
+
* For EACH ITEM in the collection: Represents whether the shape is decorative or not.
|
|
190241
|
+
|
|
190242
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
190243
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
190244
|
+
*
|
|
190245
|
+
* @remarks
|
|
190246
|
+
* [Api set: PowerPointApi 1.10]
|
|
190247
|
+
*/
|
|
190248
|
+
isDecorative?: boolean;
|
|
187713
190249
|
/**
|
|
187714
190250
|
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
187715
190251
|
*
|
|
@@ -187737,6 +190273,14 @@ declare namespace PowerPoint {
|
|
|
187737
190273
|
* [Api set: PowerPointApi 1.4]
|
|
187738
190274
|
*/
|
|
187739
190275
|
name?: boolean;
|
|
190276
|
+
/**
|
|
190277
|
+
* For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
190278
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
190279
|
+
*
|
|
190280
|
+
* @remarks
|
|
190281
|
+
* [Api set: PowerPointApi 1.10]
|
|
190282
|
+
*/
|
|
190283
|
+
rotation?: boolean;
|
|
187740
190284
|
/**
|
|
187741
190285
|
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
187742
190286
|
*
|
|
@@ -187751,6 +190295,13 @@ declare namespace PowerPoint {
|
|
|
187751
190295
|
* [Api set: PowerPointApi 1.4]
|
|
187752
190296
|
*/
|
|
187753
190297
|
type?: boolean;
|
|
190298
|
+
/**
|
|
190299
|
+
* For EACH ITEM in the collection: Specifies if the shape is visible.
|
|
190300
|
+
*
|
|
190301
|
+
* @remarks
|
|
190302
|
+
* [Api set: PowerPointApi 1.10]
|
|
190303
|
+
*/
|
|
190304
|
+
visible?: boolean;
|
|
187754
190305
|
/**
|
|
187755
190306
|
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
187756
190307
|
*
|
|
@@ -187767,6 +190318,188 @@ declare namespace PowerPoint {
|
|
|
187767
190318
|
*/
|
|
187768
190319
|
zOrderPosition?: boolean;
|
|
187769
190320
|
}
|
|
190321
|
+
/**
|
|
190322
|
+
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
|
|
190323
|
+
*
|
|
190324
|
+
* @remarks
|
|
190325
|
+
* [Api set: PowerPointApi 1.10]
|
|
190326
|
+
*/
|
|
190327
|
+
interface SlideBackgroundGradientFillLoadOptions {
|
|
190328
|
+
/**
|
|
190329
|
+
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`).
|
|
190330
|
+
*/
|
|
190331
|
+
$all?: boolean;
|
|
190332
|
+
/**
|
|
190333
|
+
* Specifies the type of gradient fill.
|
|
190334
|
+
*
|
|
190335
|
+
* @remarks
|
|
190336
|
+
* [Api set: PowerPointApi 1.10]
|
|
190337
|
+
*/
|
|
190338
|
+
type?: boolean;
|
|
190339
|
+
}
|
|
190340
|
+
/**
|
|
190341
|
+
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
|
|
190342
|
+
*
|
|
190343
|
+
* @remarks
|
|
190344
|
+
* [Api set: PowerPointApi 1.10]
|
|
190345
|
+
*/
|
|
190346
|
+
interface SlideBackgroundPatternFillLoadOptions {
|
|
190347
|
+
/**
|
|
190348
|
+
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`).
|
|
190349
|
+
*/
|
|
190350
|
+
$all?: boolean;
|
|
190351
|
+
/**
|
|
190352
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
190353
|
+
*
|
|
190354
|
+
* @remarks
|
|
190355
|
+
* [Api set: PowerPointApi 1.10]
|
|
190356
|
+
*/
|
|
190357
|
+
backgroundColor?: boolean;
|
|
190358
|
+
/**
|
|
190359
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
190360
|
+
*
|
|
190361
|
+
* @remarks
|
|
190362
|
+
* [Api set: PowerPointApi 1.10]
|
|
190363
|
+
*/
|
|
190364
|
+
foregroundColor?: boolean;
|
|
190365
|
+
/**
|
|
190366
|
+
* Specifies the pattern type.
|
|
190367
|
+
*
|
|
190368
|
+
* @remarks
|
|
190369
|
+
* [Api set: PowerPointApi 1.10]
|
|
190370
|
+
*/
|
|
190371
|
+
pattern?: boolean;
|
|
190372
|
+
}
|
|
190373
|
+
/**
|
|
190374
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
|
|
190375
|
+
*
|
|
190376
|
+
* @remarks
|
|
190377
|
+
* [Api set: PowerPointApi 1.10]
|
|
190378
|
+
*/
|
|
190379
|
+
interface SlideBackgroundPictureOrTextureFillLoadOptions {
|
|
190380
|
+
/**
|
|
190381
|
+
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`).
|
|
190382
|
+
*/
|
|
190383
|
+
$all?: boolean;
|
|
190384
|
+
/**
|
|
190385
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
190386
|
+
*
|
|
190387
|
+
* @remarks
|
|
190388
|
+
* [Api set: PowerPointApi 1.10]
|
|
190389
|
+
*/
|
|
190390
|
+
transparency?: boolean;
|
|
190391
|
+
}
|
|
190392
|
+
/**
|
|
190393
|
+
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
|
|
190394
|
+
*
|
|
190395
|
+
* @remarks
|
|
190396
|
+
* [Api set: PowerPointApi 1.10]
|
|
190397
|
+
*/
|
|
190398
|
+
interface SlideBackgroundSolidFillLoadOptions {
|
|
190399
|
+
/**
|
|
190400
|
+
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`).
|
|
190401
|
+
*/
|
|
190402
|
+
$all?: boolean;
|
|
190403
|
+
/**
|
|
190404
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
190405
|
+
*
|
|
190406
|
+
* @remarks
|
|
190407
|
+
* [Api set: PowerPointApi 1.10]
|
|
190408
|
+
*/
|
|
190409
|
+
color?: boolean;
|
|
190410
|
+
/**
|
|
190411
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
190412
|
+
*
|
|
190413
|
+
* @remarks
|
|
190414
|
+
* [Api set: PowerPointApi 1.10]
|
|
190415
|
+
*/
|
|
190416
|
+
transparency?: boolean;
|
|
190417
|
+
}
|
|
190418
|
+
/**
|
|
190419
|
+
* Represents the fill formatting of a slide background object.
|
|
190420
|
+
*
|
|
190421
|
+
* @remarks
|
|
190422
|
+
* [Api set: PowerPointApi 1.10]
|
|
190423
|
+
*/
|
|
190424
|
+
interface SlideBackgroundFillLoadOptions {
|
|
190425
|
+
/**
|
|
190426
|
+
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`).
|
|
190427
|
+
*/
|
|
190428
|
+
$all?: boolean;
|
|
190429
|
+
/**
|
|
190430
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
190431
|
+
*
|
|
190432
|
+
* @remarks
|
|
190433
|
+
* [Api set: PowerPointApi 1.10]
|
|
190434
|
+
*/
|
|
190435
|
+
type?: boolean;
|
|
190436
|
+
}
|
|
190437
|
+
/**
|
|
190438
|
+
* Represents a background of a slide.
|
|
190439
|
+
*
|
|
190440
|
+
* @remarks
|
|
190441
|
+
* [Api set: PowerPointApi 1.10]
|
|
190442
|
+
*/
|
|
190443
|
+
interface SlideBackgroundLoadOptions {
|
|
190444
|
+
/**
|
|
190445
|
+
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`).
|
|
190446
|
+
*/
|
|
190447
|
+
$all?: boolean;
|
|
190448
|
+
/**
|
|
190449
|
+
* Returns the fill formatting of the background.
|
|
190450
|
+
*
|
|
190451
|
+
* @remarks
|
|
190452
|
+
* [Api set: PowerPointApi 1.10]
|
|
190453
|
+
*/
|
|
190454
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
190455
|
+
/**
|
|
190456
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
190457
|
+
*
|
|
190458
|
+
* @remarks
|
|
190459
|
+
* [Api set: PowerPointApi 1.10]
|
|
190460
|
+
*/
|
|
190461
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
190462
|
+
/**
|
|
190463
|
+
* Specifies if the slide background follows the slide master background.
|
|
190464
|
+
*
|
|
190465
|
+
* @remarks
|
|
190466
|
+
* [Api set: PowerPointApi 1.10]
|
|
190467
|
+
*/
|
|
190468
|
+
isMasterBackgroundFollowed?: boolean;
|
|
190469
|
+
}
|
|
190470
|
+
/**
|
|
190471
|
+
* Represents the background of a slide layout.
|
|
190472
|
+
*
|
|
190473
|
+
* @remarks
|
|
190474
|
+
* [Api set: PowerPointApi 1.10]
|
|
190475
|
+
*/
|
|
190476
|
+
interface SlideLayoutBackgroundLoadOptions {
|
|
190477
|
+
/**
|
|
190478
|
+
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`).
|
|
190479
|
+
*/
|
|
190480
|
+
$all?: boolean;
|
|
190481
|
+
/**
|
|
190482
|
+
* Returns the fill formatting of the background.
|
|
190483
|
+
*
|
|
190484
|
+
* @remarks
|
|
190485
|
+
* [Api set: PowerPointApi 1.10]
|
|
190486
|
+
*/
|
|
190487
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
190488
|
+
/**
|
|
190489
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
190490
|
+
*
|
|
190491
|
+
* @remarks
|
|
190492
|
+
* [Api set: PowerPointApi 1.10]
|
|
190493
|
+
*/
|
|
190494
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
190495
|
+
/**
|
|
190496
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
190497
|
+
*
|
|
190498
|
+
* @remarks
|
|
190499
|
+
* [Api set: PowerPointApi 1.10]
|
|
190500
|
+
*/
|
|
190501
|
+
isMasterBackgroundFollowed?: boolean;
|
|
190502
|
+
}
|
|
187770
190503
|
/**
|
|
187771
190504
|
* Represents the layout of a slide.
|
|
187772
190505
|
*
|
|
@@ -187778,6 +190511,13 @@ declare namespace PowerPoint {
|
|
|
187778
190511
|
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`).
|
|
187779
190512
|
*/
|
|
187780
190513
|
$all?: boolean;
|
|
190514
|
+
/**
|
|
190515
|
+
* Gets the background of the slide layout.
|
|
190516
|
+
*
|
|
190517
|
+
* @remarks
|
|
190518
|
+
* [Api set: PowerPointApi 1.10]
|
|
190519
|
+
*/
|
|
190520
|
+
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
|
|
187781
190521
|
/**
|
|
187782
190522
|
* Gets the unique ID of the slide layout.
|
|
187783
190523
|
*
|
|
@@ -187811,6 +190551,13 @@ declare namespace PowerPoint {
|
|
|
187811
190551
|
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`).
|
|
187812
190552
|
*/
|
|
187813
190553
|
$all?: boolean;
|
|
190554
|
+
/**
|
|
190555
|
+
* For EACH ITEM in the collection: Gets the background of the slide layout.
|
|
190556
|
+
*
|
|
190557
|
+
* @remarks
|
|
190558
|
+
* [Api set: PowerPointApi 1.10]
|
|
190559
|
+
*/
|
|
190560
|
+
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
|
|
187814
190561
|
/**
|
|
187815
190562
|
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
|
|
187816
190563
|
*
|
|
@@ -187833,6 +190580,25 @@ declare namespace PowerPoint {
|
|
|
187833
190580
|
*/
|
|
187834
190581
|
type?: boolean;
|
|
187835
190582
|
}
|
|
190583
|
+
/**
|
|
190584
|
+
* Represents the background of a slide master.
|
|
190585
|
+
*
|
|
190586
|
+
* @remarks
|
|
190587
|
+
* [Api set: PowerPointApi 1.10]
|
|
190588
|
+
*/
|
|
190589
|
+
interface SlideMasterBackgroundLoadOptions {
|
|
190590
|
+
/**
|
|
190591
|
+
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`).
|
|
190592
|
+
*/
|
|
190593
|
+
$all?: boolean;
|
|
190594
|
+
/**
|
|
190595
|
+
* Returns the fill formatting of the background.
|
|
190596
|
+
*
|
|
190597
|
+
* @remarks
|
|
190598
|
+
* [Api set: PowerPointApi 1.10]
|
|
190599
|
+
*/
|
|
190600
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
190601
|
+
}
|
|
187836
190602
|
/**
|
|
187837
190603
|
* Represents the Slide Master of a slide.
|
|
187838
190604
|
*
|
|
@@ -187844,6 +190610,13 @@ declare namespace PowerPoint {
|
|
|
187844
190610
|
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`).
|
|
187845
190611
|
*/
|
|
187846
190612
|
$all?: boolean;
|
|
190613
|
+
/**
|
|
190614
|
+
* Gets the background of the Slide Master.
|
|
190615
|
+
*
|
|
190616
|
+
* @remarks
|
|
190617
|
+
* [Api set: PowerPointApi 1.10]
|
|
190618
|
+
*/
|
|
190619
|
+
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
|
|
187847
190620
|
/**
|
|
187848
190621
|
* Gets the unique ID of the Slide Master.
|
|
187849
190622
|
*
|
|
@@ -187923,6 +190696,13 @@ declare namespace PowerPoint {
|
|
|
187923
190696
|
*/
|
|
187924
190697
|
$all?: boolean;
|
|
187925
190698
|
/**
|
|
190699
|
+
* Gets the background of the slide.
|
|
190700
|
+
*
|
|
190701
|
+
* @remarks
|
|
190702
|
+
* [Api set: PowerPointApi 1.10]
|
|
190703
|
+
*/
|
|
190704
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
190705
|
+
/**
|
|
187926
190706
|
* Gets the layout of the slide.
|
|
187927
190707
|
*
|
|
187928
190708
|
* @remarks
|
|
@@ -187963,50 +190743,85 @@ declare namespace PowerPoint {
|
|
|
187963
190743
|
*/
|
|
187964
190744
|
$all?: boolean;
|
|
187965
190745
|
/**
|
|
187966
|
-
|
|
187967
|
-
|
|
187968
|
-
|
|
187969
|
-
|
|
187970
|
-
|
|
190746
|
+
* For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
|
|
190747
|
+
*
|
|
190748
|
+
* @remarks
|
|
190749
|
+
* [Api set: PowerPointApi 1.10]
|
|
190750
|
+
*/
|
|
190751
|
+
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
|
|
190752
|
+
/**
|
|
190753
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
190754
|
+
*
|
|
190755
|
+
* @remarks
|
|
190756
|
+
* [Api set: PowerPointApi 1.5]
|
|
190757
|
+
*/
|
|
187971
190758
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
187972
190759
|
/**
|
|
187973
|
-
|
|
190760
|
+
* For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
|
|
187974
190761
|
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
187975
|
-
|
|
187976
|
-
|
|
187977
|
-
|
|
187978
|
-
|
|
190762
|
+
*
|
|
190763
|
+
* @remarks
|
|
190764
|
+
* [Api set: PowerPointApi 1.8]
|
|
190765
|
+
*/
|
|
187979
190766
|
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
187980
190767
|
/**
|
|
187981
|
-
|
|
187982
|
-
|
|
187983
|
-
|
|
187984
|
-
|
|
187985
|
-
|
|
190768
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
190769
|
+
*
|
|
190770
|
+
* @remarks
|
|
190771
|
+
* [Api set: PowerPointApi 1.5]
|
|
190772
|
+
*/
|
|
187986
190773
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
187987
190774
|
/**
|
|
187988
|
-
|
|
190775
|
+
* For EACH ITEM in the collection: Returns the parent group of this shape.
|
|
187989
190776
|
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
190777
|
+
*
|
|
190778
|
+
* @remarks
|
|
190779
|
+
* [Api set: PowerPointApi 1.8]
|
|
190780
|
+
*/
|
|
190781
|
+
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
190782
|
+
/**
|
|
190783
|
+
* For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
|
|
190784
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
190785
|
+
*
|
|
190786
|
+
* @remarks
|
|
190787
|
+
* [Api set: PowerPointApi 1.8]
|
|
190788
|
+
*/
|
|
190789
|
+
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
190790
|
+
/**
|
|
190791
|
+
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
190792
|
+
*
|
|
190793
|
+
* @remarks
|
|
190794
|
+
* [Api set: PowerPointApi 1.5]
|
|
190795
|
+
*/
|
|
190796
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
190797
|
+
/**
|
|
190798
|
+
* For EACH ITEM in the collection: The alt text description of the Shape.
|
|
190799
|
+
|
|
190800
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
190801
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
187990
190802
|
*
|
|
187991
190803
|
* @remarks
|
|
187992
|
-
* [Api set: PowerPointApi 1.
|
|
190804
|
+
* [Api set: PowerPointApi 1.10]
|
|
187993
190805
|
*/
|
|
187994
|
-
|
|
190806
|
+
altTextDescription?: boolean;
|
|
187995
190807
|
/**
|
|
187996
|
-
* For EACH ITEM in the collection:
|
|
187997
|
-
|
|
190808
|
+
* For EACH ITEM in the collection: The alt text title of the Shape.
|
|
190809
|
+
|
|
190810
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
190811
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
190812
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
187998
190813
|
*
|
|
187999
190814
|
* @remarks
|
|
188000
|
-
* [Api set: PowerPointApi 1.
|
|
190815
|
+
* [Api set: PowerPointApi 1.10]
|
|
188001
190816
|
*/
|
|
188002
|
-
|
|
190817
|
+
altTextTitle?: boolean;
|
|
188003
190818
|
/**
|
|
188004
|
-
* For EACH ITEM in the collection:
|
|
190819
|
+
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
188005
190820
|
*
|
|
188006
190821
|
* @remarks
|
|
188007
|
-
* [Api set: PowerPointApi 1.
|
|
190822
|
+
* [Api set: PowerPointApi 1.10]
|
|
188008
190823
|
*/
|
|
188009
|
-
|
|
190824
|
+
creationId?: boolean;
|
|
188010
190825
|
/**
|
|
188011
190826
|
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
188012
190827
|
*
|
|
@@ -188021,6 +190836,16 @@ declare namespace PowerPoint {
|
|
|
188021
190836
|
* [Api set: PowerPointApi 1.3]
|
|
188022
190837
|
*/
|
|
188023
190838
|
id?: boolean;
|
|
190839
|
+
/**
|
|
190840
|
+
* For EACH ITEM in the collection: Represents whether the shape is decorative or not.
|
|
190841
|
+
|
|
190842
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
190843
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
190844
|
+
*
|
|
190845
|
+
* @remarks
|
|
190846
|
+
* [Api set: PowerPointApi 1.10]
|
|
190847
|
+
*/
|
|
190848
|
+
isDecorative?: boolean;
|
|
188024
190849
|
/**
|
|
188025
190850
|
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
188026
190851
|
*
|
|
@@ -188048,6 +190873,14 @@ declare namespace PowerPoint {
|
|
|
188048
190873
|
* [Api set: PowerPointApi 1.4]
|
|
188049
190874
|
*/
|
|
188050
190875
|
name?: boolean;
|
|
190876
|
+
/**
|
|
190877
|
+
* For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
190878
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
190879
|
+
*
|
|
190880
|
+
* @remarks
|
|
190881
|
+
* [Api set: PowerPointApi 1.10]
|
|
190882
|
+
*/
|
|
190883
|
+
rotation?: boolean;
|
|
188051
190884
|
/**
|
|
188052
190885
|
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
188053
190886
|
*
|
|
@@ -188062,6 +190895,13 @@ declare namespace PowerPoint {
|
|
|
188062
190895
|
* [Api set: PowerPointApi 1.4]
|
|
188063
190896
|
*/
|
|
188064
190897
|
type?: boolean;
|
|
190898
|
+
/**
|
|
190899
|
+
* For EACH ITEM in the collection: Specifies if the shape is visible.
|
|
190900
|
+
*
|
|
190901
|
+
* @remarks
|
|
190902
|
+
* [Api set: PowerPointApi 1.10]
|
|
190903
|
+
*/
|
|
190904
|
+
visible?: boolean;
|
|
188065
190905
|
/**
|
|
188066
190906
|
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
188067
190907
|
*
|
|
@@ -188096,6 +190936,13 @@ declare namespace PowerPoint {
|
|
|
188096
190936
|
* [Api set: PowerPointApi 1.8]
|
|
188097
190937
|
*/
|
|
188098
190938
|
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
190939
|
+
/**
|
|
190940
|
+
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
|
|
190941
|
+
*
|
|
190942
|
+
* @remarks
|
|
190943
|
+
* [Api set: PowerPointApi 1.10]
|
|
190944
|
+
*/
|
|
190945
|
+
creationId?: boolean;
|
|
188099
190946
|
/**
|
|
188100
190947
|
* Gets the unique ID of the shape group.
|
|
188101
190948
|
*
|
|
@@ -188170,50 +191017,85 @@ declare namespace PowerPoint {
|
|
|
188170
191017
|
*/
|
|
188171
191018
|
$all?: boolean;
|
|
188172
191019
|
/**
|
|
188173
|
-
|
|
188174
|
-
|
|
188175
|
-
|
|
188176
|
-
|
|
188177
|
-
|
|
191020
|
+
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
|
|
191021
|
+
*
|
|
191022
|
+
* @remarks
|
|
191023
|
+
* [Api set: PowerPointApi 1.10]
|
|
191024
|
+
*/
|
|
191025
|
+
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
|
|
191026
|
+
/**
|
|
191027
|
+
* Returns the fill formatting of this shape.
|
|
191028
|
+
*
|
|
191029
|
+
* @remarks
|
|
191030
|
+
* [Api set: PowerPointApi 1.4]
|
|
191031
|
+
*/
|
|
188178
191032
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
188179
191033
|
/**
|
|
188180
|
-
|
|
191034
|
+
* Returns the `ShapeGroup` associated with the shape.
|
|
188181
191035
|
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
188182
|
-
|
|
188183
|
-
|
|
188184
|
-
|
|
188185
|
-
|
|
191036
|
+
*
|
|
191037
|
+
* @remarks
|
|
191038
|
+
* [Api set: PowerPointApi 1.8]
|
|
191039
|
+
*/
|
|
188186
191040
|
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
188187
191041
|
/**
|
|
188188
|
-
|
|
188189
|
-
|
|
188190
|
-
|
|
188191
|
-
|
|
188192
|
-
|
|
191042
|
+
* Returns the line formatting of this shape.
|
|
191043
|
+
*
|
|
191044
|
+
* @remarks
|
|
191045
|
+
* [Api set: PowerPointApi 1.4]
|
|
191046
|
+
*/
|
|
188193
191047
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
188194
191048
|
/**
|
|
188195
|
-
|
|
191049
|
+
* Returns the parent group of this shape.
|
|
188196
191050
|
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
191051
|
+
*
|
|
191052
|
+
* @remarks
|
|
191053
|
+
* [Api set: PowerPointApi 1.8]
|
|
191054
|
+
*/
|
|
191055
|
+
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
191056
|
+
/**
|
|
191057
|
+
* Returns the properties that apply specifically to this placeholder.
|
|
191058
|
+
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
191059
|
+
*
|
|
191060
|
+
* @remarks
|
|
191061
|
+
* [Api set: PowerPointApi 1.8]
|
|
191062
|
+
*/
|
|
191063
|
+
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
191064
|
+
/**
|
|
191065
|
+
* Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
191066
|
+
*
|
|
191067
|
+
* @remarks
|
|
191068
|
+
* [Api set: PowerPointApi 1.4]
|
|
191069
|
+
*/
|
|
191070
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
191071
|
+
/**
|
|
191072
|
+
* The alt text description of the Shape.
|
|
191073
|
+
|
|
191074
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
191075
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
188197
191076
|
*
|
|
188198
191077
|
* @remarks
|
|
188199
|
-
* [Api set: PowerPointApi 1.
|
|
191078
|
+
* [Api set: PowerPointApi 1.10]
|
|
188200
191079
|
*/
|
|
188201
|
-
|
|
191080
|
+
altTextDescription?: boolean;
|
|
188202
191081
|
/**
|
|
188203
|
-
*
|
|
188204
|
-
|
|
191082
|
+
* The alt text title of the Shape.
|
|
191083
|
+
|
|
191084
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
191085
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
191086
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
188205
191087
|
*
|
|
188206
191088
|
* @remarks
|
|
188207
|
-
* [Api set: PowerPointApi 1.
|
|
191089
|
+
* [Api set: PowerPointApi 1.10]
|
|
188208
191090
|
*/
|
|
188209
|
-
|
|
191091
|
+
altTextTitle?: boolean;
|
|
188210
191092
|
/**
|
|
188211
|
-
*
|
|
191093
|
+
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
188212
191094
|
*
|
|
188213
191095
|
* @remarks
|
|
188214
|
-
* [Api set: PowerPointApi 1.
|
|
191096
|
+
* [Api set: PowerPointApi 1.10]
|
|
188215
191097
|
*/
|
|
188216
|
-
|
|
191098
|
+
creationId?: boolean;
|
|
188217
191099
|
/**
|
|
188218
191100
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
188219
191101
|
*
|
|
@@ -188228,6 +191110,16 @@ declare namespace PowerPoint {
|
|
|
188228
191110
|
* [Api set: PowerPointApi 1.3]
|
|
188229
191111
|
*/
|
|
188230
191112
|
id?: boolean;
|
|
191113
|
+
/**
|
|
191114
|
+
* Represents whether the shape is decorative or not.
|
|
191115
|
+
|
|
191116
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
191117
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
191118
|
+
*
|
|
191119
|
+
* @remarks
|
|
191120
|
+
* [Api set: PowerPointApi 1.10]
|
|
191121
|
+
*/
|
|
191122
|
+
isDecorative?: boolean;
|
|
188231
191123
|
/**
|
|
188232
191124
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
188233
191125
|
*
|
|
@@ -188255,6 +191147,14 @@ declare namespace PowerPoint {
|
|
|
188255
191147
|
* [Api set: PowerPointApi 1.4]
|
|
188256
191148
|
*/
|
|
188257
191149
|
name?: boolean;
|
|
191150
|
+
/**
|
|
191151
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
191152
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
191153
|
+
*
|
|
191154
|
+
* @remarks
|
|
191155
|
+
* [Api set: PowerPointApi 1.10]
|
|
191156
|
+
*/
|
|
191157
|
+
rotation?: boolean;
|
|
188258
191158
|
/**
|
|
188259
191159
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
188260
191160
|
*
|
|
@@ -188269,6 +191169,13 @@ declare namespace PowerPoint {
|
|
|
188269
191169
|
* [Api set: PowerPointApi 1.4]
|
|
188270
191170
|
*/
|
|
188271
191171
|
type?: boolean;
|
|
191172
|
+
/**
|
|
191173
|
+
* Specifies if the shape is visible.
|
|
191174
|
+
*
|
|
191175
|
+
* @remarks
|
|
191176
|
+
* [Api set: PowerPointApi 1.10]
|
|
191177
|
+
*/
|
|
191178
|
+
visible?: boolean;
|
|
188272
191179
|
/**
|
|
188273
191180
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
188274
191181
|
*
|
|
@@ -188495,29 +191402,62 @@ declare namespace PowerPoint {
|
|
|
188495
191402
|
title?: boolean;
|
|
188496
191403
|
}
|
|
188497
191404
|
/**
|
|
188498
|
-
* Represents the
|
|
191405
|
+
* Represents the page setup information for the presentation.
|
|
188499
191406
|
*
|
|
188500
191407
|
* @remarks
|
|
188501
|
-
* [Api set: PowerPointApi 1.
|
|
191408
|
+
* [Api set: PowerPointApi 1.10]
|
|
188502
191409
|
*/
|
|
188503
|
-
interface
|
|
191410
|
+
interface PageSetupLoadOptions {
|
|
188504
191411
|
/**
|
|
188505
191412
|
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`).
|
|
188506
191413
|
*/
|
|
188507
191414
|
$all?: boolean;
|
|
188508
191415
|
/**
|
|
188509
|
-
*
|
|
191416
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
188510
191417
|
*
|
|
188511
191418
|
* @remarks
|
|
188512
|
-
* [Api set: PowerPointApi 1.
|
|
191419
|
+
* [Api set: PowerPointApi 1.10]
|
|
188513
191420
|
*/
|
|
188514
|
-
|
|
191421
|
+
slideHeight?: boolean;
|
|
188515
191422
|
/**
|
|
188516
|
-
*
|
|
191423
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
188517
191424
|
*
|
|
188518
191425
|
* @remarks
|
|
188519
|
-
* [Api set: PowerPointApi 1.
|
|
191426
|
+
* [Api set: PowerPointApi 1.10]
|
|
188520
191427
|
*/
|
|
191428
|
+
slideWidth?: boolean;
|
|
191429
|
+
}
|
|
191430
|
+
/**
|
|
191431
|
+
* Represents the collection of slides in the presentation.
|
|
191432
|
+
*
|
|
191433
|
+
* @remarks
|
|
191434
|
+
* [Api set: PowerPointApi 1.2]
|
|
191435
|
+
*/
|
|
191436
|
+
interface SlideCollectionLoadOptions {
|
|
191437
|
+
/**
|
|
191438
|
+
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`).
|
|
191439
|
+
*/
|
|
191440
|
+
$all?: boolean;
|
|
191441
|
+
/**
|
|
191442
|
+
* For EACH ITEM in the collection: Gets the background of the slide.
|
|
191443
|
+
*
|
|
191444
|
+
* @remarks
|
|
191445
|
+
* [Api set: PowerPointApi 1.10]
|
|
191446
|
+
*/
|
|
191447
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
191448
|
+
/**
|
|
191449
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
191450
|
+
*
|
|
191451
|
+
* @remarks
|
|
191452
|
+
* [Api set: PowerPointApi 1.3]
|
|
191453
|
+
*/
|
|
191454
|
+
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
191455
|
+
/**
|
|
191456
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
191457
|
+
*
|
|
191458
|
+
* @remarks
|
|
191459
|
+
* [Api set: PowerPointApi 1.3]
|
|
191460
|
+
*/
|
|
188521
191461
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
188522
191462
|
/**
|
|
188523
191463
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
@@ -188546,18 +191486,25 @@ declare namespace PowerPoint {
|
|
|
188546
191486
|
*/
|
|
188547
191487
|
$all?: boolean;
|
|
188548
191488
|
/**
|
|
188549
|
-
|
|
188550
|
-
|
|
188551
|
-
|
|
188552
|
-
|
|
188553
|
-
|
|
191489
|
+
* For EACH ITEM in the collection: Gets the background of the slide.
|
|
191490
|
+
*
|
|
191491
|
+
* @remarks
|
|
191492
|
+
* [Api set: PowerPointApi 1.10]
|
|
191493
|
+
*/
|
|
191494
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
191495
|
+
/**
|
|
191496
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
191497
|
+
*
|
|
191498
|
+
* @remarks
|
|
191499
|
+
* [Api set: PowerPointApi 1.5]
|
|
191500
|
+
*/
|
|
188554
191501
|
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
188555
191502
|
/**
|
|
188556
|
-
|
|
188557
|
-
|
|
188558
|
-
|
|
188559
|
-
|
|
188560
|
-
|
|
191503
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
191504
|
+
*
|
|
191505
|
+
* @remarks
|
|
191506
|
+
* [Api set: PowerPointApi 1.5]
|
|
191507
|
+
*/
|
|
188561
191508
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
188562
191509
|
/**
|
|
188563
191510
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
@@ -188585,6 +191532,13 @@ declare namespace PowerPoint {
|
|
|
188585
191532
|
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`).
|
|
188586
191533
|
*/
|
|
188587
191534
|
$all?: boolean;
|
|
191535
|
+
/**
|
|
191536
|
+
* For EACH ITEM in the collection: Gets the background of the Slide Master.
|
|
191537
|
+
*
|
|
191538
|
+
* @remarks
|
|
191539
|
+
* [Api set: PowerPointApi 1.10]
|
|
191540
|
+
*/
|
|
191541
|
+
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
|
|
188588
191542
|
/**
|
|
188589
191543
|
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
|
|
188590
191544
|
*
|