@types/office-js 1.0.252 → 1.0.255
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/README.md +1 -1
- office-js/index.d.ts +1852 -8
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -18296,7 +18296,7 @@ declare namespace OfficeExtension {
|
|
|
18296
18296
|
* This statement will never contain any potentially-sensitive data and may not match the code exactly as written,
|
|
18297
18297
|
* but will be a close approximation.
|
|
18298
18298
|
*/
|
|
18299
|
-
|
|
18299
|
+
statement?: string;
|
|
18300
18300
|
/**
|
|
18301
18301
|
* The statements that closely precede and follow the statement that caused the error, if available.
|
|
18302
18302
|
*
|
|
@@ -19691,6 +19691,32 @@ declare namespace Excel {
|
|
|
19691
19691
|
*/
|
|
19692
19692
|
automatic = "Automatic"
|
|
19693
19693
|
}
|
|
19694
|
+
/**
|
|
19695
|
+
* Represents a command type of `DataConnection`.
|
|
19696
|
+
*
|
|
19697
|
+
* @remarks
|
|
19698
|
+
* [Api set: ExcelApi 1.15]
|
|
19699
|
+
*/
|
|
19700
|
+
enum DataSourceType {
|
|
19701
|
+
/**
|
|
19702
|
+
* The data source type is unknown or unsupported.
|
|
19703
|
+
* @remarks
|
|
19704
|
+
* [Api set: ExcelApi 1.15]
|
|
19705
|
+
*/
|
|
19706
|
+
unknown = "Unknown",
|
|
19707
|
+
/**
|
|
19708
|
+
* The data source type is a range in the current workbook.
|
|
19709
|
+
* @remarks
|
|
19710
|
+
* [Api set: ExcelApi 1.15]
|
|
19711
|
+
*/
|
|
19712
|
+
localRange = "LocalRange",
|
|
19713
|
+
/**
|
|
19714
|
+
* The data source type is a table in the current workbook.
|
|
19715
|
+
* @remarks
|
|
19716
|
+
* [Api set: ExcelApi 1.15]
|
|
19717
|
+
*/
|
|
19718
|
+
localTable = "LocalTable"
|
|
19719
|
+
}
|
|
19694
19720
|
/**
|
|
19695
19721
|
* Enum representing all accepted conditions by which a date filter can be applied.
|
|
19696
19722
|
Used to configure the type of PivotFilter that is applied to the field.
|
|
@@ -23996,14 +24022,21 @@ declare namespace Excel {
|
|
|
23996
24022
|
*/
|
|
23997
24023
|
getColumnsBefore(count?: number): Excel.Range;
|
|
23998
24024
|
/**
|
|
23999
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the
|
|
24000
|
-
*
|
|
24025
|
+
* Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
|
|
24026
|
+
*
|
|
24027
|
+
* @remarks
|
|
24028
|
+
* [Api set: ExcelApi 1.15]
|
|
24029
|
+
*/
|
|
24030
|
+
getDependents(): Excel.WorkbookRangeAreas;
|
|
24031
|
+
/**
|
|
24032
|
+
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
|
|
24033
|
+
*
|
|
24001
24034
|
* @remarks
|
|
24002
24035
|
* [Api set: ExcelApi 1.13]
|
|
24003
24036
|
*/
|
|
24004
24037
|
getDirectDependents(): Excel.WorkbookRangeAreas;
|
|
24005
24038
|
/**
|
|
24006
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct
|
|
24039
|
+
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
|
|
24007
24040
|
*
|
|
24008
24041
|
* @remarks
|
|
24009
24042
|
* [Api set: ExcelApi 1.12]
|
|
@@ -24120,7 +24153,7 @@ declare namespace Excel {
|
|
|
24120
24153
|
*/
|
|
24121
24154
|
getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
|
|
24122
24155
|
/**
|
|
24123
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the
|
|
24156
|
+
* Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
|
|
24124
24157
|
*
|
|
24125
24158
|
* @remarks
|
|
24126
24159
|
* [Api set: ExcelApi 1.14]
|
|
@@ -26990,10 +27023,11 @@ declare namespace Excel {
|
|
|
26990
27023
|
to point at the index for which it was created.
|
|
26991
27024
|
*
|
|
26992
27025
|
* @remarks
|
|
26993
|
-
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.]
|
|
27026
|
+
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; 1.15 for adding `alwaysInsert` parameter.]
|
|
26994
27027
|
*
|
|
26995
27028
|
* @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
|
|
26996
27029
|
* @param values Optional. A 2D array of unformatted values of the table row.
|
|
27030
|
+
* @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
|
|
26997
27031
|
*/
|
|
26998
27032
|
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
|
|
26999
27033
|
/**
|
|
@@ -29162,6 +29196,42 @@ declare namespace Excel {
|
|
|
29162
29196
|
* [Api set: ExcelApi 1.7]
|
|
29163
29197
|
*/
|
|
29164
29198
|
delete(): void;
|
|
29199
|
+
/**
|
|
29200
|
+
* Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
|
|
29201
|
+
*
|
|
29202
|
+
* @remarks
|
|
29203
|
+
* [Api set: ExcelApi 1.15]
|
|
29204
|
+
*
|
|
29205
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
29206
|
+
*/
|
|
29207
|
+
getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
|
|
29208
|
+
/**
|
|
29209
|
+
* Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
|
|
29210
|
+
*
|
|
29211
|
+
* @remarks
|
|
29212
|
+
* [Api set: ExcelApi 1.15]
|
|
29213
|
+
*
|
|
29214
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
29215
|
+
*/
|
|
29216
|
+
getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;
|
|
29217
|
+
/**
|
|
29218
|
+
* Gets the data source type of the chart series.
|
|
29219
|
+
*
|
|
29220
|
+
* @remarks
|
|
29221
|
+
* [Api set: ExcelApi 1.15]
|
|
29222
|
+
*
|
|
29223
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
29224
|
+
*/
|
|
29225
|
+
getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
|
|
29226
|
+
/**
|
|
29227
|
+
* Gets the data source type of the chart series.
|
|
29228
|
+
*
|
|
29229
|
+
* @remarks
|
|
29230
|
+
* [Api set: ExcelApi 1.15]
|
|
29231
|
+
*
|
|
29232
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
29233
|
+
*/
|
|
29234
|
+
getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
|
|
29165
29235
|
/**
|
|
29166
29236
|
* Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series.
|
|
29167
29237
|
*
|
|
@@ -33690,6 +33760,15 @@ declare namespace Excel {
|
|
|
33690
33760
|
* [Api set: ExcelApi 1.12]
|
|
33691
33761
|
*/
|
|
33692
33762
|
getFirst(): Excel.PivotTable;
|
|
33763
|
+
/**
|
|
33764
|
+
* Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
|
|
33765
|
+
If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33766
|
+
For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
33767
|
+
*
|
|
33768
|
+
* @remarks
|
|
33769
|
+
* [Api set: ExcelApi 1.15]
|
|
33770
|
+
*/
|
|
33771
|
+
getFirstOrNullObject(): Excel.PivotTable;
|
|
33693
33772
|
/**
|
|
33694
33773
|
* Gets a PivotTable by name.
|
|
33695
33774
|
*
|
|
@@ -33929,6 +34008,21 @@ declare namespace Excel {
|
|
|
33929
34008
|
* [Api set: ExcelApi 1.8]
|
|
33930
34009
|
*/
|
|
33931
34010
|
delete(): void;
|
|
34011
|
+
/**
|
|
34012
|
+
* Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
|
|
34013
|
+
Otherwise, it returns an empty string.
|
|
34014
|
+
*
|
|
34015
|
+
* @remarks
|
|
34016
|
+
* [Api set: ExcelApi 1.15]
|
|
34017
|
+
*/
|
|
34018
|
+
getDataSourceString(): OfficeExtension.ClientResult<string>;
|
|
34019
|
+
/**
|
|
34020
|
+
* Gets the type of the data source for the PivotTable.
|
|
34021
|
+
*
|
|
34022
|
+
* @remarks
|
|
34023
|
+
* [Api set: ExcelApi 1.15]
|
|
34024
|
+
*/
|
|
34025
|
+
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
|
|
33932
34026
|
/**
|
|
33933
34027
|
* Refreshes the PivotTable.
|
|
33934
34028
|
*
|
|
@@ -40108,6 +40202,15 @@ declare namespace Excel {
|
|
|
40108
40202
|
* [Api set: ExcelApi 1.9]
|
|
40109
40203
|
*/
|
|
40110
40204
|
readonly connectionSiteCount: number;
|
|
40205
|
+
/**
|
|
40206
|
+
* Gets the display name of the shape. A newly created shape has a generated name
|
|
40207
|
+
that is localized and may not match its `name`. In this scenario, you can use
|
|
40208
|
+
this API to get the name that is displayed in the UI.
|
|
40209
|
+
*
|
|
40210
|
+
* @remarks
|
|
40211
|
+
* [Api set: ExcelApi 1.15]
|
|
40212
|
+
*/
|
|
40213
|
+
readonly displayName: string;
|
|
40111
40214
|
/**
|
|
40112
40215
|
* Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
|
|
40113
40216
|
*
|
|
@@ -42533,6 +42636,38 @@ declare namespace Excel {
|
|
|
42533
42636
|
*/
|
|
42534
42637
|
rows = "Rows"
|
|
42535
42638
|
}
|
|
42639
|
+
/**
|
|
42640
|
+
* Specifies the data source type of the chart series.
|
|
42641
|
+
*
|
|
42642
|
+
* @remarks
|
|
42643
|
+
* [Api set: ExcelApi 1.15]
|
|
42644
|
+
*/
|
|
42645
|
+
enum ChartDataSourceType {
|
|
42646
|
+
/**
|
|
42647
|
+
* The data source type of the chart series is a local range.
|
|
42648
|
+
* @remarks
|
|
42649
|
+
* [Api set: ExcelApi 1.15]
|
|
42650
|
+
*/
|
|
42651
|
+
localRange = "LocalRange",
|
|
42652
|
+
/**
|
|
42653
|
+
* The data source type of the chart series is an external range.
|
|
42654
|
+
* @remarks
|
|
42655
|
+
* [Api set: ExcelApi 1.15]
|
|
42656
|
+
*/
|
|
42657
|
+
externalRange = "ExternalRange",
|
|
42658
|
+
/**
|
|
42659
|
+
* The data source type of the chart series is a list.
|
|
42660
|
+
* @remarks
|
|
42661
|
+
* [Api set: ExcelApi 1.15]
|
|
42662
|
+
*/
|
|
42663
|
+
list = "List",
|
|
42664
|
+
/**
|
|
42665
|
+
* The data source type of the chart series is unknown or unsupported.
|
|
42666
|
+
* @remarks
|
|
42667
|
+
* [Api set: ExcelApi 1.15]
|
|
42668
|
+
*/
|
|
42669
|
+
unknown = "Unknown"
|
|
42670
|
+
}
|
|
42536
42671
|
/**
|
|
42537
42672
|
* Represents the horizontal alignment for the specified object.
|
|
42538
42673
|
*
|
|
@@ -63170,6 +63305,15 @@ declare namespace Excel {
|
|
|
63170
63305
|
* [Api set: ExcelApi 1.9]
|
|
63171
63306
|
*/
|
|
63172
63307
|
connectionSiteCount?: number;
|
|
63308
|
+
/**
|
|
63309
|
+
* Gets the display name of the shape. A newly created shape has a generated name
|
|
63310
|
+
that is localized and may not match its `name`. In this scenario, you can use
|
|
63311
|
+
this API to get the name that is displayed in the UI.
|
|
63312
|
+
*
|
|
63313
|
+
* @remarks
|
|
63314
|
+
* [Api set: ExcelApi 1.15]
|
|
63315
|
+
*/
|
|
63316
|
+
displayName?: string;
|
|
63173
63317
|
/**
|
|
63174
63318
|
* Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
|
|
63175
63319
|
*
|
|
@@ -73295,6 +73439,15 @@ declare namespace Excel {
|
|
|
73295
73439
|
* [Api set: ExcelApi 1.9]
|
|
73296
73440
|
*/
|
|
73297
73441
|
connectionSiteCount?: boolean;
|
|
73442
|
+
/**
|
|
73443
|
+
* For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
|
|
73444
|
+
that is localized and may not match its `name`. In this scenario, you can use
|
|
73445
|
+
this API to get the name that is displayed in the UI.
|
|
73446
|
+
*
|
|
73447
|
+
* @remarks
|
|
73448
|
+
* [Api set: ExcelApi 1.15]
|
|
73449
|
+
*/
|
|
73450
|
+
displayName?: boolean;
|
|
73298
73451
|
/**
|
|
73299
73452
|
* For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
|
|
73300
73453
|
*
|
|
@@ -73487,6 +73640,15 @@ declare namespace Excel {
|
|
|
73487
73640
|
* [Api set: ExcelApi 1.9]
|
|
73488
73641
|
*/
|
|
73489
73642
|
connectionSiteCount?: boolean;
|
|
73643
|
+
/**
|
|
73644
|
+
* Gets the display name of the shape. A newly created shape has a generated name
|
|
73645
|
+
that is localized and may not match its `name`. In this scenario, you can use
|
|
73646
|
+
this API to get the name that is displayed in the UI.
|
|
73647
|
+
*
|
|
73648
|
+
* @remarks
|
|
73649
|
+
* [Api set: ExcelApi 1.15]
|
|
73650
|
+
*/
|
|
73651
|
+
displayName?: boolean;
|
|
73490
73652
|
/**
|
|
73491
73653
|
* Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
|
|
73492
73654
|
*
|
|
@@ -73763,6 +73925,15 @@ declare namespace Excel {
|
|
|
73763
73925
|
* [Api set: ExcelApi 1.9]
|
|
73764
73926
|
*/
|
|
73765
73927
|
connectionSiteCount?: boolean;
|
|
73928
|
+
/**
|
|
73929
|
+
* For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
|
|
73930
|
+
that is localized and may not match its `name`. In this scenario, you can use
|
|
73931
|
+
this API to get the name that is displayed in the UI.
|
|
73932
|
+
*
|
|
73933
|
+
* @remarks
|
|
73934
|
+
* [Api set: ExcelApi 1.15]
|
|
73935
|
+
*/
|
|
73936
|
+
displayName?: boolean;
|
|
73766
73937
|
/**
|
|
73767
73938
|
* For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
|
|
73768
73939
|
*
|
|
@@ -74658,6 +74829,13 @@ declare namespace Word {
|
|
|
74658
74829
|
* [Api set: WordApi 1.1]
|
|
74659
74830
|
*/
|
|
74660
74831
|
readonly contentControls: Word.ContentControlCollection;
|
|
74832
|
+
/**
|
|
74833
|
+
* Gets the collection of endnotes in the body. Read-only.
|
|
74834
|
+
*
|
|
74835
|
+
* @remarks
|
|
74836
|
+
* [Api set: WordApiOnline 1.1]
|
|
74837
|
+
*/
|
|
74838
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
74661
74839
|
/**
|
|
74662
74840
|
* Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
|
|
74663
74841
|
*
|
|
@@ -74665,6 +74843,13 @@ declare namespace Word {
|
|
|
74665
74843
|
* [Api set: WordApi 1.1]
|
|
74666
74844
|
*/
|
|
74667
74845
|
readonly font: Word.Font;
|
|
74846
|
+
/**
|
|
74847
|
+
* Gets the collection of footnotes in the body. Read-only.
|
|
74848
|
+
*
|
|
74849
|
+
* @remarks
|
|
74850
|
+
* [Api set: WordApiOnline 1.1]
|
|
74851
|
+
*/
|
|
74852
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
74668
74853
|
/**
|
|
74669
74854
|
* Gets the collection of InlinePicture objects in the body. The collection does not include floating images. Read-only.
|
|
74670
74855
|
*
|
|
@@ -74762,7 +74947,7 @@ declare namespace Word {
|
|
|
74762
74947
|
* @remarks
|
|
74763
74948
|
* [Api set: WordApi 1.3]
|
|
74764
74949
|
*/
|
|
74765
|
-
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
74950
|
+
readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
74766
74951
|
/**
|
|
74767
74952
|
* 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.
|
|
74768
74953
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -74778,6 +74963,13 @@ declare namespace Word {
|
|
|
74778
74963
|
* [Api set: WordApi 1.1]
|
|
74779
74964
|
*/
|
|
74780
74965
|
clear(): void;
|
|
74966
|
+
/**
|
|
74967
|
+
* Gets comments associated with the body.
|
|
74968
|
+
*
|
|
74969
|
+
* @remarks
|
|
74970
|
+
* [Api set: WordApiOnline 1.1]
|
|
74971
|
+
*/
|
|
74972
|
+
getComments(): Word.CommentCollection;
|
|
74781
74973
|
/**
|
|
74782
74974
|
* Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML.
|
|
74783
74975
|
*
|
|
@@ -74810,6 +75002,24 @@ declare namespace Word {
|
|
|
74810
75002
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
74811
75003
|
*/
|
|
74812
75004
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
75005
|
+
/**
|
|
75006
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75007
|
+
*
|
|
75008
|
+
* @remarks
|
|
75009
|
+
* [Api set: WordApiOnline 1.1]
|
|
75010
|
+
*
|
|
75011
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75012
|
+
*/
|
|
75013
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
75014
|
+
/**
|
|
75015
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75016
|
+
*
|
|
75017
|
+
* @remarks
|
|
75018
|
+
* [Api set: WordApiOnline 1.1]
|
|
75019
|
+
*
|
|
75020
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
75021
|
+
*/
|
|
75022
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
74813
75023
|
/**
|
|
74814
75024
|
* Inserts a break at the specified location in the main document.
|
|
74815
75025
|
*
|
|
@@ -75052,6 +75262,496 @@ declare namespace Word {
|
|
|
75052
75262
|
*/
|
|
75053
75263
|
toJSON(): Word.Interfaces.BodyData;
|
|
75054
75264
|
}
|
|
75265
|
+
/**
|
|
75266
|
+
* Represents a comment in the document.
|
|
75267
|
+
*
|
|
75268
|
+
* @remarks
|
|
75269
|
+
* [Api set: WordApiOnline 1.1]
|
|
75270
|
+
*/
|
|
75271
|
+
class Comment extends OfficeExtension.ClientObject {
|
|
75272
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75273
|
+
context: RequestContext;
|
|
75274
|
+
/**
|
|
75275
|
+
* Gets or sets the comment's content range.
|
|
75276
|
+
*
|
|
75277
|
+
* @remarks
|
|
75278
|
+
* [Api set: WordApiOnline 1.1]
|
|
75279
|
+
*/
|
|
75280
|
+
contentRange: Word.CommentContentRange;
|
|
75281
|
+
/**
|
|
75282
|
+
* Gets the collection of reply objects associated with the comment.
|
|
75283
|
+
*
|
|
75284
|
+
* @remarks
|
|
75285
|
+
* [Api set: WordApiOnline 1.1]
|
|
75286
|
+
*/
|
|
75287
|
+
readonly replies: Word.CommentReplyCollection;
|
|
75288
|
+
/**
|
|
75289
|
+
* Gets the email of the comment's author.
|
|
75290
|
+
*
|
|
75291
|
+
* @remarks
|
|
75292
|
+
* [Api set: WordApiOnline 1.1]
|
|
75293
|
+
*/
|
|
75294
|
+
readonly authorEmail: string;
|
|
75295
|
+
/**
|
|
75296
|
+
* Gets the name of the comment's author.
|
|
75297
|
+
*
|
|
75298
|
+
* @remarks
|
|
75299
|
+
* [Api set: WordApiOnline 1.1]
|
|
75300
|
+
*/
|
|
75301
|
+
readonly authorName: string;
|
|
75302
|
+
/**
|
|
75303
|
+
* Gets or sets the comment's content as plain text.
|
|
75304
|
+
*
|
|
75305
|
+
* @remarks
|
|
75306
|
+
* [Api set: WordApiOnline 1.1]
|
|
75307
|
+
*/
|
|
75308
|
+
content: string;
|
|
75309
|
+
/**
|
|
75310
|
+
* Gets the creation date of the comment.
|
|
75311
|
+
*
|
|
75312
|
+
* @remarks
|
|
75313
|
+
* [Api set: WordApiOnline 1.1]
|
|
75314
|
+
*/
|
|
75315
|
+
readonly creationDate: Date;
|
|
75316
|
+
/**
|
|
75317
|
+
* Gets the Id of the comment. Read-only.
|
|
75318
|
+
*
|
|
75319
|
+
* @remarks
|
|
75320
|
+
* [Api set: WordApiOnline 1.1]
|
|
75321
|
+
*/
|
|
75322
|
+
readonly id: string;
|
|
75323
|
+
/**
|
|
75324
|
+
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
75325
|
+
*
|
|
75326
|
+
* @remarks
|
|
75327
|
+
* [Api set: WordApiOnline 1.1]
|
|
75328
|
+
*/
|
|
75329
|
+
resolved: boolean;
|
|
75330
|
+
/**
|
|
75331
|
+
* 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.
|
|
75332
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75333
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75334
|
+
*/
|
|
75335
|
+
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75336
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75337
|
+
set(properties: Word.Comment): void;
|
|
75338
|
+
/**
|
|
75339
|
+
* Deletes the comment and its replies.
|
|
75340
|
+
*
|
|
75341
|
+
* @remarks
|
|
75342
|
+
* [Api set: WordApiOnline 1.1]
|
|
75343
|
+
*/
|
|
75344
|
+
delete(): void;
|
|
75345
|
+
/**
|
|
75346
|
+
* Gets the range in the main document where the comment is on.
|
|
75347
|
+
*
|
|
75348
|
+
* @remarks
|
|
75349
|
+
* [Api set: WordApiOnline 1.1]
|
|
75350
|
+
*/
|
|
75351
|
+
getRange(): Word.Range;
|
|
75352
|
+
/**
|
|
75353
|
+
* Adds a new reply to the end of the comment thread.
|
|
75354
|
+
*
|
|
75355
|
+
* @remarks
|
|
75356
|
+
* [Api set: WordApiOnline 1.1]
|
|
75357
|
+
*
|
|
75358
|
+
* @param replyText Required. Reply text.
|
|
75359
|
+
*/
|
|
75360
|
+
reply(replyText: string): Word.CommentReply;
|
|
75361
|
+
/**
|
|
75362
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75363
|
+
*
|
|
75364
|
+
* @param options Provides options for which properties of the object to load.
|
|
75365
|
+
*/
|
|
75366
|
+
load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment;
|
|
75367
|
+
/**
|
|
75368
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75369
|
+
*
|
|
75370
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75371
|
+
*/
|
|
75372
|
+
load(propertyNames?: string | string[]): Word.Comment;
|
|
75373
|
+
/**
|
|
75374
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75375
|
+
*
|
|
75376
|
+
* @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.
|
|
75377
|
+
*/
|
|
75378
|
+
load(propertyNamesAndPaths?: {
|
|
75379
|
+
select?: string;
|
|
75380
|
+
expand?: string;
|
|
75381
|
+
}): Word.Comment;
|
|
75382
|
+
/**
|
|
75383
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
75384
|
+
*/
|
|
75385
|
+
track(): Word.Comment;
|
|
75386
|
+
/**
|
|
75387
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
75388
|
+
*/
|
|
75389
|
+
untrack(): Word.Comment;
|
|
75390
|
+
/**
|
|
75391
|
+
* 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 is passed to it.)
|
|
75392
|
+
* Whereas the original Word.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75393
|
+
*/
|
|
75394
|
+
toJSON(): Word.Interfaces.CommentData;
|
|
75395
|
+
}
|
|
75396
|
+
/**
|
|
75397
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
75398
|
+
*
|
|
75399
|
+
* @remarks
|
|
75400
|
+
* [Api set: WordApiOnline 1.1]
|
|
75401
|
+
*/
|
|
75402
|
+
class CommentCollection extends OfficeExtension.ClientObject {
|
|
75403
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75404
|
+
context: RequestContext;
|
|
75405
|
+
/** Gets the loaded child items in this collection. */
|
|
75406
|
+
readonly items: Word.Comment[];
|
|
75407
|
+
/**
|
|
75408
|
+
* Gets the first comment in the collection. Throws an error if this collection is empty.
|
|
75409
|
+
*
|
|
75410
|
+
* @remarks
|
|
75411
|
+
* [Api set: WordApiOnline 1.1]
|
|
75412
|
+
*/
|
|
75413
|
+
getFirst(): Word.Comment;
|
|
75414
|
+
/**
|
|
75415
|
+
* Gets the first comment in the collection. If the collection is empty, returns a null object.
|
|
75416
|
+
*
|
|
75417
|
+
* @remarks
|
|
75418
|
+
* [Api set: WordApiOnline 1.1]
|
|
75419
|
+
*/
|
|
75420
|
+
getFirstOrNullObject(): Word.Comment;
|
|
75421
|
+
/**
|
|
75422
|
+
* Gets a comment object by its index in the collection.
|
|
75423
|
+
*
|
|
75424
|
+
* @remarks
|
|
75425
|
+
* [Api set: WordApiOnline 1.1]
|
|
75426
|
+
*
|
|
75427
|
+
* @param index A number that identifies the index location of a comment object.
|
|
75428
|
+
*/
|
|
75429
|
+
getItem(index: number): Word.Comment;
|
|
75430
|
+
/**
|
|
75431
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75432
|
+
*
|
|
75433
|
+
* @param options Provides options for which properties of the object to load.
|
|
75434
|
+
*/
|
|
75435
|
+
load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection;
|
|
75436
|
+
/**
|
|
75437
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75438
|
+
*
|
|
75439
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75440
|
+
*/
|
|
75441
|
+
load(propertyNames?: string | string[]): Word.CommentCollection;
|
|
75442
|
+
/**
|
|
75443
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75444
|
+
*
|
|
75445
|
+
* @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.
|
|
75446
|
+
*/
|
|
75447
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
|
|
75448
|
+
/**
|
|
75449
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
75450
|
+
*/
|
|
75451
|
+
track(): Word.CommentCollection;
|
|
75452
|
+
/**
|
|
75453
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
75454
|
+
*/
|
|
75455
|
+
untrack(): Word.CommentCollection;
|
|
75456
|
+
/**
|
|
75457
|
+
* 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 is passed to it.)
|
|
75458
|
+
* Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
75459
|
+
*/
|
|
75460
|
+
toJSON(): Word.Interfaces.CommentCollectionData;
|
|
75461
|
+
}
|
|
75462
|
+
/**
|
|
75463
|
+
* @remarks
|
|
75464
|
+
* [Api set: WordApiOnline 1.1]
|
|
75465
|
+
*/
|
|
75466
|
+
class CommentContentRange extends OfficeExtension.ClientObject {
|
|
75467
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75468
|
+
context: RequestContext;
|
|
75469
|
+
/**
|
|
75470
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
75471
|
+
*
|
|
75472
|
+
* @remarks
|
|
75473
|
+
* [Api set: WordApiOnline 1.1]
|
|
75474
|
+
*/
|
|
75475
|
+
bold: boolean;
|
|
75476
|
+
/**
|
|
75477
|
+
* 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.
|
|
75478
|
+
*
|
|
75479
|
+
* @remarks
|
|
75480
|
+
* [Api set: WordApiOnline 1.1]
|
|
75481
|
+
*/
|
|
75482
|
+
hyperlink: string;
|
|
75483
|
+
/**
|
|
75484
|
+
* Checks whether the range length is zero. Read-only.
|
|
75485
|
+
*
|
|
75486
|
+
* @remarks
|
|
75487
|
+
* [Api set: WordApiOnline 1.1]
|
|
75488
|
+
*/
|
|
75489
|
+
readonly isEmpty: boolean;
|
|
75490
|
+
/**
|
|
75491
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
75492
|
+
*
|
|
75493
|
+
* @remarks
|
|
75494
|
+
* [Api set: WordApiOnline 1.1]
|
|
75495
|
+
*/
|
|
75496
|
+
italic: boolean;
|
|
75497
|
+
/**
|
|
75498
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
75499
|
+
*
|
|
75500
|
+
* @remarks
|
|
75501
|
+
* [Api set: WordApiOnline 1.1]
|
|
75502
|
+
*/
|
|
75503
|
+
strikeThrough: boolean;
|
|
75504
|
+
/**
|
|
75505
|
+
* Gets the text of the comment range. Read-only.
|
|
75506
|
+
*
|
|
75507
|
+
* @remarks
|
|
75508
|
+
* [Api set: WordApiOnline 1.1]
|
|
75509
|
+
*/
|
|
75510
|
+
readonly text: string;
|
|
75511
|
+
/**
|
|
75512
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
75513
|
+
*
|
|
75514
|
+
* @remarks
|
|
75515
|
+
* [Api set: WordApiOnline 1.1]
|
|
75516
|
+
*/
|
|
75517
|
+
underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
75518
|
+
/**
|
|
75519
|
+
* 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.
|
|
75520
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75521
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75522
|
+
*/
|
|
75523
|
+
set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75524
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75525
|
+
set(properties: Word.CommentContentRange): void;
|
|
75526
|
+
/**
|
|
75527
|
+
* Inserts text into at the specified location.
|
|
75528
|
+
*
|
|
75529
|
+
* @remarks
|
|
75530
|
+
* [Api set: WordApiOnline 1.1]
|
|
75531
|
+
*
|
|
75532
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75533
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75534
|
+
*/
|
|
75535
|
+
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
75536
|
+
/**
|
|
75537
|
+
* Inserts text into at the specified location.
|
|
75538
|
+
*
|
|
75539
|
+
* @remarks
|
|
75540
|
+
* [Api set: WordApiOnline 1.1]
|
|
75541
|
+
*
|
|
75542
|
+
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
75543
|
+
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
75544
|
+
*/
|
|
75545
|
+
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
|
|
75546
|
+
/**
|
|
75547
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75548
|
+
*
|
|
75549
|
+
* @param options Provides options for which properties of the object to load.
|
|
75550
|
+
*/
|
|
75551
|
+
load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;
|
|
75552
|
+
/**
|
|
75553
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75554
|
+
*
|
|
75555
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75556
|
+
*/
|
|
75557
|
+
load(propertyNames?: string | string[]): Word.CommentContentRange;
|
|
75558
|
+
/**
|
|
75559
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75560
|
+
*
|
|
75561
|
+
* @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.
|
|
75562
|
+
*/
|
|
75563
|
+
load(propertyNamesAndPaths?: {
|
|
75564
|
+
select?: string;
|
|
75565
|
+
expand?: string;
|
|
75566
|
+
}): Word.CommentContentRange;
|
|
75567
|
+
/**
|
|
75568
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
75569
|
+
*/
|
|
75570
|
+
track(): Word.CommentContentRange;
|
|
75571
|
+
/**
|
|
75572
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
75573
|
+
*/
|
|
75574
|
+
untrack(): Word.CommentContentRange;
|
|
75575
|
+
/**
|
|
75576
|
+
* 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 is passed to it.)
|
|
75577
|
+
* Whereas the original Word.CommentContentRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75578
|
+
*/
|
|
75579
|
+
toJSON(): Word.Interfaces.CommentContentRangeData;
|
|
75580
|
+
}
|
|
75581
|
+
/**
|
|
75582
|
+
* Represents a comment reply in the document.
|
|
75583
|
+
*
|
|
75584
|
+
* @remarks
|
|
75585
|
+
* [Api set: WordApiOnline 1.1]
|
|
75586
|
+
*/
|
|
75587
|
+
class CommentReply extends OfficeExtension.ClientObject {
|
|
75588
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75589
|
+
context: RequestContext;
|
|
75590
|
+
/**
|
|
75591
|
+
* Gets or sets the commentReply's content range.
|
|
75592
|
+
*
|
|
75593
|
+
* @remarks
|
|
75594
|
+
* [Api set: WordApiOnline 1.1]
|
|
75595
|
+
*/
|
|
75596
|
+
contentRange: Word.CommentContentRange;
|
|
75597
|
+
/**
|
|
75598
|
+
* Gets the parent comment of this reply.
|
|
75599
|
+
*
|
|
75600
|
+
* @remarks
|
|
75601
|
+
* [Api set: WordApiOnline 1.1]
|
|
75602
|
+
*/
|
|
75603
|
+
readonly parentComment: Word.Comment;
|
|
75604
|
+
/**
|
|
75605
|
+
* Gets the email of the comment reply's author.
|
|
75606
|
+
*
|
|
75607
|
+
* @remarks
|
|
75608
|
+
* [Api set: WordApiOnline 1.1]
|
|
75609
|
+
*/
|
|
75610
|
+
readonly authorEmail: string;
|
|
75611
|
+
/**
|
|
75612
|
+
* Gets the name of the comment reply's author.
|
|
75613
|
+
*
|
|
75614
|
+
* @remarks
|
|
75615
|
+
* [Api set: WordApiOnline 1.1]
|
|
75616
|
+
*/
|
|
75617
|
+
readonly authorName: string;
|
|
75618
|
+
/**
|
|
75619
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
75620
|
+
*
|
|
75621
|
+
* @remarks
|
|
75622
|
+
* [Api set: WordApiOnline 1.1]
|
|
75623
|
+
*/
|
|
75624
|
+
content: string;
|
|
75625
|
+
/**
|
|
75626
|
+
* Gets the creation date of the comment reply.
|
|
75627
|
+
*
|
|
75628
|
+
* @remarks
|
|
75629
|
+
* [Api set: WordApiOnline 1.1]
|
|
75630
|
+
*/
|
|
75631
|
+
readonly creationDate: Date;
|
|
75632
|
+
/**
|
|
75633
|
+
* Gets the Id of the comment reply. Read-only.
|
|
75634
|
+
*
|
|
75635
|
+
* @remarks
|
|
75636
|
+
* [Api set: WordApiOnline 1.1]
|
|
75637
|
+
*/
|
|
75638
|
+
readonly id: string;
|
|
75639
|
+
/**
|
|
75640
|
+
* 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.
|
|
75641
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
75642
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
75643
|
+
*/
|
|
75644
|
+
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75645
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75646
|
+
set(properties: Word.CommentReply): void;
|
|
75647
|
+
/**
|
|
75648
|
+
* Deletes the comment reply.
|
|
75649
|
+
*
|
|
75650
|
+
* @remarks
|
|
75651
|
+
* [Api set: WordApiOnline 1.1]
|
|
75652
|
+
*/
|
|
75653
|
+
delete(): void;
|
|
75654
|
+
/**
|
|
75655
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75656
|
+
*
|
|
75657
|
+
* @param options Provides options for which properties of the object to load.
|
|
75658
|
+
*/
|
|
75659
|
+
load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;
|
|
75660
|
+
/**
|
|
75661
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75662
|
+
*
|
|
75663
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75664
|
+
*/
|
|
75665
|
+
load(propertyNames?: string | string[]): Word.CommentReply;
|
|
75666
|
+
/**
|
|
75667
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75668
|
+
*
|
|
75669
|
+
* @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.
|
|
75670
|
+
*/
|
|
75671
|
+
load(propertyNamesAndPaths?: {
|
|
75672
|
+
select?: string;
|
|
75673
|
+
expand?: string;
|
|
75674
|
+
}): Word.CommentReply;
|
|
75675
|
+
/**
|
|
75676
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
75677
|
+
*/
|
|
75678
|
+
track(): Word.CommentReply;
|
|
75679
|
+
/**
|
|
75680
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
75681
|
+
*/
|
|
75682
|
+
untrack(): Word.CommentReply;
|
|
75683
|
+
/**
|
|
75684
|
+
* 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 is passed to it.)
|
|
75685
|
+
* Whereas the original Word.CommentReply object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
75686
|
+
*/
|
|
75687
|
+
toJSON(): Word.Interfaces.CommentReplyData;
|
|
75688
|
+
}
|
|
75689
|
+
/**
|
|
75690
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
75691
|
+
*
|
|
75692
|
+
* @remarks
|
|
75693
|
+
* [Api set: WordApiOnline 1.1]
|
|
75694
|
+
*/
|
|
75695
|
+
class CommentReplyCollection extends OfficeExtension.ClientObject {
|
|
75696
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75697
|
+
context: RequestContext;
|
|
75698
|
+
/** Gets the loaded child items in this collection. */
|
|
75699
|
+
readonly items: Word.CommentReply[];
|
|
75700
|
+
/**
|
|
75701
|
+
* Gets the first comment reply in the collection. Throws an error if this collection is empty.
|
|
75702
|
+
*
|
|
75703
|
+
* @remarks
|
|
75704
|
+
* [Api set: WordApiOnline 1.1]
|
|
75705
|
+
*/
|
|
75706
|
+
getFirst(): Word.CommentReply;
|
|
75707
|
+
/**
|
|
75708
|
+
* Gets the first comment reply in the collection. If the collection is empty, returns a null object.
|
|
75709
|
+
*
|
|
75710
|
+
* @remarks
|
|
75711
|
+
* [Api set: WordApiOnline 1.1]
|
|
75712
|
+
*/
|
|
75713
|
+
getFirstOrNullObject(): Word.CommentReply;
|
|
75714
|
+
/**
|
|
75715
|
+
* Gets a comment reply object by its index in the collection.
|
|
75716
|
+
*
|
|
75717
|
+
* @remarks
|
|
75718
|
+
* [Api set: WordApiOnline 1.1]
|
|
75719
|
+
*
|
|
75720
|
+
* @param index A number that identifies the index location of a comment reply object.
|
|
75721
|
+
*/
|
|
75722
|
+
getItem(index: number): Word.CommentReply;
|
|
75723
|
+
/**
|
|
75724
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75725
|
+
*
|
|
75726
|
+
* @param options Provides options for which properties of the object to load.
|
|
75727
|
+
*/
|
|
75728
|
+
load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection;
|
|
75729
|
+
/**
|
|
75730
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75731
|
+
*
|
|
75732
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
75733
|
+
*/
|
|
75734
|
+
load(propertyNames?: string | string[]): Word.CommentReplyCollection;
|
|
75735
|
+
/**
|
|
75736
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75737
|
+
*
|
|
75738
|
+
* @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.
|
|
75739
|
+
*/
|
|
75740
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
|
|
75741
|
+
/**
|
|
75742
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
75743
|
+
*/
|
|
75744
|
+
track(): Word.CommentReplyCollection;
|
|
75745
|
+
/**
|
|
75746
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
75747
|
+
*/
|
|
75748
|
+
untrack(): Word.CommentReplyCollection;
|
|
75749
|
+
/**
|
|
75750
|
+
* 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 is passed to it.)
|
|
75751
|
+
* Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
75752
|
+
*/
|
|
75753
|
+
toJSON(): Word.Interfaces.CommentReplyCollectionData;
|
|
75754
|
+
}
|
|
75055
75755
|
/**
|
|
75056
75756
|
* Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
|
|
75057
75757
|
*
|
|
@@ -75068,6 +75768,13 @@ declare namespace Word {
|
|
|
75068
75768
|
* [Api set: WordApi 1.1]
|
|
75069
75769
|
*/
|
|
75070
75770
|
readonly contentControls: Word.ContentControlCollection;
|
|
75771
|
+
/**
|
|
75772
|
+
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
75773
|
+
*
|
|
75774
|
+
* @remarks
|
|
75775
|
+
* [Api set: WordApiOnline 1.1]
|
|
75776
|
+
*/
|
|
75777
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
75071
75778
|
/**
|
|
75072
75779
|
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
75073
75780
|
*
|
|
@@ -75075,6 +75782,13 @@ declare namespace Word {
|
|
|
75075
75782
|
* [Api set: WordApi 1.1]
|
|
75076
75783
|
*/
|
|
75077
75784
|
readonly font: Word.Font;
|
|
75785
|
+
/**
|
|
75786
|
+
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
75787
|
+
*
|
|
75788
|
+
* @remarks
|
|
75789
|
+
* [Api set: WordApiOnline 1.1]
|
|
75790
|
+
*/
|
|
75791
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
75078
75792
|
/**
|
|
75079
75793
|
* Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only.
|
|
75080
75794
|
*
|
|
@@ -75275,6 +75989,13 @@ declare namespace Word {
|
|
|
75275
75989
|
* @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
|
|
75276
75990
|
*/
|
|
75277
75991
|
delete(keepContent: boolean): void;
|
|
75992
|
+
/**
|
|
75993
|
+
* Gets comments associated with the body.
|
|
75994
|
+
*
|
|
75995
|
+
* @remarks
|
|
75996
|
+
* [Api set: WordApiOnline 1.1]
|
|
75997
|
+
*/
|
|
75998
|
+
getComments(): Word.CommentCollection;
|
|
75278
75999
|
/**
|
|
75279
76000
|
* Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML.
|
|
75280
76001
|
*
|
|
@@ -75307,6 +76028,24 @@ declare namespace Word {
|
|
|
75307
76028
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
75308
76029
|
*/
|
|
75309
76030
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
76031
|
+
/**
|
|
76032
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76033
|
+
*
|
|
76034
|
+
* @remarks
|
|
76035
|
+
* [Api set: WordApiOnline 1.1]
|
|
76036
|
+
*
|
|
76037
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76038
|
+
*/
|
|
76039
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
76040
|
+
/**
|
|
76041
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76042
|
+
*
|
|
76043
|
+
* @remarks
|
|
76044
|
+
* [Api set: WordApiOnline 1.1]
|
|
76045
|
+
*
|
|
76046
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
76047
|
+
*/
|
|
76048
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
75310
76049
|
/**
|
|
75311
76050
|
* Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
|
|
75312
76051
|
*
|
|
@@ -75877,6 +76616,13 @@ declare namespace Word {
|
|
|
75877
76616
|
* [Api set: WordApi 1.1]
|
|
75878
76617
|
*/
|
|
75879
76618
|
readonly sections: Word.SectionCollection;
|
|
76619
|
+
/**
|
|
76620
|
+
* Gets or sets the ChangeTracking mode.
|
|
76621
|
+
*
|
|
76622
|
+
* @remarks
|
|
76623
|
+
* [Api set: WordApiOnline 1.1]
|
|
76624
|
+
*/
|
|
76625
|
+
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
75880
76626
|
/**
|
|
75881
76627
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
75882
76628
|
*
|
|
@@ -75892,6 +76638,22 @@ declare namespace Word {
|
|
|
75892
76638
|
set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
75893
76639
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
75894
76640
|
set(properties: Word.Document): void;
|
|
76641
|
+
/**
|
|
76642
|
+
* Gets the document's endnotes in a single body. Read-only.
|
|
76643
|
+
Not implemented in Word on the web.
|
|
76644
|
+
*
|
|
76645
|
+
* @remarks
|
|
76646
|
+
* [Api set: WordApiOnline 1.1]
|
|
76647
|
+
*/
|
|
76648
|
+
getEndnoteBody(): Word.Body;
|
|
76649
|
+
/**
|
|
76650
|
+
* Gets the document's footnotes in a single body. Read-only.
|
|
76651
|
+
Not implemented in Word on the web.
|
|
76652
|
+
*
|
|
76653
|
+
* @remarks
|
|
76654
|
+
* [Api set: WordApiOnline 1.1]
|
|
76655
|
+
*/
|
|
76656
|
+
getFootnoteBody(): Word.Body;
|
|
75895
76657
|
/**
|
|
75896
76658
|
* Gets the current selection of the document. Multiple selections are not supported.
|
|
75897
76659
|
*
|
|
@@ -75906,6 +76668,21 @@ declare namespace Word {
|
|
|
75906
76668
|
* [Api set: WordApi 1.1]
|
|
75907
76669
|
*/
|
|
75908
76670
|
save(): void;
|
|
76671
|
+
/**
|
|
76672
|
+
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
76673
|
+
*
|
|
76674
|
+
* @remarks
|
|
76675
|
+
* [Api set: WordApiOnline 1.1]
|
|
76676
|
+
*/
|
|
76677
|
+
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
76678
|
+
ignorePunct?: boolean;
|
|
76679
|
+
ignoreSpace?: boolean;
|
|
76680
|
+
matchCase?: boolean;
|
|
76681
|
+
matchPrefix?: boolean;
|
|
76682
|
+
matchSuffix?: boolean;
|
|
76683
|
+
matchWholeWord?: boolean;
|
|
76684
|
+
matchWildcards?: boolean;
|
|
76685
|
+
}): Word.RangeCollection;
|
|
75909
76686
|
/**
|
|
75910
76687
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
75911
76688
|
*
|
|
@@ -77142,6 +77919,157 @@ declare namespace Word {
|
|
|
77142
77919
|
*/
|
|
77143
77920
|
toJSON(): Word.Interfaces.ListItemData;
|
|
77144
77921
|
}
|
|
77922
|
+
/**
|
|
77923
|
+
* Represents a footnote or endnote.
|
|
77924
|
+
*
|
|
77925
|
+
* @remarks
|
|
77926
|
+
* [Api set: WordApiOnline 1.1]
|
|
77927
|
+
*/
|
|
77928
|
+
class NoteItem extends OfficeExtension.ClientObject {
|
|
77929
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
77930
|
+
context: RequestContext;
|
|
77931
|
+
/**
|
|
77932
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
77933
|
+
*
|
|
77934
|
+
* @remarks
|
|
77935
|
+
* [Api set: WordApiOnline 1.1]
|
|
77936
|
+
*/
|
|
77937
|
+
readonly body: Word.Body;
|
|
77938
|
+
/**
|
|
77939
|
+
* Represents a footnote or endnote reference in the main document.
|
|
77940
|
+
*
|
|
77941
|
+
* @remarks
|
|
77942
|
+
* [Api set: WordApiOnline 1.1]
|
|
77943
|
+
*/
|
|
77944
|
+
readonly reference: Word.Range;
|
|
77945
|
+
/**
|
|
77946
|
+
* Represents the note item type: footnote or endnote.
|
|
77947
|
+
*
|
|
77948
|
+
* @remarks
|
|
77949
|
+
* [Api set: WordApiOnline 1.1]
|
|
77950
|
+
*/
|
|
77951
|
+
readonly type: Word.NoteItemType | "Footnote" | "Endnote";
|
|
77952
|
+
/**
|
|
77953
|
+
* 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.
|
|
77954
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
77955
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
77956
|
+
*/
|
|
77957
|
+
set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
77958
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
77959
|
+
set(properties: Word.NoteItem): void;
|
|
77960
|
+
/**
|
|
77961
|
+
* Deletes the note item.
|
|
77962
|
+
*
|
|
77963
|
+
* @remarks
|
|
77964
|
+
* [Api set: WordApiOnline 1.1]
|
|
77965
|
+
*/
|
|
77966
|
+
delete(): void;
|
|
77967
|
+
/**
|
|
77968
|
+
* Gets the next note item of the same type. Throws an error if this note item is the last one.
|
|
77969
|
+
*
|
|
77970
|
+
* @remarks
|
|
77971
|
+
* [Api set: WordApiOnline 1.1]
|
|
77972
|
+
*/
|
|
77973
|
+
getNext(): Word.NoteItem;
|
|
77974
|
+
/**
|
|
77975
|
+
* Gets the next note item of the same type. Returns a null object if this note item is the last one.
|
|
77976
|
+
*
|
|
77977
|
+
* @remarks
|
|
77978
|
+
* [Api set: WordApiOnline 1.1]
|
|
77979
|
+
*/
|
|
77980
|
+
getNextOrNullObject(): Word.NoteItem;
|
|
77981
|
+
/**
|
|
77982
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77983
|
+
*
|
|
77984
|
+
* @param options Provides options for which properties of the object to load.
|
|
77985
|
+
*/
|
|
77986
|
+
load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
|
|
77987
|
+
/**
|
|
77988
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77989
|
+
*
|
|
77990
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
77991
|
+
*/
|
|
77992
|
+
load(propertyNames?: string | string[]): Word.NoteItem;
|
|
77993
|
+
/**
|
|
77994
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77995
|
+
*
|
|
77996
|
+
* @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.
|
|
77997
|
+
*/
|
|
77998
|
+
load(propertyNamesAndPaths?: {
|
|
77999
|
+
select?: string;
|
|
78000
|
+
expand?: string;
|
|
78001
|
+
}): Word.NoteItem;
|
|
78002
|
+
/**
|
|
78003
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
78004
|
+
*/
|
|
78005
|
+
track(): Word.NoteItem;
|
|
78006
|
+
/**
|
|
78007
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
78008
|
+
*/
|
|
78009
|
+
untrack(): Word.NoteItem;
|
|
78010
|
+
/**
|
|
78011
|
+
* 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 is passed to it.)
|
|
78012
|
+
* Whereas the original Word.NoteItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
|
|
78013
|
+
*/
|
|
78014
|
+
toJSON(): Word.Interfaces.NoteItemData;
|
|
78015
|
+
}
|
|
78016
|
+
/**
|
|
78017
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
78018
|
+
*
|
|
78019
|
+
* @remarks
|
|
78020
|
+
* [Api set: WordApiOnline 1.1]
|
|
78021
|
+
*/
|
|
78022
|
+
class NoteItemCollection extends OfficeExtension.ClientObject {
|
|
78023
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78024
|
+
context: RequestContext;
|
|
78025
|
+
/** Gets the loaded child items in this collection. */
|
|
78026
|
+
readonly items: Word.NoteItem[];
|
|
78027
|
+
/**
|
|
78028
|
+
* Gets the first note item in this collection. Throws an error if this collection is empty.
|
|
78029
|
+
*
|
|
78030
|
+
* @remarks
|
|
78031
|
+
* [Api set: WordApiOnline 1.1]
|
|
78032
|
+
*/
|
|
78033
|
+
getFirst(): Word.NoteItem;
|
|
78034
|
+
/**
|
|
78035
|
+
* Gets the first note item in this collection. Returns a null object if this collection is empty.
|
|
78036
|
+
*
|
|
78037
|
+
* @remarks
|
|
78038
|
+
* [Api set: WordApiOnline 1.1]
|
|
78039
|
+
*/
|
|
78040
|
+
getFirstOrNullObject(): Word.NoteItem;
|
|
78041
|
+
/**
|
|
78042
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78043
|
+
*
|
|
78044
|
+
* @param options Provides options for which properties of the object to load.
|
|
78045
|
+
*/
|
|
78046
|
+
load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection;
|
|
78047
|
+
/**
|
|
78048
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78049
|
+
*
|
|
78050
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
78051
|
+
*/
|
|
78052
|
+
load(propertyNames?: string | string[]): Word.NoteItemCollection;
|
|
78053
|
+
/**
|
|
78054
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78055
|
+
*
|
|
78056
|
+
* @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.
|
|
78057
|
+
*/
|
|
78058
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
|
|
78059
|
+
/**
|
|
78060
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
|
|
78061
|
+
*/
|
|
78062
|
+
track(): Word.NoteItemCollection;
|
|
78063
|
+
/**
|
|
78064
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
|
|
78065
|
+
*/
|
|
78066
|
+
untrack(): Word.NoteItemCollection;
|
|
78067
|
+
/**
|
|
78068
|
+
* 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 is passed to it.)
|
|
78069
|
+
* Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
78070
|
+
*/
|
|
78071
|
+
toJSON(): Word.Interfaces.NoteItemCollectionData;
|
|
78072
|
+
}
|
|
77145
78073
|
/**
|
|
77146
78074
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
77147
78075
|
*
|
|
@@ -77158,6 +78086,13 @@ declare namespace Word {
|
|
|
77158
78086
|
* [Api set: WordApi 1.1]
|
|
77159
78087
|
*/
|
|
77160
78088
|
readonly contentControls: Word.ContentControlCollection;
|
|
78089
|
+
/**
|
|
78090
|
+
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
78091
|
+
*
|
|
78092
|
+
* @remarks
|
|
78093
|
+
* [Api set: WordApiOnline 1.1]
|
|
78094
|
+
*/
|
|
78095
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77161
78096
|
/**
|
|
77162
78097
|
* Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77163
78098
|
*
|
|
@@ -77165,6 +78100,13 @@ declare namespace Word {
|
|
|
77165
78100
|
* [Api set: WordApi 1.1]
|
|
77166
78101
|
*/
|
|
77167
78102
|
readonly font: Word.Font;
|
|
78103
|
+
/**
|
|
78104
|
+
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
78105
|
+
*
|
|
78106
|
+
* @remarks
|
|
78107
|
+
* [Api set: WordApiOnline 1.1]
|
|
78108
|
+
*/
|
|
78109
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77168
78110
|
/**
|
|
77169
78111
|
* Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images. Read-only.
|
|
77170
78112
|
*
|
|
@@ -77400,6 +78342,13 @@ declare namespace Word {
|
|
|
77400
78342
|
* [Api set: WordApi 1.3]
|
|
77401
78343
|
*/
|
|
77402
78344
|
detachFromList(): void;
|
|
78345
|
+
/**
|
|
78346
|
+
* Gets comments associated with the paragraph.
|
|
78347
|
+
*
|
|
78348
|
+
* @remarks
|
|
78349
|
+
* [Api set: WordApiOnline 1.1]
|
|
78350
|
+
*/
|
|
78351
|
+
getComments(): Word.CommentCollection;
|
|
77403
78352
|
/**
|
|
77404
78353
|
* Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML.
|
|
77405
78354
|
*
|
|
@@ -77460,6 +78409,24 @@ declare namespace Word {
|
|
|
77460
78409
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
77461
78410
|
*/
|
|
77462
78411
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
78412
|
+
/**
|
|
78413
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78414
|
+
*
|
|
78415
|
+
* @remarks
|
|
78416
|
+
* [Api set: WordApiOnline 1.1]
|
|
78417
|
+
*
|
|
78418
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78419
|
+
*/
|
|
78420
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
78421
|
+
/**
|
|
78422
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
78423
|
+
*
|
|
78424
|
+
* @remarks
|
|
78425
|
+
* [Api set: WordApiOnline 1.1]
|
|
78426
|
+
*
|
|
78427
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
78428
|
+
*/
|
|
78429
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
77463
78430
|
/**
|
|
77464
78431
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
77465
78432
|
*
|
|
@@ -77817,6 +78784,13 @@ declare namespace Word {
|
|
|
77817
78784
|
* [Api set: WordApi 1.1]
|
|
77818
78785
|
*/
|
|
77819
78786
|
readonly contentControls: Word.ContentControlCollection;
|
|
78787
|
+
/**
|
|
78788
|
+
* Gets the collection of endnotes in the range. Read-only.
|
|
78789
|
+
*
|
|
78790
|
+
* @remarks
|
|
78791
|
+
* [Api set: WordApiOnline 1.1]
|
|
78792
|
+
*/
|
|
78793
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
77820
78794
|
/**
|
|
77821
78795
|
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
77822
78796
|
*
|
|
@@ -77824,6 +78798,13 @@ declare namespace Word {
|
|
|
77824
78798
|
* [Api set: WordApi 1.1]
|
|
77825
78799
|
*/
|
|
77826
78800
|
readonly font: Word.Font;
|
|
78801
|
+
/**
|
|
78802
|
+
* Gets the collection of footnotes in the range. Read-only.
|
|
78803
|
+
*
|
|
78804
|
+
* @remarks
|
|
78805
|
+
* [Api set: WordApiOnline 1.1]
|
|
78806
|
+
*/
|
|
78807
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
77827
78808
|
/**
|
|
77828
78809
|
* Gets the collection of inline picture objects in the range. Read-only.
|
|
77829
78810
|
*
|
|
@@ -77985,6 +78966,14 @@ declare namespace Word {
|
|
|
77985
78966
|
* @param range Required. Another range.
|
|
77986
78967
|
*/
|
|
77987
78968
|
expandToOrNullObject(range: Word.Range): Word.Range;
|
|
78969
|
+
/**
|
|
78970
|
+
* Gets comments associated with the range.
|
|
78971
|
+
*
|
|
78972
|
+
* @remarks
|
|
78973
|
+
* [Api set: WordApiOnline 1.1]
|
|
78974
|
+
* @returns
|
|
78975
|
+
*/
|
|
78976
|
+
getComments(): Word.CommentCollection;
|
|
77988
78977
|
/**
|
|
77989
78978
|
* Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML.
|
|
77990
78979
|
*
|
|
@@ -78044,6 +79033,24 @@ declare namespace Word {
|
|
|
78044
79033
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
78045
79034
|
*/
|
|
78046
79035
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
79036
|
+
/**
|
|
79037
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79038
|
+
*
|
|
79039
|
+
* @remarks
|
|
79040
|
+
* [Api set: WordApiOnline 1.1]
|
|
79041
|
+
*
|
|
79042
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79043
|
+
*/
|
|
79044
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
79045
|
+
/**
|
|
79046
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79047
|
+
*
|
|
79048
|
+
* @remarks
|
|
79049
|
+
* [Api set: WordApiOnline 1.1]
|
|
79050
|
+
*
|
|
79051
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
79052
|
+
*/
|
|
79053
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
78047
79054
|
/**
|
|
78048
79055
|
* Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
|
|
78049
79056
|
*
|
|
@@ -78074,6 +79081,16 @@ declare namespace Word {
|
|
|
78074
79081
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78075
79082
|
*/
|
|
78076
79083
|
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
79084
|
+
/**
|
|
79085
|
+
* Insert a comment on the range.
|
|
79086
|
+
*
|
|
79087
|
+
* @remarks
|
|
79088
|
+
* [Api set: WordApiOnline 1.1]
|
|
79089
|
+
*
|
|
79090
|
+
* @param commentText Required. The comment text to be inserted.
|
|
79091
|
+
* @returns comment object
|
|
79092
|
+
*/
|
|
79093
|
+
insertComment(commentText: string): Word.Comment;
|
|
78077
79094
|
/**
|
|
78078
79095
|
* Wraps the range object with a rich text content control.
|
|
78079
79096
|
*
|
|
@@ -78081,6 +79098,15 @@ declare namespace Word {
|
|
|
78081
79098
|
* [Api set: WordApi 1.1]
|
|
78082
79099
|
*/
|
|
78083
79100
|
insertContentControl(): Word.ContentControl;
|
|
79101
|
+
/**
|
|
79102
|
+
* Inserts an endnote. The endnote reference is placed after the range.
|
|
79103
|
+
*
|
|
79104
|
+
* @remarks
|
|
79105
|
+
* [Api set: WordApiOnline 1.1]
|
|
79106
|
+
*
|
|
79107
|
+
* @param insertText Optional. Text to be inserted into the endnote body. The default is "".
|
|
79108
|
+
*/
|
|
79109
|
+
insertEndnote(insertText?: string): Word.NoteItem;
|
|
78084
79110
|
/**
|
|
78085
79111
|
* Inserts a document at the specified location.
|
|
78086
79112
|
*
|
|
@@ -78101,6 +79127,15 @@ declare namespace Word {
|
|
|
78101
79127
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
78102
79128
|
*/
|
|
78103
79129
|
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79130
|
+
/**
|
|
79131
|
+
* Inserts a footnote. The footnote reference is placed after the range.
|
|
79132
|
+
*
|
|
79133
|
+
* @remarks
|
|
79134
|
+
* [Api set: WordApiOnline 1.1]
|
|
79135
|
+
*
|
|
79136
|
+
* @param insertText Optional. Text to be inserted into the footnote body. The default is "".
|
|
79137
|
+
*/
|
|
79138
|
+
insertFootnote(insertText?: string): Word.NoteItem;
|
|
78104
79139
|
/**
|
|
78105
79140
|
* Inserts HTML at the specified location.
|
|
78106
79141
|
*
|
|
@@ -78657,6 +79692,13 @@ declare namespace Word {
|
|
|
78657
79692
|
class Table extends OfficeExtension.ClientObject {
|
|
78658
79693
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
78659
79694
|
context: RequestContext;
|
|
79695
|
+
/**
|
|
79696
|
+
* Gets the collection of endnotes in the table. Read-only.
|
|
79697
|
+
*
|
|
79698
|
+
* @remarks
|
|
79699
|
+
* [Api set: WordApiOnline 1.1]
|
|
79700
|
+
*/
|
|
79701
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
78660
79702
|
/**
|
|
78661
79703
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
78662
79704
|
*
|
|
@@ -78664,6 +79706,13 @@ declare namespace Word {
|
|
|
78664
79706
|
* [Api set: WordApi 1.3]
|
|
78665
79707
|
*/
|
|
78666
79708
|
readonly font: Word.Font;
|
|
79709
|
+
/**
|
|
79710
|
+
* Gets the collection of footnotes in the table. Read-only.
|
|
79711
|
+
*
|
|
79712
|
+
* @remarks
|
|
79713
|
+
* [Api set: WordApiOnline 1.1]
|
|
79714
|
+
*/
|
|
79715
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
78667
79716
|
/**
|
|
78668
79717
|
* Gets the parent body of the table. Read-only.
|
|
78669
79718
|
*
|
|
@@ -79277,6 +80326,13 @@ declare namespace Word {
|
|
|
79277
80326
|
* [Api set: WordApi 1.3]
|
|
79278
80327
|
*/
|
|
79279
80328
|
readonly cells: Word.TableCellCollection;
|
|
80329
|
+
/**
|
|
80330
|
+
* Gets the collection of endnotes in the table row. Read-only.
|
|
80331
|
+
*
|
|
80332
|
+
* @remarks
|
|
80333
|
+
* [Api set: WordApiOnline 1.1]
|
|
80334
|
+
*/
|
|
80335
|
+
readonly endnotes: Word.NoteItemCollection;
|
|
79280
80336
|
/**
|
|
79281
80337
|
* Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
|
|
79282
80338
|
*
|
|
@@ -79284,6 +80340,13 @@ declare namespace Word {
|
|
|
79284
80340
|
* [Api set: WordApi 1.3]
|
|
79285
80341
|
*/
|
|
79286
80342
|
readonly font: Word.Font;
|
|
80343
|
+
/**
|
|
80344
|
+
* Gets the collection of footnotes in the table row. Read-only.
|
|
80345
|
+
*
|
|
80346
|
+
* @remarks
|
|
80347
|
+
* [Api set: WordApiOnline 1.1]
|
|
80348
|
+
*/
|
|
80349
|
+
readonly footnotes: Word.NoteItemCollection;
|
|
79287
80350
|
/**
|
|
79288
80351
|
* Gets parent table. Read-only.
|
|
79289
80352
|
*
|
|
@@ -79976,6 +81039,68 @@ declare namespace Word {
|
|
|
79976
81039
|
*/
|
|
79977
81040
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
79978
81041
|
}
|
|
81042
|
+
/**
|
|
81043
|
+
* ChangeTracking mode.
|
|
81044
|
+
*
|
|
81045
|
+
* @remarks
|
|
81046
|
+
* [Api set: WordApiOnline 1.1]
|
|
81047
|
+
*/
|
|
81048
|
+
enum ChangeTrackingMode {
|
|
81049
|
+
/**
|
|
81050
|
+
* ChangeTracking is turned off.
|
|
81051
|
+
* @remarks
|
|
81052
|
+
* [Api set: WordApiOnline 1.1]
|
|
81053
|
+
*/
|
|
81054
|
+
off = "Off",
|
|
81055
|
+
/**
|
|
81056
|
+
* ChangeTracking is turned on for everyone.
|
|
81057
|
+
* @remarks
|
|
81058
|
+
* [Api set: WordApiOnline 1.1]
|
|
81059
|
+
*/
|
|
81060
|
+
trackAll = "TrackAll",
|
|
81061
|
+
/**
|
|
81062
|
+
* Tracking is turned on for my changes only.
|
|
81063
|
+
* @remarks
|
|
81064
|
+
* [Api set: WordApiOnline 1.1]
|
|
81065
|
+
*/
|
|
81066
|
+
trackMineOnly = "TrackMineOnly",
|
|
81067
|
+
}
|
|
81068
|
+
/**
|
|
81069
|
+
* Specify the current version or the original version of the text.
|
|
81070
|
+
*
|
|
81071
|
+
* @remarks
|
|
81072
|
+
* [Api set: WordApiOnline 1.1]
|
|
81073
|
+
*/
|
|
81074
|
+
enum ChangeTrackingVersion {
|
|
81075
|
+
/**
|
|
81076
|
+
* @remarks
|
|
81077
|
+
* [Api set: WordApiOnline 1.1]
|
|
81078
|
+
*/
|
|
81079
|
+
original = "Original",
|
|
81080
|
+
/**
|
|
81081
|
+
* @remarks
|
|
81082
|
+
* [Api set: WordApiOnline 1.1]
|
|
81083
|
+
*/
|
|
81084
|
+
current = "Current",
|
|
81085
|
+
}
|
|
81086
|
+
/**
|
|
81087
|
+
* Note item type
|
|
81088
|
+
*
|
|
81089
|
+
* @remarks
|
|
81090
|
+
* [Api set: WordApiOnline 1.1]
|
|
81091
|
+
*/
|
|
81092
|
+
enum NoteItemType {
|
|
81093
|
+
/**
|
|
81094
|
+
* @remarks
|
|
81095
|
+
* [Api set: WordApiOnline 1.1]
|
|
81096
|
+
*/
|
|
81097
|
+
footnote = "Footnote",
|
|
81098
|
+
/**
|
|
81099
|
+
* @remarks
|
|
81100
|
+
* [Api set: WordApiOnline 1.1]
|
|
81101
|
+
*/
|
|
81102
|
+
endnote = "Endnote",
|
|
81103
|
+
}
|
|
79979
81104
|
/**
|
|
79980
81105
|
* Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added.
|
|
79981
81106
|
*
|
|
@@ -80474,6 +81599,21 @@ declare namespace Word {
|
|
|
80474
81599
|
* [Api set: WordApi 1.3]
|
|
80475
81600
|
*/
|
|
80476
81601
|
tableCell = "TableCell",
|
|
81602
|
+
/**
|
|
81603
|
+
* @remarks
|
|
81604
|
+
* [Api set: WordApiOnline 1.1]
|
|
81605
|
+
*/
|
|
81606
|
+
footnote = "Footnote",
|
|
81607
|
+
/**
|
|
81608
|
+
* @remarks
|
|
81609
|
+
* [Api set: WordApiOnline 1.1]
|
|
81610
|
+
*/
|
|
81611
|
+
endnote = "Endnote",
|
|
81612
|
+
/**
|
|
81613
|
+
* @remarks
|
|
81614
|
+
* [Api set: WordApiOnline 1.1]
|
|
81615
|
+
*/
|
|
81616
|
+
noteItem = "NoteItem",
|
|
80477
81617
|
}
|
|
80478
81618
|
/**
|
|
80479
81619
|
* This enum sets where the cursor (insertion point) in the document is after a selection.
|
|
@@ -81791,6 +82931,100 @@ declare namespace Word {
|
|
|
81791
82931
|
*/
|
|
81792
82932
|
styleBuiltIn?: Word.Style | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
81793
82933
|
}
|
|
82934
|
+
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
82935
|
+
interface CommentUpdateData {
|
|
82936
|
+
/**
|
|
82937
|
+
* Gets or sets the comment's content range.
|
|
82938
|
+
*
|
|
82939
|
+
* @remarks
|
|
82940
|
+
* [Api set: WordApiOnline 1.1]
|
|
82941
|
+
*/
|
|
82942
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
82943
|
+
/**
|
|
82944
|
+
* Gets or sets the comment's content as plain text.
|
|
82945
|
+
*
|
|
82946
|
+
* @remarks
|
|
82947
|
+
* [Api set: WordApiOnline 1.1]
|
|
82948
|
+
*/
|
|
82949
|
+
content?: string;
|
|
82950
|
+
/**
|
|
82951
|
+
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
82952
|
+
*
|
|
82953
|
+
* @remarks
|
|
82954
|
+
* [Api set: WordApiOnline 1.1]
|
|
82955
|
+
*/
|
|
82956
|
+
resolved?: boolean;
|
|
82957
|
+
}
|
|
82958
|
+
/** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
|
|
82959
|
+
interface CommentCollectionUpdateData {
|
|
82960
|
+
items?: Word.Interfaces.CommentData[];
|
|
82961
|
+
}
|
|
82962
|
+
/** An interface for updating data on the CommentContentRange object, for use in `commentContentRange.set({ ... })`. */
|
|
82963
|
+
interface CommentContentRangeUpdateData {
|
|
82964
|
+
/**
|
|
82965
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
82966
|
+
*
|
|
82967
|
+
* @remarks
|
|
82968
|
+
* [Api set: WordApiOnline 1.1]
|
|
82969
|
+
*/
|
|
82970
|
+
bold?: boolean;
|
|
82971
|
+
/**
|
|
82972
|
+
* 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.
|
|
82973
|
+
*
|
|
82974
|
+
* @remarks
|
|
82975
|
+
* [Api set: WordApiOnline 1.1]
|
|
82976
|
+
*/
|
|
82977
|
+
hyperlink?: string;
|
|
82978
|
+
/**
|
|
82979
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
82980
|
+
*
|
|
82981
|
+
* @remarks
|
|
82982
|
+
* [Api set: WordApiOnline 1.1]
|
|
82983
|
+
*/
|
|
82984
|
+
italic?: boolean;
|
|
82985
|
+
/**
|
|
82986
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
82987
|
+
*
|
|
82988
|
+
* @remarks
|
|
82989
|
+
* [Api set: WordApiOnline 1.1]
|
|
82990
|
+
*/
|
|
82991
|
+
strikeThrough?: boolean;
|
|
82992
|
+
/**
|
|
82993
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
82994
|
+
*
|
|
82995
|
+
* @remarks
|
|
82996
|
+
* [Api set: WordApiOnline 1.1]
|
|
82997
|
+
*/
|
|
82998
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
82999
|
+
}
|
|
83000
|
+
/** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */
|
|
83001
|
+
interface CommentReplyUpdateData {
|
|
83002
|
+
/**
|
|
83003
|
+
* Gets or sets the commentReply's content range.
|
|
83004
|
+
*
|
|
83005
|
+
* @remarks
|
|
83006
|
+
* [Api set: WordApiOnline 1.1]
|
|
83007
|
+
*/
|
|
83008
|
+
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
83009
|
+
/**
|
|
83010
|
+
* Gets the parent comment of this reply.
|
|
83011
|
+
*
|
|
83012
|
+
* @remarks
|
|
83013
|
+
* [Api set: WordApiOnline 1.1]
|
|
83014
|
+
*/
|
|
83015
|
+
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
83016
|
+
/**
|
|
83017
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
83018
|
+
*
|
|
83019
|
+
* @remarks
|
|
83020
|
+
* [Api set: WordApiOnline 1.1]
|
|
83021
|
+
*/
|
|
83022
|
+
content?: string;
|
|
83023
|
+
}
|
|
83024
|
+
/** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */
|
|
83025
|
+
interface CommentReplyCollectionUpdateData {
|
|
83026
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
83027
|
+
}
|
|
81794
83028
|
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
81795
83029
|
interface ContentControlUpdateData {
|
|
81796
83030
|
/**
|
|
@@ -81906,6 +83140,13 @@ declare namespace Word {
|
|
|
81906
83140
|
* [Api set: WordApi 1.3]
|
|
81907
83141
|
*/
|
|
81908
83142
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
83143
|
+
/**
|
|
83144
|
+
* Gets or sets the ChangeTracking mode.
|
|
83145
|
+
*
|
|
83146
|
+
* @remarks
|
|
83147
|
+
* [Api set: WordApiOnline 1.1]
|
|
83148
|
+
*/
|
|
83149
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
81909
83150
|
}
|
|
81910
83151
|
/** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
|
|
81911
83152
|
interface DocumentCreatedUpdateData {
|
|
@@ -82134,6 +83375,27 @@ declare namespace Word {
|
|
|
82134
83375
|
*/
|
|
82135
83376
|
level?: number;
|
|
82136
83377
|
}
|
|
83378
|
+
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
83379
|
+
interface NoteItemUpdateData {
|
|
83380
|
+
/**
|
|
83381
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
83382
|
+
*
|
|
83383
|
+
* @remarks
|
|
83384
|
+
* [Api set: WordApiOnline 1.1]
|
|
83385
|
+
*/
|
|
83386
|
+
body?: Word.Interfaces.BodyUpdateData;
|
|
83387
|
+
/**
|
|
83388
|
+
* Represents a footnote or endnote reference in the main document.
|
|
83389
|
+
*
|
|
83390
|
+
* @remarks
|
|
83391
|
+
* [Api set: WordApiOnline 1.1]
|
|
83392
|
+
*/
|
|
83393
|
+
reference?: Word.Interfaces.RangeUpdateData;
|
|
83394
|
+
}
|
|
83395
|
+
/** An interface for updating data on the NoteItemCollection object, for use in `noteItemCollection.set({ ... })`. */
|
|
83396
|
+
interface NoteItemCollectionUpdateData {
|
|
83397
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
83398
|
+
}
|
|
82137
83399
|
/** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
|
|
82138
83400
|
interface ParagraphUpdateData {
|
|
82139
83401
|
/**
|
|
@@ -82652,7 +83914,178 @@ declare namespace Word {
|
|
|
82652
83914
|
* @remarks
|
|
82653
83915
|
* [Api set: WordApi 1.3]
|
|
82654
83916
|
*/
|
|
82655
|
-
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
|
|
83917
|
+
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
83918
|
+
}
|
|
83919
|
+
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
83920
|
+
interface CommentData {
|
|
83921
|
+
/**
|
|
83922
|
+
* Gets or sets the comment's content range.
|
|
83923
|
+
*
|
|
83924
|
+
* @remarks
|
|
83925
|
+
* [Api set: WordApiOnline 1.1]
|
|
83926
|
+
*/
|
|
83927
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
83928
|
+
/**
|
|
83929
|
+
* Gets the collection of reply objects associated with the comment.
|
|
83930
|
+
*
|
|
83931
|
+
* @remarks
|
|
83932
|
+
* [Api set: WordApiOnline 1.1]
|
|
83933
|
+
*/
|
|
83934
|
+
replies?: Word.Interfaces.CommentReplyData[];
|
|
83935
|
+
/**
|
|
83936
|
+
* Gets the email of the comment's author.
|
|
83937
|
+
*
|
|
83938
|
+
* @remarks
|
|
83939
|
+
* [Api set: WordApiOnline 1.1]
|
|
83940
|
+
*/
|
|
83941
|
+
authorEmail?: string;
|
|
83942
|
+
/**
|
|
83943
|
+
* Gets the name of the comment's author.
|
|
83944
|
+
*
|
|
83945
|
+
* @remarks
|
|
83946
|
+
* [Api set: WordApiOnline 1.1]
|
|
83947
|
+
*/
|
|
83948
|
+
authorName?: string;
|
|
83949
|
+
/**
|
|
83950
|
+
* Gets or sets the comment's content as plain text.
|
|
83951
|
+
*
|
|
83952
|
+
* @remarks
|
|
83953
|
+
* [Api set: WordApiOnline 1.1]
|
|
83954
|
+
*/
|
|
83955
|
+
content?: string;
|
|
83956
|
+
/**
|
|
83957
|
+
* Gets the creation date of the comment.
|
|
83958
|
+
*
|
|
83959
|
+
* @remarks
|
|
83960
|
+
* [Api set: WordApiOnline 1.1]
|
|
83961
|
+
*/
|
|
83962
|
+
creationDate?: Date;
|
|
83963
|
+
/**
|
|
83964
|
+
* Gets the Id of the comment. Read-only.
|
|
83965
|
+
*
|
|
83966
|
+
* @remarks
|
|
83967
|
+
* [Api set: WordApiOnline 1.1]
|
|
83968
|
+
*/
|
|
83969
|
+
id?: string;
|
|
83970
|
+
/**
|
|
83971
|
+
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
83972
|
+
*
|
|
83973
|
+
* @remarks
|
|
83974
|
+
* [Api set: WordApiOnline 1.1]
|
|
83975
|
+
*/
|
|
83976
|
+
resolved?: boolean;
|
|
83977
|
+
}
|
|
83978
|
+
/** An interface describing the data returned by calling `commentCollection.toJSON()`. */
|
|
83979
|
+
interface CommentCollectionData {
|
|
83980
|
+
items?: Word.Interfaces.CommentData[];
|
|
83981
|
+
}
|
|
83982
|
+
/** An interface describing the data returned by calling `commentContentRange.toJSON()`. */
|
|
83983
|
+
interface CommentContentRangeData {
|
|
83984
|
+
/**
|
|
83985
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
83986
|
+
*
|
|
83987
|
+
* @remarks
|
|
83988
|
+
* [Api set: WordApiOnline 1.1]
|
|
83989
|
+
*/
|
|
83990
|
+
bold?: boolean;
|
|
83991
|
+
/**
|
|
83992
|
+
* 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.
|
|
83993
|
+
*
|
|
83994
|
+
* @remarks
|
|
83995
|
+
* [Api set: WordApiOnline 1.1]
|
|
83996
|
+
*/
|
|
83997
|
+
hyperlink?: string;
|
|
83998
|
+
/**
|
|
83999
|
+
* Checks whether the range length is zero. Read-only.
|
|
84000
|
+
*
|
|
84001
|
+
* @remarks
|
|
84002
|
+
* [Api set: WordApiOnline 1.1]
|
|
84003
|
+
*/
|
|
84004
|
+
isEmpty?: boolean;
|
|
84005
|
+
/**
|
|
84006
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
84007
|
+
*
|
|
84008
|
+
* @remarks
|
|
84009
|
+
* [Api set: WordApiOnline 1.1]
|
|
84010
|
+
*/
|
|
84011
|
+
italic?: boolean;
|
|
84012
|
+
/**
|
|
84013
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
84014
|
+
*
|
|
84015
|
+
* @remarks
|
|
84016
|
+
* [Api set: WordApiOnline 1.1]
|
|
84017
|
+
*/
|
|
84018
|
+
strikeThrough?: boolean;
|
|
84019
|
+
/**
|
|
84020
|
+
* Gets the text of the comment range. Read-only.
|
|
84021
|
+
*
|
|
84022
|
+
* @remarks
|
|
84023
|
+
* [Api set: WordApiOnline 1.1]
|
|
84024
|
+
*/
|
|
84025
|
+
text?: string;
|
|
84026
|
+
/**
|
|
84027
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
84028
|
+
*
|
|
84029
|
+
* @remarks
|
|
84030
|
+
* [Api set: WordApiOnline 1.1]
|
|
84031
|
+
*/
|
|
84032
|
+
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
84033
|
+
}
|
|
84034
|
+
/** An interface describing the data returned by calling `commentReply.toJSON()`. */
|
|
84035
|
+
interface CommentReplyData {
|
|
84036
|
+
/**
|
|
84037
|
+
* Gets or sets the commentReply's content range.
|
|
84038
|
+
*
|
|
84039
|
+
* @remarks
|
|
84040
|
+
* [Api set: WordApiOnline 1.1]
|
|
84041
|
+
*/
|
|
84042
|
+
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
84043
|
+
/**
|
|
84044
|
+
* Gets the parent comment of this reply.
|
|
84045
|
+
*
|
|
84046
|
+
* @remarks
|
|
84047
|
+
* [Api set: WordApiOnline 1.1]
|
|
84048
|
+
*/
|
|
84049
|
+
parentComment?: Word.Interfaces.CommentData;
|
|
84050
|
+
/**
|
|
84051
|
+
* Gets the email of the comment reply's author.
|
|
84052
|
+
*
|
|
84053
|
+
* @remarks
|
|
84054
|
+
* [Api set: WordApiOnline 1.1]
|
|
84055
|
+
*/
|
|
84056
|
+
authorEmail?: string;
|
|
84057
|
+
/**
|
|
84058
|
+
* Gets the name of the comment reply's author.
|
|
84059
|
+
*
|
|
84060
|
+
* @remarks
|
|
84061
|
+
* [Api set: WordApiOnline 1.1]
|
|
84062
|
+
*/
|
|
84063
|
+
authorName?: string;
|
|
84064
|
+
/**
|
|
84065
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
84066
|
+
*
|
|
84067
|
+
* @remarks
|
|
84068
|
+
* [Api set: WordApiOnline 1.1]
|
|
84069
|
+
*/
|
|
84070
|
+
content?: string;
|
|
84071
|
+
/**
|
|
84072
|
+
* Gets the creation date of the comment reply.
|
|
84073
|
+
*
|
|
84074
|
+
* @remarks
|
|
84075
|
+
* [Api set: WordApiOnline 1.1]
|
|
84076
|
+
*/
|
|
84077
|
+
creationDate?: Date;
|
|
84078
|
+
/**
|
|
84079
|
+
* Gets the Id of the comment reply. Read-only.
|
|
84080
|
+
*
|
|
84081
|
+
* @remarks
|
|
84082
|
+
* [Api set: WordApiOnline 1.1]
|
|
84083
|
+
*/
|
|
84084
|
+
id?: string;
|
|
84085
|
+
}
|
|
84086
|
+
/** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */
|
|
84087
|
+
interface CommentReplyCollectionData {
|
|
84088
|
+
items?: Word.Interfaces.CommentReplyData[];
|
|
82656
84089
|
}
|
|
82657
84090
|
/** An interface describing the data returned by calling `contentControl.toJSON()`. */
|
|
82658
84091
|
interface ContentControlData {
|
|
@@ -82860,6 +84293,13 @@ declare namespace Word {
|
|
|
82860
84293
|
* [Api set: WordApi 1.1]
|
|
82861
84294
|
*/
|
|
82862
84295
|
sections?: Word.Interfaces.SectionData[];
|
|
84296
|
+
/**
|
|
84297
|
+
* Gets or sets the ChangeTracking mode.
|
|
84298
|
+
*
|
|
84299
|
+
* @remarks
|
|
84300
|
+
* [Api set: WordApiOnline 1.1]
|
|
84301
|
+
*/
|
|
84302
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
82863
84303
|
/**
|
|
82864
84304
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
82865
84305
|
*
|
|
@@ -83224,6 +84664,34 @@ declare namespace Word {
|
|
|
83224
84664
|
*/
|
|
83225
84665
|
siblingIndex?: number;
|
|
83226
84666
|
}
|
|
84667
|
+
/** An interface describing the data returned by calling `noteItem.toJSON()`. */
|
|
84668
|
+
interface NoteItemData {
|
|
84669
|
+
/**
|
|
84670
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
84671
|
+
*
|
|
84672
|
+
* @remarks
|
|
84673
|
+
* [Api set: WordApiOnline 1.1]
|
|
84674
|
+
*/
|
|
84675
|
+
body?: Word.Interfaces.BodyData;
|
|
84676
|
+
/**
|
|
84677
|
+
* Represents a footnote or endnote reference in the main document.
|
|
84678
|
+
*
|
|
84679
|
+
* @remarks
|
|
84680
|
+
* [Api set: WordApiOnline 1.1]
|
|
84681
|
+
*/
|
|
84682
|
+
reference?: Word.Interfaces.RangeData;
|
|
84683
|
+
/**
|
|
84684
|
+
* Represents the note item type: footnote or endnote.
|
|
84685
|
+
*
|
|
84686
|
+
* @remarks
|
|
84687
|
+
* [Api set: WordApiOnline 1.1]
|
|
84688
|
+
*/
|
|
84689
|
+
type?: Word.NoteItemType | "Footnote" | "Endnote";
|
|
84690
|
+
}
|
|
84691
|
+
/** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */
|
|
84692
|
+
interface NoteItemCollectionData {
|
|
84693
|
+
items?: Word.Interfaces.NoteItemData[];
|
|
84694
|
+
}
|
|
83227
84695
|
/** An interface describing the data returned by calling `paragraph.toJSON()`. */
|
|
83228
84696
|
interface ParagraphData {
|
|
83229
84697
|
/**
|
|
@@ -83900,6 +85368,309 @@ declare namespace Word {
|
|
|
83900
85368
|
*/
|
|
83901
85369
|
type?: boolean;
|
|
83902
85370
|
}
|
|
85371
|
+
/**
|
|
85372
|
+
* Represents a comment in the document.
|
|
85373
|
+
*
|
|
85374
|
+
* @remarks
|
|
85375
|
+
* [Api set: WordApiOnline 1.1]
|
|
85376
|
+
*/
|
|
85377
|
+
interface CommentLoadOptions {
|
|
85378
|
+
/**
|
|
85379
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85380
|
+
*/
|
|
85381
|
+
$all?: boolean;
|
|
85382
|
+
/**
|
|
85383
|
+
* Gets or sets the comment's content range.
|
|
85384
|
+
*
|
|
85385
|
+
* @remarks
|
|
85386
|
+
* [Api set: WordApiOnline 1.1]
|
|
85387
|
+
*/
|
|
85388
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85389
|
+
/**
|
|
85390
|
+
* Gets the email of the comment's author.
|
|
85391
|
+
*
|
|
85392
|
+
* @remarks
|
|
85393
|
+
* [Api set: WordApiOnline 1.1]
|
|
85394
|
+
*/
|
|
85395
|
+
authorEmail?: boolean;
|
|
85396
|
+
/**
|
|
85397
|
+
* Gets the name of the comment's author.
|
|
85398
|
+
*
|
|
85399
|
+
* @remarks
|
|
85400
|
+
* [Api set: WordApiOnline 1.1]
|
|
85401
|
+
*/
|
|
85402
|
+
authorName?: boolean;
|
|
85403
|
+
/**
|
|
85404
|
+
* Gets or sets the comment's content as plain text.
|
|
85405
|
+
*
|
|
85406
|
+
* @remarks
|
|
85407
|
+
* [Api set: WordApiOnline 1.1]
|
|
85408
|
+
*/
|
|
85409
|
+
content?: boolean;
|
|
85410
|
+
/**
|
|
85411
|
+
* Gets the creation date of the comment.
|
|
85412
|
+
*
|
|
85413
|
+
* @remarks
|
|
85414
|
+
* [Api set: WordApiOnline 1.1]
|
|
85415
|
+
*/
|
|
85416
|
+
creationDate?: boolean;
|
|
85417
|
+
/**
|
|
85418
|
+
* Gets the Id of the comment. Read-only.
|
|
85419
|
+
*
|
|
85420
|
+
* @remarks
|
|
85421
|
+
* [Api set: WordApiOnline 1.1]
|
|
85422
|
+
*/
|
|
85423
|
+
id?: boolean;
|
|
85424
|
+
/**
|
|
85425
|
+
* Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
85426
|
+
*
|
|
85427
|
+
* @remarks
|
|
85428
|
+
* [Api set: WordApiOnline 1.1]
|
|
85429
|
+
*/
|
|
85430
|
+
resolved?: boolean;
|
|
85431
|
+
}
|
|
85432
|
+
/**
|
|
85433
|
+
* Contains a collection of {@link Word.Comment} objects.
|
|
85434
|
+
*
|
|
85435
|
+
* @remarks
|
|
85436
|
+
* [Api set: WordApiOnline 1.1]
|
|
85437
|
+
*/
|
|
85438
|
+
interface CommentCollectionLoadOptions {
|
|
85439
|
+
/**
|
|
85440
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85441
|
+
*/
|
|
85442
|
+
$all?: boolean;
|
|
85443
|
+
/**
|
|
85444
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content range.
|
|
85445
|
+
*
|
|
85446
|
+
* @remarks
|
|
85447
|
+
* [Api set: WordApiOnline 1.1]
|
|
85448
|
+
*/
|
|
85449
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85450
|
+
/**
|
|
85451
|
+
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
85452
|
+
*
|
|
85453
|
+
* @remarks
|
|
85454
|
+
* [Api set: WordApiOnline 1.1]
|
|
85455
|
+
*/
|
|
85456
|
+
authorEmail?: boolean;
|
|
85457
|
+
/**
|
|
85458
|
+
* For EACH ITEM in the collection: Gets the name of the comment's author.
|
|
85459
|
+
*
|
|
85460
|
+
* @remarks
|
|
85461
|
+
* [Api set: WordApiOnline 1.1]
|
|
85462
|
+
*/
|
|
85463
|
+
authorName?: boolean;
|
|
85464
|
+
/**
|
|
85465
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
|
|
85466
|
+
*
|
|
85467
|
+
* @remarks
|
|
85468
|
+
* [Api set: WordApiOnline 1.1]
|
|
85469
|
+
*/
|
|
85470
|
+
content?: boolean;
|
|
85471
|
+
/**
|
|
85472
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment.
|
|
85473
|
+
*
|
|
85474
|
+
* @remarks
|
|
85475
|
+
* [Api set: WordApiOnline 1.1]
|
|
85476
|
+
*/
|
|
85477
|
+
creationDate?: boolean;
|
|
85478
|
+
/**
|
|
85479
|
+
* For EACH ITEM in the collection: Gets the Id of the comment. Read-only.
|
|
85480
|
+
*
|
|
85481
|
+
* @remarks
|
|
85482
|
+
* [Api set: WordApiOnline 1.1]
|
|
85483
|
+
*/
|
|
85484
|
+
id?: boolean;
|
|
85485
|
+
/**
|
|
85486
|
+
* For EACH ITEM in the collection: Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
|
|
85487
|
+
*
|
|
85488
|
+
* @remarks
|
|
85489
|
+
* [Api set: WordApiOnline 1.1]
|
|
85490
|
+
*/
|
|
85491
|
+
resolved?: boolean;
|
|
85492
|
+
}
|
|
85493
|
+
/**
|
|
85494
|
+
* @remarks
|
|
85495
|
+
* [Api set: WordApiOnline 1.1]
|
|
85496
|
+
*/
|
|
85497
|
+
interface CommentContentRangeLoadOptions {
|
|
85498
|
+
/**
|
|
85499
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85500
|
+
*/
|
|
85501
|
+
$all?: boolean;
|
|
85502
|
+
/**
|
|
85503
|
+
* Gets or sets a value that indicates whether the comment text is bold.
|
|
85504
|
+
*
|
|
85505
|
+
* @remarks
|
|
85506
|
+
* [Api set: WordApiOnline 1.1]
|
|
85507
|
+
*/
|
|
85508
|
+
bold?: boolean;
|
|
85509
|
+
/**
|
|
85510
|
+
* 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.
|
|
85511
|
+
*
|
|
85512
|
+
* @remarks
|
|
85513
|
+
* [Api set: WordApiOnline 1.1]
|
|
85514
|
+
*/
|
|
85515
|
+
hyperlink?: boolean;
|
|
85516
|
+
/**
|
|
85517
|
+
* Checks whether the range length is zero. Read-only.
|
|
85518
|
+
*
|
|
85519
|
+
* @remarks
|
|
85520
|
+
* [Api set: WordApiOnline 1.1]
|
|
85521
|
+
*/
|
|
85522
|
+
isEmpty?: boolean;
|
|
85523
|
+
/**
|
|
85524
|
+
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
85525
|
+
*
|
|
85526
|
+
* @remarks
|
|
85527
|
+
* [Api set: WordApiOnline 1.1]
|
|
85528
|
+
*/
|
|
85529
|
+
italic?: boolean;
|
|
85530
|
+
/**
|
|
85531
|
+
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
85532
|
+
*
|
|
85533
|
+
* @remarks
|
|
85534
|
+
* [Api set: WordApiOnline 1.1]
|
|
85535
|
+
*/
|
|
85536
|
+
strikeThrough?: boolean;
|
|
85537
|
+
/**
|
|
85538
|
+
* Gets the text of the comment range. Read-only.
|
|
85539
|
+
*
|
|
85540
|
+
* @remarks
|
|
85541
|
+
* [Api set: WordApiOnline 1.1]
|
|
85542
|
+
*/
|
|
85543
|
+
text?: boolean;
|
|
85544
|
+
/**
|
|
85545
|
+
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
85546
|
+
*
|
|
85547
|
+
* @remarks
|
|
85548
|
+
* [Api set: WordApiOnline 1.1]
|
|
85549
|
+
*/
|
|
85550
|
+
underline?: boolean;
|
|
85551
|
+
}
|
|
85552
|
+
/**
|
|
85553
|
+
* Represents a comment reply in the document.
|
|
85554
|
+
*
|
|
85555
|
+
* @remarks
|
|
85556
|
+
* [Api set: WordApiOnline 1.1]
|
|
85557
|
+
*/
|
|
85558
|
+
interface CommentReplyLoadOptions {
|
|
85559
|
+
/**
|
|
85560
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85561
|
+
*/
|
|
85562
|
+
$all?: boolean;
|
|
85563
|
+
/**
|
|
85564
|
+
* Gets or sets the commentReply's content range.
|
|
85565
|
+
*
|
|
85566
|
+
* @remarks
|
|
85567
|
+
* [Api set: WordApiOnline 1.1]
|
|
85568
|
+
*/
|
|
85569
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85570
|
+
/**
|
|
85571
|
+
* Gets the parent comment of this reply.
|
|
85572
|
+
*
|
|
85573
|
+
* @remarks
|
|
85574
|
+
* [Api set: WordApiOnline 1.1]
|
|
85575
|
+
*/
|
|
85576
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
85577
|
+
/**
|
|
85578
|
+
* Gets the email of the comment reply's author.
|
|
85579
|
+
*
|
|
85580
|
+
* @remarks
|
|
85581
|
+
* [Api set: WordApiOnline 1.1]
|
|
85582
|
+
*/
|
|
85583
|
+
authorEmail?: boolean;
|
|
85584
|
+
/**
|
|
85585
|
+
* Gets the name of the comment reply's author.
|
|
85586
|
+
*
|
|
85587
|
+
* @remarks
|
|
85588
|
+
* [Api set: WordApiOnline 1.1]
|
|
85589
|
+
*/
|
|
85590
|
+
authorName?: boolean;
|
|
85591
|
+
/**
|
|
85592
|
+
* Gets or sets the comment reply's content. The string is plain text.
|
|
85593
|
+
*
|
|
85594
|
+
* @remarks
|
|
85595
|
+
* [Api set: WordApiOnline 1.1]
|
|
85596
|
+
*/
|
|
85597
|
+
content?: boolean;
|
|
85598
|
+
/**
|
|
85599
|
+
* Gets the creation date of the comment reply.
|
|
85600
|
+
*
|
|
85601
|
+
* @remarks
|
|
85602
|
+
* [Api set: WordApiOnline 1.1]
|
|
85603
|
+
*/
|
|
85604
|
+
creationDate?: boolean;
|
|
85605
|
+
/**
|
|
85606
|
+
* Gets the Id of the comment reply. Read-only.
|
|
85607
|
+
*
|
|
85608
|
+
* @remarks
|
|
85609
|
+
* [Api set: WordApiOnline 1.1]
|
|
85610
|
+
*/
|
|
85611
|
+
id?: boolean;
|
|
85612
|
+
}
|
|
85613
|
+
/**
|
|
85614
|
+
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
85615
|
+
*
|
|
85616
|
+
* @remarks
|
|
85617
|
+
* [Api set: WordApiOnline 1.1]
|
|
85618
|
+
*/
|
|
85619
|
+
interface CommentReplyCollectionLoadOptions {
|
|
85620
|
+
/**
|
|
85621
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
85622
|
+
*/
|
|
85623
|
+
$all?: boolean;
|
|
85624
|
+
/**
|
|
85625
|
+
* For EACH ITEM in the collection: Gets or sets the commentReply's content range.
|
|
85626
|
+
*
|
|
85627
|
+
* @remarks
|
|
85628
|
+
* [Api set: WordApiOnline 1.1]
|
|
85629
|
+
*/
|
|
85630
|
+
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
85631
|
+
/**
|
|
85632
|
+
* For EACH ITEM in the collection: Gets the parent comment of this reply.
|
|
85633
|
+
*
|
|
85634
|
+
* @remarks
|
|
85635
|
+
* [Api set: WordApiOnline 1.1]
|
|
85636
|
+
*/
|
|
85637
|
+
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
85638
|
+
/**
|
|
85639
|
+
* For EACH ITEM in the collection: Gets the email of the comment reply's author.
|
|
85640
|
+
*
|
|
85641
|
+
* @remarks
|
|
85642
|
+
* [Api set: WordApiOnline 1.1]
|
|
85643
|
+
*/
|
|
85644
|
+
authorEmail?: boolean;
|
|
85645
|
+
/**
|
|
85646
|
+
* For EACH ITEM in the collection: Gets the name of the comment reply's author.
|
|
85647
|
+
*
|
|
85648
|
+
* @remarks
|
|
85649
|
+
* [Api set: WordApiOnline 1.1]
|
|
85650
|
+
*/
|
|
85651
|
+
authorName?: boolean;
|
|
85652
|
+
/**
|
|
85653
|
+
* For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
|
|
85654
|
+
*
|
|
85655
|
+
* @remarks
|
|
85656
|
+
* [Api set: WordApiOnline 1.1]
|
|
85657
|
+
*/
|
|
85658
|
+
content?: boolean;
|
|
85659
|
+
/**
|
|
85660
|
+
* For EACH ITEM in the collection: Gets the creation date of the comment reply.
|
|
85661
|
+
*
|
|
85662
|
+
* @remarks
|
|
85663
|
+
* [Api set: WordApiOnline 1.1]
|
|
85664
|
+
*/
|
|
85665
|
+
creationDate?: boolean;
|
|
85666
|
+
/**
|
|
85667
|
+
* For EACH ITEM in the collection: Gets the Id of the comment reply. Read-only.
|
|
85668
|
+
*
|
|
85669
|
+
* @remarks
|
|
85670
|
+
* [Api set: WordApiOnline 1.1]
|
|
85671
|
+
*/
|
|
85672
|
+
id?: boolean;
|
|
85673
|
+
}
|
|
83903
85674
|
/**
|
|
83904
85675
|
* Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
|
|
83905
85676
|
*
|
|
@@ -84325,6 +86096,13 @@ declare namespace Word {
|
|
|
84325
86096
|
* [Api set: WordApi 1.3]
|
|
84326
86097
|
*/
|
|
84327
86098
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
86099
|
+
/**
|
|
86100
|
+
* Gets or sets the ChangeTracking mode.
|
|
86101
|
+
*
|
|
86102
|
+
* @remarks
|
|
86103
|
+
* [Api set: WordApiOnline 1.1]
|
|
86104
|
+
*/
|
|
86105
|
+
changeTrackingMode?: boolean;
|
|
84328
86106
|
/**
|
|
84329
86107
|
* Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
|
|
84330
86108
|
*
|
|
@@ -84892,6 +86670,72 @@ declare namespace Word {
|
|
|
84892
86670
|
*/
|
|
84893
86671
|
siblingIndex?: boolean;
|
|
84894
86672
|
}
|
|
86673
|
+
/**
|
|
86674
|
+
* Represents a footnote or endnote.
|
|
86675
|
+
*
|
|
86676
|
+
* @remarks
|
|
86677
|
+
* [Api set: WordApiOnline 1.1]
|
|
86678
|
+
*/
|
|
86679
|
+
interface NoteItemLoadOptions {
|
|
86680
|
+
/**
|
|
86681
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
86682
|
+
*/
|
|
86683
|
+
$all?: boolean;
|
|
86684
|
+
/**
|
|
86685
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
86686
|
+
*
|
|
86687
|
+
* @remarks
|
|
86688
|
+
* [Api set: WordApiOnline 1.1]
|
|
86689
|
+
*/
|
|
86690
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86691
|
+
/**
|
|
86692
|
+
* Represents a footnote or endnote reference in the main document.
|
|
86693
|
+
*
|
|
86694
|
+
* @remarks
|
|
86695
|
+
* [Api set: WordApiOnline 1.1]
|
|
86696
|
+
*/
|
|
86697
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86698
|
+
/**
|
|
86699
|
+
* Represents the note item type: footnote or endnote.
|
|
86700
|
+
*
|
|
86701
|
+
* @remarks
|
|
86702
|
+
* [Api set: WordApiOnline 1.1]
|
|
86703
|
+
*/
|
|
86704
|
+
type?: boolean;
|
|
86705
|
+
}
|
|
86706
|
+
/**
|
|
86707
|
+
* Contains a collection of {@link Word.NoteItem} objects.
|
|
86708
|
+
*
|
|
86709
|
+
* @remarks
|
|
86710
|
+
* [Api set: WordApiOnline 1.1]
|
|
86711
|
+
*/
|
|
86712
|
+
interface NoteItemCollectionLoadOptions {
|
|
86713
|
+
/**
|
|
86714
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
86715
|
+
*/
|
|
86716
|
+
$all?: boolean;
|
|
86717
|
+
/**
|
|
86718
|
+
* For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
86719
|
+
*
|
|
86720
|
+
* @remarks
|
|
86721
|
+
* [Api set: WordApiOnline 1.1]
|
|
86722
|
+
*/
|
|
86723
|
+
body?: Word.Interfaces.BodyLoadOptions;
|
|
86724
|
+
/**
|
|
86725
|
+
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
86726
|
+
*
|
|
86727
|
+
* @remarks
|
|
86728
|
+
* [Api set: WordApiOnline 1.1]
|
|
86729
|
+
*/
|
|
86730
|
+
reference?: Word.Interfaces.RangeLoadOptions;
|
|
86731
|
+
/**
|
|
86732
|
+
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
86733
|
+
*
|
|
86734
|
+
* @remarks
|
|
86735
|
+
* [Api set: WordApiOnline 1.1]
|
|
86736
|
+
*/
|
|
86737
|
+
type?: boolean;
|
|
86738
|
+
}
|
|
84895
86739
|
/**
|
|
84896
86740
|
* Represents a single paragraph in a selection, range, content control, or document body.
|
|
84897
86741
|
*
|