@types/office-js-preview 1.0.669 → 1.0.670

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.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 01 Dec 2025 20:34:48 GMT
11
+ * Last updated: Fri, 12 Dec 2025 18:42:47 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -102965,7 +102965,7 @@ declare namespace Word {
102965
102965
  };
102966
102966
  }
102967
102967
  /**
102968
- * The data specific to content controls of type CheckBox.
102968
+ * Represents the data specific to content controls of type `CheckBox`.
102969
102969
  *
102970
102970
  * @remarks
102971
102971
  * [Api set: WordApi 1.7]
@@ -109036,7 +109036,7 @@ declare namespace Word {
109036
109036
  toJSON(): Word.Interfaces.DocumentData;
109037
109037
  }
109038
109038
  /**
109039
- * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
109039
+ * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
109040
109040
  *
109041
109041
  * @remarks
109042
109042
  * [Api set: WordApi 1.3]
@@ -109427,7 +109427,7 @@ declare namespace Word {
109427
109427
  toJSON(): Word.Interfaces.DocumentPropertiesData;
109428
109428
  }
109429
109429
  /**
109430
- * The data specific to content controls of type `dropDownList`.
109430
+ * Represents the data specific to content controls of type `dropDownList`.
109431
109431
  *
109432
109432
  * @remarks
109433
109433
  * [Api set: WordApi 1.9]
@@ -109490,7 +109490,7 @@ declare namespace Word {
109490
109490
  toJSON(): Word.Interfaces.DropDownListContentControlData;
109491
109491
  }
109492
109492
  /**
109493
- * The data specific to content controls of type `comboBox`.
109493
+ * Represents the data specific to content controls of type `comboBox`.
109494
109494
  *
109495
109495
  * @remarks
109496
109496
  * [Api set: WordApi 1.9]
@@ -120771,7 +120771,7 @@ declare namespace Word {
120771
120771
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
120772
120772
  context: RequestContext;
120773
120773
  /**
120774
- * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes.
120774
+ * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
120775
120775
  *
120776
120776
  * @remarks
120777
120777
  * [Api set: WordApiDesktop 1.2]
@@ -120841,21 +120841,21 @@ declare namespace Word {
120841
120841
  */
120842
120842
  altTextDescription: string;
120843
120843
  /**
120844
- * The geometric shape type of the shape. It will be null if isn't a geometric shape.
120844
+ * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
120845
120845
  *
120846
120846
  * @remarks
120847
120847
  * [Api set: WordApiDesktop 1.2]
120848
120848
  */
120849
120849
  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";
120850
120850
  /**
120851
- * The height, in points, of the shape.
120851
+ * Specifies the height, in points, of the shape.
120852
120852
  *
120853
120853
  * @remarks
120854
120854
  * [Api set: WordApiDesktop 1.2]
120855
120855
  */
120856
120856
  height: number;
120857
120857
  /**
120858
- * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120858
+ * 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.
120859
120859
  *
120860
120860
  * @remarks
120861
120861
  * [Api set: WordApiDesktop 1.2]
@@ -120876,14 +120876,14 @@ declare namespace Word {
120876
120876
  */
120877
120877
  readonly isChild: boolean;
120878
120878
  /**
120879
- * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
120879
+ * 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.
120880
120880
  *
120881
120881
  * @remarks
120882
120882
  * [Api set: WordApiDesktop 1.2]
120883
120883
  */
120884
120884
  left: number;
120885
120885
  /**
120886
- * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
120886
+ * 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.
120887
120887
  *
120888
120888
  * @remarks
120889
120889
  * [Api set: WordApiDesktop 1.2]
@@ -120897,35 +120897,35 @@ declare namespace Word {
120897
120897
  */
120898
120898
  lockAspectRatio: boolean;
120899
120899
  /**
120900
- * The name of the shape.
120900
+ * Specifies the name of the shape.
120901
120901
  *
120902
120902
  * @remarks
120903
120903
  * [Api set: WordApiDesktop 1.2]
120904
120904
  */
120905
120905
  name: string;
