@types/office-js 1.0.560 → 1.0.562
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +133 -113
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 12 Dec 2025 18:42:47 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -30677,7 +30677,7 @@ declare namespace Excel {
|
|
|
30677
30677
|
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
30678
30678
|
* In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.
|
|
30679
30679
|
*
|
|
30680
|
-
* @deprecated As of
|
|
30680
|
+
* @deprecated As of ExcelApi 1.19, use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead.
|
|
30681
30681
|
*
|
|
30682
30682
|
* @remarks
|
|
30683
30683
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30686,7 +30686,7 @@ declare namespace Excel {
|
|
|
30686
30686
|
/**
|
|
30687
30687
|
* Represents the type of this cell value.
|
|
30688
30688
|
*
|
|
30689
|
-
* @deprecated Deprecated since
|
|
30689
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30690
30690
|
*
|
|
30691
30691
|
* @remarks
|
|
30692
30692
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30695,7 +30695,7 @@ declare namespace Excel {
|
|
|
30695
30695
|
/**
|
|
30696
30696
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
30697
30697
|
*
|
|
30698
|
-
* @deprecated Deprecated since
|
|
30698
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30699
30699
|
*
|
|
30700
30700
|
* @remarks
|
|
30701
30701
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30704,7 +30704,7 @@ declare namespace Excel {
|
|
|
30704
30704
|
/**
|
|
30705
30705
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
30706
30706
|
*
|
|
30707
|
-
* @deprecated Deprecated since
|
|
30707
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30708
30708
|
*
|
|
30709
30709
|
* @remarks
|
|
30710
30710
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30716,7 +30716,7 @@ declare namespace Excel {
|
|
|
30716
30716
|
* Number format strings must conform to Excel guidelines.
|
|
30717
30717
|
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
30718
30718
|
*
|
|
30719
|
-
* @deprecated Deprecated since
|
|
30719
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30720
30720
|
*
|
|
30721
30721
|
* @remarks
|
|
30722
30722
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32170,10 +32170,17 @@ declare namespace Excel {
|
|
|
32170
32170
|
}
|
|
32171
32171
|
/**
|
|
32172
32172
|
*
|
|
32173
|
-
* Creates and opens a new workbook.
|
|
32174
|
-
*
|
|
32175
|
-
|
|
32176
|
-
*
|
|
32173
|
+
* Creates and opens a new workbook. Optionally, the workbook can be pre-populated
|
|
32174
|
+
* with a Base64-encoded .xlsx file.
|
|
32175
|
+
|
|
32176
|
+
* Note: Macros can be a security risk. If this API is used to create a workbook that
|
|
32177
|
+
* includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog
|
|
32178
|
+
* in the Excel UI. The user must select the "Trust add-in" button to proceed.
|
|
32179
|
+
*
|
|
32180
|
+
* Note: The `extensionHardening` Windows registry key affects the `base64File` param.
|
|
32181
|
+
* The file extension defined by the param must match the real file type of the file.
|
|
32182
|
+
* If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error:
|
|
32183
|
+
* "This operation is not allowed due to the extension hardening policy."
|
|
32177
32184
|
* [Api set: ExcelApi 1.8]
|
|
32178
32185
|
*
|
|
32179
32186
|
* @param base64File Optional. The Base64-encoded .xlsx file. The default value is null.
|
|
@@ -32365,7 +32372,6 @@ declare namespace Excel {
|
|
|
32365
32372
|
*
|
|
32366
32373
|
* When false, each `context.sync()` call creates an undo record.
|
|
32367
32374
|
* When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group.
|
|
32368
|
-
*
|
|
32369
32375
|
* @remarks
|
|
32370
32376
|
* [Api set: ExcelApi 1.20]
|
|
32371
32377
|
*/
|
|
@@ -35781,8 +35787,7 @@ declare namespace Excel {
|
|
|
35781
35787
|
*/
|
|
35782
35788
|
close(closeBehavior?: "Save" | "SkipSave"): void;
|
|
35783
35789
|
/**
|
|
35784
|
-
* Sets focus on the workbook. This
|
|
35785
|
-
to receive keyboard events.
|
|
35790
|
+
* Sets focus on the workbook. This causes the Excel grid or the currently active object to receive keyboard events.
|
|
35786
35791
|
*
|
|
35787
35792
|
* @remarks
|
|
35788
35793
|
* [Api set: ExcelApiDesktop 1.1]
|
|
@@ -35877,7 +35882,10 @@ declare namespace Excel {
|
|
|
35877
35882
|
getSelectedRanges(): Excel.RangeAreas;
|
|
35878
35883
|
/**
|
|
35879
35884
|
* Inserts the specified worksheets from a source workbook into the current workbook.
|
|
35880
|
-
|
|
35885
|
+
|
|
35886
|
+
The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
|
|
35887
|
+
|
|
35888
|
+
**Note**: This API is currently only supported for Office on Windows, Mac, and the web.
|
|
35881
35889
|
*
|
|
35882
35890
|
* @remarks
|
|
35883
35891
|
* [Api set: ExcelApi 1.13]
|
|
@@ -64306,6 +64314,7 @@ declare namespace Excel {
|
|
|
64306
64314
|
content: string;
|
|
64307
64315
|
/**
|
|
64308
64316
|
* Specifies the height of the note.
|
|
64317
|
+
* Note: This property is not supported in Excel on the web.
|
|
64309
64318
|
*
|
|
64310
64319
|
* @remarks
|
|
64311
64320
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64313,6 +64322,7 @@ declare namespace Excel {
|
|
|
64313
64322
|
height: number;
|
|
64314
64323
|
/**
|
|
64315
64324
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
64325
|
+
* Note: This property is not supported in Excel on the web.
|
|
64316
64326
|
*
|
|
64317
64327
|
* @remarks
|
|
64318
64328
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64320,6 +64330,7 @@ declare namespace Excel {
|
|
|
64320
64330
|
visible: boolean;
|
|
64321
64331
|
/**
|
|
64322
64332
|
* Specifies the width of the note.
|
|
64333
|
+
* Note: This property is not supported in Excel on the web.
|
|
64323
64334
|
*
|
|
64324
64335
|
* @remarks
|
|
64325
64336
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74108,6 +74119,7 @@ declare namespace Excel {
|
|
|
74108
74119
|
content?: string;
|
|
74109
74120
|
/**
|
|
74110
74121
|
* Specifies the height of the note.
|
|
74122
|
+
* Note: This property is not supported in Excel on the web.
|
|
74111
74123
|
*
|
|
74112
74124
|
* @remarks
|
|
74113
74125
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74115,6 +74127,7 @@ declare namespace Excel {
|
|
|
74115
74127
|
height?: number;
|
|
74116
74128
|
/**
|
|
74117
74129
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
74130
|
+
* Note: This property is not supported in Excel on the web.
|
|
74118
74131
|
*
|
|
74119
74132
|
* @remarks
|
|
74120
74133
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74122,6 +74135,7 @@ declare namespace Excel {
|
|
|
74122
74135
|
visible?: boolean;
|
|
74123
74136
|
/**
|
|
74124
74137
|
* Specifies the width of the note.
|
|
74138
|
+
* Note: This property is not supported in Excel on the web.
|
|
74125
74139
|
*
|
|
74126
74140
|
* @remarks
|
|
74127
74141
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81425,6 +81439,7 @@ declare namespace Excel {
|
|
|
81425
81439
|
content?: string;
|
|
81426
81440
|
/**
|
|
81427
81441
|
* Specifies the height of the note.
|
|
81442
|
+
* Note: This property is not supported in Excel on the web.
|
|
81428
81443
|
*
|
|
81429
81444
|
* @remarks
|
|
81430
81445
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81432,6 +81447,7 @@ declare namespace Excel {
|
|
|
81432
81447
|
height?: number;
|
|
81433
81448
|
/**
|
|
81434
81449
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
81450
|
+
* Note: This property is not supported in Excel on the web.
|
|
81435
81451
|
*
|
|
81436
81452
|
* @remarks
|
|
81437
81453
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81439,6 +81455,7 @@ declare namespace Excel {
|
|
|
81439
81455
|
visible?: boolean;
|
|
81440
81456
|
/**
|
|
81441
81457
|
* Specifies the width of the note.
|
|
81458
|
+
* Note: This property is not supported in Excel on the web.
|
|
81442
81459
|
*
|
|
81443
81460
|
* @remarks
|
|
81444
81461
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93509,6 +93526,7 @@ declare namespace Excel {
|
|
|
93509
93526
|
content?: boolean;
|
|
93510
93527
|
/**
|
|
93511
93528
|
* For EACH ITEM in the collection: Specifies the height of the note.
|
|
93529
|
+
* Note: This property is not supported in Excel on the web.
|
|
93512
93530
|
*
|
|
93513
93531
|
* @remarks
|
|
93514
93532
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93516,6 +93534,7 @@ declare namespace Excel {
|
|
|
93516
93534
|
height?: boolean;
|
|
93517
93535
|
/**
|
|
93518
93536
|
* For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
93537
|
+
* Note: This property is not supported in Excel on the web.
|
|
93519
93538
|
*
|
|
93520
93539
|
* @remarks
|
|
93521
93540
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93523,6 +93542,7 @@ declare namespace Excel {
|
|
|
93523
93542
|
visible?: boolean;
|
|
93524
93543
|
/**
|
|
93525
93544
|
* For EACH ITEM in the collection: Specifies the width of the note.
|
|
93545
|
+
* Note: This property is not supported in Excel on the web.
|
|
93526
93546
|
*
|
|
93527
93547
|
* @remarks
|
|
93528
93548
|
* [Api set: ExcelApi 1.18]
|
|
@@ -96554,7 +96574,7 @@ declare namespace Word {
|
|
|
96554
96574
|
};
|
|
96555
96575
|
}
|
|
96556
96576
|
/**
|
|
96557
|
-
*
|
|
96577
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
96558
96578
|
*
|
|
96559
96579
|
* @remarks
|
|
96560
96580
|
* [Api set: WordApi 1.7]
|
|
@@ -102081,7 +102101,7 @@ declare namespace Word {
|
|
|
102081
102101
|
toJSON(): Word.Interfaces.DocumentData;
|
|
102082
102102
|
}
|
|
102083
102103
|
/**
|
|
102084
|
-
* The `DocumentCreated` object is the top
|
|
102104
|
+
* The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
|
|
102085
102105
|
*
|
|
102086
102106
|
* @remarks
|
|
102087
102107
|
* [Api set: WordApi 1.3]
|
|
@@ -102472,7 +102492,7 @@ declare namespace Word {
|
|
|
102472
102492
|
toJSON(): Word.Interfaces.DocumentPropertiesData;
|
|
102473
102493
|
}
|
|
102474
102494
|
/**
|
|
102475
|
-
*
|
|
102495
|
+
* Represents the data specific to content controls of type `dropDownList`.
|
|
102476
102496
|
*
|
|
102477
102497
|
* @remarks
|
|
102478
102498
|
* [Api set: WordApi 1.9]
|
|
@@ -102535,7 +102555,7 @@ declare namespace Word {
|
|
|
102535
102555
|
toJSON(): Word.Interfaces.DropDownListContentControlData;
|
|
102536
102556
|
}
|
|
102537
102557
|
/**
|
|
102538
|
-
*
|
|
102558
|
+
* Represents the data specific to content controls of type `comboBox`.
|
|
102539
102559
|
*
|
|
102540
102560
|
* @remarks
|
|
102541
102561
|
* [Api set: WordApi 1.9]
|
|
@@ -113692,7 +113712,7 @@ declare namespace Word {
|
|
|
113692
113712
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
113693
113713
|
context: RequestContext;
|
|
113694
113714
|
/**
|
|
113695
|
-
*
|
|
113715
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
113696
113716
|
*
|
|
113697
113717
|
* @remarks
|
|
113698
113718
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113762,21 +113782,21 @@ declare namespace Word {
|
|
|
113762
113782
|
*/
|
|
113763
113783
|
altTextDescription: string;
|
|
113764
113784
|
/**
|
|
113765
|
-
*
|
|
113785
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
113766
113786
|
*
|
|
113767
113787
|
* @remarks
|
|
113768
113788
|
* [Api set: WordApiDesktop 1.2]
|
|
113769
113789
|
*/
|
|
113770
113790
|
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";
|
|
113771
113791
|
/**
|
|
113772
|
-
*
|
|
113792
|
+
* Specifies the height, in points, of the shape.
|
|
113773
113793
|
*
|
|
113774
113794
|
* @remarks
|
|
113775
113795
|
* [Api set: WordApiDesktop 1.2]
|
|
113776
113796
|
*/
|
|
113777
113797
|
height: number;
|
|
113778
113798
|
/**
|
|
113779
|
-
*
|
|
113799
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
113780
113800
|
*
|
|
113781
113801
|
* @remarks
|
|
113782
113802
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113797,14 +113817,14 @@ declare namespace Word {
|
|
|
113797
113817
|
*/
|
|
113798
113818
|
readonly isChild: boolean;
|
|
113799
113819
|
/**
|
|
113800
|
-
*
|
|
113820
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). 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.
|
|
113801
113821
|
*
|
|
113802
113822
|
* @remarks
|
|
113803
113823
|
* [Api set: WordApiDesktop 1.2]
|
|
113804
113824
|
*/
|
|
113805
113825
|
left: number;
|
|
113806
113826
|
/**
|
|
113807
|
-
*
|
|
113827
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
113808
113828
|
*
|
|
113809
113829
|
* @remarks
|
|
113810
113830
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113818,35 +113838,35 @@ declare namespace Word {
|
|
|
113818
113838
|
*/
|
|
113819
113839
|
lockAspectRatio: boolean;
|
|
113820
113840
|
/**
|
|
113821
|
-
*
|
|
113841
|
+
* Specifies the name of the shape.
|
|
113822
113842
|
*
|
|
113823
113843
|
* @remarks
|
|
113824
113844
|
* [Api set: WordApiDesktop 1.2]
|
|
113825
113845
|
*/
|
|
113826
113846
|
name: string;
|
|
113827
113847
|
/**
|
|
113828
|
-
*
|
|
113848
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
113829
113849
|
*
|
|
113830
113850
|
* @remarks
|
|
113831
113851
|
* [Api set: WordApiDesktop 1.2]
|
|
113832
113852
|
*/
|
|
113833
113853
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
113834
113854
|
/**
|
|
113835
|
-
*
|
|
113855
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
113836
113856
|
*
|
|
113837
113857
|
* @remarks
|
|
113838
113858
|
* [Api set: WordApiDesktop 1.2]
|
|
113839
113859
|
*/
|
|
113840
113860
|
relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
113841
113861
|
/**
|
|
113842
|
-
*
|
|
113862
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
113843
113863
|
*
|
|
113844
113864
|
* @remarks
|
|
113845
113865
|
* [Api set: WordApiDesktop 1.2]
|
|
113846
113866
|
*/
|
|
113847
113867
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
113848
113868
|
/**
|
|
113849
|
-
*
|
|
113869
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
113850
113870
|
*
|
|
113851
113871
|
* @remarks
|
|
113852
113872
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113860,14 +113880,14 @@ declare namespace Word {
|
|
|
113860
113880
|
*/
|
|
113861
113881
|
rotation: number;
|
|
113862
113882
|
/**
|
|
113863
|
-
*
|
|
113883
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). 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.
|
|
113864
113884
|
*
|
|
113865
113885
|
* @remarks
|
|
113866
113886
|
* [Api set: WordApiDesktop 1.2]
|
|
113867
113887
|
*/
|
|
113868
113888
|
top: number;
|
|
113869
113889
|
/**
|
|
113870
|
-
*
|
|
113890
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
113871
113891
|
*
|
|
113872
113892
|
* @remarks
|
|
113873
113893
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113888,14 +113908,14 @@ declare namespace Word {
|
|
|
113888
113908
|
*/
|
|
113889
113909
|
visible: boolean;
|
|
113890
113910
|
/**
|
|
113891
|
-
*
|
|
113911
|
+
* Specifies the width, in points, of the shape.
|
|
113892
113912
|
*
|
|
113893
113913
|
* @remarks
|
|
113894
113914
|
* [Api set: WordApiDesktop 1.2]
|
|
113895
113915
|
*/
|
|
113896
113916
|
width: number;
|
|
113897
113917
|
/**
|
|
113898
|
-
*
|
|
113918
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
113899
113919
|
*
|
|
113900
113920
|
* @remarks
|
|
113901
113921
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -117711,7 +117731,7 @@ declare namespace Word {
|
|
|
117711
117731
|
*/
|
|
117712
117732
|
interface ContentControlAddedEventArgs {
|
|
117713
117733
|
/**
|
|
117714
|
-
*
|
|
117734
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117715
117735
|
*
|
|
117716
117736
|
* @remarks
|
|
117717
117737
|
* [Api set: WordApi 1.5]
|
|
@@ -117725,7 +117745,7 @@ declare namespace Word {
|
|
|
117725
117745
|
*/
|
|
117726
117746
|
ids: number[];
|
|
117727
117747
|
/**
|
|
117728
|
-
*
|
|
117748
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117729
117749
|
*
|
|
117730
117750
|
* @remarks
|
|
117731
117751
|
* [Api set: WordApi 1.5]
|
|
@@ -117740,7 +117760,7 @@ declare namespace Word {
|
|
|
117740
117760
|
*/
|
|
117741
117761
|
interface ContentControlDataChangedEventArgs {
|
|
117742
117762
|
/**
|
|
117743
|
-
*
|
|
117763
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117744
117764
|
*
|
|
117745
117765
|
* @remarks
|
|
117746
117766
|
* [Api set: WordApi 1.5]
|
|
@@ -117754,7 +117774,7 @@ declare namespace Word {
|
|
|
117754
117774
|
*/
|
|
117755
117775
|
ids: number[];
|
|
117756
117776
|
/**
|
|
117757
|
-
*
|
|
117777
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117758
117778
|
*
|
|
117759
117779
|
* @remarks
|
|
117760
117780
|
* [Api set: WordApi 1.5]
|
|
@@ -117769,7 +117789,7 @@ declare namespace Word {
|
|
|
117769
117789
|
*/
|
|
117770
117790
|
interface ContentControlDeletedEventArgs {
|
|
117771
117791
|
/**
|
|
117772
|
-
*
|
|
117792
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117773
117793
|
*
|
|
117774
117794
|
* @remarks
|
|
117775
117795
|
* [Api set: WordApi 1.5]
|
|
@@ -117783,7 +117803,7 @@ declare namespace Word {
|
|
|
117783
117803
|
*/
|
|
117784
117804
|
ids: number[];
|
|
117785
117805
|
/**
|
|
117786
|
-
*
|
|
117806
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117787
117807
|
*
|
|
117788
117808
|
* @remarks
|
|
117789
117809
|
* [Api set: WordApi 1.5]
|
|
@@ -117798,7 +117818,7 @@ declare namespace Word {
|
|
|
117798
117818
|
*/
|
|
117799
117819
|
interface ContentControlEnteredEventArgs {
|
|
117800
117820
|
/**
|
|
117801
|
-
*
|
|
117821
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117802
117822
|
*
|
|
117803
117823
|
* @remarks
|
|
117804
117824
|
* [Api set: WordApi 1.5]
|
|
@@ -117812,7 +117832,7 @@ declare namespace Word {
|
|
|
117812
117832
|
*/
|
|
117813
117833
|
ids: number[];
|
|
117814
117834
|
/**
|
|
117815
|
-
*
|
|
117835
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117816
117836
|
*
|
|
117817
117837
|
* @remarks
|
|
117818
117838
|
* [Api set: WordApi 1.5]
|
|
@@ -117827,7 +117847,7 @@ declare namespace Word {
|
|
|
117827
117847
|
*/
|
|
117828
117848
|
interface ContentControlExitedEventArgs {
|
|
117829
117849
|
/**
|
|
117830
|
-
*
|
|
117850
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117831
117851
|
*
|
|
117832
117852
|
* @remarks
|
|
117833
117853
|
* [Api set: WordApi 1.5]
|
|
@@ -117841,7 +117861,7 @@ declare namespace Word {
|
|
|
117841
117861
|
*/
|
|
117842
117862
|
ids: number[];
|
|
117843
117863
|
/**
|
|
117844
|
-
*
|
|
117864
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117845
117865
|
*
|
|
117846
117866
|
* @remarks
|
|
117847
117867
|
* [Api set: WordApi 1.5]
|
|
@@ -117942,7 +117962,7 @@ declare namespace Word {
|
|
|
117942
117962
|
*/
|
|
117943
117963
|
interface ContentControlSelectionChangedEventArgs {
|
|
117944
117964
|
/**
|
|
117945
|
-
*
|
|
117965
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117946
117966
|
*
|
|
117947
117967
|
* @remarks
|
|
117948
117968
|
* [Api set: WordApi 1.5]
|
|
@@ -117956,7 +117976,7 @@ declare namespace Word {
|
|
|
117956
117976
|
*/
|
|
117957
117977
|
ids: number[];
|
|
117958
117978
|
/**
|
|
117959
|
-
*
|
|
117979
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117960
117980
|
*
|
|
117961
117981
|
* @remarks
|
|
117962
117982
|
* [Api set: WordApi 1.5]
|
|
@@ -117971,14 +117991,14 @@ declare namespace Word {
|
|
|
117971
117991
|
*/
|
|
117972
117992
|
interface ParagraphAddedEventArgs {
|
|
117973
117993
|
/**
|
|
117974
|
-
*
|
|
117994
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117975
117995
|
*
|
|
117976
117996
|
* @remarks
|
|
117977
117997
|
* [Api set: WordApi 1.6]
|
|
117978
117998
|
*/
|
|
117979
117999
|
source: Word.EventSource | "Local" | "Remote";
|
|
117980
118000
|
/**
|
|
117981
|
-
*
|
|
118001
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117982
118002
|
*
|
|
117983
118003
|
* @remarks
|
|
117984
118004
|
* [Api set: WordApi 1.6]
|
|
@@ -118000,14 +118020,14 @@ declare namespace Word {
|
|
|
118000
118020
|
*/
|
|
118001
118021
|
interface ParagraphChangedEventArgs {
|
|
118002
118022
|
/**
|
|
118003
|
-
*
|
|
118023
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
118004
118024
|
*
|
|
118005
118025
|
* @remarks
|
|
118006
118026
|
* [Api set: WordApi 1.6]
|
|
118007
118027
|
*/
|
|
118008
118028
|
source: Word.EventSource | "Local" | "Remote";
|
|
118009
118029
|
/**
|
|
118010
|
-
*
|
|
118030
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
118011
118031
|
*
|
|
118012
118032
|
* @remarks
|
|
118013
118033
|
* [Api set: WordApi 1.6]
|
|
@@ -118029,14 +118049,14 @@ declare namespace Word {
|
|
|
118029
118049
|
*/
|
|
118030
118050
|
interface ParagraphDeletedEventArgs {
|
|
118031
118051
|
/**
|
|
118032
|
-
*
|
|
118052
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
118033
118053
|
*
|
|
118034
118054
|
* @remarks
|
|
118035
118055
|
* [Api set: WordApi 1.6]
|
|
118036
118056
|
*/
|
|
118037
118057
|
source: Word.EventSource | "Local" | "Remote";
|
|
118038
118058
|
/**
|
|
118039
|
-
*
|
|
118059
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
118040
118060
|
*
|
|
118041
118061
|
* @remarks
|
|
118042
118062
|
* [Api set: WordApi 1.6]
|
|
@@ -119007,7 +119027,7 @@ declare namespace Word {
|
|
|
119007
119027
|
mixed = "Mixed",
|
|
119008
119028
|
}
|
|
119009
119029
|
/**
|
|
119010
|
-
*
|
|
119030
|
+
* Represents the {@link Word.Border | border} type.
|
|
119011
119031
|
*
|
|
119012
119032
|
* @remarks
|
|
119013
119033
|
* [Api set: WordApi 1.3]
|
|
@@ -143036,7 +143056,7 @@ declare namespace Word {
|
|
|
143036
143056
|
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
143037
143057
|
interface ShapeUpdateData {
|
|
143038
143058
|
/**
|
|
143039
|
-
*
|
|
143059
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
143040
143060
|
*
|
|
143041
143061
|
* @remarks
|
|
143042
143062
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143106,35 +143126,35 @@ declare namespace Word {
|
|
|
143106
143126
|
*/
|
|
143107
143127
|
altTextDescription?: string;
|
|
143108
143128
|
/**
|
|
143109
|
-
*
|
|
143129
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
143110
143130
|
*
|
|
143111
143131
|
* @remarks
|
|
143112
143132
|
* [Api set: WordApiDesktop 1.2]
|
|
143113
143133
|
*/
|
|
143114
143134
|
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";
|
|
143115
143135
|
/**
|
|
143116
|
-
*
|
|
143136
|
+
* Specifies the height, in points, of the shape.
|
|
143117
143137
|
*
|
|
143118
143138
|
* @remarks
|
|
143119
143139
|
* [Api set: WordApiDesktop 1.2]
|
|
143120
143140
|
*/
|
|
143121
143141
|
height?: number;
|
|
143122
143142
|
/**
|
|
143123
|
-
*
|
|
143143
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
143124
143144
|
*
|
|
143125
143145
|
* @remarks
|
|
143126
143146
|
* [Api set: WordApiDesktop 1.2]
|
|
143127
143147
|
*/
|
|
143128
143148
|
heightRelative?: number;
|
|
143129
143149
|
/**
|
|
143130
|
-
*
|
|
143150
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). 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.
|
|
143131
143151
|
*
|
|
143132
143152
|
* @remarks
|
|
143133
143153
|
* [Api set: WordApiDesktop 1.2]
|
|
143134
143154
|
*/
|
|
143135
143155
|
left?: number;
|
|
143136
143156
|
/**
|
|
143137
|
-
*
|
|
143157
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
143138
143158
|
*
|
|
143139
143159
|
* @remarks
|
|
143140
143160
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143148,35 +143168,35 @@ declare namespace Word {
|
|
|
143148
143168
|
*/
|
|
143149
143169
|
lockAspectRatio?: boolean;
|
|
143150
143170
|
/**
|
|
143151
|
-
*
|
|
143171
|
+
* Specifies the name of the shape.
|
|
143152
143172
|
*
|
|
143153
143173
|
* @remarks
|
|
143154
143174
|
* [Api set: WordApiDesktop 1.2]
|
|
143155
143175
|
*/
|
|
143156
143176
|
name?: string;
|
|
143157
143177
|
/**
|
|
143158
|
-
*
|
|
143178
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
143159
143179
|
*
|
|
143160
143180
|
* @remarks
|
|
143161
143181
|
* [Api set: WordApiDesktop 1.2]
|
|
143162
143182
|
*/
|
|
143163
143183
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
143164
143184
|
/**
|
|
143165
|
-
*
|
|
143185
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
143166
143186
|
*
|
|
143167
143187
|
* @remarks
|
|
143168
143188
|
* [Api set: WordApiDesktop 1.2]
|
|
143169
143189
|
*/
|
|
143170
143190
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
143171
143191
|
/**
|
|
143172
|
-
*
|
|
143192
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
143173
143193
|
*
|
|
143174
143194
|
* @remarks
|
|
143175
143195
|
* [Api set: WordApiDesktop 1.2]
|
|
143176
143196
|
*/
|
|
143177
143197
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
143178
143198
|
/**
|
|
143179
|
-
*
|
|
143199
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
143180
143200
|
*
|
|
143181
143201
|
* @remarks
|
|
143182
143202
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143190,14 +143210,14 @@ declare namespace Word {
|
|
|
143190
143210
|
*/
|
|
143191
143211
|
rotation?: number;
|
|
143192
143212
|
/**
|
|
143193
|
-
*
|
|
143213
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). 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.
|
|
143194
143214
|
*
|
|
143195
143215
|
* @remarks
|
|
143196
143216
|
* [Api set: WordApiDesktop 1.2]
|
|
143197
143217
|
*/
|
|
143198
143218
|
top?: number;
|
|
143199
143219
|
/**
|
|
143200
|
-
*
|
|
143220
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
143201
143221
|
*
|
|
143202
143222
|
* @remarks
|
|
143203
143223
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143211,14 +143231,14 @@ declare namespace Word {
|
|
|
143211
143231
|
*/
|
|
143212
143232
|
visible?: boolean;
|
|
143213
143233
|
/**
|
|
143214
|
-
*
|
|
143234
|
+
* Specifies the width, in points, of the shape.
|
|
143215
143235
|
*
|
|
143216
143236
|
* @remarks
|
|
143217
143237
|
* [Api set: WordApiDesktop 1.2]
|
|
143218
143238
|
*/
|
|
143219
143239
|
width?: number;
|
|
143220
143240
|
/**
|
|
143221
|
-
*
|
|
143241
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
143222
143242
|
*
|
|
143223
143243
|
* @remarks
|
|
143224
143244
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150816,7 +150836,7 @@ declare namespace Word {
|
|
|
150816
150836
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
150817
150837
|
interface ShapeData {
|
|
150818
150838
|
/**
|
|
150819
|
-
*
|
|
150839
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
150820
150840
|
*
|
|
150821
150841
|
* @remarks
|
|
150822
150842
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150886,21 +150906,21 @@ declare namespace Word {
|
|
|
150886
150906
|
*/
|
|
150887
150907
|
altTextDescription?: string;
|
|
150888
150908
|
/**
|
|
150889
|
-
*
|
|
150909
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
150890
150910
|
*
|
|
150891
150911
|
* @remarks
|
|
150892
150912
|
* [Api set: WordApiDesktop 1.2]
|
|
150893
150913
|
*/
|
|
150894
150914
|
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";
|
|
150895
150915
|
/**
|
|
150896
|
-
*
|
|
150916
|
+
* Specifies the height, in points, of the shape.
|
|
150897
150917
|
*
|
|
150898
150918
|
* @remarks
|
|
150899
150919
|
* [Api set: WordApiDesktop 1.2]
|
|
150900
150920
|
*/
|
|
150901
150921
|
height?: number;
|
|
150902
150922
|
/**
|
|
150903
|
-
*
|
|
150923
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
150904
150924
|
*
|
|
150905
150925
|
* @remarks
|
|
150906
150926
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150921,14 +150941,14 @@ declare namespace Word {
|
|
|
150921
150941
|
*/
|
|
150922
150942
|
isChild?: boolean;
|
|
150923
150943
|
/**
|
|
150924
|
-
*
|
|
150944
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). 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.
|
|
150925
150945
|
*
|
|
150926
150946
|
* @remarks
|
|
150927
150947
|
* [Api set: WordApiDesktop 1.2]
|
|
150928
150948
|
*/
|
|
150929
150949
|
left?: number;
|
|
150930
150950
|
/**
|
|
150931
|
-
*
|
|
150951
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
150932
150952
|
*
|
|
150933
150953
|
* @remarks
|
|
150934
150954
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150942,35 +150962,35 @@ declare namespace Word {
|
|
|
150942
150962
|
*/
|
|
150943
150963
|
lockAspectRatio?: boolean;
|
|
150944
150964
|
/**
|
|
150945
|
-
*
|
|
150965
|
+
* Specifies the name of the shape.
|
|
150946
150966
|
*
|
|
150947
150967
|
* @remarks
|
|
150948
150968
|
* [Api set: WordApiDesktop 1.2]
|
|
150949
150969
|
*/
|
|
150950
150970
|
name?: string;
|
|
150951
150971
|
/**
|
|
150952
|
-
*
|
|
150972
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
150953
150973
|
*
|
|
150954
150974
|
* @remarks
|
|
150955
150975
|
* [Api set: WordApiDesktop 1.2]
|
|
150956
150976
|
*/
|
|
150957
150977
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
150958
150978
|
/**
|
|
150959
|
-
*
|
|
150979
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
150960
150980
|
*
|
|
150961
150981
|
* @remarks
|
|
150962
150982
|
* [Api set: WordApiDesktop 1.2]
|
|
150963
150983
|
*/
|
|
150964
150984
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
150965
150985
|
/**
|
|
150966
|
-
*
|
|
150986
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
150967
150987
|
*
|
|
150968
150988
|
* @remarks
|
|
150969
150989
|
* [Api set: WordApiDesktop 1.2]
|
|
150970
150990
|
*/
|
|
150971
150991
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
150972
150992
|
/**
|
|
150973
|
-
*
|
|
150993
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
150974
150994
|
*
|
|
150975
150995
|
* @remarks
|
|
150976
150996
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150984,14 +151004,14 @@ declare namespace Word {
|
|
|
150984
151004
|
*/
|
|
150985
151005
|
rotation?: number;
|
|
150986
151006
|
/**
|
|
150987
|
-
*
|
|
151007
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). 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.
|
|
150988
151008
|
*
|
|
150989
151009
|
* @remarks
|
|
150990
151010
|
* [Api set: WordApiDesktop 1.2]
|
|
150991
151011
|
*/
|
|
150992
151012
|
top?: number;
|
|
150993
151013
|
/**
|
|
150994
|
-
*
|
|
151014
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
150995
151015
|
*
|
|
150996
151016
|
* @remarks
|
|
150997
151017
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151012,14 +151032,14 @@ declare namespace Word {
|
|
|
151012
151032
|
*/
|
|
151013
151033
|
visible?: boolean;
|
|
151014
151034
|
/**
|
|
151015
|
-
*
|
|
151035
|
+
* Specifies the width, in points, of the shape.
|
|
151016
151036
|
*
|
|
151017
151037
|
* @remarks
|
|
151018
151038
|
* [Api set: WordApiDesktop 1.2]
|
|
151019
151039
|
*/
|
|
151020
151040
|
width?: number;
|
|
151021
151041
|
/**
|
|
151022
|
-
*
|
|
151042
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
151023
151043
|
*
|
|
151024
151044
|
* @remarks
|
|
151025
151045
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -154231,7 +154251,7 @@ declare namespace Word {
|
|
|
154231
154251
|
name?: boolean;
|
|
154232
154252
|
}
|
|
154233
154253
|
/**
|
|
154234
|
-
*
|
|
154254
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
154235
154255
|
*
|
|
154236
154256
|
* @remarks
|
|
154237
154257
|
* [Api set: WordApi 1.7]
|
|
@@ -156673,7 +156693,7 @@ declare namespace Word {
|
|
|
156673
156693
|
xmlSaveThroughXslt?: boolean;
|
|
156674
156694
|
}
|
|
156675
156695
|
/**
|
|
156676
|
-
* The `DocumentCreated` object is the top
|
|
156696
|
+
* The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
|
|
156677
156697
|
*
|
|
156678
156698
|
* @remarks
|
|
156679
156699
|
* [Api set: WordApi 1.3]
|
|
@@ -163370,7 +163390,7 @@ declare namespace Word {
|
|
|
163370
163390
|
*/
|
|
163371
163391
|
$all?: boolean;
|
|
163372
163392
|
/**
|
|
163373
|
-
*
|
|
163393
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
163374
163394
|
*
|
|
163375
163395
|
* @remarks
|
|
163376
163396
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163440,21 +163460,21 @@ declare namespace Word {
|
|
|
163440
163460
|
*/
|
|
163441
163461
|
altTextDescription?: boolean;
|
|
163442
163462
|
/**
|
|
163443
|
-
*
|
|
163463
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
163444
163464
|
*
|
|
163445
163465
|
* @remarks
|
|
163446
163466
|
* [Api set: WordApiDesktop 1.2]
|
|
163447
163467
|
*/
|
|
163448
163468
|
geometricShapeType?: boolean;
|
|
163449
163469
|
/**
|
|
163450
|
-
*
|
|
163470
|
+
* Specifies the height, in points, of the shape.
|
|
163451
163471
|
*
|
|
163452
163472
|
* @remarks
|
|
163453
163473
|
* [Api set: WordApiDesktop 1.2]
|
|
163454
163474
|
*/
|
|
163455
163475
|
height?: boolean;
|
|
163456
163476
|
/**
|
|
163457
|
-
*
|
|
163477
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
163458
163478
|
*
|
|
163459
163479
|
* @remarks
|
|
163460
163480
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163475,14 +163495,14 @@ declare namespace Word {
|
|
|
163475
163495
|
*/
|
|
163476
163496
|
isChild?: boolean;
|
|
163477
163497
|
/**
|
|
163478
|
-
*
|
|
163498
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). 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.
|
|
163479
163499
|
*
|
|
163480
163500
|
* @remarks
|
|
163481
163501
|
* [Api set: WordApiDesktop 1.2]
|
|
163482
163502
|
*/
|
|
163483
163503
|
left?: boolean;
|
|
163484
163504
|
/**
|
|
163485
|
-
*
|
|
163505
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
163486
163506
|
*
|
|
163487
163507
|
* @remarks
|
|
163488
163508
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163496,35 +163516,35 @@ declare namespace Word {
|
|
|
163496
163516
|
*/
|
|
163497
163517
|
lockAspectRatio?: boolean;
|
|
163498
163518
|
/**
|
|
163499
|
-
*
|
|
163519
|
+
* Specifies the name of the shape.
|
|
163500
163520
|
*
|
|
163501
163521
|
* @remarks
|
|
163502
163522
|
* [Api set: WordApiDesktop 1.2]
|
|
163503
163523
|
*/
|
|
163504
163524
|
name?: boolean;
|
|
163505
163525
|
/**
|
|
163506
|
-
*
|
|
163526
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
163507
163527
|
*
|
|
163508
163528
|
* @remarks
|
|
163509
163529
|
* [Api set: WordApiDesktop 1.2]
|
|
163510
163530
|
*/
|
|
163511
163531
|
relativeHorizontalPosition?: boolean;
|
|
163512
163532
|
/**
|
|
163513
|
-
*
|
|
163533
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
163514
163534
|
*
|
|
163515
163535
|
* @remarks
|
|
163516
163536
|
* [Api set: WordApiDesktop 1.2]
|
|
163517
163537
|
*/
|
|
163518
163538
|
relativeHorizontalSize?: boolean;
|
|
163519
163539
|
/**
|
|
163520
|
-
*
|
|
163540
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
163521
163541
|
*
|
|
163522
163542
|
* @remarks
|
|
163523
163543
|
* [Api set: WordApiDesktop 1.2]
|
|
163524
163544
|
*/
|
|
163525
163545
|
relativeVerticalPosition?: boolean;
|
|
163526
163546
|
/**
|
|
163527
|
-
*
|
|
163547
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
163528
163548
|
*
|
|
163529
163549
|
* @remarks
|
|
163530
163550
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163538,14 +163558,14 @@ declare namespace Word {
|
|
|
163538
163558
|
*/
|
|
163539
163559
|
rotation?: boolean;
|
|
163540
163560
|
/**
|
|
163541
|
-
*
|
|
163561
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). 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.
|
|
163542
163562
|
*
|
|
163543
163563
|
* @remarks
|
|
163544
163564
|
* [Api set: WordApiDesktop 1.2]
|
|
163545
163565
|
*/
|
|
163546
163566
|
top?: boolean;
|
|
163547
163567
|
/**
|
|
163548
|
-
*
|
|
163568
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
163549
163569
|
*
|
|
163550
163570
|
* @remarks
|
|
163551
163571
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163566,14 +163586,14 @@ declare namespace Word {
|
|
|
163566
163586
|
*/
|
|
163567
163587
|
visible?: boolean;
|
|
163568
163588
|
/**
|
|
163569
|
-
*
|
|
163589
|
+
* Specifies the width, in points, of the shape.
|
|
163570
163590
|
*
|
|
163571
163591
|
* @remarks
|
|
163572
163592
|
* [Api set: WordApiDesktop 1.2]
|
|
163573
163593
|
*/
|
|
163574
163594
|
width?: boolean;
|
|
163575
163595
|
/**
|
|
163576
|
-
*
|
|
163596
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
163577
163597
|
*
|
|
163578
163598
|
* @remarks
|
|
163579
163599
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163644,7 +163664,7 @@ declare namespace Word {
|
|
|
163644
163664
|
*/
|
|
163645
163665
|
$all?: boolean;
|
|
163646
163666
|
/**
|
|
163647
|
-
* For EACH ITEM in the collection:
|
|
163667
|
+
* For EACH ITEM in the collection: Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
163648
163668
|
*
|
|
163649
163669
|
* @remarks
|
|
163650
163670
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163714,21 +163734,21 @@ declare namespace Word {
|
|
|
163714
163734
|
*/
|
|
163715
163735
|
altTextDescription?: boolean;
|
|
163716
163736
|
/**
|
|
163717
|
-
* For EACH ITEM in the collection:
|
|
163737
|
+
* For EACH ITEM in the collection: Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
163718
163738
|
*
|
|
163719
163739
|
* @remarks
|
|
163720
163740
|
* [Api set: WordApiDesktop 1.2]
|
|
163721
163741
|
*/
|
|
163722
163742
|
geometricShapeType?: boolean;
|
|
163723
163743
|
/**
|
|
163724
|
-
* For EACH ITEM in the collection:
|
|
163744
|
+
* For EACH ITEM in the collection: Specifies the height, in points, of the shape.
|
|
163725
163745
|
*
|
|
163726
163746
|
* @remarks
|
|
163727
163747
|
* [Api set: WordApiDesktop 1.2]
|
|
163728
163748
|
*/
|
|
163729
163749
|
height?: boolean;
|
|
163730
163750
|
/**
|
|
163731
|
-
* For EACH ITEM in the collection:
|
|
163751
|
+
* For EACH ITEM in the collection: Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
163732
163752
|
*
|
|
163733
163753
|
* @remarks
|
|
163734
163754
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163749,14 +163769,14 @@ declare namespace Word {
|
|
|
163749
163769
|
*/
|
|
163750
163770
|
isChild?: boolean;
|
|
163751
163771
|
/**
|
|
163752
|
-
* For EACH ITEM in the collection:
|
|
163772
|
+
* For EACH ITEM in the collection: Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). 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.
|
|
163753
163773
|
*
|
|
163754
163774
|
* @remarks
|
|
163755
163775
|
* [Api set: WordApiDesktop 1.2]
|
|
163756
163776
|
*/
|
|
163757
163777
|
left?: boolean;
|
|
163758
163778
|
/**
|
|
163759
|
-
* For EACH ITEM in the collection:
|
|
163779
|
+
* For EACH ITEM in the collection: Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
163760
163780
|
*
|
|
163761
163781
|
* @remarks
|
|
163762
163782
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163770,35 +163790,35 @@ declare namespace Word {
|
|
|
163770
163790
|
*/
|
|
163771
163791
|
lockAspectRatio?: boolean;
|
|
163772
163792
|
/**
|
|
163773
|
-
* For EACH ITEM in the collection:
|
|
163793
|
+
* For EACH ITEM in the collection: Specifies the name of the shape.
|
|
163774
163794
|
*
|
|
163775
163795
|
* @remarks
|
|
163776
163796
|
* [Api set: WordApiDesktop 1.2]
|
|
163777
163797
|
*/
|
|
163778
163798
|
name?: boolean;
|
|
163779
163799
|
/**
|
|
163780
|
-
* For EACH ITEM in the collection:
|
|
163800
|
+
* For EACH ITEM in the collection: Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
163781
163801
|
*
|
|
163782
163802
|
* @remarks
|
|
163783
163803
|
* [Api set: WordApiDesktop 1.2]
|
|
163784
163804
|
*/
|
|
163785
163805
|
relativeHorizontalPosition?: boolean;
|
|
163786
163806
|
/**
|
|
163787
|
-
* For EACH ITEM in the collection:
|
|
163807
|
+
* For EACH ITEM in the collection: Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
163788
163808
|
*
|
|
163789
163809
|
* @remarks
|
|
163790
163810
|
* [Api set: WordApiDesktop 1.2]
|
|
163791
163811
|
*/
|
|
163792
163812
|
relativeHorizontalSize?: boolean;
|
|
163793
163813
|
/**
|
|
163794
|
-
* For EACH ITEM in the collection:
|
|
163814
|
+
* For EACH ITEM in the collection: Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
163795
163815
|
*
|
|
163796
163816
|
* @remarks
|
|
163797
163817
|
* [Api set: WordApiDesktop 1.2]
|
|
163798
163818
|
*/
|
|
163799
163819
|
relativeVerticalPosition?: boolean;
|
|
163800
163820
|
/**
|
|
163801
|
-
* For EACH ITEM in the collection:
|
|
163821
|
+
* For EACH ITEM in the collection: Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
163802
163822
|
*
|
|
163803
163823
|
* @remarks
|
|
163804
163824
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163812,14 +163832,14 @@ declare namespace Word {
|
|
|
163812
163832
|
*/
|
|
163813
163833
|
rotation?: boolean;
|
|
163814
163834
|
/**
|
|
163815
|
-
* For EACH ITEM in the collection:
|
|
163835
|
+
* For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). 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.
|
|
163816
163836
|
*
|
|
163817
163837
|
* @remarks
|
|
163818
163838
|
* [Api set: WordApiDesktop 1.2]
|
|
163819
163839
|
*/
|
|
163820
163840
|
top?: boolean;
|
|
163821
163841
|
/**
|
|
163822
|
-
* For EACH ITEM in the collection:
|
|
163842
|
+
* For EACH ITEM in the collection: Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
163823
163843
|
*
|
|
163824
163844
|
* @remarks
|
|
163825
163845
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163840,14 +163860,14 @@ declare namespace Word {
|
|
|
163840
163860
|
*/
|
|
163841
163861
|
visible?: boolean;
|
|
163842
163862
|
/**
|
|
163843
|
-
* For EACH ITEM in the collection:
|
|
163863
|
+
* For EACH ITEM in the collection: Specifies the width, in points, of the shape.
|
|
163844
163864
|
*
|
|
163845
163865
|
* @remarks
|
|
163846
163866
|
* [Api set: WordApiDesktop 1.2]
|
|
163847
163867
|
*/
|
|
163848
163868
|
width?: boolean;
|
|
163849
163869
|
/**
|
|
163850
|
-
* For EACH ITEM in the collection:
|
|
163870
|
+
* For EACH ITEM in the collection: Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
163851
163871
|
*
|
|
163852
163872
|
* @remarks
|
|
163853
163873
|
* [Api set: WordApiDesktop 1.2]
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.562",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "5e2461c2eb3fdfcda51fdc575cf6ad2b02431eb3897019f8ed765eac2230f26a",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|