@types/office-js 1.0.561 → 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 +100 -100
- 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
|
@@ -96574,7 +96574,7 @@ declare namespace Word {
|
|
|
96574
96574
|
};
|
|
96575
96575
|
}
|
|
96576
96576
|
/**
|
|
96577
|
-
*
|
|
96577
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
96578
96578
|
*
|
|
96579
96579
|
* @remarks
|
|
96580
96580
|
* [Api set: WordApi 1.7]
|
|
@@ -102101,7 +102101,7 @@ declare namespace Word {
|
|
|
102101
102101
|
toJSON(): Word.Interfaces.DocumentData;
|
|
102102
102102
|
}
|
|
102103
102103
|
/**
|
|
102104
|
-
* 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.
|
|
102105
102105
|
*
|
|
102106
102106
|
* @remarks
|
|
102107
102107
|
* [Api set: WordApi 1.3]
|
|
@@ -102492,7 +102492,7 @@ declare namespace Word {
|
|
|
102492
102492
|
toJSON(): Word.Interfaces.DocumentPropertiesData;
|
|
102493
102493
|
}
|
|
102494
102494
|
/**
|
|
102495
|
-
*
|
|
102495
|
+
* Represents the data specific to content controls of type `dropDownList`.
|
|
102496
102496
|
*
|
|
102497
102497
|
* @remarks
|
|
102498
102498
|
* [Api set: WordApi 1.9]
|
|
@@ -102555,7 +102555,7 @@ declare namespace Word {
|
|
|
102555
102555
|
toJSON(): Word.Interfaces.DropDownListContentControlData;
|
|
102556
102556
|
}
|
|
102557
102557
|
/**
|
|
102558
|
-
*
|
|
102558
|
+
* Represents the data specific to content controls of type `comboBox`.
|
|
102559
102559
|
*
|
|
102560
102560
|
* @remarks
|
|
102561
102561
|
* [Api set: WordApi 1.9]
|
|
@@ -113712,7 +113712,7 @@ declare namespace Word {
|
|
|
113712
113712
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
113713
113713
|
context: RequestContext;
|
|
113714
113714
|
/**
|
|
113715
|
-
*
|
|
113715
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
113716
113716
|
*
|
|
113717
113717
|
* @remarks
|
|
113718
113718
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113782,21 +113782,21 @@ declare namespace Word {
|
|
|
113782
113782
|
*/
|
|
113783
113783
|
altTextDescription: string;
|
|
113784
113784
|
/**
|
|
113785
|
-
*
|
|
113785
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
113786
113786
|
*
|
|
113787
113787
|
* @remarks
|
|
113788
113788
|
* [Api set: WordApiDesktop 1.2]
|
|
113789
113789
|
*/
|
|
113790
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";
|
|
113791
113791
|
/**
|
|
113792
|
-
*
|
|
113792
|
+
* Specifies the height, in points, of the shape.
|
|
113793
113793
|
*
|
|
113794
113794
|
* @remarks
|
|
113795
113795
|
* [Api set: WordApiDesktop 1.2]
|
|
113796
113796
|
*/
|
|
113797
113797
|
height: number;
|
|
113798
113798
|
/**
|
|
113799
|
-
*
|
|
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.
|
|
113800
113800
|
*
|
|
113801
113801
|
* @remarks
|
|
113802
113802
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113817,14 +113817,14 @@ declare namespace Word {
|
|
|
113817
113817
|
*/
|
|
113818
113818
|
readonly isChild: boolean;
|
|
113819
113819
|
/**
|
|
113820
|
-
*
|
|
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.
|
|
113821
113821
|
*
|
|
113822
113822
|
* @remarks
|
|
113823
113823
|
* [Api set: WordApiDesktop 1.2]
|
|
113824
113824
|
*/
|
|
113825
113825
|
left: number;
|
|
113826
113826
|
/**
|
|
113827
|
-
*
|
|
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.
|
|
113828
113828
|
*
|
|
113829
113829
|
* @remarks
|
|
113830
113830
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113838,35 +113838,35 @@ declare namespace Word {
|
|
|
113838
113838
|
*/
|
|
113839
113839
|
lockAspectRatio: boolean;
|
|
113840
113840
|
/**
|
|
113841
|
-
*
|
|
113841
|
+
* Specifies the name of the shape.
|
|
113842
113842
|
*
|
|
113843
113843
|
* @remarks
|
|
113844
113844
|
* [Api set: WordApiDesktop 1.2]
|
|
113845
113845
|
*/
|
|
113846
113846
|
name: string;
|
|
113847
113847
|
/**
|
|
113848
|
-
*
|
|
113848
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
113849
113849
|
*
|
|
113850
113850
|
* @remarks
|
|
113851
113851
|
* [Api set: WordApiDesktop 1.2]
|
|
113852
113852
|
*/
|
|
113853
113853
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
113854
113854
|
/**
|
|
113855
|
-
*
|
|
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.
|
|
113856
113856
|
*
|
|
113857
113857
|
* @remarks
|
|
113858
113858
|
* [Api set: WordApiDesktop 1.2]
|
|
113859
113859
|
*/
|
|
113860
113860
|
relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
113861
113861
|
/**
|
|
113862
|
-
*
|
|
113862
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
113863
113863
|
*
|
|
113864
113864
|
* @remarks
|
|
113865
113865
|
* [Api set: WordApiDesktop 1.2]
|
|
113866
113866
|
*/
|
|
113867
113867
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
113868
113868
|
/**
|
|
113869
|
-
*
|
|
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.
|
|
113870
113870
|
*
|
|
113871
113871
|
* @remarks
|
|
113872
113872
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113880,14 +113880,14 @@ declare namespace Word {
|
|
|
113880
113880
|
*/
|
|
113881
113881
|
rotation: number;
|
|
113882
113882
|
/**
|
|
113883
|
-
*
|
|
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.
|
|
113884
113884
|
*
|
|
113885
113885
|
* @remarks
|
|
113886
113886
|
* [Api set: WordApiDesktop 1.2]
|
|
113887
113887
|
*/
|
|
113888
113888
|
top: number;
|
|
113889
113889
|
/**
|
|
113890
|
-
*
|
|
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.
|
|
113891
113891
|
*
|
|
113892
113892
|
* @remarks
|
|
113893
113893
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -113908,14 +113908,14 @@ declare namespace Word {
|
|
|
113908
113908
|
*/
|
|
113909
113909
|
visible: boolean;
|
|
113910
113910
|
/**
|
|
113911
|
-
*
|
|
113911
|
+
* Specifies the width, in points, of the shape.
|
|
113912
113912
|
*
|
|
113913
113913
|
* @remarks
|
|
113914
113914
|
* [Api set: WordApiDesktop 1.2]
|
|
113915
113915
|
*/
|
|
113916
113916
|
width: number;
|
|
113917
113917
|
/**
|
|
113918
|
-
*
|
|
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.
|
|
113919
113919
|
*
|
|
113920
113920
|
* @remarks
|
|
113921
113921
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -117731,7 +117731,7 @@ declare namespace Word {
|
|
|
117731
117731
|
*/
|
|
117732
117732
|
interface ContentControlAddedEventArgs {
|
|
117733
117733
|
/**
|
|
117734
|
-
*
|
|
117734
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117735
117735
|
*
|
|
117736
117736
|
* @remarks
|
|
117737
117737
|
* [Api set: WordApi 1.5]
|
|
@@ -117745,7 +117745,7 @@ declare namespace Word {
|
|
|
117745
117745
|
*/
|
|
117746
117746
|
ids: number[];
|
|
117747
117747
|
/**
|
|
117748
|
-
*
|
|
117748
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117749
117749
|
*
|
|
117750
117750
|
* @remarks
|
|
117751
117751
|
* [Api set: WordApi 1.5]
|
|
@@ -117760,7 +117760,7 @@ declare namespace Word {
|
|
|
117760
117760
|
*/
|
|
117761
117761
|
interface ContentControlDataChangedEventArgs {
|
|
117762
117762
|
/**
|
|
117763
|
-
*
|
|
117763
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117764
117764
|
*
|
|
117765
117765
|
* @remarks
|
|
117766
117766
|
* [Api set: WordApi 1.5]
|
|
@@ -117774,7 +117774,7 @@ declare namespace Word {
|
|
|
117774
117774
|
*/
|
|
117775
117775
|
ids: number[];
|
|
117776
117776
|
/**
|
|
117777
|
-
*
|
|
117777
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117778
117778
|
*
|
|
117779
117779
|
* @remarks
|
|
117780
117780
|
* [Api set: WordApi 1.5]
|
|
@@ -117789,7 +117789,7 @@ declare namespace Word {
|
|
|
117789
117789
|
*/
|
|
117790
117790
|
interface ContentControlDeletedEventArgs {
|
|
117791
117791
|
/**
|
|
117792
|
-
*
|
|
117792
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117793
117793
|
*
|
|
117794
117794
|
* @remarks
|
|
117795
117795
|
* [Api set: WordApi 1.5]
|
|
@@ -117803,7 +117803,7 @@ declare namespace Word {
|
|
|
117803
117803
|
*/
|
|
117804
117804
|
ids: number[];
|
|
117805
117805
|
/**
|
|
117806
|
-
*
|
|
117806
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117807
117807
|
*
|
|
117808
117808
|
* @remarks
|
|
117809
117809
|
* [Api set: WordApi 1.5]
|
|
@@ -117818,7 +117818,7 @@ declare namespace Word {
|
|
|
117818
117818
|
*/
|
|
117819
117819
|
interface ContentControlEnteredEventArgs {
|
|
117820
117820
|
/**
|
|
117821
|
-
*
|
|
117821
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117822
117822
|
*
|
|
117823
117823
|
* @remarks
|
|
117824
117824
|
* [Api set: WordApi 1.5]
|
|
@@ -117832,7 +117832,7 @@ declare namespace Word {
|
|
|
117832
117832
|
*/
|
|
117833
117833
|
ids: number[];
|
|
117834
117834
|
/**
|
|
117835
|
-
*
|
|
117835
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117836
117836
|
*
|
|
117837
117837
|
* @remarks
|
|
117838
117838
|
* [Api set: WordApi 1.5]
|
|
@@ -117847,7 +117847,7 @@ declare namespace Word {
|
|
|
117847
117847
|
*/
|
|
117848
117848
|
interface ContentControlExitedEventArgs {
|
|
117849
117849
|
/**
|
|
117850
|
-
*
|
|
117850
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117851
117851
|
*
|
|
117852
117852
|
* @remarks
|
|
117853
117853
|
* [Api set: WordApi 1.5]
|
|
@@ -117861,7 +117861,7 @@ declare namespace Word {
|
|
|
117861
117861
|
*/
|
|
117862
117862
|
ids: number[];
|
|
117863
117863
|
/**
|
|
117864
|
-
*
|
|
117864
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117865
117865
|
*
|
|
117866
117866
|
* @remarks
|
|
117867
117867
|
* [Api set: WordApi 1.5]
|
|
@@ -117962,7 +117962,7 @@ declare namespace Word {
|
|
|
117962
117962
|
*/
|
|
117963
117963
|
interface ContentControlSelectionChangedEventArgs {
|
|
117964
117964
|
/**
|
|
117965
|
-
*
|
|
117965
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
117966
117966
|
*
|
|
117967
117967
|
* @remarks
|
|
117968
117968
|
* [Api set: WordApi 1.5]
|
|
@@ -117976,7 +117976,7 @@ declare namespace Word {
|
|
|
117976
117976
|
*/
|
|
117977
117977
|
ids: number[];
|
|
117978
117978
|
/**
|
|
117979
|
-
*
|
|
117979
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117980
117980
|
*
|
|
117981
117981
|
* @remarks
|
|
117982
117982
|
* [Api set: WordApi 1.5]
|
|
@@ -117991,14 +117991,14 @@ declare namespace Word {
|
|
|
117991
117991
|
*/
|
|
117992
117992
|
interface ParagraphAddedEventArgs {
|
|
117993
117993
|
/**
|
|
117994
|
-
*
|
|
117994
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
117995
117995
|
*
|
|
117996
117996
|
* @remarks
|
|
117997
117997
|
* [Api set: WordApi 1.6]
|
|
117998
117998
|
*/
|
|
117999
117999
|
source: Word.EventSource | "Local" | "Remote";
|
|
118000
118000
|
/**
|
|
118001
|
-
*
|
|
118001
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
118002
118002
|
*
|
|
118003
118003
|
* @remarks
|
|
118004
118004
|
* [Api set: WordApi 1.6]
|
|
@@ -118020,14 +118020,14 @@ declare namespace Word {
|
|
|
118020
118020
|
*/
|
|
118021
118021
|
interface ParagraphChangedEventArgs {
|
|
118022
118022
|
/**
|
|
118023
|
-
*
|
|
118023
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
118024
118024
|
*
|
|
118025
118025
|
* @remarks
|
|
118026
118026
|
* [Api set: WordApi 1.6]
|
|
118027
118027
|
*/
|
|
118028
118028
|
source: Word.EventSource | "Local" | "Remote";
|
|
118029
118029
|
/**
|
|
118030
|
-
*
|
|
118030
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
118031
118031
|
*
|
|
118032
118032
|
* @remarks
|
|
118033
118033
|
* [Api set: WordApi 1.6]
|
|
@@ -118049,14 +118049,14 @@ declare namespace Word {
|
|
|
118049
118049
|
*/
|
|
118050
118050
|
interface ParagraphDeletedEventArgs {
|
|
118051
118051
|
/**
|
|
118052
|
-
*
|
|
118052
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
118053
118053
|
*
|
|
118054
118054
|
* @remarks
|
|
118055
118055
|
* [Api set: WordApi 1.6]
|
|
118056
118056
|
*/
|
|
118057
118057
|
source: Word.EventSource | "Local" | "Remote";
|
|
118058
118058
|
/**
|
|
118059
|
-
*
|
|
118059
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
118060
118060
|
*
|
|
118061
118061
|
* @remarks
|
|
118062
118062
|
* [Api set: WordApi 1.6]
|
|
@@ -119027,7 +119027,7 @@ declare namespace Word {
|
|
|
119027
119027
|
mixed = "Mixed",
|
|
119028
119028
|
}
|
|
119029
119029
|
/**
|
|
119030
|
-
*
|
|
119030
|
+
* Represents the {@link Word.Border | border} type.
|
|
119031
119031
|
*
|
|
119032
119032
|
* @remarks
|
|
119033
119033
|
* [Api set: WordApi 1.3]
|
|
@@ -143056,7 +143056,7 @@ declare namespace Word {
|
|
|
143056
143056
|
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
143057
143057
|
interface ShapeUpdateData {
|
|
143058
143058
|
/**
|
|
143059
|
-
*
|
|
143059
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
143060
143060
|
*
|
|
143061
143061
|
* @remarks
|
|
143062
143062
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143126,35 +143126,35 @@ declare namespace Word {
|
|
|
143126
143126
|
*/
|
|
143127
143127
|
altTextDescription?: string;
|
|
143128
143128
|
/**
|
|
143129
|
-
*
|
|
143129
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
143130
143130
|
*
|
|
143131
143131
|
* @remarks
|
|
143132
143132
|
* [Api set: WordApiDesktop 1.2]
|
|
143133
143133
|
*/
|
|
143134
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";
|
|
143135
143135
|
/**
|
|
143136
|
-
*
|
|
143136
|
+
* Specifies the height, in points, of the shape.
|
|
143137
143137
|
*
|
|
143138
143138
|
* @remarks
|
|
143139
143139
|
* [Api set: WordApiDesktop 1.2]
|
|
143140
143140
|
*/
|
|
143141
143141
|
height?: number;
|
|
143142
143142
|
/**
|
|
143143
|
-
*
|
|
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.
|
|
143144
143144
|
*
|
|
143145
143145
|
* @remarks
|
|
143146
143146
|
* [Api set: WordApiDesktop 1.2]
|
|
143147
143147
|
*/
|
|
143148
143148
|
heightRelative?: number;
|
|
143149
143149
|
/**
|
|
143150
|
-
*
|
|
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.
|
|
143151
143151
|
*
|
|
143152
143152
|
* @remarks
|
|
143153
143153
|
* [Api set: WordApiDesktop 1.2]
|
|
143154
143154
|
*/
|
|
143155
143155
|
left?: number;
|
|
143156
143156
|
/**
|
|
143157
|
-
*
|
|
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.
|
|
143158
143158
|
*
|
|
143159
143159
|
* @remarks
|
|
143160
143160
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143168,35 +143168,35 @@ declare namespace Word {
|
|
|
143168
143168
|
*/
|
|
143169
143169
|
lockAspectRatio?: boolean;
|
|
143170
143170
|
/**
|
|
143171
|
-
*
|
|
143171
|
+
* Specifies the name of the shape.
|
|
143172
143172
|
*
|
|
143173
143173
|
* @remarks
|
|
143174
143174
|
* [Api set: WordApiDesktop 1.2]
|
|
143175
143175
|
*/
|
|
143176
143176
|
name?: string;
|
|
143177
143177
|
/**
|
|
143178
|
-
*
|
|
143178
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
143179
143179
|
*
|
|
143180
143180
|
* @remarks
|
|
143181
143181
|
* [Api set: WordApiDesktop 1.2]
|
|
143182
143182
|
*/
|
|
143183
143183
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
143184
143184
|
/**
|
|
143185
|
-
*
|
|
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.
|
|
143186
143186
|
*
|
|
143187
143187
|
* @remarks
|
|
143188
143188
|
* [Api set: WordApiDesktop 1.2]
|
|
143189
143189
|
*/
|
|
143190
143190
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
143191
143191
|
/**
|
|
143192
|
-
*
|
|
143192
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
143193
143193
|
*
|
|
143194
143194
|
* @remarks
|
|
143195
143195
|
* [Api set: WordApiDesktop 1.2]
|
|
143196
143196
|
*/
|
|
143197
143197
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
143198
143198
|
/**
|
|
143199
|
-
*
|
|
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.
|
|
143200
143200
|
*
|
|
143201
143201
|
* @remarks
|
|
143202
143202
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143210,14 +143210,14 @@ declare namespace Word {
|
|
|
143210
143210
|
*/
|
|
143211
143211
|
rotation?: number;
|
|
143212
143212
|
/**
|
|
143213
|
-
*
|
|
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.
|
|
143214
143214
|
*
|
|
143215
143215
|
* @remarks
|
|
143216
143216
|
* [Api set: WordApiDesktop 1.2]
|
|
143217
143217
|
*/
|
|
143218
143218
|
top?: number;
|
|
143219
143219
|
/**
|
|
143220
|
-
*
|
|
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.
|
|
143221
143221
|
*
|
|
143222
143222
|
* @remarks
|
|
143223
143223
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -143231,14 +143231,14 @@ declare namespace Word {
|
|
|
143231
143231
|
*/
|
|
143232
143232
|
visible?: boolean;
|
|
143233
143233
|
/**
|
|
143234
|
-
*
|
|
143234
|
+
* Specifies the width, in points, of the shape.
|
|
143235
143235
|
*
|
|
143236
143236
|
* @remarks
|
|
143237
143237
|
* [Api set: WordApiDesktop 1.2]
|
|
143238
143238
|
*/
|
|
143239
143239
|
width?: number;
|
|
143240
143240
|
/**
|
|
143241
|
-
*
|
|
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.
|
|
143242
143242
|
*
|
|
143243
143243
|
* @remarks
|
|
143244
143244
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150836,7 +150836,7 @@ declare namespace Word {
|
|
|
150836
150836
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
150837
150837
|
interface ShapeData {
|
|
150838
150838
|
/**
|
|
150839
|
-
*
|
|
150839
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
150840
150840
|
*
|
|
150841
150841
|
* @remarks
|
|
150842
150842
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150906,21 +150906,21 @@ declare namespace Word {
|
|
|
150906
150906
|
*/
|
|
150907
150907
|
altTextDescription?: string;
|
|
150908
150908
|
/**
|
|
150909
|
-
*
|
|
150909
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
150910
150910
|
*
|
|
150911
150911
|
* @remarks
|
|
150912
150912
|
* [Api set: WordApiDesktop 1.2]
|
|
150913
150913
|
*/
|
|
150914
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";
|
|
150915
150915
|
/**
|
|
150916
|
-
*
|
|
150916
|
+
* Specifies the height, in points, of the shape.
|
|
150917
150917
|
*
|
|
150918
150918
|
* @remarks
|
|
150919
150919
|
* [Api set: WordApiDesktop 1.2]
|
|
150920
150920
|
*/
|
|
150921
150921
|
height?: number;
|
|
150922
150922
|
/**
|
|
150923
|
-
*
|
|
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.
|
|
150924
150924
|
*
|
|
150925
150925
|
* @remarks
|
|
150926
150926
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150941,14 +150941,14 @@ declare namespace Word {
|
|
|
150941
150941
|
*/
|
|
150942
150942
|
isChild?: boolean;
|
|
150943
150943
|
/**
|
|
150944
|
-
*
|
|
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.
|
|
150945
150945
|
*
|
|
150946
150946
|
* @remarks
|
|
150947
150947
|
* [Api set: WordApiDesktop 1.2]
|
|
150948
150948
|
*/
|
|
150949
150949
|
left?: number;
|
|
150950
150950
|
/**
|
|
150951
|
-
*
|
|
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.
|
|
150952
150952
|
*
|
|
150953
150953
|
* @remarks
|
|
150954
150954
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -150962,35 +150962,35 @@ declare namespace Word {
|
|
|
150962
150962
|
*/
|
|
150963
150963
|
lockAspectRatio?: boolean;
|
|
150964
150964
|
/**
|
|
150965
|
-
*
|
|
150965
|
+
* Specifies the name of the shape.
|
|
150966
150966
|
*
|
|
150967
150967
|
* @remarks
|
|
150968
150968
|
* [Api set: WordApiDesktop 1.2]
|
|
150969
150969
|
*/
|
|
150970
150970
|
name?: string;
|
|
150971
150971
|
/**
|
|
150972
|
-
*
|
|
150972
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
150973
150973
|
*
|
|
150974
150974
|
* @remarks
|
|
150975
150975
|
* [Api set: WordApiDesktop 1.2]
|
|
150976
150976
|
*/
|
|
150977
150977
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
150978
150978
|
/**
|
|
150979
|
-
*
|
|
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.
|
|
150980
150980
|
*
|
|
150981
150981
|
* @remarks
|
|
150982
150982
|
* [Api set: WordApiDesktop 1.2]
|
|
150983
150983
|
*/
|
|
150984
150984
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
150985
150985
|
/**
|
|
150986
|
-
*
|
|
150986
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
150987
150987
|
*
|
|
150988
150988
|
* @remarks
|
|
150989
150989
|
* [Api set: WordApiDesktop 1.2]
|
|
150990
150990
|
*/
|
|
150991
150991
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
150992
150992
|
/**
|
|
150993
|
-
*
|
|
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.
|
|
150994
150994
|
*
|
|
150995
150995
|
* @remarks
|
|
150996
150996
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151004,14 +151004,14 @@ declare namespace Word {
|
|
|
151004
151004
|
*/
|
|
151005
151005
|
rotation?: number;
|
|
151006
151006
|
/**
|
|
151007
|
-
*
|
|
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.
|
|
151008
151008
|
*
|
|
151009
151009
|
* @remarks
|
|
151010
151010
|
* [Api set: WordApiDesktop 1.2]
|
|
151011
151011
|
*/
|
|
151012
151012
|
top?: number;
|
|
151013
151013
|
/**
|
|
151014
|
-
*
|
|
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.
|
|
151015
151015
|
*
|
|
151016
151016
|
* @remarks
|
|
151017
151017
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151032,14 +151032,14 @@ declare namespace Word {
|
|
|
151032
151032
|
*/
|
|
151033
151033
|
visible?: boolean;
|
|
151034
151034
|
/**
|
|
151035
|
-
*
|
|
151035
|
+
* Specifies the width, in points, of the shape.
|
|
151036
151036
|
*
|
|
151037
151037
|
* @remarks
|
|
151038
151038
|
* [Api set: WordApiDesktop 1.2]
|
|
151039
151039
|
*/
|
|
151040
151040
|
width?: number;
|
|
151041
151041
|
/**
|
|
151042
|
-
*
|
|
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.
|
|
151043
151043
|
*
|
|
151044
151044
|
* @remarks
|
|
151045
151045
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -154251,7 +154251,7 @@ declare namespace Word {
|
|
|
154251
154251
|
name?: boolean;
|
|
154252
154252
|
}
|
|
154253
154253
|
/**
|
|
154254
|
-
*
|
|
154254
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
154255
154255
|
*
|
|
154256
154256
|
* @remarks
|
|
154257
154257
|
* [Api set: WordApi 1.7]
|
|
@@ -156693,7 +156693,7 @@ declare namespace Word {
|
|
|
156693
156693
|
xmlSaveThroughXslt?: boolean;
|
|
156694
156694
|
}
|
|
156695
156695
|
/**
|
|
156696
|
-
* 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.
|
|
156697
156697
|
*
|
|
156698
156698
|
* @remarks
|
|
156699
156699
|
* [Api set: WordApi 1.3]
|
|
@@ -163390,7 +163390,7 @@ declare namespace Word {
|
|
|
163390
163390
|
*/
|
|
163391
163391
|
$all?: boolean;
|
|
163392
163392
|
/**
|
|
163393
|
-
*
|
|
163393
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
163394
163394
|
*
|
|
163395
163395
|
* @remarks
|
|
163396
163396
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163460,21 +163460,21 @@ declare namespace Word {
|
|
|
163460
163460
|
*/
|
|
163461
163461
|
altTextDescription?: boolean;
|
|
163462
163462
|
/**
|
|
163463
|
-
*
|
|
163463
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
163464
163464
|
*
|
|
163465
163465
|
* @remarks
|
|
163466
163466
|
* [Api set: WordApiDesktop 1.2]
|
|
163467
163467
|
*/
|
|
163468
163468
|
geometricShapeType?: boolean;
|
|
163469
163469
|
/**
|
|
163470
|
-
*
|
|
163470
|
+
* Specifies the height, in points, of the shape.
|
|
163471
163471
|
*
|
|
163472
163472
|
* @remarks
|
|
163473
163473
|
* [Api set: WordApiDesktop 1.2]
|
|
163474
163474
|
*/
|
|
163475
163475
|
height?: boolean;
|
|
163476
163476
|
/**
|
|
163477
|
-
*
|
|
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.
|
|
163478
163478
|
*
|
|
163479
163479
|
* @remarks
|
|
163480
163480
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163495,14 +163495,14 @@ declare namespace Word {
|
|
|
163495
163495
|
*/
|
|
163496
163496
|
isChild?: boolean;
|
|
163497
163497
|
/**
|
|
163498
|
-
*
|
|
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.
|
|
163499
163499
|
*
|
|
163500
163500
|
* @remarks
|
|
163501
163501
|
* [Api set: WordApiDesktop 1.2]
|
|
163502
163502
|
*/
|
|
163503
163503
|
left?: boolean;
|
|
163504
163504
|
/**
|
|
163505
|
-
*
|
|
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.
|
|
163506
163506
|
*
|
|
163507
163507
|
* @remarks
|
|
163508
163508
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163516,35 +163516,35 @@ declare namespace Word {
|
|
|
163516
163516
|
*/
|
|
163517
163517
|
lockAspectRatio?: boolean;
|
|
163518
163518
|
/**
|
|
163519
|
-
*
|
|
163519
|
+
* Specifies the name of the shape.
|
|
163520
163520
|
*
|
|
163521
163521
|
* @remarks
|
|
163522
163522
|
* [Api set: WordApiDesktop 1.2]
|
|
163523
163523
|
*/
|
|
163524
163524
|
name?: boolean;
|
|
163525
163525
|
/**
|
|
163526
|
-
*
|
|
163526
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
163527
163527
|
*
|
|
163528
163528
|
* @remarks
|
|
163529
163529
|
* [Api set: WordApiDesktop 1.2]
|
|
163530
163530
|
*/
|
|
163531
163531
|
relativeHorizontalPosition?: boolean;
|
|
163532
163532
|
/**
|
|
163533
|
-
*
|
|
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.
|
|
163534
163534
|
*
|
|
163535
163535
|
* @remarks
|
|
163536
163536
|
* [Api set: WordApiDesktop 1.2]
|
|
163537
163537
|
*/
|
|
163538
163538
|
relativeHorizontalSize?: boolean;
|
|
163539
163539
|
/**
|
|
163540
|
-
*
|
|
163540
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
163541
163541
|
*
|
|
163542
163542
|
* @remarks
|
|
163543
163543
|
* [Api set: WordApiDesktop 1.2]
|
|
163544
163544
|
*/
|
|
163545
163545
|
relativeVerticalPosition?: boolean;
|
|
163546
163546
|
/**
|
|
163547
|
-
*
|
|
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.
|
|
163548
163548
|
*
|
|
163549
163549
|
* @remarks
|
|
163550
163550
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163558,14 +163558,14 @@ declare namespace Word {
|
|
|
163558
163558
|
*/
|
|
163559
163559
|
rotation?: boolean;
|
|
163560
163560
|
/**
|
|
163561
|
-
*
|
|
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.
|
|
163562
163562
|
*
|
|
163563
163563
|
* @remarks
|
|
163564
163564
|
* [Api set: WordApiDesktop 1.2]
|
|
163565
163565
|
*/
|
|
163566
163566
|
top?: boolean;
|
|
163567
163567
|
/**
|
|
163568
|
-
*
|
|
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.
|
|
163569
163569
|
*
|
|
163570
163570
|
* @remarks
|
|
163571
163571
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163586,14 +163586,14 @@ declare namespace Word {
|
|
|
163586
163586
|
*/
|
|
163587
163587
|
visible?: boolean;
|
|
163588
163588
|
/**
|
|
163589
|
-
*
|
|
163589
|
+
* Specifies the width, in points, of the shape.
|
|
163590
163590
|
*
|
|
163591
163591
|
* @remarks
|
|
163592
163592
|
* [Api set: WordApiDesktop 1.2]
|
|
163593
163593
|
*/
|
|
163594
163594
|
width?: boolean;
|
|
163595
163595
|
/**
|
|
163596
|
-
*
|
|
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.
|
|
163597
163597
|
*
|
|
163598
163598
|
* @remarks
|
|
163599
163599
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163664,7 +163664,7 @@ declare namespace Word {
|
|
|
163664
163664
|
*/
|
|
163665
163665
|
$all?: boolean;
|
|
163666
163666
|
/**
|
|
163667
|
-
* 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.
|
|
163668
163668
|
*
|
|
163669
163669
|
* @remarks
|
|
163670
163670
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163734,21 +163734,21 @@ declare namespace Word {
|
|
|
163734
163734
|
*/
|
|
163735
163735
|
altTextDescription?: boolean;
|
|
163736
163736
|
/**
|
|
163737
|
-
* 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.
|
|
163738
163738
|
*
|
|
163739
163739
|
* @remarks
|
|
163740
163740
|
* [Api set: WordApiDesktop 1.2]
|
|
163741
163741
|
*/
|
|
163742
163742
|
geometricShapeType?: boolean;
|
|
163743
163743
|
/**
|
|
163744
|
-
* For EACH ITEM in the collection:
|
|
163744
|
+
* For EACH ITEM in the collection: Specifies the height, in points, of the shape.
|
|
163745
163745
|
*
|
|
163746
163746
|
* @remarks
|
|
163747
163747
|
* [Api set: WordApiDesktop 1.2]
|
|
163748
163748
|
*/
|
|
163749
163749
|
height?: boolean;
|
|
163750
163750
|
/**
|
|
163751
|
-
* 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.
|
|
163752
163752
|
*
|
|
163753
163753
|
* @remarks
|
|
163754
163754
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163769,14 +163769,14 @@ declare namespace Word {
|
|
|
163769
163769
|
*/
|
|
163770
163770
|
isChild?: boolean;
|
|
163771
163771
|
/**
|
|
163772
|
-
* 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.
|
|
163773
163773
|
*
|
|
163774
163774
|
* @remarks
|
|
163775
163775
|
* [Api set: WordApiDesktop 1.2]
|
|
163776
163776
|
*/
|
|
163777
163777
|
left?: boolean;
|
|
163778
163778
|
/**
|
|
163779
|
-
* 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.
|
|
163780
163780
|
*
|
|
163781
163781
|
* @remarks
|
|
163782
163782
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163790,35 +163790,35 @@ declare namespace Word {
|
|
|
163790
163790
|
*/
|
|
163791
163791
|
lockAspectRatio?: boolean;
|
|
163792
163792
|
/**
|
|
163793
|
-
* For EACH ITEM in the collection:
|
|
163793
|
+
* For EACH ITEM in the collection: Specifies the name of the shape.
|
|
163794
163794
|
*
|
|
163795
163795
|
* @remarks
|
|
163796
163796
|
* [Api set: WordApiDesktop 1.2]
|
|
163797
163797
|
*/
|
|
163798
163798
|
name?: boolean;
|
|
163799
163799
|
/**
|
|
163800
|
-
* 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}.
|
|
163801
163801
|
*
|
|
163802
163802
|
* @remarks
|
|
163803
163803
|
* [Api set: WordApiDesktop 1.2]
|
|
163804
163804
|
*/
|
|
163805
163805
|
relativeHorizontalPosition?: boolean;
|
|
163806
163806
|
/**
|
|
163807
|
-
* 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.
|
|
163808
163808
|
*
|
|
163809
163809
|
* @remarks
|
|
163810
163810
|
* [Api set: WordApiDesktop 1.2]
|
|
163811
163811
|
*/
|
|
163812
163812
|
relativeHorizontalSize?: boolean;
|
|
163813
163813
|
/**
|
|
163814
|
-
* 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}.
|
|
163815
163815
|
*
|
|
163816
163816
|
* @remarks
|
|
163817
163817
|
* [Api set: WordApiDesktop 1.2]
|
|
163818
163818
|
*/
|
|
163819
163819
|
relativeVerticalPosition?: boolean;
|
|
163820
163820
|
/**
|
|
163821
|
-
* 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.
|
|
163822
163822
|
*
|
|
163823
163823
|
* @remarks
|
|
163824
163824
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163832,14 +163832,14 @@ declare namespace Word {
|
|
|
163832
163832
|
*/
|
|
163833
163833
|
rotation?: boolean;
|
|
163834
163834
|
/**
|
|
163835
|
-
* 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.
|
|
163836
163836
|
*
|
|
163837
163837
|
* @remarks
|
|
163838
163838
|
* [Api set: WordApiDesktop 1.2]
|
|
163839
163839
|
*/
|
|
163840
163840
|
top?: boolean;
|
|
163841
163841
|
/**
|
|
163842
|
-
* 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.
|
|
163843
163843
|
*
|
|
163844
163844
|
* @remarks
|
|
163845
163845
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163860,14 +163860,14 @@ declare namespace Word {
|
|
|
163860
163860
|
*/
|
|
163861
163861
|
visible?: boolean;
|
|
163862
163862
|
/**
|
|
163863
|
-
* For EACH ITEM in the collection:
|
|
163863
|
+
* For EACH ITEM in the collection: Specifies the width, in points, of the shape.
|
|
163864
163864
|
*
|
|
163865
163865
|
* @remarks
|
|
163866
163866
|
* [Api set: WordApiDesktop 1.2]
|
|
163867
163867
|
*/
|
|
163868
163868
|
width?: boolean;
|
|
163869
163869
|
/**
|
|
163870
|
-
* 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.
|
|
163871
163871
|
*
|
|
163872
163872
|
* @remarks
|
|
163873
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
|
}
|