Skip to content

Commit 0bde9c6

Browse files
ElizabethSamuel-MSFTElizabethSamuel-MSFT
authored
[office-js-preview] (Word) Updates from CDN (DefinitelyTyped#71756)
1 parent de0f712 commit 0bde9c6

File tree

1 file changed

+101
-19
lines changed

1 file changed

+101
-19
lines changed

‎types/office-js-preview/index.d.ts‎

Lines changed: 101 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -104143,6 +104143,14 @@ declare namespace Word {
104143104143
* @beta
104144104144
*/
104145104145
readonly body: Word.Body;
104146+
/**
104147+
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
104148+
*
104149+
* @remarks
104150+
* [Api set: WordApi BETA (PREVIEW ONLY)]
104151+
* @beta
104152+
*/
104153+
readonly parentGroup: Word.Shape;
104146104154
/**
104147104155
* 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}.
104148104156
*
@@ -104175,6 +104183,14 @@ declare namespace Word {
104175104183
* @beta
104176104184
*/
104177104185
readonly id: number;
104186+
/**
104187+
* Check whether this shape is a child of a group shape or a canvas shape.
104188+
*
104189+
* @remarks
104190+
* [Api set: WordApi BETA (PREVIEW ONLY)]
104191+
* @beta
104192+
*/
104193+
readonly isChild: boolean;
104178104194
/**
104179104195
* 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.
104180104196
*
@@ -104361,7 +104377,7 @@ declare namespace Word {
104361104377
* [Api set: WordApi BETA (PREVIEW ONLY)]
104362104378
* @beta
104363104379
*/
104364-
unGroup(): Word.ShapeCollection;
104380+
ungroup(): Word.ShapeCollection;
104365104381
/**
104366104382
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
104367104383
*
@@ -104449,6 +104465,16 @@ declare namespace Word {
104449104465
* @param ids Required. An array of shape identifiers.
104450104466
*/
104451104467
getByIds(ids: number[]): Word.ShapeCollection;
104468+
/**
104469+
* Gets the shapes that have the specified names.
104470+
*
104471+
* @remarks
104472+
* [Api set: WordApi BETA (PREVIEW ONLY)]
104473+
* @beta
104474+
*
104475+
* @param names Required. An array of shape names.
104476+
*/
104477+
getByNames(names: string[]): Word.ShapeCollection;
104452104478
/**
104453104479
* Gets the shapes that have the specified types.
104454104480
*
@@ -111447,13 +111473,21 @@ declare namespace Word {
111447111473
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
111448111474
interface ShapeUpdateData {
111449111475
/**
111450-
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
111451-
*
111452-
* @remarks
111453-
* [Api set: WordApi BETA (PREVIEW ONLY)]
111454-
* @beta
111455-
*/
111476+
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
111477+
*
111478+
* @remarks
111479+
* [Api set: WordApi BETA (PREVIEW ONLY)]
111480+
* @beta
111481+
*/
111456111482
body?: Word.Interfaces.BodyUpdateData;
111483+
/**
111484+
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
111485+
*
111486+
* @remarks
111487+
* [Api set: WordApi BETA (PREVIEW ONLY)]
111488+
* @beta
111489+
*/
111490+
parentGroup?: Word.Interfaces.ShapeUpdateData;
111457111491
/**
111458111492
* 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}.
111459111493
*
@@ -113799,6 +113833,14 @@ declare namespace Word {
113799113833
* @beta
113800113834
*/
113801113835
body?: Word.Interfaces.BodyData;
113836+
/**
113837+
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
113838+
*
113839+
* @remarks
113840+
* [Api set: WordApi BETA (PREVIEW ONLY)]
113841+
* @beta
113842+
*/
113843+
parentGroup?: Word.Interfaces.ShapeData;
113802113844
/**
113803113845
* 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}.
113804113846
*
@@ -113831,6 +113873,14 @@ declare namespace Word {
113831113873
* @beta
113832113874
*/
113833113875
id?: number;
113876+
/**
113877+
* Check whether this shape is a child of a group shape or a canvas shape.
113878+
*
113879+
* @remarks
113880+
* [Api set: WordApi BETA (PREVIEW ONLY)]
113881+
* @beta
113882+
*/
113883+
isChild?: boolean;
113834113884
/**
113835113885
* 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.
113836113886
*
@@ -118311,13 +118361,21 @@ declare namespace Word {
118311118361
*/
118312118362
$all?: boolean;
118313118363
/**
118314-
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
118315-
*
118316-
* @remarks
118317-
* [Api set: WordApi BETA (PREVIEW ONLY)]
118318-
* @beta
118319-
*/
118364+
* Represents the body object of the shape. Only applies to text boxes and geometric shapes.
118365+
*
118366+
* @remarks
118367+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118368+
* @beta
118369+
*/
118320118370
body?: Word.Interfaces.BodyLoadOptions;
118371+
/**
118372+
* Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
118373+
*
118374+
* @remarks
118375+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118376+
* @beta
118377+
*/
118378+
parentGroup?: Word.Interfaces.ShapeLoadOptions;
118321118379
/**
118322118380
* 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}.
118323118381
*
@@ -118350,6 +118408,14 @@ declare namespace Word {
118350118408
* @beta
118351118409
*/
118352118410
id?: boolean;
118411+
/**
118412+
* Check whether this shape is a child of a group shape or a canvas shape.
118413+
*
118414+
* @remarks
118415+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118416+
* @beta
118417+
*/
118418+
isChild?: boolean;
118353118419
/**
118354118420
* 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.
118355118421
*
@@ -118449,13 +118515,21 @@ declare namespace Word {
118449118515
*/
118450118516
$all?: boolean;
118451118517
/**
118452-
* For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
118453-
*
118454-
* @remarks
118455-
* [Api set: WordApi BETA (PREVIEW ONLY)]
118456-
* @beta
118457-
*/
118518+
* For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
118519+
*
118520+
* @remarks
118521+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118522+
* @beta
118523+
*/
118458118524
body?: Word.Interfaces.BodyLoadOptions;
118525+
/**
118526+
* For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
118527+
*
118528+
* @remarks
118529+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118530+
* @beta
118531+
*/
118532+
parentGroup?: Word.Interfaces.ShapeLoadOptions;
118459118533
/**
118460118534
* 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}.
118461118535
*
@@ -118488,6 +118562,14 @@ declare namespace Word {
118488118562
* @beta
118489118563
*/
118490118564
id?: boolean;
118565+
/**
118566+
* For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.
118567+
*
118568+
* @remarks
118569+
* [Api set: WordApi BETA (PREVIEW ONLY)]
118570+
* @beta
118571+
*/
118572+
isChild?: boolean;
118491118573
/**
118492118574
* 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.
118493118575
*

0 commit comments

Comments
 (0)