@types/office-js-preview 1.0.668 → 1.0.670
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +219 -123
- 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: Fri, 12 Dec 2025 18:42:47 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -32093,7 +32093,7 @@ declare namespace Excel {
|
|
|
32093
32093
|
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
32094
32094
|
* In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.
|
|
32095
32095
|
*
|
|
32096
|
-
* @deprecated As of
|
|
32096
|
+
* @deprecated As of ExcelApi 1.19, use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead.
|
|
32097
32097
|
*
|
|
32098
32098
|
* @remarks
|
|
32099
32099
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32102,7 +32102,7 @@ declare namespace Excel {
|
|
|
32102
32102
|
/**
|
|
32103
32103
|
* Represents the type of this cell value.
|
|
32104
32104
|
*
|
|
32105
|
-
* @deprecated Deprecated since
|
|
32105
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
32106
32106
|
*
|
|
32107
32107
|
* @remarks
|
|
32108
32108
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32111,7 +32111,7 @@ declare namespace Excel {
|
|
|
32111
32111
|
/**
|
|
32112
32112
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
32113
32113
|
*
|
|
32114
|
-
* @deprecated Deprecated since
|
|
32114
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
32115
32115
|
*
|
|
32116
32116
|
* @remarks
|
|
32117
32117
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32120,7 +32120,7 @@ declare namespace Excel {
|
|
|
32120
32120
|
/**
|
|
32121
32121
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
32122
32122
|
*
|
|
32123
|
-
* @deprecated Deprecated since
|
|
32123
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
32124
32124
|
*
|
|
32125
32125
|
* @remarks
|
|
32126
32126
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32132,7 +32132,7 @@ declare namespace Excel {
|
|
|
32132
32132
|
* Number format strings must conform to Excel guidelines.
|
|
32133
32133
|
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
32134
32134
|
*
|
|
32135
|
-
* @deprecated Deprecated since
|
|
32135
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
32136
32136
|
*
|
|
32137
32137
|
* @remarks
|
|
32138
32138
|
* [Api set: ExcelApi 1.16]
|
|
@@ -34625,10 +34625,17 @@ declare namespace Excel {
|
|
|
34625
34625
|
}
|
|
34626
34626
|
/**
|
|
34627
34627
|
*
|
|
34628
|
-
* Creates and opens a new workbook.
|
|
34629
|
-
*
|
|
34630
|
-
|
|
34631
|
-
*
|
|
34628
|
+
* Creates and opens a new workbook. Optionally, the workbook can be pre-populated
|
|
34629
|
+
* with a Base64-encoded .xlsx file.
|
|
34630
|
+
|
|
34631
|
+
* Note: Macros can be a security risk. If this API is used to create a workbook that
|
|
34632
|
+
* includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog
|
|
34633
|
+
* in the Excel UI. The user must select the "Trust add-in" button to proceed.
|
|
34634
|
+
*
|
|
34635
|
+
* Note: The `extensionHardening` Windows registry key affects the `base64File` param.
|
|
34636
|
+
* The file extension defined by the param must match the real file type of the file.
|
|
34637
|
+
* If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error:
|
|
34638
|
+
* "This operation is not allowed due to the extension hardening policy."
|
|
34632
34639
|
* [Api set: ExcelApi 1.8]
|
|
34633
34640
|
*
|
|
34634
34641
|
* @param base64File Optional. The Base64-encoded .xlsx file. The default value is null.
|
|
@@ -34800,11 +34807,11 @@ declare namespace Excel {
|
|
|
34800
34807
|
class RequestContext extends OfficeCore.RequestContext {
|
|
34801
34808
|
constructor(url?: string | Session, invocation?: {
|
|
34802
34809
|
invocationId: number;
|
|
34803
|
-
|
|
34810
|
+
isInSyncExecution: boolean;
|
|
34804
34811
|
});
|
|
34805
34812
|
setInvocation(invocation: {
|
|
34806
34813
|
invocationId: number;
|
|
34807
|
-
|
|
34814
|
+
isInSyncExecution: boolean;
|
|
34808
34815
|
}): void;
|
|
34809
34816
|
readonly workbook: Workbook;
|
|
34810
34817
|
readonly application: Application;
|
|
@@ -34827,7 +34834,6 @@ declare namespace Excel {
|
|
|
34827
34834
|
*
|
|
34828
34835
|
* When false, each `context.sync()` call creates an undo record.
|
|
34829
34836
|
* When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group.
|
|
34830
|
-
*
|
|
34831
34837
|
* @remarks
|
|
34832
34838
|
* [Api set: ExcelApi 1.20]
|
|
34833
34839
|
*/
|
|
@@ -39860,6 +39866,66 @@ declare namespace Excel {
|
|
|
39860
39866
|
*/
|
|
39861
39867
|
toJSON(): Excel.Interfaces.IterativeCalculationData;
|
|
39862
39868
|
}
|
|
39869
|
+
/**
|
|
39870
|
+
* Specifies the type of autorun event.
|
|
39871
|
+
*
|
|
39872
|
+
* @remarks
|
|
39873
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39874
|
+
* @beta
|
|
39875
|
+
*/
|
|
39876
|
+
enum AutorunEventType {
|
|
39877
|
+
/**
|
|
39878
|
+
* The autorun event type is unknown.
|
|
39879
|
+
* @remarks
|
|
39880
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39881
|
+
*/
|
|
39882
|
+
unknown = "Unknown",
|
|
39883
|
+
/**
|
|
39884
|
+
* The autorun event type is triggered when the document is saved.
|
|
39885
|
+
* @remarks
|
|
39886
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39887
|
+
*/
|
|
39888
|
+
onDocumentSave = "OnDocumentSave",
|
|
39889
|
+
/**
|
|
39890
|
+
* The autorun event type is triggered when the document is saved as a new file.
|
|
39891
|
+
* @remarks
|
|
39892
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39893
|
+
*/
|
|
39894
|
+
onDocumentSaveAs = "OnDocumentSaveAs"
|
|
39895
|
+
}
|
|
39896
|
+
/**
|
|
39897
|
+
* Specifies the options for completing an autorun event.
|
|
39898
|
+
*
|
|
39899
|
+
* @remarks
|
|
39900
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39901
|
+
* @beta
|
|
39902
|
+
*/
|
|
39903
|
+
interface AutorunEventCompletedOptions {
|
|
39904
|
+
/**
|
|
39905
|
+
* Specifies whether to allow the event to proceed. The default value is `false`.
|
|
39906
|
+
*
|
|
39907
|
+
* @remarks
|
|
39908
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39909
|
+
* @beta
|
|
39910
|
+
*/
|
|
39911
|
+
allowEvent: boolean;
|
|
39912
|
+
/**
|
|
39913
|
+
* Specifies the type of autorun event to be completed if allowed. The default value is `unknown`.
|
|
39914
|
+
*
|
|
39915
|
+
* @remarks
|
|
39916
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39917
|
+
* @beta
|
|
39918
|
+
*/
|
|
39919
|
+
autorunEventType: Excel.AutorunEventType | "Unknown" | "OnDocumentSave" | "OnDocumentSaveAs";
|
|
39920
|
+
/**
|
|
39921
|
+
* If provided, specifies an optional error message if the event isn't allowed to proceed. The default value is "" (empty string).
|
|
39922
|
+
*
|
|
39923
|
+
* @remarks
|
|
39924
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
39925
|
+
* @beta
|
|
39926
|
+
*/
|
|
39927
|
+
message?: string;
|
|
39928
|
+
}
|
|
39863
39929
|
/**
|
|
39864
39930
|
* Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
|
|
39865
39931
|
To learn more about the workbook object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}.
|
|
@@ -40139,6 +40205,16 @@ declare namespace Excel {
|
|
|
40139
40205
|
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
40140
40206
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
40141
40207
|
set(properties: Excel.Workbook): void;
|
|
40208
|
+
/**
|
|
40209
|
+
* Notifies the host application that the add-in's code has finished running in an autorun event.
|
|
40210
|
+
*
|
|
40211
|
+
* @remarks
|
|
40212
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
40213
|
+
* @beta
|
|
40214
|
+
*
|
|
40215
|
+
* @param AutorunEventCompletedOptions Required. Options for completing the autorun event.
|
|
40216
|
+
*/
|
|
40217
|
+
autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions): void;
|
|
40142
40218
|
/**
|
|
40143
40219
|
* Close current workbook.
|
|
40144
40220
|
*
|
|
@@ -40158,8 +40234,7 @@ declare namespace Excel {
|
|
|
40158
40234
|
*/
|
|
40159
40235
|
close(closeBehavior?: "Save" | "SkipSave"): void;
|
|
40160
40236
|
/**
|
|
40161
|
-
* Sets focus on the workbook. This
|
|
40162
|
-
to receive keyboard events.
|
|
40237
|
+
* Sets focus on the workbook. This causes the Excel grid or the currently active object to receive keyboard events.
|
|
40163
40238
|
*
|
|
40164
40239
|
* @remarks
|
|
40165
40240
|
* [Api set: ExcelApiDesktop 1.1]
|
|
@@ -40254,7 +40329,10 @@ declare namespace Excel {
|
|
|
40254
40329
|
getSelectedRanges(): Excel.RangeAreas;
|
|
40255
40330
|
/**
|
|
40256
40331
|
* Inserts the specified worksheets from a source workbook into the current workbook.
|
|
40257
|
-
|
|
40332
|
+
|
|
40333
|
+
The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
|
|
40334
|
+
|
|
40335
|
+
**Note**: This API is currently only supported for Office on Windows, Mac, and the web.
|
|
40258
40336
|
*
|
|
40259
40337
|
* @remarks
|
|
40260
40338
|
* [Api set: ExcelApi 1.13]
|
|
@@ -45290,35 +45368,35 @@ declare namespace Excel {
|
|
|
45290
45368
|
*/
|
|
45291
45369
|
enum TableSource {
|
|
45292
45370
|
/**
|
|
45293
|
-
*
|
|
45371
|
+
* An external data source, such as Microsoft SharePoint Foundation.
|
|
45294
45372
|
* @remarks
|
|
45295
45373
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
45296
45374
|
* @beta
|
|
45297
45375
|
*/
|
|
45298
45376
|
external = "External",
|
|
45299
45377
|
/**
|
|
45300
|
-
*
|
|
45378
|
+
* A range object in this worksheet.
|
|
45301
45379
|
* @remarks
|
|
45302
45380
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
45303
45381
|
* @beta
|
|
45304
45382
|
*/
|
|
45305
45383
|
range = "Range",
|
|
45306
45384
|
/**
|
|
45307
|
-
* XML data source.
|
|
45385
|
+
* An XML data source.
|
|
45308
45386
|
* @remarks
|
|
45309
45387
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
45310
45388
|
* @beta
|
|
45311
45389
|
*/
|
|
45312
45390
|
xml = "Xml",
|
|
45313
45391
|
/**
|
|
45314
|
-
* Query data source.
|
|
45392
|
+
* A Power Query query data source.
|
|
45315
45393
|
* @remarks
|
|
45316
45394
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
45317
45395
|
* @beta
|
|
45318
45396
|
*/
|
|
45319
45397
|
query = "Query",
|
|
45320
45398
|
/**
|
|
45321
|
-
* Power Pivot model.
|
|
45399
|
+
* A Power Pivot model.
|
|
45322
45400
|
* @remarks
|
|
45323
45401
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
45324
45402
|
* @beta
|
|
@@ -66334,7 +66412,13 @@ declare namespace Excel {
|
|
|
66334
66412
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
66335
66413
|
* @beta
|
|
66336
66414
|
*/
|
|
66337
|
-
externalCodeServiceDiffResultReceived = "ExternalCodeServiceDiffResultReceived"
|
|
66415
|
+
externalCodeServiceDiffResultReceived = "ExternalCodeServiceDiffResultReceived",
|
|
66416
|
+
/**
|
|
66417
|
+
* AugmentationLoopUploadStatusChanged represents the type of event registered when the upload status of the augmentation loop changes.
|
|
66418
|
+
* @remarks
|
|
66419
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
66420
|
+
*/
|
|
66421
|
+
augmentationLoopUploadStatusChanged = "AugmentationLoopUploadStatusChanged"
|
|
66338
66422
|
}
|
|
66339
66423
|
/**
|
|
66340
66424
|
* @remarks
|
|
@@ -69276,6 +69360,7 @@ declare namespace Excel {
|
|
|
69276
69360
|
content: string;
|
|
69277
69361
|
/**
|
|
69278
69362
|
* Specifies the height of the note.
|
|
69363
|
+
* Note: This property is not supported in Excel on the web.
|
|
69279
69364
|
*
|
|
69280
69365
|
* @remarks
|
|
69281
69366
|
* [Api set: ExcelApi 1.18]
|
|
@@ -69283,6 +69368,7 @@ declare namespace Excel {
|
|
|
69283
69368
|
height: number;
|
|
69284
69369
|
/**
|
|
69285
69370
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
69371
|
+
* Note: This property is not supported in Excel on the web.
|
|
69286
69372
|
*
|
|
69287
69373
|
* @remarks
|
|
69288
69374
|
* [Api set: ExcelApi 1.18]
|
|
@@ -69290,6 +69376,7 @@ declare namespace Excel {
|
|
|
69290
69376
|
visible: boolean;
|
|
69291
69377
|
/**
|
|
69292
69378
|
* Specifies the width of the note.
|
|
69379
|
+
* Note: This property is not supported in Excel on the web.
|
|
69293
69380
|
*
|
|
69294
69381
|
* @remarks
|
|
69295
69382
|
* [Api set: ExcelApi 1.18]
|
|
@@ -79271,6 +79358,7 @@ declare namespace Excel {
|
|
|
79271
79358
|
content?: string;
|
|
79272
79359
|
/**
|
|
79273
79360
|
* Specifies the height of the note.
|
|
79361
|
+
* Note: This property is not supported in Excel on the web.
|
|
79274
79362
|
*
|
|
79275
79363
|
* @remarks
|
|
79276
79364
|
* [Api set: ExcelApi 1.18]
|
|
@@ -79278,6 +79366,7 @@ declare namespace Excel {
|
|
|
79278
79366
|
height?: number;
|
|
79279
79367
|
/**
|
|
79280
79368
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
79369
|
+
* Note: This property is not supported in Excel on the web.
|
|
79281
79370
|
*
|
|
79282
79371
|
* @remarks
|
|
79283
79372
|
* [Api set: ExcelApi 1.18]
|
|
@@ -79285,6 +79374,7 @@ declare namespace Excel {
|
|
|
79285
79374
|
visible?: boolean;
|
|
79286
79375
|
/**
|
|
79287
79376
|
* Specifies the width of the note.
|
|
79377
|
+
* Note: This property is not supported in Excel on the web.
|
|
79288
79378
|
*
|
|
79289
79379
|
* @remarks
|
|
79290
79380
|
* [Api set: ExcelApi 1.18]
|
|
@@ -86969,6 +87059,7 @@ declare namespace Excel {
|
|
|
86969
87059
|
content?: string;
|
|
86970
87060
|
/**
|
|
86971
87061
|
* Specifies the height of the note.
|
|
87062
|
+
* Note: This property is not supported in Excel on the web.
|
|
86972
87063
|
*
|
|
86973
87064
|
* @remarks
|
|
86974
87065
|
* [Api set: ExcelApi 1.18]
|
|
@@ -86976,6 +87067,7 @@ declare namespace Excel {
|
|
|
86976
87067
|
height?: number;
|
|
86977
87068
|
/**
|
|
86978
87069
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
87070
|
+
* Note: This property is not supported in Excel on the web.
|
|
86979
87071
|
*
|
|
86980
87072
|
* @remarks
|
|
86981
87073
|
* [Api set: ExcelApi 1.18]
|
|
@@ -86983,6 +87075,7 @@ declare namespace Excel {
|
|
|
86983
87075
|
visible?: boolean;
|
|
86984
87076
|
/**
|
|
86985
87077
|
* Specifies the width of the note.
|
|
87078
|
+
* Note: This property is not supported in Excel on the web.
|
|
86986
87079
|
*
|
|
86987
87080
|
* @remarks
|
|
86988
87081
|
* [Api set: ExcelApi 1.18]
|
|
@@ -99738,6 +99831,7 @@ declare namespace Excel {
|
|
|
99738
99831
|
content?: boolean;
|
|
99739
99832
|
/**
|
|
99740
99833
|
* For EACH ITEM in the collection: Specifies the height of the note.
|
|
99834
|
+
* Note: This property is not supported in Excel on the web.
|
|
99741
99835
|
*
|
|
99742
99836
|
* @remarks
|
|
99743
99837
|
* [Api set: ExcelApi 1.18]
|
|
@@ -99745,6 +99839,7 @@ declare namespace Excel {
|
|
|
99745
99839
|
height?: boolean;
|
|
99746
99840
|
/**
|
|
99747
99841
|
* For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
99842
|
+
* Note: This property is not supported in Excel on the web.
|
|
99748
99843
|
*
|
|
99749
99844
|
* @remarks
|
|
99750
99845
|
* [Api set: ExcelApi 1.18]
|
|
@@ -99752,6 +99847,7 @@ declare namespace Excel {
|
|
|
99752
99847
|
visible?: boolean;
|
|
99753
99848
|
/**
|
|
99754
99849
|
* For EACH ITEM in the collection: Specifies the width of the note.
|
|
99850
|
+
* Note: This property is not supported in Excel on the web.
|
|
99755
99851
|
*
|
|
99756
99852
|
* @remarks
|
|
99757
99853
|
* [Api set: ExcelApi 1.18]
|
|
@@ -102869,7 +102965,7 @@ declare namespace Word {
|
|
|
102869
102965
|
};
|
|
102870
102966
|
}
|
|
102871
102967
|
/**
|
|
102872
|
-
*
|
|
102968
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
102873
102969
|
*
|
|
102874
102970
|
* @remarks
|
|
102875
102971
|
* [Api set: WordApi 1.7]
|
|
@@ -108940,7 +109036,7 @@ declare namespace Word {
|
|
|
108940
109036
|
toJSON(): Word.Interfaces.DocumentData;
|
|
108941
109037
|
}
|
|
108942
109038
|
/**
|
|
108943
|
-
* The `DocumentCreated` object is the top
|
|
109039
|
+
* The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
|
|
108944
109040
|
*
|
|
108945
109041
|
* @remarks
|
|
108946
109042
|
* [Api set: WordApi 1.3]
|
|
@@ -109331,7 +109427,7 @@ declare namespace Word {
|
|
|
109331
109427
|
toJSON(): Word.Interfaces.DocumentPropertiesData;
|
|
109332
109428
|
}
|
|
109333
109429
|
/**
|
|
109334
|
-
*
|
|
109430
|
+
* Represents the data specific to content controls of type `dropDownList`.
|
|
109335
109431
|
*
|
|
109336
109432
|
* @remarks
|
|
109337
109433
|
* [Api set: WordApi 1.9]
|
|
@@ -109394,7 +109490,7 @@ declare namespace Word {
|
|
|
109394
109490
|
toJSON(): Word.Interfaces.DropDownListContentControlData;
|
|
109395
109491
|
}
|
|
109396
109492
|
/**
|
|
109397
|
-
*
|
|
109493
|
+
* Represents the data specific to content controls of type `comboBox`.
|
|
109398
109494
|
*
|
|
109399
109495
|
* @remarks
|
|
109400
109496
|
* [Api set: WordApi 1.9]
|
|
@@ -120675,7 +120771,7 @@ declare namespace Word {
|
|
|
120675
120771
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
120676
120772
|
context: RequestContext;
|
|
120677
120773
|
/**
|
|
120678
|
-
*
|
|
120774
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
120679
120775
|
*
|
|
120680
120776
|
* @remarks
|
|
120681
120777
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -120745,21 +120841,21 @@ declare namespace Word {
|
|
|
120745
120841
|
*/
|
|
120746
120842
|
altTextDescription: string;
|
|
120747
120843
|
/**
|
|
120748
|
-
*
|
|
120844
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
120749
120845
|
*
|
|
120750
120846
|
* @remarks
|
|
120751
120847
|
* [Api set: WordApiDesktop 1.2]
|
|
120752
120848
|
*/
|
|
120753
120849
|
geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
120754
120850
|
/**
|
|
120755
|
-
*
|
|
120851
|
+
* Specifies the height, in points, of the shape.
|
|
120756
120852
|
*
|
|
120757
120853
|
* @remarks
|
|
120758
120854
|
* [Api set: WordApiDesktop 1.2]
|
|
120759
120855
|
*/
|
|
120760
120856
|
height: number;
|
|
120761
120857
|
/**
|
|
120762
|
-
*
|
|
120858
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
120763
120859
|
*
|
|
120764
120860
|
* @remarks
|
|
120765
120861
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -120780,14 +120876,14 @@ declare namespace Word {
|
|
|
120780
120876
|
*/
|
|
120781
120877
|
readonly isChild: boolean;
|
|
120782
120878
|
/**
|
|
120783
|
-
*
|
|
120879
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120784
120880
|
*
|
|
120785
120881
|
* @remarks
|
|
120786
120882
|
* [Api set: WordApiDesktop 1.2]
|
|
120787
120883
|
*/
|
|
120788
120884
|
left: number;
|
|
120789
120885
|
/**
|
|
120790
|
-
*
|
|
120886
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
120791
120887
|
*
|
|
120792
120888
|
* @remarks
|
|
120793
120889
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -120801,35 +120897,35 @@ declare namespace Word {
|
|
|
120801
120897
|
*/
|
|
120802
120898
|
lockAspectRatio: boolean;
|
|
120803
120899
|
/**
|
|
120804
|
-
*
|
|
120900
|
+
* Specifies the name of the shape.
|
|
120805
120901
|
*
|
|
120806
120902
|
* @remarks
|
|
120807
120903
|
* [Api set: WordApiDesktop 1.2]
|
|
120808
120904
|
*/
|
|
120809
120905
|
name: string;
|
|
120810
120906
|
/**
|
|
120811
|
-
*
|
|
120907
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
120812
120908
|
*
|
|
120813
120909
|
* @remarks
|
|
120814
120910
|
* [Api set: WordApiDesktop 1.2]
|
|
120815
120911
|
*/
|
|
120816
120912
|
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
120817
120913
|
/**
|
|
120818
|
-
*
|
|
120914
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
120819
120915
|
*
|
|
120820
120916
|
* @remarks
|
|
120821
120917
|
* [Api set: WordApiDesktop 1.2]
|
|
120822
120918
|
*/
|
|
120823
120919
|
relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
120824
120920
|
/**
|
|
120825
|
-
*
|
|
120921
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
120826
120922
|
*
|
|
120827
120923
|
* @remarks
|
|
120828
120924
|
* [Api set: WordApiDesktop 1.2]
|
|
120829
120925
|
*/
|
|
120830
120926
|
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
120831
120927
|
/**
|
|
120832
|
-
*
|
|
120928
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
120833
120929
|
*
|
|
120834
120930
|
* @remarks
|
|
120835
120931
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -120843,14 +120939,14 @@ declare namespace Word {
|
|
|
120843
120939
|
*/
|
|
120844
120940
|
rotation: number;
|
|
120845
120941
|
/**
|
|
120846
|
-
*
|
|
120942
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
120847
120943
|
*
|
|
120848
120944
|
* @remarks
|
|
120849
120945
|
* [Api set: WordApiDesktop 1.2]
|
|
120850
120946
|
*/
|
|
120851
120947
|
top: number;
|
|
120852
120948
|
/**
|
|
120853
|
-
*
|
|
120949
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
120854
120950
|
*
|
|
120855
120951
|
* @remarks
|
|
120856
120952
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -120871,14 +120967,14 @@ declare namespace Word {
|
|
|
120871
120967
|
*/
|
|
120872
120968
|
visible: boolean;
|
|
120873
120969
|
/**
|
|
120874
|
-
*
|
|
120970
|
+
* Specifies the width, in points, of the shape.
|
|
120875
120971
|
*
|
|
120876
120972
|
* @remarks
|
|
120877
120973
|
* [Api set: WordApiDesktop 1.2]
|
|
120878
120974
|
*/
|
|
120879
120975
|
width: number;
|
|
120880
120976
|
/**
|
|
120881
|
-
*
|
|
120977
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
120882
120978
|
*
|
|
120883
120979
|
* @remarks
|
|
120884
120980
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -124783,7 +124879,7 @@ declare namespace Word {
|
|
|
124783
124879
|
*/
|
|
124784
124880
|
interface ContentControlAddedEventArgs {
|
|
124785
124881
|
/**
|
|
124786
|
-
*
|
|
124882
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
124787
124883
|
*
|
|
124788
124884
|
* @remarks
|
|
124789
124885
|
* [Api set: WordApi 1.5]
|
|
@@ -124797,7 +124893,7 @@ declare namespace Word {
|
|
|
124797
124893
|
*/
|
|
124798
124894
|
ids: number[];
|
|
124799
124895
|
/**
|
|
124800
|
-
*
|
|
124896
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
124801
124897
|
*
|
|
124802
124898
|
* @remarks
|
|
124803
124899
|
* [Api set: WordApi 1.5]
|
|
@@ -124812,7 +124908,7 @@ declare namespace Word {
|
|
|
124812
124908
|
*/
|
|
124813
124909
|
interface ContentControlDataChangedEventArgs {
|
|
124814
124910
|
/**
|
|
124815
|
-
*
|
|
124911
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
124816
124912
|
*
|
|
124817
124913
|
* @remarks
|
|
124818
124914
|
* [Api set: WordApi 1.5]
|
|
@@ -124826,7 +124922,7 @@ declare namespace Word {
|
|
|
124826
124922
|
*/
|
|
124827
124923
|
ids: number[];
|
|
124828
124924
|
/**
|
|
124829
|
-
*
|
|
124925
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
124830
124926
|
*
|
|
124831
124927
|
* @remarks
|
|
124832
124928
|
* [Api set: WordApi 1.5]
|
|
@@ -124841,7 +124937,7 @@ declare namespace Word {
|
|
|
124841
124937
|
*/
|
|
124842
124938
|
interface ContentControlDeletedEventArgs {
|
|
124843
124939
|
/**
|
|
124844
|
-
*
|
|
124940
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
124845
124941
|
*
|
|
124846
124942
|
* @remarks
|
|
124847
124943
|
* [Api set: WordApi 1.5]
|
|
@@ -124855,7 +124951,7 @@ declare namespace Word {
|
|
|
124855
124951
|
*/
|
|
124856
124952
|
ids: number[];
|
|
124857
124953
|
/**
|
|
124858
|
-
*
|
|
124954
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
124859
124955
|
*
|
|
124860
124956
|
* @remarks
|
|
124861
124957
|
* [Api set: WordApi 1.5]
|
|
@@ -124870,7 +124966,7 @@ declare namespace Word {
|
|
|
124870
124966
|
*/
|
|
124871
124967
|
interface ContentControlEnteredEventArgs {
|
|
124872
124968
|
/**
|
|
124873
|
-
*
|
|
124969
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
124874
124970
|
*
|
|
124875
124971
|
* @remarks
|
|
124876
124972
|
* [Api set: WordApi 1.5]
|
|
@@ -124884,7 +124980,7 @@ declare namespace Word {
|
|
|
124884
124980
|
*/
|
|
124885
124981
|
ids: number[];
|
|
124886
124982
|
/**
|
|
124887
|
-
*
|
|
124983
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
124888
124984
|
*
|
|
124889
124985
|
* @remarks
|
|
124890
124986
|
* [Api set: WordApi 1.5]
|
|
@@ -124899,7 +124995,7 @@ declare namespace Word {
|
|
|
124899
124995
|
*/
|
|
124900
124996
|
interface ContentControlExitedEventArgs {
|
|
124901
124997
|
/**
|
|
124902
|
-
*
|
|
124998
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
124903
124999
|
*
|
|
124904
125000
|
* @remarks
|
|
124905
125001
|
* [Api set: WordApi 1.5]
|
|
@@ -124913,7 +125009,7 @@ declare namespace Word {
|
|
|
124913
125009
|
*/
|
|
124914
125010
|
ids: number[];
|
|
124915
125011
|
/**
|
|
124916
|
-
*
|
|
125012
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
124917
125013
|
*
|
|
124918
125014
|
* @remarks
|
|
124919
125015
|
* [Api set: WordApi 1.5]
|
|
@@ -125014,7 +125110,7 @@ declare namespace Word {
|
|
|
125014
125110
|
*/
|
|
125015
125111
|
interface ContentControlSelectionChangedEventArgs {
|
|
125016
125112
|
/**
|
|
125017
|
-
*
|
|
125113
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
125018
125114
|
*
|
|
125019
125115
|
* @remarks
|
|
125020
125116
|
* [Api set: WordApi 1.5]
|
|
@@ -125028,7 +125124,7 @@ declare namespace Word {
|
|
|
125028
125124
|
*/
|
|
125029
125125
|
ids: number[];
|
|
125030
125126
|
/**
|
|
125031
|
-
*
|
|
125127
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
125032
125128
|
*
|
|
125033
125129
|
* @remarks
|
|
125034
125130
|
* [Api set: WordApi 1.5]
|
|
@@ -125043,14 +125139,14 @@ declare namespace Word {
|
|
|
125043
125139
|
*/
|
|
125044
125140
|
interface ParagraphAddedEventArgs {
|
|
125045
125141
|
/**
|
|
125046
|
-
*
|
|
125142
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
125047
125143
|
*
|
|
125048
125144
|
* @remarks
|
|
125049
125145
|
* [Api set: WordApi 1.6]
|
|
125050
125146
|
*/
|
|
125051
125147
|
source: Word.EventSource | "Local" | "Remote";
|
|
125052
125148
|
/**
|
|
125053
|
-
*
|
|
125149
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
125054
125150
|
*
|
|
125055
125151
|
* @remarks
|
|
125056
125152
|
* [Api set: WordApi 1.6]
|
|
@@ -125072,14 +125168,14 @@ declare namespace Word {
|
|
|
125072
125168
|
*/
|
|
125073
125169
|
interface ParagraphChangedEventArgs {
|
|
125074
125170
|
/**
|
|
125075
|
-
*
|
|
125171
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
125076
125172
|
*
|
|
125077
125173
|
* @remarks
|
|
125078
125174
|
* [Api set: WordApi 1.6]
|
|
125079
125175
|
*/
|
|
125080
125176
|
source: Word.EventSource | "Local" | "Remote";
|
|
125081
125177
|
/**
|
|
125082
|
-
*
|
|
125178
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
125083
125179
|
*
|
|
125084
125180
|
* @remarks
|
|
125085
125181
|
* [Api set: WordApi 1.6]
|
|
@@ -125101,14 +125197,14 @@ declare namespace Word {
|
|
|
125101
125197
|
*/
|
|
125102
125198
|
interface ParagraphDeletedEventArgs {
|
|
125103
125199
|
/**
|
|
125104
|
-
*
|
|
125200
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
125105
125201
|
*
|
|
125106
125202
|
* @remarks
|
|
125107
125203
|
* [Api set: WordApi 1.6]
|
|
125108
125204
|
*/
|
|
125109
125205
|
source: Word.EventSource | "Local" | "Remote";
|
|
125110
125206
|
/**
|
|
125111
|
-
*
|
|
125207
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
125112
125208
|
*
|
|
125113
125209
|
* @remarks
|
|
125114
125210
|
* [Api set: WordApi 1.6]
|
|
@@ -125147,7 +125243,7 @@ declare namespace Word {
|
|
|
125147
125243
|
*/
|
|
125148
125244
|
commentDetails: Word.CommentDetail[];
|
|
125149
125245
|
/**
|
|
125150
|
-
*
|
|
125246
|
+
* Specifies the source of the event. It can be local or remote (through coauthoring).
|
|
125151
125247
|
*
|
|
125152
125248
|
* @remarks
|
|
125153
125249
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -125155,7 +125251,7 @@ declare namespace Word {
|
|
|
125155
125251
|
*/
|
|
125156
125252
|
source: Word.EventSource | "Local" | "Remote";
|
|
125157
125253
|
/**
|
|
125158
|
-
*
|
|
125254
|
+
* Specifies the event type. See `Word.EventType` for details.
|
|
125159
125255
|
*
|
|
125160
125256
|
* @remarks
|
|
125161
125257
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -126233,7 +126329,7 @@ declare namespace Word {
|
|
|
126233
126329
|
mixed = "Mixed",
|
|
126234
126330
|
}
|
|
126235
126331
|
/**
|
|
126236
|
-
*
|
|
126332
|
+
* Represents the {@link Word.Border | border} type.
|
|
126237
126333
|
*
|
|
126238
126334
|
* @remarks
|
|
126239
126335
|
* [Api set: WordApi 1.3]
|
|
@@ -151693,7 +151789,7 @@ declare namespace Word {
|
|
|
151693
151789
|
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
151694
151790
|
interface ShapeUpdateData {
|
|
151695
151791
|
/**
|
|
151696
|
-
*
|
|
151792
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
151697
151793
|
*
|
|
151698
151794
|
* @remarks
|
|
151699
151795
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151763,35 +151859,35 @@ declare namespace Word {
|
|
|
151763
151859
|
*/
|
|
151764
151860
|
altTextDescription?: string;
|
|
151765
151861
|
/**
|
|
151766
|
-
*
|
|
151862
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
151767
151863
|
*
|
|
151768
151864
|
* @remarks
|
|
151769
151865
|
* [Api set: WordApiDesktop 1.2]
|
|
151770
151866
|
*/
|
|
151771
151867
|
geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
151772
151868
|
/**
|
|
151773
|
-
*
|
|
151869
|
+
* Specifies the height, in points, of the shape.
|
|
151774
151870
|
*
|
|
151775
151871
|
* @remarks
|
|
151776
151872
|
* [Api set: WordApiDesktop 1.2]
|
|
151777
151873
|
*/
|
|
151778
151874
|
height?: number;
|
|
151779
151875
|
/**
|
|
151780
|
-
*
|
|
151876
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
151781
151877
|
*
|
|
151782
151878
|
* @remarks
|
|
151783
151879
|
* [Api set: WordApiDesktop 1.2]
|
|
151784
151880
|
*/
|
|
151785
151881
|
heightRelative?: number;
|
|
151786
151882
|
/**
|
|
151787
|
-
*
|
|
151883
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
151788
151884
|
*
|
|
151789
151885
|
* @remarks
|
|
151790
151886
|
* [Api set: WordApiDesktop 1.2]
|
|
151791
151887
|
*/
|
|
151792
151888
|
left?: number;
|
|
151793
151889
|
/**
|
|
151794
|
-
*
|
|
151890
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
151795
151891
|
*
|
|
151796
151892
|
* @remarks
|
|
151797
151893
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151805,35 +151901,35 @@ declare namespace Word {
|
|
|
151805
151901
|
*/
|
|
151806
151902
|
lockAspectRatio?: boolean;
|
|
151807
151903
|
/**
|
|
151808
|
-
*
|
|
151904
|
+
* Specifies the name of the shape.
|
|
151809
151905
|
*
|
|
151810
151906
|
* @remarks
|
|
151811
151907
|
* [Api set: WordApiDesktop 1.2]
|
|
151812
151908
|
*/
|
|
151813
151909
|
name?: string;
|
|
151814
151910
|
/**
|
|
151815
|
-
*
|
|
151911
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
151816
151912
|
*
|
|
151817
151913
|
* @remarks
|
|
151818
151914
|
* [Api set: WordApiDesktop 1.2]
|
|
151819
151915
|
*/
|
|
151820
151916
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
151821
151917
|
/**
|
|
151822
|
-
*
|
|
151918
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
151823
151919
|
*
|
|
151824
151920
|
* @remarks
|
|
151825
151921
|
* [Api set: WordApiDesktop 1.2]
|
|
151826
151922
|
*/
|
|
151827
151923
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
151828
151924
|
/**
|
|
151829
|
-
*
|
|
151925
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
151830
151926
|
*
|
|
151831
151927
|
* @remarks
|
|
151832
151928
|
* [Api set: WordApiDesktop 1.2]
|
|
151833
151929
|
*/
|
|
151834
151930
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
151835
151931
|
/**
|
|
151836
|
-
*
|
|
151932
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
151837
151933
|
*
|
|
151838
151934
|
* @remarks
|
|
151839
151935
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151847,14 +151943,14 @@ declare namespace Word {
|
|
|
151847
151943
|
*/
|
|
151848
151944
|
rotation?: number;
|
|
151849
151945
|
/**
|
|
151850
|
-
*
|
|
151946
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
151851
151947
|
*
|
|
151852
151948
|
* @remarks
|
|
151853
151949
|
* [Api set: WordApiDesktop 1.2]
|
|
151854
151950
|
*/
|
|
151855
151951
|
top?: number;
|
|
151856
151952
|
/**
|
|
151857
|
-
*
|
|
151953
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
151858
151954
|
*
|
|
151859
151955
|
* @remarks
|
|
151860
151956
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -151868,14 +151964,14 @@ declare namespace Word {
|
|
|
151868
151964
|
*/
|
|
151869
151965
|
visible?: boolean;
|
|
151870
151966
|
/**
|
|
151871
|
-
*
|
|
151967
|
+
* Specifies the width, in points, of the shape.
|
|
151872
151968
|
*
|
|
151873
151969
|
* @remarks
|
|
151874
151970
|
* [Api set: WordApiDesktop 1.2]
|
|
151875
151971
|
*/
|
|
151876
151972
|
width?: number;
|
|
151877
151973
|
/**
|
|
151878
|
-
*
|
|
151974
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
151879
151975
|
*
|
|
151880
151976
|
* @remarks
|
|
151881
151977
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159568,7 +159664,7 @@ declare namespace Word {
|
|
|
159568
159664
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
159569
159665
|
interface ShapeData {
|
|
159570
159666
|
/**
|
|
159571
|
-
*
|
|
159667
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
159572
159668
|
*
|
|
159573
159669
|
* @remarks
|
|
159574
159670
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159638,21 +159734,21 @@ declare namespace Word {
|
|
|
159638
159734
|
*/
|
|
159639
159735
|
altTextDescription?: string;
|
|
159640
159736
|
/**
|
|
159641
|
-
*
|
|
159737
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
159642
159738
|
*
|
|
159643
159739
|
* @remarks
|
|
159644
159740
|
* [Api set: WordApiDesktop 1.2]
|
|
159645
159741
|
*/
|
|
159646
159742
|
geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
159647
159743
|
/**
|
|
159648
|
-
*
|
|
159744
|
+
* Specifies the height, in points, of the shape.
|
|
159649
159745
|
*
|
|
159650
159746
|
* @remarks
|
|
159651
159747
|
* [Api set: WordApiDesktop 1.2]
|
|
159652
159748
|
*/
|
|
159653
159749
|
height?: number;
|
|
159654
159750
|
/**
|
|
159655
|
-
*
|
|
159751
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
159656
159752
|
*
|
|
159657
159753
|
* @remarks
|
|
159658
159754
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159673,14 +159769,14 @@ declare namespace Word {
|
|
|
159673
159769
|
*/
|
|
159674
159770
|
isChild?: boolean;
|
|
159675
159771
|
/**
|
|
159676
|
-
*
|
|
159772
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
159677
159773
|
*
|
|
159678
159774
|
* @remarks
|
|
159679
159775
|
* [Api set: WordApiDesktop 1.2]
|
|
159680
159776
|
*/
|
|
159681
159777
|
left?: number;
|
|
159682
159778
|
/**
|
|
159683
|
-
*
|
|
159779
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
159684
159780
|
*
|
|
159685
159781
|
* @remarks
|
|
159686
159782
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159694,35 +159790,35 @@ declare namespace Word {
|
|
|
159694
159790
|
*/
|
|
159695
159791
|
lockAspectRatio?: boolean;
|
|
159696
159792
|
/**
|
|
159697
|
-
*
|
|
159793
|
+
* Specifies the name of the shape.
|
|
159698
159794
|
*
|
|
159699
159795
|
* @remarks
|
|
159700
159796
|
* [Api set: WordApiDesktop 1.2]
|
|
159701
159797
|
*/
|
|
159702
159798
|
name?: string;
|
|
159703
159799
|
/**
|
|
159704
|
-
*
|
|
159800
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
159705
159801
|
*
|
|
159706
159802
|
* @remarks
|
|
159707
159803
|
* [Api set: WordApiDesktop 1.2]
|
|
159708
159804
|
*/
|
|
159709
159805
|
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
|
|
159710
159806
|
/**
|
|
159711
|
-
*
|
|
159807
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
159712
159808
|
*
|
|
159713
159809
|
* @remarks
|
|
159714
159810
|
* [Api set: WordApiDesktop 1.2]
|
|
159715
159811
|
*/
|
|
159716
159812
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
159717
159813
|
/**
|
|
159718
|
-
*
|
|
159814
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
159719
159815
|
*
|
|
159720
159816
|
* @remarks
|
|
159721
159817
|
* [Api set: WordApiDesktop 1.2]
|
|
159722
159818
|
*/
|
|
159723
159819
|
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
159724
159820
|
/**
|
|
159725
|
-
*
|
|
159821
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
159726
159822
|
*
|
|
159727
159823
|
* @remarks
|
|
159728
159824
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159736,14 +159832,14 @@ declare namespace Word {
|
|
|
159736
159832
|
*/
|
|
159737
159833
|
rotation?: number;
|
|
159738
159834
|
/**
|
|
159739
|
-
*
|
|
159835
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
159740
159836
|
*
|
|
159741
159837
|
* @remarks
|
|
159742
159838
|
* [Api set: WordApiDesktop 1.2]
|
|
159743
159839
|
*/
|
|
159744
159840
|
top?: number;
|
|
159745
159841
|
/**
|
|
159746
|
-
*
|
|
159842
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
159747
159843
|
*
|
|
159748
159844
|
* @remarks
|
|
159749
159845
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -159764,14 +159860,14 @@ declare namespace Word {
|
|
|
159764
159860
|
*/
|
|
159765
159861
|
visible?: boolean;
|
|
159766
159862
|
/**
|
|
159767
|
-
*
|
|
159863
|
+
* Specifies the width, in points, of the shape.
|
|
159768
159864
|
*
|
|
159769
159865
|
* @remarks
|
|
159770
159866
|
* [Api set: WordApiDesktop 1.2]
|
|
159771
159867
|
*/
|
|
159772
159868
|
width?: number;
|
|
159773
159869
|
/**
|
|
159774
|
-
*
|
|
159870
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
159775
159871
|
*
|
|
159776
159872
|
* @remarks
|
|
159777
159873
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -163007,7 +163103,7 @@ declare namespace Word {
|
|
|
163007
163103
|
name?: boolean;
|
|
163008
163104
|
}
|
|
163009
163105
|
/**
|
|
163010
|
-
*
|
|
163106
|
+
* Represents the data specific to content controls of type `CheckBox`.
|
|
163011
163107
|
*
|
|
163012
163108
|
* @remarks
|
|
163013
163109
|
* [Api set: WordApi 1.7]
|
|
@@ -165555,7 +165651,7 @@ declare namespace Word {
|
|
|
165555
165651
|
xmlSaveThroughXslt?: boolean;
|
|
165556
165652
|
}
|
|
165557
165653
|
/**
|
|
165558
|
-
* The `DocumentCreated` object is the top
|
|
165654
|
+
* The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object.
|
|
165559
165655
|
*
|
|
165560
165656
|
* @remarks
|
|
165561
165657
|
* [Api set: WordApi 1.3]
|
|
@@ -172300,7 +172396,7 @@ declare namespace Word {
|
|
|
172300
172396
|
*/
|
|
172301
172397
|
$all?: boolean;
|
|
172302
172398
|
/**
|
|
172303
|
-
*
|
|
172399
|
+
* Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
172304
172400
|
*
|
|
172305
172401
|
* @remarks
|
|
172306
172402
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172370,21 +172466,21 @@ declare namespace Word {
|
|
|
172370
172466
|
*/
|
|
172371
172467
|
altTextDescription?: boolean;
|
|
172372
172468
|
/**
|
|
172373
|
-
*
|
|
172469
|
+
* Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
172374
172470
|
*
|
|
172375
172471
|
* @remarks
|
|
172376
172472
|
* [Api set: WordApiDesktop 1.2]
|
|
172377
172473
|
*/
|
|
172378
172474
|
geometricShapeType?: boolean;
|
|
172379
172475
|
/**
|
|
172380
|
-
*
|
|
172476
|
+
* Specifies the height, in points, of the shape.
|
|
172381
172477
|
*
|
|
172382
172478
|
* @remarks
|
|
172383
172479
|
* [Api set: WordApiDesktop 1.2]
|
|
172384
172480
|
*/
|
|
172385
172481
|
height?: boolean;
|
|
172386
172482
|
/**
|
|
172387
|
-
*
|
|
172483
|
+
* Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
172388
172484
|
*
|
|
172389
172485
|
* @remarks
|
|
172390
172486
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172405,14 +172501,14 @@ declare namespace Word {
|
|
|
172405
172501
|
*/
|
|
172406
172502
|
isChild?: boolean;
|
|
172407
172503
|
/**
|
|
172408
|
-
*
|
|
172504
|
+
* Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
172409
172505
|
*
|
|
172410
172506
|
* @remarks
|
|
172411
172507
|
* [Api set: WordApiDesktop 1.2]
|
|
172412
172508
|
*/
|
|
172413
172509
|
left?: boolean;
|
|
172414
172510
|
/**
|
|
172415
|
-
*
|
|
172511
|
+
* Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
172416
172512
|
*
|
|
172417
172513
|
* @remarks
|
|
172418
172514
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172426,35 +172522,35 @@ declare namespace Word {
|
|
|
172426
172522
|
*/
|
|
172427
172523
|
lockAspectRatio?: boolean;
|
|
172428
172524
|
/**
|
|
172429
|
-
*
|
|
172525
|
+
* Specifies the name of the shape.
|
|
172430
172526
|
*
|
|
172431
172527
|
* @remarks
|
|
172432
172528
|
* [Api set: WordApiDesktop 1.2]
|
|
172433
172529
|
*/
|
|
172434
172530
|
name?: boolean;
|
|
172435
172531
|
/**
|
|
172436
|
-
*
|
|
172532
|
+
* Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
172437
172533
|
*
|
|
172438
172534
|
* @remarks
|
|
172439
172535
|
* [Api set: WordApiDesktop 1.2]
|
|
172440
172536
|
*/
|
|
172441
172537
|
relativeHorizontalPosition?: boolean;
|
|
172442
172538
|
/**
|
|
172443
|
-
*
|
|
172539
|
+
* Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
172444
172540
|
*
|
|
172445
172541
|
* @remarks
|
|
172446
172542
|
* [Api set: WordApiDesktop 1.2]
|
|
172447
172543
|
*/
|
|
172448
172544
|
relativeHorizontalSize?: boolean;
|
|
172449
172545
|
/**
|
|
172450
|
-
*
|
|
172546
|
+
* Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
172451
172547
|
*
|
|
172452
172548
|
* @remarks
|
|
172453
172549
|
* [Api set: WordApiDesktop 1.2]
|
|
172454
172550
|
*/
|
|
172455
172551
|
relativeVerticalPosition?: boolean;
|
|
172456
172552
|
/**
|
|
172457
|
-
*
|
|
172553
|
+
* Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
172458
172554
|
*
|
|
172459
172555
|
* @remarks
|
|
172460
172556
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172468,14 +172564,14 @@ declare namespace Word {
|
|
|
172468
172564
|
*/
|
|
172469
172565
|
rotation?: boolean;
|
|
172470
172566
|
/**
|
|
172471
|
-
*
|
|
172567
|
+
* Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
172472
172568
|
*
|
|
172473
172569
|
* @remarks
|
|
172474
172570
|
* [Api set: WordApiDesktop 1.2]
|
|
172475
172571
|
*/
|
|
172476
172572
|
top?: boolean;
|
|
172477
172573
|
/**
|
|
172478
|
-
*
|
|
172574
|
+
* Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
172479
172575
|
*
|
|
172480
172576
|
* @remarks
|
|
172481
172577
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172496,14 +172592,14 @@ declare namespace Word {
|
|
|
172496
172592
|
*/
|
|
172497
172593
|
visible?: boolean;
|
|
172498
172594
|
/**
|
|
172499
|
-
*
|
|
172595
|
+
* Specifies the width, in points, of the shape.
|
|
172500
172596
|
*
|
|
172501
172597
|
* @remarks
|
|
172502
172598
|
* [Api set: WordApiDesktop 1.2]
|
|
172503
172599
|
*/
|
|
172504
172600
|
width?: boolean;
|
|
172505
172601
|
/**
|
|
172506
|
-
*
|
|
172602
|
+
* Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
172507
172603
|
*
|
|
172508
172604
|
* @remarks
|
|
172509
172605
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172574,7 +172670,7 @@ declare namespace Word {
|
|
|
172574
172670
|
*/
|
|
172575
172671
|
$all?: boolean;
|
|
172576
172672
|
/**
|
|
172577
|
-
* For EACH ITEM in the collection:
|
|
172673
|
+
* For EACH ITEM in the collection: Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes.
|
|
172578
172674
|
*
|
|
172579
172675
|
* @remarks
|
|
172580
172676
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172644,21 +172740,21 @@ declare namespace Word {
|
|
|
172644
172740
|
*/
|
|
172645
172741
|
altTextDescription?: boolean;
|
|
172646
172742
|
/**
|
|
172647
|
-
* For EACH ITEM in the collection:
|
|
172743
|
+
* For EACH ITEM in the collection: Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape.
|
|
172648
172744
|
*
|
|
172649
172745
|
* @remarks
|
|
172650
172746
|
* [Api set: WordApiDesktop 1.2]
|
|
172651
172747
|
*/
|
|
172652
172748
|
geometricShapeType?: boolean;
|
|
172653
172749
|
/**
|
|
172654
|
-
* For EACH ITEM in the collection:
|
|
172750
|
+
* For EACH ITEM in the collection: Specifies the height, in points, of the shape.
|
|
172655
172751
|
*
|
|
172656
172752
|
* @remarks
|
|
172657
172753
|
* [Api set: WordApiDesktop 1.2]
|
|
172658
172754
|
*/
|
|
172659
172755
|
height?: boolean;
|
|
172660
172756
|
/**
|
|
172661
|
-
* For EACH ITEM in the collection:
|
|
172757
|
+
* For EACH ITEM in the collection: Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set.
|
|
172662
172758
|
*
|
|
172663
172759
|
* @remarks
|
|
172664
172760
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172679,14 +172775,14 @@ declare namespace Word {
|
|
|
172679
172775
|
*/
|
|
172680
172776
|
isChild?: boolean;
|
|
172681
172777
|
/**
|
|
172682
|
-
* For EACH ITEM in the collection:
|
|
172778
|
+
* For EACH ITEM in the collection: Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
172683
172779
|
*
|
|
172684
172780
|
* @remarks
|
|
172685
172781
|
* [Api set: WordApiDesktop 1.2]
|
|
172686
172782
|
*/
|
|
172687
172783
|
left?: boolean;
|
|
172688
172784
|
/**
|
|
172689
|
-
* For EACH ITEM in the collection:
|
|
172785
|
+
* For EACH ITEM in the collection: Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
172690
172786
|
*
|
|
172691
172787
|
* @remarks
|
|
172692
172788
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172700,35 +172796,35 @@ declare namespace Word {
|
|
|
172700
172796
|
*/
|
|
172701
172797
|
lockAspectRatio?: boolean;
|
|
172702
172798
|
/**
|
|
172703
|
-
* For EACH ITEM in the collection:
|
|
172799
|
+
* For EACH ITEM in the collection: Specifies the name of the shape.
|
|
172704
172800
|
*
|
|
172705
172801
|
* @remarks
|
|
172706
172802
|
* [Api set: WordApiDesktop 1.2]
|
|
172707
172803
|
*/
|
|
172708
172804
|
name?: boolean;
|
|
172709
172805
|
/**
|
|
172710
|
-
* For EACH ITEM in the collection:
|
|
172806
|
+
* For EACH ITEM in the collection: Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
|
|
172711
172807
|
*
|
|
172712
172808
|
* @remarks
|
|
172713
172809
|
* [Api set: WordApiDesktop 1.2]
|
|
172714
172810
|
*/
|
|
172715
172811
|
relativeHorizontalPosition?: boolean;
|
|
172716
172812
|
/**
|
|
172717
|
-
* For EACH ITEM in the collection:
|
|
172813
|
+
* For EACH ITEM in the collection: Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set.
|
|
172718
172814
|
*
|
|
172719
172815
|
* @remarks
|
|
172720
172816
|
* [Api set: WordApiDesktop 1.2]
|
|
172721
172817
|
*/
|
|
172722
172818
|
relativeHorizontalSize?: boolean;
|
|
172723
172819
|
/**
|
|
172724
|
-
* For EACH ITEM in the collection:
|
|
172820
|
+
* For EACH ITEM in the collection: Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
172725
172821
|
*
|
|
172726
172822
|
* @remarks
|
|
172727
172823
|
* [Api set: WordApiDesktop 1.2]
|
|
172728
172824
|
*/
|
|
172729
172825
|
relativeVerticalPosition?: boolean;
|
|
172730
172826
|
/**
|
|
172731
|
-
* For EACH ITEM in the collection:
|
|
172827
|
+
* For EACH ITEM in the collection: Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set.
|
|
172732
172828
|
*
|
|
172733
172829
|
* @remarks
|
|
172734
172830
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172742,14 +172838,14 @@ declare namespace Word {
|
|
|
172742
172838
|
*/
|
|
172743
172839
|
rotation?: boolean;
|
|
172744
172840
|
/**
|
|
172745
|
-
* For EACH ITEM in the collection:
|
|
172841
|
+
* For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
172746
172842
|
*
|
|
172747
172843
|
* @remarks
|
|
172748
172844
|
* [Api set: WordApiDesktop 1.2]
|
|
172749
172845
|
*/
|
|
172750
172846
|
top?: boolean;
|
|
172751
172847
|
/**
|
|
172752
|
-
* For EACH ITEM in the collection:
|
|
172848
|
+
* For EACH ITEM in the collection: Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set.
|
|
172753
172849
|
*
|
|
172754
172850
|
* @remarks
|
|
172755
172851
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -172770,14 +172866,14 @@ declare namespace Word {
|
|
|
172770
172866
|
*/
|
|
172771
172867
|
visible?: boolean;
|
|
172772
172868
|
/**
|
|
172773
|
-
* For EACH ITEM in the collection:
|
|
172869
|
+
* For EACH ITEM in the collection: Specifies the width, in points, of the shape.
|
|
172774
172870
|
*
|
|
172775
172871
|
* @remarks
|
|
172776
172872
|
* [Api set: WordApiDesktop 1.2]
|
|
172777
172873
|
*/
|
|
172778
172874
|
width?: boolean;
|
|
172779
172875
|
/**
|
|
172780
|
-
* For EACH ITEM in the collection:
|
|
172876
|
+
* For EACH ITEM in the collection: Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set.
|
|
172781
172877
|
*
|
|
172782
172878
|
* @remarks
|
|
172783
172879
|
* [Api set: WordApiDesktop 1.2]
|
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.670",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "0287982a183ca08ca2e883defbd95e4f77e6a1b9fcf6dfed7269343116724a2b",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|