@types/office-js-preview 1.0.558 → 1.0.560
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 +532 -74
- 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:
|
|
11
|
+
* Last updated: Thu, 20 Feb 2025 18:37:24 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -10659,9 +10659,6 @@ declare namespace Office {
|
|
|
10659
10659
|
*
|
|
10660
10660
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10661
10661
|
*
|
|
10662
|
-
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
10663
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
10664
|
-
*
|
|
10665
10662
|
* @remarks
|
|
10666
10663
|
* [Api set: Mailbox 1.8]
|
|
10667
10664
|
*
|
|
@@ -10669,6 +10666,18 @@ declare namespace Office {
|
|
|
10669
10666
|
*
|
|
10670
10667
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10671
10668
|
*
|
|
10669
|
+
* **Important**:
|
|
10670
|
+
*
|
|
10671
|
+
* - If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
10672
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
10673
|
+
*
|
|
10674
|
+
* - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
|
|
10675
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
|
|
10676
|
+
* If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
|
|
10677
|
+
* Otherwise, the image won't render in the body once it's inserted. For an example, see the
|
|
10678
|
+
* {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
|
|
10679
|
+
* sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
|
|
10680
|
+
*
|
|
10672
10681
|
* **Errors**:
|
|
10673
10682
|
*
|
|
10674
10683
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
@@ -10677,11 +10686,6 @@ declare namespace Office {
|
|
|
10677
10686
|
*
|
|
10678
10687
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
10679
10688
|
*
|
|
10680
|
-
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
10681
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
10682
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
10683
|
-
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
10684
|
-
*
|
|
10685
10689
|
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
10686
10690
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
10687
10691
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -10702,9 +10706,6 @@ declare namespace Office {
|
|
|
10702
10706
|
*
|
|
10703
10707
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10704
10708
|
*
|
|
10705
|
-
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
10706
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
10707
|
-
*
|
|
10708
10709
|
* @remarks
|
|
10709
10710
|
* [Api set: Mailbox 1.8]
|
|
10710
10711
|
*
|
|
@@ -10712,6 +10713,18 @@ declare namespace Office {
|
|
|
10712
10713
|
*
|
|
10713
10714
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10714
10715
|
*
|
|
10716
|
+
* **Important**:
|
|
10717
|
+
*
|
|
10718
|
+
* - If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
10719
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
10720
|
+
*
|
|
10721
|
+
* - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
|
|
10722
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
|
|
10723
|
+
* If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
|
|
10724
|
+
* Otherwise, the image won't render in the body once it's inserted. For an example, see the
|
|
10725
|
+
* {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
|
|
10726
|
+
* sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
|
|
10727
|
+
*
|
|
10715
10728
|
* **Errors**:
|
|
10716
10729
|
*
|
|
10717
10730
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
@@ -10720,11 +10733,6 @@ declare namespace Office {
|
|
|
10720
10733
|
*
|
|
10721
10734
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
10722
10735
|
*
|
|
10723
|
-
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
10724
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
10725
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
10726
|
-
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
10727
|
-
*
|
|
10728
10736
|
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
10729
10737
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
10730
10738
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -18867,10 +18875,12 @@ declare namespace Office {
|
|
|
18867
18875
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
18868
18876
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
18869
18877
|
*
|
|
18870
|
-
* -
|
|
18871
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body
|
|
18872
|
-
*
|
|
18873
|
-
*
|
|
18878
|
+
* - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
|
|
18879
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
|
|
18880
|
+
* If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
|
|
18881
|
+
* Otherwise, the image won't render in the body once it's inserted. For an example, see the
|
|
18882
|
+
* {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
|
|
18883
|
+
* sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
|
|
18874
18884
|
*
|
|
18875
18885
|
* **Errors**:
|
|
18876
18886
|
*
|
|
@@ -18913,10 +18923,12 @@ declare namespace Office {
|
|
|
18913
18923
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
18914
18924
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
18915
18925
|
*
|
|
18916
|
-
* -
|
|
18917
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body
|
|
18918
|
-
*
|
|
18919
|
-
*
|
|
18926
|
+
* - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
|
|
18927
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
|
|
18928
|
+
* If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
|
|
18929
|
+
* Otherwise, the image won't render in the body once it's inserted. For an example, see the
|
|
18930
|
+
* {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
|
|
18931
|
+
* sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
|
|
18920
18932
|
*
|
|
18921
18933
|
* **Errors**:
|
|
18922
18934
|
*
|
|
@@ -104720,7 +104732,7 @@ declare namespace Word {
|
|
|
104720
104732
|
*/
|
|
104721
104733
|
readonly canvas: Word.Canvas;
|
|
104722
104734
|
/**
|
|
104723
|
-
* Returns the fill formatting of
|
|
104735
|
+
* Returns the fill formatting of the shape.
|
|
104724
104736
|
*
|
|
104725
104737
|
* @remarks
|
|
104726
104738
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104759,6 +104771,22 @@ declare namespace Word {
|
|
|
104759
104771
|
* @beta
|
|
104760
104772
|
*/
|
|
104761
104773
|
readonly textFrame: Word.TextFrame;
|
|
104774
|
+
/**
|
|
104775
|
+
* Returns the text wrap formatting of the shape.
|
|
104776
|
+
*
|
|
104777
|
+
* @remarks
|
|
104778
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104779
|
+
* @beta
|
|
104780
|
+
*/
|
|
104781
|
+
readonly textWrap: Word.ShapeTextWrap;
|
|
104782
|
+
/**
|
|
104783
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
104784
|
+
*
|
|
104785
|
+
* @remarks
|
|
104786
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104787
|
+
* @beta
|
|
104788
|
+
*/
|
|
104789
|
+
allowOverlap: boolean;
|
|
104762
104790
|
/**
|
|
104763
104791
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
104764
104792
|
*
|
|
@@ -105454,6 +105482,107 @@ declare namespace Word {
|
|
|
105454
105482
|
*/
|
|
105455
105483
|
toJSON(): Word.Interfaces.TextFrameData;
|
|
105456
105484
|
}
|
|
105485
|
+
/**
|
|
105486
|
+
* Represents all the properties for wrapping text around a shape.
|
|
105487
|
+
*
|
|
105488
|
+
* @remarks
|
|
105489
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105490
|
+
* @beta
|
|
105491
|
+
*/
|
|
105492
|
+
class ShapeTextWrap extends OfficeExtension.ClientObject {
|
|
105493
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
105494
|
+
context: RequestContext;
|
|
105495
|
+
/**
|
|
105496
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
105497
|
+
*
|
|
105498
|
+
* @remarks
|
|
105499
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105500
|
+
* @beta
|
|
105501
|
+
*/
|
|
105502
|
+
bottomDistance: number;
|
|
105503
|
+
/**
|
|
105504
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
105505
|
+
*
|
|
105506
|
+
* @remarks
|
|
105507
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105508
|
+
* @beta
|
|
105509
|
+
*/
|
|
105510
|
+
leftDistance: number;
|
|
105511
|
+
/**
|
|
105512
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
105513
|
+
*
|
|
105514
|
+
* @remarks
|
|
105515
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105516
|
+
* @beta
|
|
105517
|
+
*/
|
|
105518
|
+
rightDistance: number;
|
|
105519
|
+
/**
|
|
105520
|
+
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
105521
|
+
*
|
|
105522
|
+
* @remarks
|
|
105523
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105524
|
+
* @beta
|
|
105525
|
+
*/
|
|
105526
|
+
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
105527
|
+
/**
|
|
105528
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
105529
|
+
*
|
|
105530
|
+
* @remarks
|
|
105531
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105532
|
+
* @beta
|
|
105533
|
+
*/
|
|
105534
|
+
topDistance: number;
|
|
105535
|
+
/**
|
|
105536
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
105537
|
+
*
|
|
105538
|
+
* @remarks
|
|
105539
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105540
|
+
* @beta
|
|
105541
|
+
*/
|
|
105542
|
+
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
105543
|
+
/**
|
|
105544
|
+
* 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.
|
|
105545
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
105546
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
105547
|
+
*/
|
|
105548
|
+
set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
105549
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
105550
|
+
set(properties: Word.ShapeTextWrap): void;
|
|
105551
|
+
/**
|
|
105552
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
105553
|
+
*
|
|
105554
|
+
* @param options Provides options for which properties of the object to load.
|
|
105555
|
+
*/
|
|
105556
|
+
load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap;
|
|
105557
|
+
/**
|
|
105558
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
105559
|
+
*
|
|
105560
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
105561
|
+
*/
|
|
105562
|
+
load(propertyNames?: string | string[]): Word.ShapeTextWrap;
|
|
105563
|
+
/**
|
|
105564
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
105565
|
+
*
|
|
105566
|
+
* @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.
|
|
105567
|
+
*/
|
|
105568
|
+
load(propertyNamesAndPaths?: {
|
|
105569
|
+
select?: string;
|
|
105570
|
+
expand?: string;
|
|
105571
|
+
}): Word.ShapeTextWrap;
|
|
105572
|
+
/**
|
|
105573
|
+
* 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.
|
|
105574
|
+
*/
|
|
105575
|
+
track(): Word.ShapeTextWrap;
|
|
105576
|
+
/**
|
|
105577
|
+
* 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.
|
|
105578
|
+
*/
|
|
105579
|
+
untrack(): Word.ShapeTextWrap;
|
|
105580
|
+
/**
|
|
105581
|
+
* 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.)
|
|
105582
|
+
* Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object.
|
|
105583
|
+
*/
|
|
105584
|
+
toJSON(): Word.Interfaces.ShapeTextWrapData;
|
|
105585
|
+
}
|
|
105457
105586
|
/**
|
|
105458
105587
|
* ChangeTracking mode.
|
|
105459
105588
|
*
|
|
@@ -111047,6 +111176,108 @@ declare namespace Word {
|
|
|
111047
111176
|
*/
|
|
111048
111177
|
mixed = "Mixed",
|
|
111049
111178
|
}
|
|
111179
|
+
/**
|
|
111180
|
+
* Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}.
|
|
111181
|
+
*
|
|
111182
|
+
* @remarks
|
|
111183
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111184
|
+
* @beta
|
|
111185
|
+
*/
|
|
111186
|
+
enum ShapeTextWrapType {
|
|
111187
|
+
/**
|
|
111188
|
+
* Places the shape in line with text.
|
|
111189
|
+
* @remarks
|
|
111190
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111191
|
+
* @beta
|
|
111192
|
+
*/
|
|
111193
|
+
inline = "Inline",
|
|
111194
|
+
/**
|
|
111195
|
+
* Wraps text squarely around the shape.
|
|
111196
|
+
* @remarks
|
|
111197
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111198
|
+
* @beta
|
|
111199
|
+
*/
|
|
111200
|
+
square = "Square",
|
|
111201
|
+
/**
|
|
111202
|
+
* Wraps text close to the shape.
|
|
111203
|
+
* @remarks
|
|
111204
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111205
|
+
* @beta
|
|
111206
|
+
*/
|
|
111207
|
+
tight = "Tight",
|
|
111208
|
+
/**
|
|
111209
|
+
* Wraps text around and through the shape.
|
|
111210
|
+
* @remarks
|
|
111211
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111212
|
+
* @beta
|
|
111213
|
+
*/
|
|
111214
|
+
through = "Through",
|
|
111215
|
+
/**
|
|
111216
|
+
* Places text above and below the shape.
|
|
111217
|
+
* @remarks
|
|
111218
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111219
|
+
* @beta
|
|
111220
|
+
*/
|
|
111221
|
+
topBottom = "TopBottom",
|
|
111222
|
+
/**
|
|
111223
|
+
* Places shape behind text.
|
|
111224
|
+
* @remarks
|
|
111225
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111226
|
+
* @beta
|
|
111227
|
+
*/
|
|
111228
|
+
behind = "Behind",
|
|
111229
|
+
/**
|
|
111230
|
+
* Places shape in front of text.
|
|
111231
|
+
* @remarks
|
|
111232
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111233
|
+
* @beta
|
|
111234
|
+
*/
|
|
111235
|
+
front = "Front",
|
|
111236
|
+
}
|
|
111237
|
+
/**
|
|
111238
|
+
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin.
|
|
111239
|
+
*
|
|
111240
|
+
* @remarks
|
|
111241
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111242
|
+
* @beta
|
|
111243
|
+
*/
|
|
111244
|
+
enum ShapeTextWrapSide {
|
|
111245
|
+
/**
|
|
111246
|
+
* Has no wrap side property, such as those for inline shapes.
|
|
111247
|
+
* @remarks
|
|
111248
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111249
|
+
* @beta
|
|
111250
|
+
*/
|
|
111251
|
+
none = "None",
|
|
111252
|
+
/**
|
|
111253
|
+
* Both left and right sides of the shape.
|
|
111254
|
+
* @remarks
|
|
111255
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111256
|
+
* @beta
|
|
111257
|
+
*/
|
|
111258
|
+
both = "Both",
|
|
111259
|
+
/**
|
|
111260
|
+
* Left side of the shape only.
|
|
111261
|
+
* @remarks
|
|
111262
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111263
|
+
* @beta
|
|
111264
|
+
*/
|
|
111265
|
+
left = "Left",
|
|
111266
|
+
/**
|
|
111267
|
+
* Right side of the shape only.
|
|
111268
|
+
* @remarks
|
|
111269
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111270
|
+
* @beta
|
|
111271
|
+
*/
|
|
111272
|
+
right = "Right",
|
|
111273
|
+
/**
|
|
111274
|
+
* Side of the shape that's farther from the respective page margin.
|
|
111275
|
+
* @remarks
|
|
111276
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111277
|
+
* @beta
|
|
111278
|
+
*/
|
|
111279
|
+
largest = "Largest",
|
|
111280
|
+
}
|
|
111050
111281
|
enum ErrorCodes {
|
|
111051
111282
|
accessDenied = "AccessDenied",
|
|
111052
111283
|
generalException = "GeneralException",
|
|
@@ -111838,7 +112069,6 @@ declare namespace Word {
|
|
|
111838
112069
|
interface NoteItemCollectionUpdateData {
|
|
111839
112070
|
items?: Word.Interfaces.NoteItemData[];
|
|
111840
112071
|
}
|
|
111841
|
-
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
111842
112072
|
/** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */
|
|
111843
112073
|
interface PageCollectionUpdateData {
|
|
111844
112074
|
items?: Word.Interfaces.PageData[];
|
|
@@ -111851,6 +112081,7 @@ declare namespace Word {
|
|
|
111851
112081
|
interface WindowCollectionUpdateData {
|
|
111852
112082
|
items?: Word.Interfaces.WindowData[];
|
|
111853
112083
|
}
|
|
112084
|
+
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
111854
112085
|
interface ParagraphUpdateData {
|
|
111855
112086
|
/**
|
|
111856
112087
|
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
@@ -112606,7 +112837,7 @@ declare namespace Word {
|
|
|
112606
112837
|
*/
|
|
112607
112838
|
canvas?: Word.Interfaces.CanvasUpdateData;
|
|
112608
112839
|
/**
|
|
112609
|
-
* Returns the fill formatting of
|
|
112840
|
+
* Returns the fill formatting of the shape.
|
|
112610
112841
|
*
|
|
112611
112842
|
* @remarks
|
|
112612
112843
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -112645,6 +112876,22 @@ declare namespace Word {
|
|
|
112645
112876
|
* @beta
|
|
112646
112877
|
*/
|
|
112647
112878
|
textFrame?: Word.Interfaces.TextFrameUpdateData;
|
|
112879
|
+
/**
|
|
112880
|
+
* Returns the text wrap formatting of the shape.
|
|
112881
|
+
*
|
|
112882
|
+
* @remarks
|
|
112883
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
112884
|
+
* @beta
|
|
112885
|
+
*/
|
|
112886
|
+
textWrap?: Word.Interfaces.ShapeTextWrapUpdateData;
|
|
112887
|
+
/**
|
|
112888
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
112889
|
+
*
|
|
112890
|
+
* @remarks
|
|
112891
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
112892
|
+
* @beta
|
|
112893
|
+
*/
|
|
112894
|
+
allowOverlap?: boolean;
|
|
112648
112895
|
/**
|
|
112649
112896
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
112650
112897
|
*
|
|
@@ -112838,6 +113085,57 @@ declare namespace Word {
|
|
|
112838
113085
|
*/
|
|
112839
113086
|
wordWrap?: boolean;
|
|
112840
113087
|
}
|
|
113088
|
+
/** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */
|
|
113089
|
+
interface ShapeTextWrapUpdateData {
|
|
113090
|
+
/**
|
|
113091
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
113092
|
+
*
|
|
113093
|
+
* @remarks
|
|
113094
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113095
|
+
* @beta
|
|
113096
|
+
*/
|
|
113097
|
+
bottomDistance?: number;
|
|
113098
|
+
/**
|
|
113099
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
113100
|
+
*
|
|
113101
|
+
* @remarks
|
|
113102
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113103
|
+
* @beta
|
|
113104
|
+
*/
|
|
113105
|
+
leftDistance?: number;
|
|
113106
|
+
/**
|
|
113107
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
113108
|
+
*
|
|
113109
|
+
* @remarks
|
|
113110
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113111
|
+
* @beta
|
|
113112
|
+
*/
|
|
113113
|
+
rightDistance?: number;
|
|
113114
|
+
/**
|
|
113115
|
+
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
113116
|
+
*
|
|
113117
|
+
* @remarks
|
|
113118
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113119
|
+
* @beta
|
|
113120
|
+
*/
|
|
113121
|
+
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
113122
|
+
/**
|
|
113123
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
113124
|
+
*
|
|
113125
|
+
* @remarks
|
|
113126
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113127
|
+
* @beta
|
|
113128
|
+
*/
|
|
113129
|
+
topDistance?: number;
|
|
113130
|
+
/**
|
|
113131
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
113132
|
+
*
|
|
113133
|
+
* @remarks
|
|
113134
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113135
|
+
* @beta
|
|
113136
|
+
*/
|
|
113137
|
+
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
113138
|
+
}
|
|
112841
113139
|
/** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */
|
|
112842
113140
|
interface CritiqueAnnotationData {
|
|
112843
113141
|
/**
|
|
@@ -114455,7 +114753,7 @@ declare namespace Word {
|
|
|
114455
114753
|
*/
|
|
114456
114754
|
pages?: Word.Interfaces.PageData[];
|
|
114457
114755
|
/**
|
|
114458
|
-
* 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 shapes, groups, pictures and canvases.
|
|
114756
|
+
* 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 shapes, groups, pictures, and canvases.
|
|
114459
114757
|
*
|
|
114460
114758
|
* @remarks
|
|
114461
114759
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -115189,7 +115487,7 @@ declare namespace Word {
|
|
|
115189
115487
|
*/
|
|
115190
115488
|
canvas?: Word.Interfaces.CanvasData;
|
|
115191
115489
|
/**
|
|
115192
|
-
* Returns the fill formatting of
|
|
115490
|
+
* Returns the fill formatting of the shape.
|
|
115193
115491
|
*
|
|
115194
115492
|
* @remarks
|
|
115195
115493
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -115228,6 +115526,22 @@ declare namespace Word {
|
|
|
115228
115526
|
* @beta
|
|
115229
115527
|
*/
|
|
115230
115528
|
textFrame?: Word.Interfaces.TextFrameData;
|
|
115529
|
+
/**
|
|
115530
|
+
* Returns the text wrap formatting of the shape.
|
|
115531
|
+
*
|
|
115532
|
+
* @remarks
|
|
115533
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115534
|
+
* @beta
|
|
115535
|
+
*/
|
|
115536
|
+
textWrap?: Word.Interfaces.ShapeTextWrapData;
|
|
115537
|
+
/**
|
|
115538
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
115539
|
+
*
|
|
115540
|
+
* @remarks
|
|
115541
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115542
|
+
* @beta
|
|
115543
|
+
*/
|
|
115544
|
+
allowOverlap?: boolean;
|
|
115231
115545
|
/**
|
|
115232
115546
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
115233
115547
|
*
|
|
@@ -115493,6 +115807,57 @@ declare namespace Word {
|
|
|
115493
115807
|
*/
|
|
115494
115808
|
wordWrap?: boolean;
|
|
115495
115809
|
}
|
|
115810
|
+
/** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */
|
|
115811
|
+
interface ShapeTextWrapData {
|
|
115812
|
+
/**
|
|
115813
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
115814
|
+
*
|
|
115815
|
+
* @remarks
|
|
115816
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115817
|
+
* @beta
|
|
115818
|
+
*/
|
|
115819
|
+
bottomDistance?: number;
|
|
115820
|
+
/**
|
|
115821
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
115822
|
+
*
|
|
115823
|
+
* @remarks
|
|
115824
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115825
|
+
* @beta
|
|
115826
|
+
*/
|
|
115827
|
+
leftDistance?: number;
|
|
115828
|
+
/**
|
|
115829
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
115830
|
+
*
|
|
115831
|
+
* @remarks
|
|
115832
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115833
|
+
* @beta
|
|
115834
|
+
*/
|
|
115835
|
+
rightDistance?: number;
|
|
115836
|
+
/**
|
|
115837
|
+
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
115838
|
+
*
|
|
115839
|
+
* @remarks
|
|
115840
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115841
|
+
* @beta
|
|
115842
|
+
*/
|
|
115843
|
+
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
115844
|
+
/**
|
|
115845
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
115846
|
+
*
|
|
115847
|
+
* @remarks
|
|
115848
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115849
|
+
* @beta
|
|
115850
|
+
*/
|
|
115851
|
+
topDistance?: number;
|
|
115852
|
+
/**
|
|
115853
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
115854
|
+
*
|
|
115855
|
+
* @remarks
|
|
115856
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115857
|
+
* @beta
|
|
115858
|
+
*/
|
|
115859
|
+
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
115860
|
+
}
|
|
115496
115861
|
/**
|
|
115497
115862
|
* Represents an annotation wrapper around critique displayed in the document.
|
|
115498
115863
|
*
|
|
@@ -118494,60 +118859,60 @@ declare namespace Word {
|
|
|
118494
118859
|
*/
|
|
118495
118860
|
$all?: boolean;
|
|
118496
118861
|
/**
|
|
118497
|
-
|
|
118498
|
-
|
|
118499
|
-
|
|
118500
|
-
|
|
118501
|
-
|
|
118862
|
+
* For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
|
|
118863
|
+
*
|
|
118864
|
+
* @remarks
|
|
118865
|
+
* [Api set: WordApi 1.1]
|
|
118866
|
+
*/
|
|
118502
118867
|
font?: Word.Interfaces.FontLoadOptions;
|
|
118503
118868
|
/**
|
|
118504
|
-
|
|
118505
|
-
|
|
118506
|
-
|
|
118507
|
-
|
|
118508
|
-
|
|
118869
|
+
* For EACH ITEM in the collection: Gets the parent body of the range.
|
|
118870
|
+
*
|
|
118871
|
+
* @remarks
|
|
118872
|
+
* [Api set: WordApi 1.3]
|
|
118873
|
+
*/
|
|
118509
118874
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
118510
118875
|
/**
|
|
118511
|
-
|
|
118512
|
-
|
|
118513
|
-
|
|
118514
|
-
|
|
118515
|
-
|
|
118876
|
+
* For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
118877
|
+
*
|
|
118878
|
+
* @remarks
|
|
118879
|
+
* [Api set: WordApi 1.1]
|
|
118880
|
+
*/
|
|
118516
118881
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
118517
118882
|
/**
|
|
118518
|
-
|
|
118519
|
-
|
|
118520
|
-
|
|
118521
|
-
|
|
118522
|
-
|
|
118883
|
+
* For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, 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}.
|
|
118884
|
+
*
|
|
118885
|
+
* @remarks
|
|
118886
|
+
* [Api set: WordApi 1.3]
|
|
118887
|
+
*/
|
|
118523
118888
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
118524
118889
|
/**
|
|
118525
|
-
|
|
118526
|
-
|
|
118527
|
-
|
|
118528
|
-
|
|
118529
|
-
|
|
118890
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
118891
|
+
*
|
|
118892
|
+
* @remarks
|
|
118893
|
+
* [Api set: WordApi 1.3]
|
|
118894
|
+
*/
|
|
118530
118895
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
118531
118896
|
/**
|
|
118532
|
-
|
|
118533
|
-
|
|
118534
|
-
|
|
118535
|
-
|
|
118536
|
-
|
|
118897
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
118898
|
+
*
|
|
118899
|
+
* @remarks
|
|
118900
|
+
* [Api set: WordApi 1.3]
|
|
118901
|
+
*/
|
|
118537
118902
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
118538
118903
|
/**
|
|
118539
|
-
|
|
118540
|
-
|
|
118541
|
-
|
|
118542
|
-
|
|
118543
|
-
|
|
118904
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, 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}.
|
|
118905
|
+
*
|
|
118906
|
+
* @remarks
|
|
118907
|
+
* [Api set: WordApi 1.3]
|
|
118908
|
+
*/
|
|
118544
118909
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
118545
118910
|
/**
|
|
118546
|
-
|
|
118547
|
-
|
|
118548
|
-
|
|
118549
|
-
|
|
118550
|
-
|
|
118911
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, 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}.
|
|
118912
|
+
*
|
|
118913
|
+
* @remarks
|
|
118914
|
+
* [Api set: WordApi 1.3]
|
|
118915
|
+
*/
|
|
118551
118916
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
118552
118917
|
/**
|
|
118553
118918
|
* For EACH ITEM in the collection: 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.
|
|
@@ -119947,7 +120312,7 @@ declare namespace Word {
|
|
|
119947
120312
|
type?: boolean;
|
|
119948
120313
|
}
|
|
119949
120314
|
/**
|
|
119950
|
-
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
120315
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
119951
120316
|
*
|
|
119952
120317
|
* @remarks
|
|
119953
120318
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119975,7 +120340,7 @@ declare namespace Word {
|
|
|
119975
120340
|
*/
|
|
119976
120341
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
119977
120342
|
/**
|
|
119978
|
-
* Returns the fill formatting of
|
|
120343
|
+
* Returns the fill formatting of the shape.
|
|
119979
120344
|
*
|
|
119980
120345
|
* @remarks
|
|
119981
120346
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -120014,6 +120379,22 @@ declare namespace Word {
|
|
|
120014
120379
|
* @beta
|
|
120015
120380
|
*/
|
|
120016
120381
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120382
|
+
/**
|
|
120383
|
+
* Returns the text wrap formatting of the shape.
|
|
120384
|
+
*
|
|
120385
|
+
* @remarks
|
|
120386
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120387
|
+
* @beta
|
|
120388
|
+
*/
|
|
120389
|
+
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120390
|
+
/**
|
|
120391
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
120392
|
+
*
|
|
120393
|
+
* @remarks
|
|
120394
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120395
|
+
* @beta
|
|
120396
|
+
*/
|
|
120397
|
+
allowOverlap?: boolean;
|
|
120017
120398
|
/**
|
|
120018
120399
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120019
120400
|
*
|
|
@@ -120190,7 +120571,7 @@ declare namespace Word {
|
|
|
120190
120571
|
*/
|
|
120191
120572
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120192
120573
|
/**
|
|
120193
|
-
* For EACH ITEM in the collection: Returns the fill formatting of
|
|
120574
|
+
* For EACH ITEM in the collection: Returns the fill formatting of the shape.
|
|
120194
120575
|
*
|
|
120195
120576
|
* @remarks
|
|
120196
120577
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -120229,6 +120610,22 @@ declare namespace Word {
|
|
|
120229
120610
|
* @beta
|
|
120230
120611
|
*/
|
|
120231
120612
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120613
|
+
/**
|
|
120614
|
+
* For EACH ITEM in the collection: Returns the text wrap formatting of the shape.
|
|
120615
|
+
*
|
|
120616
|
+
* @remarks
|
|
120617
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120618
|
+
* @beta
|
|
120619
|
+
*/
|
|
120620
|
+
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120621
|
+
/**
|
|
120622
|
+
* For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.
|
|
120623
|
+
*
|
|
120624
|
+
* @remarks
|
|
120625
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120626
|
+
* @beta
|
|
120627
|
+
*/
|
|
120628
|
+
allowOverlap?: boolean;
|
|
120232
120629
|
/**
|
|
120233
120630
|
* For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120234
120631
|
*
|
|
@@ -120456,6 +120853,67 @@ declare namespace Word {
|
|
|
120456
120853
|
*/
|
|
120457
120854
|
wordWrap?: boolean;
|
|
120458
120855
|
}
|
|
120856
|
+
/**
|
|
120857
|
+
* Represents all the properties for wrapping text around a shape.
|
|
120858
|
+
*
|
|
120859
|
+
* @remarks
|
|
120860
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120861
|
+
* @beta
|
|
120862
|
+
*/
|
|
120863
|
+
interface ShapeTextWrapLoadOptions {
|
|
120864
|
+
/**
|
|
120865
|
+
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`).
|
|
120866
|
+
*/
|
|
120867
|
+
$all?: boolean;
|
|
120868
|
+
/**
|
|
120869
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
120870
|
+
*
|
|
120871
|
+
* @remarks
|
|
120872
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120873
|
+
* @beta
|
|
120874
|
+
*/
|
|
120875
|
+
bottomDistance?: boolean;
|
|
120876
|
+
/**
|
|
120877
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
120878
|
+
*
|
|
120879
|
+
* @remarks
|
|
120880
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120881
|
+
* @beta
|
|
120882
|
+
*/
|
|
120883
|
+
leftDistance?: boolean;
|
|
120884
|
+
/**
|
|
120885
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
120886
|
+
*
|
|
120887
|
+
* @remarks
|
|
120888
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120889
|
+
* @beta
|
|
120890
|
+
*/
|
|
120891
|
+
rightDistance?: boolean;
|
|
120892
|
+
/**
|
|
120893
|
+
* Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
|
|
120894
|
+
*
|
|
120895
|
+
* @remarks
|
|
120896
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120897
|
+
* @beta
|
|
120898
|
+
*/
|
|
120899
|
+
side?: boolean;
|
|
120900
|
+
/**
|
|
120901
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
120902
|
+
*
|
|
120903
|
+
* @remarks
|
|
120904
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120905
|
+
* @beta
|
|
120906
|
+
*/
|
|
120907
|
+
topDistance?: boolean;
|
|
120908
|
+
/**
|
|
120909
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
120910
|
+
*
|
|
120911
|
+
* @remarks
|
|
120912
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120913
|
+
* @beta
|
|
120914
|
+
*/
|
|
120915
|
+
type?: boolean;
|
|
120916
|
+
}
|
|
120459
120917
|
}
|
|
120460
120918
|
}
|
|
120461
120919
|
declare namespace Word {
|
|
@@ -131449,7 +131907,7 @@ declare namespace PowerPoint {
|
|
|
131449
131907
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
131450
131908
|
* @beta
|
|
131451
131909
|
*/
|
|
131452
|
-
readonly containedType: ShapeType | null;
|
|
131910
|
+
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
131453
131911
|
/**
|
|
131454
131912
|
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
131455
131913
|
*
|
|
@@ -136003,7 +136461,7 @@ declare namespace PowerPoint {
|
|
|
136003
136461
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136004
136462
|
* @beta
|
|
136005
136463
|
*/
|
|
136006
|
-
containedType?: ShapeType | null;
|
|
136464
|
+
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
136007
136465
|
/**
|
|
136008
136466
|
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
136009
136467
|
*
|
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.560",
|
|
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": "0253eb16994e7b0e2b638b411cf237c87af30e041dee6ed80a652f68a3b020b1",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|