@types/office-js-preview 1.0.564 → 1.0.566
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +616 -1103
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -23435,6 +23435,73 @@ declare namespace Office {
|
|
|
23435
23435
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
23436
23436
|
*/
|
|
23437
23437
|
interface SpamReportingEventCompletedOptions {
|
|
23438
|
+
/**
|
|
23439
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
23440
|
+
* this property specifies the ID of the task pane that opens after the message is processed.
|
|
23441
|
+
*
|
|
23442
|
+
* @remarks
|
|
23443
|
+
*
|
|
23444
|
+
* [Api set: Mailbox preview]
|
|
23445
|
+
*
|
|
23446
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
23447
|
+
*
|
|
23448
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
23449
|
+
*
|
|
23450
|
+
* **Important**:
|
|
23451
|
+
*
|
|
23452
|
+
* - The `commandId` option is currently in preview in Outlook on the web and on Windows (new and classic). To preview this feature in classic Outlook on Windows,
|
|
23453
|
+
* install Version 2411 (Build 18227.20034) or later. Then, join the
|
|
23454
|
+
* {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
|
|
23455
|
+
* and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
|
|
23456
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview | Open a task pane after reporting a message (preview)}.
|
|
23457
|
+
*
|
|
23458
|
+
* - The `commandId` value must match the task pane ID specified in the manifest of your add-in. In an add-in only manifest,
|
|
23459
|
+
* the ID is specified in the `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element that represents the task pane.
|
|
23460
|
+
* The `commandId` property isn't currently supported in a spam-reporting add-in that uses a unified manifest for Microsoft 365.
|
|
23461
|
+
*
|
|
23462
|
+
* - If you configure the `commandId` option in the `event.completed` call, a post-processing dialog isn't shown to the user
|
|
23463
|
+
* even if the `showPostProcessingDialog` option is specified in the call.
|
|
23464
|
+
*
|
|
23465
|
+
* - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
|
|
23466
|
+
*
|
|
23467
|
+
* @beta
|
|
23468
|
+
*/
|
|
23469
|
+
commandId?: string;
|
|
23470
|
+
/**
|
|
23471
|
+
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
23472
|
+
* this property specifies any JSON data passed to the add-in's task pane after the message is processed.
|
|
23473
|
+
*
|
|
23474
|
+
* @remarks
|
|
23475
|
+
*
|
|
23476
|
+
* [Api set: Mailbox preview]
|
|
23477
|
+
*
|
|
23478
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
23479
|
+
*
|
|
23480
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
23481
|
+
*
|
|
23482
|
+
* **Important**:
|
|
23483
|
+
*
|
|
23484
|
+
* - The `contextData` option is currently in preview in Outlook on the web and on Windows (new and classic). To preview this feature in classic Outlook on Windows,
|
|
23485
|
+
* install Version 2411 (Build 18227.20034) or later. Then, join the
|
|
23486
|
+
* {@link https://techcommunity.microsoft.com/blog/microsoft365insiderblog/join-the-microsoft-365-insider-program-on-windows/4206638 | Microsoft 365 Insider program}
|
|
23487
|
+
* and select the **Beta Channel** option. To learn how to implement this in your spam-reporting add-in, see
|
|
23488
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting#open-a-task-pane-after-reporting-a-message-preview | Open a task pane after reporting a message (preview)}.
|
|
23489
|
+
*
|
|
23490
|
+
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
23491
|
+
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
23492
|
+
*
|
|
23493
|
+
* - If you configure the `commandId` and `contextData` options in the `event.completed` call, a post-processing dialog isn't shown to the user
|
|
23494
|
+
* even if the `showPostProcessingDialog` option is specified in the call.
|
|
23495
|
+
*
|
|
23496
|
+
* - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
|
|
23497
|
+
*
|
|
23498
|
+
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
23499
|
+
* of your task pane. If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using
|
|
23500
|
+
* `JSON.parse()` once you retrieve it.
|
|
23501
|
+
*
|
|
23502
|
+
* @beta
|
|
23503
|
+
*/
|
|
23504
|
+
contextData?: any;
|
|
23438
23505
|
/**
|
|
23439
23506
|
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,
|
|
23440
23507
|
* this property specifies the Outlook mailbox folder to which the message will be moved.
|
|
@@ -23477,6 +23544,9 @@ declare namespace Office {
|
|
|
23477
23544
|
* - If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
23478
23545
|
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
23479
23546
|
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
23547
|
+
*
|
|
23548
|
+
* - If you configure the `commandId` and `contextData` options in the `event.completed` call to open a task pane after a user selects the **Report** option from the preprocessing dialog,
|
|
23549
|
+
* you must set the `moveItemTo` option to `Office.MailboxEnums.MoveSpamItemTo.NoMove`. Otherwise, the task pane won't open.
|
|
23480
23550
|
*/
|
|
23481
23551
|
moveItemTo?: MailboxEnums.MoveSpamItemTo;
|
|
23482
23552
|
/**
|
|
@@ -23538,6 +23608,9 @@ declare namespace Office {
|
|
|
23538
23608
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
23539
23609
|
*
|
|
23540
23610
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
23611
|
+
*
|
|
23612
|
+
* **Important**: If you configure the `commandId` and `contextData` options in the `event.completed` call to open a task pane after a user selects the **Report** option from the preprocessing dialog,
|
|
23613
|
+
* a post-processing dialog isn't shown to the user. This behavior applies even if the `showPostProcessingDialog` is specified in the `event.completed` call.
|
|
23541
23614
|
*/
|
|
23542
23615
|
showPostProcessingDialog?: object;
|
|
23543
23616
|
}
|
|
@@ -94832,8 +94905,7 @@ declare namespace Word {
|
|
|
94832
94905
|
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
94833
94906
|
*
|
|
94834
94907
|
* @remarks
|
|
94835
|
-
* [Api set:
|
|
94836
|
-
* @beta
|
|
94908
|
+
* [Api set: WordApiDesktop 1.2]
|
|
94837
94909
|
*/
|
|
94838
94910
|
readonly shapes: Word.ShapeCollection;
|
|
94839
94911
|
/**
|
|
@@ -97427,8 +97499,7 @@ declare namespace Word {
|
|
|
97427
97499
|
* Gets the active window for the document.
|
|
97428
97500
|
*
|
|
97429
97501
|
* @remarks
|
|
97430
|
-
* [Api set:
|
|
97431
|
-
* @beta
|
|
97502
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97432
97503
|
*/
|
|
97433
97504
|
readonly activeWindow: Word.Window;
|
|
97434
97505
|
/**
|
|
@@ -97477,8 +97548,7 @@ declare namespace Word {
|
|
|
97477
97548
|
* Gets the collection of `Word.Window` objects for the document.
|
|
97478
97549
|
*
|
|
97479
97550
|
* @remarks
|
|
97480
|
-
* [Api set:
|
|
97481
|
-
* @beta
|
|
97551
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97482
97552
|
*/
|
|
97483
97553
|
readonly windows: Word.WindowCollection;
|
|
97484
97554
|
/**
|
|
@@ -97559,8 +97629,7 @@ declare namespace Word {
|
|
|
97559
97629
|
* Displays revision marks that indicate where the specified document differs from another document.
|
|
97560
97630
|
*
|
|
97561
97631
|
* @remarks
|
|
97562
|
-
* [Api set:
|
|
97563
|
-
* @beta
|
|
97632
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97564
97633
|
*
|
|
97565
97634
|
* @param base64File Required. The Base64-encoded content of the document with which the specified document is compared.
|
|
97566
97635
|
* @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API.
|
|
@@ -99932,8 +100001,7 @@ declare namespace Word {
|
|
|
99932
100001
|
* Represents a page in the document. `Page` objects manage the page layout and content.
|
|
99933
100002
|
*
|
|
99934
100003
|
* @remarks
|
|
99935
|
-
* [Api set:
|
|
99936
|
-
* @beta
|
|
100004
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99937
100005
|
*/
|
|
99938
100006
|
class Page extends OfficeExtension.ClientObject {
|
|
99939
100007
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -99942,48 +100010,42 @@ declare namespace Word {
|
|
|
99942
100010
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
99943
100011
|
*
|
|
99944
100012
|
* @remarks
|
|
99945
|
-
* [Api set:
|
|
99946
|
-
* @beta
|
|
100013
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99947
100014
|
*/
|
|
99948
100015
|
readonly height: number;
|
|
99949
100016
|
/**
|
|
99950
100017
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
99951
100018
|
*
|
|
99952
100019
|
* @remarks
|
|
99953
|
-
* [Api set:
|
|
99954
|
-
* @beta
|
|
100020
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99955
100021
|
*/
|
|
99956
100022
|
readonly index: number;
|
|
99957
100023
|
/**
|
|
99958
100024
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
99959
100025
|
*
|
|
99960
100026
|
* @remarks
|
|
99961
|
-
* [Api set:
|
|
99962
|
-
* @beta
|
|
100027
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99963
100028
|
*/
|
|
99964
100029
|
readonly width: number;
|
|
99965
100030
|
/**
|
|
99966
100031
|
* Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one.
|
|
99967
100032
|
*
|
|
99968
100033
|
* @remarks
|
|
99969
|
-
* [Api set:
|
|
99970
|
-
* @beta
|
|
100034
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99971
100035
|
*/
|
|
99972
100036
|
getNext(): Word.Page;
|
|
99973
100037
|
/**
|
|
99974
100038
|
* Gets the next page. If this page is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99975
100039
|
*
|
|
99976
100040
|
* @remarks
|
|
99977
|
-
* [Api set:
|
|
99978
|
-
* @beta
|
|
100041
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99979
100042
|
*/
|
|
99980
100043
|
getNextOrNullObject(): Word.Page;
|
|
99981
100044
|
/**
|
|
99982
100045
|
* Gets the whole page, or the starting or ending point of the page, as a range.
|
|
99983
100046
|
*
|
|
99984
100047
|
* @remarks
|
|
99985
|
-
* [Api set:
|
|
99986
|
-
* @beta
|
|
100048
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99987
100049
|
*
|
|
99988
100050
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
99989
100051
|
*/
|
|
@@ -100027,8 +100089,7 @@ declare namespace Word {
|
|
|
100027
100089
|
* Represents the collection of page.
|
|
100028
100090
|
*
|
|
100029
100091
|
* @remarks
|
|
100030
|
-
* [Api set:
|
|
100031
|
-
* @beta
|
|
100092
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100032
100093
|
*/
|
|
100033
100094
|
class PageCollection extends OfficeExtension.ClientObject {
|
|
100034
100095
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100039,28 +100100,16 @@ declare namespace Word {
|
|
|
100039
100100
|
* Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100040
100101
|
*
|
|
100041
100102
|
* @remarks
|
|
100042
|
-
* [Api set:
|
|
100043
|
-
* @beta
|
|
100103
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100044
100104
|
*/
|
|
100045
100105
|
getFirst(): Word.Page;
|
|
100046
100106
|
/**
|
|
100047
100107
|
* Gets the first page in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100048
100108
|
*
|
|
100049
100109
|
* @remarks
|
|
100050
|
-
* [Api set:
|
|
100051
|
-
* @beta
|
|
100110
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100052
100111
|
*/
|
|
100053
100112
|
getFirstOrNullObject(): Word.Page;
|
|
100054
|
-
/**
|
|
100055
|
-
* Gets a Page object by its index in the collection.
|
|
100056
|
-
*
|
|
100057
|
-
* @remarks
|
|
100058
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100059
|
-
* @beta
|
|
100060
|
-
*
|
|
100061
|
-
* @param index A number that identifies the index location of a Page object.
|
|
100062
|
-
*/
|
|
100063
|
-
getItem(index: number): Word.Page;
|
|
100064
100113
|
/**
|
|
100065
100114
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100066
100115
|
*
|
|
@@ -100097,8 +100146,7 @@ declare namespace Word {
|
|
|
100097
100146
|
* Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window.
|
|
100098
100147
|
*
|
|
100099
100148
|
* @remarks
|
|
100100
|
-
* [Api set:
|
|
100101
|
-
* @beta
|
|
100149
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100102
100150
|
*/
|
|
100103
100151
|
class Pane extends OfficeExtension.ClientObject {
|
|
100104
100152
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100107,32 +100155,28 @@ declare namespace Word {
|
|
|
100107
100155
|
* Gets the collection of pages in the pane.
|
|
100108
100156
|
*
|
|
100109
100157
|
* @remarks
|
|
100110
|
-
* [Api set:
|
|
100111
|
-
* @beta
|
|
100158
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100112
100159
|
*/
|
|
100113
100160
|
readonly pages: Word.PageCollection;
|
|
100114
100161
|
/**
|
|
100115
100162
|
* Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned.
|
|
100116
100163
|
*
|
|
100117
100164
|
* @remarks
|
|
100118
|
-
* [Api set:
|
|
100119
|
-
* @beta
|
|
100165
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100120
100166
|
*/
|
|
100121
100167
|
readonly pagesEnclosingViewport: Word.PageCollection;
|
|
100122
100168
|
/**
|
|
100123
100169
|
* Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one.
|
|
100124
100170
|
*
|
|
100125
100171
|
* @remarks
|
|
100126
|
-
* [Api set:
|
|
100127
|
-
* @beta
|
|
100172
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100128
100173
|
*/
|
|
100129
100174
|
getNext(): Word.Pane;
|
|
100130
100175
|
/**
|
|
100131
100176
|
* Gets the next pane. If this pane is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100132
100177
|
*
|
|
100133
100178
|
* @remarks
|
|
100134
|
-
* [Api set:
|
|
100135
|
-
* @beta
|
|
100179
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100136
100180
|
*/
|
|
100137
100181
|
getNextOrNullObject(): Word.Pane;
|
|
100138
100182
|
/**
|
|
@@ -100168,8 +100212,7 @@ declare namespace Word {
|
|
|
100168
100212
|
* Represents the collection of pane.
|
|
100169
100213
|
*
|
|
100170
100214
|
* @remarks
|
|
100171
|
-
* [Api set:
|
|
100172
|
-
* @beta
|
|
100215
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100173
100216
|
*/
|
|
100174
100217
|
class PaneCollection extends OfficeExtension.ClientObject {
|
|
100175
100218
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100180,28 +100223,16 @@ declare namespace Word {
|
|
|
100180
100223
|
* Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100181
100224
|
*
|
|
100182
100225
|
* @remarks
|
|
100183
|
-
* [Api set:
|
|
100184
|
-
* @beta
|
|
100226
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100185
100227
|
*/
|
|
100186
100228
|
getFirst(): Word.Pane;
|
|
100187
100229
|
/**
|
|
100188
100230
|
* Gets the first pane in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100189
100231
|
*
|
|
100190
100232
|
* @remarks
|
|
100191
|
-
* [Api set:
|
|
100192
|
-
* @beta
|
|
100233
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100193
100234
|
*/
|
|
100194
100235
|
getFirstOrNullObject(): Word.Pane;
|
|
100195
|
-
/**
|
|
100196
|
-
* Gets a Pane object by its index in the collection.
|
|
100197
|
-
*
|
|
100198
|
-
* @remarks
|
|
100199
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100200
|
-
* @beta
|
|
100201
|
-
*
|
|
100202
|
-
* @param index A number that identifies the index location of a Pane object.
|
|
100203
|
-
*/
|
|
100204
|
-
getItem(index: number): Word.Pane;
|
|
100205
100236
|
/**
|
|
100206
100237
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100207
100238
|
*
|
|
@@ -100232,8 +100263,7 @@ declare namespace Word {
|
|
|
100232
100263
|
* Represents the window that displays the document. A window can be split to contain multiple reading panes.
|
|
100233
100264
|
*
|
|
100234
100265
|
* @remarks
|
|
100235
|
-
* [Api set:
|
|
100236
|
-
* @beta
|
|
100266
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100237
100267
|
*/
|
|
100238
100268
|
class Window extends OfficeExtension.ClientObject {
|
|
100239
100269
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100242,16 +100272,14 @@ declare namespace Word {
|
|
|
100242
100272
|
* Gets the active pane in the window.
|
|
100243
100273
|
*
|
|
100244
100274
|
* @remarks
|
|
100245
|
-
* [Api set:
|
|
100246
|
-
* @beta
|
|
100275
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100247
100276
|
*/
|
|
100248
100277
|
readonly activePane: Word.Pane;
|
|
100249
100278
|
/**
|
|
100250
100279
|
* Gets the collection of panes in the window.
|
|
100251
100280
|
*
|
|
100252
100281
|
* @remarks
|
|
100253
|
-
* [Api set:
|
|
100254
|
-
* @beta
|
|
100282
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100255
100283
|
*/
|
|
100256
100284
|
readonly panes: Word.PaneCollection;
|
|
100257
100285
|
/**
|
|
@@ -100287,8 +100315,7 @@ declare namespace Word {
|
|
|
100287
100315
|
* Represents the collection of window objects.
|
|
100288
100316
|
*
|
|
100289
100317
|
* @remarks
|
|
100290
|
-
* [Api set:
|
|
100291
|
-
* @beta
|
|
100318
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100292
100319
|
*/
|
|
100293
100320
|
class WindowCollection extends OfficeExtension.ClientObject {
|
|
100294
100321
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100299,28 +100326,16 @@ declare namespace Word {
|
|
|
100299
100326
|
* Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100300
100327
|
*
|
|
100301
100328
|
* @remarks
|
|
100302
|
-
* [Api set:
|
|
100303
|
-
* @beta
|
|
100329
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100304
100330
|
*/
|
|
100305
100331
|
getFirst(): Word.Window;
|
|
100306
100332
|
/**
|
|
100307
100333
|
* Gets the first window in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100308
100334
|
*
|
|
100309
100335
|
* @remarks
|
|
100310
|
-
* [Api set:
|
|
100311
|
-
* @beta
|
|
100336
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100312
100337
|
*/
|
|
100313
100338
|
getFirstOrNullObject(): Word.Window;
|
|
100314
|
-
/**
|
|
100315
|
-
* Gets a Window object by its index in the collection.
|
|
100316
|
-
*
|
|
100317
|
-
* @remarks
|
|
100318
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100319
|
-
* @beta
|
|
100320
|
-
*
|
|
100321
|
-
* @param index A number that identifies the index location of a Window object.
|
|
100322
|
-
*/
|
|
100323
|
-
getItem(index: number): Word.Window;
|
|
100324
100339
|
/**
|
|
100325
100340
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100326
100341
|
*
|
|
@@ -100479,8 +100494,7 @@ declare namespace Word {
|
|
|
100479
100494
|
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
100480
100495
|
*
|
|
100481
100496
|
* @remarks
|
|
100482
|
-
* [Api set:
|
|
100483
|
-
* @beta
|
|
100497
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100484
100498
|
*/
|
|
100485
100499
|
readonly shapes: Word.ShapeCollection;
|
|
100486
100500
|
/**
|
|
@@ -100795,8 +100809,7 @@ declare namespace Word {
|
|
|
100795
100809
|
* Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.
|
|
100796
100810
|
*
|
|
100797
100811
|
* @remarks
|
|
100798
|
-
* [Api set:
|
|
100799
|
-
* @beta
|
|
100812
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100800
100813
|
*
|
|
100801
100814
|
* @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200).
|
|
100802
100815
|
*/
|
|
@@ -100829,8 +100842,7 @@ declare namespace Word {
|
|
|
100829
100842
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.
|
|
100830
100843
|
*
|
|
100831
100844
|
* @remarks
|
|
100832
|
-
* [Api set:
|
|
100833
|
-
* @beta
|
|
100845
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100834
100846
|
*
|
|
100835
100847
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100836
100848
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -100840,8 +100852,7 @@ declare namespace Word {
|
|
|
100840
100852
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.
|
|
100841
100853
|
*
|
|
100842
100854
|
* @remarks
|
|
100843
|
-
* [Api set:
|
|
100844
|
-
* @beta
|
|
100855
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100845
100856
|
*
|
|
100846
100857
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100847
100858
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -100891,8 +100902,7 @@ declare namespace Word {
|
|
|
100891
100902
|
* Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.
|
|
100892
100903
|
*
|
|
100893
100904
|
* @remarks
|
|
100894
|
-
* [Api set:
|
|
100895
|
-
* @beta
|
|
100905
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100896
100906
|
*
|
|
100897
100907
|
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
100898
100908
|
* @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
|
|
@@ -100924,8 +100934,7 @@ declare namespace Word {
|
|
|
100924
100934
|
* Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.
|
|
100925
100935
|
*
|
|
100926
100936
|
* @remarks
|
|
100927
|
-
* [Api set:
|
|
100928
|
-
* @beta
|
|
100937
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100929
100938
|
*
|
|
100930
100939
|
* @param text Optional. The text to insert into the text box.
|
|
100931
100940
|
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
@@ -101353,8 +101362,7 @@ declare namespace Word {
|
|
|
101353
101362
|
* Gets the collection of pages in the range.
|
|
101354
101363
|
*
|
|
101355
101364
|
* @remarks
|
|
101356
|
-
* [Api set:
|
|
101357
|
-
* @beta
|
|
101365
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101358
101366
|
*/
|
|
101359
101367
|
readonly pages: Word.PageCollection;
|
|
101360
101368
|
/**
|
|
@@ -101419,8 +101427,7 @@ declare namespace Word {
|
|
|
101419
101427
|
* Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
101420
101428
|
*
|
|
101421
101429
|
* @remarks
|
|
101422
|
-
* [Api set:
|
|
101423
|
-
* @beta
|
|
101430
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101424
101431
|
*/
|
|
101425
101432
|
readonly shapes: Word.ShapeCollection;
|
|
101426
101433
|
/**
|
|
@@ -101663,8 +101670,7 @@ declare namespace Word {
|
|
|
101663
101670
|
* Inserts a floating canvas in front of text with its anchor at the beginning of the range.
|
|
101664
101671
|
*
|
|
101665
101672
|
* @remarks
|
|
101666
|
-
* [Api set:
|
|
101667
|
-
* @beta
|
|
101673
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101668
101674
|
*
|
|
101669
101675
|
* @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200).
|
|
101670
101676
|
*/
|
|
@@ -101777,8 +101783,7 @@ declare namespace Word {
|
|
|
101777
101783
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the range.
|
|
101778
101784
|
*
|
|
101779
101785
|
* @remarks
|
|
101780
|
-
* [Api set:
|
|
101781
|
-
* @beta
|
|
101786
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101782
101787
|
*
|
|
101783
101788
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101784
101789
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -101788,8 +101793,7 @@ declare namespace Word {
|
|
|
101788
101793
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the range.
|
|
101789
101794
|
*
|
|
101790
101795
|
* @remarks
|
|
101791
|
-
* [Api set:
|
|
101792
|
-
* @beta
|
|
101796
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101793
101797
|
*
|
|
101794
101798
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101795
101799
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -101839,8 +101843,7 @@ declare namespace Word {
|
|
|
101839
101843
|
* Inserts a floating picture in front of text with its anchor at the beginning of the range.
|
|
101840
101844
|
*
|
|
101841
101845
|
* @remarks
|
|
101842
|
-
* [Api set:
|
|
101843
|
-
* @beta
|
|
101846
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101844
101847
|
*
|
|
101845
101848
|
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
101846
101849
|
* @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
|
|
@@ -101872,8 +101875,7 @@ declare namespace Word {
|
|
|
101872
101875
|
* Inserts a floating text box in front of text with its anchor at the beginning of the range.
|
|
101873
101876
|
*
|
|
101874
101877
|
* @remarks
|
|
101875
|
-
* [Api set:
|
|
101876
|
-
* @beta
|
|
101878
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101877
101879
|
*
|
|
101878
101880
|
* @param text Optional. The text to insert into the text box.
|
|
101879
101881
|
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
@@ -102088,40 +102090,35 @@ declare namespace Word {
|
|
|
102088
102090
|
* Specifies the options to determine location and size when inserting a shape.
|
|
102089
102091
|
*
|
|
102090
102092
|
* @remarks
|
|
102091
|
-
* [Api set:
|
|
102092
|
-
* @beta
|
|
102093
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102093
102094
|
*/
|
|
102094
102095
|
interface InsertShapeOptions {
|
|
102095
102096
|
/**
|
|
102096
102097
|
* Represents the height of the shape being inserted.
|
|
102097
102098
|
*
|
|
102098
102099
|
* @remarks
|
|
102099
|
-
* [Api set:
|
|
102100
|
-
* @beta
|
|
102100
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102101
102101
|
*/
|
|
102102
102102
|
height?: number;
|
|
102103
102103
|
/**
|
|
102104
102104
|
* Represents the left position of the shape being inserted.
|
|
102105
102105
|
*
|
|
102106
102106
|
* @remarks
|
|
102107
|
-
* [Api set:
|
|
102108
|
-
* @beta
|
|
102107
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102109
102108
|
*/
|
|
102110
102109
|
left?: number;
|
|
102111
102110
|
/**
|
|
102112
102111
|
* Represents the top position of the shape being inserted.
|
|
102113
102112
|
*
|
|
102114
102113
|
* @remarks
|
|
102115
|
-
* [Api set:
|
|
102116
|
-
* @beta
|
|
102114
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102117
102115
|
*/
|
|
102118
102116
|
top?: number;
|
|
102119
102117
|
/**
|
|
102120
102118
|
* Represents the width of the shape being inserted.
|
|
102121
102119
|
*
|
|
102122
102120
|
* @remarks
|
|
102123
|
-
* [Api set:
|
|
102124
|
-
* @beta
|
|
102121
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102125
102122
|
*/
|
|
102126
102123
|
width?: number;
|
|
102127
102124
|
}
|
|
@@ -104631,11 +104628,10 @@ declare namespace Word {
|
|
|
104631
104628
|
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
104632
104629
|
}
|
|
104633
104630
|
/**
|
|
104634
|
-
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
104631
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
104635
104632
|
*
|
|
104636
104633
|
* @remarks
|
|
104637
|
-
* [Api set:
|
|
104638
|
-
* @beta
|
|
104634
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104639
104635
|
*/
|
|
104640
104636
|
class Shape extends OfficeExtension.ClientObject {
|
|
104641
104637
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -104644,160 +104640,140 @@ declare namespace Word {
|
|
|
104644
104640
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
104645
104641
|
*
|
|
104646
104642
|
* @remarks
|
|
104647
|
-
* [Api set:
|
|
104648
|
-
* @beta
|
|
104643
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104649
104644
|
*/
|
|
104650
104645
|
readonly body: Word.Body;
|
|
104651
104646
|
/**
|
|
104652
104647
|
* Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}.
|
|
104653
104648
|
*
|
|
104654
104649
|
* @remarks
|
|
104655
|
-
* [Api set:
|
|
104656
|
-
* @beta
|
|
104650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104657
104651
|
*/
|
|
104658
104652
|
readonly canvas: Word.Canvas;
|
|
104659
104653
|
/**
|
|
104660
104654
|
* Returns the fill formatting of the shape.
|
|
104661
104655
|
*
|
|
104662
104656
|
* @remarks
|
|
104663
|
-
* [Api set:
|
|
104664
|
-
* @beta
|
|
104657
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104665
104658
|
*/
|
|
104666
104659
|
readonly fill: Word.ShapeFill;
|
|
104667
104660
|
/**
|
|
104668
104661
|
* Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
|
|
104669
104662
|
*
|
|
104670
104663
|
* @remarks
|
|
104671
|
-
* [Api set:
|
|
104672
|
-
* @beta
|
|
104664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104673
104665
|
*/
|
|
104674
104666
|
readonly parentCanvas: Word.Shape;
|
|
104675
104667
|
/**
|
|
104676
104668
|
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
|
|
104677
104669
|
*
|
|
104678
104670
|
* @remarks
|
|
104679
|
-
* [Api set:
|
|
104680
|
-
* @beta
|
|
104671
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104681
104672
|
*/
|
|
104682
104673
|
readonly parentGroup: Word.Shape;
|
|
104683
104674
|
/**
|
|
104684
104675
|
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}.
|
|
104685
104676
|
*
|
|
104686
104677
|
* @remarks
|
|
104687
|
-
* [Api set:
|
|
104688
|
-
* @beta
|
|
104678
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104689
104679
|
*/
|
|
104690
104680
|
readonly shapeGroup: Word.ShapeGroup;
|
|
104691
104681
|
/**
|
|
104692
104682
|
* Gets the text frame object of the shape.
|
|
104693
104683
|
*
|
|
104694
104684
|
* @remarks
|
|
104695
|
-
* [Api set:
|
|
104696
|
-
* @beta
|
|
104685
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104697
104686
|
*/
|
|
104698
104687
|
readonly textFrame: Word.TextFrame;
|
|
104699
104688
|
/**
|
|
104700
104689
|
* Returns the text wrap formatting of the shape.
|
|
104701
104690
|
*
|
|
104702
104691
|
* @remarks
|
|
104703
|
-
* [Api set:
|
|
104704
|
-
* @beta
|
|
104692
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104705
104693
|
*/
|
|
104706
104694
|
readonly textWrap: Word.ShapeTextWrap;
|
|
104707
104695
|
/**
|
|
104708
104696
|
* Specifies whether a given shape can overlap other shapes.
|
|
104709
104697
|
*
|
|
104710
104698
|
* @remarks
|
|
104711
|
-
* [Api set:
|
|
104712
|
-
* @beta
|
|
104699
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104713
104700
|
*/
|
|
104714
104701
|
allowOverlap: boolean;
|
|
104715
104702
|
/**
|
|
104716
104703
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
104717
104704
|
*
|
|
104718
104705
|
* @remarks
|
|
104719
|
-
* [Api set:
|
|
104720
|
-
* @beta
|
|
104706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104721
104707
|
*/
|
|
104722
104708
|
geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
104723
104709
|
/**
|
|
104724
104710
|
* The height, in points, of the shape.
|
|
104725
104711
|
*
|
|
104726
104712
|
* @remarks
|
|
104727
|
-
* [Api set:
|
|
104728
|
-
* @beta
|
|
104713
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104729
104714
|
*/
|
|
104730
104715
|
height: number;
|
|
104731
104716
|
/**
|
|
104732
104717
|
* Gets an integer that represents the shape identifier.
|
|
104733
104718
|
*
|
|
104734
104719
|
* @remarks
|
|
104735
|
-
* [Api set:
|
|
104736
|
-
* @beta
|
|
104720
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104737
104721
|
*/
|
|
104738
104722
|
readonly id: number;
|
|
104739
104723
|
/**
|
|
104740
104724
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
104741
104725
|
*
|
|
104742
104726
|
* @remarks
|
|
104743
|
-
* [Api set:
|
|
104744
|
-
* @beta
|
|
104727
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104745
104728
|
*/
|
|
104746
104729
|
readonly isChild: boolean;
|
|
104747
104730
|
/**
|
|
104748
104731
|
* The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
104749
104732
|
*
|
|
104750
104733
|
* @remarks
|
|
104751
|
-
* [Api set:
|
|
104752
|
-
* @beta
|
|
104734
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104753
104735
|
*/
|
|
104754
104736
|
left: number;
|
|
104755
104737
|
/**
|
|
104756
104738
|
* The name of the shape.
|
|
104757
104739
|
*
|
|
104758
104740
|
* @remarks
|
|
104759
|
-
* [Api set:
|
|
104760
|
-
* @beta
|
|
104741
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104761
104742
|
*/
|
|
104762
104743
|
name: string;
|
|
104763
104744
|
/**
|
|
104764
104745
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
104765
104746
|
*
|
|
104766
104747
|
* @remarks
|
|
104767
|
-
* [Api set:
|
|
104768
|
-
* @beta
|
|
104748
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104769
104749
|
*/
|
|
104770
104750
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
104771
104751
|
/**
|
|
104772
104752
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
104773
104753
|
*
|
|
104774
104754
|
* @remarks
|
|
104775
|
-
* [Api set:
|
|
104776
|
-
* @beta
|
|
104755
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104777
104756
|
*/
|
|
104778
104757
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
104779
104758
|
/**
|
|
104780
104759
|
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
104781
104760
|
*
|
|
104782
104761
|
* @remarks
|
|
104783
|
-
* [Api set:
|
|
104784
|
-
* @beta
|
|
104762
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104785
104763
|
*/
|
|
104786
104764
|
top: number;
|
|
104787
104765
|
/**
|
|
104788
104766
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
104789
104767
|
*
|
|
104790
104768
|
* @remarks
|
|
104791
|
-
* [Api set:
|
|
104792
|
-
* @beta
|
|
104769
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104793
104770
|
*/
|
|
104794
104771
|
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
|
|
104795
104772
|
/**
|
|
104796
104773
|
* The width, in points, of the shape.
|
|
104797
104774
|
*
|
|
104798
104775
|
* @remarks
|
|
104799
|
-
* [Api set:
|
|
104800
|
-
* @beta
|
|
104776
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104801
104777
|
*/
|
|
104802
104778
|
width: number;
|
|
104803
104779
|
/**
|
|
@@ -104812,16 +104788,14 @@ declare namespace Word {
|
|
|
104812
104788
|
* Deletes the shape and its content.
|
|
104813
104789
|
*
|
|
104814
104790
|
* @remarks
|
|
104815
|
-
* [Api set:
|
|
104816
|
-
* @beta
|
|
104791
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104817
104792
|
*/
|
|
104818
104793
|
delete(): void;
|
|
104819
104794
|
/**
|
|
104820
104795
|
* Moves the shape horizontally by the number of points.
|
|
104821
104796
|
*
|
|
104822
104797
|
* @remarks
|
|
104823
|
-
* [Api set:
|
|
104824
|
-
* @beta
|
|
104798
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104825
104799
|
*
|
|
104826
104800
|
* @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left.
|
|
104827
104801
|
*/
|
|
@@ -104830,8 +104804,7 @@ declare namespace Word {
|
|
|
104830
104804
|
* Moves the shape vertically by the number of points.
|
|
104831
104805
|
*
|
|
104832
104806
|
* @remarks
|
|
104833
|
-
* [Api set:
|
|
104834
|
-
* @beta
|
|
104807
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104835
104808
|
*
|
|
104836
104809
|
* @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down.
|
|
104837
104810
|
*/
|
|
@@ -104840,8 +104813,7 @@ declare namespace Word {
|
|
|
104840
104813
|
* Selects the shape.
|
|
104841
104814
|
*
|
|
104842
104815
|
* @remarks
|
|
104843
|
-
* [Api set:
|
|
104844
|
-
* @beta
|
|
104816
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104845
104817
|
*
|
|
104846
104818
|
* @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false.
|
|
104847
104819
|
*/
|
|
@@ -104885,8 +104857,7 @@ declare namespace Word {
|
|
|
104885
104857
|
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
104886
104858
|
*
|
|
104887
104859
|
* @remarks
|
|
104888
|
-
* [Api set:
|
|
104889
|
-
* @beta
|
|
104860
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104890
104861
|
*/
|
|
104891
104862
|
class ShapeGroup extends OfficeExtension.ClientObject {
|
|
104892
104863
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -104895,24 +104866,21 @@ declare namespace Word {
|
|
|
104895
104866
|
* Gets the Shape object associated with the group.
|
|
104896
104867
|
*
|
|
104897
104868
|
* @remarks
|
|
104898
|
-
* [Api set:
|
|
104899
|
-
* @beta
|
|
104869
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104900
104870
|
*/
|
|
104901
104871
|
readonly shape: Word.Shape;
|
|
104902
104872
|
/**
|
|
104903
104873
|
* Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
|
|
104904
104874
|
*
|
|
104905
104875
|
* @remarks
|
|
104906
|
-
* [Api set:
|
|
104907
|
-
* @beta
|
|
104876
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104908
104877
|
*/
|
|
104909
104878
|
readonly shapes: Word.ShapeCollection;
|
|
104910
104879
|
/**
|
|
104911
104880
|
* Gets an integer that represents the shape group identifier.
|
|
104912
104881
|
*
|
|
104913
104882
|
* @remarks
|
|
104914
|
-
* [Api set:
|
|
104915
|
-
* @beta
|
|
104883
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104916
104884
|
*/
|
|
104917
104885
|
readonly id: number;
|
|
104918
104886
|
/**
|
|
@@ -104927,8 +104895,7 @@ declare namespace Word {
|
|
|
104927
104895
|
* Ungroups any grouped shapes in the specified shape group.
|
|
104928
104896
|
*
|
|
104929
104897
|
* @remarks
|
|
104930
|
-
* [Api set:
|
|
104931
|
-
* @beta
|
|
104898
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104932
104899
|
*/
|
|
104933
104900
|
ungroup(): Word.ShapeCollection;
|
|
104934
104901
|
/**
|
|
@@ -104970,8 +104937,7 @@ declare namespace Word {
|
|
|
104970
104937
|
* Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.
|
|
104971
104938
|
*
|
|
104972
104939
|
* @remarks
|
|
104973
|
-
* [Api set:
|
|
104974
|
-
* @beta
|
|
104940
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104975
104941
|
*/
|
|
104976
104942
|
class Canvas extends OfficeExtension.ClientObject {
|
|
104977
104943
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -104980,24 +104946,21 @@ declare namespace Word {
|
|
|
104980
104946
|
* Gets the Shape object associated with the canvas.
|
|
104981
104947
|
*
|
|
104982
104948
|
* @remarks
|
|
104983
|
-
* [Api set:
|
|
104984
|
-
* @beta
|
|
104949
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104985
104950
|
*/
|
|
104986
104951
|
readonly shape: Word.Shape;
|
|
104987
104952
|
/**
|
|
104988
104953
|
* Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
|
|
104989
104954
|
*
|
|
104990
104955
|
* @remarks
|
|
104991
|
-
* [Api set:
|
|
104992
|
-
* @beta
|
|
104956
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104993
104957
|
*/
|
|
104994
104958
|
readonly shapes: Word.ShapeCollection;
|
|
104995
104959
|
/**
|
|
104996
104960
|
* Gets an integer that represents the canvas identifier.
|
|
104997
104961
|
*
|
|
104998
104962
|
* @remarks
|
|
104999
|
-
* [Api set:
|
|
105000
|
-
* @beta
|
|
104963
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105001
104964
|
*/
|
|
105002
104965
|
readonly id: number;
|
|
105003
104966
|
/**
|
|
@@ -105047,8 +105010,7 @@ declare namespace Word {
|
|
|
105047
105010
|
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
105048
105011
|
*
|
|
105049
105012
|
* @remarks
|
|
105050
|
-
* [Api set:
|
|
105051
|
-
* @beta
|
|
105013
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105052
105014
|
*/
|
|
105053
105015
|
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
105054
105016
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105059,8 +105021,7 @@ declare namespace Word {
|
|
|
105059
105021
|
* Gets the shapes that have the specified geometric types. Only applied to geometric shapes.
|
|
105060
105022
|
*
|
|
105061
105023
|
* @remarks
|
|
105062
|
-
* [Api set:
|
|
105063
|
-
* @beta
|
|
105024
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105064
105025
|
*
|
|
105065
105026
|
* @param types Required. An array of geometric shape subtypes.
|
|
105066
105027
|
*/
|
|
@@ -105069,8 +105030,7 @@ declare namespace Word {
|
|
|
105069
105030
|
* Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection.
|
|
105070
105031
|
*
|
|
105071
105032
|
* @remarks
|
|
105072
|
-
* [Api set:
|
|
105073
|
-
* @beta
|
|
105033
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105074
105034
|
*
|
|
105075
105035
|
* @param id Required. A shape identifier.
|
|
105076
105036
|
*/
|
|
@@ -105079,8 +105039,7 @@ declare namespace Word {
|
|
|
105079
105039
|
* Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105080
105040
|
*
|
|
105081
105041
|
* @remarks
|
|
105082
|
-
* [Api set:
|
|
105083
|
-
* @beta
|
|
105042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105084
105043
|
*
|
|
105085
105044
|
* @param id Required. A shape identifier.
|
|
105086
105045
|
*/
|
|
@@ -105089,8 +105048,7 @@ declare namespace Word {
|
|
|
105089
105048
|
* Gets the shapes by the identifiers.
|
|
105090
105049
|
*
|
|
105091
105050
|
* @remarks
|
|
105092
|
-
* [Api set:
|
|
105093
|
-
* @beta
|
|
105051
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105094
105052
|
*
|
|
105095
105053
|
* @param ids Required. An array of shape identifiers.
|
|
105096
105054
|
*/
|
|
@@ -105099,8 +105057,7 @@ declare namespace Word {
|
|
|
105099
105057
|
* Gets the shapes that have the specified names.
|
|
105100
105058
|
*
|
|
105101
105059
|
* @remarks
|
|
105102
|
-
* [Api set:
|
|
105103
|
-
* @beta
|
|
105060
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105104
105061
|
*
|
|
105105
105062
|
* @param names Required. An array of shape names.
|
|
105106
105063
|
*/
|
|
@@ -105109,8 +105066,7 @@ declare namespace Word {
|
|
|
105109
105066
|
* Gets the shapes that have the specified types.
|
|
105110
105067
|
*
|
|
105111
105068
|
* @remarks
|
|
105112
|
-
* [Api set:
|
|
105113
|
-
* @beta
|
|
105069
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105114
105070
|
*
|
|
105115
105071
|
* @param types Required. An array of shape types.
|
|
105116
105072
|
*/
|
|
@@ -105119,24 +105075,21 @@ declare namespace Word {
|
|
|
105119
105075
|
* Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
105120
105076
|
*
|
|
105121
105077
|
* @remarks
|
|
105122
|
-
* [Api set:
|
|
105123
|
-
* @beta
|
|
105078
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105124
105079
|
*/
|
|
105125
105080
|
getFirst(): Word.Shape;
|
|
105126
105081
|
/**
|
|
105127
105082
|
* Gets the first shape in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
105128
105083
|
*
|
|
105129
105084
|
* @remarks
|
|
105130
|
-
* [Api set:
|
|
105131
|
-
* @beta
|
|
105085
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105132
105086
|
*/
|
|
105133
105087
|
getFirstOrNullObject(): Word.Shape;
|
|
105134
105088
|
/**
|
|
105135
105089
|
* Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.
|
|
105136
105090
|
*
|
|
105137
105091
|
* @remarks
|
|
105138
|
-
* [Api set:
|
|
105139
|
-
* @beta
|
|
105092
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105140
105093
|
*/
|
|
105141
105094
|
group(): Word.Shape;
|
|
105142
105095
|
/**
|
|
@@ -105175,8 +105128,7 @@ declare namespace Word {
|
|
|
105175
105128
|
* Represents the fill formatting of a shape object.
|
|
105176
105129
|
*
|
|
105177
105130
|
* @remarks
|
|
105178
|
-
* [Api set:
|
|
105179
|
-
* @beta
|
|
105131
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105180
105132
|
*/
|
|
105181
105133
|
class ShapeFill extends OfficeExtension.ClientObject {
|
|
105182
105134
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105185,32 +105137,28 @@ declare namespace Word {
|
|
|
105185
105137
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105186
105138
|
*
|
|
105187
105139
|
* @remarks
|
|
105188
|
-
* [Api set:
|
|
105189
|
-
* @beta
|
|
105140
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105190
105141
|
*/
|
|
105191
105142
|
backgroundColor: string;
|
|
105192
105143
|
/**
|
|
105193
105144
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105194
105145
|
*
|
|
105195
105146
|
* @remarks
|
|
105196
|
-
* [Api set:
|
|
105197
|
-
* @beta
|
|
105147
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105198
105148
|
*/
|
|
105199
105149
|
foregroundColor: string;
|
|
105200
105150
|
/**
|
|
105201
105151
|
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
105202
105152
|
*
|
|
105203
105153
|
* @remarks
|
|
105204
|
-
* [Api set:
|
|
105205
|
-
* @beta
|
|
105154
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105206
105155
|
*/
|
|
105207
105156
|
transparency: number;
|
|
105208
105157
|
/**
|
|
105209
105158
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
105210
105159
|
*
|
|
105211
105160
|
* @remarks
|
|
105212
|
-
* [Api set:
|
|
105213
|
-
* @beta
|
|
105161
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105214
105162
|
*/
|
|
105215
105163
|
readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";
|
|
105216
105164
|
/**
|
|
@@ -105225,16 +105173,14 @@ declare namespace Word {
|
|
|
105225
105173
|
* Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;
|
|
105226
105174
|
*
|
|
105227
105175
|
* @remarks
|
|
105228
|
-
* [Api set:
|
|
105229
|
-
* @beta
|
|
105176
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105230
105177
|
*/
|
|
105231
105178
|
clear(): void;
|
|
105232
105179
|
/**
|
|
105233
105180
|
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`.
|
|
105234
105181
|
*
|
|
105235
105182
|
* @remarks
|
|
105236
|
-
* [Api set:
|
|
105237
|
-
* @beta
|
|
105183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105238
105184
|
*
|
|
105239
105185
|
* @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105240
105186
|
*/
|
|
@@ -105278,8 +105224,7 @@ declare namespace Word {
|
|
|
105278
105224
|
* Represents the text frame of a shape object.
|
|
105279
105225
|
*
|
|
105280
105226
|
* @remarks
|
|
105281
|
-
* [Api set:
|
|
105282
|
-
* @beta
|
|
105227
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105283
105228
|
*/
|
|
105284
105229
|
class TextFrame extends OfficeExtension.ClientObject {
|
|
105285
105230
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105288,80 +105233,70 @@ declare namespace Word {
|
|
|
105288
105233
|
* The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
|
|
105289
105234
|
*
|
|
105290
105235
|
* @remarks
|
|
105291
|
-
* [Api set:
|
|
105292
|
-
* @beta
|
|
105236
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105293
105237
|
*/
|
|
105294
105238
|
autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
105295
105239
|
/**
|
|
105296
105240
|
* Represents the bottom margin, in points, of the text frame.
|
|
105297
105241
|
*
|
|
105298
105242
|
* @remarks
|
|
105299
|
-
* [Api set:
|
|
105300
|
-
* @beta
|
|
105243
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105301
105244
|
*/
|
|
105302
105245
|
bottomMargin: number;
|
|
105303
105246
|
/**
|
|
105304
105247
|
* Specifies if the text frame contains text.
|
|
105305
105248
|
*
|
|
105306
105249
|
* @remarks
|
|
105307
|
-
* [Api set:
|
|
105308
|
-
* @beta
|
|
105250
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105309
105251
|
*/
|
|
105310
105252
|
readonly hasText: boolean;
|
|
105311
105253
|
/**
|
|
105312
105254
|
* Represents the left margin, in points, of the text frame.
|
|
105313
105255
|
*
|
|
105314
105256
|
* @remarks
|
|
105315
|
-
* [Api set:
|
|
105316
|
-
* @beta
|
|
105257
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105317
105258
|
*/
|
|
105318
105259
|
leftMargin: number;
|
|
105319
105260
|
/**
|
|
105320
105261
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
105321
105262
|
*
|
|
105322
105263
|
* @remarks
|
|
105323
|
-
* [Api set:
|
|
105324
|
-
* @beta
|
|
105264
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105325
105265
|
*/
|
|
105326
105266
|
noTextRotation: boolean;
|
|
105327
105267
|
/**
|
|
105328
105268
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
105329
105269
|
*
|
|
105330
105270
|
* @remarks
|
|
105331
|
-
* [Api set:
|
|
105332
|
-
* @beta
|
|
105271
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105333
105272
|
*/
|
|
105334
105273
|
orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
105335
105274
|
/**
|
|
105336
105275
|
* Represents the right margin, in points, of the text frame.
|
|
105337
105276
|
*
|
|
105338
105277
|
* @remarks
|
|
105339
|
-
* [Api set:
|
|
105340
|
-
* @beta
|
|
105278
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105341
105279
|
*/
|
|
105342
105280
|
rightMargin: number;
|
|
105343
105281
|
/**
|
|
105344
105282
|
* Represents the top margin, in points, of the text frame.
|
|
105345
105283
|
*
|
|
105346
105284
|
* @remarks
|
|
105347
|
-
* [Api set:
|
|
105348
|
-
* @beta
|
|
105285
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105349
105286
|
*/
|
|
105350
105287
|
topMargin: number;
|
|
105351
105288
|
/**
|
|
105352
105289
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
105353
105290
|
*
|
|
105354
105291
|
* @remarks
|
|
105355
|
-
* [Api set:
|
|
105356
|
-
* @beta
|
|
105292
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105357
105293
|
*/
|
|
105358
105294
|
verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
105359
105295
|
/**
|
|
105360
105296
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
105361
105297
|
*
|
|
105362
105298
|
* @remarks
|
|
105363
|
-
* [Api set:
|
|
105364
|
-
* @beta
|
|
105299
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105365
105300
|
*/
|
|
105366
105301
|
wordWrap: boolean;
|
|
105367
105302
|
/**
|
|
@@ -105411,8 +105346,7 @@ declare namespace Word {
|
|
|
105411
105346
|
* Represents all the properties for wrapping text around a shape.
|
|
105412
105347
|
*
|
|
105413
105348
|
* @remarks
|
|
105414
|
-
* [Api set:
|
|
105415
|
-
* @beta
|
|
105349
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105416
105350
|
*/
|
|
105417
105351
|
class ShapeTextWrap extends OfficeExtension.ClientObject {
|
|
105418
105352
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105421,48 +105355,42 @@ declare namespace Word {
|
|
|
105421
105355
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
105422
105356
|
*
|
|
105423
105357
|
* @remarks
|
|
105424
|
-
* [Api set:
|
|
105425
|
-
* @beta
|
|
105358
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105426
105359
|
*/
|
|
105427
105360
|
bottomDistance: number;
|
|
105428
105361
|
/**
|
|
105429
105362
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
105430
105363
|
*
|
|
105431
105364
|
* @remarks
|
|
105432
|
-
* [Api set:
|
|
105433
|
-
* @beta
|
|
105365
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105434
105366
|
*/
|
|
105435
105367
|
leftDistance: number;
|
|
105436
105368
|
/**
|
|
105437
105369
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
105438
105370
|
*
|
|
105439
105371
|
* @remarks
|
|
105440
|
-
* [Api set:
|
|
105441
|
-
* @beta
|
|
105372
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105442
105373
|
*/
|
|
105443
105374
|
rightDistance: number;
|
|
105444
105375
|
/**
|
|
105445
105376
|
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
105446
105377
|
*
|
|
105447
105378
|
* @remarks
|
|
105448
|
-
* [Api set:
|
|
105449
|
-
* @beta
|
|
105379
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105450
105380
|
*/
|
|
105451
105381
|
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
105452
105382
|
/**
|
|
105453
105383
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
105454
105384
|
*
|
|
105455
105385
|
* @remarks
|
|
105456
|
-
* [Api set:
|
|
105457
|
-
* @beta
|
|
105386
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105458
105387
|
*/
|
|
105459
105388
|
topDistance: number;
|
|
105460
105389
|
/**
|
|
105461
105390
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
105462
105391
|
*
|
|
105463
105392
|
* @remarks
|
|
105464
|
-
* [Api set:
|
|
105465
|
-
* @beta
|
|
105393
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105466
105394
|
*/
|
|
105467
105395
|
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
105468
105396
|
/**
|
|
@@ -109491,50 +109419,43 @@ declare namespace Word {
|
|
|
109491
109419
|
* Represents the shape type.
|
|
109492
109420
|
*
|
|
109493
109421
|
* @remarks
|
|
109494
|
-
* [Api set:
|
|
109495
|
-
* @beta
|
|
109422
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109496
109423
|
*/
|
|
109497
109424
|
enum ShapeType {
|
|
109498
109425
|
/**
|
|
109499
109426
|
* Unsupported shape type.
|
|
109500
109427
|
* @remarks
|
|
109501
|
-
* [Api set:
|
|
109502
|
-
* @beta
|
|
109428
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109503
109429
|
*/
|
|
109504
109430
|
unsupported = "Unsupported",
|
|
109505
109431
|
/**
|
|
109506
109432
|
* Text box shape.
|
|
109507
109433
|
* @remarks
|
|
109508
|
-
* [Api set:
|
|
109509
|
-
* @beta
|
|
109434
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109510
109435
|
*/
|
|
109511
109436
|
textBox = "TextBox",
|
|
109512
109437
|
/**
|
|
109513
109438
|
* Geometric shape.
|
|
109514
109439
|
* @remarks
|
|
109515
|
-
* [Api set:
|
|
109516
|
-
* @beta
|
|
109440
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109517
109441
|
*/
|
|
109518
109442
|
geometricShape = "GeometricShape",
|
|
109519
109443
|
/**
|
|
109520
109444
|
* Group shape.
|
|
109521
109445
|
* @remarks
|
|
109522
|
-
* [Api set:
|
|
109523
|
-
* @beta
|
|
109446
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109524
109447
|
*/
|
|
109525
109448
|
group = "Group",
|
|
109526
109449
|
/**
|
|
109527
109450
|
* Picture shape.
|
|
109528
109451
|
* @remarks
|
|
109529
|
-
* [Api set:
|
|
109530
|
-
* @beta
|
|
109452
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109531
109453
|
*/
|
|
109532
109454
|
picture = "Picture",
|
|
109533
109455
|
/**
|
|
109534
109456
|
* Canvas shape.
|
|
109535
109457
|
* @remarks
|
|
109536
|
-
* [Api set:
|
|
109537
|
-
* @beta
|
|
109458
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109538
109459
|
*/
|
|
109539
109460
|
canvas = "Canvas",
|
|
109540
109461
|
}
|
|
@@ -109543,64 +109464,55 @@ declare namespace Word {
|
|
|
109543
109464
|
For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}.
|
|
109544
109465
|
*
|
|
109545
109466
|
* @remarks
|
|
109546
|
-
* [Api set:
|
|
109547
|
-
* @beta
|
|
109467
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109548
109468
|
*/
|
|
109549
109469
|
enum RelativeHorizontalPosition {
|
|
109550
109470
|
/**
|
|
109551
109471
|
* Relative to margin.
|
|
109552
109472
|
* @remarks
|
|
109553
|
-
* [Api set:
|
|
109554
|
-
* @beta
|
|
109473
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109555
109474
|
*/
|
|
109556
109475
|
margin = "Margin",
|
|
109557
109476
|
/**
|
|
109558
109477
|
* Relative to page.
|
|
109559
109478
|
* @remarks
|
|
109560
|
-
* [Api set:
|
|
109561
|
-
* @beta
|
|
109479
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109562
109480
|
*/
|
|
109563
109481
|
page = "Page",
|
|
109564
109482
|
/**
|
|
109565
109483
|
* Relative to column.
|
|
109566
109484
|
* @remarks
|
|
109567
|
-
* [Api set:
|
|
109568
|
-
* @beta
|
|
109485
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109569
109486
|
*/
|
|
109570
109487
|
column = "Column",
|
|
109571
109488
|
/**
|
|
109572
109489
|
* Relative to character.
|
|
109573
109490
|
* @remarks
|
|
109574
|
-
* [Api set:
|
|
109575
|
-
* @beta
|
|
109491
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109576
109492
|
*/
|
|
109577
109493
|
character = "Character",
|
|
109578
109494
|
/**
|
|
109579
109495
|
* Relative to left margin.
|
|
109580
109496
|
* @remarks
|
|
109581
|
-
* [Api set:
|
|
109582
|
-
* @beta
|
|
109497
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109583
109498
|
*/
|
|
109584
109499
|
leftMargin = "LeftMargin",
|
|
109585
109500
|
/**
|
|
109586
109501
|
* Relative to right margin.
|
|
109587
109502
|
* @remarks
|
|
109588
|
-
* [Api set:
|
|
109589
|
-
* @beta
|
|
109503
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109590
109504
|
*/
|
|
109591
109505
|
rightMargin = "RightMargin",
|
|
109592
109506
|
/**
|
|
109593
109507
|
* Relative to inside margin.
|
|
109594
109508
|
* @remarks
|
|
109595
|
-
* [Api set:
|
|
109596
|
-
* @beta
|
|
109509
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109597
109510
|
*/
|
|
109598
109511
|
insideMargin = "InsideMargin",
|
|
109599
109512
|
/**
|
|
109600
109513
|
* Relative to outside margin.
|
|
109601
109514
|
* @remarks
|
|
109602
|
-
* [Api set:
|
|
109603
|
-
* @beta
|
|
109515
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109604
109516
|
*/
|
|
109605
109517
|
outsideMargin = "OutsideMargin",
|
|
109606
109518
|
}
|
|
@@ -109609,64 +109521,55 @@ declare namespace Word {
|
|
|
109609
109521
|
For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}.
|
|
109610
109522
|
*
|
|
109611
109523
|
* @remarks
|
|
109612
|
-
* [Api set:
|
|
109613
|
-
* @beta
|
|
109524
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109614
109525
|
*/
|
|
109615
109526
|
enum RelativeVerticalPosition {
|
|
109616
109527
|
/**
|
|
109617
109528
|
* Relative to margin.
|
|
109618
109529
|
* @remarks
|
|
109619
|
-
* [Api set:
|
|
109620
|
-
* @beta
|
|
109530
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109621
109531
|
*/
|
|
109622
109532
|
margin = "Margin",
|
|
109623
109533
|
/**
|
|
109624
109534
|
* Relative to page.
|
|
109625
109535
|
* @remarks
|
|
109626
|
-
* [Api set:
|
|
109627
|
-
* @beta
|
|
109536
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109628
109537
|
*/
|
|
109629
109538
|
page = "Page",
|
|
109630
109539
|
/**
|
|
109631
109540
|
* Relative to paragraph.
|
|
109632
109541
|
* @remarks
|
|
109633
|
-
* [Api set:
|
|
109634
|
-
* @beta
|
|
109542
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109635
109543
|
*/
|
|
109636
109544
|
paragraph = "Paragraph",
|
|
109637
109545
|
/**
|
|
109638
109546
|
* Relative to line.
|
|
109639
109547
|
* @remarks
|
|
109640
|
-
* [Api set:
|
|
109641
|
-
* @beta
|
|
109548
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109642
109549
|
*/
|
|
109643
109550
|
line = "Line",
|
|
109644
109551
|
/**
|
|
109645
109552
|
* Relative to top margin.
|
|
109646
109553
|
* @remarks
|
|
109647
|
-
* [Api set:
|
|
109648
|
-
* @beta
|
|
109554
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109649
109555
|
*/
|
|
109650
109556
|
topMargin = "TopMargin",
|
|
109651
109557
|
/**
|
|
109652
109558
|
* Relative to bottom margin.
|
|
109653
109559
|
* @remarks
|
|
109654
|
-
* [Api set:
|
|
109655
|
-
* @beta
|
|
109560
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109656
109561
|
*/
|
|
109657
109562
|
bottomMargin = "BottomMargin",
|
|
109658
109563
|
/**
|
|
109659
109564
|
* Relative to inside margin.
|
|
109660
109565
|
* @remarks
|
|
109661
|
-
* [Api set:
|
|
109662
|
-
* @beta
|
|
109566
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109663
109567
|
*/
|
|
109664
109568
|
insideMargin = "InsideMargin",
|
|
109665
109569
|
/**
|
|
109666
109570
|
* Relative to outside margin.
|
|
109667
109571
|
* @remarks
|
|
109668
|
-
* [Api set:
|
|
109669
|
-
* @beta
|
|
109572
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109670
109573
|
*/
|
|
109671
109574
|
outsideMargin = "OutsideMargin",
|
|
109672
109575
|
}
|
|
@@ -109674,1247 +109577,1069 @@ declare namespace Word {
|
|
|
109674
109577
|
* Specifies the shape type for a `GeometricShape` object.
|
|
109675
109578
|
*
|
|
109676
109579
|
* @remarks
|
|
109677
|
-
* [Api set:
|
|
109678
|
-
* @beta
|
|
109580
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109679
109581
|
*/
|
|
109680
109582
|
enum GeometricShapeType {
|
|
109681
109583
|
/**
|
|
109682
109584
|
* Line inverse geometric shape.
|
|
109683
109585
|
* @remarks
|
|
109684
|
-
* [Api set:
|
|
109685
|
-
* @beta
|
|
109586
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109686
109587
|
*/
|
|
109687
109588
|
lineInverse = "LineInverse",
|
|
109688
109589
|
/**
|
|
109689
109590
|
* Triangle geometric shape.
|
|
109690
109591
|
* @remarks
|
|
109691
|
-
* [Api set:
|
|
109692
|
-
* @beta
|
|
109592
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109693
109593
|
*/
|
|
109694
109594
|
triangle = "Triangle",
|
|
109695
109595
|
/**
|
|
109696
109596
|
* Right triangle geometric shape.
|
|
109697
109597
|
* @remarks
|
|
109698
|
-
* [Api set:
|
|
109699
|
-
* @beta
|
|
109598
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109700
109599
|
*/
|
|
109701
109600
|
rightTriangle = "RightTriangle",
|
|
109702
109601
|
/**
|
|
109703
109602
|
* Rectangle geometric shape.
|
|
109704
109603
|
* @remarks
|
|
109705
|
-
* [Api set:
|
|
109706
|
-
* @beta
|
|
109604
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109707
109605
|
*/
|
|
109708
109606
|
rectangle = "Rectangle",
|
|
109709
109607
|
/**
|
|
109710
109608
|
* Diamond geometric shape.
|
|
109711
109609
|
* @remarks
|
|
109712
|
-
* [Api set:
|
|
109713
|
-
* @beta
|
|
109610
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109714
109611
|
*/
|
|
109715
109612
|
diamond = "Diamond",
|
|
109716
109613
|
/**
|
|
109717
109614
|
* Parallelogram geometric shape.
|
|
109718
109615
|
* @remarks
|
|
109719
|
-
* [Api set:
|
|
109720
|
-
* @beta
|
|
109616
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109721
109617
|
*/
|
|
109722
109618
|
parallelogram = "Parallelogram",
|
|
109723
109619
|
/**
|
|
109724
109620
|
* Trapezoid geometric shape.
|
|
109725
109621
|
* @remarks
|
|
109726
|
-
* [Api set:
|
|
109727
|
-
* @beta
|
|
109622
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109728
109623
|
*/
|
|
109729
109624
|
trapezoid = "Trapezoid",
|
|
109730
109625
|
/**
|
|
109731
109626
|
* Non-isosceles trapezoid geometric shape.
|
|
109732
109627
|
* @remarks
|
|
109733
|
-
* [Api set:
|
|
109734
|
-
* @beta
|
|
109628
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109735
109629
|
*/
|
|
109736
109630
|
nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
|
|
109737
109631
|
/**
|
|
109738
109632
|
* Pentagon geometric shape.
|
|
109739
109633
|
* @remarks
|
|
109740
|
-
* [Api set:
|
|
109741
|
-
* @beta
|
|
109634
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109742
109635
|
*/
|
|
109743
109636
|
pentagon = "Pentagon",
|
|
109744
109637
|
/**
|
|
109745
109638
|
* Hexagon geometric shape.
|
|
109746
109639
|
* @remarks
|
|
109747
|
-
* [Api set:
|
|
109748
|
-
* @beta
|
|
109640
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109749
109641
|
*/
|
|
109750
109642
|
hexagon = "Hexagon",
|
|
109751
109643
|
/**
|
|
109752
109644
|
* Heptagon geometric shape.
|
|
109753
109645
|
* @remarks
|
|
109754
|
-
* [Api set:
|
|
109755
|
-
* @beta
|
|
109646
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109756
109647
|
*/
|
|
109757
109648
|
heptagon = "Heptagon",
|
|
109758
109649
|
/**
|
|
109759
109650
|
* Octagon geometric shape.
|
|
109760
109651
|
* @remarks
|
|
109761
|
-
* [Api set:
|
|
109762
|
-
* @beta
|
|
109652
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109763
109653
|
*/
|
|
109764
109654
|
octagon = "Octagon",
|
|
109765
109655
|
/**
|
|
109766
109656
|
* Decagon geometric shape.
|
|
109767
109657
|
* @remarks
|
|
109768
|
-
* [Api set:
|
|
109769
|
-
* @beta
|
|
109658
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109770
109659
|
*/
|
|
109771
109660
|
decagon = "Decagon",
|
|
109772
109661
|
/**
|
|
109773
109662
|
* Dodecagon geometric shape.
|
|
109774
109663
|
* @remarks
|
|
109775
|
-
* [Api set:
|
|
109776
|
-
* @beta
|
|
109664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109777
109665
|
*/
|
|
109778
109666
|
dodecagon = "Dodecagon",
|
|
109779
109667
|
/**
|
|
109780
109668
|
* Star 4-point geometric shape.
|
|
109781
109669
|
* @remarks
|
|
109782
|
-
* [Api set:
|
|
109783
|
-
* @beta
|
|
109670
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109784
109671
|
*/
|
|
109785
109672
|
star4 = "Star4",
|
|
109786
109673
|
/**
|
|
109787
109674
|
* Star 5-point geometric shape.
|
|
109788
109675
|
* @remarks
|
|
109789
|
-
* [Api set:
|
|
109790
|
-
* @beta
|
|
109676
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109791
109677
|
*/
|
|
109792
109678
|
star5 = "Star5",
|
|
109793
109679
|
/**
|
|
109794
109680
|
* Star 6-point geometric shape.
|
|
109795
109681
|
* @remarks
|
|
109796
|
-
* [Api set:
|
|
109797
|
-
* @beta
|
|
109682
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109798
109683
|
*/
|
|
109799
109684
|
star6 = "Star6",
|
|
109800
109685
|
/**
|
|
109801
109686
|
* Star 7-point geometric shape.
|
|
109802
109687
|
* @remarks
|
|
109803
|
-
* [Api set:
|
|
109804
|
-
* @beta
|
|
109688
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109805
109689
|
*/
|
|
109806
109690
|
star7 = "Star7",
|
|
109807
109691
|
/**
|
|
109808
109692
|
* Star 8-point geometric shape.
|
|
109809
109693
|
* @remarks
|
|
109810
|
-
* [Api set:
|
|
109811
|
-
* @beta
|
|
109694
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109812
109695
|
*/
|
|
109813
109696
|
star8 = "Star8",
|
|
109814
109697
|
/**
|
|
109815
109698
|
* Star 10-point geometric shape.
|
|
109816
109699
|
* @remarks
|
|
109817
|
-
* [Api set:
|
|
109818
|
-
* @beta
|
|
109700
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109819
109701
|
*/
|
|
109820
109702
|
star10 = "Star10",
|
|
109821
109703
|
/**
|
|
109822
109704
|
* Star 12-point geometric shape.
|
|
109823
109705
|
* @remarks
|
|
109824
|
-
* [Api set:
|
|
109825
|
-
* @beta
|
|
109706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109826
109707
|
*/
|
|
109827
109708
|
star12 = "Star12",
|
|
109828
109709
|
/**
|
|
109829
109710
|
* Star 16-point geometric shape.
|
|
109830
109711
|
* @remarks
|
|
109831
|
-
* [Api set:
|
|
109832
|
-
* @beta
|
|
109712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109833
109713
|
*/
|
|
109834
109714
|
star16 = "Star16",
|
|
109835
109715
|
/**
|
|
109836
109716
|
* Star 24-point geometric shape.
|
|
109837
109717
|
* @remarks
|
|
109838
|
-
* [Api set:
|
|
109839
|
-
* @beta
|
|
109718
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109840
109719
|
*/
|
|
109841
109720
|
star24 = "Star24",
|
|
109842
109721
|
/**
|
|
109843
109722
|
* Star 32-point geometric shape.
|
|
109844
109723
|
* @remarks
|
|
109845
|
-
* [Api set:
|
|
109846
|
-
* @beta
|
|
109724
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109847
109725
|
*/
|
|
109848
109726
|
star32 = "Star32",
|
|
109849
109727
|
/**
|
|
109850
109728
|
* Round rectangle geometric shape.
|
|
109851
109729
|
* @remarks
|
|
109852
|
-
* [Api set:
|
|
109853
|
-
* @beta
|
|
109730
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109854
109731
|
*/
|
|
109855
109732
|
roundRectangle = "RoundRectangle",
|
|
109856
109733
|
/**
|
|
109857
109734
|
* Round one rectangle geometric shape.
|
|
109858
109735
|
* @remarks
|
|
109859
|
-
* [Api set:
|
|
109860
|
-
* @beta
|
|
109736
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109861
109737
|
*/
|
|
109862
109738
|
round1Rectangle = "Round1Rectangle",
|
|
109863
109739
|
/**
|
|
109864
109740
|
* Round two same rectangle geometric shape.
|
|
109865
109741
|
* @remarks
|
|
109866
|
-
* [Api set:
|
|
109867
|
-
* @beta
|
|
109742
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109868
109743
|
*/
|
|
109869
109744
|
round2SameRectangle = "Round2SameRectangle",
|
|
109870
109745
|
/**
|
|
109871
109746
|
* Round two diagonal rectangle geometric shape.
|
|
109872
109747
|
* @remarks
|
|
109873
|
-
* [Api set:
|
|
109874
|
-
* @beta
|
|
109748
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109875
109749
|
*/
|
|
109876
109750
|
round2DiagonalRectangle = "Round2DiagonalRectangle",
|
|
109877
109751
|
/**
|
|
109878
109752
|
* Snip round rectangle geometric shape.
|
|
109879
109753
|
* @remarks
|
|
109880
|
-
* [Api set:
|
|
109881
|
-
* @beta
|
|
109754
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109882
109755
|
*/
|
|
109883
109756
|
snipRoundRectangle = "SnipRoundRectangle",
|
|
109884
109757
|
/**
|
|
109885
109758
|
* Snip one rectangle geometric shape.
|
|
109886
109759
|
* @remarks
|
|
109887
|
-
* [Api set:
|
|
109888
|
-
* @beta
|
|
109760
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109889
109761
|
*/
|
|
109890
109762
|
snip1Rectangle = "Snip1Rectangle",
|
|
109891
109763
|
/**
|
|
109892
109764
|
* Snip two same rectangle geometric shape.
|
|
109893
109765
|
* @remarks
|
|
109894
|
-
* [Api set:
|
|
109895
|
-
* @beta
|
|
109766
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109896
109767
|
*/
|
|
109897
109768
|
snip2SameRectangle = "Snip2SameRectangle",
|
|
109898
109769
|
/**
|
|
109899
109770
|
* Snip two diagonal rectangle geometric shape.
|
|
109900
109771
|
* @remarks
|
|
109901
|
-
* [Api set:
|
|
109902
|
-
* @beta
|
|
109772
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109903
109773
|
*/
|
|
109904
109774
|
snip2DiagonalRectangle = "Snip2DiagonalRectangle",
|
|
109905
109775
|
/**
|
|
109906
109776
|
* Plaque geometric shape.
|
|
109907
109777
|
* @remarks
|
|
109908
|
-
* [Api set:
|
|
109909
|
-
* @beta
|
|
109778
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109910
109779
|
*/
|
|
109911
109780
|
plaque = "Plaque",
|
|
109912
109781
|
/**
|
|
109913
109782
|
* Ellipse geometric shape.
|
|
109914
109783
|
* @remarks
|
|
109915
|
-
* [Api set:
|
|
109916
|
-
* @beta
|
|
109784
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109917
109785
|
*/
|
|
109918
109786
|
ellipse = "Ellipse",
|
|
109919
109787
|
/**
|
|
109920
109788
|
* Teardrop geometric shape.
|
|
109921
109789
|
* @remarks
|
|
109922
|
-
* [Api set:
|
|
109923
|
-
* @beta
|
|
109790
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109924
109791
|
*/
|
|
109925
109792
|
teardrop = "Teardrop",
|
|
109926
109793
|
/**
|
|
109927
109794
|
* Home plate geometric shape.
|
|
109928
109795
|
* @remarks
|
|
109929
|
-
* [Api set:
|
|
109930
|
-
* @beta
|
|
109796
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109931
109797
|
*/
|
|
109932
109798
|
homePlate = "HomePlate",
|
|
109933
109799
|
/**
|
|
109934
109800
|
* Chevron geometric shape.
|
|
109935
109801
|
* @remarks
|
|
109936
|
-
* [Api set:
|
|
109937
|
-
* @beta
|
|
109802
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109938
109803
|
*/
|
|
109939
109804
|
chevron = "Chevron",
|
|
109940
109805
|
/**
|
|
109941
109806
|
* Pie wedge geometric shape.
|
|
109942
109807
|
* @remarks
|
|
109943
|
-
* [Api set:
|
|
109944
|
-
* @beta
|
|
109808
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109945
109809
|
*/
|
|
109946
109810
|
pieWedge = "PieWedge",
|
|
109947
109811
|
/**
|
|
109948
109812
|
* Pie geometric shape.
|
|
109949
109813
|
* @remarks
|
|
109950
|
-
* [Api set:
|
|
109951
|
-
* @beta
|
|
109814
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109952
109815
|
*/
|
|
109953
109816
|
pie = "Pie",
|
|
109954
109817
|
/**
|
|
109955
109818
|
* Block arc geometric shape.
|
|
109956
109819
|
* @remarks
|
|
109957
|
-
* [Api set:
|
|
109958
|
-
* @beta
|
|
109820
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109959
109821
|
*/
|
|
109960
109822
|
blockArc = "BlockArc",
|
|
109961
109823
|
/**
|
|
109962
109824
|
* Donut geometric shape.
|
|
109963
109825
|
* @remarks
|
|
109964
|
-
* [Api set:
|
|
109965
|
-
* @beta
|
|
109826
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109966
109827
|
*/
|
|
109967
109828
|
donut = "Donut",
|
|
109968
109829
|
/**
|
|
109969
109830
|
* No smoking geometric shape.
|
|
109970
109831
|
* @remarks
|
|
109971
|
-
* [Api set:
|
|
109972
|
-
* @beta
|
|
109832
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109973
109833
|
*/
|
|
109974
109834
|
noSmoking = "NoSmoking",
|
|
109975
109835
|
/**
|
|
109976
109836
|
* Right arrow geometric shape.
|
|
109977
109837
|
* @remarks
|
|
109978
|
-
* [Api set:
|
|
109979
|
-
* @beta
|
|
109838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109980
109839
|
*/
|
|
109981
109840
|
rightArrow = "RightArrow",
|
|
109982
109841
|
/**
|
|
109983
109842
|
* Left arrow geometric shape.
|
|
109984
109843
|
* @remarks
|
|
109985
|
-
* [Api set:
|
|
109986
|
-
* @beta
|
|
109844
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109987
109845
|
*/
|
|
109988
109846
|
leftArrow = "LeftArrow",
|
|
109989
109847
|
/**
|
|
109990
109848
|
* Up arrow geometric shape.
|
|
109991
109849
|
* @remarks
|
|
109992
|
-
* [Api set:
|
|
109993
|
-
* @beta
|
|
109850
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109994
109851
|
*/
|
|
109995
109852
|
upArrow = "UpArrow",
|
|
109996
109853
|
/**
|
|
109997
109854
|
* Down arrow geometric shape.
|
|
109998
109855
|
* @remarks
|
|
109999
|
-
* [Api set:
|
|
110000
|
-
* @beta
|
|
109856
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110001
109857
|
*/
|
|
110002
109858
|
downArrow = "DownArrow",
|
|
110003
109859
|
/**
|
|
110004
109860
|
* Striped right arrow geometric shape.
|
|
110005
109861
|
* @remarks
|
|
110006
|
-
* [Api set:
|
|
110007
|
-
* @beta
|
|
109862
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110008
109863
|
*/
|
|
110009
109864
|
stripedRightArrow = "StripedRightArrow",
|
|
110010
109865
|
/**
|
|
110011
109866
|
* Notched right arrow geometric shape.
|
|
110012
109867
|
* @remarks
|
|
110013
|
-
* [Api set:
|
|
110014
|
-
* @beta
|
|
109868
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110015
109869
|
*/
|
|
110016
109870
|
notchedRightArrow = "NotchedRightArrow",
|
|
110017
109871
|
/**
|
|
110018
109872
|
* Bent up arrow geometric shape.
|
|
110019
109873
|
* @remarks
|
|
110020
|
-
* [Api set:
|
|
110021
|
-
* @beta
|
|
109874
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110022
109875
|
*/
|
|
110023
109876
|
bentUpArrow = "BentUpArrow",
|
|
110024
109877
|
/**
|
|
110025
109878
|
* Left-right arrow geometric shape.
|
|
110026
109879
|
* @remarks
|
|
110027
|
-
* [Api set:
|
|
110028
|
-
* @beta
|
|
109880
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110029
109881
|
*/
|
|
110030
109882
|
leftRightArrow = "LeftRightArrow",
|
|
110031
109883
|
/**
|
|
110032
109884
|
* Up-down arrow geometric shape.
|
|
110033
109885
|
* @remarks
|
|
110034
|
-
* [Api set:
|
|
110035
|
-
* @beta
|
|
109886
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110036
109887
|
*/
|
|
110037
109888
|
upDownArrow = "UpDownArrow",
|
|
110038
109889
|
/**
|
|
110039
109890
|
* Left-up arrow geometric shape.
|
|
110040
109891
|
* @remarks
|
|
110041
|
-
* [Api set:
|
|
110042
|
-
* @beta
|
|
109892
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110043
109893
|
*/
|
|
110044
109894
|
leftUpArrow = "LeftUpArrow",
|
|
110045
109895
|
/**
|
|
110046
109896
|
* Left-right-up arrow geometric shape.
|
|
110047
109897
|
* @remarks
|
|
110048
|
-
* [Api set:
|
|
110049
|
-
* @beta
|
|
109898
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110050
109899
|
*/
|
|
110051
109900
|
leftRightUpArrow = "LeftRightUpArrow",
|
|
110052
109901
|
/**
|
|
110053
109902
|
* Quad arrow geometric shape.
|
|
110054
109903
|
* @remarks
|
|
110055
|
-
* [Api set:
|
|
110056
|
-
* @beta
|
|
109904
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110057
109905
|
*/
|
|
110058
109906
|
quadArrow = "QuadArrow",
|
|
110059
109907
|
/**
|
|
110060
109908
|
* Left arrow callout geometric shape.
|
|
110061
109909
|
* @remarks
|
|
110062
|
-
* [Api set:
|
|
110063
|
-
* @beta
|
|
109910
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110064
109911
|
*/
|
|
110065
109912
|
leftArrowCallout = "LeftArrowCallout",
|
|
110066
109913
|
/**
|
|
110067
109914
|
* Right arrow callout geometric shape.
|
|
110068
109915
|
* @remarks
|
|
110069
|
-
* [Api set:
|
|
110070
|
-
* @beta
|
|
109916
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110071
109917
|
*/
|
|
110072
109918
|
rightArrowCallout = "RightArrowCallout",
|
|
110073
109919
|
/**
|
|
110074
109920
|
* Up arrow callout geometric shape.
|
|
110075
109921
|
* @remarks
|
|
110076
|
-
* [Api set:
|
|
110077
|
-
* @beta
|
|
109922
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110078
109923
|
*/
|
|
110079
109924
|
upArrowCallout = "UpArrowCallout",
|
|
110080
109925
|
/**
|
|
110081
109926
|
* Down arrow callout geometric shape.
|
|
110082
109927
|
* @remarks
|
|
110083
|
-
* [Api set:
|
|
110084
|
-
* @beta
|
|
109928
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110085
109929
|
*/
|
|
110086
109930
|
downArrowCallout = "DownArrowCallout",
|
|
110087
109931
|
/**
|
|
110088
109932
|
* Left-right arrow callout geometric shape.
|
|
110089
109933
|
* @remarks
|
|
110090
|
-
* [Api set:
|
|
110091
|
-
* @beta
|
|
109934
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110092
109935
|
*/
|
|
110093
109936
|
leftRightArrowCallout = "LeftRightArrowCallout",
|
|
110094
109937
|
/**
|
|
110095
109938
|
* Up-down arrow callout geometric shape.
|
|
110096
109939
|
* @remarks
|
|
110097
|
-
* [Api set:
|
|
110098
|
-
* @beta
|
|
109940
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110099
109941
|
*/
|
|
110100
109942
|
upDownArrowCallout = "UpDownArrowCallout",
|
|
110101
109943
|
/**
|
|
110102
109944
|
* Quad arrow callout geometric shape.
|
|
110103
109945
|
* @remarks
|
|
110104
|
-
* [Api set:
|
|
110105
|
-
* @beta
|
|
109946
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110106
109947
|
*/
|
|
110107
109948
|
quadArrowCallout = "QuadArrowCallout",
|
|
110108
109949
|
/**
|
|
110109
109950
|
* Bent arrow geometric shape.
|
|
110110
109951
|
* @remarks
|
|
110111
|
-
* [Api set:
|
|
110112
|
-
* @beta
|
|
109952
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110113
109953
|
*/
|
|
110114
109954
|
bentArrow = "BentArrow",
|
|
110115
109955
|
/**
|
|
110116
109956
|
* U-turn arrow geometric shape.
|
|
110117
109957
|
* @remarks
|
|
110118
|
-
* [Api set:
|
|
110119
|
-
* @beta
|
|
109958
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110120
109959
|
*/
|
|
110121
109960
|
uturnArrow = "UturnArrow",
|
|
110122
109961
|
/**
|
|
110123
109962
|
* Circular arrow geometric shape.
|
|
110124
109963
|
* @remarks
|
|
110125
|
-
* [Api set:
|
|
110126
|
-
* @beta
|
|
109964
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110127
109965
|
*/
|
|
110128
109966
|
circularArrow = "CircularArrow",
|
|
110129
109967
|
/**
|
|
110130
109968
|
* Left circular arrow geometric shape.
|
|
110131
109969
|
* @remarks
|
|
110132
|
-
* [Api set:
|
|
110133
|
-
* @beta
|
|
109970
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110134
109971
|
*/
|
|
110135
109972
|
leftCircularArrow = "LeftCircularArrow",
|
|
110136
109973
|
/**
|
|
110137
109974
|
* Left-right circular arrow geometric shape.
|
|
110138
109975
|
* @remarks
|
|
110139
|
-
* [Api set:
|
|
110140
|
-
* @beta
|
|
109976
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110141
109977
|
*/
|
|
110142
109978
|
leftRightCircularArrow = "LeftRightCircularArrow",
|
|
110143
109979
|
/**
|
|
110144
109980
|
* Curved right arrow geometric shape.
|
|
110145
109981
|
* @remarks
|
|
110146
|
-
* [Api set:
|
|
110147
|
-
* @beta
|
|
109982
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110148
109983
|
*/
|
|
110149
109984
|
curvedRightArrow = "CurvedRightArrow",
|
|
110150
109985
|
/**
|
|
110151
109986
|
* Curved left arrow geometric shape.
|
|
110152
109987
|
* @remarks
|
|
110153
|
-
* [Api set:
|
|
110154
|
-
* @beta
|
|
109988
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110155
109989
|
*/
|
|
110156
109990
|
curvedLeftArrow = "CurvedLeftArrow",
|
|
110157
109991
|
/**
|
|
110158
109992
|
* Curved up arrow geometric shape.
|
|
110159
109993
|
* @remarks
|
|
110160
|
-
* [Api set:
|
|
110161
|
-
* @beta
|
|
109994
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110162
109995
|
*/
|
|
110163
109996
|
curvedUpArrow = "CurvedUpArrow",
|
|
110164
109997
|
/**
|
|
110165
109998
|
* Curved down arrow geometric shape.
|
|
110166
109999
|
* @remarks
|
|
110167
|
-
* [Api set:
|
|
110168
|
-
* @beta
|
|
110000
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110169
110001
|
*/
|
|
110170
110002
|
curvedDownArrow = "CurvedDownArrow",
|
|
110171
110003
|
/**
|
|
110172
110004
|
* Swoosh arrow geometric shape.
|
|
110173
110005
|
* @remarks
|
|
110174
|
-
* [Api set:
|
|
110175
|
-
* @beta
|
|
110006
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110176
110007
|
*/
|
|
110177
110008
|
swooshArrow = "SwooshArrow",
|
|
110178
110009
|
/**
|
|
110179
110010
|
* Cube geometric shape.
|
|
110180
110011
|
* @remarks
|
|
110181
|
-
* [Api set:
|
|
110182
|
-
* @beta
|
|
110012
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110183
110013
|
*/
|
|
110184
110014
|
cube = "Cube",
|
|
110185
110015
|
/**
|
|
110186
110016
|
* Can geometric shape.
|
|
110187
110017
|
* @remarks
|
|
110188
|
-
* [Api set:
|
|
110189
|
-
* @beta
|
|
110018
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110190
110019
|
*/
|
|
110191
110020
|
can = "Can",
|
|
110192
110021
|
/**
|
|
110193
110022
|
* Lightning bolt geometric shape.
|
|
110194
110023
|
* @remarks
|
|
110195
|
-
* [Api set:
|
|
110196
|
-
* @beta
|
|
110024
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110197
110025
|
*/
|
|
110198
110026
|
lightningBolt = "LightningBolt",
|
|
110199
110027
|
/**
|
|
110200
110028
|
* Heart geometric shape.
|
|
110201
110029
|
* @remarks
|
|
110202
|
-
* [Api set:
|
|
110203
|
-
* @beta
|
|
110030
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110204
110031
|
*/
|
|
110205
110032
|
heart = "Heart",
|
|
110206
110033
|
/**
|
|
110207
110034
|
* Sun geometric shape.
|
|
110208
110035
|
* @remarks
|
|
110209
|
-
* [Api set:
|
|
110210
|
-
* @beta
|
|
110036
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110211
110037
|
*/
|
|
110212
110038
|
sun = "Sun",
|
|
110213
110039
|
/**
|
|
110214
110040
|
* Moon geometric shape.
|
|
110215
110041
|
* @remarks
|
|
110216
|
-
* [Api set:
|
|
110217
|
-
* @beta
|
|
110042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110218
110043
|
*/
|
|
110219
110044
|
moon = "Moon",
|
|
110220
110045
|
/**
|
|
110221
110046
|
* Smiley face geometric shape.
|
|
110222
110047
|
* @remarks
|
|
110223
|
-
* [Api set:
|
|
110224
|
-
* @beta
|
|
110048
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110225
110049
|
*/
|
|
110226
110050
|
smileyFace = "SmileyFace",
|
|
110227
110051
|
/**
|
|
110228
110052
|
* Irregular seal 1 geometric shape.
|
|
110229
110053
|
* @remarks
|
|
110230
|
-
* [Api set:
|
|
110231
|
-
* @beta
|
|
110054
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110232
110055
|
*/
|
|
110233
110056
|
irregularSeal1 = "IrregularSeal1",
|
|
110234
110057
|
/**
|
|
110235
110058
|
* Irregular seal 2 geometric shape.
|
|
110236
110059
|
* @remarks
|
|
110237
|
-
* [Api set:
|
|
110238
|
-
* @beta
|
|
110060
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110239
110061
|
*/
|
|
110240
110062
|
irregularSeal2 = "IrregularSeal2",
|
|
110241
110063
|
/**
|
|
110242
110064
|
* Folded corner geometric shape.
|
|
110243
110065
|
* @remarks
|
|
110244
|
-
* [Api set:
|
|
110245
|
-
* @beta
|
|
110066
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110246
110067
|
*/
|
|
110247
110068
|
foldedCorner = "FoldedCorner",
|
|
110248
110069
|
/**
|
|
110249
110070
|
* Bevel geometric shape.
|
|
110250
110071
|
* @remarks
|
|
110251
|
-
* [Api set:
|
|
110252
|
-
* @beta
|
|
110072
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110253
110073
|
*/
|
|
110254
110074
|
bevel = "Bevel",
|
|
110255
110075
|
/**
|
|
110256
110076
|
* Frame geometric shape.
|
|
110257
110077
|
* @remarks
|
|
110258
|
-
* [Api set:
|
|
110259
|
-
* @beta
|
|
110078
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110260
110079
|
*/
|
|
110261
110080
|
frame = "Frame",
|
|
110262
110081
|
/**
|
|
110263
110082
|
* Half frame geometric shape.
|
|
110264
110083
|
* @remarks
|
|
110265
|
-
* [Api set:
|
|
110266
|
-
* @beta
|
|
110084
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110267
110085
|
*/
|
|
110268
110086
|
halfFrame = "HalfFrame",
|
|
110269
110087
|
/**
|
|
110270
110088
|
* Corner geometric shape.
|
|
110271
110089
|
* @remarks
|
|
110272
|
-
* [Api set:
|
|
110273
|
-
* @beta
|
|
110090
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110274
110091
|
*/
|
|
110275
110092
|
corner = "Corner",
|
|
110276
110093
|
/**
|
|
110277
110094
|
* Diagonal stripe geometric shape.
|
|
110278
110095
|
* @remarks
|
|
110279
|
-
* [Api set:
|
|
110280
|
-
* @beta
|
|
110096
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110281
110097
|
*/
|
|
110282
110098
|
diagonalStripe = "DiagonalStripe",
|
|
110283
110099
|
/**
|
|
110284
110100
|
* Chord geometric shape.
|
|
110285
110101
|
* @remarks
|
|
110286
|
-
* [Api set:
|
|
110287
|
-
* @beta
|
|
110102
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110288
110103
|
*/
|
|
110289
110104
|
chord = "Chord",
|
|
110290
110105
|
/**
|
|
110291
110106
|
* Arc geometric shape.
|
|
110292
110107
|
* @remarks
|
|
110293
|
-
* [Api set:
|
|
110294
|
-
* @beta
|
|
110108
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110295
110109
|
*/
|
|
110296
110110
|
arc = "Arc",
|
|
110297
110111
|
/**
|
|
110298
110112
|
* Left bracket geometric shape.
|
|
110299
110113
|
* @remarks
|
|
110300
|
-
* [Api set:
|
|
110301
|
-
* @beta
|
|
110114
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110302
110115
|
*/
|
|
110303
110116
|
leftBracket = "LeftBracket",
|
|
110304
110117
|
/**
|
|
110305
110118
|
* Right bracket geometric shape.
|
|
110306
110119
|
* @remarks
|
|
110307
|
-
* [Api set:
|
|
110308
|
-
* @beta
|
|
110120
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110309
110121
|
*/
|
|
110310
110122
|
rightBracket = "RightBracket",
|
|
110311
110123
|
/**
|
|
110312
110124
|
* Left brace geometric shape.
|
|
110313
110125
|
* @remarks
|
|
110314
|
-
* [Api set:
|
|
110315
|
-
* @beta
|
|
110126
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110316
110127
|
*/
|
|
110317
110128
|
leftBrace = "LeftBrace",
|
|
110318
110129
|
/**
|
|
110319
110130
|
* Right brace geometric shape.
|
|
110320
110131
|
* @remarks
|
|
110321
|
-
* [Api set:
|
|
110322
|
-
* @beta
|
|
110132
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110323
110133
|
*/
|
|
110324
110134
|
rightBrace = "RightBrace",
|
|
110325
110135
|
/**
|
|
110326
110136
|
* Bracket pair geometric shape.
|
|
110327
110137
|
* @remarks
|
|
110328
|
-
* [Api set:
|
|
110329
|
-
* @beta
|
|
110138
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110330
110139
|
*/
|
|
110331
110140
|
bracketPair = "BracketPair",
|
|
110332
110141
|
/**
|
|
110333
110142
|
* Brace pair geometric shape.
|
|
110334
110143
|
* @remarks
|
|
110335
|
-
* [Api set:
|
|
110336
|
-
* @beta
|
|
110144
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110337
110145
|
*/
|
|
110338
110146
|
bracePair = "BracePair",
|
|
110339
110147
|
/**
|
|
110340
110148
|
* Callout 1 geometric shape.
|
|
110341
110149
|
* @remarks
|
|
110342
|
-
* [Api set:
|
|
110343
|
-
* @beta
|
|
110150
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110344
110151
|
*/
|
|
110345
110152
|
callout1 = "Callout1",
|
|
110346
110153
|
/**
|
|
110347
110154
|
* Callout 2 geometric shape.
|
|
110348
110155
|
* @remarks
|
|
110349
|
-
* [Api set:
|
|
110350
|
-
* @beta
|
|
110156
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110351
110157
|
*/
|
|
110352
110158
|
callout2 = "Callout2",
|
|
110353
110159
|
/**
|
|
110354
110160
|
* Callout 3 geometric shape.
|
|
110355
110161
|
* @remarks
|
|
110356
|
-
* [Api set:
|
|
110357
|
-
* @beta
|
|
110162
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110358
110163
|
*/
|
|
110359
110164
|
callout3 = "Callout3",
|
|
110360
110165
|
/**
|
|
110361
110166
|
* Accent callout 1 geometric shape.
|
|
110362
110167
|
* @remarks
|
|
110363
|
-
* [Api set:
|
|
110364
|
-
* @beta
|
|
110168
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110365
110169
|
*/
|
|
110366
110170
|
accentCallout1 = "AccentCallout1",
|
|
110367
110171
|
/**
|
|
110368
110172
|
* Accent callout 2 geometric shape.
|
|
110369
110173
|
* @remarks
|
|
110370
|
-
* [Api set:
|
|
110371
|
-
* @beta
|
|
110174
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110372
110175
|
*/
|
|
110373
110176
|
accentCallout2 = "AccentCallout2",
|
|
110374
110177
|
/**
|
|
110375
110178
|
* Accent callout 3 geometric shape.
|
|
110376
110179
|
* @remarks
|
|
110377
|
-
* [Api set:
|
|
110378
|
-
* @beta
|
|
110180
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110379
110181
|
*/
|
|
110380
110182
|
accentCallout3 = "AccentCallout3",
|
|
110381
110183
|
/**
|
|
110382
110184
|
* Border callout 1 geometric shape.
|
|
110383
110185
|
* @remarks
|
|
110384
|
-
* [Api set:
|
|
110385
|
-
* @beta
|
|
110186
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110386
110187
|
*/
|
|
110387
110188
|
borderCallout1 = "BorderCallout1",
|
|
110388
110189
|
/**
|
|
110389
110190
|
* Border callout 2 geometric shape.
|
|
110390
110191
|
* @remarks
|
|
110391
|
-
* [Api set:
|
|
110392
|
-
* @beta
|
|
110192
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110393
110193
|
*/
|
|
110394
110194
|
borderCallout2 = "BorderCallout2",
|
|
110395
110195
|
/**
|
|
110396
110196
|
* Border callout 3 geometric shape.
|
|
110397
110197
|
* @remarks
|
|
110398
|
-
* [Api set:
|
|
110399
|
-
* @beta
|
|
110198
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110400
110199
|
*/
|
|
110401
110200
|
borderCallout3 = "BorderCallout3",
|
|
110402
110201
|
/**
|
|
110403
110202
|
* Accent border callout 1 geometric shape.
|
|
110404
110203
|
* @remarks
|
|
110405
|
-
* [Api set:
|
|
110406
|
-
* @beta
|
|
110204
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110407
110205
|
*/
|
|
110408
110206
|
accentBorderCallout1 = "AccentBorderCallout1",
|
|
110409
110207
|
/**
|
|
110410
110208
|
* Accent border callout 2 geometric shape.
|
|
110411
110209
|
* @remarks
|
|
110412
|
-
* [Api set:
|
|
110413
|
-
* @beta
|
|
110210
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110414
110211
|
*/
|
|
110415
110212
|
accentBorderCallout2 = "AccentBorderCallout2",
|
|
110416
110213
|
/**
|
|
110417
110214
|
* Accent border callout 3 geometric shape.
|
|
110418
110215
|
* @remarks
|
|
110419
|
-
* [Api set:
|
|
110420
|
-
* @beta
|
|
110216
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110421
110217
|
*/
|
|
110422
110218
|
accentBorderCallout3 = "AccentBorderCallout3",
|
|
110423
110219
|
/**
|
|
110424
110220
|
* Wedge rectangle callout geometric shape.
|
|
110425
110221
|
* @remarks
|
|
110426
|
-
* [Api set:
|
|
110427
|
-
* @beta
|
|
110222
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110428
110223
|
*/
|
|
110429
110224
|
wedgeRectCallout = "WedgeRectCallout",
|
|
110430
110225
|
/**
|
|
110431
110226
|
* Wedge rounded rectangle callout geometric shape.
|
|
110432
110227
|
* @remarks
|
|
110433
|
-
* [Api set:
|
|
110434
|
-
* @beta
|
|
110228
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110435
110229
|
*/
|
|
110436
110230
|
wedgeRRectCallout = "WedgeRRectCallout",
|
|
110437
110231
|
/**
|
|
110438
110232
|
* Wedge ellipse callout geometric shape.
|
|
110439
110233
|
* @remarks
|
|
110440
|
-
* [Api set:
|
|
110441
|
-
* @beta
|
|
110234
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110442
110235
|
*/
|
|
110443
110236
|
wedgeEllipseCallout = "WedgeEllipseCallout",
|
|
110444
110237
|
/**
|
|
110445
110238
|
* Cloud callout geometric shape.
|
|
110446
110239
|
* @remarks
|
|
110447
|
-
* [Api set:
|
|
110448
|
-
* @beta
|
|
110240
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110449
110241
|
*/
|
|
110450
110242
|
cloudCallout = "CloudCallout",
|
|
110451
110243
|
/**
|
|
110452
110244
|
* Cloud geometric shape.
|
|
110453
110245
|
* @remarks
|
|
110454
|
-
* [Api set:
|
|
110455
|
-
* @beta
|
|
110246
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110456
110247
|
*/
|
|
110457
110248
|
cloud = "Cloud",
|
|
110458
110249
|
/**
|
|
110459
110250
|
* Ribbon geometric shape.
|
|
110460
110251
|
* @remarks
|
|
110461
|
-
* [Api set:
|
|
110462
|
-
* @beta
|
|
110252
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110463
110253
|
*/
|
|
110464
110254
|
ribbon = "Ribbon",
|
|
110465
110255
|
/**
|
|
110466
110256
|
* Ribbon 2 geometric shape.
|
|
110467
110257
|
* @remarks
|
|
110468
|
-
* [Api set:
|
|
110469
|
-
* @beta
|
|
110258
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110470
110259
|
*/
|
|
110471
110260
|
ribbon2 = "Ribbon2",
|
|
110472
110261
|
/**
|
|
110473
110262
|
* Ellipse ribbon geometric shape.
|
|
110474
110263
|
* @remarks
|
|
110475
|
-
* [Api set:
|
|
110476
|
-
* @beta
|
|
110264
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110477
110265
|
*/
|
|
110478
110266
|
ellipseRibbon = "EllipseRibbon",
|
|
110479
110267
|
/**
|
|
110480
110268
|
* Ellipse ribbon 2 geometric shape.
|
|
110481
110269
|
* @remarks
|
|
110482
|
-
* [Api set:
|
|
110483
|
-
* @beta
|
|
110270
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110484
110271
|
*/
|
|
110485
110272
|
ellipseRibbon2 = "EllipseRibbon2",
|
|
110486
110273
|
/**
|
|
110487
110274
|
* Left-right ribbon geometric shape.
|
|
110488
110275
|
* @remarks
|
|
110489
|
-
* [Api set:
|
|
110490
|
-
* @beta
|
|
110276
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110491
110277
|
*/
|
|
110492
110278
|
leftRightRibbon = "LeftRightRibbon",
|
|
110493
110279
|
/**
|
|
110494
110280
|
* Vertical scroll geometric shape.
|
|
110495
110281
|
* @remarks
|
|
110496
|
-
* [Api set:
|
|
110497
|
-
* @beta
|
|
110282
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110498
110283
|
*/
|
|
110499
110284
|
verticalScroll = "VerticalScroll",
|
|
110500
110285
|
/**
|
|
110501
110286
|
* Horizontal scroll geometric shape.
|
|
110502
110287
|
* @remarks
|
|
110503
|
-
* [Api set:
|
|
110504
|
-
* @beta
|
|
110288
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110505
110289
|
*/
|
|
110506
110290
|
horizontalScroll = "HorizontalScroll",
|
|
110507
110291
|
/**
|
|
110508
110292
|
* Wave geometric shape.
|
|
110509
110293
|
* @remarks
|
|
110510
|
-
* [Api set:
|
|
110511
|
-
* @beta
|
|
110294
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110512
110295
|
*/
|
|
110513
110296
|
wave = "Wave",
|
|
110514
110297
|
/**
|
|
110515
110298
|
* Double wave geometric shape.
|
|
110516
110299
|
* @remarks
|
|
110517
|
-
* [Api set:
|
|
110518
|
-
* @beta
|
|
110300
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110519
110301
|
*/
|
|
110520
110302
|
doubleWave = "DoubleWave",
|
|
110521
110303
|
/**
|
|
110522
110304
|
* Plus geometric shape.
|
|
110523
110305
|
* @remarks
|
|
110524
|
-
* [Api set:
|
|
110525
|
-
* @beta
|
|
110306
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110526
110307
|
*/
|
|
110527
110308
|
plus = "Plus",
|
|
110528
110309
|
/**
|
|
110529
110310
|
* Flow chart process geometric shape.
|
|
110530
110311
|
* @remarks
|
|
110531
|
-
* [Api set:
|
|
110532
|
-
* @beta
|
|
110312
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110533
110313
|
*/
|
|
110534
110314
|
flowChartProcess = "FlowChartProcess",
|
|
110535
110315
|
/**
|
|
110536
110316
|
* Flow chart decision geometric shape.
|
|
110537
110317
|
* @remarks
|
|
110538
|
-
* [Api set:
|
|
110539
|
-
* @beta
|
|
110318
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110540
110319
|
*/
|
|
110541
110320
|
flowChartDecision = "FlowChartDecision",
|
|
110542
110321
|
/**
|
|
110543
110322
|
* Flow chart input-output geometric shape.
|
|
110544
110323
|
* @remarks
|
|
110545
|
-
* [Api set:
|
|
110546
|
-
* @beta
|
|
110324
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110547
110325
|
*/
|
|
110548
110326
|
flowChartInputOutput = "FlowChartInputOutput",
|
|
110549
110327
|
/**
|
|
110550
110328
|
* Flow chart predefined process geometric shape.
|
|
110551
110329
|
* @remarks
|
|
110552
|
-
* [Api set:
|
|
110553
|
-
* @beta
|
|
110330
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110554
110331
|
*/
|
|
110555
110332
|
flowChartPredefinedProcess = "FlowChartPredefinedProcess",
|
|
110556
110333
|
/**
|
|
110557
110334
|
* Flow chart internal storage geometric shape.
|
|
110558
110335
|
* @remarks
|
|
110559
|
-
* [Api set:
|
|
110560
|
-
* @beta
|
|
110336
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110561
110337
|
*/
|
|
110562
110338
|
flowChartInternalStorage = "FlowChartInternalStorage",
|
|
110563
110339
|
/**
|
|
110564
110340
|
* Flow chart document geometric shape.
|
|
110565
110341
|
* @remarks
|
|
110566
|
-
* [Api set:
|
|
110567
|
-
* @beta
|
|
110342
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110568
110343
|
*/
|
|
110569
110344
|
flowChartDocument = "FlowChartDocument",
|
|
110570
110345
|
/**
|
|
110571
110346
|
* Flow chart multidocument geometric shape.
|
|
110572
110347
|
* @remarks
|
|
110573
|
-
* [Api set:
|
|
110574
|
-
* @beta
|
|
110348
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110575
110349
|
*/
|
|
110576
110350
|
flowChartMultidocument = "FlowChartMultidocument",
|
|
110577
110351
|
/**
|
|
110578
110352
|
* Flow chart terminator geometric shape.
|
|
110579
110353
|
* @remarks
|
|
110580
|
-
* [Api set:
|
|
110581
|
-
* @beta
|
|
110354
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110582
110355
|
*/
|
|
110583
110356
|
flowChartTerminator = "FlowChartTerminator",
|
|
110584
110357
|
/**
|
|
110585
110358
|
* Flow chart preparation geometric shape.
|
|
110586
110359
|
* @remarks
|
|
110587
|
-
* [Api set:
|
|
110588
|
-
* @beta
|
|
110360
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110589
110361
|
*/
|
|
110590
110362
|
flowChartPreparation = "FlowChartPreparation",
|
|
110591
110363
|
/**
|
|
110592
110364
|
* Flow chart manual input geometric shape.
|
|
110593
110365
|
* @remarks
|
|
110594
|
-
* [Api set:
|
|
110595
|
-
* @beta
|
|
110366
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110596
110367
|
*/
|
|
110597
110368
|
flowChartManualInput = "FlowChartManualInput",
|
|
110598
110369
|
/**
|
|
110599
110370
|
* Flow chart manual operation geometric shape.
|
|
110600
110371
|
* @remarks
|
|
110601
|
-
* [Api set:
|
|
110602
|
-
* @beta
|
|
110372
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110603
110373
|
*/
|
|
110604
110374
|
flowChartManualOperation = "FlowChartManualOperation",
|
|
110605
110375
|
/**
|
|
110606
110376
|
* Flow chart connector geometric shape.
|
|
110607
110377
|
* @remarks
|
|
110608
|
-
* [Api set:
|
|
110609
|
-
* @beta
|
|
110378
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110610
110379
|
*/
|
|
110611
110380
|
flowChartConnector = "FlowChartConnector",
|
|
110612
110381
|
/**
|
|
110613
110382
|
* Flow chart punched card geometric shape.
|
|
110614
110383
|
* @remarks
|
|
110615
|
-
* [Api set:
|
|
110616
|
-
* @beta
|
|
110384
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110617
110385
|
*/
|
|
110618
110386
|
flowChartPunchedCard = "FlowChartPunchedCard",
|
|
110619
110387
|
/**
|
|
110620
110388
|
* Flow chart punched tape geometric shape.
|
|
110621
110389
|
* @remarks
|
|
110622
|
-
* [Api set:
|
|
110623
|
-
* @beta
|
|
110390
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110624
110391
|
*/
|
|
110625
110392
|
flowChartPunchedTape = "FlowChartPunchedTape",
|
|
110626
110393
|
/**
|
|
110627
110394
|
* Flow chart summing junction geometric shape.
|
|
110628
110395
|
* @remarks
|
|
110629
|
-
* [Api set:
|
|
110630
|
-
* @beta
|
|
110396
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110631
110397
|
*/
|
|
110632
110398
|
flowChartSummingJunction = "FlowChartSummingJunction",
|
|
110633
110399
|
/**
|
|
110634
110400
|
* Flow chart OR geometric shape.
|
|
110635
110401
|
* @remarks
|
|
110636
|
-
* [Api set:
|
|
110637
|
-
* @beta
|
|
110402
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110638
110403
|
*/
|
|
110639
110404
|
flowChartOr = "FlowChartOr",
|
|
110640
110405
|
/**
|
|
110641
110406
|
* Flow chart collate geometric shape.
|
|
110642
110407
|
* @remarks
|
|
110643
|
-
* [Api set:
|
|
110644
|
-
* @beta
|
|
110408
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110645
110409
|
*/
|
|
110646
110410
|
flowChartCollate = "FlowChartCollate",
|
|
110647
110411
|
/**
|
|
110648
110412
|
* Flow chart sort geometric shape.
|
|
110649
110413
|
* @remarks
|
|
110650
|
-
* [Api set:
|
|
110651
|
-
* @beta
|
|
110414
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110652
110415
|
*/
|
|
110653
110416
|
flowChartSort = "FlowChartSort",
|
|
110654
110417
|
/**
|
|
110655
110418
|
* Flow chart extract geometric shape.
|
|
110656
110419
|
* @remarks
|
|
110657
|
-
* [Api set:
|
|
110658
|
-
* @beta
|
|
110420
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110659
110421
|
*/
|
|
110660
110422
|
flowChartExtract = "FlowChartExtract",
|
|
110661
110423
|
/**
|
|
110662
110424
|
* Flow chart merge geometric shape.
|
|
110663
110425
|
* @remarks
|
|
110664
|
-
* [Api set:
|
|
110665
|
-
* @beta
|
|
110426
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110666
110427
|
*/
|
|
110667
110428
|
flowChartMerge = "FlowChartMerge",
|
|
110668
110429
|
/**
|
|
110669
110430
|
* Flow chart offline storage geometric shape.
|
|
110670
110431
|
* @remarks
|
|
110671
|
-
* [Api set:
|
|
110672
|
-
* @beta
|
|
110432
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110673
110433
|
*/
|
|
110674
110434
|
flowChartOfflineStorage = "FlowChartOfflineStorage",
|
|
110675
110435
|
/**
|
|
110676
110436
|
* Flow chart online storage geometric shape.
|
|
110677
110437
|
* @remarks
|
|
110678
|
-
* [Api set:
|
|
110679
|
-
* @beta
|
|
110438
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110680
110439
|
*/
|
|
110681
110440
|
flowChartOnlineStorage = "FlowChartOnlineStorage",
|
|
110682
110441
|
/**
|
|
110683
110442
|
* Flow chart magnetic tape geometric shape.
|
|
110684
110443
|
* @remarks
|
|
110685
|
-
* [Api set:
|
|
110686
|
-
* @beta
|
|
110444
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110687
110445
|
*/
|
|
110688
110446
|
flowChartMagneticTape = "FlowChartMagneticTape",
|
|
110689
110447
|
/**
|
|
110690
110448
|
* Flow chart magnetic disk geometric shape.
|
|
110691
110449
|
* @remarks
|
|
110692
|
-
* [Api set:
|
|
110693
|
-
* @beta
|
|
110450
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110694
110451
|
*/
|
|
110695
110452
|
flowChartMagneticDisk = "FlowChartMagneticDisk",
|
|
110696
110453
|
/**
|
|
110697
110454
|
* Flow chart magnetic drum geometric shape.
|
|
110698
110455
|
* @remarks
|
|
110699
|
-
* [Api set:
|
|
110700
|
-
* @beta
|
|
110456
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110701
110457
|
*/
|
|
110702
110458
|
flowChartMagneticDrum = "FlowChartMagneticDrum",
|
|
110703
110459
|
/**
|
|
110704
110460
|
* Flow chart display geometric shape.
|
|
110705
110461
|
* @remarks
|
|
110706
|
-
* [Api set:
|
|
110707
|
-
* @beta
|
|
110462
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110708
110463
|
*/
|
|
110709
110464
|
flowChartDisplay = "FlowChartDisplay",
|
|
110710
110465
|
/**
|
|
110711
110466
|
* Flow chart delay geometric shape.
|
|
110712
110467
|
* @remarks
|
|
110713
|
-
* [Api set:
|
|
110714
|
-
* @beta
|
|
110468
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110715
110469
|
*/
|
|
110716
110470
|
flowChartDelay = "FlowChartDelay",
|
|
110717
110471
|
/**
|
|
110718
110472
|
* Flow chart alternate process geometric shape.
|
|
110719
110473
|
* @remarks
|
|
110720
|
-
* [Api set:
|
|
110721
|
-
* @beta
|
|
110474
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110722
110475
|
*/
|
|
110723
110476
|
flowChartAlternateProcess = "FlowChartAlternateProcess",
|
|
110724
110477
|
/**
|
|
110725
110478
|
* Flow chart off-page connector geometric shape.
|
|
110726
110479
|
* @remarks
|
|
110727
|
-
* [Api set:
|
|
110728
|
-
* @beta
|
|
110480
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110729
110481
|
*/
|
|
110730
110482
|
flowChartOffpageConnector = "FlowChartOffpageConnector",
|
|
110731
110483
|
/**
|
|
110732
110484
|
* Action button blank geometric shape.
|
|
110733
110485
|
* @remarks
|
|
110734
|
-
* [Api set:
|
|
110735
|
-
* @beta
|
|
110486
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110736
110487
|
*/
|
|
110737
110488
|
actionButtonBlank = "ActionButtonBlank",
|
|
110738
110489
|
/**
|
|
110739
110490
|
* Action button home geometric shape.
|
|
110740
110491
|
* @remarks
|
|
110741
|
-
* [Api set:
|
|
110742
|
-
* @beta
|
|
110492
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110743
110493
|
*/
|
|
110744
110494
|
actionButtonHome = "ActionButtonHome",
|
|
110745
110495
|
/**
|
|
110746
110496
|
* Action button help geometric shape.
|
|
110747
110497
|
* @remarks
|
|
110748
|
-
* [Api set:
|
|
110749
|
-
* @beta
|
|
110498
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110750
110499
|
*/
|
|
110751
110500
|
actionButtonHelp = "ActionButtonHelp",
|
|
110752
110501
|
/**
|
|
110753
110502
|
* Action button information geometric shape.
|
|
110754
110503
|
* @remarks
|
|
110755
|
-
* [Api set:
|
|
110756
|
-
* @beta
|
|
110504
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110757
110505
|
*/
|
|
110758
110506
|
actionButtonInformation = "ActionButtonInformation",
|
|
110759
110507
|
/**
|
|
110760
110508
|
* Action button forward next geometric shape.
|
|
110761
110509
|
* @remarks
|
|
110762
|
-
* [Api set:
|
|
110763
|
-
* @beta
|
|
110510
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110764
110511
|
*/
|
|
110765
110512
|
actionButtonForwardNext = "ActionButtonForwardNext",
|
|
110766
110513
|
/**
|
|
110767
110514
|
* Action button back previous geometric shape.
|
|
110768
110515
|
* @remarks
|
|
110769
|
-
* [Api set:
|
|
110770
|
-
* @beta
|
|
110516
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110771
110517
|
*/
|
|
110772
110518
|
actionButtonBackPrevious = "ActionButtonBackPrevious",
|
|
110773
110519
|
/**
|
|
110774
110520
|
* Action button end geometric shape.
|
|
110775
110521
|
* @remarks
|
|
110776
|
-
* [Api set:
|
|
110777
|
-
* @beta
|
|
110522
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110778
110523
|
*/
|
|
110779
110524
|
actionButtonEnd = "ActionButtonEnd",
|
|
110780
110525
|
/**
|
|
110781
110526
|
* Action button beginning geometric shape.
|
|
110782
110527
|
* @remarks
|
|
110783
|
-
* [Api set:
|
|
110784
|
-
* @beta
|
|
110528
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110785
110529
|
*/
|
|
110786
110530
|
actionButtonBeginning = "ActionButtonBeginning",
|
|
110787
110531
|
/**
|
|
110788
110532
|
* Action button return geometric shape.
|
|
110789
110533
|
* @remarks
|
|
110790
|
-
* [Api set:
|
|
110791
|
-
* @beta
|
|
110534
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110792
110535
|
*/
|
|
110793
110536
|
actionButtonReturn = "ActionButtonReturn",
|
|
110794
110537
|
/**
|
|
110795
110538
|
* Action button document geometric shape.
|
|
110796
110539
|
* @remarks
|
|
110797
|
-
* [Api set:
|
|
110798
|
-
* @beta
|
|
110540
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110799
110541
|
*/
|
|
110800
110542
|
actionButtonDocument = "ActionButtonDocument",
|
|
110801
110543
|
/**
|
|
110802
110544
|
* Action button sound geometric shape.
|
|
110803
110545
|
* @remarks
|
|
110804
|
-
* [Api set:
|
|
110805
|
-
* @beta
|
|
110546
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110806
110547
|
*/
|
|
110807
110548
|
actionButtonSound = "ActionButtonSound",
|
|
110808
110549
|
/**
|
|
110809
110550
|
* Action button movie geometric shape.
|
|
110810
110551
|
* @remarks
|
|
110811
|
-
* [Api set:
|
|
110812
|
-
* @beta
|
|
110552
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110813
110553
|
*/
|
|
110814
110554
|
actionButtonMovie = "ActionButtonMovie",
|
|
110815
110555
|
/**
|
|
110816
110556
|
* Gear 6 geometric shape.
|
|
110817
110557
|
* @remarks
|
|
110818
|
-
* [Api set:
|
|
110819
|
-
* @beta
|
|
110558
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110820
110559
|
*/
|
|
110821
110560
|
gear6 = "Gear6",
|
|
110822
110561
|
/**
|
|
110823
110562
|
* Gear 9 geometric shape.
|
|
110824
110563
|
* @remarks
|
|
110825
|
-
* [Api set:
|
|
110826
|
-
* @beta
|
|
110564
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110827
110565
|
*/
|
|
110828
110566
|
gear9 = "Gear9",
|
|
110829
110567
|
/**
|
|
110830
110568
|
* Funnel geometric shape.
|
|
110831
110569
|
* @remarks
|
|
110832
|
-
* [Api set:
|
|
110833
|
-
* @beta
|
|
110570
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110834
110571
|
*/
|
|
110835
110572
|
funnel = "Funnel",
|
|
110836
110573
|
/**
|
|
110837
110574
|
* Math plus geometric shape.
|
|
110838
110575
|
* @remarks
|
|
110839
|
-
* [Api set:
|
|
110840
|
-
* @beta
|
|
110576
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110841
110577
|
*/
|
|
110842
110578
|
mathPlus = "MathPlus",
|
|
110843
110579
|
/**
|
|
110844
110580
|
* Math minus geometric shape.
|
|
110845
110581
|
* @remarks
|
|
110846
|
-
* [Api set:
|
|
110847
|
-
* @beta
|
|
110582
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110848
110583
|
*/
|
|
110849
110584
|
mathMinus = "MathMinus",
|
|
110850
110585
|
/**
|
|
110851
110586
|
* Math multiply geometric shape.
|
|
110852
110587
|
* @remarks
|
|
110853
|
-
* [Api set:
|
|
110854
|
-
* @beta
|
|
110588
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110855
110589
|
*/
|
|
110856
110590
|
mathMultiply = "MathMultiply",
|
|
110857
110591
|
/**
|
|
110858
110592
|
* Math divide geometric shape.
|
|
110859
110593
|
* @remarks
|
|
110860
|
-
* [Api set:
|
|
110861
|
-
* @beta
|
|
110594
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110862
110595
|
*/
|
|
110863
110596
|
mathDivide = "MathDivide",
|
|
110864
110597
|
/**
|
|
110865
110598
|
* Math equal geometric shape.
|
|
110866
110599
|
* @remarks
|
|
110867
|
-
* [Api set:
|
|
110868
|
-
* @beta
|
|
110600
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110869
110601
|
*/
|
|
110870
110602
|
mathEqual = "MathEqual",
|
|
110871
110603
|
/**
|
|
110872
110604
|
* Math not equal geometric shape.
|
|
110873
110605
|
* @remarks
|
|
110874
|
-
* [Api set:
|
|
110875
|
-
* @beta
|
|
110606
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110876
110607
|
*/
|
|
110877
110608
|
mathNotEqual = "MathNotEqual",
|
|
110878
110609
|
/**
|
|
110879
110610
|
* Corner tabs geometric shape.
|
|
110880
110611
|
* @remarks
|
|
110881
|
-
* [Api set:
|
|
110882
|
-
* @beta
|
|
110612
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110883
110613
|
*/
|
|
110884
110614
|
cornerTabs = "CornerTabs",
|
|
110885
110615
|
/**
|
|
110886
110616
|
* Square tabs geometric shape.
|
|
110887
110617
|
* @remarks
|
|
110888
|
-
* [Api set:
|
|
110889
|
-
* @beta
|
|
110618
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110890
110619
|
*/
|
|
110891
110620
|
squareTabs = "SquareTabs",
|
|
110892
110621
|
/**
|
|
110893
110622
|
* Plaque tabs geometric shape.
|
|
110894
110623
|
* @remarks
|
|
110895
|
-
* [Api set:
|
|
110896
|
-
* @beta
|
|
110624
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110897
110625
|
*/
|
|
110898
110626
|
plaqueTabs = "PlaqueTabs",
|
|
110899
110627
|
/**
|
|
110900
110628
|
* Chart X geometric shape.
|
|
110901
110629
|
* @remarks
|
|
110902
|
-
* [Api set:
|
|
110903
|
-
* @beta
|
|
110630
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110904
110631
|
*/
|
|
110905
110632
|
chartX = "ChartX",
|
|
110906
110633
|
/**
|
|
110907
110634
|
* Chart star geometric shape.
|
|
110908
110635
|
* @remarks
|
|
110909
|
-
* [Api set:
|
|
110910
|
-
* @beta
|
|
110636
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110911
110637
|
*/
|
|
110912
110638
|
chartStar = "ChartStar",
|
|
110913
110639
|
/**
|
|
110914
110640
|
* Chart plus geometric shape.
|
|
110915
110641
|
* @remarks
|
|
110916
|
-
* [Api set:
|
|
110917
|
-
* @beta
|
|
110642
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110918
110643
|
*/
|
|
110919
110644
|
chartPlus = "ChartPlus",
|
|
110920
110645
|
}
|
|
@@ -110922,57 +110647,49 @@ declare namespace Word {
|
|
|
110922
110647
|
* Specifies a shape's fill type.
|
|
110923
110648
|
*
|
|
110924
110649
|
* @remarks
|
|
110925
|
-
* [Api set:
|
|
110926
|
-
* @beta
|
|
110650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110927
110651
|
*/
|
|
110928
110652
|
enum ShapeFillType {
|
|
110929
110653
|
/**
|
|
110930
110654
|
* No fill.
|
|
110931
110655
|
* @remarks
|
|
110932
|
-
* [Api set:
|
|
110933
|
-
* @beta
|
|
110656
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110934
110657
|
*/
|
|
110935
110658
|
noFill = "NoFill",
|
|
110936
110659
|
/**
|
|
110937
110660
|
* Solid fill.
|
|
110938
110661
|
* @remarks
|
|
110939
|
-
* [Api set:
|
|
110940
|
-
* @beta
|
|
110662
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110941
110663
|
*/
|
|
110942
110664
|
solid = "Solid",
|
|
110943
110665
|
/**
|
|
110944
110666
|
* Gradient fill.
|
|
110945
110667
|
* @remarks
|
|
110946
|
-
* [Api set:
|
|
110947
|
-
* @beta
|
|
110668
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110948
110669
|
*/
|
|
110949
110670
|
gradient = "Gradient",
|
|
110950
110671
|
/**
|
|
110951
110672
|
* Pattern fill.
|
|
110952
110673
|
* @remarks
|
|
110953
|
-
* [Api set:
|
|
110954
|
-
* @beta
|
|
110674
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110955
110675
|
*/
|
|
110956
110676
|
pattern = "Pattern",
|
|
110957
110677
|
/**
|
|
110958
110678
|
* Picture fill.
|
|
110959
110679
|
* @remarks
|
|
110960
|
-
* [Api set:
|
|
110961
|
-
* @beta
|
|
110680
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110962
110681
|
*/
|
|
110963
110682
|
picture = "Picture",
|
|
110964
110683
|
/**
|
|
110965
110684
|
* Texture fill.
|
|
110966
110685
|
* @remarks
|
|
110967
|
-
* [Api set:
|
|
110968
|
-
* @beta
|
|
110686
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110969
110687
|
*/
|
|
110970
110688
|
texture = "Texture",
|
|
110971
110689
|
/**
|
|
110972
110690
|
* Mixed fill.
|
|
110973
110691
|
* @remarks
|
|
110974
|
-
* [Api set:
|
|
110975
|
-
* @beta
|
|
110692
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110976
110693
|
*/
|
|
110977
110694
|
mixed = "Mixed",
|
|
110978
110695
|
}
|
|
@@ -110980,29 +110697,25 @@ declare namespace Word {
|
|
|
110980
110697
|
* Specifies the vertical alignment for the text frame in a shape.
|
|
110981
110698
|
*
|
|
110982
110699
|
* @remarks
|
|
110983
|
-
* [Api set:
|
|
110984
|
-
* @beta
|
|
110700
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110985
110701
|
*/
|
|
110986
110702
|
enum ShapeTextVerticalAlignment {
|
|
110987
110703
|
/**
|
|
110988
110704
|
* Anchor the text at the top of the bounding rectangle.
|
|
110989
110705
|
* @remarks
|
|
110990
|
-
* [Api set:
|
|
110991
|
-
* @beta
|
|
110706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110992
110707
|
*/
|
|
110993
110708
|
top = "Top",
|
|
110994
110709
|
/**
|
|
110995
110710
|
* Anchor the text at the middle of the bounding rectangle.
|
|
110996
110711
|
* @remarks
|
|
110997
|
-
* [Api set:
|
|
110998
|
-
* @beta
|
|
110712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110999
110713
|
*/
|
|
111000
110714
|
middle = "Middle",
|
|
111001
110715
|
/**
|
|
111002
110716
|
* Anchor the text at the bottom of the bounding rectangle.
|
|
111003
110717
|
* @remarks
|
|
111004
|
-
* [Api set:
|
|
111005
|
-
* @beta
|
|
110718
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111006
110719
|
*/
|
|
111007
110720
|
bottom = "Bottom",
|
|
111008
110721
|
}
|
|
@@ -111010,57 +110723,49 @@ declare namespace Word {
|
|
|
111010
110723
|
* Specifies the orientation for the text frame in a shape.
|
|
111011
110724
|
*
|
|
111012
110725
|
* @remarks
|
|
111013
|
-
* [Api set:
|
|
111014
|
-
* @beta
|
|
110726
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111015
110727
|
*/
|
|
111016
110728
|
enum ShapeTextOrientation {
|
|
111017
110729
|
/**
|
|
111018
110730
|
* No orientation, such as in a new geometric shape.
|
|
111019
110731
|
* @remarks
|
|
111020
|
-
* [Api set:
|
|
111021
|
-
* @beta
|
|
110732
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111022
110733
|
*/
|
|
111023
110734
|
none = "None",
|
|
111024
110735
|
/**
|
|
111025
110736
|
* Horizontal text.
|
|
111026
110737
|
* @remarks
|
|
111027
|
-
* [Api set:
|
|
111028
|
-
* @beta
|
|
110738
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111029
110739
|
*/
|
|
111030
110740
|
horizontal = "Horizontal",
|
|
111031
110741
|
/**
|
|
111032
110742
|
* A special version of vertical text, where some fonts are displayed as if rotated.
|
|
111033
110743
|
* @remarks
|
|
111034
|
-
* [Api set:
|
|
111035
|
-
* @beta
|
|
110744
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111036
110745
|
*/
|
|
111037
110746
|
eastAsianVertical = "EastAsianVertical",
|
|
111038
110747
|
/**
|
|
111039
110748
|
* Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise).
|
|
111040
110749
|
* @remarks
|
|
111041
|
-
* [Api set:
|
|
111042
|
-
* @beta
|
|
110750
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111043
110751
|
*/
|
|
111044
110752
|
vertical270 = "Vertical270",
|
|
111045
110753
|
/**
|
|
111046
110754
|
* Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise).
|
|
111047
110755
|
* @remarks
|
|
111048
|
-
* [Api set:
|
|
111049
|
-
* @beta
|
|
110756
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111050
110757
|
*/
|
|
111051
110758
|
vertical = "Vertical",
|
|
111052
110759
|
/**
|
|
111053
110760
|
* A special version of vertical text, where some fonts are displayed as if rotated.
|
|
111054
110761
|
* @remarks
|
|
111055
|
-
* [Api set:
|
|
111056
|
-
* @beta
|
|
110762
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111057
110763
|
*/
|
|
111058
110764
|
eastAsianHorizontalRotated = "EastAsianHorizontalRotated",
|
|
111059
110765
|
/**
|
|
111060
110766
|
* A combination of automatic orientation is used.
|
|
111061
110767
|
* @remarks
|
|
111062
|
-
* [Api set:
|
|
111063
|
-
* @beta
|
|
110768
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111064
110769
|
*/
|
|
111065
110770
|
mixed = "Mixed",
|
|
111066
110771
|
}
|
|
@@ -111068,36 +110773,31 @@ declare namespace Word {
|
|
|
111068
110773
|
* Determines the type of automatic sizing allowed.
|
|
111069
110774
|
*
|
|
111070
110775
|
* @remarks
|
|
111071
|
-
* [Api set:
|
|
111072
|
-
* @beta
|
|
110776
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111073
110777
|
*/
|
|
111074
110778
|
enum ShapeAutoSize {
|
|
111075
110779
|
/**
|
|
111076
110780
|
* No autosizing.
|
|
111077
110781
|
* @remarks
|
|
111078
|
-
* [Api set:
|
|
111079
|
-
* @beta
|
|
110782
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111080
110783
|
*/
|
|
111081
110784
|
none = "None",
|
|
111082
110785
|
/**
|
|
111083
110786
|
* The text is adjusted to fit the shape.
|
|
111084
110787
|
* @remarks
|
|
111085
|
-
* [Api set:
|
|
111086
|
-
* @beta
|
|
110788
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111087
110789
|
*/
|
|
111088
110790
|
textToFitShape = "TextToFitShape",
|
|
111089
110791
|
/**
|
|
111090
110792
|
* The shape is adjusted to fit the text.
|
|
111091
110793
|
* @remarks
|
|
111092
|
-
* [Api set:
|
|
111093
|
-
* @beta
|
|
110794
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111094
110795
|
*/
|
|
111095
110796
|
shapeToFitText = "ShapeToFitText",
|
|
111096
110797
|
/**
|
|
111097
110798
|
* A combination of automatic sizing schemes are used.
|
|
111098
110799
|
* @remarks
|
|
111099
|
-
* [Api set:
|
|
111100
|
-
* @beta
|
|
110800
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111101
110801
|
*/
|
|
111102
110802
|
mixed = "Mixed",
|
|
111103
110803
|
}
|
|
@@ -111105,57 +110805,49 @@ declare namespace Word {
|
|
|
111105
110805
|
* Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}.
|
|
111106
110806
|
*
|
|
111107
110807
|
* @remarks
|
|
111108
|
-
* [Api set:
|
|
111109
|
-
* @beta
|
|
110808
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111110
110809
|
*/
|
|
111111
110810
|
enum ShapeTextWrapType {
|
|
111112
110811
|
/**
|
|
111113
110812
|
* Places the shape in line with text.
|
|
111114
110813
|
* @remarks
|
|
111115
|
-
* [Api set:
|
|
111116
|
-
* @beta
|
|
110814
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111117
110815
|
*/
|
|
111118
110816
|
inline = "Inline",
|
|
111119
110817
|
/**
|
|
111120
110818
|
* Wraps text squarely around the shape.
|
|
111121
110819
|
* @remarks
|
|
111122
|
-
* [Api set:
|
|
111123
|
-
* @beta
|
|
110820
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111124
110821
|
*/
|
|
111125
110822
|
square = "Square",
|
|
111126
110823
|
/**
|
|
111127
110824
|
* Wraps text close to the shape.
|
|
111128
110825
|
* @remarks
|
|
111129
|
-
* [Api set:
|
|
111130
|
-
* @beta
|
|
110826
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111131
110827
|
*/
|
|
111132
110828
|
tight = "Tight",
|
|
111133
110829
|
/**
|
|
111134
110830
|
* Wraps text around and through the shape.
|
|
111135
110831
|
* @remarks
|
|
111136
|
-
* [Api set:
|
|
111137
|
-
* @beta
|
|
110832
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111138
110833
|
*/
|
|
111139
110834
|
through = "Through",
|
|
111140
110835
|
/**
|
|
111141
110836
|
* Places text above and below the shape.
|
|
111142
110837
|
* @remarks
|
|
111143
|
-
* [Api set:
|
|
111144
|
-
* @beta
|
|
110838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111145
110839
|
*/
|
|
111146
110840
|
topBottom = "TopBottom",
|
|
111147
110841
|
/**
|
|
111148
110842
|
* Places shape behind text.
|
|
111149
110843
|
* @remarks
|
|
111150
|
-
* [Api set:
|
|
111151
|
-
* @beta
|
|
110844
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111152
110845
|
*/
|
|
111153
110846
|
behind = "Behind",
|
|
111154
110847
|
/**
|
|
111155
110848
|
* Places shape in front of text.
|
|
111156
110849
|
* @remarks
|
|
111157
|
-
* [Api set:
|
|
111158
|
-
* @beta
|
|
110850
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111159
110851
|
*/
|
|
111160
110852
|
front = "Front",
|
|
111161
110853
|
}
|
|
@@ -111163,43 +110855,37 @@ declare namespace Word {
|
|
|
111163
110855
|
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin.
|
|
111164
110856
|
*
|
|
111165
110857
|
* @remarks
|
|
111166
|
-
* [Api set:
|
|
111167
|
-
* @beta
|
|
110858
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111168
110859
|
*/
|
|
111169
110860
|
enum ShapeTextWrapSide {
|
|
111170
110861
|
/**
|
|
111171
110862
|
* Has no wrap side property, such as those for inline shapes.
|
|
111172
110863
|
* @remarks
|
|
111173
|
-
* [Api set:
|
|
111174
|
-
* @beta
|
|
110864
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111175
110865
|
*/
|
|
111176
110866
|
none = "None",
|
|
111177
110867
|
/**
|
|
111178
110868
|
* Both left and right sides of the shape.
|
|
111179
110869
|
* @remarks
|
|
111180
|
-
* [Api set:
|
|
111181
|
-
* @beta
|
|
110870
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111182
110871
|
*/
|
|
111183
110872
|
both = "Both",
|
|
111184
110873
|
/**
|
|
111185
110874
|
* Left side of the shape only.
|
|
111186
110875
|
* @remarks
|
|
111187
|
-
* [Api set:
|
|
111188
|
-
* @beta
|
|
110876
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111189
110877
|
*/
|
|
111190
110878
|
left = "Left",
|
|
111191
110879
|
/**
|
|
111192
110880
|
* Right side of the shape only.
|
|
111193
110881
|
* @remarks
|
|
111194
|
-
* [Api set:
|
|
111195
|
-
* @beta
|
|
110882
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111196
110883
|
*/
|
|
111197
110884
|
right = "Right",
|
|
111198
110885
|
/**
|
|
111199
110886
|
* Side of the shape that's farther from the respective page margin.
|
|
111200
110887
|
* @remarks
|
|
111201
|
-
* [Api set:
|
|
111202
|
-
* @beta
|
|
110888
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111203
110889
|
*/
|
|
111204
110890
|
largest = "Largest",
|
|
111205
110891
|
}
|
|
@@ -112749,159 +112435,140 @@ declare namespace Word {
|
|
|
112749
112435
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
112750
112436
|
*
|
|
112751
112437
|
* @remarks
|
|
112752
|
-
* [Api set:
|
|
112753
|
-
* @beta
|
|
112438
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112754
112439
|
*/
|
|
112755
112440
|
body?: Word.Interfaces.BodyUpdateData;
|
|
112756
112441
|
/**
|
|
112757
112442
|
* Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}.
|
|
112758
112443
|
*
|
|
112759
112444
|
* @remarks
|
|
112760
|
-
* [Api set:
|
|
112761
|
-
* @beta
|
|
112445
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112762
112446
|
*/
|
|
112763
112447
|
canvas?: Word.Interfaces.CanvasUpdateData;
|
|
112764
112448
|
/**
|
|
112765
112449
|
* Returns the fill formatting of the shape.
|
|
112766
112450
|
*
|
|
112767
112451
|
* @remarks
|
|
112768
|
-
* [Api set:
|
|
112769
|
-
* @beta
|
|
112452
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112770
112453
|
*/
|
|
112771
112454
|
fill?: Word.Interfaces.ShapeFillUpdateData;
|
|
112772
112455
|
/**
|
|
112773
112456
|
* Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
|
|
112774
112457
|
*
|
|
112775
112458
|
* @remarks
|
|
112776
|
-
* [Api set:
|
|
112777
|
-
* @beta
|
|
112459
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112778
112460
|
*/
|
|
112779
112461
|
parentCanvas?: Word.Interfaces.ShapeUpdateData;
|
|
112780
112462
|
/**
|
|
112781
112463
|
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
|
|
112782
112464
|
*
|
|
112783
112465
|
* @remarks
|
|
112784
|
-
* [Api set:
|
|
112785
|
-
* @beta
|
|
112466
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112786
112467
|
*/
|
|
112787
112468
|
parentGroup?: Word.Interfaces.ShapeUpdateData;
|
|
112788
112469
|
/**
|
|
112789
112470
|
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}.
|
|
112790
112471
|
*
|
|
112791
112472
|
* @remarks
|
|
112792
|
-
* [Api set:
|
|
112793
|
-
* @beta
|
|
112473
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112794
112474
|
*/
|
|
112795
112475
|
shapeGroup?: Word.Interfaces.ShapeGroupUpdateData;
|
|
112796
112476
|
/**
|
|
112797
112477
|
* Gets the text frame object of the shape.
|
|
112798
112478
|
*
|
|
112799
112479
|
* @remarks
|
|
112800
|
-
* [Api set:
|
|
112801
|
-
* @beta
|
|
112480
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112802
112481
|
*/
|
|
112803
112482
|
textFrame?: Word.Interfaces.TextFrameUpdateData;
|
|
112804
112483
|
/**
|
|
112805
112484
|
* Returns the text wrap formatting of the shape.
|
|
112806
112485
|
*
|
|
112807
112486
|
* @remarks
|
|
112808
|
-
* [Api set:
|
|
112809
|
-
* @beta
|
|
112487
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112810
112488
|
*/
|
|
112811
112489
|
textWrap?: Word.Interfaces.ShapeTextWrapUpdateData;
|
|
112812
112490
|
/**
|
|
112813
112491
|
* Specifies whether a given shape can overlap other shapes.
|
|
112814
112492
|
*
|
|
112815
112493
|
* @remarks
|
|
112816
|
-
* [Api set:
|
|
112817
|
-
* @beta
|
|
112494
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112818
112495
|
*/
|
|
112819
112496
|
allowOverlap?: boolean;
|
|
112820
112497
|
/**
|
|
112821
112498
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
112822
112499
|
*
|
|
112823
112500
|
* @remarks
|
|
112824
|
-
* [Api set:
|
|
112825
|
-
* @beta
|
|
112501
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112826
112502
|
*/
|
|
112827
112503
|
geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
112828
112504
|
/**
|
|
112829
112505
|
* The height, in points, of the shape.
|
|
112830
112506
|
*
|
|
112831
112507
|
* @remarks
|
|
112832
|
-
* [Api set:
|
|
112833
|
-
* @beta
|
|
112508
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112834
112509
|
*/
|
|
112835
112510
|
height?: number;
|
|
112836
112511
|
/**
|
|
112837
112512
|
* The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
112838
112513
|
*
|
|
112839
112514
|
* @remarks
|
|
112840
|
-
* [Api set:
|
|
112841
|
-
* @beta
|
|
112515
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112842
112516
|
*/
|
|
112843
112517
|
left?: number;
|
|
112844
112518
|
/**
|
|
112845
112519
|
* The name of the shape.
|
|
112846
112520
|
*
|
|
112847
112521
|
* @remarks
|
|
112848
|
-
* [Api set:
|
|
112849
|
-
* @beta
|
|
112522
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112850
112523
|
*/
|
|
112851
112524
|
name?: string;
|
|
112852
112525
|
/**
|
|
112853
112526
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
112854
112527
|
*
|
|
112855
112528
|
* @remarks
|
|
112856
|
-
* [Api set:
|
|
112857
|
-
* @beta
|
|
112529
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112858
112530
|
*/
|
|
112859
112531
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
112860
112532
|
/**
|
|
112861
112533
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
112862
112534
|
*
|
|
112863
112535
|
* @remarks
|
|
112864
|
-
* [Api set:
|
|
112865
|
-
* @beta
|
|
112536
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112866
112537
|
*/
|
|
112867
112538
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
112868
112539
|
/**
|
|
112869
112540
|
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
112870
112541
|
*
|
|
112871
112542
|
* @remarks
|
|
112872
|
-
* [Api set:
|
|
112873
|
-
* @beta
|
|
112543
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112874
112544
|
*/
|
|
112875
112545
|
top?: number;
|
|
112876
112546
|
/**
|
|
112877
112547
|
* The width, in points, of the shape.
|
|
112878
112548
|
*
|
|
112879
112549
|
* @remarks
|
|
112880
|
-
* [Api set:
|
|
112881
|
-
* @beta
|
|
112550
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112882
112551
|
*/
|
|
112883
112552
|
width?: number;
|
|
112884
112553
|
}
|
|
112885
112554
|
/** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
|
|
112886
112555
|
interface ShapeGroupUpdateData {
|
|
112887
112556
|
/**
|
|
112888
|
-
|
|
112889
|
-
|
|
112890
|
-
|
|
112891
|
-
|
|
112892
|
-
* @beta
|
|
112557
|
+
* Gets the Shape object associated with the group.
|
|
112558
|
+
*
|
|
112559
|
+
* @remarks
|
|
112560
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112893
112561
|
*/
|
|
112894
112562
|
shape?: Word.Interfaces.ShapeUpdateData;
|
|
112895
112563
|
}
|
|
112896
112564
|
/** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */
|
|
112897
112565
|
interface CanvasUpdateData {
|
|
112898
112566
|
/**
|
|
112899
|
-
|
|
112900
|
-
|
|
112901
|
-
|
|
112902
|
-
|
|
112903
|
-
|
|
112904
|
-
*/
|
|
112567
|
+
* Gets the Shape object associated with the canvas.
|
|
112568
|
+
*
|
|
112569
|
+
* @remarks
|
|
112570
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112571
|
+
*/
|
|
112905
112572
|
shape?: Word.Interfaces.ShapeUpdateData;
|
|
112906
112573
|
}
|
|
112907
112574
|
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
@@ -112914,24 +112581,21 @@ declare namespace Word {
|
|
|
112914
112581
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
112915
112582
|
*
|
|
112916
112583
|
* @remarks
|
|
112917
|
-
* [Api set:
|
|
112918
|
-
* @beta
|
|
112584
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112919
112585
|
*/
|
|
112920
112586
|
backgroundColor?: string;
|
|
112921
112587
|
/**
|
|
112922
112588
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
112923
112589
|
*
|
|
112924
112590
|
* @remarks
|
|
112925
|
-
* [Api set:
|
|
112926
|
-
* @beta
|
|
112591
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112927
112592
|
*/
|
|
112928
112593
|
foregroundColor?: string;
|
|
112929
112594
|
/**
|
|
112930
112595
|
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
112931
112596
|
*
|
|
112932
112597
|
* @remarks
|
|
112933
|
-
* [Api set:
|
|
112934
|
-
* @beta
|
|
112598
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112935
112599
|
*/
|
|
112936
112600
|
transparency?: number;
|
|
112937
112601
|
}
|
|
@@ -112941,72 +112605,63 @@ declare namespace Word {
|
|
|
112941
112605
|
* The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
|
|
112942
112606
|
*
|
|
112943
112607
|
* @remarks
|
|
112944
|
-
* [Api set:
|
|
112945
|
-
* @beta
|
|
112608
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112946
112609
|
*/
|
|
112947
112610
|
autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
112948
112611
|
/**
|
|
112949
112612
|
* Represents the bottom margin, in points, of the text frame.
|
|
112950
112613
|
*
|
|
112951
112614
|
* @remarks
|
|
112952
|
-
* [Api set:
|
|
112953
|
-
* @beta
|
|
112615
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112954
112616
|
*/
|
|
112955
112617
|
bottomMargin?: number;
|
|
112956
112618
|
/**
|
|
112957
112619
|
* Represents the left margin, in points, of the text frame.
|
|
112958
112620
|
*
|
|
112959
112621
|
* @remarks
|
|
112960
|
-
* [Api set:
|
|
112961
|
-
* @beta
|
|
112622
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112962
112623
|
*/
|
|
112963
112624
|
leftMargin?: number;
|
|
112964
112625
|
/**
|
|
112965
112626
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
112966
112627
|
*
|
|
112967
112628
|
* @remarks
|
|
112968
|
-
* [Api set:
|
|
112969
|
-
* @beta
|
|
112629
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112970
112630
|
*/
|
|
112971
112631
|
noTextRotation?: boolean;
|
|
112972
112632
|
/**
|
|
112973
112633
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
112974
112634
|
*
|
|
112975
112635
|
* @remarks
|
|
112976
|
-
* [Api set:
|
|
112977
|
-
* @beta
|
|
112636
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112978
112637
|
*/
|
|
112979
112638
|
orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
112980
112639
|
/**
|
|
112981
112640
|
* Represents the right margin, in points, of the text frame.
|
|
112982
112641
|
*
|
|
112983
112642
|
* @remarks
|
|
112984
|
-
* [Api set:
|
|
112985
|
-
* @beta
|
|
112643
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112986
112644
|
*/
|
|
112987
112645
|
rightMargin?: number;
|
|
112988
112646
|
/**
|
|
112989
112647
|
* Represents the top margin, in points, of the text frame.
|
|
112990
112648
|
*
|
|
112991
112649
|
* @remarks
|
|
112992
|
-
* [Api set:
|
|
112993
|
-
* @beta
|
|
112650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112994
112651
|
*/
|
|
112995
112652
|
topMargin?: number;
|
|
112996
112653
|
/**
|
|
112997
112654
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
112998
112655
|
*
|
|
112999
112656
|
* @remarks
|
|
113000
|
-
* [Api set:
|
|
113001
|
-
* @beta
|
|
112657
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113002
112658
|
*/
|
|
113003
112659
|
verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
113004
112660
|
/**
|
|
113005
112661
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
113006
112662
|
*
|
|
113007
112663
|
* @remarks
|
|
113008
|
-
* [Api set:
|
|
113009
|
-
* @beta
|
|
112664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113010
112665
|
*/
|
|
113011
112666
|
wordWrap?: boolean;
|
|
113012
112667
|
}
|
|
@@ -113016,48 +112671,42 @@ declare namespace Word {
|
|
|
113016
112671
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
113017
112672
|
*
|
|
113018
112673
|
* @remarks
|
|
113019
|
-
* [Api set:
|
|
113020
|
-
* @beta
|
|
112674
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113021
112675
|
*/
|
|
113022
112676
|
bottomDistance?: number;
|
|
113023
112677
|
/**
|
|
113024
112678
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
113025
112679
|
*
|
|
113026
112680
|
* @remarks
|
|
113027
|
-
* [Api set:
|
|
113028
|
-
* @beta
|
|
112681
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113029
112682
|
*/
|
|
113030
112683
|
leftDistance?: number;
|
|
113031
112684
|
/**
|
|
113032
112685
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
113033
112686
|
*
|
|
113034
112687
|
* @remarks
|
|
113035
|
-
* [Api set:
|
|
113036
|
-
* @beta
|
|
112688
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113037
112689
|
*/
|
|
113038
112690
|
rightDistance?: number;
|
|
113039
112691
|
/**
|
|
113040
112692
|
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
113041
112693
|
*
|
|
113042
112694
|
* @remarks
|
|
113043
|
-
* [Api set:
|
|
113044
|
-
* @beta
|
|
112695
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113045
112696
|
*/
|
|
113046
112697
|
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
113047
112698
|
/**
|
|
113048
112699
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
113049
112700
|
*
|
|
113050
112701
|
* @remarks
|
|
113051
|
-
* [Api set:
|
|
113052
|
-
* @beta
|
|
112702
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113053
112703
|
*/
|
|
113054
112704
|
topDistance?: number;
|
|
113055
112705
|
/**
|
|
113056
112706
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
113057
112707
|
*
|
|
113058
112708
|
* @remarks
|
|
113059
|
-
* [Api set:
|
|
113060
|
-
* @beta
|
|
112709
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113061
112710
|
*/
|
|
113062
112711
|
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
113063
112712
|
}
|
|
@@ -113142,8 +112791,7 @@ declare namespace Word {
|
|
|
113142
112791
|
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
113143
112792
|
*
|
|
113144
112793
|
* @remarks
|
|
113145
|
-
* [Api set:
|
|
113146
|
-
* @beta
|
|
112794
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113147
112795
|
*/
|
|
113148
112796
|
shapes?: Word.Interfaces.ShapeData[];
|
|
113149
112797
|
/**
|
|
@@ -113669,8 +113317,7 @@ declare namespace Word {
|
|
|
113669
113317
|
* Gets the active window for the document.
|
|
113670
113318
|
*
|
|
113671
113319
|
* @remarks
|
|
113672
|
-
* [Api set:
|
|
113673
|
-
* @beta
|
|
113320
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113674
113321
|
*/
|
|
113675
113322
|
activeWindow?: Word.Interfaces.WindowData;
|
|
113676
113323
|
/**
|
|
@@ -113719,8 +113366,7 @@ declare namespace Word {
|
|
|
113719
113366
|
* Gets the collection of `Word.Window` objects for the document.
|
|
113720
113367
|
*
|
|
113721
113368
|
* @remarks
|
|
113722
|
-
* [Api set:
|
|
113723
|
-
* @beta
|
|
113369
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113724
113370
|
*/
|
|
113725
113371
|
windows?: Word.Interfaces.WindowData[];
|
|
113726
113372
|
/**
|
|
@@ -114321,24 +113967,21 @@ declare namespace Word {
|
|
|
114321
113967
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
114322
113968
|
*
|
|
114323
113969
|
* @remarks
|
|
114324
|
-
* [Api set:
|
|
114325
|
-
* @beta
|
|
113970
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114326
113971
|
*/
|
|
114327
113972
|
height?: number;
|
|
114328
113973
|
/**
|
|
114329
113974
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
114330
113975
|
*
|
|
114331
113976
|
* @remarks
|
|
114332
|
-
* [Api set:
|
|
114333
|
-
* @beta
|
|
113977
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114334
113978
|
*/
|
|
114335
113979
|
index?: number;
|
|
114336
113980
|
/**
|
|
114337
113981
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
114338
113982
|
*
|
|
114339
113983
|
* @remarks
|
|
114340
|
-
* [Api set:
|
|
114341
|
-
* @beta
|
|
113984
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114342
113985
|
*/
|
|
114343
113986
|
width?: number;
|
|
114344
113987
|
}
|
|
@@ -114352,16 +113995,14 @@ declare namespace Word {
|
|
|
114352
113995
|
* Gets the collection of pages in the pane.
|
|
114353
113996
|
*
|
|
114354
113997
|
* @remarks
|
|
114355
|
-
* [Api set:
|
|
114356
|
-
* @beta
|
|
113998
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114357
113999
|
*/
|
|
114358
114000
|
pages?: Word.Interfaces.PageData[];
|
|
114359
114001
|
/**
|
|
114360
114002
|
* Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned.
|
|
114361
114003
|
*
|
|
114362
114004
|
* @remarks
|
|
114363
|
-
* [Api set:
|
|
114364
|
-
* @beta
|
|
114005
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114365
114006
|
*/
|
|
114366
114007
|
pagesEnclosingViewport?: Word.Interfaces.PageData[];
|
|
114367
114008
|
}
|
|
@@ -114414,11 +114055,10 @@ declare namespace Word {
|
|
|
114414
114055
|
*/
|
|
114415
114056
|
listItemOrNullObject?: Word.Interfaces.ListItemData;
|
|
114416
114057
|
/**
|
|
114417
|
-
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
114058
|
+
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
114418
114059
|
*
|
|
114419
114060
|
* @remarks
|
|
114420
|
-
* [Api set:
|
|
114421
|
-
* @beta
|
|
114061
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114422
114062
|
*/
|
|
114423
114063
|
shapes?: Word.Interfaces.ShapeData[];
|
|
114424
114064
|
/**
|
|
@@ -114673,16 +114313,14 @@ declare namespace Word {
|
|
|
114673
114313
|
* Gets the collection of pages in the range.
|
|
114674
114314
|
*
|
|
114675
114315
|
* @remarks
|
|
114676
|
-
* [Api set:
|
|
114677
|
-
* @beta
|
|
114316
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114678
114317
|
*/
|
|
114679
114318
|
pages?: Word.Interfaces.PageData[];
|
|
114680
114319
|
/**
|
|
114681
114320
|
* Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
114682
114321
|
*
|
|
114683
114322
|
* @remarks
|
|
114684
|
-
* [Api set:
|
|
114685
|
-
* @beta
|
|
114323
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114686
114324
|
*/
|
|
114687
114325
|
shapes?: Word.Interfaces.ShapeData[];
|
|
114688
114326
|
/**
|
|
@@ -115399,160 +115037,140 @@ declare namespace Word {
|
|
|
115399
115037
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
115400
115038
|
*
|
|
115401
115039
|
* @remarks
|
|
115402
|
-
* [Api set:
|
|
115403
|
-
* @beta
|
|
115040
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115404
115041
|
*/
|
|
115405
115042
|
body?: Word.Interfaces.BodyData;
|
|
115406
115043
|
/**
|
|
115407
115044
|
* Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}.
|
|
115408
115045
|
*
|
|
115409
115046
|
* @remarks
|
|
115410
|
-
* [Api set:
|
|
115411
|
-
* @beta
|
|
115047
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115412
115048
|
*/
|
|
115413
115049
|
canvas?: Word.Interfaces.CanvasData;
|
|
115414
115050
|
/**
|
|
115415
115051
|
* Returns the fill formatting of the shape.
|
|
115416
115052
|
*
|
|
115417
115053
|
* @remarks
|
|
115418
|
-
* [Api set:
|
|
115419
|
-
* @beta
|
|
115054
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115420
115055
|
*/
|
|
115421
115056
|
fill?: Word.Interfaces.ShapeFillData;
|
|
115422
115057
|
/**
|
|
115423
115058
|
* Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
|
|
115424
115059
|
*
|
|
115425
115060
|
* @remarks
|
|
115426
|
-
* [Api set:
|
|
115427
|
-
* @beta
|
|
115061
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115428
115062
|
*/
|
|
115429
115063
|
parentCanvas?: Word.Interfaces.ShapeData;
|
|
115430
115064
|
/**
|
|
115431
115065
|
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
|
|
115432
115066
|
*
|
|
115433
115067
|
* @remarks
|
|
115434
|
-
* [Api set:
|
|
115435
|
-
* @beta
|
|
115068
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115436
115069
|
*/
|
|
115437
115070
|
parentGroup?: Word.Interfaces.ShapeData;
|
|
115438
115071
|
/**
|
|
115439
115072
|
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}.
|
|
115440
115073
|
*
|
|
115441
115074
|
* @remarks
|
|
115442
|
-
* [Api set:
|
|
115443
|
-
* @beta
|
|
115075
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115444
115076
|
*/
|
|
115445
115077
|
shapeGroup?: Word.Interfaces.ShapeGroupData;
|
|
115446
115078
|
/**
|
|
115447
115079
|
* Gets the text frame object of the shape.
|
|
115448
115080
|
*
|
|
115449
115081
|
* @remarks
|
|
115450
|
-
* [Api set:
|
|
115451
|
-
* @beta
|
|
115082
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115452
115083
|
*/
|
|
115453
115084
|
textFrame?: Word.Interfaces.TextFrameData;
|
|
115454
115085
|
/**
|
|
115455
115086
|
* Returns the text wrap formatting of the shape.
|
|
115456
115087
|
*
|
|
115457
115088
|
* @remarks
|
|
115458
|
-
* [Api set:
|
|
115459
|
-
* @beta
|
|
115089
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115460
115090
|
*/
|
|
115461
115091
|
textWrap?: Word.Interfaces.ShapeTextWrapData;
|
|
115462
115092
|
/**
|
|
115463
115093
|
* Specifies whether a given shape can overlap other shapes.
|
|
115464
115094
|
*
|
|
115465
115095
|
* @remarks
|
|
115466
|
-
* [Api set:
|
|
115467
|
-
* @beta
|
|
115096
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115468
115097
|
*/
|
|
115469
115098
|
allowOverlap?: boolean;
|
|
115470
115099
|
/**
|
|
115471
115100
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
115472
115101
|
*
|
|
115473
115102
|
* @remarks
|
|
115474
|
-
* [Api set:
|
|
115475
|
-
* @beta
|
|
115103
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115476
115104
|
*/
|
|
115477
115105
|
geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
115478
115106
|
/**
|
|
115479
115107
|
* The height, in points, of the shape.
|
|
115480
115108
|
*
|
|
115481
115109
|
* @remarks
|
|
115482
|
-
* [Api set:
|
|
115483
|
-
* @beta
|
|
115110
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115484
115111
|
*/
|
|
115485
115112
|
height?: number;
|
|
115486
115113
|
/**
|
|
115487
115114
|
* Gets an integer that represents the shape identifier.
|
|
115488
115115
|
*
|
|
115489
115116
|
* @remarks
|
|
115490
|
-
* [Api set:
|
|
115491
|
-
* @beta
|
|
115117
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115492
115118
|
*/
|
|
115493
115119
|
id?: number;
|
|
115494
115120
|
/**
|
|
115495
115121
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
115496
115122
|
*
|
|
115497
115123
|
* @remarks
|
|
115498
|
-
* [Api set:
|
|
115499
|
-
* @beta
|
|
115124
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115500
115125
|
*/
|
|
115501
115126
|
isChild?: boolean;
|
|
115502
115127
|
/**
|
|
115503
115128
|
* The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
115504
115129
|
*
|
|
115505
115130
|
* @remarks
|
|
115506
|
-
* [Api set:
|
|
115507
|
-
* @beta
|
|
115131
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115508
115132
|
*/
|
|
115509
115133
|
left?: number;
|
|
115510
115134
|
/**
|
|
115511
115135
|
* The name of the shape.
|
|
115512
115136
|
*
|
|
115513
115137
|
* @remarks
|
|
115514
|
-
* [Api set:
|
|
115515
|
-
* @beta
|
|
115138
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115516
115139
|
*/
|
|
115517
115140
|
name?: string;
|
|
115518
115141
|
/**
|
|
115519
115142
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
115520
115143
|
*
|
|
115521
115144
|
* @remarks
|
|
115522
|
-
* [Api set:
|
|
115523
|
-
* @beta
|
|
115145
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115524
115146
|
*/
|
|
115525
115147
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
115526
115148
|
/**
|
|
115527
115149
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
115528
115150
|
*
|
|
115529
115151
|
* @remarks
|
|
115530
|
-
* [Api set:
|
|
115531
|
-
* @beta
|
|
115152
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115532
115153
|
*/
|
|
115533
115154
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
115534
115155
|
/**
|
|
115535
115156
|
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
115536
115157
|
*
|
|
115537
115158
|
* @remarks
|
|
115538
|
-
* [Api set:
|
|
115539
|
-
* @beta
|
|
115159
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115540
115160
|
*/
|
|
115541
115161
|
top?: number;
|
|
115542
115162
|
/**
|
|
115543
115163
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
115544
115164
|
*
|
|
115545
115165
|
* @remarks
|
|
115546
|
-
* [Api set:
|
|
115547
|
-
* @beta
|
|
115166
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115548
115167
|
*/
|
|
115549
115168
|
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
|
|
115550
115169
|
/**
|
|
115551
115170
|
* The width, in points, of the shape.
|
|
115552
115171
|
*
|
|
115553
115172
|
* @remarks
|
|
115554
|
-
* [Api set:
|
|
115555
|
-
* @beta
|
|
115173
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115556
115174
|
*/
|
|
115557
115175
|
width?: number;
|
|
115558
115176
|
}
|
|
@@ -115562,24 +115180,21 @@ declare namespace Word {
|
|
|
115562
115180
|
* Gets the Shape object associated with the group.
|
|
115563
115181
|
*
|
|
115564
115182
|
* @remarks
|
|
115565
|
-
* [Api set:
|
|
115566
|
-
* @beta
|
|
115183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115567
115184
|
*/
|
|
115568
115185
|
shape?: Word.Interfaces.ShapeData;
|
|
115569
115186
|
/**
|
|
115570
115187
|
* Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
|
|
115571
115188
|
*
|
|
115572
115189
|
* @remarks
|
|
115573
|
-
* [Api set:
|
|
115574
|
-
* @beta
|
|
115190
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115575
115191
|
*/
|
|
115576
115192
|
shapes?: Word.Interfaces.ShapeData[];
|
|
115577
115193
|
/**
|
|
115578
115194
|
* Gets an integer that represents the shape group identifier.
|
|
115579
115195
|
*
|
|
115580
115196
|
* @remarks
|
|
115581
|
-
* [Api set:
|
|
115582
|
-
* @beta
|
|
115197
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115583
115198
|
*/
|
|
115584
115199
|
id?: number;
|
|
115585
115200
|
}
|
|
@@ -115589,24 +115204,21 @@ declare namespace Word {
|
|
|
115589
115204
|
* Gets the Shape object associated with the canvas.
|
|
115590
115205
|
*
|
|
115591
115206
|
* @remarks
|
|
115592
|
-
* [Api set:
|
|
115593
|
-
* @beta
|
|
115207
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115594
115208
|
*/
|
|
115595
115209
|
shape?: Word.Interfaces.ShapeData;
|
|
115596
115210
|
/**
|
|
115597
115211
|
* Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
|
|
115598
115212
|
*
|
|
115599
115213
|
* @remarks
|
|
115600
|
-
* [Api set:
|
|
115601
|
-
* @beta
|
|
115214
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115602
115215
|
*/
|
|
115603
115216
|
shapes?: Word.Interfaces.ShapeData[];
|
|
115604
115217
|
/**
|
|
115605
115218
|
* Gets an integer that represents the canvas identifier.
|
|
115606
115219
|
*
|
|
115607
115220
|
* @remarks
|
|
115608
|
-
* [Api set:
|
|
115609
|
-
* @beta
|
|
115221
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115610
115222
|
*/
|
|
115611
115223
|
id?: number;
|
|
115612
115224
|
}
|
|
@@ -115620,32 +115232,28 @@ declare namespace Word {
|
|
|
115620
115232
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
115621
115233
|
*
|
|
115622
115234
|
* @remarks
|
|
115623
|
-
* [Api set:
|
|
115624
|
-
* @beta
|
|
115235
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115625
115236
|
*/
|
|
115626
115237
|
backgroundColor?: string;
|
|
115627
115238
|
/**
|
|
115628
115239
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
115629
115240
|
*
|
|
115630
115241
|
* @remarks
|
|
115631
|
-
* [Api set:
|
|
115632
|
-
* @beta
|
|
115242
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115633
115243
|
*/
|
|
115634
115244
|
foregroundColor?: string;
|
|
115635
115245
|
/**
|
|
115636
115246
|
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
115637
115247
|
*
|
|
115638
115248
|
* @remarks
|
|
115639
|
-
* [Api set:
|
|
115640
|
-
* @beta
|
|
115249
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115641
115250
|
*/
|
|
115642
115251
|
transparency?: number;
|
|
115643
115252
|
/**
|
|
115644
115253
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
115645
115254
|
*
|
|
115646
115255
|
* @remarks
|
|
115647
|
-
* [Api set:
|
|
115648
|
-
* @beta
|
|
115256
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115649
115257
|
*/
|
|
115650
115258
|
type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";
|
|
115651
115259
|
}
|
|
@@ -115655,80 +115263,70 @@ declare namespace Word {
|
|
|
115655
115263
|
* The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
|
|
115656
115264
|
*
|
|
115657
115265
|
* @remarks
|
|
115658
|
-
* [Api set:
|
|
115659
|
-
* @beta
|
|
115266
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115660
115267
|
*/
|
|
115661
115268
|
autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
115662
115269
|
/**
|
|
115663
115270
|
* Represents the bottom margin, in points, of the text frame.
|
|
115664
115271
|
*
|
|
115665
115272
|
* @remarks
|
|
115666
|
-
* [Api set:
|
|
115667
|
-
* @beta
|
|
115273
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115668
115274
|
*/
|
|
115669
115275
|
bottomMargin?: number;
|
|
115670
115276
|
/**
|
|
115671
115277
|
* Specifies if the text frame contains text.
|
|
115672
115278
|
*
|
|
115673
115279
|
* @remarks
|
|
115674
|
-
* [Api set:
|
|
115675
|
-
* @beta
|
|
115280
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115676
115281
|
*/
|
|
115677
115282
|
hasText?: boolean;
|
|
115678
115283
|
/**
|
|
115679
115284
|
* Represents the left margin, in points, of the text frame.
|
|
115680
115285
|
*
|
|
115681
115286
|
* @remarks
|
|
115682
|
-
* [Api set:
|
|
115683
|
-
* @beta
|
|
115287
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115684
115288
|
*/
|
|
115685
115289
|
leftMargin?: number;
|
|
115686
115290
|
/**
|
|
115687
115291
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
115688
115292
|
*
|
|
115689
115293
|
* @remarks
|
|
115690
|
-
* [Api set:
|
|
115691
|
-
* @beta
|
|
115294
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115692
115295
|
*/
|
|
115693
115296
|
noTextRotation?: boolean;
|
|
115694
115297
|
/**
|
|
115695
115298
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
115696
115299
|
*
|
|
115697
115300
|
* @remarks
|
|
115698
|
-
* [Api set:
|
|
115699
|
-
* @beta
|
|
115301
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115700
115302
|
*/
|
|
115701
115303
|
orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
115702
115304
|
/**
|
|
115703
115305
|
* Represents the right margin, in points, of the text frame.
|
|
115704
115306
|
*
|
|
115705
115307
|
* @remarks
|
|
115706
|
-
* [Api set:
|
|
115707
|
-
* @beta
|
|
115308
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115708
115309
|
*/
|
|
115709
115310
|
rightMargin?: number;
|
|
115710
115311
|
/**
|
|
115711
115312
|
* Represents the top margin, in points, of the text frame.
|
|
115712
115313
|
*
|
|
115713
115314
|
* @remarks
|
|
115714
|
-
* [Api set:
|
|
115715
|
-
* @beta
|
|
115315
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115716
115316
|
*/
|
|
115717
115317
|
topMargin?: number;
|
|
115718
115318
|
/**
|
|
115719
115319
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
115720
115320
|
*
|
|
115721
115321
|
* @remarks
|
|
115722
|
-
* [Api set:
|
|
115723
|
-
* @beta
|
|
115322
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115724
115323
|
*/
|
|
115725
115324
|
verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
115726
115325
|
/**
|
|
115727
115326
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
115728
115327
|
*
|
|
115729
115328
|
* @remarks
|
|
115730
|
-
* [Api set:
|
|
115731
|
-
* @beta
|
|
115329
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115732
115330
|
*/
|
|
115733
115331
|
wordWrap?: boolean;
|
|
115734
115332
|
}
|
|
@@ -115738,48 +115336,42 @@ declare namespace Word {
|
|
|
115738
115336
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
115739
115337
|
*
|
|
115740
115338
|
* @remarks
|
|
115741
|
-
* [Api set:
|
|
115742
|
-
* @beta
|
|
115339
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115743
115340
|
*/
|
|
115744
115341
|
bottomDistance?: number;
|
|
115745
115342
|
/**
|
|
115746
115343
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
115747
115344
|
*
|
|
115748
115345
|
* @remarks
|
|
115749
|
-
* [Api set:
|
|
115750
|
-
* @beta
|
|
115346
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115751
115347
|
*/
|
|
115752
115348
|
leftDistance?: number;
|
|
115753
115349
|
/**
|
|
115754
115350
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
115755
115351
|
*
|
|
115756
115352
|
* @remarks
|
|
115757
|
-
* [Api set:
|
|
115758
|
-
* @beta
|
|
115353
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115759
115354
|
*/
|
|
115760
115355
|
rightDistance?: number;
|
|
115761
115356
|
/**
|
|
115762
115357
|
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
115763
115358
|
*
|
|
115764
115359
|
* @remarks
|
|
115765
|
-
* [Api set:
|
|
115766
|
-
* @beta
|
|
115360
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115767
115361
|
*/
|
|
115768
115362
|
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
115769
115363
|
/**
|
|
115770
115364
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
115771
115365
|
*
|
|
115772
115366
|
* @remarks
|
|
115773
|
-
* [Api set:
|
|
115774
|
-
* @beta
|
|
115367
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115775
115368
|
*/
|
|
115776
115369
|
topDistance?: number;
|
|
115777
115370
|
/**
|
|
115778
115371
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
115779
115372
|
*
|
|
115780
115373
|
* @remarks
|
|
115781
|
-
* [Api set:
|
|
115782
|
-
* @beta
|
|
115374
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115783
115375
|
*/
|
|
115784
115376
|
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
115785
115377
|
}
|
|
@@ -118059,8 +117651,7 @@ declare namespace Word {
|
|
|
118059
117651
|
* Represents a page in the document. `Page` objects manage the page layout and content.
|
|
118060
117652
|
*
|
|
118061
117653
|
* @remarks
|
|
118062
|
-
* [Api set:
|
|
118063
|
-
* @beta
|
|
117654
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118064
117655
|
*/
|
|
118065
117656
|
interface PageLoadOptions {
|
|
118066
117657
|
/**
|
|
@@ -118071,24 +117662,21 @@ declare namespace Word {
|
|
|
118071
117662
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
118072
117663
|
*
|
|
118073
117664
|
* @remarks
|
|
118074
|
-
* [Api set:
|
|
118075
|
-
* @beta
|
|
117665
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118076
117666
|
*/
|
|
118077
117667
|
height?: boolean;
|
|
118078
117668
|
/**
|
|
118079
117669
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
118080
117670
|
*
|
|
118081
117671
|
* @remarks
|
|
118082
|
-
* [Api set:
|
|
118083
|
-
* @beta
|
|
117672
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118084
117673
|
*/
|
|
118085
117674
|
index?: boolean;
|
|
118086
117675
|
/**
|
|
118087
117676
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
118088
117677
|
*
|
|
118089
117678
|
* @remarks
|
|
118090
|
-
* [Api set:
|
|
118091
|
-
* @beta
|
|
117679
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118092
117680
|
*/
|
|
118093
117681
|
width?: boolean;
|
|
118094
117682
|
}
|
|
@@ -118096,8 +117684,7 @@ declare namespace Word {
|
|
|
118096
117684
|
* Represents the collection of page.
|
|
118097
117685
|
*
|
|
118098
117686
|
* @remarks
|
|
118099
|
-
* [Api set:
|
|
118100
|
-
* @beta
|
|
117687
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118101
117688
|
*/
|
|
118102
117689
|
interface PageCollectionLoadOptions {
|
|
118103
117690
|
/**
|
|
@@ -118108,24 +117695,21 @@ declare namespace Word {
|
|
|
118108
117695
|
* For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
118109
117696
|
*
|
|
118110
117697
|
* @remarks
|
|
118111
|
-
* [Api set:
|
|
118112
|
-
* @beta
|
|
117698
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118113
117699
|
*/
|
|
118114
117700
|
height?: boolean;
|
|
118115
117701
|
/**
|
|
118116
117702
|
* For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
118117
117703
|
*
|
|
118118
117704
|
* @remarks
|
|
118119
|
-
* [Api set:
|
|
118120
|
-
* @beta
|
|
117705
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118121
117706
|
*/
|
|
118122
117707
|
index?: boolean;
|
|
118123
117708
|
/**
|
|
118124
117709
|
* For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
118125
117710
|
*
|
|
118126
117711
|
* @remarks
|
|
118127
|
-
* [Api set:
|
|
118128
|
-
* @beta
|
|
117712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118129
117713
|
*/
|
|
118130
117714
|
width?: boolean;
|
|
118131
117715
|
}
|
|
@@ -120240,8 +119824,7 @@ declare namespace Word {
|
|
|
120240
119824
|
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
120241
119825
|
*
|
|
120242
119826
|
* @remarks
|
|
120243
|
-
* [Api set:
|
|
120244
|
-
* @beta
|
|
119827
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120245
119828
|
*/
|
|
120246
119829
|
interface ShapeLoadOptions {
|
|
120247
119830
|
/**
|
|
@@ -120252,160 +119835,140 @@ declare namespace Word {
|
|
|
120252
119835
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
120253
119836
|
*
|
|
120254
119837
|
* @remarks
|
|
120255
|
-
* [Api set:
|
|
120256
|
-
* @beta
|
|
119838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120257
119839
|
*/
|
|
120258
119840
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
120259
119841
|
/**
|
|
120260
119842
|
* Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}.
|
|
120261
119843
|
*
|
|
120262
119844
|
* @remarks
|
|
120263
|
-
* [Api set:
|
|
120264
|
-
* @beta
|
|
119845
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120265
119846
|
*/
|
|
120266
119847
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120267
119848
|
/**
|
|
120268
119849
|
* Returns the fill formatting of the shape.
|
|
120269
119850
|
*
|
|
120270
119851
|
* @remarks
|
|
120271
|
-
* [Api set:
|
|
120272
|
-
* @beta
|
|
119852
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120273
119853
|
*/
|
|
120274
119854
|
fill?: Word.Interfaces.ShapeFillLoadOptions;
|
|
120275
119855
|
/**
|
|
120276
119856
|
* Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
|
|
120277
119857
|
*
|
|
120278
119858
|
* @remarks
|
|
120279
|
-
* [Api set:
|
|
120280
|
-
* @beta
|
|
119859
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120281
119860
|
*/
|
|
120282
119861
|
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
|
|
120283
119862
|
/**
|
|
120284
119863
|
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
|
|
120285
119864
|
*
|
|
120286
119865
|
* @remarks
|
|
120287
|
-
* [Api set:
|
|
120288
|
-
* @beta
|
|
119866
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120289
119867
|
*/
|
|
120290
119868
|
parentGroup?: Word.Interfaces.ShapeLoadOptions;
|
|
120291
119869
|
/**
|
|
120292
119870
|
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}.
|
|
120293
119871
|
*
|
|
120294
119872
|
* @remarks
|
|
120295
|
-
* [Api set:
|
|
120296
|
-
* @beta
|
|
119873
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120297
119874
|
*/
|
|
120298
119875
|
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
120299
119876
|
/**
|
|
120300
|
-
|
|
120301
|
-
|
|
120302
|
-
|
|
120303
|
-
|
|
120304
|
-
|
|
120305
|
-
*/
|
|
119877
|
+
* Gets the text frame object of the shape.
|
|
119878
|
+
*
|
|
119879
|
+
* @remarks
|
|
119880
|
+
* [Api set: WordApiDesktop 1.2]
|
|
119881
|
+
*/
|
|
120306
119882
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120307
119883
|
/**
|
|
120308
119884
|
* Returns the text wrap formatting of the shape.
|
|
120309
119885
|
*
|
|
120310
119886
|
* @remarks
|
|
120311
|
-
* [Api set:
|
|
120312
|
-
* @beta
|
|
119887
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120313
119888
|
*/
|
|
120314
119889
|
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120315
119890
|
/**
|
|
120316
119891
|
* Specifies whether a given shape can overlap other shapes.
|
|
120317
119892
|
*
|
|
120318
119893
|
* @remarks
|
|
120319
|
-
* [Api set:
|
|
120320
|
-
* @beta
|
|
119894
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120321
119895
|
*/
|
|
120322
119896
|
allowOverlap?: boolean;
|
|
120323
119897
|
/**
|
|
120324
119898
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120325
119899
|
*
|
|
120326
119900
|
* @remarks
|
|
120327
|
-
* [Api set:
|
|
120328
|
-
* @beta
|
|
119901
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120329
119902
|
*/
|
|
120330
119903
|
geometricShapeType?: boolean;
|
|
120331
119904
|
/**
|
|
120332
119905
|
* The height, in points, of the shape.
|
|
120333
119906
|
*
|
|
120334
119907
|
* @remarks
|
|
120335
|
-
* [Api set:
|
|
120336
|
-
* @beta
|
|
119908
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120337
119909
|
*/
|
|
120338
119910
|
height?: boolean;
|
|
120339
119911
|
/**
|
|
120340
119912
|
* Gets an integer that represents the shape identifier.
|
|
120341
119913
|
*
|
|
120342
119914
|
* @remarks
|
|
120343
|
-
* [Api set:
|
|
120344
|
-
* @beta
|
|
119915
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120345
119916
|
*/
|
|
120346
119917
|
id?: boolean;
|
|
120347
119918
|
/**
|
|
120348
119919
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
120349
119920
|
*
|
|
120350
119921
|
* @remarks
|
|
120351
|
-
* [Api set:
|
|
120352
|
-
* @beta
|
|
119922
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120353
119923
|
*/
|
|
120354
119924
|
isChild?: boolean;
|
|
120355
119925
|
/**
|
|
120356
119926
|
* The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120357
119927
|
*
|
|
120358
119928
|
* @remarks
|
|
120359
|
-
* [Api set:
|
|
120360
|
-
* @beta
|
|
119929
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120361
119930
|
*/
|
|
120362
119931
|
left?: boolean;
|
|
120363
119932
|
/**
|
|
120364
119933
|
* The name of the shape.
|
|
120365
119934
|
*
|
|
120366
119935
|
* @remarks
|
|
120367
|
-
* [Api set:
|
|
120368
|
-
* @beta
|
|
119936
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120369
119937
|
*/
|
|
120370
119938
|
name?: boolean;
|
|
120371
119939
|
/**
|
|
120372
119940
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
120373
119941
|
*
|
|
120374
119942
|
* @remarks
|
|
120375
|
-
* [Api set:
|
|
120376
|
-
* @beta
|
|
119943
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120377
119944
|
*/
|
|
120378
119945
|
relativeHorizontalPosition?: boolean;
|
|
120379
119946
|
/**
|
|
120380
119947
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
120381
119948
|
*
|
|
120382
119949
|
* @remarks
|
|
120383
|
-
* [Api set:
|
|
120384
|
-
* @beta
|
|
119950
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120385
119951
|
*/
|
|
120386
119952
|
relativeVerticalPosition?: boolean;
|
|
120387
119953
|
/**
|
|
120388
119954
|
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120389
119955
|
*
|
|
120390
119956
|
* @remarks
|
|
120391
|
-
* [Api set:
|
|
120392
|
-
* @beta
|
|
119957
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120393
119958
|
*/
|
|
120394
119959
|
top?: boolean;
|
|
120395
119960
|
/**
|
|
120396
119961
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
120397
119962
|
*
|
|
120398
119963
|
* @remarks
|
|
120399
|
-
* [Api set:
|
|
120400
|
-
* @beta
|
|
119964
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120401
119965
|
*/
|
|
120402
119966
|
type?: boolean;
|
|
120403
119967
|
/**
|
|
120404
119968
|
* The width, in points, of the shape.
|
|
120405
119969
|
*
|
|
120406
119970
|
* @remarks
|
|
120407
|
-
* [Api set:
|
|
120408
|
-
* @beta
|
|
119971
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120409
119972
|
*/
|
|
120410
119973
|
width?: boolean;
|
|
120411
119974
|
}
|
|
@@ -120413,8 +119976,7 @@ declare namespace Word {
|
|
|
120413
119976
|
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
120414
119977
|
*
|
|
120415
119978
|
* @remarks
|
|
120416
|
-
* [Api set:
|
|
120417
|
-
* @beta
|
|
119979
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120418
119980
|
*/
|
|
120419
119981
|
interface ShapeGroupLoadOptions {
|
|
120420
119982
|
/**
|
|
@@ -120425,16 +119987,14 @@ declare namespace Word {
|
|
|
120425
119987
|
* Gets the Shape object associated with the group.
|
|
120426
119988
|
*
|
|
120427
119989
|
* @remarks
|
|
120428
|
-
* [Api set:
|
|
120429
|
-
* @beta
|
|
119990
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120430
119991
|
*/
|
|
120431
119992
|
shape?: Word.Interfaces.ShapeLoadOptions;
|
|
120432
119993
|
/**
|
|
120433
119994
|
* Gets an integer that represents the shape group identifier.
|
|
120434
119995
|
*
|
|
120435
119996
|
* @remarks
|
|
120436
|
-
* [Api set:
|
|
120437
|
-
* @beta
|
|
119997
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120438
119998
|
*/
|
|
120439
119999
|
id?: boolean;
|
|
120440
120000
|
}
|
|
@@ -120442,8 +120002,7 @@ declare namespace Word {
|
|
|
120442
120002
|
* Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.
|
|
120443
120003
|
*
|
|
120444
120004
|
* @remarks
|
|
120445
|
-
* [Api set:
|
|
120446
|
-
* @beta
|
|
120005
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120447
120006
|
*/
|
|
120448
120007
|
interface CanvasLoadOptions {
|
|
120449
120008
|
/**
|
|
@@ -120454,16 +120013,14 @@ declare namespace Word {
|
|
|
120454
120013
|
* Gets the Shape object associated with the canvas.
|
|
120455
120014
|
*
|
|
120456
120015
|
* @remarks
|
|
120457
|
-
* [Api set:
|
|
120458
|
-
* @beta
|
|
120016
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120459
120017
|
*/
|
|
120460
120018
|
shape?: Word.Interfaces.ShapeLoadOptions;
|
|
120461
120019
|
/**
|
|
120462
120020
|
* Gets an integer that represents the canvas identifier.
|
|
120463
120021
|
*
|
|
120464
120022
|
* @remarks
|
|
120465
|
-
* [Api set:
|
|
120466
|
-
* @beta
|
|
120023
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120467
120024
|
*/
|
|
120468
120025
|
id?: boolean;
|
|
120469
120026
|
}
|
|
@@ -120471,8 +120028,7 @@ declare namespace Word {
|
|
|
120471
120028
|
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
120472
120029
|
*
|
|
120473
120030
|
* @remarks
|
|
120474
|
-
* [Api set:
|
|
120475
|
-
* @beta
|
|
120031
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120476
120032
|
*/
|
|
120477
120033
|
interface ShapeCollectionLoadOptions {
|
|
120478
120034
|
/**
|
|
@@ -120483,160 +120039,140 @@ declare namespace Word {
|
|
|
120483
120039
|
* For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
120484
120040
|
*
|
|
120485
120041
|
* @remarks
|
|
120486
|
-
* [Api set:
|
|
120487
|
-
* @beta
|
|
120042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120488
120043
|
*/
|
|
120489
120044
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
120490
120045
|
/**
|
|
120491
120046
|
* For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}.
|
|
120492
120047
|
*
|
|
120493
120048
|
* @remarks
|
|
120494
|
-
* [Api set:
|
|
120495
|
-
* @beta
|
|
120049
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120496
120050
|
*/
|
|
120497
120051
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120498
120052
|
/**
|
|
120499
120053
|
* For EACH ITEM in the collection: Returns the fill formatting of the shape.
|
|
120500
120054
|
*
|
|
120501
120055
|
* @remarks
|
|
120502
|
-
* [Api set:
|
|
120503
|
-
* @beta
|
|
120056
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120504
120057
|
*/
|
|
120505
120058
|
fill?: Word.Interfaces.ShapeFillLoadOptions;
|
|
120506
120059
|
/**
|
|
120507
120060
|
* For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
|
|
120508
120061
|
*
|
|
120509
120062
|
* @remarks
|
|
120510
|
-
* [Api set:
|
|
120511
|
-
* @beta
|
|
120063
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120512
120064
|
*/
|
|
120513
120065
|
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
|
|
120514
120066
|
/**
|
|
120515
120067
|
* For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
|
|
120516
120068
|
*
|
|
120517
120069
|
* @remarks
|
|
120518
|
-
* [Api set:
|
|
120519
|
-
* @beta
|
|
120070
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120520
120071
|
*/
|
|
120521
120072
|
parentGroup?: Word.Interfaces.ShapeLoadOptions;
|
|
120522
120073
|
/**
|
|
120523
120074
|
* For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}.
|
|
120524
120075
|
*
|
|
120525
120076
|
* @remarks
|
|
120526
|
-
* [Api set:
|
|
120527
|
-
* @beta
|
|
120077
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120528
120078
|
*/
|
|
120529
120079
|
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
120530
120080
|
/**
|
|
120531
120081
|
* For EACH ITEM in the collection: Gets the text frame object of the shape.
|
|
120532
120082
|
*
|
|
120533
120083
|
* @remarks
|
|
120534
|
-
* [Api set:
|
|
120535
|
-
* @beta
|
|
120084
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120536
120085
|
*/
|
|
120537
120086
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120538
120087
|
/**
|
|
120539
120088
|
* For EACH ITEM in the collection: Returns the text wrap formatting of the shape.
|
|
120540
120089
|
*
|
|
120541
120090
|
* @remarks
|
|
120542
|
-
* [Api set:
|
|
120543
|
-
* @beta
|
|
120091
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120544
120092
|
*/
|
|
120545
120093
|
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120546
120094
|
/**
|
|
120547
120095
|
* For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.
|
|
120548
120096
|
*
|
|
120549
120097
|
* @remarks
|
|
120550
|
-
* [Api set:
|
|
120551
|
-
* @beta
|
|
120098
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120552
120099
|
*/
|
|
120553
120100
|
allowOverlap?: boolean;
|
|
120554
120101
|
/**
|
|
120555
120102
|
* For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120556
120103
|
*
|
|
120557
120104
|
* @remarks
|
|
120558
|
-
* [Api set:
|
|
120559
|
-
* @beta
|
|
120105
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120560
120106
|
*/
|
|
120561
120107
|
geometricShapeType?: boolean;
|
|
120562
120108
|
/**
|
|
120563
120109
|
* For EACH ITEM in the collection: The height, in points, of the shape.
|
|
120564
120110
|
*
|
|
120565
120111
|
* @remarks
|
|
120566
|
-
* [Api set:
|
|
120567
|
-
* @beta
|
|
120112
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120568
120113
|
*/
|
|
120569
120114
|
height?: boolean;
|
|
120570
120115
|
/**
|
|
120571
120116
|
* For EACH ITEM in the collection: Gets an integer that represents the shape identifier.
|
|
120572
120117
|
*
|
|
120573
120118
|
* @remarks
|
|
120574
|
-
* [Api set:
|
|
120575
|
-
* @beta
|
|
120119
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120576
120120
|
*/
|
|
120577
120121
|
id?: boolean;
|
|
120578
120122
|
/**
|
|
120579
120123
|
* For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.
|
|
120580
120124
|
*
|
|
120581
120125
|
* @remarks
|
|
120582
|
-
* [Api set:
|
|
120583
|
-
* @beta
|
|
120126
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120584
120127
|
*/
|
|
120585
120128
|
isChild?: boolean;
|
|
120586
120129
|
/**
|
|
120587
120130
|
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120588
120131
|
*
|
|
120589
120132
|
* @remarks
|
|
120590
|
-
* [Api set:
|
|
120591
|
-
* @beta
|
|
120133
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120592
120134
|
*/
|
|
120593
120135
|
left?: boolean;
|
|
120594
120136
|
/**
|
|
120595
120137
|
* For EACH ITEM in the collection: The name of the shape.
|
|
120596
120138
|
*
|
|
120597
120139
|
* @remarks
|
|
120598
|
-
* [Api set:
|
|
120599
|
-
* @beta
|
|
120140
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120600
120141
|
*/
|
|
120601
120142
|
name?: boolean;
|
|
120602
120143
|
/**
|
|
120603
120144
|
* For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
120604
120145
|
*
|
|
120605
120146
|
* @remarks
|
|
120606
|
-
* [Api set:
|
|
120607
|
-
* @beta
|
|
120147
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120608
120148
|
*/
|
|
120609
120149
|
relativeHorizontalPosition?: boolean;
|
|
120610
120150
|
/**
|
|
120611
120151
|
* For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
120612
120152
|
*
|
|
120613
120153
|
* @remarks
|
|
120614
|
-
* [Api set:
|
|
120615
|
-
* @beta
|
|
120154
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120616
120155
|
*/
|
|
120617
120156
|
relativeVerticalPosition?: boolean;
|
|
120618
120157
|
/**
|
|
120619
120158
|
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120620
120159
|
*
|
|
120621
120160
|
* @remarks
|
|
120622
|
-
* [Api set:
|
|
120623
|
-
* @beta
|
|
120161
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120624
120162
|
*/
|
|
120625
120163
|
top?: boolean;
|
|
120626
120164
|
/**
|
|
120627
120165
|
* For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
120628
120166
|
*
|
|
120629
120167
|
* @remarks
|
|
120630
|
-
* [Api set:
|
|
120631
|
-
* @beta
|
|
120168
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120632
120169
|
*/
|
|
120633
120170
|
type?: boolean;
|
|
120634
120171
|
/**
|
|
120635
120172
|
* For EACH ITEM in the collection: The width, in points, of the shape.
|
|
120636
120173
|
*
|
|
120637
120174
|
* @remarks
|
|
120638
|
-
* [Api set:
|
|
120639
|
-
* @beta
|
|
120175
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120640
120176
|
*/
|
|
120641
120177
|
width?: boolean;
|
|
120642
120178
|
}
|
|
@@ -120644,8 +120180,7 @@ declare namespace Word {
|
|
|
120644
120180
|
* Represents the fill formatting of a shape object.
|
|
120645
120181
|
*
|
|
120646
120182
|
* @remarks
|
|
120647
|
-
* [Api set:
|
|
120648
|
-
* @beta
|
|
120183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120649
120184
|
*/
|
|
120650
120185
|
interface ShapeFillLoadOptions {
|
|
120651
120186
|
/**
|
|
@@ -120656,32 +120191,28 @@ declare namespace Word {
|
|
|
120656
120191
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
120657
120192
|
*
|
|
120658
120193
|
* @remarks
|
|
120659
|
-
* [Api set:
|
|
120660
|
-
* @beta
|
|
120194
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120661
120195
|
*/
|
|
120662
120196
|
backgroundColor?: boolean;
|
|
120663
120197
|
/**
|
|
120664
120198
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
120665
120199
|
*
|
|
120666
120200
|
* @remarks
|
|
120667
|
-
* [Api set:
|
|
120668
|
-
* @beta
|
|
120201
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120669
120202
|
*/
|
|
120670
120203
|
foregroundColor?: boolean;
|
|
120671
120204
|
/**
|
|
120672
120205
|
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
120673
120206
|
*
|
|
120674
120207
|
* @remarks
|
|
120675
|
-
* [Api set:
|
|
120676
|
-
* @beta
|
|
120208
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120677
120209
|
*/
|
|
120678
120210
|
transparency?: boolean;
|
|
120679
120211
|
/**
|
|
120680
120212
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
120681
120213
|
*
|
|
120682
120214
|
* @remarks
|
|
120683
|
-
* [Api set:
|
|
120684
|
-
* @beta
|
|
120215
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120685
120216
|
*/
|
|
120686
120217
|
type?: boolean;
|
|
120687
120218
|
}
|
|
@@ -120689,8 +120220,7 @@ declare namespace Word {
|
|
|
120689
120220
|
* Represents the text frame of a shape object.
|
|
120690
120221
|
*
|
|
120691
120222
|
* @remarks
|
|
120692
|
-
* [Api set:
|
|
120693
|
-
* @beta
|
|
120223
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120694
120224
|
*/
|
|
120695
120225
|
interface TextFrameLoadOptions {
|
|
120696
120226
|
/**
|
|
@@ -120701,80 +120231,70 @@ declare namespace Word {
|
|
|
120701
120231
|
* The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
|
|
120702
120232
|
*
|
|
120703
120233
|
* @remarks
|
|
120704
|
-
* [Api set:
|
|
120705
|
-
* @beta
|
|
120234
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120706
120235
|
*/
|
|
120707
120236
|
autoSizeSetting?: boolean;
|
|
120708
120237
|
/**
|
|
120709
120238
|
* Represents the bottom margin, in points, of the text frame.
|
|
120710
120239
|
*
|
|
120711
120240
|
* @remarks
|
|
120712
|
-
* [Api set:
|
|
120713
|
-
* @beta
|
|
120241
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120714
120242
|
*/
|
|
120715
120243
|
bottomMargin?: boolean;
|
|
120716
120244
|
/**
|
|
120717
120245
|
* Specifies if the text frame contains text.
|
|
120718
120246
|
*
|
|
120719
120247
|
* @remarks
|
|
120720
|
-
* [Api set:
|
|
120721
|
-
* @beta
|
|
120248
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120722
120249
|
*/
|
|
120723
120250
|
hasText?: boolean;
|
|
120724
120251
|
/**
|
|
120725
120252
|
* Represents the left margin, in points, of the text frame.
|
|
120726
120253
|
*
|
|
120727
120254
|
* @remarks
|
|
120728
|
-
* [Api set:
|
|
120729
|
-
* @beta
|
|
120255
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120730
120256
|
*/
|
|
120731
120257
|
leftMargin?: boolean;
|
|
120732
120258
|
/**
|
|
120733
120259
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
120734
120260
|
*
|
|
120735
120261
|
* @remarks
|
|
120736
|
-
* [Api set:
|
|
120737
|
-
* @beta
|
|
120262
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120738
120263
|
*/
|
|
120739
120264
|
noTextRotation?: boolean;
|
|
120740
120265
|
/**
|
|
120741
120266
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
120742
120267
|
*
|
|
120743
120268
|
* @remarks
|
|
120744
|
-
* [Api set:
|
|
120745
|
-
* @beta
|
|
120269
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120746
120270
|
*/
|
|
120747
120271
|
orientation?: boolean;
|
|
120748
120272
|
/**
|
|
120749
120273
|
* Represents the right margin, in points, of the text frame.
|
|
120750
120274
|
*
|
|
120751
120275
|
* @remarks
|
|
120752
|
-
* [Api set:
|
|
120753
|
-
* @beta
|
|
120276
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120754
120277
|
*/
|
|
120755
120278
|
rightMargin?: boolean;
|
|
120756
120279
|
/**
|
|
120757
120280
|
* Represents the top margin, in points, of the text frame.
|
|
120758
120281
|
*
|
|
120759
120282
|
* @remarks
|
|
120760
|
-
* [Api set:
|
|
120761
|
-
* @beta
|
|
120283
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120762
120284
|
*/
|
|
120763
120285
|
topMargin?: boolean;
|
|
120764
120286
|
/**
|
|
120765
120287
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
120766
120288
|
*
|
|
120767
120289
|
* @remarks
|
|
120768
|
-
* [Api set:
|
|
120769
|
-
* @beta
|
|
120290
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120770
120291
|
*/
|
|
120771
120292
|
verticalAlignment?: boolean;
|
|
120772
120293
|
/**
|
|
120773
120294
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
120774
120295
|
*
|
|
120775
120296
|
* @remarks
|
|
120776
|
-
* [Api set:
|
|
120777
|
-
* @beta
|
|
120297
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120778
120298
|
*/
|
|
120779
120299
|
wordWrap?: boolean;
|
|
120780
120300
|
}
|
|
@@ -120782,8 +120302,7 @@ declare namespace Word {
|
|
|
120782
120302
|
* Represents all the properties for wrapping text around a shape.
|
|
120783
120303
|
*
|
|
120784
120304
|
* @remarks
|
|
120785
|
-
* [Api set:
|
|
120786
|
-
* @beta
|
|
120305
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120787
120306
|
*/
|
|
120788
120307
|
interface ShapeTextWrapLoadOptions {
|
|
120789
120308
|
/**
|
|
@@ -120794,48 +120313,42 @@ declare namespace Word {
|
|
|
120794
120313
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
120795
120314
|
*
|
|
120796
120315
|
* @remarks
|
|
120797
|
-
* [Api set:
|
|
120798
|
-
* @beta
|
|
120316
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120799
120317
|
*/
|
|
120800
120318
|
bottomDistance?: boolean;
|
|
120801
120319
|
/**
|
|
120802
120320
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
120803
120321
|
*
|
|
120804
120322
|
* @remarks
|
|
120805
|
-
* [Api set:
|
|
120806
|
-
* @beta
|
|
120323
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120807
120324
|
*/
|
|
120808
120325
|
leftDistance?: boolean;
|
|
120809
120326
|
/**
|
|
120810
120327
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
120811
120328
|
*
|
|
120812
120329
|
* @remarks
|
|
120813
|
-
* [Api set:
|
|
120814
|
-
* @beta
|
|
120330
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120815
120331
|
*/
|
|
120816
120332
|
rightDistance?: boolean;
|
|
120817
120333
|
/**
|
|
120818
120334
|
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
120819
120335
|
*
|
|
120820
120336
|
* @remarks
|
|
120821
|
-
* [Api set:
|
|
120822
|
-
* @beta
|
|
120337
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120823
120338
|
*/
|
|
120824
120339
|
side?: boolean;
|
|
120825
120340
|
/**
|
|
120826
120341
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
120827
120342
|
*
|
|
120828
120343
|
* @remarks
|
|
120829
|
-
* [Api set:
|
|
120830
|
-
* @beta
|
|
120344
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120831
120345
|
*/
|
|
120832
120346
|
topDistance?: boolean;
|
|
120833
120347
|
/**
|
|
120834
120348
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
120835
120349
|
*
|
|
120836
120350
|
* @remarks
|
|
120837
|
-
* [Api set:
|
|
120838
|
-
* @beta
|
|
120351
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120839
120352
|
*/
|
|
120840
120353
|
type?: boolean;
|
|
120841
120354
|
}
|