120906
120906
  /**
120907
- * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120907
+ * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120908
120908
  *
120909
120909
  * @remarks
120910
120910
  * [Api set: WordApiDesktop 1.2]
120911
120911
  */
120912
120912
  relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
120913
120913
  /**
120914
- * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120914
+ * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
120915
120915
  *
120916
120916
  * @remarks
120917
120917
  * [Api set: WordApiDesktop 1.2]
120918
120918
  */
120919
120919
  relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
120920
120920
  /**
120921
- * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
120921
+ * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
120922
120922
  *
120923
120923
  * @remarks
120924
120924
  * [Api set: WordApiDesktop 1.2]
120925
120925
  */
120926
120926
  relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
120927
120927
  /**
120928
- * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120928
+ * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
120929
120929
  *
120930
120930
  * @remarks
120931
120931
  * [Api set: WordApiDesktop 1.2]
@@ -120939,14 +120939,14 @@ declare namespace Word {
120939
120939
  */
120940
120940
  rotation: number;
120941
120941
  /**
120942
- * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
120942
+ * 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.
120943
120943
  *
120944
120944
  * @remarks
120945
120945
  * [Api set: WordApiDesktop 1.2]
120946
120946
  */
120947
120947
  top: number;
120948
120948
  /**
120949
- * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
120949
+ * 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.
120950
120950
  *
120951
120951
  * @remarks
120952
120952
  * [Api set: WordApiDesktop 1.2]
@@ -120967,14 +120967,14 @@ declare namespace Word {
120967
120967
  */
120968
120968
  visible: boolean;
120969
120969
  /**
120970
- * The width, in points, of the shape.
120970
+ * Specifies the width, in points, of the shape.
120971
120971
  *
120972
120972
  * @remarks
120973
120973
  * [Api set: WordApiDesktop 1.2]
120974
120974
  */
120975
120975
  width: number;
120976
120976
  /**
120977
- * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120977
+ * 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.
120978
120978
  *
120979
120979
  * @remarks
120980
120980
  * [Api set: WordApiDesktop 1.2]
@@ -124879,7 +124879,7 @@ declare namespace Word {
124879
124879
  */
