@types/office-js-preview 1.0.557 → 1.0.559
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 +498 -50
- 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: Tue, 18 Feb 2025 18:37:42 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -23389,6 +23389,8 @@ declare namespace Office {
|
|
|
23389
23389
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
23390
23390
|
*
|
|
23391
23391
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23392
|
+
*
|
|
23393
|
+
* **Important**: The error message must be 500 characters or less.
|
|
23392
23394
|
*/
|
|
23393
23395
|
errorMessage?: string;
|
|
23394
23396
|
/**
|
|
@@ -104718,7 +104720,7 @@ declare namespace Word {
|
|
|
104718
104720
|
*/
|
|
104719
104721
|
readonly canvas: Word.Canvas;
|
|
104720
104722
|
/**
|
|
104721
|
-
* Returns the fill formatting of
|
|
104723
|
+
* Returns the fill formatting of the shape.
|
|
104722
104724
|
*
|
|
104723
104725
|
* @remarks
|
|
104724
104726
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -104757,6 +104759,22 @@ declare namespace Word {
|
|
|
104757
104759
|
* @beta
|
|
104758
104760
|
*/
|
|
104759
104761
|
readonly textFrame: Word.TextFrame;
|
|
104762
|
+
/**
|
|
104763
|
+
* Returns the text wrap formatting of the shape.
|
|
104764
|
+
*
|
|
104765
|
+
* @remarks
|
|
104766
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104767
|
+
* @beta
|
|
104768
|
+
*/
|
|
104769
|
+
readonly textWrap: Word.ShapeTextWrap;
|
|
104770
|
+
/**
|
|
104771
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
104772
|
+
*
|
|
104773
|
+
* @remarks
|
|
104774
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
104775
|
+
* @beta
|
|
104776
|
+
*/
|
|
104777
|
+
allowOverlap: boolean;
|
|
104760
104778
|
/**
|
|
104761
104779
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
104762
104780
|
*
|
|
@@ -105452,6 +105470,107 @@ declare namespace Word {
|
|
|
105452
105470
|
*/
|
|
105453
105471
|
toJSON(): Word.Interfaces.TextFrameData;
|
|
105454
105472
|
}
|
|
105473
|
+
/**
|
|
105474
|
+
* Represents all the properties for wrapping text around a shape.
|
|
105475
|
+
*
|
|
105476
|
+
* @remarks
|
|
105477
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105478
|
+
* @beta
|
|
105479
|
+
*/
|
|
105480
|
+
class ShapeTextWrap extends OfficeExtension.ClientObject {
|
|
105481
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
105482
|
+
context: RequestContext;
|
|
105483
|
+
/**
|
|
105484
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
105485
|
+
*
|
|
105486
|
+
* @remarks
|
|
105487
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105488
|
+
* @beta
|
|
105489
|
+
*/
|
|
105490
|
+
bottomDistance: number;
|
|
105491
|
+
/**
|
|
105492
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
105493
|
+
*
|
|
105494
|
+
* @remarks
|
|
105495
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105496
|
+
* @beta
|
|
105497
|
+
*/
|
|
105498
|
+
leftDistance: number;
|
|
105499
|
+
/**
|
|
105500
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
105501
|
+
*
|
|
105502
|
+
* @remarks
|
|
105503
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105504
|
+
* @beta
|
|
105505
|
+
*/
|
|
105506
|
+
rightDistance: number;
|
|
105507
|
+
/**
|
|
105508
|
+
* 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.
|
|
105509
|
+
*
|
|
105510
|
+
* @remarks
|
|
105511
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105512
|
+
* @beta
|
|
105513
|
+
*/
|
|
105514
|
+
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
105515
|
+
/**
|
|
105516
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
105517
|
+
*
|
|
105518
|
+
* @remarks
|
|
105519
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105520
|
+
* @beta
|
|
105521
|
+
*/
|
|
105522
|
+
topDistance: number;
|
|
105523
|
+
/**
|
|
105524
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
105525
|
+
*
|
|
105526
|
+
* @remarks
|
|
105527
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
105528
|
+
* @beta
|
|
105529
|
+
*/
|
|
105530
|
+
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
105531
|
+
/**
|
|
105532
|
+
* 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.
|
|
105533
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
105534
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
105535
|
+
*/
|
|
105536
|
+
set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
105537
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
105538
|
+
set(properties: Word.ShapeTextWrap): void;
|
|
105539
|
+
/**
|
|
105540
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
105541
|
+
*
|
|
105542
|
+
* @param options Provides options for which properties of the object to load.
|
|
105543
|
+
*/
|
|
105544
|
+
load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap;
|
|
105545
|
+
/**
|
|
105546
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
105547
|
+
*
|
|
105548
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
105549
|
+
*/
|
|
105550
|
+
load(propertyNames?: string | string[]): Word.ShapeTextWrap;
|
|
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 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.
|
|
105555
|
+
*/
|
|
105556
|
+
load(propertyNamesAndPaths?: {
|
|
105557
|
+
select?: string;
|
|
105558
|
+
expand?: string;
|
|
105559
|
+
}): Word.ShapeTextWrap;
|
|
105560
|
+
/**
|
|
105561
|
+
* 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.
|
|
105562
|
+
*/
|
|
105563
|
+
track(): Word.ShapeTextWrap;
|
|
105564
|
+
/**
|
|
105565
|
+
* 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.
|
|
105566
|
+
*/
|
|
105567
|
+
untrack(): Word.ShapeTextWrap;
|
|
105568
|
+
/**
|
|
105569
|
+
* 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.)
|
|
105570
|
+
* 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.
|
|
105571
|
+
*/
|
|
105572
|
+
toJSON(): Word.Interfaces.ShapeTextWrapData;
|
|
105573
|
+
}
|
|
105455
105574
|
/**
|
|
105456
105575
|
* ChangeTracking mode.
|
|
105457
105576
|
*
|
|
@@ -111045,6 +111164,108 @@ declare namespace Word {
|
|
|
111045
111164
|
*/
|
|
111046
111165
|
mixed = "Mixed",
|
|
111047
111166
|
}
|
|
111167
|
+
/**
|
|
111168
|
+
* 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}.
|
|
111169
|
+
*
|
|
111170
|
+
* @remarks
|
|
111171
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111172
|
+
* @beta
|
|
111173
|
+
*/
|
|
111174
|
+
enum ShapeTextWrapType {
|
|
111175
|
+
/**
|
|
111176
|
+
* Places the shape in line with text.
|
|
111177
|
+
* @remarks
|
|
111178
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111179
|
+
* @beta
|
|
111180
|
+
*/
|
|
111181
|
+
inline = "Inline",
|
|
111182
|
+
/**
|
|
111183
|
+
* Wraps text squarely around the shape.
|
|
111184
|
+
* @remarks
|
|
111185
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111186
|
+
* @beta
|
|
111187
|
+
*/
|
|
111188
|
+
square = "Square",
|
|
111189
|
+
/**
|
|
111190
|
+
* Wraps text close to the shape.
|
|
111191
|
+
* @remarks
|
|
111192
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111193
|
+
* @beta
|
|
111194
|
+
*/
|
|
111195
|
+
tight = "Tight",
|
|
111196
|
+
/**
|
|
111197
|
+
* Wraps text around and through the shape.
|
|
111198
|
+
* @remarks
|
|
111199
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111200
|
+
* @beta
|
|
111201
|
+
*/
|
|
111202
|
+
through = "Through",
|
|
111203
|
+
/**
|
|
111204
|
+
* Places text above and below the shape.
|
|
111205
|
+
* @remarks
|
|
111206
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111207
|
+
* @beta
|
|
111208
|
+
*/
|
|
111209
|
+
topBottom = "TopBottom",
|
|
111210
|
+
/**
|
|
111211
|
+
* Places shape behind text.
|
|
111212
|
+
* @remarks
|
|
111213
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111214
|
+
* @beta
|
|
111215
|
+
*/
|
|
111216
|
+
behind = "Behind",
|
|
111217
|
+
/**
|
|
111218
|
+
* Places shape in front of text.
|
|
111219
|
+
* @remarks
|
|
111220
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111221
|
+
* @beta
|
|
111222
|
+
*/
|
|
111223
|
+
front = "Front",
|
|
111224
|
+
}
|
|
111225
|
+
/**
|
|
111226
|
+
* 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.
|
|
111227
|
+
*
|
|
111228
|
+
* @remarks
|
|
111229
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111230
|
+
* @beta
|
|
111231
|
+
*/
|
|
111232
|
+
enum ShapeTextWrapSide {
|
|
111233
|
+
/**
|
|
111234
|
+
* Has no wrap side property, such as those for inline shapes.
|
|
111235
|
+
* @remarks
|
|
111236
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111237
|
+
* @beta
|
|
111238
|
+
*/
|
|
111239
|
+
none = "None",
|
|
111240
|
+
/**
|
|
111241
|
+
* Both left and right sides of the shape.
|
|
111242
|
+
* @remarks
|
|
111243
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111244
|
+
* @beta
|
|
111245
|
+
*/
|
|
111246
|
+
both = "Both",
|
|
111247
|
+
/**
|
|
111248
|
+
* Left side of the shape only.
|
|
111249
|
+
* @remarks
|
|
111250
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111251
|
+
* @beta
|
|
111252
|
+
*/
|
|
111253
|
+
left = "Left",
|
|
111254
|
+
/**
|
|
111255
|
+
* Right side of the shape only.
|
|
111256
|
+
* @remarks
|
|
111257
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111258
|
+
* @beta
|
|
111259
|
+
*/
|
|
111260
|
+
right = "Right",
|
|
111261
|
+
/**
|
|
111262
|
+
* Side of the shape that's farther from the respective page margin.
|
|
111263
|
+
* @remarks
|
|
111264
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
111265
|
+
* @beta
|
|
111266
|
+
*/
|
|
111267
|
+
largest = "Largest",
|
|
111268
|
+
}
|
|
111048
111269
|
enum ErrorCodes {
|
|
111049
111270
|
accessDenied = "AccessDenied",
|
|
111050
111271
|
generalException = "GeneralException",
|
|
@@ -111836,7 +112057,6 @@ declare namespace Word {
|
|
|
111836
112057
|
interface NoteItemCollectionUpdateData {
|
|
111837
112058
|
items?: Word.Interfaces.NoteItemData[];
|
|
111838
112059
|
}
|
|
111839
|
-
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
111840
112060
|
/** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */
|
|
111841
112061
|
interface PageCollectionUpdateData {
|
|
111842
112062
|
items?: Word.Interfaces.PageData[];
|
|
@@ -111849,6 +112069,7 @@ declare namespace Word {
|
|
|
111849
112069
|
interface WindowCollectionUpdateData {
|
|
111850
112070
|
items?: Word.Interfaces.WindowData[];
|
|
111851
112071
|
}
|
|
112072
|
+
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
111852
112073
|
interface ParagraphUpdateData {
|
|
111853
112074
|
/**
|
|
111854
112075
|
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
|
|
@@ -112604,7 +112825,7 @@ declare namespace Word {
|
|
|
112604
112825
|
*/
|
|
112605
112826
|
canvas?: Word.Interfaces.CanvasUpdateData;
|
|
112606
112827
|
/**
|
|
112607
|
-
* Returns the fill formatting of
|
|
112828
|
+
* Returns the fill formatting of the shape.
|
|
112608
112829
|
*
|
|
112609
112830
|
* @remarks
|
|
112610
112831
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -112643,6 +112864,22 @@ declare namespace Word {
|
|
|
112643
112864
|
* @beta
|
|
112644
112865
|
*/
|
|
112645
112866
|
textFrame?: Word.Interfaces.TextFrameUpdateData;
|
|
112867
|
+
/**
|
|
112868
|
+
* Returns the text wrap formatting of the shape.
|
|
112869
|
+
*
|
|
112870
|
+
* @remarks
|
|
112871
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
112872
|
+
* @beta
|
|
112873
|
+
*/
|
|
112874
|
+
textWrap?: Word.Interfaces.ShapeTextWrapUpdateData;
|
|
112875
|
+
/**
|
|
112876
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
112877
|
+
*
|
|
112878
|
+
* @remarks
|
|
112879
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
112880
|
+
* @beta
|
|
112881
|
+
*/
|
|
112882
|
+
allowOverlap?: boolean;
|
|
112646
112883
|
/**
|
|
112647
112884
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
112648
112885
|
*
|
|
@@ -112836,6 +113073,57 @@ declare namespace Word {
|
|
|
112836
113073
|
*/
|
|
112837
113074
|
wordWrap?: boolean;
|
|
112838
113075
|
}
|
|
113076
|
+
/** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */
|
|
113077
|
+
interface ShapeTextWrapUpdateData {
|
|
113078
|
+
/**
|
|
113079
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
113080
|
+
*
|
|
113081
|
+
* @remarks
|
|
113082
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113083
|
+
* @beta
|
|
113084
|
+
*/
|
|
113085
|
+
bottomDistance?: number;
|
|
113086
|
+
/**
|
|
113087
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
113088
|
+
*
|
|
113089
|
+
* @remarks
|
|
113090
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113091
|
+
* @beta
|
|
113092
|
+
*/
|
|
113093
|
+
leftDistance?: number;
|
|
113094
|
+
/**
|
|
113095
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
113096
|
+
*
|
|
113097
|
+
* @remarks
|
|
113098
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113099
|
+
* @beta
|
|
113100
|
+
*/
|
|
113101
|
+
rightDistance?: number;
|
|
113102
|
+
/**
|
|
113103
|
+
* 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.
|
|
113104
|
+
*
|
|
113105
|
+
* @remarks
|
|
113106
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113107
|
+
* @beta
|
|
113108
|
+
*/
|
|
113109
|
+
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
113110
|
+
/**
|
|
113111
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
113112
|
+
*
|
|
113113
|
+
* @remarks
|
|
113114
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113115
|
+
* @beta
|
|
113116
|
+
*/
|
|
113117
|
+
topDistance?: number;
|
|
113118
|
+
/**
|
|
113119
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
113120
|
+
*
|
|
113121
|
+
* @remarks
|
|
113122
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
113123
|
+
* @beta
|
|
113124
|
+
*/
|
|
113125
|
+
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
113126
|
+
}
|
|
112839
113127
|
/** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */
|
|
112840
113128
|
interface CritiqueAnnotationData {
|
|
112841
113129
|
/**
|
|
@@ -114453,7 +114741,7 @@ declare namespace Word {
|
|
|
114453
114741
|
*/
|
|
114454
114742
|
pages?: Word.Interfaces.PageData[];
|
|
114455
114743
|
/**
|
|
114456
|
-
* 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.
|
|
114744
|
+
* 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.
|
|
114457
114745
|
*
|
|
114458
114746
|
* @remarks
|
|
114459
114747
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -115187,7 +115475,7 @@ declare namespace Word {
|
|
|
115187
115475
|
*/
|
|
115188
115476
|
canvas?: Word.Interfaces.CanvasData;
|
|
115189
115477
|
/**
|
|
115190
|
-
* Returns the fill formatting of
|
|
115478
|
+
* Returns the fill formatting of the shape.
|
|
115191
115479
|
*
|
|
115192
115480
|
* @remarks
|
|
115193
115481
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -115226,6 +115514,22 @@ declare namespace Word {
|
|
|
115226
115514
|
* @beta
|
|
115227
115515
|
*/
|
|
115228
115516
|
textFrame?: Word.Interfaces.TextFrameData;
|
|
115517
|
+
/**
|
|
115518
|
+
* Returns the text wrap formatting of the shape.
|
|
115519
|
+
*
|
|
115520
|
+
* @remarks
|
|
115521
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115522
|
+
* @beta
|
|
115523
|
+
*/
|
|
115524
|
+
textWrap?: Word.Interfaces.ShapeTextWrapData;
|
|
115525
|
+
/**
|
|
115526
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
115527
|
+
*
|
|
115528
|
+
* @remarks
|
|
115529
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115530
|
+
* @beta
|
|
115531
|
+
*/
|
|
115532
|
+
allowOverlap?: boolean;
|
|
115229
115533
|
/**
|
|
115230
115534
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
115231
115535
|
*
|
|
@@ -115491,6 +115795,57 @@ declare namespace Word {
|
|
|
115491
115795
|
*/
|
|
115492
115796
|
wordWrap?: boolean;
|
|
115493
115797
|
}
|
|
115798
|
+
/** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */
|
|
115799
|
+
interface ShapeTextWrapData {
|
|
115800
|
+
/**
|
|
115801
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
115802
|
+
*
|
|
115803
|
+
* @remarks
|
|
115804
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115805
|
+
* @beta
|
|
115806
|
+
*/
|
|
115807
|
+
bottomDistance?: number;
|
|
115808
|
+
/**
|
|
115809
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
115810
|
+
*
|
|
115811
|
+
* @remarks
|
|
115812
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115813
|
+
* @beta
|
|
115814
|
+
*/
|
|
115815
|
+
leftDistance?: number;
|
|
115816
|
+
/**
|
|
115817
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
115818
|
+
*
|
|
115819
|
+
* @remarks
|
|
115820
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115821
|
+
* @beta
|
|
115822
|
+
*/
|
|
115823
|
+
rightDistance?: number;
|
|
115824
|
+
/**
|
|
115825
|
+
* 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.
|
|
115826
|
+
*
|
|
115827
|
+
* @remarks
|
|
115828
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115829
|
+
* @beta
|
|
115830
|
+
*/
|
|
115831
|
+
side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";
|
|
115832
|
+
/**
|
|
115833
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
115834
|
+
*
|
|
115835
|
+
* @remarks
|
|
115836
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115837
|
+
* @beta
|
|
115838
|
+
*/
|
|
115839
|
+
topDistance?: number;
|
|
115840
|
+
/**
|
|
115841
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
115842
|
+
*
|
|
115843
|
+
* @remarks
|
|
115844
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
115845
|
+
* @beta
|
|
115846
|
+
*/
|
|
115847
|
+
type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";
|
|
115848
|
+
}
|
|
115494
115849
|
/**
|
|
115495
115850
|
* Represents an annotation wrapper around critique displayed in the document.
|
|
115496
115851
|
*
|
|
@@ -118492,60 +118847,60 @@ declare namespace Word {
|
|
|
118492
118847
|
*/
|
|
118493
118848
|
$all?: boolean;
|
|
118494
118849
|
/**
|
|
118495
|
-
|
|
118496
|
-
|
|
118497
|
-
|
|
118498
|
-
|
|
118499
|
-
|
|
118850
|
+
* 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.
|
|
118851
|
+
*
|
|
118852
|
+
* @remarks
|
|
118853
|
+
* [Api set: WordApi 1.1]
|
|
118854
|
+
*/
|
|
118500
118855
|
font?: Word.Interfaces.FontLoadOptions;
|
|
118501
118856
|
/**
|
|
118502
|
-
|
|
118503
|
-
|
|
118504
|
-
|
|
118505
|
-
|
|
118506
|
-
|
|
118857
|
+
* For EACH ITEM in the collection: Gets the parent body of the range.
|
|
118858
|
+
*
|
|
118859
|
+
* @remarks
|
|
118860
|
+
* [Api set: WordApi 1.3]
|
|
118861
|
+
*/
|
|
118507
118862
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
118508
118863
|
/**
|
|
118509
|
-
|
|
118510
|
-
|
|
118511
|
-
|
|
118512
|
-
|
|
118513
|
-
|
|
118864
|
+
* 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.
|
|
118865
|
+
*
|
|
118866
|
+
* @remarks
|
|
118867
|
+
* [Api set: WordApi 1.1]
|
|
118868
|
+
*/
|
|
118514
118869
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
118515
118870
|
/**
|
|
118516
|
-
|
|
118517
|
-
|
|
118518
|
-
|
|
118519
|
-
|
|
118520
|
-
|
|
118871
|
+
* 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}.
|
|
118872
|
+
*
|
|
118873
|
+
* @remarks
|
|
118874
|
+
* [Api set: WordApi 1.3]
|
|
118875
|
+
*/
|
|
118521
118876
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
118522
118877
|
/**
|
|
118523
|
-
|
|
118524
|
-
|
|
118525
|
-
|
|
118526
|
-
|
|
118527
|
-
|
|
118878
|
+
* 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.
|
|
118879
|
+
*
|
|
118880
|
+
* @remarks
|
|
118881
|
+
* [Api set: WordApi 1.3]
|
|
118882
|
+
*/
|
|
118528
118883
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
118529
118884
|
/**
|
|
118530
|
-
|
|
118531
|
-
|
|
118532
|
-
|
|
118533
|
-
|
|
118534
|
-
|
|
118885
|
+
* 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.
|
|
118886
|
+
*
|
|
118887
|
+
* @remarks
|
|
118888
|
+
* [Api set: WordApi 1.3]
|
|
118889
|
+
*/
|
|
118535
118890
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
118536
118891
|
/**
|
|
118537
|
-
|
|
118538
|
-
|
|
118539
|
-
|
|
118540
|
-
|
|
118541
|
-
|
|
118892
|
+
* 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}.
|
|
118893
|
+
*
|
|
118894
|
+
* @remarks
|
|
118895
|
+
* [Api set: WordApi 1.3]
|
|
118896
|
+
*/
|
|
118542
118897
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
118543
118898
|
/**
|
|
118544
|
-
|
|
118545
|
-
|
|
118546
|
-
|
|
118547
|
-
|
|
118548
|
-
|
|
118899
|
+
* 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}.
|
|
118900
|
+
*
|
|
118901
|
+
* @remarks
|
|
118902
|
+
* [Api set: WordApi 1.3]
|
|
118903
|
+
*/
|
|
118549
118904
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
118550
118905
|
/**
|
|
118551
118906
|
* 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.
|
|
@@ -119945,7 +120300,7 @@ declare namespace Word {
|
|
|
119945
120300
|
type?: boolean;
|
|
119946
120301
|
}
|
|
119947
120302
|
/**
|
|
119948
|
-
* 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.
|
|
120303
|
+
* 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.
|
|
119949
120304
|
*
|
|
119950
120305
|
* @remarks
|
|
119951
120306
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -119973,7 +120328,7 @@ declare namespace Word {
|
|
|
119973
120328
|
*/
|
|
119974
120329
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
119975
120330
|
/**
|
|
119976
|
-
* Returns the fill formatting of
|
|
120331
|
+
* Returns the fill formatting of the shape.
|
|
119977
120332
|
*
|
|
119978
120333
|
* @remarks
|
|
119979
120334
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -120012,6 +120367,22 @@ declare namespace Word {
|
|
|
120012
120367
|
* @beta
|
|
120013
120368
|
*/
|
|
120014
120369
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120370
|
+
/**
|
|
120371
|
+
* Returns the text wrap formatting of the shape.
|
|
120372
|
+
*
|
|
120373
|
+
* @remarks
|
|
120374
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120375
|
+
* @beta
|
|
120376
|
+
*/
|
|
120377
|
+
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120378
|
+
/**
|
|
120379
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
120380
|
+
*
|
|
120381
|
+
* @remarks
|
|
120382
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120383
|
+
* @beta
|
|
120384
|
+
*/
|
|
120385
|
+
allowOverlap?: boolean;
|
|
120015
120386
|
/**
|
|
120016
120387
|
* The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120017
120388
|
*
|
|
@@ -120188,7 +120559,7 @@ declare namespace Word {
|
|
|
120188
120559
|
*/
|
|
120189
120560
|
canvas?: Word.Interfaces.CanvasLoadOptions;
|
|
120190
120561
|
/**
|
|
120191
|
-
* For EACH ITEM in the collection: Returns the fill formatting of
|
|
120562
|
+
* For EACH ITEM in the collection: Returns the fill formatting of the shape.
|
|
120192
120563
|
*
|
|
120193
120564
|
* @remarks
|
|
120194
120565
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -120227,6 +120598,22 @@ declare namespace Word {
|
|
|
120227
120598
|
* @beta
|
|
120228
120599
|
*/
|
|
120229
120600
|
textFrame?: Word.Interfaces.TextFrameLoadOptions;
|
|
120601
|
+
/**
|
|
120602
|
+
* For EACH ITEM in the collection: Returns the text wrap formatting of the shape.
|
|
120603
|
+
*
|
|
120604
|
+
* @remarks
|
|
120605
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120606
|
+
* @beta
|
|
120607
|
+
*/
|
|
120608
|
+
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
120609
|
+
/**
|
|
120610
|
+
* For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.
|
|
120611
|
+
*
|
|
120612
|
+
* @remarks
|
|
120613
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120614
|
+
* @beta
|
|
120615
|
+
*/
|
|
120616
|
+
allowOverlap?: boolean;
|
|
120230
120617
|
/**
|
|
120231
120618
|
* For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120232
120619
|
*
|
|
@@ -120454,6 +120841,67 @@ declare namespace Word {
|
|
|
120454
120841
|
*/
|
|
120455
120842
|
wordWrap?: boolean;
|
|
120456
120843
|
}
|
|
120844
|
+
/**
|
|
120845
|
+
* Represents all the properties for wrapping text around a shape.
|
|
120846
|
+
*
|
|
120847
|
+
* @remarks
|
|
120848
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120849
|
+
* @beta
|
|
120850
|
+
*/
|
|
120851
|
+
interface ShapeTextWrapLoadOptions {
|
|
120852
|
+
/**
|
|
120853
|
+
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`).
|
|
120854
|
+
*/
|
|
120855
|
+
$all?: boolean;
|
|
120856
|
+
/**
|
|
120857
|
+
* Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
|
|
120858
|
+
*
|
|
120859
|
+
* @remarks
|
|
120860
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120861
|
+
* @beta
|
|
120862
|
+
*/
|
|
120863
|
+
bottomDistance?: boolean;
|
|
120864
|
+
/**
|
|
120865
|
+
* Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
|
|
120866
|
+
*
|
|
120867
|
+
* @remarks
|
|
120868
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120869
|
+
* @beta
|
|
120870
|
+
*/
|
|
120871
|
+
leftDistance?: boolean;
|
|
120872
|
+
/**
|
|
120873
|
+
* Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
|
|
120874
|
+
*
|
|
120875
|
+
* @remarks
|
|
120876
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120877
|
+
* @beta
|
|
120878
|
+
*/
|
|
120879
|
+
rightDistance?: boolean;
|
|
120880
|
+
/**
|
|
120881
|
+
* 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.
|
|
120882
|
+
*
|
|
120883
|
+
* @remarks
|
|
120884
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120885
|
+
* @beta
|
|
120886
|
+
*/
|
|
120887
|
+
side?: boolean;
|
|
120888
|
+
/**
|
|
120889
|
+
* Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
|
|
120890
|
+
*
|
|
120891
|
+
* @remarks
|
|
120892
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120893
|
+
* @beta
|
|
120894
|
+
*/
|
|
120895
|
+
topDistance?: boolean;
|
|
120896
|
+
/**
|
|
120897
|
+
* Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
|
|
120898
|
+
*
|
|
120899
|
+
* @remarks
|
|
120900
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
120901
|
+
* @beta
|
|
120902
|
+
*/
|
|
120903
|
+
type?: boolean;
|
|
120904
|
+
}
|
|
120457
120905
|
}
|
|
120458
120906
|
}
|
|
120459
120907
|
declare namespace Word {
|
|
@@ -131447,7 +131895,7 @@ declare namespace PowerPoint {
|
|
|
131447
131895
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
131448
131896
|
* @beta
|
|
131449
131897
|
*/
|
|
131450
|
-
readonly containedType: ShapeType | null;
|
|
131898
|
+
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
131451
131899
|
/**
|
|
131452
131900
|
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
131453
131901
|
*
|
|
@@ -136001,7 +136449,7 @@ declare namespace PowerPoint {
|
|
|
136001
136449
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136002
136450
|
* @beta
|
|
136003
136451
|
*/
|
|
136004
|
-
containedType?: ShapeType | null;
|
|
136452
|
+
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
|
|
136005
136453
|
/**
|
|
136006
136454
|
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
|
|
136007
136455
|
*
|
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.559",
|
|
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": "a3aa6e907bce3e857e6d25946a6e35aa59942a551a362d2436645ccf46e827af",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|