@types/office-js-preview 1.0.565 → 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 +544 -1104
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -94905,8 +94905,7 @@ declare namespace Word {
|
|
|
94905
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.
|
|
94906
94906
|
*
|
|
94907
94907
|
* @remarks
|
|
94908
|
-
* [Api set:
|
|
94909
|
-
* @beta
|
|
94908
|
+
* [Api set: WordApiDesktop 1.2]
|
|
94910
94909
|
*/
|
|
94911
94910
|
readonly shapes: Word.ShapeCollection;
|
|
94912
94911
|
/**
|
|
@@ -97500,8 +97499,7 @@ declare namespace Word {
|
|
|
97500
97499
|
* Gets the active window for the document.
|
|
97501
97500
|
*
|
|
97502
97501
|
* @remarks
|
|
97503
|
-
* [Api set:
|
|
97504
|
-
* @beta
|
|
97502
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97505
97503
|
*/
|
|
97506
97504
|
readonly activeWindow: Word.Window;
|
|
97507
97505
|
/**
|
|
@@ -97550,8 +97548,7 @@ declare namespace Word {
|
|
|
97550
97548
|
* Gets the collection of `Word.Window` objects for the document.
|
|
97551
97549
|
*
|
|
97552
97550
|
* @remarks
|
|
97553
|
-
* [Api set:
|
|
97554
|
-
* @beta
|
|
97551
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97555
97552
|
*/
|
|
97556
97553
|
readonly windows: Word.WindowCollection;
|
|
97557
97554
|
/**
|
|
@@ -97632,8 +97629,7 @@ declare namespace Word {
|
|
|
97632
97629
|
* Displays revision marks that indicate where the specified document differs from another document.
|
|
97633
97630
|
*
|
|
97634
97631
|
* @remarks
|
|
97635
|
-
* [Api set:
|
|
97636
|
-
* @beta
|
|
97632
|
+
* [Api set: WordApiDesktop 1.2]
|
|
97637
97633
|
*
|
|
97638
97634
|
* @param base64File Required. The Base64-encoded content of the document with which the specified document is compared.
|
|
97639
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.
|
|
@@ -100005,8 +100001,7 @@ declare namespace Word {
|
|
|
100005
100001
|
* Represents a page in the document. `Page` objects manage the page layout and content.
|
|
100006
100002
|
*
|
|
100007
100003
|
* @remarks
|
|
100008
|
-
* [Api set:
|
|
100009
|
-
* @beta
|
|
100004
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100010
100005
|
*/
|
|
100011
100006
|
class Page extends OfficeExtension.ClientObject {
|
|
100012
100007
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100015,48 +100010,42 @@ declare namespace Word {
|
|
|
100015
100010
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
100016
100011
|
*
|
|
100017
100012
|
* @remarks
|
|
100018
|
-
* [Api set:
|
|
100019
|
-
* @beta
|
|
100013
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100020
100014
|
*/
|
|
100021
100015
|
readonly height: number;
|
|
100022
100016
|
/**
|
|
100023
100017
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
100024
100018
|
*
|
|
100025
100019
|
* @remarks
|
|
100026
|
-
* [Api set:
|
|
100027
|
-
* @beta
|
|
100020
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100028
100021
|
*/
|
|
100029
100022
|
readonly index: number;
|
|
100030
100023
|
/**
|
|
100031
100024
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
100032
100025
|
*
|
|
100033
100026
|
* @remarks
|
|
100034
|
-
* [Api set:
|
|
100035
|
-
* @beta
|
|
100027
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100036
100028
|
*/
|
|
100037
100029
|
readonly width: number;
|
|
100038
100030
|
/**
|
|
100039
100031
|
* Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one.
|
|
100040
100032
|
*
|
|
100041
100033
|
* @remarks
|
|
100042
|
-
* [Api set:
|
|
100043
|
-
* @beta
|
|
100034
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100044
100035
|
*/
|
|
100045
100036
|
getNext(): Word.Page;
|
|
100046
100037
|
/**
|
|
100047
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}.
|
|
100048
100039
|
*
|
|
100049
100040
|
* @remarks
|
|
100050
|
-
* [Api set:
|
|
100051
|
-
* @beta
|
|
100041
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100052
100042
|
*/
|
|
100053
100043
|
getNextOrNullObject(): Word.Page;
|
|
100054
100044
|
/**
|
|
100055
100045
|
* Gets the whole page, or the starting or ending point of the page, as a range.
|
|
100056
100046
|
*
|
|
100057
100047
|
* @remarks
|
|
100058
|
-
* [Api set:
|
|
100059
|
-
* @beta
|
|
100048
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100060
100049
|
*
|
|
100061
100050
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
100062
100051
|
*/
|
|
@@ -100100,8 +100089,7 @@ declare namespace Word {
|
|
|
100100
100089
|
* Represents the collection of page.
|
|
100101
100090
|
*
|
|
100102
100091
|
* @remarks
|
|
100103
|
-
* [Api set:
|
|
100104
|
-
* @beta
|
|
100092
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100105
100093
|
*/
|
|
100106
100094
|
class PageCollection extends OfficeExtension.ClientObject {
|
|
100107
100095
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100112,28 +100100,16 @@ declare namespace Word {
|
|
|
100112
100100
|
* Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100113
100101
|
*
|
|
100114
100102
|
* @remarks
|
|
100115
|
-
* [Api set:
|
|
100116
|
-
* @beta
|
|
100103
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100117
100104
|
*/
|
|
100118
100105
|
getFirst(): Word.Page;
|
|
100119
100106
|
/**
|
|
100120
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}.
|
|
100121
100108
|
*
|
|
100122
100109
|
* @remarks
|
|
100123
|
-
* [Api set:
|
|
100124
|
-
* @beta
|
|
100110
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100125
100111
|
*/
|
|
100126
100112
|
getFirstOrNullObject(): Word.Page;
|
|
100127
|
-
/**
|
|
100128
|
-
* Gets a Page object by its index in the collection.
|
|
100129
|
-
*
|
|
100130
|
-
* @remarks
|
|
100131
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100132
|
-
* @beta
|
|
100133
|
-
*
|
|
100134
|
-
* @param index A number that identifies the index location of a Page object.
|
|
100135
|
-
*/
|
|
100136
|
-
getItem(index: number): Word.Page;
|
|
100137
100113
|
/**
|
|
100138
100114
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100139
100115
|
*
|
|
@@ -100170,8 +100146,7 @@ declare namespace Word {
|
|
|
100170
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.
|
|
100171
100147
|
*
|
|
100172
100148
|
* @remarks
|
|
100173
|
-
* [Api set:
|
|
100174
|
-
* @beta
|
|
100149
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100175
100150
|
*/
|
|
100176
100151
|
class Pane extends OfficeExtension.ClientObject {
|
|
100177
100152
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100180,32 +100155,28 @@ declare namespace Word {
|
|
|
100180
100155
|
* Gets the collection of pages in the pane.
|
|
100181
100156
|
*
|
|
100182
100157
|
* @remarks
|
|
100183
|
-
* [Api set:
|
|
100184
|
-
* @beta
|
|
100158
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100185
100159
|
*/
|
|
100186
100160
|
readonly pages: Word.PageCollection;
|
|
100187
100161
|
/**
|
|
100188
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.
|
|
100189
100163
|
*
|
|
100190
100164
|
* @remarks
|
|
100191
|
-
* [Api set:
|
|
100192
|
-
* @beta
|
|
100165
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100193
100166
|
*/
|
|
100194
100167
|
readonly pagesEnclosingViewport: Word.PageCollection;
|
|
100195
100168
|
/**
|
|
100196
100169
|
* Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one.
|
|
100197
100170
|
*
|
|
100198
100171
|
* @remarks
|
|
100199
|
-
* [Api set:
|
|
100200
|
-
* @beta
|
|
100172
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100201
100173
|
*/
|
|
100202
100174
|
getNext(): Word.Pane;
|
|
100203
100175
|
/**
|
|
100204
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}.
|
|
100205
100177
|
*
|
|
100206
100178
|
* @remarks
|
|
100207
|
-
* [Api set:
|
|
100208
|
-
* @beta
|
|
100179
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100209
100180
|
*/
|
|
100210
100181
|
getNextOrNullObject(): Word.Pane;
|
|
100211
100182
|
/**
|
|
@@ -100241,8 +100212,7 @@ declare namespace Word {
|
|
|
100241
100212
|
* Represents the collection of pane.
|
|
100242
100213
|
*
|
|
100243
100214
|
* @remarks
|
|
100244
|
-
* [Api set:
|
|
100245
|
-
* @beta
|
|
100215
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100246
100216
|
*/
|
|
100247
100217
|
class PaneCollection extends OfficeExtension.ClientObject {
|
|
100248
100218
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100253,28 +100223,16 @@ declare namespace Word {
|
|
|
100253
100223
|
* Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100254
100224
|
*
|
|
100255
100225
|
* @remarks
|
|
100256
|
-
* [Api set:
|
|
100257
|
-
* @beta
|
|
100226
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100258
100227
|
*/
|
|
100259
100228
|
getFirst(): Word.Pane;
|
|
100260
100229
|
/**
|
|
100261
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}.
|
|
100262
100231
|
*
|
|
100263
100232
|
* @remarks
|
|
100264
|
-
* [Api set:
|
|
100265
|
-
* @beta
|
|
100233
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100266
100234
|
*/
|
|
100267
100235
|
getFirstOrNullObject(): Word.Pane;
|
|
100268
|
-
/**
|
|
100269
|
-
* Gets a Pane object by its index in the collection.
|
|
100270
|
-
*
|
|
100271
|
-
* @remarks
|
|
100272
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100273
|
-
* @beta
|
|
100274
|
-
*
|
|
100275
|
-
* @param index A number that identifies the index location of a Pane object.
|
|
100276
|
-
*/
|
|
100277
|
-
getItem(index: number): Word.Pane;
|
|
100278
100236
|
/**
|
|
100279
100237
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100280
100238
|
*
|
|
@@ -100305,8 +100263,7 @@ declare namespace Word {
|
|
|
100305
100263
|
* Represents the window that displays the document. A window can be split to contain multiple reading panes.
|
|
100306
100264
|
*
|
|
100307
100265
|
* @remarks
|
|
100308
|
-
* [Api set:
|
|
100309
|
-
* @beta
|
|
100266
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100310
100267
|
*/
|
|
100311
100268
|
class Window extends OfficeExtension.ClientObject {
|
|
100312
100269
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100315,16 +100272,14 @@ declare namespace Word {
|
|
|
100315
100272
|
* Gets the active pane in the window.
|
|
100316
100273
|
*
|
|
100317
100274
|
* @remarks
|
|
100318
|
-
* [Api set:
|
|
100319
|
-
* @beta
|
|
100275
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100320
100276
|
*/
|
|
100321
100277
|
readonly activePane: Word.Pane;
|
|
100322
100278
|
/**
|
|
100323
100279
|
* Gets the collection of panes in the window.
|
|
100324
100280
|
*
|
|
100325
100281
|
* @remarks
|
|
100326
|
-
* [Api set:
|
|
100327
|
-
* @beta
|
|
100282
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100328
100283
|
*/
|
|
100329
100284
|
readonly panes: Word.PaneCollection;
|
|
100330
100285
|
/**
|
|
@@ -100360,8 +100315,7 @@ declare namespace Word {
|
|
|
100360
100315
|
* Represents the collection of window objects.
|
|
100361
100316
|
*
|
|
100362
100317
|
* @remarks
|
|
100363
|
-
* [Api set:
|
|
100364
|
-
* @beta
|
|
100318
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100365
100319
|
*/
|
|
100366
100320
|
class WindowCollection extends OfficeExtension.ClientObject {
|
|
100367
100321
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -100372,28 +100326,16 @@ declare namespace Word {
|
|
|
100372
100326
|
* Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
100373
100327
|
*
|
|
100374
100328
|
* @remarks
|
|
100375
|
-
* [Api set:
|
|
100376
|
-
* @beta
|
|
100329
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100377
100330
|
*/
|
|
100378
100331
|
getFirst(): Word.Window;
|
|
100379
100332
|
/**
|
|
100380
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}.
|
|
100381
100334
|
*
|
|
100382
100335
|
* @remarks
|
|
100383
|
-
* [Api set:
|
|
100384
|
-
* @beta
|
|
100336
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100385
100337
|
*/
|
|
100386
100338
|
getFirstOrNullObject(): Word.Window;
|
|
100387
|
-
/**
|
|
100388
|
-
* Gets a Window object by its index in the collection.
|
|
100389
|
-
*
|
|
100390
|
-
* @remarks
|
|
100391
|
-
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100392
|
-
* @beta
|
|
100393
|
-
*
|
|
100394
|
-
* @param index A number that identifies the index location of a Window object.
|
|
100395
|
-
*/
|
|
100396
|
-
getItem(index: number): Word.Window;
|
|
100397
100339
|
/**
|
|
100398
100340
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100399
100341
|
*
|
|
@@ -100552,8 +100494,7 @@ declare namespace Word {
|
|
|
100552
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.
|
|
100553
100495
|
*
|
|
100554
100496
|
* @remarks
|
|
100555
|
-
* [Api set:
|
|
100556
|
-
* @beta
|
|
100497
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100557
100498
|
*/
|
|
100558
100499
|
readonly shapes: Word.ShapeCollection;
|
|
100559
100500
|
/**
|
|
@@ -100868,8 +100809,7 @@ declare namespace Word {
|
|
|
100868
100809
|
* Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.
|
|
100869
100810
|
*
|
|
100870
100811
|
* @remarks
|
|
100871
|
-
* [Api set:
|
|
100872
|
-
* @beta
|
|
100812
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100873
100813
|
*
|
|
100874
100814
|
* @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200).
|
|
100875
100815
|
*/
|
|
@@ -100902,8 +100842,7 @@ declare namespace Word {
|
|
|
100902
100842
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.
|
|
100903
100843
|
*
|
|
100904
100844
|
* @remarks
|
|
100905
|
-
* [Api set:
|
|
100906
|
-
* @beta
|
|
100845
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100907
100846
|
*
|
|
100908
100847
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100909
100848
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -100913,8 +100852,7 @@ declare namespace Word {
|
|
|
100913
100852
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.
|
|
100914
100853
|
*
|
|
100915
100854
|
* @remarks
|
|
100916
|
-
* [Api set:
|
|
100917
|
-
* @beta
|
|
100855
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100918
100856
|
*
|
|
100919
100857
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100920
100858
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -100964,8 +100902,7 @@ declare namespace Word {
|
|
|
100964
100902
|
* Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.
|
|
100965
100903
|
*
|
|
100966
100904
|
* @remarks
|
|
100967
|
-
* [Api set:
|
|
100968
|
-
* @beta
|
|
100905
|
+
* [Api set: WordApiDesktop 1.2]
|
|
100969
100906
|
*
|
|
100970
100907
|
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
100971
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.
|
|
@@ -100997,8 +100934,7 @@ declare namespace Word {
|
|
|
100997
100934
|
* Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.
|
|
100998
100935
|
*
|
|
100999
100936
|
* @remarks
|
|
101000
|
-
* [Api set:
|
|
101001
|
-
* @beta
|
|
100937
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101002
100938
|
*
|
|
101003
100939
|
* @param text Optional. The text to insert into the text box.
|
|
101004
100940
|
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
@@ -101426,8 +101362,7 @@ declare namespace Word {
|
|
|
101426
101362
|
* Gets the collection of pages in the range.
|
|
101427
101363
|
*
|
|
101428
101364
|
* @remarks
|
|
101429
|
-
* [Api set:
|
|
101430
|
-
* @beta
|
|
101365
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101431
101366
|
*/
|
|
101432
101367
|
readonly pages: Word.PageCollection;
|
|
101433
101368
|
/**
|
|
@@ -101492,8 +101427,7 @@ declare namespace Word {
|
|
|
101492
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.
|
|
101493
101428
|
*
|
|
101494
101429
|
* @remarks
|
|
101495
|
-
* [Api set:
|
|
101496
|
-
* @beta
|
|
101430
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101497
101431
|
*/
|
|
101498
101432
|
readonly shapes: Word.ShapeCollection;
|
|
101499
101433
|
/**
|
|
@@ -101736,8 +101670,7 @@ declare namespace Word {
|
|
|
101736
101670
|
* Inserts a floating canvas in front of text with its anchor at the beginning of the range.
|
|
101737
101671
|
*
|
|
101738
101672
|
* @remarks
|
|
101739
|
-
* [Api set:
|
|
101740
|
-
* @beta
|
|
101673
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101741
101674
|
*
|
|
101742
101675
|
* @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200).
|
|
101743
101676
|
*/
|
|
@@ -101850,8 +101783,7 @@ declare namespace Word {
|
|
|
101850
101783
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the range.
|
|
101851
101784
|
*
|
|
101852
101785
|
* @remarks
|
|
101853
|
-
* [Api set:
|
|
101854
|
-
* @beta
|
|
101786
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101855
101787
|
*
|
|
101856
101788
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101857
101789
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -101861,8 +101793,7 @@ declare namespace Word {
|
|
|
101861
101793
|
* Inserts a geometric shape in front of text with its anchor at the beginning of the range.
|
|
101862
101794
|
*
|
|
101863
101795
|
* @remarks
|
|
101864
|
-
* [Api set:
|
|
101865
|
-
* @beta
|
|
101796
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101866
101797
|
*
|
|
101867
101798
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101868
101799
|
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
@@ -101912,8 +101843,7 @@ declare namespace Word {
|
|
|
101912
101843
|
* Inserts a floating picture in front of text with its anchor at the beginning of the range.
|
|
101913
101844
|
*
|
|
101914
101845
|
* @remarks
|
|
101915
|
-
* [Api set:
|
|
101916
|
-
* @beta
|
|
101846
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101917
101847
|
*
|
|
101918
101848
|
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
101919
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.
|
|
@@ -101945,8 +101875,7 @@ declare namespace Word {
|
|
|
101945
101875
|
* Inserts a floating text box in front of text with its anchor at the beginning of the range.
|
|
101946
101876
|
*
|
|
101947
101877
|
* @remarks
|
|
101948
|
-
* [Api set:
|
|
101949
|
-
* @beta
|
|
101878
|
+
* [Api set: WordApiDesktop 1.2]
|
|
101950
101879
|
*
|
|
101951
101880
|
* @param text Optional. The text to insert into the text box.
|
|
101952
101881
|
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
@@ -102161,40 +102090,35 @@ declare namespace Word {
|
|
|
102161
102090
|
* Specifies the options to determine location and size when inserting a shape.
|
|
102162
102091
|
*
|
|
102163
102092
|
* @remarks
|
|
102164
|
-
* [Api set:
|
|
102165
|
-
* @beta
|
|
102093
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102166
102094
|
*/
|
|
102167
102095
|
interface InsertShapeOptions {
|
|
102168
102096
|
/**
|
|
102169
102097
|
* Represents the height of the shape being inserted.
|
|
102170
102098
|
*
|
|
102171
102099
|
* @remarks
|
|
102172
|
-
* [Api set:
|
|
102173
|
-
* @beta
|
|
102100
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102174
102101
|
*/
|
|
102175
102102
|
height?: number;
|
|
102176
102103
|
/**
|
|
102177
102104
|
* Represents the left position of the shape being inserted.
|
|
102178
102105
|
*
|
|
102179
102106
|
* @remarks
|
|
102180
|
-
* [Api set:
|
|
102181
|
-
* @beta
|
|
102107
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102182
102108
|
*/
|
|
102183
102109
|
left?: number;
|
|
102184
102110
|
/**
|
|
102185
102111
|
* Represents the top position of the shape being inserted.
|
|
102186
102112
|
*
|
|
102187
102113
|
* @remarks
|
|
102188
|
-
* [Api set:
|
|
102189
|
-
* @beta
|
|
102114
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102190
102115
|
*/
|
|
102191
102116
|
top?: number;
|
|
102192
102117
|
/**
|
|
102193
102118
|
* Represents the width of the shape being inserted.
|
|
102194
102119
|
*
|
|
102195
102120
|
* @remarks
|
|
102196
|
-
* [Api set:
|
|
102197
|
-
* @beta
|
|
102121
|
+
* [Api set: WordApiDesktop 1.2]
|
|
102198
102122
|
*/
|
|
102199
102123
|
width?: number;
|
|
102200
102124
|
}
|
|
@@ -104704,11 +104628,10 @@ declare namespace Word {
|
|
|
104704
104628
|
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
104705
104629
|
}
|
|
104706
104630
|
/**
|
|
104707
|
-
* 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.
|
|
104708
104632
|
*
|
|
104709
104633
|
* @remarks
|
|
104710
|
-
* [Api set:
|
|
104711
|
-
* @beta
|
|
104634
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104712
104635
|
*/
|
|
104713
104636
|
class Shape extends OfficeExtension.ClientObject {
|
|
104714
104637
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -104717,160 +104640,140 @@ declare namespace Word {
|
|
|
104717
104640
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
104718
104641
|
*
|
|
104719
104642
|
* @remarks
|
|
104720
|
-
* [Api set:
|
|
104721
|
-
* @beta
|
|
104643
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104722
104644
|
*/
|
|
104723
104645
|
readonly body: Word.Body;
|
|
104724
104646
|
/**
|
|
104725
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}.
|
|
104726
104648
|
*
|
|
104727
104649
|
* @remarks
|
|
104728
|
-
* [Api set:
|
|
104729
|
-
* @beta
|
|
104650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104730
104651
|
*/
|
|
104731
104652
|
readonly canvas: Word.Canvas;
|
|
104732
104653
|
/**
|
|
104733
104654
|
* Returns the fill formatting of the shape.
|
|
104734
104655
|
*
|
|
104735
104656
|
* @remarks
|
|
104736
|
-
* [Api set:
|
|
104737
|
-
* @beta
|
|
104657
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104738
104658
|
*/
|
|
104739
104659
|
readonly fill: Word.ShapeFill;
|
|
104740
104660
|
/**
|
|
104741
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.
|
|
104742
104662
|
*
|
|
104743
104663
|
* @remarks
|
|
104744
|
-
* [Api set:
|
|
104745
|
-
* @beta
|
|
104664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104746
104665
|
*/
|
|
104747
104666
|
readonly parentCanvas: Word.Shape;
|
|
104748
104667
|
/**
|
|
104749
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.
|
|
104750
104669
|
*
|
|
104751
104670
|
* @remarks
|
|
104752
|
-
* [Api set:
|
|
104753
|
-
* @beta
|
|
104671
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104754
104672
|
*/
|
|
104755
104673
|
readonly parentGroup: Word.Shape;
|
|
104756
104674
|
/**
|
|
104757
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}.
|
|
104758
104676
|
*
|
|
104759
104677
|
* @remarks
|
|
104760
|
-
* [Api set:
|
|
104761
|
-
* @beta
|
|
104678
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104762
104679
|
*/
|
|
104763
104680
|
readonly shapeGroup: Word.ShapeGroup;
|
|
104764
104681
|
/**
|
|
104765
104682
|
* Gets the text frame object of the shape.
|
|
104766
104683
|
*
|
|
104767
104684
|
* @remarks
|
|
104768
|
-
* [Api set:
|
|
104769
|
-
* @beta
|
|
104685
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104770
104686
|
*/
|
|
104771
104687
|
readonly textFrame: Word.TextFrame;
|
|
104772
104688
|
/**
|
|
104773
104689
|
* Returns the text wrap formatting of the shape.
|
|
104774
104690
|
*
|
|
104775
104691
|
* @remarks
|
|
104776
|
-
* [Api set:
|
|
104777
|
-
* @beta
|
|
104692
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104778
104693
|
*/
|
|
104779
104694
|
readonly textWrap: Word.ShapeTextWrap;
|
|
104780
104695
|
/**
|
|
104781
104696
|
* Specifies whether a given shape can overlap other shapes.
|
|
104782
104697
|
*
|
|
104783
104698
|
* @remarks
|
|
104784
|
-
* [Api set:
|
|
104785
|
-
* @beta
|
|
104699
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104786
104700
|
*/
|
|
104787
104701
|
allowOverlap: boolean;
|
|
104788
104702
|
/**
|
|
104789
104703
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
104790
104704
|
*
|
|
104791
104705
|
* @remarks
|
|
104792
|
-
* [Api set:
|
|
104793
|
-
* @beta
|
|
104706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104794
104707
|
*/
|
|
104795
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";
|
|
104796
104709
|
/**
|
|
104797
104710
|
* The height, in points, of the shape.
|
|
104798
104711
|
*
|
|
104799
104712
|
* @remarks
|
|
104800
|
-
* [Api set:
|
|
104801
|
-
* @beta
|
|
104713
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104802
104714
|
*/
|
|
104803
104715
|
height: number;
|
|
104804
104716
|
/**
|
|
104805
104717
|
* Gets an integer that represents the shape identifier.
|
|
104806
104718
|
*
|
|
104807
104719
|
* @remarks
|
|
104808
|
-
* [Api set:
|
|
104809
|
-
* @beta
|
|
104720
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104810
104721
|
*/
|
|
104811
104722
|
readonly id: number;
|
|
104812
104723
|
/**
|
|
104813
104724
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
104814
104725
|
*
|
|
104815
104726
|
* @remarks
|
|
104816
|
-
* [Api set:
|
|
104817
|
-
* @beta
|
|
104727
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104818
104728
|
*/
|
|
104819
104729
|
readonly isChild: boolean;
|
|
104820
104730
|
/**
|
|
104821
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.
|
|
104822
104732
|
*
|
|
104823
104733
|
* @remarks
|
|
104824
|
-
* [Api set:
|
|
104825
|
-
* @beta
|
|
104734
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104826
104735
|
*/
|
|
104827
104736
|
left: number;
|
|
104828
104737
|
/**
|
|
104829
104738
|
* The name of the shape.
|
|
104830
104739
|
*
|
|
104831
104740
|
* @remarks
|
|
104832
|
-
* [Api set:
|
|
104833
|
-
* @beta
|
|
104741
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104834
104742
|
*/
|
|
104835
104743
|
name: string;
|
|
104836
104744
|
/**
|
|
104837
104745
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
104838
104746
|
*
|
|
104839
104747
|
* @remarks
|
|
104840
|
-
* [Api set:
|
|
104841
|
-
* @beta
|
|
104748
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104842
104749
|
*/
|
|
104843
104750
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
104844
104751
|
/**
|
|
104845
104752
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
104846
104753
|
*
|
|
104847
104754
|
* @remarks
|
|
104848
|
-
* [Api set:
|
|
104849
|
-
* @beta
|
|
104755
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104850
104756
|
*/
|
|
104851
104757
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
104852
104758
|
/**
|
|
104853
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.
|
|
104854
104760
|
*
|
|
104855
104761
|
* @remarks
|
|
104856
|
-
* [Api set:
|
|
104857
|
-
* @beta
|
|
104762
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104858
104763
|
*/
|
|
104859
104764
|
top: number;
|
|
104860
104765
|
/**
|
|
104861
104766
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
104862
104767
|
*
|
|
104863
104768
|
* @remarks
|
|
104864
|
-
* [Api set:
|
|
104865
|
-
* @beta
|
|
104769
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104866
104770
|
*/
|
|
104867
104771
|
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
|
|
104868
104772
|
/**
|
|
104869
104773
|
* The width, in points, of the shape.
|
|
104870
104774
|
*
|
|
104871
104775
|
* @remarks
|
|
104872
|
-
* [Api set:
|
|
104873
|
-
* @beta
|
|
104776
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104874
104777
|
*/
|
|
104875
104778
|
width: number;
|
|
104876
104779
|
/**
|
|
@@ -104885,16 +104788,14 @@ declare namespace Word {
|
|
|
104885
104788
|
* Deletes the shape and its content.
|
|
104886
104789
|
*
|
|
104887
104790
|
* @remarks
|
|
104888
|
-
* [Api set:
|
|
104889
|
-
* @beta
|
|
104791
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104890
104792
|
*/
|
|
104891
104793
|
delete(): void;
|
|
104892
104794
|
/**
|
|
104893
104795
|
* Moves the shape horizontally by the number of points.
|
|
104894
104796
|
*
|
|
104895
104797
|
* @remarks
|
|
104896
|
-
* [Api set:
|
|
104897
|
-
* @beta
|
|
104798
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104898
104799
|
*
|
|
104899
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.
|
|
104900
104801
|
*/
|
|
@@ -104903,8 +104804,7 @@ declare namespace Word {
|
|
|
104903
104804
|
* Moves the shape vertically by the number of points.
|
|
104904
104805
|
*
|
|
104905
104806
|
* @remarks
|
|
104906
|
-
* [Api set:
|
|
104907
|
-
* @beta
|
|
104807
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104908
104808
|
*
|
|
104909
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.
|
|
104910
104810
|
*/
|
|
@@ -104913,8 +104813,7 @@ declare namespace Word {
|
|
|
104913
104813
|
* Selects the shape.
|
|
104914
104814
|
*
|
|
104915
104815
|
* @remarks
|
|
104916
|
-
* [Api set:
|
|
104917
|
-
* @beta
|
|
104816
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104918
104817
|
*
|
|
104919
104818
|
* @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false.
|
|
104920
104819
|
*/
|
|
@@ -104958,8 +104857,7 @@ declare namespace Word {
|
|
|
104958
104857
|
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
104959
104858
|
*
|
|
104960
104859
|
* @remarks
|
|
104961
|
-
* [Api set:
|
|
104962
|
-
* @beta
|
|
104860
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104963
104861
|
*/
|
|
104964
104862
|
class ShapeGroup extends OfficeExtension.ClientObject {
|
|
104965
104863
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -104968,24 +104866,21 @@ declare namespace Word {
|
|
|
104968
104866
|
* Gets the Shape object associated with the group.
|
|
104969
104867
|
*
|
|
104970
104868
|
* @remarks
|
|
104971
|
-
* [Api set:
|
|
104972
|
-
* @beta
|
|
104869
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104973
104870
|
*/
|
|
104974
104871
|
readonly shape: Word.Shape;
|
|
104975
104872
|
/**
|
|
104976
104873
|
* Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
|
|
104977
104874
|
*
|
|
104978
104875
|
* @remarks
|
|
104979
|
-
* [Api set:
|
|
104980
|
-
* @beta
|
|
104876
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104981
104877
|
*/
|
|
104982
104878
|
readonly shapes: Word.ShapeCollection;
|
|
104983
104879
|
/**
|
|
104984
104880
|
* Gets an integer that represents the shape group identifier.
|
|
104985
104881
|
*
|
|
104986
104882
|
* @remarks
|
|
104987
|
-
* [Api set:
|
|
104988
|
-
* @beta
|
|
104883
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104989
104884
|
*/
|
|
104990
104885
|
readonly id: number;
|
|
104991
104886
|
/**
|
|
@@ -105000,8 +104895,7 @@ declare namespace Word {
|
|
|
105000
104895
|
* Ungroups any grouped shapes in the specified shape group.
|
|
105001
104896
|
*
|
|
105002
104897
|
* @remarks
|
|
105003
|
-
* [Api set:
|
|
105004
|
-
* @beta
|
|
104898
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105005
104899
|
*/
|
|
105006
104900
|
ungroup(): Word.ShapeCollection;
|
|
105007
104901
|
/**
|
|
@@ -105043,8 +104937,7 @@ declare namespace Word {
|
|
|
105043
104937
|
* Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.
|
|
105044
104938
|
*
|
|
105045
104939
|
* @remarks
|
|
105046
|
-
* [Api set:
|
|
105047
|
-
* @beta
|
|
104940
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105048
104941
|
*/
|
|
105049
104942
|
class Canvas extends OfficeExtension.ClientObject {
|
|
105050
104943
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105053,24 +104946,21 @@ declare namespace Word {
|
|
|
105053
104946
|
* Gets the Shape object associated with the canvas.
|
|
105054
104947
|
*
|
|
105055
104948
|
* @remarks
|
|
105056
|
-
* [Api set:
|
|
105057
|
-
* @beta
|
|
104949
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105058
104950
|
*/
|
|
105059
104951
|
readonly shape: Word.Shape;
|
|
105060
104952
|
/**
|
|
105061
104953
|
* Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
|
|
105062
104954
|
*
|
|
105063
104955
|
* @remarks
|
|
105064
|
-
* [Api set:
|
|
105065
|
-
* @beta
|
|
104956
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105066
104957
|
*/
|
|
105067
104958
|
readonly shapes: Word.ShapeCollection;
|
|
105068
104959
|
/**
|
|
105069
104960
|
* Gets an integer that represents the canvas identifier.
|
|
105070
104961
|
*
|
|
105071
104962
|
* @remarks
|
|
105072
|
-
* [Api set:
|
|
105073
|
-
* @beta
|
|
104963
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105074
104964
|
*/
|
|
105075
104965
|
readonly id: number;
|
|
105076
104966
|
/**
|
|
@@ -105120,8 +105010,7 @@ declare namespace Word {
|
|
|
105120
105010
|
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
105121
105011
|
*
|
|
105122
105012
|
* @remarks
|
|
105123
|
-
* [Api set:
|
|
105124
|
-
* @beta
|
|
105013
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105125
105014
|
*/
|
|
105126
105015
|
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
105127
105016
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105132,8 +105021,7 @@ declare namespace Word {
|
|
|
105132
105021
|
* Gets the shapes that have the specified geometric types. Only applied to geometric shapes.
|
|
105133
105022
|
*
|
|
105134
105023
|
* @remarks
|
|
105135
|
-
* [Api set:
|
|
105136
|
-
* @beta
|
|
105024
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105137
105025
|
*
|
|
105138
105026
|
* @param types Required. An array of geometric shape subtypes.
|
|
105139
105027
|
*/
|
|
@@ -105142,8 +105030,7 @@ declare namespace Word {
|
|
|
105142
105030
|
* Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection.
|
|
105143
105031
|
*
|
|
105144
105032
|
* @remarks
|
|
105145
|
-
* [Api set:
|
|
105146
|
-
* @beta
|
|
105033
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105147
105034
|
*
|
|
105148
105035
|
* @param id Required. A shape identifier.
|
|
105149
105036
|
*/
|
|
@@ -105152,8 +105039,7 @@ declare namespace Word {
|
|
|
105152
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}.
|
|
105153
105040
|
*
|
|
105154
105041
|
* @remarks
|
|
105155
|
-
* [Api set:
|
|
105156
|
-
* @beta
|
|
105042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105157
105043
|
*
|
|
105158
105044
|
* @param id Required. A shape identifier.
|
|
105159
105045
|
*/
|
|
@@ -105162,8 +105048,7 @@ declare namespace Word {
|
|
|
105162
105048
|
* Gets the shapes by the identifiers.
|
|
105163
105049
|
*
|
|
105164
105050
|
* @remarks
|
|
105165
|
-
* [Api set:
|
|
105166
|
-
* @beta
|
|
105051
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105167
105052
|
*
|
|
105168
105053
|
* @param ids Required. An array of shape identifiers.
|
|
105169
105054
|
*/
|
|
@@ -105172,8 +105057,7 @@ declare namespace Word {
|
|
|
105172
105057
|
* Gets the shapes that have the specified names.
|
|
105173
105058
|
*
|
|
105174
105059
|
* @remarks
|
|
105175
|
-
* [Api set:
|
|
105176
|
-
* @beta
|
|
105060
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105177
105061
|
*
|
|
105178
105062
|
* @param names Required. An array of shape names.
|
|
105179
105063
|
*/
|
|
@@ -105182,8 +105066,7 @@ declare namespace Word {
|
|
|
105182
105066
|
* Gets the shapes that have the specified types.
|
|
105183
105067
|
*
|
|
105184
105068
|
* @remarks
|
|
105185
|
-
* [Api set:
|
|
105186
|
-
* @beta
|
|
105069
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105187
105070
|
*
|
|
105188
105071
|
* @param types Required. An array of shape types.
|
|
105189
105072
|
*/
|
|
@@ -105192,24 +105075,21 @@ declare namespace Word {
|
|
|
105192
105075
|
* Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
105193
105076
|
*
|
|
105194
105077
|
* @remarks
|
|
105195
|
-
* [Api set:
|
|
105196
|
-
* @beta
|
|
105078
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105197
105079
|
*/
|
|
105198
105080
|
getFirst(): Word.Shape;
|
|
105199
105081
|
/**
|
|
105200
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}.
|
|
105201
105083
|
*
|
|
105202
105084
|
* @remarks
|
|
105203
|
-
* [Api set:
|
|
105204
|
-
* @beta
|
|
105085
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105205
105086
|
*/
|
|
105206
105087
|
getFirstOrNullObject(): Word.Shape;
|
|
105207
105088
|
/**
|
|
105208
105089
|
* Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.
|
|
105209
105090
|
*
|
|
105210
105091
|
* @remarks
|
|
105211
|
-
* [Api set:
|
|
105212
|
-
* @beta
|
|
105092
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105213
105093
|
*/
|
|
105214
105094
|
group(): Word.Shape;
|
|
105215
105095
|
/**
|
|
@@ -105248,8 +105128,7 @@ declare namespace Word {
|
|
|
105248
105128
|
* Represents the fill formatting of a shape object.
|
|
105249
105129
|
*
|
|
105250
105130
|
* @remarks
|
|
105251
|
-
* [Api set:
|
|
105252
|
-
* @beta
|
|
105131
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105253
105132
|
*/
|
|
105254
105133
|
class ShapeFill extends OfficeExtension.ClientObject {
|
|
105255
105134
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105258,32 +105137,28 @@ declare namespace Word {
|
|
|
105258
105137
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105259
105138
|
*
|
|
105260
105139
|
* @remarks
|
|
105261
|
-
* [Api set:
|
|
105262
|
-
* @beta
|
|
105140
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105263
105141
|
*/
|
|
105264
105142
|
backgroundColor: string;
|
|
105265
105143
|
/**
|
|
105266
105144
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105267
105145
|
*
|
|
105268
105146
|
* @remarks
|
|
105269
|
-
* [Api set:
|
|
105270
|
-
* @beta
|
|
105147
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105271
105148
|
*/
|
|
105272
105149
|
foregroundColor: string;
|
|
105273
105150
|
/**
|
|
105274
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.
|
|
105275
105152
|
*
|
|
105276
105153
|
* @remarks
|
|
105277
|
-
* [Api set:
|
|
105278
|
-
* @beta
|
|
105154
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105279
105155
|
*/
|
|
105280
105156
|
transparency: number;
|
|
105281
105157
|
/**
|
|
105282
105158
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
105283
105159
|
*
|
|
105284
105160
|
* @remarks
|
|
105285
|
-
* [Api set:
|
|
105286
|
-
* @beta
|
|
105161
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105287
105162
|
*/
|
|
105288
105163
|
readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";
|
|
105289
105164
|
/**
|
|
@@ -105298,16 +105173,14 @@ declare namespace Word {
|
|
|
105298
105173
|
* Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;
|
|
105299
105174
|
*
|
|
105300
105175
|
* @remarks
|
|
105301
|
-
* [Api set:
|
|
105302
|
-
* @beta
|
|
105176
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105303
105177
|
*/
|
|
105304
105178
|
clear(): void;
|
|
105305
105179
|
/**
|
|
105306
105180
|
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`.
|
|
105307
105181
|
*
|
|
105308
105182
|
* @remarks
|
|
105309
|
-
* [Api set:
|
|
105310
|
-
* @beta
|
|
105183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105311
105184
|
*
|
|
105312
105185
|
* @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
105313
105186
|
*/
|
|
@@ -105351,8 +105224,7 @@ declare namespace Word {
|
|
|
105351
105224
|
* Represents the text frame of a shape object.
|
|
105352
105225
|
*
|
|
105353
105226
|
* @remarks
|
|
105354
|
-
* [Api set:
|
|
105355
|
-
* @beta
|
|
105227
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105356
105228
|
*/
|
|
105357
105229
|
class TextFrame extends OfficeExtension.ClientObject {
|
|
105358
105230
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105361,80 +105233,70 @@ declare namespace Word {
|
|
|
105361
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.
|
|
105362
105234
|
*
|
|
105363
105235
|
* @remarks
|
|
105364
|
-
* [Api set:
|
|
105365
|
-
* @beta
|
|
105236
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105366
105237
|
*/
|
|
105367
105238
|
autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
105368
105239
|
/**
|
|
105369
105240
|
* Represents the bottom margin, in points, of the text frame.
|
|
105370
105241
|
*
|
|
105371
105242
|
* @remarks
|
|
105372
|
-
* [Api set:
|
|
105373
|
-
* @beta
|
|
105243
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105374
105244
|
*/
|
|
105375
105245
|
bottomMargin: number;
|
|
105376
105246
|
/**
|
|
105377
105247
|
* Specifies if the text frame contains text.
|
|
105378
105248
|
*
|
|
105379
105249
|
* @remarks
|
|
105380
|
-
* [Api set:
|
|
105381
|
-
* @beta
|
|
105250
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105382
105251
|
*/
|
|
105383
105252
|
readonly hasText: boolean;
|
|
105384
105253
|
/**
|
|
105385
105254
|
* Represents the left margin, in points, of the text frame.
|
|
105386
105255
|
*
|
|
105387
105256
|
* @remarks
|
|
105388
|
-
* [Api set:
|
|
105389
|
-
* @beta
|
|
105257
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105390
105258
|
*/
|
|
105391
105259
|
leftMargin: number;
|
|
105392
105260
|
/**
|
|
105393
105261
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
105394
105262
|
*
|
|
105395
105263
|
* @remarks
|
|
105396
|
-
* [Api set:
|
|
105397
|
-
* @beta
|
|
105264
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105398
105265
|
*/
|
|
105399
105266
|
noTextRotation: boolean;
|
|
105400
105267
|
/**
|
|
105401
105268
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
105402
105269
|
*
|
|
105403
105270
|
* @remarks
|
|
105404
|
-
* [Api set:
|
|
105405
|
-
* @beta
|
|
105271
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105406
105272
|
*/
|
|
105407
105273
|
orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
105408
105274
|
/**
|
|
105409
105275
|
* Represents the right margin, in points, of the text frame.
|
|
105410
105276
|
*
|
|
105411
105277
|
* @remarks
|
|
105412
|
-
* [Api set:
|
|
105413
|
-
* @beta
|
|
105278
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105414
105279
|
*/
|
|
105415
105280
|
rightMargin: number;
|
|
105416
105281
|
/**
|
|
105417
105282
|
* Represents the top margin, in points, of the text frame.
|
|
105418
105283
|
*
|
|
105419
105284
|
* @remarks
|
|
105420
|
-
* [Api set:
|
|
105421
|
-
* @beta
|
|
105285
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105422
105286
|
*/
|
|
105423
105287
|
topMargin: number;
|
|
105424
105288
|
/**
|
|
105425
105289
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
105426
105290
|
*
|
|
105427
105291
|
* @remarks
|
|
105428
|
-
* [Api set:
|
|
105429
|
-
* @beta
|
|
105292
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105430
105293
|
*/
|
|
105431
105294
|
verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
105432
105295
|
/**
|
|
105433
105296
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
105434
105297
|
*
|
|
105435
105298
|
* @remarks
|
|
105436
|
-
* [Api set:
|
|
105437
|
-
* @beta
|
|
105299
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105438
105300
|
*/
|
|
105439
105301
|
wordWrap: boolean;
|
|
105440
105302
|
/**
|
|
@@ -105484,8 +105346,7 @@ declare namespace Word {
|
|
|
105484
105346
|
* Represents all the properties for wrapping text around a shape.
|
|
105485
105347
|
*
|
|
105486
105348
|
* @remarks
|
|
105487
|
-
* [Api set:
|
|
105488
|
-
* @beta
|
|
105349
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105489
105350
|
*/
|
|
105490
105351
|
class ShapeTextWrap extends OfficeExtension.ClientObject {
|
|
105491
105352
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -105494,48 +105355,42 @@ declare namespace Word {
|
|
|
105494
105355
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
105495
105356
|
*
|
|
105496
105357
|
* @remarks
|
|
105497
|
-
* [Api set:
|
|
105498
|
-
* @beta
|
|
105358
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105499
105359
|
*/
|
|
105500
105360
|
bottomDistance: number;
|
|
105501
105361
|
/**
|
|
105502
105362
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
105503
105363
|
*
|
|
105504
105364
|
* @remarks
|
|
105505
|
-
* [Api set:
|
|
105506
|
-
* @beta
|
|
105365
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105507
105366
|
*/
|
|
105508
105367
|
leftDistance: number;
|
|
105509
105368
|
/**
|
|
105510
105369
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
105511
105370
|
*
|
|
105512
105371
|
* @remarks
|
|
105513
|
-
* [Api set:
|
|
105514
|
-
* @beta
|
|
105372
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105515
105373
|
*/
|
|
105516
105374
|
rightDistance: number;
|
|
105517
105375
|
/**
|
|
105518
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.
|
|
105519
105377
|
*
|
|
105520
105378
|
* @remarks
|
|
105521
|
-
* [Api set:
|
|
105522
|
-
* @beta
|
|
105379
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105523
105380
|
*/
|
|
105524
105381
|
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
105525
105382
|
/**
|
|
105526
105383
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
105527
105384
|
*
|
|
105528
105385
|
* @remarks
|
|
105529
|
-
* [Api set:
|
|
105530
|
-
* @beta
|
|
105386
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105531
105387
|
*/
|
|
105532
105388
|
topDistance: number;
|
|
105533
105389
|
/**
|
|
105534
105390
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
105535
105391
|
*
|
|
105536
105392
|
* @remarks
|
|
105537
|
-
* [Api set:
|
|
105538
|
-
* @beta
|
|
105393
|
+
* [Api set: WordApiDesktop 1.2]
|
|
105539
105394
|
*/
|
|
105540
105395
|
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
105541
105396
|
/**
|
|
@@ -109564,50 +109419,43 @@ declare namespace Word {
|
|
|
109564
109419
|
* Represents the shape type.
|
|
109565
109420
|
*
|
|
109566
109421
|
* @remarks
|
|
109567
|
-
* [Api set:
|
|
109568
|
-
* @beta
|
|
109422
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109569
109423
|
*/
|
|
109570
109424
|
enum ShapeType {
|
|
109571
109425
|
/**
|
|
109572
109426
|
* Unsupported shape type.
|
|
109573
109427
|
* @remarks
|
|
109574
|
-
* [Api set:
|
|
109575
|
-
* @beta
|
|
109428
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109576
109429
|
*/
|
|
109577
109430
|
unsupported = "Unsupported",
|
|
109578
109431
|
/**
|
|
109579
109432
|
* Text box shape.
|
|
109580
109433
|
* @remarks
|
|
109581
|
-
* [Api set:
|
|
109582
|
-
* @beta
|
|
109434
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109583
109435
|
*/
|
|
109584
109436
|
textBox = "TextBox",
|
|
109585
109437
|
/**
|
|
109586
109438
|
* Geometric shape.
|
|
109587
109439
|
* @remarks
|
|
109588
|
-
* [Api set:
|
|
109589
|
-
* @beta
|
|
109440
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109590
109441
|
*/
|
|
109591
109442
|
geometricShape = "GeometricShape",
|
|
109592
109443
|
/**
|
|
109593
109444
|
* Group shape.
|
|
109594
109445
|
* @remarks
|
|
109595
|
-
* [Api set:
|
|
109596
|
-
* @beta
|
|
109446
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109597
109447
|
*/
|
|
109598
109448
|
group = "Group",
|
|
109599
109449
|
/**
|
|
109600
109450
|
* Picture shape.
|
|
109601
109451
|
* @remarks
|
|
109602
|
-
* [Api set:
|
|
109603
|
-
* @beta
|
|
109452
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109604
109453
|
*/
|
|
109605
109454
|
picture = "Picture",
|
|
109606
109455
|
/**
|
|
109607
109456
|
* Canvas shape.
|
|
109608
109457
|
* @remarks
|
|
109609
|
-
* [Api set:
|
|
109610
|
-
* @beta
|
|
109458
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109611
109459
|
*/
|
|
109612
109460
|
canvas = "Canvas",
|
|
109613
109461
|
}
|
|
@@ -109616,64 +109464,55 @@ declare namespace Word {
|
|
|
109616
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}.
|
|
109617
109465
|
*
|
|
109618
109466
|
* @remarks
|
|
109619
|
-
* [Api set:
|
|
109620
|
-
* @beta
|
|
109467
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109621
109468
|
*/
|
|
109622
109469
|
enum RelativeHorizontalPosition {
|
|
109623
109470
|
/**
|
|
109624
109471
|
* Relative to margin.
|
|
109625
109472
|
* @remarks
|
|
109626
|
-
* [Api set:
|
|
109627
|
-
* @beta
|
|
109473
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109628
109474
|
*/
|
|
109629
109475
|
margin = "Margin",
|
|
109630
109476
|
/**
|
|
109631
109477
|
* Relative to page.
|
|
109632
109478
|
* @remarks
|
|
109633
|
-
* [Api set:
|
|
109634
|
-
* @beta
|
|
109479
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109635
109480
|
*/
|
|
109636
109481
|
page = "Page",
|
|
109637
109482
|
/**
|
|
109638
109483
|
* Relative to column.
|
|
109639
109484
|
* @remarks
|
|
109640
|
-
* [Api set:
|
|
109641
|
-
* @beta
|
|
109485
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109642
109486
|
*/
|
|
109643
109487
|
column = "Column",
|
|
109644
109488
|
/**
|
|
109645
109489
|
* Relative to character.
|
|
109646
109490
|
* @remarks
|
|
109647
|
-
* [Api set:
|
|
109648
|
-
* @beta
|
|
109491
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109649
109492
|
*/
|
|
109650
109493
|
character = "Character",
|
|
109651
109494
|
/**
|
|
109652
109495
|
* Relative to left margin.
|
|
109653
109496
|
* @remarks
|
|
109654
|
-
* [Api set:
|
|
109655
|
-
* @beta
|
|
109497
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109656
109498
|
*/
|
|
109657
109499
|
leftMargin = "LeftMargin",
|
|
109658
109500
|
/**
|
|
109659
109501
|
* Relative to right margin.
|
|
109660
109502
|
* @remarks
|
|
109661
|
-
* [Api set:
|
|
109662
|
-
* @beta
|
|
109503
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109663
109504
|
*/
|
|
109664
109505
|
rightMargin = "RightMargin",
|
|
109665
109506
|
/**
|
|
109666
109507
|
* Relative to inside margin.
|
|
109667
109508
|
* @remarks
|
|
109668
|
-
* [Api set:
|
|
109669
|
-
* @beta
|
|
109509
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109670
109510
|
*/
|
|
109671
109511
|
insideMargin = "InsideMargin",
|
|
109672
109512
|
/**
|
|
109673
109513
|
* Relative to outside margin.
|
|
109674
109514
|
* @remarks
|
|
109675
|
-
* [Api set:
|
|
109676
|
-
* @beta
|
|
109515
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109677
109516
|
*/
|
|
109678
109517
|
outsideMargin = "OutsideMargin",
|
|
109679
109518
|
}
|
|
@@ -109682,64 +109521,55 @@ declare namespace Word {
|
|
|
109682
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}.
|
|
109683
109522
|
*
|
|
109684
109523
|
* @remarks
|
|
109685
|
-
* [Api set:
|
|
109686
|
-
* @beta
|
|
109524
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109687
109525
|
*/
|
|
109688
109526
|
enum RelativeVerticalPosition {
|
|
109689
109527
|
/**
|
|
109690
109528
|
* Relative to margin.
|
|
109691
109529
|
* @remarks
|
|
109692
|
-
* [Api set:
|
|
109693
|
-
* @beta
|
|
109530
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109694
109531
|
*/
|
|
109695
109532
|
margin = "Margin",
|
|
109696
109533
|
/**
|
|
109697
109534
|
* Relative to page.
|
|
109698
109535
|
* @remarks
|
|
109699
|
-
* [Api set:
|
|
109700
|
-
* @beta
|
|
109536
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109701
109537
|
*/
|
|
109702
109538
|
page = "Page",
|
|
109703
109539
|
/**
|
|
109704
109540
|
* Relative to paragraph.
|
|
109705
109541
|
* @remarks
|
|
109706
|
-
* [Api set:
|
|
109707
|
-
* @beta
|
|
109542
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109708
109543
|
*/
|
|
109709
109544
|
paragraph = "Paragraph",
|
|
109710
109545
|
/**
|
|
109711
109546
|
* Relative to line.
|
|
109712
109547
|
* @remarks
|
|
109713
|
-
* [Api set:
|
|
109714
|
-
* @beta
|
|
109548
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109715
109549
|
*/
|
|
109716
109550
|
line = "Line",
|
|
109717
109551
|
/**
|
|
109718
109552
|
* Relative to top margin.
|
|
109719
109553
|
* @remarks
|
|
109720
|
-
* [Api set:
|
|
109721
|
-
* @beta
|
|
109554
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109722
109555
|
*/
|
|
109723
109556
|
topMargin = "TopMargin",
|
|
109724
109557
|
/**
|
|
109725
109558
|
* Relative to bottom margin.
|
|
109726
109559
|
* @remarks
|
|
109727
|
-
* [Api set:
|
|
109728
|
-
* @beta
|
|
109560
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109729
109561
|
*/
|
|
109730
109562
|
bottomMargin = "BottomMargin",
|
|
109731
109563
|
/**
|
|
109732
109564
|
* Relative to inside margin.
|
|
109733
109565
|
* @remarks
|
|
109734
|
-
* [Api set:
|
|
109735
|
-
* @beta
|
|
109566
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109736
109567
|
*/
|
|
109737
109568
|
insideMargin = "InsideMargin",
|
|
109738
109569
|
/**
|
|
109739
109570
|
* Relative to outside margin.
|
|
109740
109571
|
* @remarks
|
|
109741
|
-
* [Api set:
|
|
109742
|
-
* @beta
|
|
109572
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109743
109573
|
*/
|
|
109744
109574
|
outsideMargin = "OutsideMargin",
|
|
109745
109575
|
}
|
|
@@ -109747,1247 +109577,1069 @@ declare namespace Word {
|
|
|
109747
109577
|
* Specifies the shape type for a `GeometricShape` object.
|
|
109748
109578
|
*
|
|
109749
109579
|
* @remarks
|
|
109750
|
-
* [Api set:
|
|
109751
|
-
* @beta
|
|
109580
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109752
109581
|
*/
|
|
109753
109582
|
enum GeometricShapeType {
|
|
109754
109583
|
/**
|
|
109755
109584
|
* Line inverse geometric shape.
|
|
109756
109585
|
* @remarks
|
|
109757
|
-
* [Api set:
|
|
109758
|
-
* @beta
|
|
109586
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109759
109587
|
*/
|
|
109760
109588
|
lineInverse = "LineInverse",
|
|
109761
109589
|
/**
|
|
109762
109590
|
* Triangle geometric shape.
|
|
109763
109591
|
* @remarks
|
|
109764
|
-
* [Api set:
|
|
109765
|
-
* @beta
|
|
109592
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109766
109593
|
*/
|
|
109767
109594
|
triangle = "Triangle",
|
|
109768
109595
|
/**
|
|
109769
109596
|
* Right triangle geometric shape.
|
|
109770
109597
|
* @remarks
|
|
109771
|
-
* [Api set:
|
|
109772
|
-
* @beta
|
|
109598
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109773
109599
|
*/
|
|
109774
109600
|
rightTriangle = "RightTriangle",
|
|
109775
109601
|
/**
|
|
109776
109602
|
* Rectangle geometric shape.
|
|
109777
109603
|
* @remarks
|
|
109778
|
-
* [Api set:
|
|
109779
|
-
* @beta
|
|
109604
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109780
109605
|
*/
|
|
109781
109606
|
rectangle = "Rectangle",
|
|
109782
109607
|
/**
|
|
109783
109608
|
* Diamond geometric shape.
|
|
109784
109609
|
* @remarks
|
|
109785
|
-
* [Api set:
|
|
109786
|
-
* @beta
|
|
109610
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109787
109611
|
*/
|
|
109788
109612
|
diamond = "Diamond",
|
|
109789
109613
|
/**
|
|
109790
109614
|
* Parallelogram geometric shape.
|
|
109791
109615
|
* @remarks
|
|
109792
|
-
* [Api set:
|
|
109793
|
-
* @beta
|
|
109616
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109794
109617
|
*/
|
|
109795
109618
|
parallelogram = "Parallelogram",
|
|
109796
109619
|
/**
|
|
109797
109620
|
* Trapezoid geometric shape.
|
|
109798
109621
|
* @remarks
|
|
109799
|
-
* [Api set:
|
|
109800
|
-
* @beta
|
|
109622
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109801
109623
|
*/
|
|
109802
109624
|
trapezoid = "Trapezoid",
|
|
109803
109625
|
/**
|
|
109804
109626
|
* Non-isosceles trapezoid geometric shape.
|
|
109805
109627
|
* @remarks
|
|
109806
|
-
* [Api set:
|
|
109807
|
-
* @beta
|
|
109628
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109808
109629
|
*/
|
|
109809
109630
|
nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
|
|
109810
109631
|
/**
|
|
109811
109632
|
* Pentagon geometric shape.
|
|
109812
109633
|
* @remarks
|
|
109813
|
-
* [Api set:
|
|
109814
|
-
* @beta
|
|
109634
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109815
109635
|
*/
|
|
109816
109636
|
pentagon = "Pentagon",
|
|
109817
109637
|
/**
|
|
109818
109638
|
* Hexagon geometric shape.
|
|
109819
109639
|
* @remarks
|
|
109820
|
-
* [Api set:
|
|
109821
|
-
* @beta
|
|
109640
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109822
109641
|
*/
|
|
109823
109642
|
hexagon = "Hexagon",
|
|
109824
109643
|
/**
|
|
109825
109644
|
* Heptagon geometric shape.
|
|
109826
109645
|
* @remarks
|
|
109827
|
-
* [Api set:
|
|
109828
|
-
* @beta
|
|
109646
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109829
109647
|
*/
|
|
109830
109648
|
heptagon = "Heptagon",
|
|
109831
109649
|
/**
|
|
109832
109650
|
* Octagon geometric shape.
|
|
109833
109651
|
* @remarks
|
|
109834
|
-
* [Api set:
|
|
109835
|
-
* @beta
|
|
109652
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109836
109653
|
*/
|
|
109837
109654
|
octagon = "Octagon",
|
|
109838
109655
|
/**
|
|
109839
109656
|
* Decagon geometric shape.
|
|
109840
109657
|
* @remarks
|
|
109841
|
-
* [Api set:
|
|
109842
|
-
* @beta
|
|
109658
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109843
109659
|
*/
|
|
109844
109660
|
decagon = "Decagon",
|
|
109845
109661
|
/**
|
|
109846
109662
|
* Dodecagon geometric shape.
|
|
109847
109663
|
* @remarks
|
|
109848
|
-
* [Api set:
|
|
109849
|
-
* @beta
|
|
109664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109850
109665
|
*/
|
|
109851
109666
|
dodecagon = "Dodecagon",
|
|
109852
109667
|
/**
|
|
109853
109668
|
* Star 4-point geometric shape.
|
|
109854
109669
|
* @remarks
|
|
109855
|
-
* [Api set:
|
|
109856
|
-
* @beta
|
|
109670
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109857
109671
|
*/
|
|
109858
109672
|
star4 = "Star4",
|
|
109859
109673
|
/**
|
|
109860
109674
|
* Star 5-point geometric shape.
|
|
109861
109675
|
* @remarks
|
|
109862
|
-
* [Api set:
|
|
109863
|
-
* @beta
|
|
109676
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109864
109677
|
*/
|
|
109865
109678
|
star5 = "Star5",
|
|
109866
109679
|
/**
|
|
109867
109680
|
* Star 6-point geometric shape.
|
|
109868
109681
|
* @remarks
|
|
109869
|
-
* [Api set:
|
|
109870
|
-
* @beta
|
|
109682
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109871
109683
|
*/
|
|
109872
109684
|
star6 = "Star6",
|
|
109873
109685
|
/**
|
|
109874
109686
|
* Star 7-point geometric shape.
|
|
109875
109687
|
* @remarks
|
|
109876
|
-
* [Api set:
|
|
109877
|
-
* @beta
|
|
109688
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109878
109689
|
*/
|
|
109879
109690
|
star7 = "Star7",
|
|
109880
109691
|
/**
|
|
109881
109692
|
* Star 8-point geometric shape.
|
|
109882
109693
|
* @remarks
|
|
109883
|
-
* [Api set:
|
|
109884
|
-
* @beta
|
|
109694
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109885
109695
|
*/
|
|
109886
109696
|
star8 = "Star8",
|
|
109887
109697
|
/**
|
|
109888
109698
|
* Star 10-point geometric shape.
|
|
109889
109699
|
* @remarks
|
|
109890
|
-
* [Api set:
|
|
109891
|
-
* @beta
|
|
109700
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109892
109701
|
*/
|
|
109893
109702
|
star10 = "Star10",
|
|
109894
109703
|
/**
|
|
109895
109704
|
* Star 12-point geometric shape.
|
|
109896
109705
|
* @remarks
|
|
109897
|
-
* [Api set:
|
|
109898
|
-
* @beta
|
|
109706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109899
109707
|
*/
|
|
109900
109708
|
star12 = "Star12",
|
|
109901
109709
|
/**
|
|
109902
109710
|
* Star 16-point geometric shape.
|
|
109903
109711
|
* @remarks
|
|
109904
|
-
* [Api set:
|
|
109905
|
-
* @beta
|
|
109712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109906
109713
|
*/
|
|
109907
109714
|
star16 = "Star16",
|
|
109908
109715
|
/**
|
|
109909
109716
|
* Star 24-point geometric shape.
|
|
109910
109717
|
* @remarks
|
|
109911
|
-
* [Api set:
|
|
109912
|
-
* @beta
|
|
109718
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109913
109719
|
*/
|
|
109914
109720
|
star24 = "Star24",
|
|
109915
109721
|
/**
|
|
109916
109722
|
* Star 32-point geometric shape.
|
|
109917
109723
|
* @remarks
|
|
109918
|
-
* [Api set:
|
|
109919
|
-
* @beta
|
|
109724
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109920
109725
|
*/
|
|
109921
109726
|
star32 = "Star32",
|
|
109922
109727
|
/**
|
|
109923
109728
|
* Round rectangle geometric shape.
|
|
109924
109729
|
* @remarks
|
|
109925
|
-
* [Api set:
|
|
109926
|
-
* @beta
|
|
109730
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109927
109731
|
*/
|
|
109928
109732
|
roundRectangle = "RoundRectangle",
|
|
109929
109733
|
/**
|
|
109930
109734
|
* Round one rectangle geometric shape.
|
|
109931
109735
|
* @remarks
|
|
109932
|
-
* [Api set:
|
|
109933
|
-
* @beta
|
|
109736
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109934
109737
|
*/
|
|
109935
109738
|
round1Rectangle = "Round1Rectangle",
|
|
109936
109739
|
/**
|
|
109937
109740
|
* Round two same rectangle geometric shape.
|
|
109938
109741
|
* @remarks
|
|
109939
|
-
* [Api set:
|
|
109940
|
-
* @beta
|
|
109742
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109941
109743
|
*/
|
|
109942
109744
|
round2SameRectangle = "Round2SameRectangle",
|
|
109943
109745
|
/**
|
|
109944
109746
|
* Round two diagonal rectangle geometric shape.
|
|
109945
109747
|
* @remarks
|
|
109946
|
-
* [Api set:
|
|
109947
|
-
* @beta
|
|
109748
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109948
109749
|
*/
|
|
109949
109750
|
round2DiagonalRectangle = "Round2DiagonalRectangle",
|
|
109950
109751
|
/**
|
|
109951
109752
|
* Snip round rectangle geometric shape.
|
|
109952
109753
|
* @remarks
|
|
109953
|
-
* [Api set:
|
|
109954
|
-
* @beta
|
|
109754
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109955
109755
|
*/
|
|
109956
109756
|
snipRoundRectangle = "SnipRoundRectangle",
|
|
109957
109757
|
/**
|
|
109958
109758
|
* Snip one rectangle geometric shape.
|
|
109959
109759
|
* @remarks
|
|
109960
|
-
* [Api set:
|
|
109961
|
-
* @beta
|
|
109760
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109962
109761
|
*/
|
|
109963
109762
|
snip1Rectangle = "Snip1Rectangle",
|
|
109964
109763
|
/**
|
|
109965
109764
|
* Snip two same rectangle geometric shape.
|
|
109966
109765
|
* @remarks
|
|
109967
|
-
* [Api set:
|
|
109968
|
-
* @beta
|
|
109766
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109969
109767
|
*/
|
|
109970
109768
|
snip2SameRectangle = "Snip2SameRectangle",
|
|
109971
109769
|
/**
|
|
109972
109770
|
* Snip two diagonal rectangle geometric shape.
|
|
109973
109771
|
* @remarks
|
|
109974
|
-
* [Api set:
|
|
109975
|
-
* @beta
|
|
109772
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109976
109773
|
*/
|
|
109977
109774
|
snip2DiagonalRectangle = "Snip2DiagonalRectangle",
|
|
109978
109775
|
/**
|
|
109979
109776
|
* Plaque geometric shape.
|
|
109980
109777
|
* @remarks
|
|
109981
|
-
* [Api set:
|
|
109982
|
-
* @beta
|
|
109778
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109983
109779
|
*/
|
|
109984
109780
|
plaque = "Plaque",
|
|
109985
109781
|
/**
|
|
109986
109782
|
* Ellipse geometric shape.
|
|
109987
109783
|
* @remarks
|
|
109988
|
-
* [Api set:
|
|
109989
|
-
* @beta
|
|
109784
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109990
109785
|
*/
|
|
109991
109786
|
ellipse = "Ellipse",
|
|
109992
109787
|
/**
|
|
109993
109788
|
* Teardrop geometric shape.
|
|
109994
109789
|
* @remarks
|
|
109995
|
-
* [Api set:
|
|
109996
|
-
* @beta
|
|
109790
|
+
* [Api set: WordApiDesktop 1.2]
|
|
109997
109791
|
*/
|
|
109998
109792
|
teardrop = "Teardrop",
|
|
109999
109793
|
/**
|
|
110000
109794
|
* Home plate geometric shape.
|
|
110001
109795
|
* @remarks
|
|
110002
|
-
* [Api set:
|
|
110003
|
-
* @beta
|
|
109796
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110004
109797
|
*/
|
|
110005
109798
|
homePlate = "HomePlate",
|
|
110006
109799
|
/**
|
|
110007
109800
|
* Chevron geometric shape.
|
|
110008
109801
|
* @remarks
|
|
110009
|
-
* [Api set:
|
|
110010
|
-
* @beta
|
|
109802
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110011
109803
|
*/
|
|
110012
109804
|
chevron = "Chevron",
|
|
110013
109805
|
/**
|
|
110014
109806
|
* Pie wedge geometric shape.
|
|
110015
109807
|
* @remarks
|
|
110016
|
-
* [Api set:
|
|
110017
|
-
* @beta
|
|
109808
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110018
109809
|
*/
|
|
110019
109810
|
pieWedge = "PieWedge",
|
|
110020
109811
|
/**
|
|
110021
109812
|
* Pie geometric shape.
|
|
110022
109813
|
* @remarks
|
|
110023
|
-
* [Api set:
|
|
110024
|
-
* @beta
|
|
109814
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110025
109815
|
*/
|
|
110026
109816
|
pie = "Pie",
|
|
110027
109817
|
/**
|
|
110028
109818
|
* Block arc geometric shape.
|
|
110029
109819
|
* @remarks
|
|
110030
|
-
* [Api set:
|
|
110031
|
-
* @beta
|
|
109820
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110032
109821
|
*/
|
|
110033
109822
|
blockArc = "BlockArc",
|
|
110034
109823
|
/**
|
|
110035
109824
|
* Donut geometric shape.
|
|
110036
109825
|
* @remarks
|
|
110037
|
-
* [Api set:
|
|
110038
|
-
* @beta
|
|
109826
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110039
109827
|
*/
|
|
110040
109828
|
donut = "Donut",
|
|
110041
109829
|
/**
|
|
110042
109830
|
* No smoking geometric shape.
|
|
110043
109831
|
* @remarks
|
|
110044
|
-
* [Api set:
|
|
110045
|
-
* @beta
|
|
109832
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110046
109833
|
*/
|
|
110047
109834
|
noSmoking = "NoSmoking",
|
|
110048
109835
|
/**
|
|
110049
109836
|
* Right arrow geometric shape.
|
|
110050
109837
|
* @remarks
|
|
110051
|
-
* [Api set:
|
|
110052
|
-
* @beta
|
|
109838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110053
109839
|
*/
|
|
110054
109840
|
rightArrow = "RightArrow",
|
|
110055
109841
|
/**
|
|
110056
109842
|
* Left arrow geometric shape.
|
|
110057
109843
|
* @remarks
|
|
110058
|
-
* [Api set:
|
|
110059
|
-
* @beta
|
|
109844
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110060
109845
|
*/
|
|
110061
109846
|
leftArrow = "LeftArrow",
|
|
110062
109847
|
/**
|
|
110063
109848
|
* Up arrow geometric shape.
|
|
110064
109849
|
* @remarks
|
|
110065
|
-
* [Api set:
|
|
110066
|
-
* @beta
|
|
109850
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110067
109851
|
*/
|
|
110068
109852
|
upArrow = "UpArrow",
|
|
110069
109853
|
/**
|
|
110070
109854
|
* Down arrow geometric shape.
|
|
110071
109855
|
* @remarks
|
|
110072
|
-
* [Api set:
|
|
110073
|
-
* @beta
|
|
109856
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110074
109857
|
*/
|
|
110075
109858
|
downArrow = "DownArrow",
|
|
110076
109859
|
/**
|
|
110077
109860
|
* Striped right arrow geometric shape.
|
|
110078
109861
|
* @remarks
|
|
110079
|
-
* [Api set:
|
|
110080
|
-
* @beta
|
|
109862
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110081
109863
|
*/
|
|
110082
109864
|
stripedRightArrow = "StripedRightArrow",
|
|
110083
109865
|
/**
|
|
110084
109866
|
* Notched right arrow geometric shape.
|
|
110085
109867
|
* @remarks
|
|
110086
|
-
* [Api set:
|
|
110087
|
-
* @beta
|
|
109868
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110088
109869
|
*/
|
|
110089
109870
|
notchedRightArrow = "NotchedRightArrow",
|
|
110090
109871
|
/**
|
|
110091
109872
|
* Bent up arrow geometric shape.
|
|
110092
109873
|
* @remarks
|
|
110093
|
-
* [Api set:
|
|
110094
|
-
* @beta
|
|
109874
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110095
109875
|
*/
|
|
110096
109876
|
bentUpArrow = "BentUpArrow",
|
|
110097
109877
|
/**
|
|
110098
109878
|
* Left-right arrow geometric shape.
|
|
110099
109879
|
* @remarks
|
|
110100
|
-
* [Api set:
|
|
110101
|
-
* @beta
|
|
109880
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110102
109881
|
*/
|
|
110103
109882
|
leftRightArrow = "LeftRightArrow",
|
|
110104
109883
|
/**
|
|
110105
109884
|
* Up-down arrow geometric shape.
|
|
110106
109885
|
* @remarks
|
|
110107
|
-
* [Api set:
|
|
110108
|
-
* @beta
|
|
109886
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110109
109887
|
*/
|
|
110110
109888
|
upDownArrow = "UpDownArrow",
|
|
110111
109889
|
/**
|
|
110112
109890
|
* Left-up arrow geometric shape.
|
|
110113
109891
|
* @remarks
|
|
110114
|
-
* [Api set:
|
|
110115
|
-
* @beta
|
|
109892
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110116
109893
|
*/
|
|
110117
109894
|
leftUpArrow = "LeftUpArrow",
|
|
110118
109895
|
/**
|
|
110119
109896
|
* Left-right-up arrow geometric shape.
|
|
110120
109897
|
* @remarks
|
|
110121
|
-
* [Api set:
|
|
110122
|
-
* @beta
|
|
109898
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110123
109899
|
*/
|
|
110124
109900
|
leftRightUpArrow = "LeftRightUpArrow",
|
|
110125
109901
|
/**
|
|
110126
109902
|
* Quad arrow geometric shape.
|
|
110127
109903
|
* @remarks
|
|
110128
|
-
* [Api set:
|
|
110129
|
-
* @beta
|
|
109904
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110130
109905
|
*/
|
|
110131
109906
|
quadArrow = "QuadArrow",
|
|
110132
109907
|
/**
|
|
110133
109908
|
* Left arrow callout geometric shape.
|
|
110134
109909
|
* @remarks
|
|
110135
|
-
* [Api set:
|
|
110136
|
-
* @beta
|
|
109910
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110137
109911
|
*/
|
|
110138
109912
|
leftArrowCallout = "LeftArrowCallout",
|
|
110139
109913
|
/**
|
|
110140
109914
|
* Right arrow callout geometric shape.
|
|
110141
109915
|
* @remarks
|
|
110142
|
-
* [Api set:
|
|
110143
|
-
* @beta
|
|
109916
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110144
109917
|
*/
|
|
110145
109918
|
rightArrowCallout = "RightArrowCallout",
|
|
110146
109919
|
/**
|
|
110147
109920
|
* Up arrow callout geometric shape.
|
|
110148
109921
|
* @remarks
|
|
110149
|
-
* [Api set:
|
|
110150
|
-
* @beta
|
|
109922
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110151
109923
|
*/
|
|
110152
109924
|
upArrowCallout = "UpArrowCallout",
|
|
110153
109925
|
/**
|
|
110154
109926
|
* Down arrow callout geometric shape.
|
|
110155
109927
|
* @remarks
|
|
110156
|
-
* [Api set:
|
|
110157
|
-
* @beta
|
|
109928
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110158
109929
|
*/
|
|
110159
109930
|
downArrowCallout = "DownArrowCallout",
|
|
110160
109931
|
/**
|
|
110161
109932
|
* Left-right arrow callout geometric shape.
|
|
110162
109933
|
* @remarks
|
|
110163
|
-
* [Api set:
|
|
110164
|
-
* @beta
|
|
109934
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110165
109935
|
*/
|
|
110166
109936
|
leftRightArrowCallout = "LeftRightArrowCallout",
|
|
110167
109937
|
/**
|
|
110168
109938
|
* Up-down arrow callout geometric shape.
|
|
110169
109939
|
* @remarks
|
|
110170
|
-
* [Api set:
|
|
110171
|
-
* @beta
|
|
109940
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110172
109941
|
*/
|
|
110173
109942
|
upDownArrowCallout = "UpDownArrowCallout",
|
|
110174
109943
|
/**
|
|
110175
109944
|
* Quad arrow callout geometric shape.
|
|
110176
109945
|
* @remarks
|
|
110177
|
-
* [Api set:
|
|
110178
|
-
* @beta
|
|
109946
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110179
109947
|
*/
|
|
110180
109948
|
quadArrowCallout = "QuadArrowCallout",
|
|
110181
109949
|
/**
|
|
110182
109950
|
* Bent arrow geometric shape.
|
|
110183
109951
|
* @remarks
|
|
110184
|
-
* [Api set:
|
|
110185
|
-
* @beta
|
|
109952
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110186
109953
|
*/
|
|
110187
109954
|
bentArrow = "BentArrow",
|
|
110188
109955
|
/**
|
|
110189
109956
|
* U-turn arrow geometric shape.
|
|
110190
109957
|
* @remarks
|
|
110191
|
-
* [Api set:
|
|
110192
|
-
* @beta
|
|
109958
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110193
109959
|
*/
|
|
110194
109960
|
uturnArrow = "UturnArrow",
|
|
110195
109961
|
/**
|
|
110196
109962
|
* Circular arrow geometric shape.
|
|
110197
109963
|
* @remarks
|
|
110198
|
-
* [Api set:
|
|
110199
|
-
* @beta
|
|
109964
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110200
109965
|
*/
|
|
110201
109966
|
circularArrow = "CircularArrow",
|
|
110202
109967
|
/**
|
|
110203
109968
|
* Left circular arrow geometric shape.
|
|
110204
109969
|
* @remarks
|
|
110205
|
-
* [Api set:
|
|
110206
|
-
* @beta
|
|
109970
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110207
109971
|
*/
|
|
110208
109972
|
leftCircularArrow = "LeftCircularArrow",
|
|
110209
109973
|
/**
|
|
110210
109974
|
* Left-right circular arrow geometric shape.
|
|
110211
109975
|
* @remarks
|
|
110212
|
-
* [Api set:
|
|
110213
|
-
* @beta
|
|
109976
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110214
109977
|
*/
|
|
110215
109978
|
leftRightCircularArrow = "LeftRightCircularArrow",
|
|
110216
109979
|
/**
|
|
110217
109980
|
* Curved right arrow geometric shape.
|
|
110218
109981
|
* @remarks
|
|
110219
|
-
* [Api set:
|
|
110220
|
-
* @beta
|
|
109982
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110221
109983
|
*/
|
|
110222
109984
|
curvedRightArrow = "CurvedRightArrow",
|
|
110223
109985
|
/**
|
|
110224
109986
|
* Curved left arrow geometric shape.
|
|
110225
109987
|
* @remarks
|
|
110226
|
-
* [Api set:
|
|
110227
|
-
* @beta
|
|
109988
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110228
109989
|
*/
|
|
110229
109990
|
curvedLeftArrow = "CurvedLeftArrow",
|
|
110230
109991
|
/**
|
|
110231
109992
|
* Curved up arrow geometric shape.
|
|
110232
109993
|
* @remarks
|
|
110233
|
-
* [Api set:
|
|
110234
|
-
* @beta
|
|
109994
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110235
109995
|
*/
|
|
110236
109996
|
curvedUpArrow = "CurvedUpArrow",
|
|
110237
109997
|
/**
|
|
110238
109998
|
* Curved down arrow geometric shape.
|
|
110239
109999
|
* @remarks
|
|
110240
|
-
* [Api set:
|
|
110241
|
-
* @beta
|
|
110000
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110242
110001
|
*/
|
|
110243
110002
|
curvedDownArrow = "CurvedDownArrow",
|
|
110244
110003
|
/**
|
|
110245
110004
|
* Swoosh arrow geometric shape.
|
|
110246
110005
|
* @remarks
|
|
110247
|
-
* [Api set:
|
|
110248
|
-
* @beta
|
|
110006
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110249
110007
|
*/
|
|
110250
110008
|
swooshArrow = "SwooshArrow",
|
|
110251
110009
|
/**
|
|
110252
110010
|
* Cube geometric shape.
|
|
110253
110011
|
* @remarks
|
|
110254
|
-
* [Api set:
|
|
110255
|
-
* @beta
|
|
110012
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110256
110013
|
*/
|
|
110257
110014
|
cube = "Cube",
|
|
110258
110015
|
/**
|
|
110259
110016
|
* Can geometric shape.
|
|
110260
110017
|
* @remarks
|
|
110261
|
-
* [Api set:
|
|
110262
|
-
* @beta
|
|
110018
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110263
110019
|
*/
|
|
110264
110020
|
can = "Can",
|
|
110265
110021
|
/**
|
|
110266
110022
|
* Lightning bolt geometric shape.
|
|
110267
110023
|
* @remarks
|
|
110268
|
-
* [Api set:
|
|
110269
|
-
* @beta
|
|
110024
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110270
110025
|
*/
|
|
110271
110026
|
lightningBolt = "LightningBolt",
|
|
110272
110027
|
/**
|
|
110273
110028
|
* Heart geometric shape.
|
|
110274
110029
|
* @remarks
|
|
110275
|
-
* [Api set:
|
|
110276
|
-
* @beta
|
|
110030
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110277
110031
|
*/
|
|
110278
110032
|
heart = "Heart",
|
|
110279
110033
|
/**
|
|
110280
110034
|
* Sun geometric shape.
|
|
110281
110035
|
* @remarks
|
|
110282
|
-
* [Api set:
|
|
110283
|
-
* @beta
|
|
110036
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110284
110037
|
*/
|
|
110285
110038
|
sun = "Sun",
|
|
110286
110039
|
/**
|
|
110287
110040
|
* Moon geometric shape.
|
|
110288
110041
|
* @remarks
|
|
110289
|
-
* [Api set:
|
|
110290
|
-
* @beta
|
|
110042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110291
110043
|
*/
|
|
110292
110044
|
moon = "Moon",
|
|
110293
110045
|
/**
|
|
110294
110046
|
* Smiley face geometric shape.
|
|
110295
110047
|
* @remarks
|
|
110296
|
-
* [Api set:
|
|
110297
|
-
* @beta
|
|
110048
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110298
110049
|
*/
|
|
110299
110050
|
smileyFace = "SmileyFace",
|
|
110300
110051
|
/**
|
|
110301
110052
|
* Irregular seal 1 geometric shape.
|
|
110302
110053
|
* @remarks
|
|
110303
|
-
* [Api set:
|
|
110304
|
-
* @beta
|
|
110054
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110305
110055
|
*/
|
|
110306
110056
|
irregularSeal1 = "IrregularSeal1",
|
|
110307
110057
|
/**
|
|
110308
110058
|
* Irregular seal 2 geometric shape.
|
|
110309
110059
|
* @remarks
|
|
110310
|
-
* [Api set:
|
|
110311
|
-
* @beta
|
|
110060
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110312
110061
|
*/
|
|
110313
110062
|
irregularSeal2 = "IrregularSeal2",
|
|
110314
110063
|
/**
|
|
110315
110064
|
* Folded corner geometric shape.
|
|
110316
110065
|
* @remarks
|
|
110317
|
-
* [Api set:
|
|
110318
|
-
* @beta
|
|
110066
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110319
110067
|
*/
|
|
110320
110068
|
foldedCorner = "FoldedCorner",
|
|
110321
110069
|
/**
|
|
110322
110070
|
* Bevel geometric shape.
|
|
110323
110071
|
* @remarks
|
|
110324
|
-
* [Api set:
|
|
110325
|
-
* @beta
|
|
110072
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110326
110073
|
*/
|
|
110327
110074
|
bevel = "Bevel",
|
|
110328
110075
|
/**
|
|
110329
110076
|
* Frame geometric shape.
|
|
110330
110077
|
* @remarks
|
|
110331
|
-
* [Api set:
|
|
110332
|
-
* @beta
|
|
110078
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110333
110079
|
*/
|
|
110334
110080
|
frame = "Frame",
|
|
110335
110081
|
/**
|
|
110336
110082
|
* Half frame geometric shape.
|
|
110337
110083
|
* @remarks
|
|
110338
|
-
* [Api set:
|
|
110339
|
-
* @beta
|
|
110084
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110340
110085
|
*/
|
|
110341
110086
|
halfFrame = "HalfFrame",
|
|
110342
110087
|
/**
|
|
110343
110088
|
* Corner geometric shape.
|
|
110344
110089
|
* @remarks
|
|
110345
|
-
* [Api set:
|
|
110346
|
-
* @beta
|
|
110090
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110347
110091
|
*/
|
|
110348
110092
|
corner = "Corner",
|
|
110349
110093
|
/**
|
|
110350
110094
|
* Diagonal stripe geometric shape.
|
|
110351
110095
|
* @remarks
|
|
110352
|
-
* [Api set:
|
|
110353
|
-
* @beta
|
|
110096
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110354
110097
|
*/
|
|
110355
110098
|
diagonalStripe = "DiagonalStripe",
|
|
110356
110099
|
/**
|
|
110357
110100
|
* Chord geometric shape.
|
|
110358
110101
|
* @remarks
|
|
110359
|
-
* [Api set:
|
|
110360
|
-
* @beta
|
|
110102
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110361
110103
|
*/
|
|
110362
110104
|
chord = "Chord",
|
|
110363
110105
|
/**
|
|
110364
110106
|
* Arc geometric shape.
|
|
110365
110107
|
* @remarks
|
|
110366
|
-
* [Api set:
|
|
110367
|
-
* @beta
|
|
110108
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110368
110109
|
*/
|
|
110369
110110
|
arc = "Arc",
|
|
110370
110111
|
/**
|
|
110371
110112
|
* Left bracket geometric shape.
|
|
110372
110113
|
* @remarks
|
|
110373
|
-
* [Api set:
|
|
110374
|
-
* @beta
|
|
110114
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110375
110115
|
*/
|
|
110376
110116
|
leftBracket = "LeftBracket",
|
|
110377
110117
|
/**
|
|
110378
110118
|
* Right bracket geometric shape.
|
|
110379
110119
|
* @remarks
|
|
110380
|
-
* [Api set:
|
|
110381
|
-
* @beta
|
|
110120
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110382
110121
|
*/
|
|
110383
110122
|
rightBracket = "RightBracket",
|
|
110384
110123
|
/**
|
|
110385
110124
|
* Left brace geometric shape.
|
|
110386
110125
|
* @remarks
|
|
110387
|
-
* [Api set:
|
|
110388
|
-
* @beta
|
|
110126
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110389
110127
|
*/
|
|
110390
110128
|
leftBrace = "LeftBrace",
|
|
110391
110129
|
/**
|
|
110392
110130
|
* Right brace geometric shape.
|
|
110393
110131
|
* @remarks
|
|
110394
|
-
* [Api set:
|
|
110395
|
-
* @beta
|
|
110132
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110396
110133
|
*/
|
|
110397
110134
|
rightBrace = "RightBrace",
|
|
110398
110135
|
/**
|
|
110399
110136
|
* Bracket pair geometric shape.
|
|
110400
110137
|
* @remarks
|
|
110401
|
-
* [Api set:
|
|
110402
|
-
* @beta
|
|
110138
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110403
110139
|
*/
|
|
110404
110140
|
bracketPair = "BracketPair",
|
|
110405
110141
|
/**
|
|
110406
110142
|
* Brace pair geometric shape.
|
|
110407
110143
|
* @remarks
|
|
110408
|
-
* [Api set:
|
|
110409
|
-
* @beta
|
|
110144
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110410
110145
|
*/
|
|
110411
110146
|
bracePair = "BracePair",
|
|
110412
110147
|
/**
|
|
110413
110148
|
* Callout 1 geometric shape.
|
|
110414
110149
|
* @remarks
|
|
110415
|
-
* [Api set:
|
|
110416
|
-
* @beta
|
|
110150
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110417
110151
|
*/
|
|
110418
110152
|
callout1 = "Callout1",
|
|
110419
110153
|
/**
|
|
110420
110154
|
* Callout 2 geometric shape.
|
|
110421
110155
|
* @remarks
|
|
110422
|
-
* [Api set:
|
|
110423
|
-
* @beta
|
|
110156
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110424
110157
|
*/
|
|
110425
110158
|
callout2 = "Callout2",
|
|
110426
110159
|
/**
|
|
110427
110160
|
* Callout 3 geometric shape.
|
|
110428
110161
|
* @remarks
|
|
110429
|
-
* [Api set:
|
|
110430
|
-
* @beta
|
|
110162
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110431
110163
|
*/
|
|
110432
110164
|
callout3 = "Callout3",
|
|
110433
110165
|
/**
|
|
110434
110166
|
* Accent callout 1 geometric shape.
|
|
110435
110167
|
* @remarks
|
|
110436
|
-
* [Api set:
|
|
110437
|
-
* @beta
|
|
110168
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110438
110169
|
*/
|
|
110439
110170
|
accentCallout1 = "AccentCallout1",
|
|
110440
110171
|
/**
|
|
110441
110172
|
* Accent callout 2 geometric shape.
|
|
110442
110173
|
* @remarks
|
|
110443
|
-
* [Api set:
|
|
110444
|
-
* @beta
|
|
110174
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110445
110175
|
*/
|
|
110446
110176
|
accentCallout2 = "AccentCallout2",
|
|
110447
110177
|
/**
|
|
110448
110178
|
* Accent callout 3 geometric shape.
|
|
110449
110179
|
* @remarks
|
|
110450
|
-
* [Api set:
|
|
110451
|
-
* @beta
|
|
110180
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110452
110181
|
*/
|
|
110453
110182
|
accentCallout3 = "AccentCallout3",
|
|
110454
110183
|
/**
|
|
110455
110184
|
* Border callout 1 geometric shape.
|
|
110456
110185
|
* @remarks
|
|
110457
|
-
* [Api set:
|
|
110458
|
-
* @beta
|
|
110186
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110459
110187
|
*/
|
|
110460
110188
|
borderCallout1 = "BorderCallout1",
|
|
110461
110189
|
/**
|
|
110462
110190
|
* Border callout 2 geometric shape.
|
|
110463
110191
|
* @remarks
|
|
110464
|
-
* [Api set:
|
|
110465
|
-
* @beta
|
|
110192
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110466
110193
|
*/
|
|
110467
110194
|
borderCallout2 = "BorderCallout2",
|
|
110468
110195
|
/**
|
|
110469
110196
|
* Border callout 3 geometric shape.
|
|
110470
110197
|
* @remarks
|
|
110471
|
-
* [Api set:
|
|
110472
|
-
* @beta
|
|
110198
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110473
110199
|
*/
|
|
110474
110200
|
borderCallout3 = "BorderCallout3",
|
|
110475
110201
|
/**
|
|
110476
110202
|
* Accent border callout 1 geometric shape.
|
|
110477
110203
|
* @remarks
|
|
110478
|
-
* [Api set:
|
|
110479
|
-
* @beta
|
|
110204
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110480
110205
|
*/
|
|
110481
110206
|
accentBorderCallout1 = "AccentBorderCallout1",
|
|
110482
110207
|
/**
|
|
110483
110208
|
* Accent border callout 2 geometric shape.
|
|
110484
110209
|
* @remarks
|
|
110485
|
-
* [Api set:
|
|
110486
|
-
* @beta
|
|
110210
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110487
110211
|
*/
|
|
110488
110212
|
accentBorderCallout2 = "AccentBorderCallout2",
|
|
110489
110213
|
/**
|
|
110490
110214
|
* Accent border callout 3 geometric shape.
|
|
110491
110215
|
* @remarks
|
|
110492
|
-
* [Api set:
|
|
110493
|
-
* @beta
|
|
110216
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110494
110217
|
*/
|
|
110495
110218
|
accentBorderCallout3 = "AccentBorderCallout3",
|
|
110496
110219
|
/**
|
|
110497
110220
|
* Wedge rectangle callout geometric shape.
|
|
110498
110221
|
* @remarks
|
|
110499
|
-
* [Api set:
|
|
110500
|
-
* @beta
|
|
110222
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110501
110223
|
*/
|
|
110502
110224
|
wedgeRectCallout = "WedgeRectCallout",
|
|
110503
110225
|
/**
|
|
110504
110226
|
* Wedge rounded rectangle callout geometric shape.
|
|
110505
110227
|
* @remarks
|
|
110506
|
-
* [Api set:
|
|
110507
|
-
* @beta
|
|
110228
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110508
110229
|
*/
|
|
110509
110230
|
wedgeRRectCallout = "WedgeRRectCallout",
|
|
110510
110231
|
/**
|
|
110511
110232
|
* Wedge ellipse callout geometric shape.
|
|
110512
110233
|
* @remarks
|
|
110513
|
-
* [Api set:
|
|
110514
|
-
* @beta
|
|
110234
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110515
110235
|
*/
|
|
110516
110236
|
wedgeEllipseCallout = "WedgeEllipseCallout",
|
|
110517
110237
|
/**
|
|
110518
110238
|
* Cloud callout geometric shape.
|
|
110519
110239
|
* @remarks
|
|
110520
|
-
* [Api set:
|
|
110521
|
-
* @beta
|
|
110240
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110522
110241
|
*/
|
|
110523
110242
|
cloudCallout = "CloudCallout",
|
|
110524
110243
|
/**
|
|
110525
110244
|
* Cloud geometric shape.
|
|
110526
110245
|
* @remarks
|
|
110527
|
-
* [Api set:
|
|
110528
|
-
* @beta
|
|
110246
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110529
110247
|
*/
|
|
110530
110248
|
cloud = "Cloud",
|
|
110531
110249
|
/**
|
|
110532
110250
|
* Ribbon geometric shape.
|
|
110533
110251
|
* @remarks
|
|
110534
|
-
* [Api set:
|
|
110535
|
-
* @beta
|
|
110252
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110536
110253
|
*/
|
|
110537
110254
|
ribbon = "Ribbon",
|
|
110538
110255
|
/**
|
|
110539
110256
|
* Ribbon 2 geometric shape.
|
|
110540
110257
|
* @remarks
|
|
110541
|
-
* [Api set:
|
|
110542
|
-
* @beta
|
|
110258
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110543
110259
|
*/
|
|
110544
110260
|
ribbon2 = "Ribbon2",
|
|
110545
110261
|
/**
|
|
110546
110262
|
* Ellipse ribbon geometric shape.
|
|
110547
110263
|
* @remarks
|
|
110548
|
-
* [Api set:
|
|
110549
|
-
* @beta
|
|
110264
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110550
110265
|
*/
|
|
110551
110266
|
ellipseRibbon = "EllipseRibbon",
|
|
110552
110267
|
/**
|
|
110553
110268
|
* Ellipse ribbon 2 geometric shape.
|
|
110554
110269
|
* @remarks
|
|
110555
|
-
* [Api set:
|
|
110556
|
-
* @beta
|
|
110270
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110557
110271
|
*/
|
|
110558
110272
|
ellipseRibbon2 = "EllipseRibbon2",
|
|
110559
110273
|
/**
|
|
110560
110274
|
* Left-right ribbon geometric shape.
|
|
110561
110275
|
* @remarks
|
|
110562
|
-
* [Api set:
|
|
110563
|
-
* @beta
|
|
110276
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110564
110277
|
*/
|
|
110565
110278
|
leftRightRibbon = "LeftRightRibbon",
|
|
110566
110279
|
/**
|
|
110567
110280
|
* Vertical scroll geometric shape.
|
|
110568
110281
|
* @remarks
|
|
110569
|
-
* [Api set:
|
|
110570
|
-
* @beta
|
|
110282
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110571
110283
|
*/
|
|
110572
110284
|
verticalScroll = "VerticalScroll",
|
|
110573
110285
|
/**
|
|
110574
110286
|
* Horizontal scroll geometric shape.
|
|
110575
110287
|
* @remarks
|
|
110576
|
-
* [Api set:
|
|
110577
|
-
* @beta
|
|
110288
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110578
110289
|
*/
|
|
110579
110290
|
horizontalScroll = "HorizontalScroll",
|
|
110580
110291
|
/**
|
|
110581
110292
|
* Wave geometric shape.
|
|
110582
110293
|
* @remarks
|
|
110583
|
-
* [Api set:
|
|
110584
|
-
* @beta
|
|
110294
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110585
110295
|
*/
|
|
110586
110296
|
wave = "Wave",
|
|
110587
110297
|
/**
|
|
110588
110298
|
* Double wave geometric shape.
|
|
110589
110299
|
* @remarks
|
|
110590
|
-
* [Api set:
|
|
110591
|
-
* @beta
|
|
110300
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110592
110301
|
*/
|
|
110593
110302
|
doubleWave = "DoubleWave",
|
|
110594
110303
|
/**
|
|
110595
110304
|
* Plus geometric shape.
|
|
110596
110305
|
* @remarks
|
|
110597
|
-
* [Api set:
|
|
110598
|
-
* @beta
|
|
110306
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110599
110307
|
*/
|
|
110600
110308
|
plus = "Plus",
|
|
110601
110309
|
/**
|
|
110602
110310
|
* Flow chart process geometric shape.
|
|
110603
110311
|
* @remarks
|
|
110604
|
-
* [Api set:
|
|
110605
|
-
* @beta
|
|
110312
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110606
110313
|
*/
|
|
110607
110314
|
flowChartProcess = "FlowChartProcess",
|
|
110608
110315
|
/**
|
|
110609
110316
|
* Flow chart decision geometric shape.
|
|
110610
110317
|
* @remarks
|
|
110611
|
-
* [Api set:
|
|
110612
|
-
* @beta
|
|
110318
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110613
110319
|
*/
|
|
110614
110320
|
flowChartDecision = "FlowChartDecision",
|
|
110615
110321
|
/**
|
|
110616
110322
|
* Flow chart input-output geometric shape.
|
|
110617
110323
|
* @remarks
|
|
110618
|
-
* [Api set:
|
|
110619
|
-
* @beta
|
|
110324
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110620
110325
|
*/
|
|
110621
110326
|
flowChartInputOutput = "FlowChartInputOutput",
|
|
110622
110327
|
/**
|
|
110623
110328
|
* Flow chart predefined process geometric shape.
|
|
110624
110329
|
* @remarks
|
|
110625
|
-
* [Api set:
|
|
110626
|
-
* @beta
|
|
110330
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110627
110331
|
*/
|
|
110628
110332
|
flowChartPredefinedProcess = "FlowChartPredefinedProcess",
|
|
110629
110333
|
/**
|
|
110630
110334
|
* Flow chart internal storage geometric shape.
|
|
110631
110335
|
* @remarks
|
|
110632
|
-
* [Api set:
|
|
110633
|
-
* @beta
|
|
110336
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110634
110337
|
*/
|
|
110635
110338
|
flowChartInternalStorage = "FlowChartInternalStorage",
|
|
110636
110339
|
/**
|
|
110637
110340
|
* Flow chart document geometric shape.
|
|
110638
110341
|
* @remarks
|
|
110639
|
-
* [Api set:
|
|
110640
|
-
* @beta
|
|
110342
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110641
110343
|
*/
|
|
110642
110344
|
flowChartDocument = "FlowChartDocument",
|
|
110643
110345
|
/**
|
|
110644
110346
|
* Flow chart multidocument geometric shape.
|
|
110645
110347
|
* @remarks
|
|
110646
|
-
* [Api set:
|
|
110647
|
-
* @beta
|
|
110348
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110648
110349
|
*/
|
|
110649
110350
|
flowChartMultidocument = "FlowChartMultidocument",
|
|
110650
110351
|
/**
|
|
110651
110352
|
* Flow chart terminator geometric shape.
|
|
110652
110353
|
* @remarks
|
|
110653
|
-
* [Api set:
|
|
110654
|
-
* @beta
|
|
110354
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110655
110355
|
*/
|
|
110656
110356
|
flowChartTerminator = "FlowChartTerminator",
|
|
110657
110357
|
/**
|
|
110658
110358
|
* Flow chart preparation geometric shape.
|
|
110659
110359
|
* @remarks
|
|
110660
|
-
* [Api set:
|
|
110661
|
-
* @beta
|
|
110360
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110662
110361
|
*/
|
|
110663
110362
|
flowChartPreparation = "FlowChartPreparation",
|
|
110664
110363
|
/**
|
|
110665
110364
|
* Flow chart manual input geometric shape.
|
|
110666
110365
|
* @remarks
|
|
110667
|
-
* [Api set:
|
|
110668
|
-
* @beta
|
|
110366
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110669
110367
|
*/
|
|
110670
110368
|
flowChartManualInput = "FlowChartManualInput",
|
|
110671
110369
|
/**
|
|
110672
110370
|
* Flow chart manual operation geometric shape.
|
|
110673
110371
|
* @remarks
|
|
110674
|
-
* [Api set:
|
|
110675
|
-
* @beta
|
|
110372
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110676
110373
|
*/
|
|
110677
110374
|
flowChartManualOperation = "FlowChartManualOperation",
|
|
110678
110375
|
/**
|
|
110679
110376
|
* Flow chart connector geometric shape.
|
|
110680
110377
|
* @remarks
|
|
110681
|
-
* [Api set:
|
|
110682
|
-
* @beta
|
|
110378
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110683
110379
|
*/
|
|
110684
110380
|
flowChartConnector = "FlowChartConnector",
|
|
110685
110381
|
/**
|
|
110686
110382
|
* Flow chart punched card geometric shape.
|
|
110687
110383
|
* @remarks
|
|
110688
|
-
* [Api set:
|
|
110689
|
-
* @beta
|
|
110384
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110690
110385
|
*/
|
|
110691
110386
|
flowChartPunchedCard = "FlowChartPunchedCard",
|
|
110692
110387
|
/**
|
|
110693
110388
|
* Flow chart punched tape geometric shape.
|
|
110694
110389
|
* @remarks
|
|
110695
|
-
* [Api set:
|
|
110696
|
-
* @beta
|
|
110390
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110697
110391
|
*/
|
|
110698
110392
|
flowChartPunchedTape = "FlowChartPunchedTape",
|
|
110699
110393
|
/**
|
|
110700
110394
|
* Flow chart summing junction geometric shape.
|
|
110701
110395
|
* @remarks
|
|
110702
|
-
* [Api set:
|
|
110703
|
-
* @beta
|
|
110396
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110704
110397
|
*/
|
|
110705
110398
|
flowChartSummingJunction = "FlowChartSummingJunction",
|
|
110706
110399
|
/**
|
|
110707
110400
|
* Flow chart OR geometric shape.
|
|
110708
110401
|
* @remarks
|
|
110709
|
-
* [Api set:
|
|
110710
|
-
* @beta
|
|
110402
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110711
110403
|
*/
|
|
110712
110404
|
flowChartOr = "FlowChartOr",
|
|
110713
110405
|
/**
|
|
110714
110406
|
* Flow chart collate geometric shape.
|
|
110715
110407
|
* @remarks
|
|
110716
|
-
* [Api set:
|
|
110717
|
-
* @beta
|
|
110408
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110718
110409
|
*/
|
|
110719
110410
|
flowChartCollate = "FlowChartCollate",
|
|
110720
110411
|
/**
|
|
110721
110412
|
* Flow chart sort geometric shape.
|
|
110722
110413
|
* @remarks
|
|
110723
|
-
* [Api set:
|
|
110724
|
-
* @beta
|
|
110414
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110725
110415
|
*/
|
|
110726
110416
|
flowChartSort = "FlowChartSort",
|
|
110727
110417
|
/**
|
|
110728
110418
|
* Flow chart extract geometric shape.
|
|
110729
110419
|
* @remarks
|
|
110730
|
-
* [Api set:
|
|
110731
|
-
* @beta
|
|
110420
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110732
110421
|
*/
|
|
110733
110422
|
flowChartExtract = "FlowChartExtract",
|
|
110734
110423
|
/**
|
|
110735
110424
|
* Flow chart merge geometric shape.
|
|
110736
|
-
* @remarks
|
|
110737
|
-
* [Api set:
|
|
110738
|
-
* @beta
|
|
110425
|
+
* @remarks
|
|
110426
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110739
110427
|
*/
|
|
110740
110428
|
flowChartMerge = "FlowChartMerge",
|
|
110741
110429
|
/**
|
|
110742
110430
|
* Flow chart offline storage geometric shape.
|
|
110743
110431
|
* @remarks
|
|
110744
|
-
* [Api set:
|
|
110745
|
-
* @beta
|
|
110432
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110746
110433
|
*/
|
|
110747
110434
|
flowChartOfflineStorage = "FlowChartOfflineStorage",
|
|
110748
110435
|
/**
|
|
110749
110436
|
* Flow chart online storage geometric shape.
|
|
110750
110437
|
* @remarks
|
|
110751
|
-
* [Api set:
|
|
110752
|
-
* @beta
|
|
110438
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110753
110439
|
*/
|
|
110754
110440
|
flowChartOnlineStorage = "FlowChartOnlineStorage",
|
|
110755
110441
|
/**
|
|
110756
110442
|
* Flow chart magnetic tape geometric shape.
|
|
110757
110443
|
* @remarks
|
|
110758
|
-
* [Api set:
|
|
110759
|
-
* @beta
|
|
110444
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110760
110445
|
*/
|
|
110761
110446
|
flowChartMagneticTape = "FlowChartMagneticTape",
|
|
110762
110447
|
/**
|
|
110763
110448
|
* Flow chart magnetic disk geometric shape.
|
|
110764
110449
|
* @remarks
|
|
110765
|
-
* [Api set:
|
|
110766
|
-
* @beta
|
|
110450
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110767
110451
|
*/
|
|
110768
110452
|
flowChartMagneticDisk = "FlowChartMagneticDisk",
|
|
110769
110453
|
/**
|
|
110770
110454
|
* Flow chart magnetic drum geometric shape.
|
|
110771
110455
|
* @remarks
|
|
110772
|
-
* [Api set:
|
|
110773
|
-
* @beta
|
|
110456
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110774
110457
|
*/
|
|
110775
110458
|
flowChartMagneticDrum = "FlowChartMagneticDrum",
|
|
110776
110459
|
/**
|
|
110777
110460
|
* Flow chart display geometric shape.
|
|
110778
110461
|
* @remarks
|
|
110779
|
-
* [Api set:
|
|
110780
|
-
* @beta
|
|
110462
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110781
110463
|
*/
|
|
110782
110464
|
flowChartDisplay = "FlowChartDisplay",
|
|
110783
110465
|
/**
|
|
110784
110466
|
* Flow chart delay geometric shape.
|
|
110785
110467
|
* @remarks
|
|
110786
|
-
* [Api set:
|
|
110787
|
-
* @beta
|
|
110468
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110788
110469
|
*/
|
|
110789
110470
|
flowChartDelay = "FlowChartDelay",
|
|
110790
110471
|
/**
|
|
110791
110472
|
* Flow chart alternate process geometric shape.
|
|
110792
110473
|
* @remarks
|
|
110793
|
-
* [Api set:
|
|
110794
|
-
* @beta
|
|
110474
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110795
110475
|
*/
|
|
110796
110476
|
flowChartAlternateProcess = "FlowChartAlternateProcess",
|
|
110797
110477
|
/**
|
|
110798
110478
|
* Flow chart off-page connector geometric shape.
|
|
110799
110479
|
* @remarks
|
|
110800
|
-
* [Api set:
|
|
110801
|
-
* @beta
|
|
110480
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110802
110481
|
*/
|
|
110803
110482
|
flowChartOffpageConnector = "FlowChartOffpageConnector",
|
|
110804
110483
|
/**
|
|
110805
110484
|
* Action button blank geometric shape.
|
|
110806
110485
|
* @remarks
|
|
110807
|
-
* [Api set:
|
|
110808
|
-
* @beta
|
|
110486
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110809
110487
|
*/
|
|
110810
110488
|
actionButtonBlank = "ActionButtonBlank",
|
|
110811
110489
|
/**
|
|
110812
110490
|
* Action button home geometric shape.
|
|
110813
110491
|
* @remarks
|
|
110814
|
-
* [Api set:
|
|
110815
|
-
* @beta
|
|
110492
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110816
110493
|
*/
|
|
110817
110494
|
actionButtonHome = "ActionButtonHome",
|
|
110818
110495
|
/**
|
|
110819
110496
|
* Action button help geometric shape.
|
|
110820
110497
|
* @remarks
|
|
110821
|
-
* [Api set:
|
|
110822
|
-
* @beta
|
|
110498
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110823
110499
|
*/
|
|
110824
110500
|
actionButtonHelp = "ActionButtonHelp",
|
|
110825
110501
|
/**
|
|
110826
110502
|
* Action button information geometric shape.
|
|
110827
110503
|
* @remarks
|
|
110828
|
-
* [Api set:
|
|
110829
|
-
* @beta
|
|
110504
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110830
110505
|
*/
|
|
110831
110506
|
actionButtonInformation = "ActionButtonInformation",
|
|
110832
110507
|
/**
|
|
110833
110508
|
* Action button forward next geometric shape.
|
|
110834
110509
|
* @remarks
|
|
110835
|
-
* [Api set:
|
|
110836
|
-
* @beta
|
|
110510
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110837
110511
|
*/
|
|
110838
110512
|
actionButtonForwardNext = "ActionButtonForwardNext",
|
|
110839
110513
|
/**
|
|
110840
110514
|
* Action button back previous geometric shape.
|
|
110841
110515
|
* @remarks
|
|
110842
|
-
* [Api set:
|
|
110843
|
-
* @beta
|
|
110516
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110844
110517
|
*/
|
|
110845
110518
|
actionButtonBackPrevious = "ActionButtonBackPrevious",
|
|
110846
110519
|
/**
|
|
110847
110520
|
* Action button end geometric shape.
|
|
110848
110521
|
* @remarks
|
|
110849
|
-
* [Api set:
|
|
110850
|
-
* @beta
|
|
110522
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110851
110523
|
*/
|
|
110852
110524
|
actionButtonEnd = "ActionButtonEnd",
|
|
110853
110525
|
/**
|
|
110854
110526
|
* Action button beginning geometric shape.
|
|
110855
110527
|
* @remarks
|
|
110856
|
-
* [Api set:
|
|
110857
|
-
* @beta
|
|
110528
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110858
110529
|
*/
|
|
110859
110530
|
actionButtonBeginning = "ActionButtonBeginning",
|
|
110860
110531
|
/**
|
|
110861
110532
|
* Action button return geometric shape.
|
|
110862
110533
|
* @remarks
|
|
110863
|
-
* [Api set:
|
|
110864
|
-
* @beta
|
|
110534
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110865
110535
|
*/
|
|
110866
110536
|
actionButtonReturn = "ActionButtonReturn",
|
|
110867
110537
|
/**
|
|
110868
110538
|
* Action button document geometric shape.
|
|
110869
110539
|
* @remarks
|
|
110870
|
-
* [Api set:
|
|
110871
|
-
* @beta
|
|
110540
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110872
110541
|
*/
|
|
110873
110542
|
actionButtonDocument = "ActionButtonDocument",
|
|
110874
110543
|
/**
|
|
110875
110544
|
* Action button sound geometric shape.
|
|
110876
110545
|
* @remarks
|
|
110877
|
-
* [Api set:
|
|
110878
|
-
* @beta
|
|
110546
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110879
110547
|
*/
|
|
110880
110548
|
actionButtonSound = "ActionButtonSound",
|
|
110881
110549
|
/**
|
|
110882
110550
|
* Action button movie geometric shape.
|
|
110883
110551
|
* @remarks
|
|
110884
|
-
* [Api set:
|
|
110885
|
-
* @beta
|
|
110552
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110886
110553
|
*/
|
|
110887
110554
|
actionButtonMovie = "ActionButtonMovie",
|
|
110888
110555
|
/**
|
|
110889
110556
|
* Gear 6 geometric shape.
|
|
110890
110557
|
* @remarks
|
|
110891
|
-
* [Api set:
|
|
110892
|
-
* @beta
|
|
110558
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110893
110559
|
*/
|
|
110894
110560
|
gear6 = "Gear6",
|
|
110895
110561
|
/**
|
|
110896
110562
|
* Gear 9 geometric shape.
|
|
110897
110563
|
* @remarks
|
|
110898
|
-
* [Api set:
|
|
110899
|
-
* @beta
|
|
110564
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110900
110565
|
*/
|
|
110901
110566
|
gear9 = "Gear9",
|
|
110902
110567
|
/**
|
|
110903
110568
|
* Funnel geometric shape.
|
|
110904
110569
|
* @remarks
|
|
110905
|
-
* [Api set:
|
|
110906
|
-
* @beta
|
|
110570
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110907
110571
|
*/
|
|
110908
110572
|
funnel = "Funnel",
|
|
110909
110573
|
/**
|
|
110910
110574
|
* Math plus geometric shape.
|
|
110911
110575
|
* @remarks
|
|
110912
|
-
* [Api set:
|
|
110913
|
-
* @beta
|
|
110576
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110914
110577
|
*/
|
|
110915
110578
|
mathPlus = "MathPlus",
|
|
110916
110579
|
/**
|
|
110917
110580
|
* Math minus geometric shape.
|
|
110918
110581
|
* @remarks
|
|
110919
|
-
* [Api set:
|
|
110920
|
-
* @beta
|
|
110582
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110921
110583
|
*/
|
|
110922
110584
|
mathMinus = "MathMinus",
|
|
110923
110585
|
/**
|
|
110924
110586
|
* Math multiply geometric shape.
|
|
110925
110587
|
* @remarks
|
|
110926
|
-
* [Api set:
|
|
110927
|
-
* @beta
|
|
110588
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110928
110589
|
*/
|
|
110929
110590
|
mathMultiply = "MathMultiply",
|
|
110930
110591
|
/**
|
|
110931
110592
|
* Math divide geometric shape.
|
|
110932
110593
|
* @remarks
|
|
110933
|
-
* [Api set:
|
|
110934
|
-
* @beta
|
|
110594
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110935
110595
|
*/
|
|
110936
110596
|
mathDivide = "MathDivide",
|
|
110937
110597
|
/**
|
|
110938
110598
|
* Math equal geometric shape.
|
|
110939
110599
|
* @remarks
|
|
110940
|
-
* [Api set:
|
|
110941
|
-
* @beta
|
|
110600
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110942
110601
|
*/
|
|
110943
110602
|
mathEqual = "MathEqual",
|
|
110944
110603
|
/**
|
|
110945
110604
|
* Math not equal geometric shape.
|
|
110946
110605
|
* @remarks
|
|
110947
|
-
* [Api set:
|
|
110948
|
-
* @beta
|
|
110606
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110949
110607
|
*/
|
|
110950
110608
|
mathNotEqual = "MathNotEqual",
|
|
110951
110609
|
/**
|
|
110952
110610
|
* Corner tabs geometric shape.
|
|
110953
110611
|
* @remarks
|
|
110954
|
-
* [Api set:
|
|
110955
|
-
* @beta
|
|
110612
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110956
110613
|
*/
|
|
110957
110614
|
cornerTabs = "CornerTabs",
|
|
110958
110615
|
/**
|
|
110959
110616
|
* Square tabs geometric shape.
|
|
110960
110617
|
* @remarks
|
|
110961
|
-
* [Api set:
|
|
110962
|
-
* @beta
|
|
110618
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110963
110619
|
*/
|
|
110964
110620
|
squareTabs = "SquareTabs",
|
|
110965
110621
|
/**
|
|
110966
110622
|
* Plaque tabs geometric shape.
|
|
110967
110623
|
* @remarks
|
|
110968
|
-
* [Api set:
|
|
110969
|
-
* @beta
|
|
110624
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110970
110625
|
*/
|
|
110971
110626
|
plaqueTabs = "PlaqueTabs",
|
|
110972
110627
|
/**
|
|
110973
110628
|
* Chart X geometric shape.
|
|
110974
110629
|
* @remarks
|
|
110975
|
-
* [Api set:
|
|
110976
|
-
* @beta
|
|
110630
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110977
110631
|
*/
|
|
110978
110632
|
chartX = "ChartX",
|
|
110979
110633
|
/**
|
|
110980
110634
|
* Chart star geometric shape.
|
|
110981
110635
|
* @remarks
|
|
110982
|
-
* [Api set:
|
|
110983
|
-
* @beta
|
|
110636
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110984
110637
|
*/
|
|
110985
110638
|
chartStar = "ChartStar",
|
|
110986
110639
|
/**
|
|
110987
110640
|
* Chart plus geometric shape.
|
|
110988
110641
|
* @remarks
|
|
110989
|
-
* [Api set:
|
|
110990
|
-
* @beta
|
|
110642
|
+
* [Api set: WordApiDesktop 1.2]
|
|
110991
110643
|
*/
|
|
110992
110644
|
chartPlus = "ChartPlus",
|
|
110993
110645
|
}
|
|
@@ -110995,57 +110647,49 @@ declare namespace Word {
|
|
|
110995
110647
|
* Specifies a shape's fill type.
|
|
110996
110648
|
*
|
|
110997
110649
|
* @remarks
|
|
110998
|
-
* [Api set:
|
|
110999
|
-
* @beta
|
|
110650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111000
110651
|
*/
|
|
111001
110652
|
enum ShapeFillType {
|
|
111002
110653
|
/**
|
|
111003
110654
|
* No fill.
|
|
111004
110655
|
* @remarks
|
|
111005
|
-
* [Api set:
|
|
111006
|
-
* @beta
|
|
110656
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111007
110657
|
*/
|
|
111008
110658
|
noFill = "NoFill",
|
|
111009
110659
|
/**
|
|
111010
110660
|
* Solid fill.
|
|
111011
110661
|
* @remarks
|
|
111012
|
-
* [Api set:
|
|
111013
|
-
* @beta
|
|
110662
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111014
110663
|
*/
|
|
111015
110664
|
solid = "Solid",
|
|
111016
110665
|
/**
|
|
111017
110666
|
* Gradient fill.
|
|
111018
110667
|
* @remarks
|
|
111019
|
-
* [Api set:
|
|
111020
|
-
* @beta
|
|
110668
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111021
110669
|
*/
|
|
111022
110670
|
gradient = "Gradient",
|
|
111023
110671
|
/**
|
|
111024
110672
|
* Pattern fill.
|
|
111025
110673
|
* @remarks
|
|
111026
|
-
* [Api set:
|
|
111027
|
-
* @beta
|
|
110674
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111028
110675
|
*/
|
|
111029
110676
|
pattern = "Pattern",
|
|
111030
110677
|
/**
|
|
111031
110678
|
* Picture fill.
|
|
111032
110679
|
* @remarks
|
|
111033
|
-
* [Api set:
|
|
111034
|
-
* @beta
|
|
110680
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111035
110681
|
*/
|
|
111036
110682
|
picture = "Picture",
|
|
111037
110683
|
/**
|
|
111038
110684
|
* Texture fill.
|
|
111039
110685
|
* @remarks
|
|
111040
|
-
* [Api set:
|
|
111041
|
-
* @beta
|
|
110686
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111042
110687
|
*/
|
|
111043
110688
|
texture = "Texture",
|
|
111044
110689
|
/**
|
|
111045
110690
|
* Mixed fill.
|
|
111046
110691
|
* @remarks
|
|
111047
|
-
* [Api set:
|
|
111048
|
-
* @beta
|
|
110692
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111049
110693
|
*/
|
|
111050
110694
|
mixed = "Mixed",
|
|
111051
110695
|
}
|
|
@@ -111053,29 +110697,25 @@ declare namespace Word {
|
|
|
111053
110697
|
* Specifies the vertical alignment for the text frame in a shape.
|
|
111054
110698
|
*
|
|
111055
110699
|
* @remarks
|
|
111056
|
-
* [Api set:
|
|
111057
|
-
* @beta
|
|
110700
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111058
110701
|
*/
|
|
111059
110702
|
enum ShapeTextVerticalAlignment {
|
|
111060
110703
|
/**
|
|
111061
110704
|
* Anchor the text at the top of the bounding rectangle.
|
|
111062
110705
|
* @remarks
|
|
111063
|
-
* [Api set:
|
|
111064
|
-
* @beta
|
|
110706
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111065
110707
|
*/
|
|
111066
110708
|
top = "Top",
|
|
111067
110709
|
/**
|
|
111068
110710
|
* Anchor the text at the middle of the bounding rectangle.
|
|
111069
110711
|
* @remarks
|
|
111070
|
-
* [Api set:
|
|
111071
|
-
* @beta
|
|
110712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111072
110713
|
*/
|
|
111073
110714
|
middle = "Middle",
|
|
111074
110715
|
/**
|
|
111075
110716
|
* Anchor the text at the bottom of the bounding rectangle.
|
|
111076
110717
|
* @remarks
|
|
111077
|
-
* [Api set:
|
|
111078
|
-
* @beta
|
|
110718
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111079
110719
|
*/
|
|
111080
110720
|
bottom = "Bottom",
|
|
111081
110721
|
}
|
|
@@ -111083,57 +110723,49 @@ declare namespace Word {
|
|
|
111083
110723
|
* Specifies the orientation for the text frame in a shape.
|
|
111084
110724
|
*
|
|
111085
110725
|
* @remarks
|
|
111086
|
-
* [Api set:
|
|
111087
|
-
* @beta
|
|
110726
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111088
110727
|
*/
|
|
111089
110728
|
enum ShapeTextOrientation {
|
|
111090
110729
|
/**
|
|
111091
110730
|
* No orientation, such as in a new geometric shape.
|
|
111092
110731
|
* @remarks
|
|
111093
|
-
* [Api set:
|
|
111094
|
-
* @beta
|
|
110732
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111095
110733
|
*/
|
|
111096
110734
|
none = "None",
|
|
111097
110735
|
/**
|
|
111098
110736
|
* Horizontal text.
|
|
111099
110737
|
* @remarks
|
|
111100
|
-
* [Api set:
|
|
111101
|
-
* @beta
|
|
110738
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111102
110739
|
*/
|
|
111103
110740
|
horizontal = "Horizontal",
|
|
111104
110741
|
/**
|
|
111105
110742
|
* A special version of vertical text, where some fonts are displayed as if rotated.
|
|
111106
110743
|
* @remarks
|
|
111107
|
-
* [Api set:
|
|
111108
|
-
* @beta
|
|
110744
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111109
110745
|
*/
|
|
111110
110746
|
eastAsianVertical = "EastAsianVertical",
|
|
111111
110747
|
/**
|
|
111112
110748
|
* Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise).
|
|
111113
110749
|
* @remarks
|
|
111114
|
-
* [Api set:
|
|
111115
|
-
* @beta
|
|
110750
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111116
110751
|
*/
|
|
111117
110752
|
vertical270 = "Vertical270",
|
|
111118
110753
|
/**
|
|
111119
110754
|
* Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise).
|
|
111120
110755
|
* @remarks
|
|
111121
|
-
* [Api set:
|
|
111122
|
-
* @beta
|
|
110756
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111123
110757
|
*/
|
|
111124
110758
|
vertical = "Vertical",
|
|
111125
110759
|
/**
|
|
111126
110760
|
* A special version of vertical text, where some fonts are displayed as if rotated.
|
|
111127
110761
|
* @remarks
|
|
111128
|
-
* [Api set:
|
|
111129
|
-
* @beta
|
|
110762
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111130
110763
|
*/
|
|
111131
110764
|
eastAsianHorizontalRotated = "EastAsianHorizontalRotated",
|
|
111132
110765
|
/**
|
|
111133
110766
|
* A combination of automatic orientation is used.
|
|
111134
110767
|
* @remarks
|
|
111135
|
-
* [Api set:
|
|
111136
|
-
* @beta
|
|
110768
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111137
110769
|
*/
|
|
111138
110770
|
mixed = "Mixed",
|
|
111139
110771
|
}
|
|
@@ -111141,36 +110773,31 @@ declare namespace Word {
|
|
|
111141
110773
|
* Determines the type of automatic sizing allowed.
|
|
111142
110774
|
*
|
|
111143
110775
|
* @remarks
|
|
111144
|
-
* [Api set:
|
|
111145
|
-
* @beta
|
|
110776
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111146
110777
|
*/
|
|
111147
110778
|
enum ShapeAutoSize {
|
|
111148
110779
|
/**
|
|
111149
110780
|
* No autosizing.
|
|
111150
110781
|
* @remarks
|
|
111151
|
-
* [Api set:
|
|
111152
|
-
* @beta
|
|
110782
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111153
110783
|
*/
|
|
111154
110784
|
none = "None",
|
|
111155
110785
|
/**
|
|
111156
110786
|
* The text is adjusted to fit the shape.
|
|
111157
110787
|
* @remarks
|
|
111158
|
-
* [Api set:
|
|
111159
|
-
* @beta
|
|
110788
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111160
110789
|
*/
|
|
111161
110790
|
textToFitShape = "TextToFitShape",
|
|
111162
110791
|
/**
|
|
111163
110792
|
* The shape is adjusted to fit the text.
|
|
111164
110793
|
* @remarks
|
|
111165
|
-
* [Api set:
|
|
111166
|
-
* @beta
|
|
110794
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111167
110795
|
*/
|
|
111168
110796
|
shapeToFitText = "ShapeToFitText",
|
|
111169
110797
|
/**
|
|
111170
110798
|
* A combination of automatic sizing schemes are used.
|
|
111171
110799
|
* @remarks
|
|
111172
|
-
* [Api set:
|
|
111173
|
-
* @beta
|
|
110800
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111174
110801
|
*/
|
|
111175
110802
|
mixed = "Mixed",
|
|
111176
110803
|
}
|
|
@@ -111178,57 +110805,49 @@ declare namespace Word {
|
|
|
111178
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}.
|
|
111179
110806
|
*
|
|
111180
110807
|
* @remarks
|
|
111181
|
-
* [Api set:
|
|
111182
|
-
* @beta
|
|
110808
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111183
110809
|
*/
|
|
111184
110810
|
enum ShapeTextWrapType {
|
|
111185
110811
|
/**
|
|
111186
110812
|
* Places the shape in line with text.
|
|
111187
110813
|
* @remarks
|
|
111188
|
-
* [Api set:
|
|
111189
|
-
* @beta
|
|
110814
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111190
110815
|
*/
|
|
111191
110816
|
inline = "Inline",
|
|
111192
110817
|
/**
|
|
111193
110818
|
* Wraps text squarely around the shape.
|
|
111194
110819
|
* @remarks
|
|
111195
|
-
* [Api set:
|
|
111196
|
-
* @beta
|
|
110820
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111197
110821
|
*/
|
|
111198
110822
|
square = "Square",
|
|
111199
110823
|
/**
|
|
111200
110824
|
* Wraps text close to the shape.
|
|
111201
110825
|
* @remarks
|
|
111202
|
-
* [Api set:
|
|
111203
|
-
* @beta
|
|
110826
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111204
110827
|
*/
|
|
111205
110828
|
tight = "Tight",
|
|
111206
110829
|
/**
|
|
111207
110830
|
* Wraps text around and through the shape.
|
|
111208
110831
|
* @remarks
|
|
111209
|
-
* [Api set:
|
|
111210
|
-
* @beta
|
|
110832
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111211
110833
|
*/
|
|
111212
110834
|
through = "Through",
|
|
111213
110835
|
/**
|
|
111214
110836
|
* Places text above and below the shape.
|
|
111215
110837
|
* @remarks
|
|
111216
|
-
* [Api set:
|
|
111217
|
-
* @beta
|
|
110838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111218
110839
|
*/
|
|
111219
110840
|
topBottom = "TopBottom",
|
|
111220
110841
|
/**
|
|
111221
110842
|
* Places shape behind text.
|
|
111222
110843
|
* @remarks
|
|
111223
|
-
* [Api set:
|
|
111224
|
-
* @beta
|
|
110844
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111225
110845
|
*/
|
|
111226
110846
|
behind = "Behind",
|
|
111227
110847
|
/**
|
|
111228
110848
|
* Places shape in front of text.
|
|
111229
110849
|
* @remarks
|
|
111230
|
-
* [Api set:
|
|
111231
|
-
* @beta
|
|
110850
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111232
110851
|
*/
|
|
111233
110852
|
front = "Front",
|
|
111234
110853
|
}
|
|
@@ -111236,43 +110855,37 @@ declare namespace Word {
|
|
|
111236
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.
|
|
111237
110856
|
*
|
|
111238
110857
|
* @remarks
|
|
111239
|
-
* [Api set:
|
|
111240
|
-
* @beta
|
|
110858
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111241
110859
|
*/
|
|
111242
110860
|
enum ShapeTextWrapSide {
|
|
111243
110861
|
/**
|
|
111244
110862
|
* Has no wrap side property, such as those for inline shapes.
|
|
111245
110863
|
* @remarks
|
|
111246
|
-
* [Api set:
|
|
111247
|
-
* @beta
|
|
110864
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111248
110865
|
*/
|
|
111249
110866
|
none = "None",
|
|
111250
110867
|
/**
|
|
111251
110868
|
* Both left and right sides of the shape.
|
|
111252
110869
|
* @remarks
|
|
111253
|
-
* [Api set:
|
|
111254
|
-
* @beta
|
|
110870
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111255
110871
|
*/
|
|
111256
110872
|
both = "Both",
|
|
111257
110873
|
/**
|
|
111258
110874
|
* Left side of the shape only.
|
|
111259
110875
|
* @remarks
|
|
111260
|
-
* [Api set:
|
|
111261
|
-
* @beta
|
|
110876
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111262
110877
|
*/
|
|
111263
110878
|
left = "Left",
|
|
111264
110879
|
/**
|
|
111265
110880
|
* Right side of the shape only.
|
|
111266
110881
|
* @remarks
|
|
111267
|
-
* [Api set:
|
|
111268
|
-
* @beta
|
|
110882
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111269
110883
|
*/
|
|
111270
110884
|
right = "Right",
|
|
111271
110885
|
/**
|
|
111272
110886
|
* Side of the shape that's farther from the respective page margin.
|
|
111273
110887
|
* @remarks
|
|
111274
|
-
* [Api set:
|
|
111275
|
-
* @beta
|
|
110888
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111276
110889
|
*/
|
|
111277
110890
|
largest = "Largest",
|
|
111278
110891
|
}
|
|
@@ -112822,159 +112435,140 @@ declare namespace Word {
|
|
|
112822
112435
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
112823
112436
|
*
|
|
112824
112437
|
* @remarks
|
|
112825
|
-
* [Api set:
|
|
112826
|
-
* @beta
|
|
112438
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112827
112439
|
*/
|
|
112828
112440
|
body?: Word.Interfaces.BodyUpdateData;
|
|
112829
112441
|
/**
|
|
112830
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}.
|
|
112831
112443
|
*
|
|
112832
112444
|
* @remarks
|
|
112833
|
-
* [Api set:
|
|
112834
|
-
* @beta
|
|
112445
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112835
112446
|
*/
|
|
112836
112447
|
canvas?: Word.Interfaces.CanvasUpdateData;
|
|
112837
112448
|
/**
|
|
112838
112449
|
* Returns the fill formatting of the shape.
|
|
112839
112450
|
*
|
|
112840
112451
|
* @remarks
|
|
112841
|
-
* [Api set:
|
|
112842
|
-
* @beta
|
|
112452
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112843
112453
|
*/
|
|
112844
112454
|
fill?: Word.Interfaces.ShapeFillUpdateData;
|
|
112845
112455
|
/**
|
|
112846
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.
|
|
112847
112457
|
*
|
|
112848
112458
|
* @remarks
|
|
112849
|
-
* [Api set:
|
|
112850
|
-
* @beta
|
|
112459
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112851
112460
|
*/
|
|
112852
112461
|
parentCanvas?: Word.Interfaces.ShapeUpdateData;
|
|
112853
112462
|
/**
|
|
112854
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.
|
|
112855
112464
|
*
|
|
112856
112465
|
* @remarks
|
|
112857
|
-
* [Api set:
|
|
112858
|
-
* @beta
|
|
112466
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112859
112467
|
*/
|
|
112860
112468
|
parentGroup?: Word.Interfaces.ShapeUpdateData;
|
|
112861
112469
|
/**
|
|
112862
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}.
|
|
112863
112471
|
*
|
|
112864
112472
|
* @remarks
|
|
112865
|
-
* [Api set:
|
|
112866
|
-
* @beta
|
|
112473
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112867
112474
|
*/
|
|
112868
112475
|
shapeGroup?: Word.Interfaces.ShapeGroupUpdateData;
|
|
112869
112476
|
/**
|
|
112870
112477
|
* Gets the text frame object of the shape.
|
|
112871
112478
|
*
|
|
112872
112479
|
* @remarks
|
|
112873
|
-
* [Api set:
|
|
112874
|
-
* @beta
|
|
112480
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112875
112481
|
*/
|
|
112876
112482
|
textFrame?: Word.Interfaces.TextFrameUpdateData;
|
|
112877
112483
|
/**
|
|
112878
112484
|
* Returns the text wrap formatting of the shape.
|
|
112879
112485
|
*
|
|
112880
112486
|
* @remarks
|
|
112881
|
-
* [Api set:
|
|
112882
|
-
* @beta
|
|
112487
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112883
112488
|
*/
|
|
112884
112489
|
textWrap?: Word.Interfaces.ShapeTextWrapUpdateData;
|
|
112885
112490
|
/**
|
|
112886
112491
|
* Specifies whether a given shape can overlap other shapes.
|
|
112887
112492
|
*
|
|
112888
112493
|
* @remarks
|
|
112889
|
-
* [Api set:
|
|
112890
|
-
* @beta
|
|
112494
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112891
112495
|
*/
|
|
112892
112496
|
allowOverlap?: boolean;
|
|
112893
112497
|
/**
|
|
112894
112498
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
112895
112499
|
*
|
|
112896
112500
|
* @remarks
|
|
112897
|
-
* [Api set:
|
|
112898
|
-
* @beta
|
|
112501
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112899
112502
|
*/
|
|
112900
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";
|
|
112901
112504
|
/**
|
|
112902
112505
|
* The height, in points, of the shape.
|
|
112903
112506
|
*
|
|
112904
112507
|
* @remarks
|
|
112905
|
-
* [Api set:
|
|
112906
|
-
* @beta
|
|
112508
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112907
112509
|
*/
|
|
112908
112510
|
height?: number;
|
|
112909
112511
|
/**
|
|
112910
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.
|
|
112911
112513
|
*
|
|
112912
112514
|
* @remarks
|
|
112913
|
-
* [Api set:
|
|
112914
|
-
* @beta
|
|
112515
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112915
112516
|
*/
|
|
112916
112517
|
left?: number;
|
|
112917
112518
|
/**
|
|
112918
112519
|
* The name of the shape.
|
|
112919
112520
|
*
|
|
112920
112521
|
* @remarks
|
|
112921
|
-
* [Api set:
|
|
112922
|
-
* @beta
|
|
112522
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112923
112523
|
*/
|
|
112924
112524
|
name?: string;
|
|
112925
112525
|
/**
|
|
112926
112526
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
112927
112527
|
*
|
|
112928
112528
|
* @remarks
|
|
112929
|
-
* [Api set:
|
|
112930
|
-
* @beta
|
|
112529
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112931
112530
|
*/
|
|
112932
112531
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
112933
112532
|
/**
|
|
112934
112533
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
112935
112534
|
*
|
|
112936
112535
|
* @remarks
|
|
112937
|
-
* [Api set:
|
|
112938
|
-
* @beta
|
|
112536
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112939
112537
|
*/
|
|
112940
112538
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
112941
112539
|
/**
|
|
112942
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.
|
|
112943
112541
|
*
|
|
112944
112542
|
* @remarks
|
|
112945
|
-
* [Api set:
|
|
112946
|
-
* @beta
|
|
112543
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112947
112544
|
*/
|
|
112948
112545
|
top?: number;
|
|
112949
112546
|
/**
|
|
112950
112547
|
* The width, in points, of the shape.
|
|
112951
112548
|
*
|
|
112952
112549
|
* @remarks
|
|
112953
|
-
* [Api set:
|
|
112954
|
-
* @beta
|
|
112550
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112955
112551
|
*/
|
|
112956
112552
|
width?: number;
|
|
112957
112553
|
}
|
|
112958
112554
|
/** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
|
|
112959
112555
|
interface ShapeGroupUpdateData {
|
|
112960
112556
|
/**
|
|
112961
|
-
|
|
112962
|
-
|
|
112963
|
-
|
|
112964
|
-
|
|
112965
|
-
* @beta
|
|
112557
|
+
* Gets the Shape object associated with the group.
|
|
112558
|
+
*
|
|
112559
|
+
* @remarks
|
|
112560
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112966
112561
|
*/
|
|
112967
112562
|
shape?: Word.Interfaces.ShapeUpdateData;
|
|
112968
112563
|
}
|
|
112969
112564
|
/** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */
|
|
112970
112565
|
interface CanvasUpdateData {
|
|
112971
112566
|
/**
|
|
112972
|
-
|
|
112973
|
-
|
|
112974
|
-
|
|
112975
|
-
|
|
112976
|
-
|
|
112977
|
-
*/
|
|
112567
|
+
* Gets the Shape object associated with the canvas.
|
|
112568
|
+
*
|
|
112569
|
+
* @remarks
|
|
112570
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112571
|
+
*/
|
|
112978
112572
|
shape?: Word.Interfaces.ShapeUpdateData;
|
|
112979
112573
|
}
|
|
112980
112574
|
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
@@ -112987,24 +112581,21 @@ declare namespace Word {
|
|
|
112987
112581
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
112988
112582
|
*
|
|
112989
112583
|
* @remarks
|
|
112990
|
-
* [Api set:
|
|
112991
|
-
* @beta
|
|
112584
|
+
* [Api set: WordApiDesktop 1.2]
|
|
112992
112585
|
*/
|
|
112993
112586
|
backgroundColor?: string;
|
|
112994
112587
|
/**
|
|
112995
112588
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
112996
112589
|
*
|
|
112997
112590
|
* @remarks
|
|
112998
|
-
* [Api set:
|
|
112999
|
-
* @beta
|
|
112591
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113000
112592
|
*/
|
|
113001
112593
|
foregroundColor?: string;
|
|
113002
112594
|
/**
|
|
113003
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.
|
|
113004
112596
|
*
|
|
113005
112597
|
* @remarks
|
|
113006
|
-
* [Api set:
|
|
113007
|
-
* @beta
|
|
112598
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113008
112599
|
*/
|
|
113009
112600
|
transparency?: number;
|
|
113010
112601
|
}
|
|
@@ -113014,72 +112605,63 @@ declare namespace Word {
|
|
|
113014
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.
|
|
113015
112606
|
*
|
|
113016
112607
|
* @remarks
|
|
113017
|
-
* [Api set:
|
|
113018
|
-
* @beta
|
|
112608
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113019
112609
|
*/
|
|
113020
112610
|
autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
113021
112611
|
/**
|
|
113022
112612
|
* Represents the bottom margin, in points, of the text frame.
|
|
113023
112613
|
*
|
|
113024
112614
|
* @remarks
|
|
113025
|
-
* [Api set:
|
|
113026
|
-
* @beta
|
|
112615
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113027
112616
|
*/
|
|
113028
112617
|
bottomMargin?: number;
|
|
113029
112618
|
/**
|
|
113030
112619
|
* Represents the left margin, in points, of the text frame.
|
|
113031
112620
|
*
|
|
113032
112621
|
* @remarks
|
|
113033
|
-
* [Api set:
|
|
113034
|
-
* @beta
|
|
112622
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113035
112623
|
*/
|
|
113036
112624
|
leftMargin?: number;
|
|
113037
112625
|
/**
|
|
113038
112626
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
113039
112627
|
*
|
|
113040
112628
|
* @remarks
|
|
113041
|
-
* [Api set:
|
|
113042
|
-
* @beta
|
|
112629
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113043
112630
|
*/
|
|
113044
112631
|
noTextRotation?: boolean;
|
|
113045
112632
|
/**
|
|
113046
112633
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
113047
112634
|
*
|
|
113048
112635
|
* @remarks
|
|
113049
|
-
* [Api set:
|
|
113050
|
-
* @beta
|
|
112636
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113051
112637
|
*/
|
|
113052
112638
|
orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
113053
112639
|
/**
|
|
113054
112640
|
* Represents the right margin, in points, of the text frame.
|
|
113055
112641
|
*
|
|
113056
112642
|
* @remarks
|
|
113057
|
-
* [Api set:
|
|
113058
|
-
* @beta
|
|
112643
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113059
112644
|
*/
|
|
113060
112645
|
rightMargin?: number;
|
|
113061
112646
|
/**
|
|
113062
112647
|
* Represents the top margin, in points, of the text frame.
|
|
113063
112648
|
*
|
|
113064
112649
|
* @remarks
|
|
113065
|
-
* [Api set:
|
|
113066
|
-
* @beta
|
|
112650
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113067
112651
|
*/
|
|
113068
112652
|
topMargin?: number;
|
|
113069
112653
|
/**
|
|
113070
112654
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
113071
112655
|
*
|
|
113072
112656
|
* @remarks
|
|
113073
|
-
* [Api set:
|
|
113074
|
-
* @beta
|
|
112657
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113075
112658
|
*/
|
|
113076
112659
|
verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
113077
112660
|
/**
|
|
113078
112661
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
113079
112662
|
*
|
|
113080
112663
|
* @remarks
|
|
113081
|
-
* [Api set:
|
|
113082
|
-
* @beta
|
|
112664
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113083
112665
|
*/
|
|
113084
112666
|
wordWrap?: boolean;
|
|
113085
112667
|
}
|
|
@@ -113089,48 +112671,42 @@ declare namespace Word {
|
|
|
113089
112671
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
113090
112672
|
*
|
|
113091
112673
|
* @remarks
|
|
113092
|
-
* [Api set:
|
|
113093
|
-
* @beta
|
|
112674
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113094
112675
|
*/
|
|
113095
112676
|
bottomDistance?: number;
|
|
113096
112677
|
/**
|
|
113097
112678
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
113098
112679
|
*
|
|
113099
112680
|
* @remarks
|
|
113100
|
-
* [Api set:
|
|
113101
|
-
* @beta
|
|
112681
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113102
112682
|
*/
|
|
113103
112683
|
leftDistance?: number;
|
|
113104
112684
|
/**
|
|
113105
112685
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
113106
112686
|
*
|
|
113107
112687
|
* @remarks
|
|
113108
|
-
* [Api set:
|
|
113109
|
-
* @beta
|
|
112688
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113110
112689
|
*/
|
|
113111
112690
|
rightDistance?: number;
|
|
113112
112691
|
/**
|
|
113113
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.
|
|
113114
112693
|
*
|
|
113115
112694
|
* @remarks
|
|
113116
|
-
* [Api set:
|
|
113117
|
-
* @beta
|
|
112695
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113118
112696
|
*/
|
|
113119
112697
|
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
113120
112698
|
/**
|
|
113121
112699
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
113122
112700
|
*
|
|
113123
112701
|
* @remarks
|
|
113124
|
-
* [Api set:
|
|
113125
|
-
* @beta
|
|
112702
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113126
112703
|
*/
|
|
113127
112704
|
topDistance?: number;
|
|
113128
112705
|
/**
|
|
113129
112706
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
113130
112707
|
*
|
|
113131
112708
|
* @remarks
|
|
113132
|
-
* [Api set:
|
|
113133
|
-
* @beta
|
|
112709
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113134
112710
|
*/
|
|
113135
112711
|
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
113136
112712
|
}
|
|
@@ -113215,8 +112791,7 @@ declare namespace Word {
|
|
|
113215
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.
|
|
113216
112792
|
*
|
|
113217
112793
|
* @remarks
|
|
113218
|
-
* [Api set:
|
|
113219
|
-
* @beta
|
|
112794
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113220
112795
|
*/
|
|
113221
112796
|
shapes?: Word.Interfaces.ShapeData[];
|
|
113222
112797
|
/**
|
|
@@ -113742,8 +113317,7 @@ declare namespace Word {
|
|
|
113742
113317
|
* Gets the active window for the document.
|
|
113743
113318
|
*
|
|
113744
113319
|
* @remarks
|
|
113745
|
-
* [Api set:
|
|
113746
|
-
* @beta
|
|
113320
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113747
113321
|
*/
|
|
113748
113322
|
activeWindow?: Word.Interfaces.WindowData;
|
|
113749
113323
|
/**
|
|
@@ -113792,8 +113366,7 @@ declare namespace Word {
|
|
|
113792
113366
|
* Gets the collection of `Word.Window` objects for the document.
|
|
113793
113367
|
*
|
|
113794
113368
|
* @remarks
|
|
113795
|
-
* [Api set:
|
|
113796
|
-
* @beta
|
|
113369
|
+
* [Api set: WordApiDesktop 1.2]
|
|
113797
113370
|
*/
|
|
113798
113371
|
windows?: Word.Interfaces.WindowData[];
|
|
113799
113372
|
/**
|
|
@@ -114394,24 +113967,21 @@ declare namespace Word {
|
|
|
114394
113967
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
114395
113968
|
*
|
|
114396
113969
|
* @remarks
|
|
114397
|
-
* [Api set:
|
|
114398
|
-
* @beta
|
|
113970
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114399
113971
|
*/
|
|
114400
113972
|
height?: number;
|
|
114401
113973
|
/**
|
|
114402
113974
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
114403
113975
|
*
|
|
114404
113976
|
* @remarks
|
|
114405
|
-
* [Api set:
|
|
114406
|
-
* @beta
|
|
113977
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114407
113978
|
*/
|
|
114408
113979
|
index?: number;
|
|
114409
113980
|
/**
|
|
114410
113981
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
114411
113982
|
*
|
|
114412
113983
|
* @remarks
|
|
114413
|
-
* [Api set:
|
|
114414
|
-
* @beta
|
|
113984
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114415
113985
|
*/
|
|
114416
113986
|
width?: number;
|
|
114417
113987
|
}
|
|
@@ -114425,16 +113995,14 @@ declare namespace Word {
|
|
|
114425
113995
|
* Gets the collection of pages in the pane.
|
|
114426
113996
|
*
|
|
114427
113997
|
* @remarks
|
|
114428
|
-
* [Api set:
|
|
114429
|
-
* @beta
|
|
113998
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114430
113999
|
*/
|
|
114431
114000
|
pages?: Word.Interfaces.PageData[];
|
|
114432
114001
|
/**
|
|
114433
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.
|
|
114434
114003
|
*
|
|
114435
114004
|
* @remarks
|
|
114436
|
-
* [Api set:
|
|
114437
|
-
* @beta
|
|
114005
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114438
114006
|
*/
|
|
114439
114007
|
pagesEnclosingViewport?: Word.Interfaces.PageData[];
|
|
114440
114008
|
}
|
|
@@ -114487,11 +114055,10 @@ declare namespace Word {
|
|
|
114487
114055
|
*/
|
|
114488
114056
|
listItemOrNullObject?: Word.Interfaces.ListItemData;
|
|
114489
114057
|
/**
|
|
114490
|
-
* 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.
|
|
114491
114059
|
*
|
|
114492
114060
|
* @remarks
|
|
114493
|
-
* [Api set:
|
|
114494
|
-
* @beta
|
|
114061
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114495
114062
|
*/
|
|
114496
114063
|
shapes?: Word.Interfaces.ShapeData[];
|
|
114497
114064
|
/**
|
|
@@ -114746,16 +114313,14 @@ declare namespace Word {
|
|
|
114746
114313
|
* Gets the collection of pages in the range.
|
|
114747
114314
|
*
|
|
114748
114315
|
* @remarks
|
|
114749
|
-
* [Api set:
|
|
114750
|
-
* @beta
|
|
114316
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114751
114317
|
*/
|
|
114752
114318
|
pages?: Word.Interfaces.PageData[];
|
|
114753
114319
|
/**
|
|
114754
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.
|
|
114755
114321
|
*
|
|
114756
114322
|
* @remarks
|
|
114757
|
-
* [Api set:
|
|
114758
|
-
* @beta
|
|
114323
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114759
114324
|
*/
|
|
114760
114325
|
shapes?: Word.Interfaces.ShapeData[];
|
|
114761
114326
|
/**
|
|
@@ -115472,160 +115037,140 @@ declare namespace Word {
|
|
|
115472
115037
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
115473
115038
|
*
|
|
115474
115039
|
* @remarks
|
|
115475
|
-
* [Api set:
|
|
115476
|
-
* @beta
|
|
115040
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115477
115041
|
*/
|
|
115478
115042
|
body?: Word.Interfaces.BodyData;
|
|
115479
115043
|
/**
|
|
115480
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}.
|
|
115481
115045
|
*
|
|
115482
115046
|
* @remarks
|
|
115483
|
-
* [Api set:
|
|
115484
|
-
* @beta
|
|
115047
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115485
115048
|
*/
|
|
115486
115049
|
canvas?: Word.Interfaces.CanvasData;
|
|
115487
115050
|
/**
|
|
115488
115051
|
* Returns the fill formatting of the shape.
|
|
115489
115052
|
*
|
|
115490
115053
|
* @remarks
|
|
115491
|
-
* [Api set:
|
|
115492
|
-
* @beta
|
|
115054
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115493
115055
|
*/
|
|
115494
115056
|
fill?: Word.Interfaces.ShapeFillData;
|
|
115495
115057
|
/**
|
|
115496
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.
|
|
115497
115059
|
*
|
|
115498
115060
|
* @remarks
|
|
115499
|
-
* [Api set:
|
|
115500
|
-
* @beta
|
|
115061
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115501
115062
|
*/
|
|
115502
115063
|
parentCanvas?: Word.Interfaces.ShapeData;
|
|
115503
115064
|
/**
|
|
115504
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.
|
|
115505
115066
|
*
|
|
115506
115067
|
* @remarks
|
|
115507
|
-
* [Api set:
|
|
115508
|
-
* @beta
|
|
115068
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115509
115069
|
*/
|
|
115510
115070
|
parentGroup?: Word.Interfaces.ShapeData;
|
|
115511
115071
|
/**
|
|
115512
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}.
|
|
115513
115073
|
*
|
|
115514
115074
|
* @remarks
|
|
115515
|
-
* [Api set:
|
|
115516
|
-
* @beta
|
|
115075
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115517
115076
|
*/
|
|
115518
115077
|
shapeGroup?: Word.Interfaces.ShapeGroupData;
|
|
115519
115078
|
/**
|
|
115520
115079
|
* Gets the text frame object of the shape.
|
|
115521
115080
|
*
|
|
115522
115081
|
* @remarks
|
|
115523
|
-
* [Api set:
|
|
115524
|
-
* @beta
|
|
115082
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115525
115083
|
*/
|
|
115526
115084
|
textFrame?: Word.Interfaces.TextFrameData;
|
|
115527
115085
|
/**
|
|
115528
115086
|
* Returns the text wrap formatting of the shape.
|
|
115529
115087
|
*
|
|
115530
115088
|
* @remarks
|
|
115531
|
-
* [Api set:
|
|
115532
|
-
* @beta
|
|
115089
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115533
115090
|
*/
|
|
115534
115091
|
textWrap?: Word.Interfaces.ShapeTextWrapData;
|
|
115535
115092
|
/**
|
|
115536
115093
|
* Specifies whether a given shape can overlap other shapes.
|
|
115537
115094
|
*
|
|
115538
115095
|
* @remarks
|
|
115539
|
-
* [Api set:
|
|
115540
|
-
* @beta
|
|
115096
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115541
115097
|
*/
|
|
115542
115098
|
allowOverlap?: boolean;
|
|
115543
115099
|
/**
|
|
115544
115100
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
115545
115101
|
*
|
|
115546
115102
|
* @remarks
|
|
115547
|
-
* [Api set:
|
|
115548
|
-
* @beta
|
|
115103
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115549
115104
|
*/
|
|
115550
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";
|
|
115551
115106
|
/**
|
|
115552
115107
|
* The height, in points, of the shape.
|
|
115553
115108
|
*
|
|
115554
115109
|
* @remarks
|
|
115555
|
-
* [Api set:
|
|
115556
|
-
* @beta
|
|
115110
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115557
115111
|
*/
|
|
115558
115112
|
height?: number;
|
|
115559
115113
|
/**
|
|
115560
115114
|
* Gets an integer that represents the shape identifier.
|
|
115561
115115
|
*
|
|
115562
115116
|
* @remarks
|
|
115563
|
-
* [Api set:
|
|
115564
|
-
* @beta
|
|
115117
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115565
115118
|
*/
|
|
115566
115119
|
id?: number;
|
|
115567
115120
|
/**
|
|
115568
115121
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
115569
115122
|
*
|
|
115570
115123
|
* @remarks
|
|
115571
|
-
* [Api set:
|
|
115572
|
-
* @beta
|
|
115124
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115573
115125
|
*/
|
|
115574
115126
|
isChild?: boolean;
|
|
115575
115127
|
/**
|
|
115576
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.
|
|
115577
115129
|
*
|
|
115578
115130
|
* @remarks
|
|
115579
|
-
* [Api set:
|
|
115580
|
-
* @beta
|
|
115131
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115581
115132
|
*/
|
|
115582
115133
|
left?: number;
|
|
115583
115134
|
/**
|
|
115584
115135
|
* The name of the shape.
|
|
115585
115136
|
*
|
|
115586
115137
|
* @remarks
|
|
115587
|
-
* [Api set:
|
|
115588
|
-
* @beta
|
|
115138
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115589
115139
|
*/
|
|
115590
115140
|
name?: string;
|
|
115591
115141
|
/**
|
|
115592
115142
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
115593
115143
|
*
|
|
115594
115144
|
* @remarks
|
|
115595
|
-
* [Api set:
|
|
115596
|
-
* @beta
|
|
115145
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115597
115146
|
*/
|
|
115598
115147
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
115599
115148
|
/**
|
|
115600
115149
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
115601
115150
|
*
|
|
115602
115151
|
* @remarks
|
|
115603
|
-
* [Api set:
|
|
115604
|
-
* @beta
|
|
115152
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115605
115153
|
*/
|
|
115606
115154
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
115607
115155
|
/**
|
|
115608
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.
|
|
115609
115157
|
*
|
|
115610
115158
|
* @remarks
|
|
115611
|
-
* [Api set:
|
|
115612
|
-
* @beta
|
|
115159
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115613
115160
|
*/
|
|
115614
115161
|
top?: number;
|
|
115615
115162
|
/**
|
|
115616
115163
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
115617
115164
|
*
|
|
115618
115165
|
* @remarks
|
|
115619
|
-
* [Api set:
|
|
115620
|
-
* @beta
|
|
115166
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115621
115167
|
*/
|
|
115622
115168
|
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
|
|
115623
115169
|
/**
|
|
115624
115170
|
* The width, in points, of the shape.
|
|
115625
115171
|
*
|
|
115626
115172
|
* @remarks
|
|
115627
|
-
* [Api set:
|
|
115628
|
-
* @beta
|
|
115173
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115629
115174
|
*/
|
|
115630
115175
|
width?: number;
|
|
115631
115176
|
}
|
|
@@ -115635,24 +115180,21 @@ declare namespace Word {
|
|
|
115635
115180
|
* Gets the Shape object associated with the group.
|
|
115636
115181
|
*
|
|
115637
115182
|
* @remarks
|
|
115638
|
-
* [Api set:
|
|
115639
|
-
* @beta
|
|
115183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115640
115184
|
*/
|
|
115641
115185
|
shape?: Word.Interfaces.ShapeData;
|
|
115642
115186
|
/**
|
|
115643
115187
|
* Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
|
|
115644
115188
|
*
|
|
115645
115189
|
* @remarks
|
|
115646
|
-
* [Api set:
|
|
115647
|
-
* @beta
|
|
115190
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115648
115191
|
*/
|
|
115649
115192
|
shapes?: Word.Interfaces.ShapeData[];
|
|
115650
115193
|
/**
|
|
115651
115194
|
* Gets an integer that represents the shape group identifier.
|
|
115652
115195
|
*
|
|
115653
115196
|
* @remarks
|
|
115654
|
-
* [Api set:
|
|
115655
|
-
* @beta
|
|
115197
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115656
115198
|
*/
|
|
115657
115199
|
id?: number;
|
|
115658
115200
|
}
|
|
@@ -115662,24 +115204,21 @@ declare namespace Word {
|
|
|
115662
115204
|
* Gets the Shape object associated with the canvas.
|
|
115663
115205
|
*
|
|
115664
115206
|
* @remarks
|
|
115665
|
-
* [Api set:
|
|
115666
|
-
* @beta
|
|
115207
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115667
115208
|
*/
|
|
115668
115209
|
shape?: Word.Interfaces.ShapeData;
|
|
115669
115210
|
/**
|
|
115670
115211
|
* Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
|
|
115671
115212
|
*
|
|
115672
115213
|
* @remarks
|
|
115673
|
-
* [Api set:
|
|
115674
|
-
* @beta
|
|
115214
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115675
115215
|
*/
|
|
115676
115216
|
shapes?: Word.Interfaces.ShapeData[];
|
|
115677
115217
|
/**
|
|
115678
115218
|
* Gets an integer that represents the canvas identifier.
|
|
115679
115219
|
*
|
|
115680
115220
|
* @remarks
|
|
115681
|
-
* [Api set:
|
|
115682
|
-
* @beta
|
|
115221
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115683
115222
|
*/
|
|
115684
115223
|
id?: number;
|
|
115685
115224
|
}
|
|
@@ -115693,32 +115232,28 @@ declare namespace Word {
|
|
|
115693
115232
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
115694
115233
|
*
|
|
115695
115234
|
* @remarks
|
|
115696
|
-
* [Api set:
|
|
115697
|
-
* @beta
|
|
115235
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115698
115236
|
*/
|
|
115699
115237
|
backgroundColor?: string;
|
|
115700
115238
|
/**
|
|
115701
115239
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
115702
115240
|
*
|
|
115703
115241
|
* @remarks
|
|
115704
|
-
* [Api set:
|
|
115705
|
-
* @beta
|
|
115242
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115706
115243
|
*/
|
|
115707
115244
|
foregroundColor?: string;
|
|
115708
115245
|
/**
|
|
115709
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.
|
|
115710
115247
|
*
|
|
115711
115248
|
* @remarks
|
|
115712
|
-
* [Api set:
|
|
115713
|
-
* @beta
|
|
115249
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115714
115250
|
*/
|
|
115715
115251
|
transparency?: number;
|
|
115716
115252
|
/**
|
|
115717
115253
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
115718
115254
|
*
|
|
115719
115255
|
* @remarks
|
|
115720
|
-
* [Api set:
|
|
115721
|
-
* @beta
|
|
115256
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115722
115257
|
*/
|
|
115723
115258
|
type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";
|
|
115724
115259
|
}
|
|
@@ -115728,80 +115263,70 @@ declare namespace Word {
|
|
|
115728
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.
|
|
115729
115264
|
*
|
|
115730
115265
|
* @remarks
|
|
115731
|
-
* [Api set:
|
|
115732
|
-
* @beta
|
|
115266
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115733
115267
|
*/
|
|
115734
115268
|
autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";
|
|
115735
115269
|
/**
|
|
115736
115270
|
* Represents the bottom margin, in points, of the text frame.
|
|
115737
115271
|
*
|
|
115738
115272
|
* @remarks
|
|
115739
|
-
* [Api set:
|
|
115740
|
-
* @beta
|
|
115273
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115741
115274
|
*/
|
|
115742
115275
|
bottomMargin?: number;
|
|
115743
115276
|
/**
|
|
115744
115277
|
* Specifies if the text frame contains text.
|
|
115745
115278
|
*
|
|
115746
115279
|
* @remarks
|
|
115747
|
-
* [Api set:
|
|
115748
|
-
* @beta
|
|
115280
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115749
115281
|
*/
|
|
115750
115282
|
hasText?: boolean;
|
|
115751
115283
|
/**
|
|
115752
115284
|
* Represents the left margin, in points, of the text frame.
|
|
115753
115285
|
*
|
|
115754
115286
|
* @remarks
|
|
115755
|
-
* [Api set:
|
|
115756
|
-
* @beta
|
|
115287
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115757
115288
|
*/
|
|
115758
115289
|
leftMargin?: number;
|
|
115759
115290
|
/**
|
|
115760
115291
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
115761
115292
|
*
|
|
115762
115293
|
* @remarks
|
|
115763
|
-
* [Api set:
|
|
115764
|
-
* @beta
|
|
115294
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115765
115295
|
*/
|
|
115766
115296
|
noTextRotation?: boolean;
|
|
115767
115297
|
/**
|
|
115768
115298
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
115769
115299
|
*
|
|
115770
115300
|
* @remarks
|
|
115771
|
-
* [Api set:
|
|
115772
|
-
* @beta
|
|
115301
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115773
115302
|
*/
|
|
115774
115303
|
orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";
|
|
115775
115304
|
/**
|
|
115776
115305
|
* Represents the right margin, in points, of the text frame.
|
|
115777
115306
|
*
|
|
115778
115307
|
* @remarks
|
|
115779
|
-
* [Api set:
|
|
115780
|
-
* @beta
|
|
115308
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115781
115309
|
*/
|
|
115782
115310
|
rightMargin?: number;
|
|
115783
115311
|
/**
|
|
115784
115312
|
* Represents the top margin, in points, of the text frame.
|
|
115785
115313
|
*
|
|
115786
115314
|
* @remarks
|
|
115787
|
-
* [Api set:
|
|
115788
|
-
* @beta
|
|
115315
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115789
115316
|
*/
|
|
115790
115317
|
topMargin?: number;
|
|
115791
115318
|
/**
|
|
115792
115319
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
115793
115320
|
*
|
|
115794
115321
|
* @remarks
|
|
115795
|
-
* [Api set:
|
|
115796
|
-
* @beta
|
|
115322
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115797
115323
|
*/
|
|
115798
115324
|
verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";
|
|
115799
115325
|
/**
|
|
115800
115326
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
115801
115327
|
*
|
|
115802
115328
|
* @remarks
|
|
115803
|
-
* [Api set:
|
|
115804
|
-
* @beta
|
|
115329
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115805
115330
|
*/
|
|
115806
115331
|
wordWrap?: boolean;
|
|
115807
115332
|
}
|
|
@@ -115811,48 +115336,42 @@ declare namespace Word {
|
|
|
115811
115336
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
115812
115337
|
*
|
|
115813
115338
|
* @remarks
|
|
115814
|
-
* [Api set:
|
|
115815
|
-
* @beta
|
|
115339
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115816
115340
|
*/
|
|
115817
115341
|
bottomDistance?: number;
|
|
115818
115342
|
/**
|
|
115819
115343
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
115820
115344
|
*
|
|
115821
115345
|
* @remarks
|
|
115822
|
-
* [Api set:
|
|
115823
|
-
* @beta
|
|
115346
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115824
115347
|
*/
|
|
115825
115348
|
leftDistance?: number;
|
|
115826
115349
|
/**
|
|
115827
115350
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
115828
115351
|
*
|
|
115829
115352
|
* @remarks
|
|
115830
|
-
* [Api set:
|
|
115831
|
-
* @beta
|
|
115353
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115832
115354
|
*/
|
|
115833
115355
|
rightDistance?: number;
|
|
115834
115356
|
/**
|
|
115835
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.
|
|
115836
115358
|
*
|
|
115837
115359
|
* @remarks
|
|
115838
|
-
* [Api set:
|
|
115839
|
-
* @beta
|
|
115360
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115840
115361
|
*/
|
|
115841
115362
|
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
115842
115363
|
/**
|
|
115843
115364
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
115844
115365
|
*
|
|
115845
115366
|
* @remarks
|
|
115846
|
-
* [Api set:
|
|
115847
|
-
* @beta
|
|
115367
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115848
115368
|
*/
|
|
115849
115369
|
topDistance?: number;
|
|
115850
115370
|
/**
|
|
115851
115371
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
115852
115372
|
*
|
|
115853
115373
|
* @remarks
|
|
115854
|
-
* [Api set:
|
|
115855
|
-
* @beta
|
|
115374
|
+
* [Api set: WordApiDesktop 1.2]
|
|
115856
115375
|
*/
|
|
115857
115376
|
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
115858
115377
|
}
|
|
@@ -118132,8 +117651,7 @@ declare namespace Word {
|
|
|
118132
117651
|
* Represents a page in the document. `Page` objects manage the page layout and content.
|
|
118133
117652
|
*
|
|
118134
117653
|
* @remarks
|
|
118135
|
-
* [Api set:
|
|
118136
|
-
* @beta
|
|
117654
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118137
117655
|
*/
|
|
118138
117656
|
interface PageLoadOptions {
|
|
118139
117657
|
/**
|
|
@@ -118144,24 +117662,21 @@ declare namespace Word {
|
|
|
118144
117662
|
* Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
118145
117663
|
*
|
|
118146
117664
|
* @remarks
|
|
118147
|
-
* [Api set:
|
|
118148
|
-
* @beta
|
|
117665
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118149
117666
|
*/
|
|
118150
117667
|
height?: boolean;
|
|
118151
117668
|
/**
|
|
118152
117669
|
* Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.
|
|
118153
117670
|
*
|
|
118154
117671
|
* @remarks
|
|
118155
|
-
* [Api set:
|
|
118156
|
-
* @beta
|
|
117672
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118157
117673
|
*/
|
|
118158
117674
|
index?: boolean;
|
|
118159
117675
|
/**
|
|
118160
117676
|
* Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
118161
117677
|
*
|
|
118162
117678
|
* @remarks
|
|
118163
|
-
* [Api set:
|
|
118164
|
-
* @beta
|
|
117679
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118165
117680
|
*/
|
|
118166
117681
|
width?: boolean;
|
|
118167
117682
|
}
|
|
@@ -118169,8 +117684,7 @@ declare namespace Word {
|
|
|
118169
117684
|
* Represents the collection of page.
|
|
118170
117685
|
*
|
|
118171
117686
|
* @remarks
|
|
118172
|
-
* [Api set:
|
|
118173
|
-
* @beta
|
|
117687
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118174
117688
|
*/
|
|
118175
117689
|
interface PageCollectionLoadOptions {
|
|
118176
117690
|
/**
|
|
@@ -118181,24 +117695,21 @@ declare namespace Word {
|
|
|
118181
117695
|
* For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box.
|
|
118182
117696
|
*
|
|
118183
117697
|
* @remarks
|
|
118184
|
-
* [Api set:
|
|
118185
|
-
* @beta
|
|
117698
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118186
117699
|
*/
|
|
118187
117700
|
height?: boolean;
|
|
118188
117701
|
/**
|
|
118189
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.
|
|
118190
117703
|
*
|
|
118191
117704
|
* @remarks
|
|
118192
|
-
* [Api set:
|
|
118193
|
-
* @beta
|
|
117705
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118194
117706
|
*/
|
|
118195
117707
|
index?: boolean;
|
|
118196
117708
|
/**
|
|
118197
117709
|
* For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box.
|
|
118198
117710
|
*
|
|
118199
117711
|
* @remarks
|
|
118200
|
-
* [Api set:
|
|
118201
|
-
* @beta
|
|
117712
|
+
* [Api set: WordApiDesktop 1.2]
|
|
118202
117713
|
*/
|
|
118203
117714
|
width?: boolean;
|
|
118204
117715
|
}
|
|
@@ -120313,8 +119824,7 @@ declare namespace Word {
|
|
|
120313
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.
|
|
120314
119825
|
*
|
|
120315
119826
|
* @remarks
|
|
120316
|
-
* [Api set:
|
|
120317
|
-
* @beta
|
|
119827
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120318
119828
|
*/
|
|
120319
119829
|
interface ShapeLoadOptions {
|
|
120320
119830
|
/**
|
|
@@ -120325,160 +119835,140 @@ declare namespace Word {
|
|
|
120325
119835
|
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
120326
119836
|
*
|
|
120327
119837
|
* @remarks
|
|
120328
|
-
* [Api set:
|
|
120329
|
-
* @beta
|
|
119838
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120330
119839
|
*/
|
|
120331
119840
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
120332
119841
|
/**
|
|
120333
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}.
|
|
120334
119843
|
*
|
|
120335
119844
|
* @remarks
|
|
120336
|
-
* [Api set:
|
|
120337
|
-
* @beta
|
|
119845
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120338
119846
|
*/
|
|
120339
119847
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120340
119848
|
/**
|
|
120341
119849
|
* Returns the fill formatting of the shape.
|
|
120342
119850
|
*
|
|
120343
119851
|
* @remarks
|
|
120344
|
-
* [Api set:
|
|
120345
|
-
* @beta
|
|
119852
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120346
119853
|
*/
|
|
120347
119854
|
fill?: Word.Interfaces.ShapeFillLoadOptions;
|
|
120348
119855
|
/**
|
|
120349
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.
|
|
120350
119857
|
*
|
|
120351
119858
|
* @remarks
|
|
120352
|
-
* [Api set:
|
|
120353
|
-
* @beta
|
|
119859
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120354
119860
|
*/
|
|
120355
119861
|
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
|
|
120356
119862
|
/**
|
|
120357
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.
|
|
120358
119864
|
*
|
|
120359
119865
|
* @remarks
|
|
120360
|
-
* [Api set:
|
|
120361
|
-
* @beta
|
|
119866
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120362
119867
|
*/
|
|
120363
119868
|
parentGroup?: Word.Interfaces.ShapeLoadOptions;
|
|
120364
119869
|
/**
|
|
120365
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}.
|
|
120366
119871
|
*
|
|
120367
119872
|
* @remarks
|
|
120368
|
-
* [Api set:
|
|
120369
|
-
* @beta
|
|
119873
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120370
119874
|
*/
|
|
120371
119875
|
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
120372
119876
|
/**
|
|
120373
|
-
|
|
120374
|
-
|
|
120375
|
-
|
|
120376
|
-
|
|
120377
|
-
|
|
120378
|
-
*/
|
|
119877
|
+
* Gets the text frame object of the shape.
|
|
119878
|
+
*
|
|
119879
|
+
* @remarks
|
|
119880
|
+
* [Api set: WordApiDesktop 1.2]
|
|
119881
|
+
*/
|
|
120379
119882
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120380
119883
|
/**
|
|
120381
119884
|
* Returns the text wrap formatting of the shape.
|
|
120382
119885
|
*
|
|
120383
119886
|
* @remarks
|
|
120384
|
-
* [Api set:
|
|
120385
|
-
* @beta
|
|
119887
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120386
119888
|
*/
|
|
120387
119889
|
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120388
119890
|
/**
|
|
120389
119891
|
* Specifies whether a given shape can overlap other shapes.
|
|
120390
119892
|
*
|
|
120391
119893
|
* @remarks
|
|
120392
|
-
* [Api set:
|
|
120393
|
-
* @beta
|
|
119894
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120394
119895
|
*/
|
|
120395
119896
|
allowOverlap?: boolean;
|
|
120396
119897
|
/**
|
|
120397
119898
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120398
119899
|
*
|
|
120399
119900
|
* @remarks
|
|
120400
|
-
* [Api set:
|
|
120401
|
-
* @beta
|
|
119901
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120402
119902
|
*/
|
|
120403
119903
|
geometricShapeType?: boolean;
|
|
120404
119904
|
/**
|
|
120405
119905
|
* The height, in points, of the shape.
|
|
120406
119906
|
*
|
|
120407
119907
|
* @remarks
|
|
120408
|
-
* [Api set:
|
|
120409
|
-
* @beta
|
|
119908
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120410
119909
|
*/
|
|
120411
119910
|
height?: boolean;
|
|
120412
119911
|
/**
|
|
120413
119912
|
* Gets an integer that represents the shape identifier.
|
|
120414
119913
|
*
|
|
120415
119914
|
* @remarks
|
|
120416
|
-
* [Api set:
|
|
120417
|
-
* @beta
|
|
119915
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120418
119916
|
*/
|
|
120419
119917
|
id?: boolean;
|
|
120420
119918
|
/**
|
|
120421
119919
|
* Check whether this shape is a child of a group shape or a canvas shape.
|
|
120422
119920
|
*
|
|
120423
119921
|
* @remarks
|
|
120424
|
-
* [Api set:
|
|
120425
|
-
* @beta
|
|
119922
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120426
119923
|
*/
|
|
120427
119924
|
isChild?: boolean;
|
|
120428
119925
|
/**
|
|
120429
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.
|
|
120430
119927
|
*
|
|
120431
119928
|
* @remarks
|
|
120432
|
-
* [Api set:
|
|
120433
|
-
* @beta
|
|
119929
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120434
119930
|
*/
|
|
120435
119931
|
left?: boolean;
|
|
120436
119932
|
/**
|
|
120437
119933
|
* The name of the shape.
|
|
120438
119934
|
*
|
|
120439
119935
|
* @remarks
|
|
120440
|
-
* [Api set:
|
|
120441
|
-
* @beta
|
|
119936
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120442
119937
|
*/
|
|
120443
119938
|
name?: boolean;
|
|
120444
119939
|
/**
|
|
120445
119940
|
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
120446
119941
|
*
|
|
120447
119942
|
* @remarks
|
|
120448
|
-
* [Api set:
|
|
120449
|
-
* @beta
|
|
119943
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120450
119944
|
*/
|
|
120451
119945
|
relativeHorizontalPosition?: boolean;
|
|
120452
119946
|
/**
|
|
120453
119947
|
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
120454
119948
|
*
|
|
120455
119949
|
* @remarks
|
|
120456
|
-
* [Api set:
|
|
120457
|
-
* @beta
|
|
119950
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120458
119951
|
*/
|
|
120459
119952
|
relativeVerticalPosition?: boolean;
|
|
120460
119953
|
/**
|
|
120461
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.
|
|
120462
119955
|
*
|
|
120463
119956
|
* @remarks
|
|
120464
|
-
* [Api set:
|
|
120465
|
-
* @beta
|
|
119957
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120466
119958
|
*/
|
|
120467
119959
|
top?: boolean;
|
|
120468
119960
|
/**
|
|
120469
119961
|
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
120470
119962
|
*
|
|
120471
119963
|
* @remarks
|
|
120472
|
-
* [Api set:
|
|
120473
|
-
* @beta
|
|
119964
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120474
119965
|
*/
|
|
120475
119966
|
type?: boolean;
|
|
120476
119967
|
/**
|
|
120477
119968
|
* The width, in points, of the shape.
|
|
120478
119969
|
*
|
|
120479
119970
|
* @remarks
|
|
120480
|
-
* [Api set:
|
|
120481
|
-
* @beta
|
|
119971
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120482
119972
|
*/
|
|
120483
119973
|
width?: boolean;
|
|
120484
119974
|
}
|
|
@@ -120486,8 +119976,7 @@ declare namespace Word {
|
|
|
120486
119976
|
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
120487
119977
|
*
|
|
120488
119978
|
* @remarks
|
|
120489
|
-
* [Api set:
|
|
120490
|
-
* @beta
|
|
119979
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120491
119980
|
*/
|
|
120492
119981
|
interface ShapeGroupLoadOptions {
|
|
120493
119982
|
/**
|
|
@@ -120498,16 +119987,14 @@ declare namespace Word {
|
|
|
120498
119987
|
* Gets the Shape object associated with the group.
|
|
120499
119988
|
*
|
|
120500
119989
|
* @remarks
|
|
120501
|
-
* [Api set:
|
|
120502
|
-
* @beta
|
|
119990
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120503
119991
|
*/
|
|
120504
119992
|
shape?: Word.Interfaces.ShapeLoadOptions;
|
|
120505
119993
|
/**
|
|
120506
119994
|
* Gets an integer that represents the shape group identifier.
|
|
120507
119995
|
*
|
|
120508
119996
|
* @remarks
|
|
120509
|
-
* [Api set:
|
|
120510
|
-
* @beta
|
|
119997
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120511
119998
|
*/
|
|
120512
119999
|
id?: boolean;
|
|
120513
120000
|
}
|
|
@@ -120515,8 +120002,7 @@ declare namespace Word {
|
|
|
120515
120002
|
* Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.
|
|
120516
120003
|
*
|
|
120517
120004
|
* @remarks
|
|
120518
|
-
* [Api set:
|
|
120519
|
-
* @beta
|
|
120005
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120520
120006
|
*/
|
|
120521
120007
|
interface CanvasLoadOptions {
|
|
120522
120008
|
/**
|
|
@@ -120527,16 +120013,14 @@ declare namespace Word {
|
|
|
120527
120013
|
* Gets the Shape object associated with the canvas.
|
|
120528
120014
|
*
|
|
120529
120015
|
* @remarks
|
|
120530
|
-
* [Api set:
|
|
120531
|
-
* @beta
|
|
120016
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120532
120017
|
*/
|
|
120533
120018
|
shape?: Word.Interfaces.ShapeLoadOptions;
|
|
120534
120019
|
/**
|
|
120535
120020
|
* Gets an integer that represents the canvas identifier.
|
|
120536
120021
|
*
|
|
120537
120022
|
* @remarks
|
|
120538
|
-
* [Api set:
|
|
120539
|
-
* @beta
|
|
120023
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120540
120024
|
*/
|
|
120541
120025
|
id?: boolean;
|
|
120542
120026
|
}
|
|
@@ -120544,8 +120028,7 @@ declare namespace Word {
|
|
|
120544
120028
|
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
120545
120029
|
*
|
|
120546
120030
|
* @remarks
|
|
120547
|
-
* [Api set:
|
|
120548
|
-
* @beta
|
|
120031
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120549
120032
|
*/
|
|
120550
120033
|
interface ShapeCollectionLoadOptions {
|
|
120551
120034
|
/**
|
|
@@ -120556,160 +120039,140 @@ declare namespace Word {
|
|
|
120556
120039
|
* For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
120557
120040
|
*
|
|
120558
120041
|
* @remarks
|
|
120559
|
-
* [Api set:
|
|
120560
|
-
* @beta
|
|
120042
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120561
120043
|
*/
|
|
120562
120044
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
120563
120045
|
/**
|
|
120564
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}.
|
|
120565
120047
|
*
|
|
120566
120048
|
* @remarks
|
|
120567
|
-
* [Api set:
|
|
120568
|
-
* @beta
|
|
120049
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120569
120050
|
*/
|
|
120570
120051
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120571
120052
|
/**
|
|
120572
120053
|
* For EACH ITEM in the collection: Returns the fill formatting of the shape.
|
|
120573
120054
|
*
|
|
120574
120055
|
* @remarks
|
|
120575
|
-
* [Api set:
|
|
120576
|
-
* @beta
|
|
120056
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120577
120057
|
*/
|
|
120578
120058
|
fill?: Word.Interfaces.ShapeFillLoadOptions;
|
|
120579
120059
|
/**
|
|
120580
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.
|
|
120581
120061
|
*
|
|
120582
120062
|
* @remarks
|
|
120583
|
-
* [Api set:
|
|
120584
|
-
* @beta
|
|
120063
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120585
120064
|
*/
|
|
120586
120065
|
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
|
|
120587
120066
|
/**
|
|
120588
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.
|
|
120589
120068
|
*
|
|
120590
120069
|
* @remarks
|
|
120591
|
-
* [Api set:
|
|
120592
|
-
* @beta
|
|
120070
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120593
120071
|
*/
|
|
120594
120072
|
parentGroup?: Word.Interfaces.ShapeLoadOptions;
|
|
120595
120073
|
/**
|
|
120596
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}.
|
|
120597
120075
|
*
|
|
120598
120076
|
* @remarks
|
|
120599
|
-
* [Api set:
|
|
120600
|
-
* @beta
|
|
120077
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120601
120078
|
*/
|
|
120602
120079
|
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
120603
120080
|
/**
|
|
120604
120081
|
* For EACH ITEM in the collection: Gets the text frame object of the shape.
|
|
120605
120082
|
*
|
|
120606
120083
|
* @remarks
|
|
120607
|
-
* [Api set:
|
|
120608
|
-
* @beta
|
|
120084
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120609
120085
|
*/
|
|
120610
120086
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120611
120087
|
/**
|
|
120612
120088
|
* For EACH ITEM in the collection: Returns the text wrap formatting of the shape.
|
|
120613
120089
|
*
|
|
120614
120090
|
* @remarks
|
|
120615
|
-
* [Api set:
|
|
120616
|
-
* @beta
|
|
120091
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120617
120092
|
*/
|
|
120618
120093
|
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120619
120094
|
/**
|
|
120620
120095
|
* For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.
|
|
120621
120096
|
*
|
|
120622
120097
|
* @remarks
|
|
120623
|
-
* [Api set:
|
|
120624
|
-
* @beta
|
|
120098
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120625
120099
|
*/
|
|
120626
120100
|
allowOverlap?: boolean;
|
|
120627
120101
|
/**
|
|
120628
120102
|
* For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120629
120103
|
*
|
|
120630
120104
|
* @remarks
|
|
120631
|
-
* [Api set:
|
|
120632
|
-
* @beta
|
|
120105
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120633
120106
|
*/
|
|
120634
120107
|
geometricShapeType?: boolean;
|
|
120635
120108
|
/**
|
|
120636
120109
|
* For EACH ITEM in the collection: The height, in points, of the shape.
|
|
120637
120110
|
*
|
|
120638
120111
|
* @remarks
|
|
120639
|
-
* [Api set:
|
|
120640
|
-
* @beta
|
|
120112
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120641
120113
|
*/
|
|
120642
120114
|
height?: boolean;
|
|
120643
120115
|
/**
|
|
120644
120116
|
* For EACH ITEM in the collection: Gets an integer that represents the shape identifier.
|
|
120645
120117
|
*
|
|
120646
120118
|
* @remarks
|
|
120647
|
-
* [Api set:
|
|
120648
|
-
* @beta
|
|
120119
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120649
120120
|
*/
|
|
120650
120121
|
id?: boolean;
|
|
120651
120122
|
/**
|
|
120652
120123
|
* For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.
|
|
120653
120124
|
*
|
|
120654
120125
|
* @remarks
|
|
120655
|
-
* [Api set:
|
|
120656
|
-
* @beta
|
|
120126
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120657
120127
|
*/
|
|
120658
120128
|
isChild?: boolean;
|
|
120659
120129
|
/**
|
|
120660
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.
|
|
120661
120131
|
*
|
|
120662
120132
|
* @remarks
|
|
120663
|
-
* [Api set:
|
|
120664
|
-
* @beta
|
|
120133
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120665
120134
|
*/
|
|
120666
120135
|
left?: boolean;
|
|
120667
120136
|
/**
|
|
120668
120137
|
* For EACH ITEM in the collection: The name of the shape.
|
|
120669
120138
|
*
|
|
120670
120139
|
* @remarks
|
|
120671
|
-
* [Api set:
|
|
120672
|
-
* @beta
|
|
120140
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120673
120141
|
*/
|
|
120674
120142
|
name?: boolean;
|
|
120675
120143
|
/**
|
|
120676
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}.
|
|
120677
120145
|
*
|
|
120678
120146
|
* @remarks
|
|
120679
|
-
* [Api set:
|
|
120680
|
-
* @beta
|
|
120147
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120681
120148
|
*/
|
|
120682
120149
|
relativeHorizontalPosition?: boolean;
|
|
120683
120150
|
/**
|
|
120684
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}.
|
|
120685
120152
|
*
|
|
120686
120153
|
* @remarks
|
|
120687
|
-
* [Api set:
|
|
120688
|
-
* @beta
|
|
120154
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120689
120155
|
*/
|
|
120690
120156
|
relativeVerticalPosition?: boolean;
|
|
120691
120157
|
/**
|
|
120692
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.
|
|
120693
120159
|
*
|
|
120694
120160
|
* @remarks
|
|
120695
|
-
* [Api set:
|
|
120696
|
-
* @beta
|
|
120161
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120697
120162
|
*/
|
|
120698
120163
|
top?: boolean;
|
|
120699
120164
|
/**
|
|
120700
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.
|
|
120701
120166
|
*
|
|
120702
120167
|
* @remarks
|
|
120703
|
-
* [Api set:
|
|
120704
|
-
* @beta
|
|
120168
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120705
120169
|
*/
|
|
120706
120170
|
type?: boolean;
|
|
120707
120171
|
/**
|
|
120708
120172
|
* For EACH ITEM in the collection: The width, in points, of the shape.
|
|
120709
120173
|
*
|
|
120710
120174
|
* @remarks
|
|
120711
|
-
* [Api set:
|
|
120712
|
-
* @beta
|
|
120175
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120713
120176
|
*/
|
|
120714
120177
|
width?: boolean;
|
|
120715
120178
|
}
|
|
@@ -120717,8 +120180,7 @@ declare namespace Word {
|
|
|
120717
120180
|
* Represents the fill formatting of a shape object.
|
|
120718
120181
|
*
|
|
120719
120182
|
* @remarks
|
|
120720
|
-
* [Api set:
|
|
120721
|
-
* @beta
|
|
120183
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120722
120184
|
*/
|
|
120723
120185
|
interface ShapeFillLoadOptions {
|
|
120724
120186
|
/**
|
|
@@ -120729,32 +120191,28 @@ declare namespace Word {
|
|
|
120729
120191
|
* Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
120730
120192
|
*
|
|
120731
120193
|
* @remarks
|
|
120732
|
-
* [Api set:
|
|
120733
|
-
* @beta
|
|
120194
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120734
120195
|
*/
|
|
120735
120196
|
backgroundColor?: boolean;
|
|
120736
120197
|
/**
|
|
120737
120198
|
* Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.
|
|
120738
120199
|
*
|
|
120739
120200
|
* @remarks
|
|
120740
|
-
* [Api set:
|
|
120741
|
-
* @beta
|
|
120201
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120742
120202
|
*/
|
|
120743
120203
|
foregroundColor?: boolean;
|
|
120744
120204
|
/**
|
|
120745
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.
|
|
120746
120206
|
*
|
|
120747
120207
|
* @remarks
|
|
120748
|
-
* [Api set:
|
|
120749
|
-
* @beta
|
|
120208
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120750
120209
|
*/
|
|
120751
120210
|
transparency?: boolean;
|
|
120752
120211
|
/**
|
|
120753
120212
|
* Returns the fill type of the shape. See `Word.ShapeFillType` for details.
|
|
120754
120213
|
*
|
|
120755
120214
|
* @remarks
|
|
120756
|
-
* [Api set:
|
|
120757
|
-
* @beta
|
|
120215
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120758
120216
|
*/
|
|
120759
120217
|
type?: boolean;
|
|
120760
120218
|
}
|
|
@@ -120762,8 +120220,7 @@ declare namespace Word {
|
|
|
120762
120220
|
* Represents the text frame of a shape object.
|
|
120763
120221
|
*
|
|
120764
120222
|
* @remarks
|
|
120765
|
-
* [Api set:
|
|
120766
|
-
* @beta
|
|
120223
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120767
120224
|
*/
|
|
120768
120225
|
interface TextFrameLoadOptions {
|
|
120769
120226
|
/**
|
|
@@ -120774,80 +120231,70 @@ declare namespace Word {
|
|
|
120774
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.
|
|
120775
120232
|
*
|
|
120776
120233
|
* @remarks
|
|
120777
|
-
* [Api set:
|
|
120778
|
-
* @beta
|
|
120234
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120779
120235
|
*/
|
|
120780
120236
|
autoSizeSetting?: boolean;
|
|
120781
120237
|
/**
|
|
120782
120238
|
* Represents the bottom margin, in points, of the text frame.
|
|
120783
120239
|
*
|
|
120784
120240
|
* @remarks
|
|
120785
|
-
* [Api set:
|
|
120786
|
-
* @beta
|
|
120241
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120787
120242
|
*/
|
|
120788
120243
|
bottomMargin?: boolean;
|
|
120789
120244
|
/**
|
|
120790
120245
|
* Specifies if the text frame contains text.
|
|
120791
120246
|
*
|
|
120792
120247
|
* @remarks
|
|
120793
|
-
* [Api set:
|
|
120794
|
-
* @beta
|
|
120248
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120795
120249
|
*/
|
|
120796
120250
|
hasText?: boolean;
|
|
120797
120251
|
/**
|
|
120798
120252
|
* Represents the left margin, in points, of the text frame.
|
|
120799
120253
|
*
|
|
120800
120254
|
* @remarks
|
|
120801
|
-
* [Api set:
|
|
120802
|
-
* @beta
|
|
120255
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120803
120256
|
*/
|
|
120804
120257
|
leftMargin?: boolean;
|
|
120805
120258
|
/**
|
|
120806
120259
|
* Returns True if text in the text frame shouldn't rotate when the shape is rotated.
|
|
120807
120260
|
*
|
|
120808
120261
|
* @remarks
|
|
120809
|
-
* [Api set:
|
|
120810
|
-
* @beta
|
|
120262
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120811
120263
|
*/
|
|
120812
120264
|
noTextRotation?: boolean;
|
|
120813
120265
|
/**
|
|
120814
120266
|
* Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details.
|
|
120815
120267
|
*
|
|
120816
120268
|
* @remarks
|
|
120817
|
-
* [Api set:
|
|
120818
|
-
* @beta
|
|
120269
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120819
120270
|
*/
|
|
120820
120271
|
orientation?: boolean;
|
|
120821
120272
|
/**
|
|
120822
120273
|
* Represents the right margin, in points, of the text frame.
|
|
120823
120274
|
*
|
|
120824
120275
|
* @remarks
|
|
120825
|
-
* [Api set:
|
|
120826
|
-
* @beta
|
|
120276
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120827
120277
|
*/
|
|
120828
120278
|
rightMargin?: boolean;
|
|
120829
120279
|
/**
|
|
120830
120280
|
* Represents the top margin, in points, of the text frame.
|
|
120831
120281
|
*
|
|
120832
120282
|
* @remarks
|
|
120833
|
-
* [Api set:
|
|
120834
|
-
* @beta
|
|
120283
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120835
120284
|
*/
|
|
120836
120285
|
topMargin?: boolean;
|
|
120837
120286
|
/**
|
|
120838
120287
|
* Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details.
|
|
120839
120288
|
*
|
|
120840
120289
|
* @remarks
|
|
120841
|
-
* [Api set:
|
|
120842
|
-
* @beta
|
|
120290
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120843
120291
|
*/
|
|
120844
120292
|
verticalAlignment?: boolean;
|
|
120845
120293
|
/**
|
|
120846
120294
|
* Determines whether lines break automatically to fit text inside the shape.
|
|
120847
120295
|
*
|
|
120848
120296
|
* @remarks
|
|
120849
|
-
* [Api set:
|
|
120850
|
-
* @beta
|
|
120297
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120851
120298
|
*/
|
|
120852
120299
|
wordWrap?: boolean;
|
|
120853
120300
|
}
|
|
@@ -120855,8 +120302,7 @@ declare namespace Word {
|
|
|
120855
120302
|
* Represents all the properties for wrapping text around a shape.
|
|
120856
120303
|
*
|
|
120857
120304
|
* @remarks
|
|
120858
|
-
* [Api set:
|
|
120859
|
-
* @beta
|
|
120305
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120860
120306
|
*/
|
|
120861
120307
|
interface ShapeTextWrapLoadOptions {
|
|
120862
120308
|
/**
|
|
@@ -120867,48 +120313,42 @@ declare namespace Word {
|
|
|
120867
120313
|
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
120868
120314
|
*
|
|
120869
120315
|
* @remarks
|
|
120870
|
-
* [Api set:
|
|
120871
|
-
* @beta
|
|
120316
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120872
120317
|
*/
|
|
120873
120318
|
bottomDistance?: boolean;
|
|
120874
120319
|
/**
|
|
120875
120320
|
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
120876
120321
|
*
|
|
120877
120322
|
* @remarks
|
|
120878
|
-
* [Api set:
|
|
120879
|
-
* @beta
|
|
120323
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120880
120324
|
*/
|
|
120881
120325
|
leftDistance?: boolean;
|
|
120882
120326
|
/**
|
|
120883
120327
|
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
120884
120328
|
*
|
|
120885
120329
|
* @remarks
|
|
120886
|
-
* [Api set:
|
|
120887
|
-
* @beta
|
|
120330
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120888
120331
|
*/
|
|
120889
120332
|
rightDistance?: boolean;
|
|
120890
120333
|
/**
|
|
120891
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.
|
|
120892
120335
|
*
|
|
120893
120336
|
* @remarks
|
|
120894
|
-
* [Api set:
|
|
120895
|
-
* @beta
|
|
120337
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120896
120338
|
*/
|
|
120897
120339
|
side?: boolean;
|
|
120898
120340
|
/**
|
|
120899
120341
|
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
120900
120342
|
*
|
|
120901
120343
|
* @remarks
|
|
120902
|
-
* [Api set:
|
|
120903
|
-
* @beta
|
|
120344
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120904
120345
|
*/
|
|
120905
120346
|
topDistance?: boolean;
|
|
120906
120347
|
/**
|
|
120907
120348
|
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
120908
120349
|
*
|
|
120909
120350
|
* @remarks
|
|
120910
|
-
* [Api set:
|
|
120911
|
-
* @beta
|
|
120351
|
+
* [Api set: WordApiDesktop 1.2]
|
|
120912
120352
|
*/
|
|
120913
120353
|
type?: boolean;
|
|
120914
120354
|
}
|