@types/office-js-preview 1.0.545 → 1.0.546
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +425 -79
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -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: Tue, 21 Jan 2025 19:
|
|
11
|
+
* Last updated: Tue, 21 Jan 2025 19:32:16 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -94790,7 +94790,7 @@ declare namespace Word {
|
|
|
94790
94790
|
*/
|
|
94791
94791
|
readonly parentSectionOrNullObject: Word.Section;
|
|
94792
94792
|
/**
|
|
94793
|
-
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only text boxes
|
|
94793
|
+
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
94794
94794
|
*
|
|
94795
94795
|
* @remarks
|
|
94796
94796
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -100002,7 +100002,7 @@ declare namespace Word {
|
|
|
100002
100002
|
*/
|
|
100003
100003
|
readonly parentTableOrNullObject: Word.Table;
|
|
100004
100004
|
/**
|
|
100005
|
-
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only text boxes
|
|
100005
|
+
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
100006
100006
|
*
|
|
100007
100007
|
* @remarks
|
|
100008
100008
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -100345,7 +100345,7 @@ declare namespace Word {
|
|
|
100345
100345
|
* @beta
|
|
100346
100346
|
*
|
|
100347
100347
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100348
|
-
* @param insertShapeOptions Optional. The
|
|
100348
|
+
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
100349
100349
|
*/
|
|
100350
100350
|
insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
100351
100351
|
/**
|
|
@@ -100356,7 +100356,7 @@ declare namespace Word {
|
|
|
100356
100356
|
* @beta
|
|
100357
100357
|
*
|
|
100358
100358
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
100359
|
-
* @param insertShapeOptions Optional. The
|
|
100359
|
+
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
100360
100360
|
*/
|
|
100361
100361
|
insertGeometricShape(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", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
100362
100362
|
/**
|
|
@@ -100399,6 +100399,17 @@ declare namespace Word {
|
|
|
100399
100399
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
100400
100400
|
*/
|
|
100401
100401
|
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
100402
|
+
/**
|
|
100403
|
+
* Inserts a floating picture with its anchor at the beginning of the paragraph.
|
|
100404
|
+
*
|
|
100405
|
+
* @remarks
|
|
100406
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
100407
|
+
* @beta
|
|
100408
|
+
*
|
|
100409
|
+
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
100410
|
+
* @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
|
|
100411
|
+
*/
|
|
100412
|
+
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
100402
100413
|
/**
|
|
100403
100414
|
* Inserts a table with the specified number of rows and columns.
|
|
100404
100415
|
*
|
|
@@ -100429,7 +100440,7 @@ declare namespace Word {
|
|
|
100429
100440
|
* @beta
|
|
100430
100441
|
*
|
|
100431
100442
|
* @param text Optional. The text to insert into the text box.
|
|
100432
|
-
* @param insertShapeOptions Optional. The
|
|
100443
|
+
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
100433
100444
|
*/
|
|
100434
100445
|
insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
100435
100446
|
/**
|
|
@@ -100909,7 +100920,7 @@ declare namespace Word {
|
|
|
100909
100920
|
*/
|
|
100910
100921
|
readonly parentTableOrNullObject: Word.Table;
|
|
100911
100922
|
/**
|
|
100912
|
-
* Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only text boxes
|
|
100923
|
+
* Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
100913
100924
|
*
|
|
100914
100925
|
* @remarks
|
|
100915
100926
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -101264,7 +101275,7 @@ declare namespace Word {
|
|
|
101264
101275
|
* @beta
|
|
101265
101276
|
*
|
|
101266
101277
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101267
|
-
* @param insertShapeOptions Optional. The
|
|
101278
|
+
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
101268
101279
|
*/
|
|
101269
101280
|
insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
101270
101281
|
/**
|
|
@@ -101275,7 +101286,7 @@ declare namespace Word {
|
|
|
101275
101286
|
* @beta
|
|
101276
101287
|
*
|
|
101277
101288
|
* @param geometricShapeType The geometric type of the shape to insert.
|
|
101278
|
-
* @param insertShapeOptions Optional. The
|
|
101289
|
+
* @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
|
|
101279
101290
|
*/
|
|
101280
101291
|
insertGeometricShape(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", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
101281
101292
|
/**
|
|
@@ -101318,6 +101329,17 @@ declare namespace Word {
|
|
|
101318
101329
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
101319
101330
|
*/
|
|
101320
101331
|
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
101332
|
+
/**
|
|
101333
|
+
* Inserts a floating picture with its anchor at the beginning of the range.
|
|
101334
|
+
*
|
|
101335
|
+
* @remarks
|
|
101336
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
101337
|
+
* @beta
|
|
101338
|
+
*
|
|
101339
|
+
* @param base64EncodedImage Required. The Base64-encoded image to be inserted.
|
|
101340
|
+
* @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
|
|
101341
|
+
*/
|
|
101342
|
+
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
101321
101343
|
/**
|
|
101322
101344
|
* Inserts a table with the specified number of rows and columns.
|
|
101323
101345
|
*
|
|
@@ -101348,7 +101370,7 @@ declare namespace Word {
|
|
|
101348
101370
|
* @beta
|
|
101349
101371
|
*
|
|
101350
101372
|
* @param text Optional. The text to insert into the text box.
|
|
101351
|
-
* @param insertShapeOptions Optional. The
|
|
101373
|
+
* @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
|
|
101352
101374
|
*/
|
|
101353
101375
|
insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
|
|
101354
101376
|
/**
|
|
@@ -101557,7 +101579,7 @@ declare namespace Word {
|
|
|
101557
101579
|
toJSON(): Word.Interfaces.RangeCollectionData;
|
|
101558
101580
|
}
|
|
101559
101581
|
/**
|
|
101560
|
-
* Specifies the options to determine
|
|
101582
|
+
* Specifies the options to determine location and size when inserting a shape.
|
|
101561
101583
|
*
|
|
101562
101584
|
* @remarks
|
|
101563
101585
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104103,7 +104125,7 @@ declare namespace Word {
|
|
|
104103
104125
|
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
104104
104126
|
}
|
|
104105
104127
|
/**
|
|
104106
|
-
* Represents a shape in the header footer or document body. Currently, only text boxes
|
|
104128
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
104107
104129
|
*
|
|
104108
104130
|
* @remarks
|
|
104109
104131
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104120,6 +104142,22 @@ declare namespace Word {
|
|
|
104120
104142
|
* @beta
|
|
104121
104143
|
*/
|
|
104122
104144
|
readonly body: Word.Body;
|
|
104145
|
+
/**
|
|
104146
|
+
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
104147
|
+
*
|
|
104148
|
+
* @remarks
|
|
104149
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104150
|
+
* @beta
|
|
104151
|
+
*/
|
|
104152
|
+
readonly shapeGroup: Word.ShapeGroup;
|
|
104153
|
+
/**
|
|
104154
|
+
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
104155
|
+
*
|
|
104156
|
+
* @remarks
|
|
104157
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104158
|
+
* @beta
|
|
104159
|
+
*/
|
|
104160
|
+
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";
|
|
104123
104161
|
/**
|
|
104124
104162
|
* The height, in points, of the shape.
|
|
104125
104163
|
*
|
|
@@ -104137,7 +104175,7 @@ declare namespace Word {
|
|
|
104137
104175
|
*/
|
|
104138
104176
|
readonly id: number;
|
|
104139
104177
|
/**
|
|
104140
|
-
* The distance, in points, from the left side of the shape to the horizontal relative position. For
|
|
104178
|
+
* 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.
|
|
104141
104179
|
*
|
|
104142
104180
|
* @remarks
|
|
104143
104181
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104145,7 +104183,15 @@ declare namespace Word {
|
|
|
104145
104183
|
*/
|
|
104146
104184
|
left: number;
|
|
104147
104185
|
/**
|
|
104148
|
-
* The
|
|
104186
|
+
* The name of the shape.
|
|
104187
|
+
*
|
|
104188
|
+
* @remarks
|
|
104189
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104190
|
+
* @beta
|
|
104191
|
+
*/
|
|
104192
|
+
name: string;
|
|
104193
|
+
/**
|
|
104194
|
+
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
104149
104195
|
*
|
|
104150
104196
|
* @remarks
|
|
104151
104197
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104153,7 +104199,7 @@ declare namespace Word {
|
|
|
104153
104199
|
*/
|
|
104154
104200
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
104155
104201
|
/**
|
|
104156
|
-
* The relative vertical position of the shape. For
|
|
104202
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
104157
104203
|
*
|
|
104158
104204
|
* @remarks
|
|
104159
104205
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104161,7 +104207,7 @@ declare namespace Word {
|
|
|
104161
104207
|
*/
|
|
104162
104208
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
104163
104209
|
/**
|
|
104164
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position. For
|
|
104210
|
+
* 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.
|
|
104165
104211
|
*
|
|
104166
104212
|
* @remarks
|
|
104167
104213
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104169,13 +104215,13 @@ declare namespace Word {
|
|
|
104169
104215
|
*/
|
|
104170
104216
|
top: number;
|
|
104171
104217
|
/**
|
|
104172
|
-
* Gets the shape type. Currently, only text boxes
|
|
104218
|
+
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
104173
104219
|
*
|
|
104174
104220
|
* @remarks
|
|
104175
104221
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104176
104222
|
* @beta
|
|
104177
104223
|
*/
|
|
104178
|
-
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
|
|
104224
|
+
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture";
|
|
104179
104225
|
/**
|
|
104180
104226
|
* The width, in points, of the shape.
|
|
104181
104227
|
*
|
|
@@ -104200,6 +104246,26 @@ declare namespace Word {
|
|
|
104200
104246
|
* @beta
|
|
104201
104247
|
*/
|
|
104202
104248
|
delete(): void;
|
|
104249
|
+
/**
|
|
104250
|
+
* Moves the shape horizontally by the number of points.
|
|
104251
|
+
*
|
|
104252
|
+
* @remarks
|
|
104253
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104254
|
+
* @beta
|
|
104255
|
+
*
|
|
104256
|
+
* @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left.
|
|
104257
|
+
*/
|
|
104258
|
+
moveHorizontally(distance: number): void;
|
|
104259
|
+
/**
|
|
104260
|
+
* Moves the shape vertically by the number of points.
|
|
104261
|
+
*
|
|
104262
|
+
* @remarks
|
|
104263
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104264
|
+
* @beta
|
|
104265
|
+
*
|
|
104266
|
+
* @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down.
|
|
104267
|
+
*/
|
|
104268
|
+
moveVertically(distance: number): void;
|
|
104203
104269
|
/**
|
|
104204
104270
|
* Selects the shape.
|
|
104205
104271
|
*
|
|
@@ -104246,7 +104312,92 @@ declare namespace Word {
|
|
|
104246
104312
|
toJSON(): Word.Interfaces.ShapeData;
|
|
104247
104313
|
}
|
|
104248
104314
|
/**
|
|
104249
|
-
*
|
|
104315
|
+
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
104316
|
+
*
|
|
104317
|
+
* @remarks
|
|
104318
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104319
|
+
* @beta
|
|
104320
|
+
*/
|
|
104321
|
+
class ShapeGroup extends OfficeExtension.ClientObject {
|
|
104322
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
104323
|
+
context: RequestContext;
|
|
104324
|
+
/**
|
|
104325
|
+
* Gets the Shape object associated with the group.
|
|
104326
|
+
*
|
|
104327
|
+
* @remarks
|
|
104328
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104329
|
+
* @beta
|
|
104330
|
+
*/
|
|
104331
|
+
readonly shape: Word.Shape;
|
|
104332
|
+
/**
|
|
104333
|
+
* Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.
|
|
104334
|
+
*
|
|
104335
|
+
* @remarks
|
|
104336
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104337
|
+
* @beta
|
|
104338
|
+
*/
|
|
104339
|
+
readonly shapes: Word.ShapeCollection;
|
|
104340
|
+
/**
|
|
104341
|
+
* Gets an integer that represents the shape group identifier.
|
|
104342
|
+
*
|
|
104343
|
+
* @remarks
|
|
104344
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104345
|
+
* @beta
|
|
104346
|
+
*/
|
|
104347
|
+
readonly id: number;
|
|
104348
|
+
/**
|
|
104349
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
104350
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
104351
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
104352
|
+
*/
|
|
104353
|
+
set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
104354
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
104355
|
+
set(properties: Word.ShapeGroup): void;
|
|
104356
|
+
/**
|
|
104357
|
+
* Ungroups any grouped shapes in the specified shape group.
|
|
104358
|
+
*
|
|
104359
|
+
* @remarks
|
|
104360
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104361
|
+
* @beta
|
|
104362
|
+
*/
|
|
104363
|
+
unGroup(): Word.ShapeCollection;
|
|
104364
|
+
/**
|
|
104365
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
104366
|
+
*
|
|
104367
|
+
* @param options Provides options for which properties of the object to load.
|
|
104368
|
+
*/
|
|
104369
|
+
load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup;
|
|
104370
|
+
/**
|
|
104371
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
104372
|
+
*
|
|
104373
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
104374
|
+
*/
|
|
104375
|
+
load(propertyNames?: string | string[]): Word.ShapeGroup;
|
|
104376
|
+
/**
|
|
104377
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
104378
|
+
*
|
|
104379
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
104380
|
+
*/
|
|
104381
|
+
load(propertyNamesAndPaths?: {
|
|
104382
|
+
select?: string;
|
|
104383
|
+
expand?: string;
|
|
104384
|
+
}): Word.ShapeGroup;
|
|
104385
|
+
/**
|
|
104386
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
104387
|
+
*/
|
|
104388
|
+
track(): Word.ShapeGroup;
|
|
104389
|
+
/**
|
|
104390
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
104391
|
+
*/
|
|
104392
|
+
untrack(): Word.ShapeGroup;
|
|
104393
|
+
/**
|
|
104394
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
104395
|
+
* Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
104396
|
+
*/
|
|
104397
|
+
toJSON(): Word.Interfaces.ShapeGroupData;
|
|
104398
|
+
}
|
|
104399
|
+
/**
|
|
104400
|
+
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
104250
104401
|
*
|
|
104251
104402
|
* @remarks
|
|
104252
104403
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104287,6 +104438,16 @@ declare namespace Word {
|
|
|
104287
104438
|
* @param id Required. A shape identifier.
|
|
104288
104439
|
*/
|
|
104289
104440
|
getByIdOrNullObject(id: number): Word.Shape;
|
|
104441
|
+
/**
|
|
104442
|
+
* Gets the shapes by the identifiers.
|
|
104443
|
+
*
|
|
104444
|
+
* @remarks
|
|
104445
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104446
|
+
* @beta
|
|
104447
|
+
*
|
|
104448
|
+
* @param ids Required. An array of shape identifiers.
|
|
104449
|
+
*/
|
|
104450
|
+
getByIds(ids: number[]): Word.ShapeCollection;
|
|
104290
104451
|
/**
|
|
104291
104452
|
* Gets the shapes that have the specified types.
|
|
104292
104453
|
*
|
|
@@ -104313,6 +104474,14 @@ declare namespace Word {
|
|
|
104313
104474
|
* @beta
|
|
104314
104475
|
*/
|
|
104315
104476
|
getFirstOrNullObject(): Word.Shape;
|
|
104477
|
+
/**
|
|
104478
|
+
* Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.
|
|
104479
|
+
*
|
|
104480
|
+
* @remarks
|
|
104481
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104482
|
+
* @beta
|
|
104483
|
+
*/
|
|
104484
|
+
group(): Word.Shape;
|
|
104316
104485
|
/**
|
|
104317
104486
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
104318
104487
|
*
|
|
@@ -108351,6 +108520,20 @@ declare namespace Word {
|
|
|
108351
108520
|
* @beta
|
|
108352
108521
|
*/
|
|
108353
108522
|
geometricShape = "GeometricShape",
|
|
108523
|
+
/**
|
|
108524
|
+
* Group shape.
|
|
108525
|
+
* @remarks
|
|
108526
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
108527
|
+
* @beta
|
|
108528
|
+
*/
|
|
108529
|
+
group = "Group",
|
|
108530
|
+
/**
|
|
108531
|
+
* Picture shape.
|
|
108532
|
+
* @remarks
|
|
108533
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
108534
|
+
* @beta
|
|
108535
|
+
*/
|
|
108536
|
+
picture = "Picture",
|
|
108354
108537
|
}
|
|
108355
108538
|
/**
|
|
108356
108539
|
* Represents what the horizontal position of a shape is relative to.
|
|
@@ -111270,6 +111453,22 @@ declare namespace Word {
|
|
|
111270
111453
|
* @beta
|
|
111271
111454
|
*/
|
|
111272
111455
|
body?: Word.Interfaces.BodyUpdateData;
|
|
111456
|
+
/**
|
|
111457
|
+
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
111458
|
+
*
|
|
111459
|
+
* @remarks
|
|
111460
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111461
|
+
* @beta
|
|
111462
|
+
*/
|
|
111463
|
+
shapeGroup?: Word.Interfaces.ShapeGroupUpdateData;
|
|
111464
|
+
/**
|
|
111465
|
+
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
111466
|
+
*
|
|
111467
|
+
* @remarks
|
|
111468
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111469
|
+
* @beta
|
|
111470
|
+
*/
|
|
111471
|
+
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";
|
|
111273
111472
|
/**
|
|
111274
111473
|
* The height, in points, of the shape.
|
|
111275
111474
|
*
|
|
@@ -111279,7 +111478,7 @@ declare namespace Word {
|
|
|
111279
111478
|
*/
|
|
111280
111479
|
height?: number;
|
|
111281
111480
|
/**
|
|
111282
|
-
* The distance, in points, from the left side of the shape to the horizontal relative position. For
|
|
111481
|
+
* 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.
|
|
111283
111482
|
*
|
|
111284
111483
|
* @remarks
|
|
111285
111484
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -111287,7 +111486,15 @@ declare namespace Word {
|
|
|
111287
111486
|
*/
|
|
111288
111487
|
left?: number;
|
|
111289
111488
|
/**
|
|
111290
|
-
* The
|
|
111489
|
+
* The name of the shape.
|
|
111490
|
+
*
|
|
111491
|
+
* @remarks
|
|
111492
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111493
|
+
* @beta
|
|
111494
|
+
*/
|
|
111495
|
+
name?: string;
|
|
111496
|
+
/**
|
|
111497
|
+
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
111291
111498
|
*
|
|
111292
111499
|
* @remarks
|
|
111293
111500
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -111295,7 +111502,7 @@ declare namespace Word {
|
|
|
111295
111502
|
*/
|
|
111296
111503
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
111297
111504
|
/**
|
|
111298
|
-
* The relative vertical position of the shape. For
|
|
111505
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
111299
111506
|
*
|
|
111300
111507
|
* @remarks
|
|
111301
111508
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -111303,7 +111510,7 @@ declare namespace Word {
|
|
|
111303
111510
|
*/
|
|
111304
111511
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
111305
111512
|
/**
|
|
111306
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position. For
|
|
111513
|
+
* 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.
|
|
111307
111514
|
*
|
|
111308
111515
|
* @remarks
|
|
111309
111516
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -111319,6 +111526,17 @@ declare namespace Word {
|
|
|
111319
111526
|
*/
|
|
111320
111527
|
width?: number;
|
|
111321
111528
|
}
|
|
111529
|
+
/** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
|
|
111530
|
+
interface ShapeGroupUpdateData {
|
|
111531
|
+
/**
|
|
111532
|
+
* Gets the Shape object associated with the group.
|
|
111533
|
+
*
|
|
111534
|
+
* @remarks
|
|
111535
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111536
|
+
* @beta
|
|
111537
|
+
*/
|
|
111538
|
+
shape?: Word.Interfaces.ShapeUpdateData;
|
|
111539
|
+
}
|
|
111322
111540
|
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
111323
111541
|
interface ShapeCollectionUpdateData {
|
|
111324
111542
|
items?: Word.Interfaces.ShapeData[];
|
|
@@ -111401,7 +111619,7 @@ declare namespace Word {
|
|
|
111401
111619
|
*/
|
|
111402
111620
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
111403
111621
|
/**
|
|
111404
|
-
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only text boxes
|
|
111622
|
+
* Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
111405
111623
|
*
|
|
111406
111624
|
* @remarks
|
|
111407
111625
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -112592,19 +112810,19 @@ declare namespace Word {
|
|
|
112592
112810
|
*/
|
|
112593
112811
|
listItem?: Word.Interfaces.ListItemData;
|
|
112594
112812
|
/**
|
|
112595
|
-
|
|
112596
|
-
|
|
112597
|
-
|
|
112598
|
-
|
|
112599
|
-
|
|
112813
|
+
* Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
112814
|
+
*
|
|
112815
|
+
* @remarks
|
|
112816
|
+
* [Api set: WordApi 1.3]
|
|
112817
|
+
*/
|
|
112600
112818
|
listItemOrNullObject?: Word.Interfaces.ListItemData;
|
|
112601
112819
|
/**
|
|
112602
|
-
|
|
112603
|
-
|
|
112604
|
-
|
|
112605
|
-
|
|
112606
|
-
|
|
112607
|
-
|
|
112820
|
+
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
112821
|
+
*
|
|
112822
|
+
* @remarks
|
|
112823
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
112824
|
+
* @beta
|
|
112825
|
+
*/
|
|
112608
112826
|
shapes?: Word.Interfaces.ShapeData[];
|
|
112609
112827
|
/**
|
|
112610
112828
|
* Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
|
|
@@ -112834,33 +113052,33 @@ declare namespace Word {
|
|
|
112834
113052
|
/** An interface describing the data returned by calling `range.toJSON()`. */
|
|
112835
113053
|
interface RangeData {
|
|
112836
113054
|
/**
|
|
112837
|
-
|
|
112838
|
-
|
|
112839
|
-
|
|
112840
|
-
|
|
112841
|
-
|
|
113055
|
+
* Gets the collection of field objects in the range.
|
|
113056
|
+
*
|
|
113057
|
+
* @remarks
|
|
113058
|
+
* [Api set: WordApi 1.4]
|
|
113059
|
+
*/
|
|
112842
113060
|
fields?: Word.Interfaces.FieldData[];
|
|
112843
113061
|
/**
|
|
112844
|
-
|
|
112845
|
-
|
|
112846
|
-
|
|
112847
|
-
|
|
112848
|
-
|
|
113062
|
+
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
|
|
113063
|
+
*
|
|
113064
|
+
* @remarks
|
|
113065
|
+
* [Api set: WordApi 1.1]
|
|
113066
|
+
*/
|
|
112849
113067
|
font?: Word.Interfaces.FontData;
|
|
112850
113068
|
/**
|
|
112851
|
-
|
|
112852
|
-
|
|
112853
|
-
|
|
112854
|
-
|
|
112855
|
-
|
|
113069
|
+
* Gets the collection of inline picture objects in the range.
|
|
113070
|
+
*
|
|
113071
|
+
* @remarks
|
|
113072
|
+
* [Api set: WordApi 1.2]
|
|
113073
|
+
*/
|
|
112856
113074
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
112857
113075
|
/**
|
|
112858
|
-
|
|
112859
|
-
|
|
112860
|
-
|
|
112861
|
-
|
|
112862
|
-
|
|
112863
|
-
|
|
113076
|
+
* Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
113077
|
+
*
|
|
113078
|
+
* @remarks
|
|
113079
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113080
|
+
* @beta
|
|
113081
|
+
*/
|
|
112864
113082
|
shapes?: Word.Interfaces.ShapeData[];
|
|
112865
113083
|
/**
|
|
112866
113084
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
|
|
@@ -113573,13 +113791,29 @@ declare namespace Word {
|
|
|
113573
113791
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
113574
113792
|
interface ShapeData {
|
|
113575
113793
|
/**
|
|
113576
|
-
|
|
113577
|
-
|
|
113578
|
-
|
|
113579
|
-
|
|
113580
|
-
|
|
113581
|
-
|
|
113794
|
+
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
|
|
113795
|
+
*
|
|
113796
|
+
* @remarks
|
|
113797
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113798
|
+
* @beta
|
|
113799
|
+
*/
|
|
113582
113800
|
body?: Word.Interfaces.BodyData;
|
|
113801
|
+
/**
|
|
113802
|
+
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
113803
|
+
*
|
|
113804
|
+
* @remarks
|
|
113805
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113806
|
+
* @beta
|
|
113807
|
+
*/
|
|
113808
|
+
shapeGroup?: Word.Interfaces.ShapeGroupData;
|
|
113809
|
+
/**
|
|
113810
|
+
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
113811
|
+
*
|
|
113812
|
+
* @remarks
|
|
113813
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113814
|
+
* @beta
|
|
113815
|
+
*/
|
|
113816
|
+
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";
|
|
113583
113817
|
/**
|
|
113584
113818
|
* The height, in points, of the shape.
|
|
113585
113819
|
*
|
|
@@ -113597,7 +113831,7 @@ declare namespace Word {
|
|
|
113597
113831
|
*/
|
|
113598
113832
|
id?: number;
|
|
113599
113833
|
/**
|
|
113600
|
-
* The distance, in points, from the left side of the shape to the horizontal relative position. For
|
|
113834
|
+
* 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.
|
|
113601
113835
|
*
|
|
113602
113836
|
* @remarks
|
|
113603
113837
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -113605,7 +113839,15 @@ declare namespace Word {
|
|
|
113605
113839
|
*/
|
|
113606
113840
|
left?: number;
|
|
113607
113841
|
/**
|
|
113608
|
-
* The
|
|
113842
|
+
* The name of the shape.
|
|
113843
|
+
*
|
|
113844
|
+
* @remarks
|
|
113845
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113846
|
+
* @beta
|
|
113847
|
+
*/
|
|
113848
|
+
name?: string;
|
|
113849
|
+
/**
|
|
113850
|
+
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
113609
113851
|
*
|
|
113610
113852
|
* @remarks
|
|
113611
113853
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -113613,7 +113855,7 @@ declare namespace Word {
|
|
|
113613
113855
|
*/
|
|
113614
113856
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
113615
113857
|
/**
|
|
113616
|
-
* The relative vertical position of the shape. For
|
|
113858
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
113617
113859
|
*
|
|
113618
113860
|
* @remarks
|
|
113619
113861
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -113621,7 +113863,7 @@ declare namespace Word {
|
|
|
113621
113863
|
*/
|
|
113622
113864
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
113623
113865
|
/**
|
|
113624
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position. For
|
|
113866
|
+
* 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.
|
|
113625
113867
|
*
|
|
113626
113868
|
* @remarks
|
|
113627
113869
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -113629,13 +113871,13 @@ declare namespace Word {
|
|
|
113629
113871
|
*/
|
|
113630
113872
|
top?: number;
|
|
113631
113873
|
/**
|
|
113632
|
-
* Gets the shape type. Currently, only text boxes
|
|
113874
|
+
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
113633
113875
|
*
|
|
113634
113876
|
* @remarks
|
|
113635
113877
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113636
113878
|
* @beta
|
|
113637
113879
|
*/
|
|
113638
|
-
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
|
|
113880
|
+
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture";
|
|
113639
113881
|
/**
|
|
113640
113882
|
* The width, in points, of the shape.
|
|
113641
113883
|
*
|
|
@@ -113645,6 +113887,33 @@ declare namespace Word {
|
|
|
113645
113887
|
*/
|
|
113646
113888
|
width?: number;
|
|
113647
113889
|
}
|
|
113890
|
+
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
|
|
113891
|
+
interface ShapeGroupData {
|
|
113892
|
+
/**
|
|
113893
|
+
* Gets the Shape object associated with the group.
|
|
113894
|
+
*
|
|
113895
|
+
* @remarks
|
|
113896
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113897
|
+
* @beta
|
|
113898
|
+
*/
|
|
113899
|
+
shape?: Word.Interfaces.ShapeData;
|
|
113900
|
+
/**
|
|
113901
|
+
* Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.
|
|
113902
|
+
*
|
|
113903
|
+
* @remarks
|
|
113904
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113905
|
+
* @beta
|
|
113906
|
+
*/
|
|
113907
|
+
shapes?: Word.Interfaces.ShapeData[];
|
|
113908
|
+
/**
|
|
113909
|
+
* Gets an integer that represents the shape group identifier.
|
|
113910
|
+
*
|
|
113911
|
+
* @remarks
|
|
113912
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113913
|
+
* @beta
|
|
113914
|
+
*/
|
|
113915
|
+
id?: number;
|
|
113916
|
+
}
|
|
113648
113917
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
113649
113918
|
interface ShapeCollectionData {
|
|
113650
113919
|
items?: Word.Interfaces.ShapeData[];
|
|
@@ -118029,7 +118298,7 @@ declare namespace Word {
|
|
|
118029
118298
|
type?: boolean;
|
|
118030
118299
|
}
|
|
118031
118300
|
/**
|
|
118032
|
-
* Represents a shape in the header footer or document body. Currently, only text boxes
|
|
118301
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
118033
118302
|
*
|
|
118034
118303
|
* @remarks
|
|
118035
118304
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118048,6 +118317,22 @@ declare namespace Word {
|
|
|
118048
118317
|
* @beta
|
|
118049
118318
|
*/
|
|
118050
118319
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
118320
|
+
/**
|
|
118321
|
+
* Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
118322
|
+
*
|
|
118323
|
+
* @remarks
|
|
118324
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118325
|
+
* @beta
|
|
118326
|
+
*/
|
|
118327
|
+
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
118328
|
+
/**
|
|
118329
|
+
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
118330
|
+
*
|
|
118331
|
+
* @remarks
|
|
118332
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118333
|
+
* @beta
|
|
118334
|
+
*/
|
|
118335
|
+
geometricShapeType?: boolean;
|
|
118051
118336
|
/**
|
|
118052
118337
|
* The height, in points, of the shape.
|
|
118053
118338
|
*
|
|
@@ -118065,7 +118350,7 @@ declare namespace Word {
|
|
|
118065
118350
|
*/
|
|
118066
118351
|
id?: boolean;
|
|
118067
118352
|
/**
|
|
118068
|
-
* The distance, in points, from the left side of the shape to the horizontal relative position. For
|
|
118353
|
+
* 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.
|
|
118069
118354
|
*
|
|
118070
118355
|
* @remarks
|
|
118071
118356
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118073,7 +118358,15 @@ declare namespace Word {
|
|
|
118073
118358
|
*/
|
|
118074
118359
|
left?: boolean;
|
|
118075
118360
|
/**
|
|
118076
|
-
* The
|
|
118361
|
+
* The name of the shape.
|
|
118362
|
+
*
|
|
118363
|
+
* @remarks
|
|
118364
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118365
|
+
* @beta
|
|
118366
|
+
*/
|
|
118367
|
+
name?: boolean;
|
|
118368
|
+
/**
|
|
118369
|
+
* The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
118077
118370
|
*
|
|
118078
118371
|
* @remarks
|
|
118079
118372
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118081,7 +118374,7 @@ declare namespace Word {
|
|
|
118081
118374
|
*/
|
|
118082
118375
|
relativeHorizontalPosition?: boolean;
|
|
118083
118376
|
/**
|
|
118084
|
-
* The relative vertical position of the shape. For
|
|
118377
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
118085
118378
|
*
|
|
118086
118379
|
* @remarks
|
|
118087
118380
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118089,7 +118382,7 @@ declare namespace Word {
|
|
|
118089
118382
|
*/
|
|
118090
118383
|
relativeVerticalPosition?: boolean;
|
|
118091
118384
|
/**
|
|
118092
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position. For
|
|
118385
|
+
* 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.
|
|
118093
118386
|
*
|
|
118094
118387
|
* @remarks
|
|
118095
118388
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118097,7 +118390,7 @@ declare namespace Word {
|
|
|
118097
118390
|
*/
|
|
118098
118391
|
top?: boolean;
|
|
118099
118392
|
/**
|
|
118100
|
-
* Gets the shape type. Currently, only text boxes
|
|
118393
|
+
* Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
118101
118394
|
*
|
|
118102
118395
|
* @remarks
|
|
118103
118396
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118114,7 +118407,36 @@ declare namespace Word {
|
|
|
118114
118407
|
width?: boolean;
|
|
118115
118408
|
}
|
|
118116
118409
|
/**
|
|
118117
|
-
*
|
|
118410
|
+
* Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
|
|
118411
|
+
*
|
|
118412
|
+
* @remarks
|
|
118413
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118414
|
+
* @beta
|
|
118415
|
+
*/
|
|
118416
|
+
interface ShapeGroupLoadOptions {
|
|
118417
|
+
/**
|
|
118418
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118419
|
+
*/
|
|
118420
|
+
$all?: boolean;
|
|
118421
|
+
/**
|
|
118422
|
+
* Gets the Shape object associated with the group.
|
|
118423
|
+
*
|
|
118424
|
+
* @remarks
|
|
118425
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118426
|
+
* @beta
|
|
118427
|
+
*/
|
|
118428
|
+
shape?: Word.Interfaces.ShapeLoadOptions;
|
|
118429
|
+
/**
|
|
118430
|
+
* Gets an integer that represents the shape group identifier.
|
|
118431
|
+
*
|
|
118432
|
+
* @remarks
|
|
118433
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118434
|
+
* @beta
|
|
118435
|
+
*/
|
|
118436
|
+
id?: boolean;
|
|
118437
|
+
}
|
|
118438
|
+
/**
|
|
118439
|
+
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
118118
118440
|
*
|
|
118119
118441
|
* @remarks
|
|
118120
118442
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118133,6 +118455,22 @@ declare namespace Word {
|
|
|
118133
118455
|
* @beta
|
|
118134
118456
|
*/
|
|
118135
118457
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
118458
|
+
/**
|
|
118459
|
+
* For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
118460
|
+
*
|
|
118461
|
+
* @remarks
|
|
118462
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118463
|
+
* @beta
|
|
118464
|
+
*/
|
|
118465
|
+
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
|
|
118466
|
+
/**
|
|
118467
|
+
* For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
118468
|
+
*
|
|
118469
|
+
* @remarks
|
|
118470
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118471
|
+
* @beta
|
|
118472
|
+
*/
|
|
118473
|
+
geometricShapeType?: boolean;
|
|
118136
118474
|
/**
|
|
118137
118475
|
* For EACH ITEM in the collection: The height, in points, of the shape.
|
|
118138
118476
|
*
|
|
@@ -118150,7 +118488,7 @@ declare namespace Word {
|
|
|
118150
118488
|
*/
|
|
118151
118489
|
id?: boolean;
|
|
118152
118490
|
/**
|
|
118153
|
-
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position. For
|
|
118491
|
+
* 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.
|
|
118154
118492
|
*
|
|
118155
118493
|
* @remarks
|
|
118156
118494
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118158,7 +118496,15 @@ declare namespace Word {
|
|
|
118158
118496
|
*/
|
|
118159
118497
|
left?: boolean;
|
|
118160
118498
|
/**
|
|
118161
|
-
* For EACH ITEM in the collection: The
|
|
118499
|
+
* For EACH ITEM in the collection: The name of the shape.
|
|
118500
|
+
*
|
|
118501
|
+
* @remarks
|
|
118502
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
118503
|
+
* @beta
|
|
118504
|
+
*/
|
|
118505
|
+
name?: boolean;
|
|
118506
|
+
/**
|
|
118507
|
+
* 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}.
|
|
118162
118508
|
*
|
|
118163
118509
|
* @remarks
|
|
118164
118510
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118166,7 +118512,7 @@ declare namespace Word {
|
|
|
118166
118512
|
*/
|
|
118167
118513
|
relativeHorizontalPosition?: boolean;
|
|
118168
118514
|
/**
|
|
118169
|
-
* For EACH ITEM in the collection: The relative vertical position of the shape. For
|
|
118515
|
+
* 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}.
|
|
118170
118516
|
*
|
|
118171
118517
|
* @remarks
|
|
118172
118518
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118174,7 +118520,7 @@ declare namespace Word {
|
|
|
118174
118520
|
*/
|
|
118175
118521
|
relativeVerticalPosition?: boolean;
|
|
118176
118522
|
/**
|
|
118177
|
-
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position. For
|
|
118523
|
+
* 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.
|
|
118178
118524
|
*
|
|
118179
118525
|
* @remarks
|
|
118180
118526
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -118182,7 +118528,7 @@ declare namespace Word {
|
|
|
118182
118528
|
*/
|
|
118183
118529
|
top?: boolean;
|
|
118184
118530
|
/**
|
|
118185
|
-
* For EACH ITEM in the collection: Gets the shape type. Currently, only text boxes
|
|
118531
|
+
* For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
|
|
118186
118532
|
*
|
|
118187
118533
|
* @remarks
|
|
118188
118534
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.546",
|
|
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": "
|
|
49
|
+
"typesPublisherContentHash": "268d099f726a661f15825f5e9c8d165d232a53ee720178e3ad13aed621fe7a10",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|