124880
124880
  interface ContentControlAddedEventArgs {
124881
124881
  /**
124882
- * The event type. See `Word.EventType` for details.
124882
+ * Specifies the event type. See `Word.EventType` for details.
124883
124883
  *
124884
124884
  * @remarks
124885
124885
  * [Api set: WordApi 1.5]
@@ -124893,7 +124893,7 @@ declare namespace Word {
124893
124893
  */
124894
124894
  ids: number[];
124895
124895
  /**
124896
- * The source of the event. It can be local or remote (through coauthoring).
124896
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
124897
124897
  *
124898
124898
  * @remarks
124899
124899
  * [Api set: WordApi 1.5]
@@ -124908,7 +124908,7 @@ declare namespace Word {
124908
124908
  */
124909
124909
  interface ContentControlDataChangedEventArgs {
124910
124910
  /**
124911
- * The event type. See `Word.EventType` for details.
124911
+ * Specifies the event type. See `Word.EventType` for details.
124912
124912
  *
124913
124913
  * @remarks
124914
124914
  * [Api set: WordApi 1.5]
@@ -124922,7 +124922,7 @@ declare namespace Word {
124922
124922
  */
124923
124923
  ids: number[];
124924
124924
  /**
124925
- * The source of the event. It can be local or remote (through coauthoring).
124925
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
124926
124926
  *
124927
124927
  * @remarks
124928
124928
  * [Api set: WordApi 1.5]
@@ -124937,7 +124937,7 @@ declare namespace Word {
124937
124937
  */
124938
124938
  interface ContentControlDeletedEventArgs {
124939
124939
  /**
124940
- * The event type. See `Word.EventType` for details.
124940
+ * Specifies the event type. See `Word.EventType` for details.
124941
124941
  *
124942
124942
  * @remarks
124943
124943
  * [Api set: WordApi 1.5]
@@ -124951,7 +124951,7 @@ declare namespace Word {
124951
124951
  */
124952
124952
  ids: number[];
124953
124953
  /**
124954
- * The source of the event. It can be local or remote (through coauthoring).
124954
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
124955
124955
  *
124956
124956
  * @remarks
124957
124957
  * [Api set: WordApi 1.5]
@@ -124966,7 +124966,7 @@ declare namespace Word {
124966
124966
  */
124967
124967
  interface ContentControlEnteredEventArgs {
124968
124968
  /**
124969
- * The event type. See `Word.EventType` for details.
124969
+ * Specifies the event type. See `Word.EventType` for details.
124970
124970
  *
124971
124971
  * @remarks
124972
124972
  * [Api set: WordApi 1.5]
@@ -124980,7 +124980,7 @@ declare namespace Word {
124980
124980
  */
124981
124981
  ids: number[];
124982
124982
  /**
124983
- * The source of the event. It can be local or remote (through coauthoring).
124983
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
124984
124984
  *
124985
124985
  * @remarks
124986
124986
  * [Api set: WordApi 1.5]
@@ -124995,7 +124995,7 @@ declare namespace Word {
124995
124995
  */
124996
124996
  interface ContentControlExitedEventArgs {
124997
124997
  /**
124998
- * The event type. See `Word.EventType` for details.
124998
+ * Specifies the event type. See `Word.EventType` for details.
124999
124999
  *
125000
125000
  * @remarks
125001
125001
  * [Api set: WordApi 1.5]
@@ -125009,7 +125009,7 @@ declare namespace Word {
125009
125009
  */
125010
125010
  ids: number[];
125011
125011
  /**
125012
- * The source of the event. It can be local or remote (through coauthoring).
125012
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125013
125013
  *
125014
125014
  * @remarks
125015
125015
  * [Api set: WordApi 1.5]
@@ -125110,7 +125110,7 @@ declare namespace Word {
125110
125110
  */
125111
125111
  interface ContentControlSelectionChangedEventArgs {
125112
125112
  /**
125113
- * The event type. See `Word.EventType` for details.
125113
+ * Specifies the event type. See `Word.EventType` for details.
125114
125114
  *
125115
125115
  * @remarks
125116
125116
  * [Api set: WordApi 1.5]
@@ -125124,7 +125124,7 @@ declare namespace Word {
125124
125124
  */
125125
125125
  ids: number[];
125126
125126
  /**
125127
- * The source of the event. It can be local or remote (through coauthoring).
125127
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125128
125128
  *
125129
125129
  * @remarks
125130
125130
  * [Api set: WordApi 1.5]
@@ -125139,14 +125139,14 @@ declare namespace Word {
125139
125139
  */
125140
125140
  interface ParagraphAddedEventArgs {
125141
125141
  /**
125142
- * The source of the event. It can be local or remote (through coauthoring).
125142
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125143
125143
  *
125144
125144
  * @remarks
125145
125145
  * [Api set: WordApi 1.6]
125146
125146
  */
125147
125147
  source: Word.EventSource | "Local" | "Remote";
125148
125148
  /**
125149
- * The event type. See `Word.EventType` for details.
125149
+ * Specifies the event type. See `Word.EventType` for details.
125150
125150
  *
125151
125151
  * @remarks
125152
125152
  * [Api set: WordApi 1.6]
@@ -125168,14 +125168,14 @@ declare namespace Word {
125168
125168
  */
125169
125169
  interface ParagraphChangedEventArgs {
125170
125170
  /**
125171
- * The source of the event. It can be local or remote (through coauthoring).
125171
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125172
125172
  *
125173
125173
  * @remarks
125174
125174
  * [Api set: WordApi 1.6]
125175
125175
  */
125176
125176
  source: Word.EventSource | "Local" | "Remote";
125177
125177
  /**
125178
- * The event type. See `Word.EventType` for details.
125178
+ * Specifies the event type. See `Word.EventType` for details.
125179
125179
  *
125180
125180
  * @remarks
125181
125181
  * [Api set: WordApi 1.6]
@@ -125197,14 +125197,14 @@ declare namespace Word {
125197
125197
  */
125198
125198
  interface ParagraphDeletedEventArgs {
125199
125199
  /**
125200
- * The source of the event. It can be local or remote (through coauthoring).
125200
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125201
125201
  *
125202
125202
  * @remarks
125203
125203
  * [Api set: WordApi 1.6]
125204
125204
  */
125205
125205
  source: Word.EventSource | "Local" | "Remote";
125206
125206
  /**
125207
- * The event type. See `Word.EventType` for details.
125207
+ * Specifies the event type. See `Word.EventType` for details.
125208
125208
  *
125209
125209
  * @remarks
125210
125210
  * [Api set: WordApi 1.6]
@@ -125243,7 +125243,7 @@ declare namespace Word {
125243
125243
  */
125244
125244
  commentDetails: Word.CommentDetail[];
125245
125245
  /**
125246
- * The source of the event. It can be local or remote (through coauthoring).
125246
+ * Specifies the source of the event. It can be local or remote (through coauthoring).
125247
125247
  *
125248
125248
  * @remarks
125249
125249
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -125251,7 +125251,7 @@ declare namespace Word {
125251
125251
  */
125252
125252
  source: Word.EventSource | "Local" | "Remote";
125253
125253
  /**
125254
- * The event type. See `Word.EventType` for details.
125254
+ * Specifies the event type. See `Word.EventType` for details.
125255
125255
  *
125256
125256
  * @remarks
125257
125257
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -126329,7 +126329,7 @@ declare namespace Word {
126329
126329
  mixed = "Mixed",
126330
126330
  }
126331
126331
  /**
126332
- * The {@link Word.Border | border} types.
126332
+ * Represents the {@link Word.Border | border} type.
126333
126333
  *
126334
126334
  * @remarks
126335
126335
  * [Api set: WordApi 1.3]
@@ -151789,7 +151789,7 @@ declare namespace Word {
151789
151789
  /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
151790
151790
  interface ShapeUpdateData {
151791
151791
  /**
151792
- * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes.
151792
+ * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
151793
151793
  *
151794
151794
  * @remarks
151795
151795
  * [Api set: WordApiDesktop 1.2]
@@ -151859,35 +151859,35 @@ declare namespace Word {
151859
151859
  */
151860
151860
  altTextDescription?: string;
151861
151861
  /**
151862
- * The geometric shape type of the shape. It will be null if isn't a geometric shape.
151862
+ * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
151863
151863
  *
151864
151864
  * @remarks
151865
151865
  * [Api set: WordApiDesktop 1.2]
151866
151866
  */
151867
151867
  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";
151868
151868
  /**
151869
- * The height, in points, of the shape.
151869
+ * Specifies the height, in points, of the shape.
151870
151870
  *
151871
151871
  * @remarks
151872
151872
  * [Api set: WordApiDesktop 1.2]
151873
151873
  */
151874
151874
  height?: number;
151875
151875
  /**
151876
- * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
151876
+ * 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.
151877
151877
  *
151878
151878
  * @remarks
151879
151879
  * [Api set: WordApiDesktop 1.2]
151880
151880
  */
151881
151881
  heightRelative?: number;
151882
151882
  /**
151883
- * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
151883
+ * 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.
151884
151884
  *
151885
151885
  * @remarks
151886
151886
  * [Api set: WordApiDesktop 1.2]
151887
151887
  */
151888
151888
  left?: number;
151889
151889
  /**
151890
- * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
151890
+ * 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.
151891
151891
  *
151892
151892
  * @remarks
151893
151893
  * [Api set: WordApiDesktop 1.2]
@@ -151901,35 +151901,35 @@ declare namespace Word {
151901
151901
  */
151902
151902
  lockAspectRatio?: boolean;
151903
151903
  /**
151904
- * The name of the shape.
151904
+ * Specifies the name of the shape.
151905
151905
  *
151906
151906
  * @remarks
151907
151907
  * [Api set: WordApiDesktop 1.2]
151908
151908
  */
151909
151909
  name?: string;
151910
151910
  /**
151911
- * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
151911
+ * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
151912
151912
  *
151913
151913
  * @remarks
151914
151914
  * [Api set: WordApiDesktop 1.2]
151915
151915
  */
151916
151916
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
151917
151917
  /**
151918
- * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
151918
+ * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
151919
151919
  *
151920
151920
  * @remarks
151921
151921
  * [Api set: WordApiDesktop 1.2]
151922
151922
  */
151923
151923
  relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
151924
151924
  /**
151925
- * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
151925
+ * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
151926
151926
  *
151927
151927
  * @remarks
151928
151928
  * [Api set: WordApiDesktop 1.2]
151929
151929
  */
151930
151930
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
151931
151931
  /**
151932
- * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
151932
+ * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
151933
151933
  *
151934
151934
  * @remarks
151935
151935
  * [Api set: WordApiDesktop 1.2]
@@ -151943,14 +151943,14 @@ declare namespace Word {
151943
151943
  */
151944
151944
  rotation?: number;
151945
151945
  /**
151946
- * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
151946
+ * 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.
151947
151947
  *
151948
151948
  * @remarks
151949
151949
  * [Api set: WordApiDesktop 1.2]
151950
151950
  */
151951
151951
  top?: number;
151952
151952
  /**
151953
- * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
151953
+ * 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.
151954
151954
  *
151955
151955
  * @remarks
151956
151956
  * [Api set: WordApiDesktop 1.2]
@@ -151964,14 +151964,14 @@ declare namespace Word {
151964
151964
  */
151965
151965
  visible?: boolean;
151966
151966
  /**
151967
- * The width, in points, of the shape.
151967
+ * Specifies the width, in points, of the shape.
151968
151968
  *
151969
151969
  * @remarks
151970
151970
  * [Api set: WordApiDesktop 1.2]
151971
151971
  */
151972
151972
  width?: number;
151973
151973
  /**
151974
- * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
151974
+ * 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.
151975
151975
  *
151976
151976
  * @remarks
151977
151977
  * [Api set: WordApiDesktop 1.2]
@@ -159664,7 +159664,7 @@ declare namespace Word {
159664
159664
  /** An interface describing the data returned by calling `shape.toJSON()`. */
159665
159665
  interface ShapeData {
159666
159666
  /**
159667
- * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes.
159667
+ * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
159668
159668
  *
159669
159669
  * @remarks
159670
159670
  * [Api set: WordApiDesktop 1.2]
@@ -159734,21 +159734,21 @@ declare namespace Word {
159734
159734
  */
159735
159735
  altTextDescription?: string;
159736
159736
  /**
159737
- * The geometric shape type of the shape. It will be null if isn't a geometric shape.
159737
+ * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
159738
159738
  *
159739
159739
  * @remarks
159740
159740
  * [Api set: WordApiDesktop 1.2]
159741
159741
  */
159742
159742
  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";
159743
159743
  /**
159744
- * The height, in points, of the shape.
159744
+ * Specifies the height, in points, of the shape.
159745
159745
  *
159746
159746
  * @remarks
159747
159747
  * [Api set: WordApiDesktop 1.2]
159748
159748
  */
159749
159749
  height?: number;
159750
159750
  /**
159751
- * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
159751
+ * 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.
159752
159752
  *
159753
159753
  * @remarks
159754
159754
  * [Api set: WordApiDesktop 1.2]
@@ -159769,14 +159769,14 @@ declare namespace Word {
159769
159769
  */
159770
159770
  isChild?: boolean;
159771
159771
  /**
159772
- * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
159772
+ * 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.
159773
159773
  *
159774
159774
  * @remarks
159775
159775
  * [Api set: WordApiDesktop 1.2]
159776
159776
  */
159777
159777
  left?: number;
159778
159778
  /**
159779
- * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
159779
+ * 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.
159780
159780
  *
159781
159781
  * @remarks
159782
159782
  * [Api set: WordApiDesktop 1.2]
@@ -159790,35 +159790,35 @@ declare namespace Word {
159790
159790
  */
159791
159791
  lockAspectRatio?: boolean;
159792
159792
  /**
159793
- * The name of the shape.
159793
+ * Specifies the name of the shape.
159794
159794
  *
159795
159795
  * @remarks
159796
159796
  * [Api set: WordApiDesktop 1.2]
159797
159797
  */
159798
159798
  name?: string;
159799
159799
  /**
159800
- * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
159800
+ * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
159801
159801
  *
159802
159802
  * @remarks
159803
159803
  * [Api set: WordApiDesktop 1.2]
159804
159804
  */
159805
159805
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
159806
159806
  /**
159807
- * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
159807
+ * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
159808
159808
  *
159809
159809
  * @remarks
159810
159810
  * [Api set: WordApiDesktop 1.2]
159811
159811
  */
159812
159812
  relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
159813
159813
  /**
159814
- * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
159814
+ * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
159815
159815
  *
159816
159816
  * @remarks
159817
159817
  * [Api set: WordApiDesktop 1.2]
159818
159818
  */
159819
159819
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
159820
159820
  /**
159821
- * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
159821
+ * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
159822
159822
  *
159823
159823
  * @remarks
159824
159824
  * [Api set: WordApiDesktop 1.2]
@@ -159832,14 +159832,14 @@ declare namespace Word {
159832
159832
  */
159833
159833
  rotation?: number;
159834
159834
  /**
159835
- * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
159835
+ * 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.
159836
159836
  *
159837
159837
  * @remarks
159838
159838
  * [Api set: WordApiDesktop 1.2]
159839
159839
  */
159840
159840
  top?: number;
159841
159841
  /**
159842
- * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
159842
+ * 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.
159843
159843
  *
159844
159844
  * @remarks
159845
159845
  * [Api set: WordApiDesktop 1.2]
@@ -159860,14 +159860,14 @@ declare namespace Word {
159860
159860
  */
159861
159861
  visible?: boolean;
159862
159862
  /**
159863
- * The width, in points, of the shape.
159863
+ * Specifies the width, in points, of the shape.
159864
159864
  *
159865
159865
  * @remarks
159866
159866
  * [Api set: WordApiDesktop 1.2]
159867
159867
  */
159868
159868
  width?: number;
159869
159869
  /**
159870
- * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
159870
+ * 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.
159871
159871
  *
159872
159872
  * @remarks
159873
159873
  * [Api set: WordApiDesktop 1.2]
@@ -163103,7 +163103,7 @@ declare namespace Word {
163103
163103
  name?: boolean;
163104
163104
  }
163105
163105
  /**
163106
- * The data specific to content controls of type CheckBox.
163106
+ * Represents the data specific to content controls of type `CheckBox`.
163107
163107
  *
163108
163108
  * @remarks
163109
163109
  * [Api set: WordApi 1.7]
@@ -165651,7 +165651,7 @@ declare namespace Word {
165651
165651
  xmlSaveThroughXslt?: boolean;
165652
165652
  }
165653
165653
  /**
165654
- * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
165654
+ * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
165655
165655
  *
165656
165656
  * @remarks
165657
165657
  * [Api set: WordApi 1.3]
@@ -172396,7 +172396,7 @@ declare namespace Word {
172396
172396
  */
172397
172397
  $all?: boolean;
172398
172398
  /**
172399
- * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes.
172399
+ * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
172400
172400
  *
172401
172401
  * @remarks
172402
172402
  * [Api set: WordApiDesktop 1.2]
@@ -172466,21 +172466,21 @@ declare namespace Word {
172466
172466
  */
172467
172467
  altTextDescription?: boolean;
172468
172468
  /**
172469
- * The geometric shape type of the shape. It will be null if isn't a geometric shape.
172469
+ * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
172470
172470
  *
172471
172471
  * @remarks
172472
172472
  * [Api set: WordApiDesktop 1.2]
172473
172473
  */
172474
172474
  geometricShapeType?: boolean;
172475
172475
  /**
172476
- * The height, in points, of the shape.
172476
+ * Specifies the height, in points, of the shape.
172477
172477
  *
172478
172478
  * @remarks
172479
172479
  * [Api set: WordApiDesktop 1.2]
172480
172480
  */
172481
172481
  height?: boolean;
172482
172482
  /**
172483
- * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
172483
+ * 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.
172484
172484
  *
172485
172485
  * @remarks
172486
172486
  * [Api set: WordApiDesktop 1.2]
@@ -172501,14 +172501,14 @@ declare namespace Word {
172501
172501
  */
172502
172502
  isChild?: boolean;
172503
172503
  /**
172504
- * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
172504
+ * 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.
172505
172505
  *
172506
172506
  * @remarks
172507
172507
  * [Api set: WordApiDesktop 1.2]
172508
172508
  */
172509
172509
  left?: boolean;
172510
172510
  /**
172511
- * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
172511
+ * 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.
172512
172512
  *
172513
172513
  * @remarks
172514
172514
  * [Api set: WordApiDesktop 1.2]
@@ -172522,35 +172522,35 @@ declare namespace Word {
172522
172522
  */
172523
172523
  lockAspectRatio?: boolean;
172524
172524
  /**
172525
- * The name of the shape.
172525
+ * Specifies the name of the shape.
172526
172526
  *
172527
172527
  * @remarks
172528
172528
  * [Api set: WordApiDesktop 1.2]
172529
172529
  */
172530
172530
  name?: boolean;
172531
172531
  /**
172532
- * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172532
+ * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172533
172533
  *
172534
172534
  * @remarks
172535
172535
  * [Api set: WordApiDesktop 1.2]
172536
172536
  */
172537
172537
  relativeHorizontalPosition?: boolean;
172538
172538
  /**
172539
- * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172539
+ * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
172540
172540
  *
172541
172541
  * @remarks
172542
172542
  * [Api set: WordApiDesktop 1.2]
172543
172543
  */
172544
172544
  relativeHorizontalSize?: boolean;
172545
172545
  /**
172546
- * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
172546
+ * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
172547
172547
  *
172548
172548
  * @remarks
172549
172549
  * [Api set: WordApiDesktop 1.2]
172550
172550
  */
172551
172551
  relativeVerticalPosition?: boolean;
172552
172552
  /**
172553
- * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172553
+ * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
172554
172554
  *
172555
172555
  * @remarks
172556
172556
  * [Api set: WordApiDesktop 1.2]
@@ -172564,14 +172564,14 @@ declare namespace Word {
172564
172564
  */
172565
172565
  rotation?: boolean;
172566
172566
  /**
172567
- * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
172567
+ * 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.
172568
172568
  *
172569
172569
  * @remarks
172570
172570
  * [Api set: WordApiDesktop 1.2]
172571
172571
  */
172572
172572
  top?: boolean;
172573
172573
  /**
172574
- * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
172574
+ * 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.
172575
172575
  *
172576
172576
  * @remarks
172577
172577
  * [Api set: WordApiDesktop 1.2]
@@ -172592,14 +172592,14 @@ declare namespace Word {
172592
172592
  */
172593
172593
  visible?: boolean;
172594
172594
  /**
172595
- * The width, in points, of the shape.
172595
+ * Specifies the width, in points, of the shape.
172596
172596
  *
172597
172597
  * @remarks
172598
172598
  * [Api set: WordApiDesktop 1.2]
172599
172599
  */
172600
172600
  width?: boolean;
172601
172601
  /**
172602
- * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
172602
+ * 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.
172603
172603
  *
172604
172604
  * @remarks
172605
172605
  * [Api set: WordApiDesktop 1.2]
@@ -172670,7 +172670,7 @@ declare namespace Word {
172670
172670
  */
172671
172671
  $all?: boolean;
172672
172672
  /**
172673
- * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes.
172673
+ * For EACH ITEM in the collection: Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
172674
172674
  *
172675
172675
  * @remarks
172676
172676
  * [Api set: WordApiDesktop 1.2]
@@ -172740,21 +172740,21 @@ declare namespace Word {
172740
172740
  */
172741
172741
  altTextDescription?: boolean;
172742
172742
  /**
172743
- * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
172743
+ * For EACH ITEM in the collection: Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
172744
172744
  *
172745
172745
  * @remarks
172746
172746
  * [Api set: WordApiDesktop 1.2]
172747
172747
  */
172748
172748
  geometricShapeType?: boolean;
172749
172749
  /**
172750
- * For EACH ITEM in the collection: The height, in points, of the shape.
172750
+ * For EACH ITEM in the collection: Specifies the height, in points, of the shape.
172751
172751
  *
172752
172752
  * @remarks
172753
172753
  * [Api set: WordApiDesktop 1.2]
172754
172754
  */
172755
172755
  height?: boolean;
172756
172756
  /**
172757
- * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
172757
+ * 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.
172758
172758
  *
172759
172759
  * @remarks
172760
172760
  * [Api set: WordApiDesktop 1.2]
@@ -172775,14 +172775,14 @@ declare namespace Word {
172775
172775
  */
172776
172776
  isChild?: boolean;
172777
172777
  /**
172778
- * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
172778
+ * 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.
172779
172779
  *
172780
172780
  * @remarks
172781
172781
  * [Api set: WordApiDesktop 1.2]
172782
172782
  */
172783
172783
  left?: boolean;
172784
172784
  /**
172785
- * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
172785
+ * 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.
172786
172786
  *
172787
172787
  * @remarks
172788
172788
  * [Api set: WordApiDesktop 1.2]
@@ -172796,35 +172796,35 @@ declare namespace Word {
172796
172796
  */
172797
172797
  lockAspectRatio?: boolean;
172798
172798
  /**
172799
- * For EACH ITEM in the collection: The name of the shape.
172799
+ * For EACH ITEM in the collection: Specifies the name of the shape.
172800
172800
  *
172801
172801
  * @remarks
172802
172802
  * [Api set: WordApiDesktop 1.2]
172803
172803
  */
172804
172804
  name?: boolean;
172805
172805
  /**
172806
- * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172806
+ * 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}.
172807
172807
  *
172808
172808
  * @remarks
172809
172809
  * [Api set: WordApiDesktop 1.2]
172810
172810
  */
172811
172811
  relativeHorizontalPosition?: boolean;
172812
172812
  /**
172813
- * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172813
+ * 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.
172814
172814
  *
172815
172815
  * @remarks
172816
172816
  * [Api set: WordApiDesktop 1.2]
172817
172817
  */
172818
172818
  relativeHorizontalSize?: boolean;
172819
172819
  /**
172820
- * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
172820
+ * 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}.
172821
172821
  *
172822
172822
  * @remarks
172823
172823
  * [Api set: WordApiDesktop 1.2]
172824
172824
  */
172825
172825
  relativeVerticalPosition?: boolean;
172826
172826
  /**
172827
- * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
172827
+ * 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.
172828
172828
  *
172829
172829
  * @remarks
172830
172830
  * [Api set: WordApiDesktop 1.2]
@@ -172838,14 +172838,14 @@ declare namespace Word {
172838
172838
  */
172839
172839
  rotation?: boolean;
172840
172840
  /**
172841
- * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
172841
+ * 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.
172842
172842
  *
172843
172843
  * @remarks
172844
172844
  * [Api set: WordApiDesktop 1.2]
172845
172845
  */
172846
172846
  top?: boolean;
172847
172847
  /**
172848
- * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
172848
+ * 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.
172849
172849
  *
172850
172850
  * @remarks
172851
172851
  * [Api set: WordApiDesktop 1.2]
@@ -172866,14 +172866,14 @@ declare namespace Word {
172866
172866
  */
172867
172867
  visible?: boolean;
172868
172868
  /**
172869
- * For EACH ITEM in the collection: The width, in points, of the shape.
172869
+ * For EACH ITEM in the collection: Specifies the width, in points, of the shape.
172870
172870
  *
172871
172871
  * @remarks
172872
172872
  * [Api set: WordApiDesktop 1.2]
172873
172873
  */
172874
172874
  width?: boolean;
172875
172875
  /**
172876
- * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
172876
+ * 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.
172877
172877
  *
172878
172878
  * @remarks
172879
172879
  * [Api set: WordApiDesktop 1.2]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.669",
3
+ "version": "1.0.670",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "8877231029e3d2899fc76dd63bc1d21bac4830866deb7faf4e414eed6057ce65",
49
+ "typesPublisherContentHash": "0287982a183ca08ca2e883defbd95e4f77e6a1b9fcf6dfed7269343116724a2b",
50
50
  "typeScriptVersion": "5.2",
51
51
  "nonNpm": true
52
52
  }