@types/office-js-preview 1.0.303 → 1.0.306
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +265 -498
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -19056,7 +19056,7 @@ declare namespace OfficeExtension {
|
|
|
19056
19056
|
* This statement will never contain any potentially-sensitive data and may not match the code exactly as written,
|
|
19057
19057
|
* but will be a close approximation.
|
|
19058
19058
|
*/
|
|
19059
|
-
|
|
19059
|
+
statement?: string;
|
|
19060
19060
|
/**
|
|
19061
19061
|
* The statements that closely precede and follow the statement that caused the error, if available.
|
|
19062
19062
|
*
|
|
@@ -19806,6 +19806,31 @@ declare namespace Excel {
|
|
|
19806
19806
|
*/
|
|
19807
19807
|
type CardLayout = EntityCardLayout;
|
|
19808
19808
|
/**
|
|
19809
|
+
* The compact layout properties for an entity.
|
|
19810
|
+
*
|
|
19811
|
+
* @remarks
|
|
19812
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19813
|
+
* @beta
|
|
19814
|
+
*/
|
|
19815
|
+
interface EntityCompactLayout {
|
|
19816
|
+
/**
|
|
19817
|
+
* Specifies the name of the icon which is used to open the card.
|
|
19818
|
+
*
|
|
19819
|
+
* @remarks
|
|
19820
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19821
|
+
* @beta
|
|
19822
|
+
*/
|
|
19823
|
+
icon?: string;
|
|
19824
|
+
}
|
|
19825
|
+
/**
|
|
19826
|
+
* Represents the layout used when there is limited space to represent the entity.
|
|
19827
|
+
*
|
|
19828
|
+
* @remarks
|
|
19829
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19830
|
+
* @beta
|
|
19831
|
+
*/
|
|
19832
|
+
type CompactLayout = EntityCompactLayout;
|
|
19833
|
+
/**
|
|
19809
19834
|
* Represents a reference into `referencedValues`. One scenario for using this reference is to avoid duplicating cell value objects (such as an `EntityCellValue`). Define a cell value object once in `referencedValues`, and then refer to that cell value from many places by using a `ReferenceCellValue` where the duplicated value would have appeared.
|
|
19810
19835
|
*
|
|
19811
19836
|
* @remarks
|
|
@@ -20695,6 +20720,14 @@ declare namespace Excel {
|
|
|
20695
20720
|
* @beta
|
|
20696
20721
|
*/
|
|
20697
20722
|
card?: CardLayout;
|
|
20723
|
+
/**
|
|
20724
|
+
* Represents the layout used when there is limited space to represent the entity.
|
|
20725
|
+
*
|
|
20726
|
+
* @remarks
|
|
20727
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20728
|
+
* @beta
|
|
20729
|
+
*/
|
|
20730
|
+
compact?: CompactLayout;
|
|
20698
20731
|
}
|
|
20699
20732
|
/**
|
|
20700
20733
|
* Represents a card layout best used for an entity.
|
|
@@ -24062,15 +24095,13 @@ declare namespace Excel {
|
|
|
24062
24095
|
* Represents a command type of `DataConnection`.
|
|
24063
24096
|
*
|
|
24064
24097
|
* @remarks
|
|
24065
|
-
* [Api set: ExcelApi
|
|
24066
|
-
* @beta
|
|
24098
|
+
* [Api set: ExcelApi 1.15]
|
|
24067
24099
|
*/
|
|
24068
24100
|
enum DataSourceType {
|
|
24069
24101
|
/**
|
|
24070
24102
|
* The data source type is unknown or unsupported.
|
|
24071
24103
|
* @remarks
|
|
24072
|
-
* [Api set: ExcelApi
|
|
24073
|
-
* @beta
|
|
24104
|
+
* [Api set: ExcelApi 1.15]
|
|
24074
24105
|
*/
|
|
24075
24106
|
unknown = "Unknown",
|
|
24076
24107
|
/**
|
|
@@ -24083,17 +24114,22 @@ declare namespace Excel {
|
|
|
24083
24114
|
/**
|
|
24084
24115
|
* The data source type is a range in the current workbook.
|
|
24085
24116
|
* @remarks
|
|
24086
|
-
* [Api set: ExcelApi
|
|
24087
|
-
* @beta
|
|
24117
|
+
* [Api set: ExcelApi 1.15]
|
|
24088
24118
|
*/
|
|
24089
24119
|
localRange = "LocalRange",
|
|
24090
24120
|
/**
|
|
24091
24121
|
* The data source type is a table in the current workbook.
|
|
24092
24122
|
* @remarks
|
|
24123
|
+
* [Api set: ExcelApi 1.15]
|
|
24124
|
+
*/
|
|
24125
|
+
localTable = "LocalTable",
|
|
24126
|
+
/**
|
|
24127
|
+
* Contains command text that the OLE DB provider (such as Power BI) understands.
|
|
24128
|
+
* @remarks
|
|
24093
24129
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
24094
24130
|
* @beta
|
|
24095
24131
|
*/
|
|
24096
|
-
|
|
24132
|
+
oledbDefault = "OledbDefault"
|
|
24097
24133
|
}
|
|
24098
24134
|
/**
|
|
24099
24135
|
* Enum representing all accepted conditions by which a date filter can be applied.
|
|
@@ -29845,22 +29881,21 @@ declare namespace Excel {
|
|
|
29845
29881
|
*/
|
|
29846
29882
|
getColumnsBefore(count?: number): Excel.Range;
|
|
29847
29883
|
/**
|
|
29848
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the
|
|
29884
|
+
* 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.
|
|
29849
29885
|
*
|
|
29850
29886
|
* @remarks
|
|
29851
|
-
* [Api set: ExcelApi
|
|
29852
|
-
* @beta
|
|
29887
|
+
* [Api set: ExcelApi 1.15]
|
|
29853
29888
|
*/
|
|
29854
29889
|
getDependents(): Excel.WorkbookRangeAreas;
|
|
29855
29890
|
/**
|
|
29856
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct
|
|
29891
|
+
* 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.
|
|
29857
29892
|
*
|
|
29858
29893
|
* @remarks
|
|
29859
29894
|
* [Api set: ExcelApi 1.13]
|
|
29860
29895
|
*/
|
|
29861
29896
|
getDirectDependents(): Excel.WorkbookRangeAreas;
|
|
29862
29897
|
/**
|
|
29863
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct
|
|
29898
|
+
* 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.
|
|
29864
29899
|
*
|
|
29865
29900
|
* @remarks
|
|
29866
29901
|
* [Api set: ExcelApi 1.12]
|
|
@@ -29977,7 +30012,7 @@ declare namespace Excel {
|
|
|
29977
30012
|
*/
|
|
29978
30013
|
getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
|
|
29979
30014
|
/**
|
|
29980
|
-
* Returns a `WorkbookRangeAreas` object that represents the range containing all the
|
|
30015
|
+
* 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.
|
|
29981
30016
|
*
|
|
29982
30017
|
* @remarks
|
|
29983
30018
|
* [Api set: ExcelApi 1.14]
|
|
@@ -32973,7 +33008,7 @@ declare namespace Excel {
|
|
|
32973
33008
|
to point at the index for which it was created.
|
|
32974
33009
|
*
|
|
32975
33010
|
* @remarks
|
|
32976
|
-
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows;
|
|
33011
|
+
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; 1.15 for adding `alwaysInsert` parameter.]
|
|
32977
33012
|
*
|
|
32978
33013
|
* @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.
|
|
32979
33014
|
* @param values Optional. A 2D array of unformatted values of the table row.
|
|
@@ -35170,8 +35205,7 @@ declare namespace Excel {
|
|
|
35170
35205
|
* Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
|
|
35171
35206
|
*
|
|
35172
35207
|
* @remarks
|
|
35173
|
-
* [Api set: ExcelApi
|
|
35174
|
-
* @beta
|
|
35208
|
+
* [Api set: ExcelApi 1.15]
|
|
35175
35209
|
*
|
|
35176
35210
|
* @param dimension The dimension of the axis where the data is from.
|
|
35177
35211
|
*/
|
|
@@ -35180,8 +35214,7 @@ declare namespace Excel {
|
|
|
35180
35214
|
* Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
|
|
35181
35215
|
*
|
|
35182
35216
|
* @remarks
|
|
35183
|
-
* [Api set: ExcelApi
|
|
35184
|
-
* @beta
|
|
35217
|
+
* [Api set: ExcelApi 1.15]
|
|
35185
35218
|
*
|
|
35186
35219
|
* @param dimension The dimension of the axis where the data is from.
|
|
35187
35220
|
*/
|
|
@@ -35190,8 +35223,7 @@ declare namespace Excel {
|
|
|
35190
35223
|
* Gets the data source type of the chart series.
|
|
35191
35224
|
*
|
|
35192
35225
|
* @remarks
|
|
35193
|
-
* [Api set: ExcelApi
|
|
35194
|
-
* @beta
|
|
35226
|
+
* [Api set: ExcelApi 1.15]
|
|
35195
35227
|
*
|
|
35196
35228
|
* @param dimension The dimension of the axis where the data is from.
|
|
35197
35229
|
*/
|
|
@@ -35200,8 +35232,7 @@ declare namespace Excel {
|
|
|
35200
35232
|
* Gets the data source type of the chart series.
|
|
35201
35233
|
*
|
|
35202
35234
|
* @remarks
|
|
35203
|
-
* [Api set: ExcelApi
|
|
35204
|
-
* @beta
|
|
35235
|
+
* [Api set: ExcelApi 1.15]
|
|
35205
35236
|
*
|
|
35206
35237
|
* @param dimension The dimension of the axis where the data is from.
|
|
35207
35238
|
*/
|
|
@@ -37651,22 +37682,6 @@ declare namespace Excel {
|
|
|
37651
37682
|
class ChartFill extends OfficeExtension.ClientObject {
|
|
37652
37683
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
37653
37684
|
context: RequestContext;
|
|
37654
|
-
/**
|
|
37655
|
-
* Sets and gets the uniform color fill formatting of a chart element.
|
|
37656
|
-
*
|
|
37657
|
-
* @remarks
|
|
37658
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
37659
|
-
* @beta
|
|
37660
|
-
*/
|
|
37661
|
-
solidColor: string;
|
|
37662
|
-
/**
|
|
37663
|
-
* 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.
|
|
37664
|
-
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
37665
|
-
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
37666
|
-
*/
|
|
37667
|
-
set(properties: Interfaces.ChartFillUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
37668
|
-
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
37669
|
-
set(properties: Excel.ChartFill): void;
|
|
37670
37685
|
/**
|
|
37671
37686
|
* Clears the fill color of a chart element.
|
|
37672
37687
|
*
|
|
@@ -37683,32 +37698,6 @@ declare namespace Excel {
|
|
|
37683
37698
|
* @param color HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
37684
37699
|
*/
|
|
37685
37700
|
setSolidColor(color: string): void;
|
|
37686
|
-
/**
|
|
37687
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37688
|
-
*
|
|
37689
|
-
* @param options Provides options for which properties of the object to load.
|
|
37690
|
-
*/
|
|
37691
|
-
load(options?: Excel.Interfaces.ChartFillLoadOptions): Excel.ChartFill;
|
|
37692
|
-
/**
|
|
37693
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37694
|
-
*
|
|
37695
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
37696
|
-
*/
|
|
37697
|
-
load(propertyNames?: string | string[]): Excel.ChartFill;
|
|
37698
|
-
/**
|
|
37699
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
37700
|
-
*
|
|
37701
|
-
* @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.
|
|
37702
|
-
*/
|
|
37703
|
-
load(propertyNamesAndPaths?: {
|
|
37704
|
-
select?: string;
|
|
37705
|
-
expand?: string;
|
|
37706
|
-
}): Excel.ChartFill;
|
|
37707
|
-
/**
|
|
37708
|
-
* 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.)
|
|
37709
|
-
* Whereas the original Excel.ChartFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
37710
|
-
*/
|
|
37711
|
-
toJSON(): Excel.Interfaces.ChartFillData;
|
|
37712
37701
|
}
|
|
37713
37702
|
/**
|
|
37714
37703
|
* Represents the border formatting of a chart element.
|
|
@@ -39775,8 +39764,7 @@ declare namespace Excel {
|
|
|
39775
39764
|
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}.
|
|
39776
39765
|
*
|
|
39777
39766
|
* @remarks
|
|
39778
|
-
* [Api set: ExcelApi
|
|
39779
|
-
* @beta
|
|
39767
|
+
* [Api set: ExcelApi 1.15]
|
|
39780
39768
|
*/
|
|
39781
39769
|
getFirstOrNullObject(): Excel.PivotTable;
|
|
39782
39770
|
/**
|
|
@@ -40072,16 +40060,14 @@ declare namespace Excel {
|
|
|
40072
40060
|
Otherwise, it returns an empty string.
|
|
40073
40061
|
*
|
|
40074
40062
|
* @remarks
|
|
40075
|
-
* [Api set: ExcelApi
|
|
40076
|
-
* @beta
|
|
40063
|
+
* [Api set: ExcelApi 1.15]
|
|
40077
40064
|
*/
|
|
40078
40065
|
getDataSourceString(): OfficeExtension.ClientResult<string>;
|
|
40079
40066
|
/**
|
|
40080
40067
|
* Gets the type of the data source for the PivotTable.
|
|
40081
40068
|
*
|
|
40082
40069
|
* @remarks
|
|
40083
|
-
* [Api set: ExcelApi
|
|
40084
|
-
* @beta
|
|
40070
|
+
* [Api set: ExcelApi 1.15]
|
|
40085
40071
|
*/
|
|
40086
40072
|
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
|
|
40087
40073
|
/**
|
|
@@ -46364,8 +46350,7 @@ declare namespace Excel {
|
|
|
46364
46350
|
this API to get the name that is displayed in the UI.
|
|
46365
46351
|
*
|
|
46366
46352
|
* @remarks
|
|
46367
|
-
* [Api set: ExcelApi
|
|
46368
|
-
* @beta
|
|
46353
|
+
* [Api set: ExcelApi 1.15]
|
|
46369
46354
|
*/
|
|
46370
46355
|
readonly displayName: string;
|
|
46371
46356
|
/**
|
|
@@ -49192,31 +49177,34 @@ declare namespace Excel {
|
|
|
49192
49177
|
rows = "Rows"
|
|
49193
49178
|
}
|
|
49194
49179
|
/**
|
|
49195
|
-
* Specifies
|
|
49196
|
-
*
|
|
49180
|
+
* Specifies the data source type of the chart series.
|
|
49181
|
+
*
|
|
49197
49182
|
* @remarks
|
|
49198
|
-
* [Api set: ExcelApi
|
|
49199
|
-
* @beta
|
|
49183
|
+
* [Api set: ExcelApi 1.15]
|
|
49200
49184
|
*/
|
|
49201
49185
|
enum ChartDataSourceType {
|
|
49202
49186
|
/**
|
|
49187
|
+
* The data source type of the chart series is a local range.
|
|
49203
49188
|
* @remarks
|
|
49204
|
-
* [Api set: ExcelApi
|
|
49189
|
+
* [Api set: ExcelApi 1.15]
|
|
49205
49190
|
*/
|
|
49206
49191
|
localRange = "LocalRange",
|
|
49207
49192
|
/**
|
|
49193
|
+
* The data source type of the chart series is an external range.
|
|
49208
49194
|
* @remarks
|
|
49209
|
-
* [Api set: ExcelApi
|
|
49195
|
+
* [Api set: ExcelApi 1.15]
|
|
49210
49196
|
*/
|
|
49211
49197
|
externalRange = "ExternalRange",
|
|
49212
49198
|
/**
|
|
49199
|
+
* The data source type of the chart series is a list.
|
|
49213
49200
|
* @remarks
|
|
49214
|
-
* [Api set: ExcelApi
|
|
49201
|
+
* [Api set: ExcelApi 1.15]
|
|
49215
49202
|
*/
|
|
49216
49203
|
list = "List",
|
|
49217
49204
|
/**
|
|
49205
|
+
* The data source type of the chart series is unknown or unsupported.
|
|
49218
49206
|
* @remarks
|
|
49219
|
-
* [Api set: ExcelApi
|
|
49207
|
+
* [Api set: ExcelApi 1.15]
|
|
49220
49208
|
*/
|
|
49221
49209
|
unknown = "Unknown"
|
|
49222
49210
|
}
|
|
@@ -61977,17 +61965,6 @@ declare namespace Excel {
|
|
|
61977
61965
|
*/
|
|
61978
61966
|
font?: Excel.Interfaces.ChartFontUpdateData;
|
|
61979
61967
|
}
|
|
61980
|
-
/** An interface for updating data on the ChartFill object, for use in `chartFill.set({ ... })`. */
|
|
61981
|
-
interface ChartFillUpdateData {
|
|
61982
|
-
/**
|
|
61983
|
-
* Sets and gets the uniform color fill formatting of a chart element.
|
|
61984
|
-
*
|
|
61985
|
-
* @remarks
|
|
61986
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
61987
|
-
* @beta
|
|
61988
|
-
*/
|
|
61989
|
-
solidColor?: string;
|
|
61990
|
-
}
|
|
61991
61968
|
/** An interface for updating data on the ChartBorder object, for use in `chartBorder.set({ ... })`. */
|
|
61992
61969
|
interface ChartBorderUpdateData {
|
|
61993
61970
|
/**
|
|
@@ -68215,17 +68192,6 @@ declare namespace Excel {
|
|
|
68215
68192
|
*/
|
|
68216
68193
|
font?: Excel.Interfaces.ChartFontData;
|
|
68217
68194
|
}
|
|
68218
|
-
/** An interface describing the data returned by calling `chartFill.toJSON()`. */
|
|
68219
|
-
interface ChartFillData {
|
|
68220
|
-
/**
|
|
68221
|
-
* Sets and gets the uniform color fill formatting of a chart element.
|
|
68222
|
-
*
|
|
68223
|
-
* @remarks
|
|
68224
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
68225
|
-
* @beta
|
|
68226
|
-
*/
|
|
68227
|
-
solidColor?: string;
|
|
68228
|
-
}
|
|
68229
68195
|
/** An interface describing the data returned by calling `chartBorder.toJSON()`. */
|
|
68230
68196
|
interface ChartBorderData {
|
|
68231
68197
|
/**
|
|
@@ -70690,8 +70656,7 @@ declare namespace Excel {
|
|
|
70690
70656
|
this API to get the name that is displayed in the UI.
|
|
70691
70657
|
*
|
|
70692
70658
|
* @remarks
|
|
70693
|
-
* [Api set: ExcelApi
|
|
70694
|
-
* @beta
|
|
70659
|
+
* [Api set: ExcelApi 1.15]
|
|
70695
70660
|
*/
|
|
70696
70661
|
displayName?: string;
|
|
70697
70662
|
/**
|
|
@@ -77352,26 +77317,6 @@ declare namespace Excel {
|
|
|
77352
77317
|
*/
|
|
77353
77318
|
font?: Excel.Interfaces.ChartFontLoadOptions;
|
|
77354
77319
|
}
|
|
77355
|
-
/**
|
|
77356
|
-
* Represents the fill formatting for a chart element.
|
|
77357
|
-
*
|
|
77358
|
-
* @remarks
|
|
77359
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
77360
|
-
*/
|
|
77361
|
-
interface ChartFillLoadOptions {
|
|
77362
|
-
/**
|
|
77363
|
-
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`).
|
|
77364
|
-
*/
|
|
77365
|
-
$all?: boolean;
|
|
77366
|
-
/**
|
|
77367
|
-
* Sets and gets the uniform color fill formatting of a chart element.
|
|
77368
|
-
*
|
|
77369
|
-
* @remarks
|
|
77370
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
77371
|
-
* @beta
|
|
77372
|
-
*/
|
|
77373
|
-
solidColor?: boolean;
|
|
77374
|
-
}
|
|
77375
77320
|
/**
|
|
77376
77321
|
* Represents the border formatting of a chart element.
|
|
77377
77322
|
*
|
|
@@ -81798,8 +81743,7 @@ declare namespace Excel {
|
|
|
81798
81743
|
this API to get the name that is displayed in the UI.
|
|
81799
81744
|
*
|
|
81800
81745
|
* @remarks
|
|
81801
|
-
* [Api set: ExcelApi
|
|
81802
|
-
* @beta
|
|
81746
|
+
* [Api set: ExcelApi 1.15]
|
|
81803
81747
|
*/
|
|
81804
81748
|
displayName?: boolean;
|
|
81805
81749
|
/**
|
|
@@ -82000,8 +81944,7 @@ declare namespace Excel {
|
|
|
82000
81944
|
this API to get the name that is displayed in the UI.
|
|
82001
81945
|
*
|
|
82002
81946
|
* @remarks
|
|
82003
|
-
* [Api set: ExcelApi
|
|
82004
|
-
* @beta
|
|
81947
|
+
* [Api set: ExcelApi 1.15]
|
|
82005
81948
|
*/
|
|
82006
81949
|
displayName?: boolean;
|
|
82007
81950
|
/**
|
|
@@ -82286,8 +82229,7 @@ declare namespace Excel {
|
|
|
82286
82229
|
this API to get the name that is displayed in the UI.
|
|
82287
82230
|
*
|
|
82288
82231
|
* @remarks
|
|
82289
|
-
* [Api set: ExcelApi
|
|
82290
|
-
* @beta
|
|
82232
|
+
* [Api set: ExcelApi 1.15]
|
|
82291
82233
|
*/
|
|
82292
82234
|
displayName?: boolean;
|
|
82293
82235
|
/**
|
|
@@ -83362,8 +83304,7 @@ declare namespace Word {
|
|
|
83362
83304
|
* Gets the collection of endnotes in the body. Read-only.
|
|
83363
83305
|
*
|
|
83364
83306
|
* @remarks
|
|
83365
|
-
* [Api set: WordApiOnline
|
|
83366
|
-
* @beta
|
|
83307
|
+
* [Api set: WordApiOnline 1.1]
|
|
83367
83308
|
*/
|
|
83368
83309
|
readonly endnotes: Word.NoteItemCollection;
|
|
83369
83310
|
/**
|
|
@@ -83385,8 +83326,7 @@ declare namespace Word {
|
|
|
83385
83326
|
* Gets the collection of footnotes in the body. Read-only.
|
|
83386
83327
|
*
|
|
83387
83328
|
* @remarks
|
|
83388
|
-
* [Api set: WordApiOnline
|
|
83389
|
-
* @beta
|
|
83329
|
+
* [Api set: WordApiOnline 1.1]
|
|
83390
83330
|
*/
|
|
83391
83331
|
readonly footnotes: Word.NoteItemCollection;
|
|
83392
83332
|
/**
|
|
@@ -83506,8 +83446,7 @@ declare namespace Word {
|
|
|
83506
83446
|
* Gets comments associated with the body.
|
|
83507
83447
|
*
|
|
83508
83448
|
* @remarks
|
|
83509
|
-
* [Api set: WordApiOnline
|
|
83510
|
-
* @beta
|
|
83449
|
+
* [Api set: WordApiOnline 1.1]
|
|
83511
83450
|
*/
|
|
83512
83451
|
getComments(): Word.CommentCollection;
|
|
83513
83452
|
/**
|
|
@@ -83546,8 +83485,7 @@ declare namespace Word {
|
|
|
83546
83485
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83547
83486
|
*
|
|
83548
83487
|
* @remarks
|
|
83549
|
-
* [Api set: WordApiOnline
|
|
83550
|
-
* @beta
|
|
83488
|
+
* [Api set: WordApiOnline 1.1]
|
|
83551
83489
|
*
|
|
83552
83490
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
83553
83491
|
*/
|
|
@@ -83556,8 +83494,7 @@ declare namespace Word {
|
|
|
83556
83494
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83557
83495
|
*
|
|
83558
83496
|
* @remarks
|
|
83559
|
-
* [Api set: WordApiOnline
|
|
83560
|
-
* @beta
|
|
83497
|
+
* [Api set: WordApiOnline 1.1]
|
|
83561
83498
|
*
|
|
83562
83499
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
83563
83500
|
*/
|
|
@@ -83808,74 +83745,65 @@ declare namespace Word {
|
|
|
83808
83745
|
* Represents a comment in the document.
|
|
83809
83746
|
*
|
|
83810
83747
|
* @remarks
|
|
83811
|
-
* [Api set: WordApiOnline
|
|
83812
|
-
* @beta
|
|
83748
|
+
* [Api set: WordApiOnline 1.1]
|
|
83813
83749
|
*/
|
|
83814
83750
|
class Comment extends OfficeExtension.ClientObject {
|
|
83815
83751
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
83816
83752
|
context: RequestContext;
|
|
83817
83753
|
/**
|
|
83818
|
-
* Gets or sets the comment
|
|
83754
|
+
* Gets or sets the comment's content range.
|
|
83819
83755
|
*
|
|
83820
83756
|
* @remarks
|
|
83821
|
-
* [Api set: WordApiOnline
|
|
83822
|
-
* @beta
|
|
83757
|
+
* [Api set: WordApiOnline 1.1]
|
|
83823
83758
|
*/
|
|
83824
83759
|
contentRange: Word.CommentContentRange;
|
|
83825
83760
|
/**
|
|
83826
83761
|
* Gets the collection of reply objects associated with the comment.
|
|
83827
83762
|
*
|
|
83828
83763
|
* @remarks
|
|
83829
|
-
* [Api set: WordApiOnline
|
|
83830
|
-
* @beta
|
|
83764
|
+
* [Api set: WordApiOnline 1.1]
|
|
83831
83765
|
*/
|
|
83832
83766
|
readonly replies: Word.CommentReplyCollection;
|
|
83833
83767
|
/**
|
|
83834
83768
|
* Gets the email of the comment's author.
|
|
83835
83769
|
*
|
|
83836
83770
|
* @remarks
|
|
83837
|
-
* [Api set: WordApiOnline
|
|
83838
|
-
* @beta
|
|
83771
|
+
* [Api set: WordApiOnline 1.1]
|
|
83839
83772
|
*/
|
|
83840
83773
|
readonly authorEmail: string;
|
|
83841
83774
|
/**
|
|
83842
83775
|
* Gets the name of the comment's author.
|
|
83843
83776
|
*
|
|
83844
83777
|
* @remarks
|
|
83845
|
-
* [Api set: WordApiOnline
|
|
83846
|
-
* @beta
|
|
83778
|
+
* [Api set: WordApiOnline 1.1]
|
|
83847
83779
|
*/
|
|
83848
83780
|
readonly authorName: string;
|
|
83849
83781
|
/**
|
|
83850
83782
|
* Gets or sets the comment's content as plain text.
|
|
83851
83783
|
*
|
|
83852
83784
|
* @remarks
|
|
83853
|
-
* [Api set: WordApiOnline
|
|
83854
|
-
* @beta
|
|
83785
|
+
* [Api set: WordApiOnline 1.1]
|
|
83855
83786
|
*/
|
|
83856
83787
|
content: string;
|
|
83857
83788
|
/**
|
|
83858
83789
|
* Gets the creation date of the comment.
|
|
83859
83790
|
*
|
|
83860
83791
|
* @remarks
|
|
83861
|
-
* [Api set: WordApiOnline
|
|
83862
|
-
* @beta
|
|
83792
|
+
* [Api set: WordApiOnline 1.1]
|
|
83863
83793
|
*/
|
|
83864
83794
|
readonly creationDate: Date;
|
|
83865
83795
|
/**
|
|
83866
83796
|
* Gets the ID of the comment. Read-only.
|
|
83867
83797
|
*
|
|
83868
83798
|
* @remarks
|
|
83869
|
-
* [Api set: WordApiOnline
|
|
83870
|
-
* @beta
|
|
83799
|
+
* [Api set: WordApiOnline 1.1]
|
|
83871
83800
|
*/
|
|
83872
83801
|
readonly id: string;
|
|
83873
83802
|
/**
|
|
83874
83803
|
* 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.
|
|
83875
83804
|
*
|
|
83876
83805
|
* @remarks
|
|
83877
|
-
* [Api set: WordApiOnline
|
|
83878
|
-
* @beta
|
|
83806
|
+
* [Api set: WordApiOnline 1.1]
|
|
83879
83807
|
*/
|
|
83880
83808
|
resolved: boolean;
|
|
83881
83809
|
/**
|
|
@@ -83890,24 +83818,21 @@ declare namespace Word {
|
|
|
83890
83818
|
* Deletes the comment and its replies.
|
|
83891
83819
|
*
|
|
83892
83820
|
* @remarks
|
|
83893
|
-
* [Api set: WordApiOnline
|
|
83894
|
-
* @beta
|
|
83821
|
+
* [Api set: WordApiOnline 1.1]
|
|
83895
83822
|
*/
|
|
83896
83823
|
delete(): void;
|
|
83897
83824
|
/**
|
|
83898
83825
|
* Gets the range in the main document where the comment is on.
|
|
83899
83826
|
*
|
|
83900
83827
|
* @remarks
|
|
83901
|
-
* [Api set: WordApiOnline
|
|
83902
|
-
* @beta
|
|
83828
|
+
* [Api set: WordApiOnline 1.1]
|
|
83903
83829
|
*/
|
|
83904
83830
|
getRange(): Word.Range;
|
|
83905
83831
|
/**
|
|
83906
83832
|
* Adds a new reply to the end of the comment thread.
|
|
83907
83833
|
*
|
|
83908
83834
|
* @remarks
|
|
83909
|
-
* [Api set: WordApiOnline
|
|
83910
|
-
* @beta
|
|
83835
|
+
* [Api set: WordApiOnline 1.1]
|
|
83911
83836
|
*
|
|
83912
83837
|
* @param replyText Required. Reply text.
|
|
83913
83838
|
*/
|
|
@@ -83951,8 +83876,7 @@ declare namespace Word {
|
|
|
83951
83876
|
* Contains a collection of {@link Word.Comment} objects.
|
|
83952
83877
|
*
|
|
83953
83878
|
* @remarks
|
|
83954
|
-
* [Api set: WordApiOnline
|
|
83955
|
-
* @beta
|
|
83879
|
+
* [Api set: WordApiOnline 1.1]
|
|
83956
83880
|
*/
|
|
83957
83881
|
class CommentCollection extends OfficeExtension.ClientObject {
|
|
83958
83882
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -83963,24 +83887,21 @@ declare namespace Word {
|
|
|
83963
83887
|
* Gets the first comment in the collection. Throws an error if this collection is empty.
|
|
83964
83888
|
*
|
|
83965
83889
|
* @remarks
|
|
83966
|
-
* [Api set: WordApiOnline
|
|
83967
|
-
* @beta
|
|
83890
|
+
* [Api set: WordApiOnline 1.1]
|
|
83968
83891
|
*/
|
|
83969
83892
|
getFirst(): Word.Comment;
|
|
83970
83893
|
/**
|
|
83971
83894
|
* Gets the first comment in the collection. If the collection is empty, returns a null object.
|
|
83972
83895
|
*
|
|
83973
83896
|
* @remarks
|
|
83974
|
-
* [Api set: WordApiOnline
|
|
83975
|
-
* @beta
|
|
83897
|
+
* [Api set: WordApiOnline 1.1]
|
|
83976
83898
|
*/
|
|
83977
83899
|
getFirstOrNullObject(): Word.Comment;
|
|
83978
83900
|
/**
|
|
83979
83901
|
* Gets a comment object by its index in the collection.
|
|
83980
83902
|
*
|
|
83981
83903
|
* @remarks
|
|
83982
|
-
* [Api set: WordApiOnline
|
|
83983
|
-
* @beta
|
|
83904
|
+
* [Api set: WordApiOnline 1.1]
|
|
83984
83905
|
*
|
|
83985
83906
|
* @param index A number that identifies the index location of a comment object.
|
|
83986
83907
|
*/
|
|
@@ -84019,8 +83940,7 @@ declare namespace Word {
|
|
|
84019
83940
|
}
|
|
84020
83941
|
/**
|
|
84021
83942
|
* @remarks
|
|
84022
|
-
* [Api set: WordApiOnline
|
|
84023
|
-
* @beta
|
|
83943
|
+
* [Api set: WordApiOnline 1.1]
|
|
84024
83944
|
*/
|
|
84025
83945
|
class CommentContentRange extends OfficeExtension.ClientObject {
|
|
84026
83946
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -84029,56 +83949,49 @@ declare namespace Word {
|
|
|
84029
83949
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
84030
83950
|
*
|
|
84031
83951
|
* @remarks
|
|
84032
|
-
* [Api set: WordApiOnline
|
|
84033
|
-
* @beta
|
|
83952
|
+
* [Api set: WordApiOnline 1.1]
|
|
84034
83953
|
*/
|
|
84035
83954
|
bold: boolean;
|
|
84036
83955
|
/**
|
|
84037
83956
|
* 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.
|
|
84038
83957
|
*
|
|
84039
83958
|
* @remarks
|
|
84040
|
-
* [Api set: WordApiOnline
|
|
84041
|
-
* @beta
|
|
83959
|
+
* [Api set: WordApiOnline 1.1]
|
|
84042
83960
|
*/
|
|
84043
83961
|
hyperlink: string;
|
|
84044
83962
|
/**
|
|
84045
83963
|
* Checks whether the range length is zero. Read-only.
|
|
84046
83964
|
*
|
|
84047
83965
|
* @remarks
|
|
84048
|
-
* [Api set: WordApiOnline
|
|
84049
|
-
* @beta
|
|
83966
|
+
* [Api set: WordApiOnline 1.1]
|
|
84050
83967
|
*/
|
|
84051
83968
|
readonly isEmpty: boolean;
|
|
84052
83969
|
/**
|
|
84053
83970
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
84054
83971
|
*
|
|
84055
83972
|
* @remarks
|
|
84056
|
-
* [Api set: WordApiOnline
|
|
84057
|
-
* @beta
|
|
83973
|
+
* [Api set: WordApiOnline 1.1]
|
|
84058
83974
|
*/
|
|
84059
83975
|
italic: boolean;
|
|
84060
83976
|
/**
|
|
84061
83977
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
84062
83978
|
*
|
|
84063
83979
|
* @remarks
|
|
84064
|
-
* [Api set: WordApiOnline
|
|
84065
|
-
* @beta
|
|
83980
|
+
* [Api set: WordApiOnline 1.1]
|
|
84066
83981
|
*/
|
|
84067
83982
|
strikeThrough: boolean;
|
|
84068
83983
|
/**
|
|
84069
83984
|
* Gets the text of the comment range. Read-only.
|
|
84070
83985
|
*
|
|
84071
83986
|
* @remarks
|
|
84072
|
-
* [Api set: WordApiOnline
|
|
84073
|
-
* @beta
|
|
83987
|
+
* [Api set: WordApiOnline 1.1]
|
|
84074
83988
|
*/
|
|
84075
83989
|
readonly text: string;
|
|
84076
83990
|
/**
|
|
84077
83991
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
84078
83992
|
*
|
|
84079
83993
|
* @remarks
|
|
84080
|
-
* [Api set: WordApiOnline
|
|
84081
|
-
* @beta
|
|
83994
|
+
* [Api set: WordApiOnline 1.1]
|
|
84082
83995
|
*/
|
|
84083
83996
|
underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
84084
83997
|
/**
|
|
@@ -84093,8 +84006,7 @@ declare namespace Word {
|
|
|
84093
84006
|
* Inserts text into at the specified location.
|
|
84094
84007
|
*
|
|
84095
84008
|
* @remarks
|
|
84096
|
-
* [Api set: WordApiOnline
|
|
84097
|
-
* @beta
|
|
84009
|
+
* [Api set: WordApiOnline 1.1]
|
|
84098
84010
|
*
|
|
84099
84011
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84100
84012
|
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
@@ -84104,8 +84016,7 @@ declare namespace Word {
|
|
|
84104
84016
|
* Inserts text into at the specified location.
|
|
84105
84017
|
*
|
|
84106
84018
|
* @remarks
|
|
84107
|
-
* [Api set: WordApiOnline
|
|
84108
|
-
* @beta
|
|
84019
|
+
* [Api set: WordApiOnline 1.1]
|
|
84109
84020
|
*
|
|
84110
84021
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
84111
84022
|
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
@@ -84150,8 +84061,7 @@ declare namespace Word {
|
|
|
84150
84061
|
* Represents a comment reply in the document.
|
|
84151
84062
|
*
|
|
84152
84063
|
* @remarks
|
|
84153
|
-
* [Api set: WordApiOnline
|
|
84154
|
-
* @beta
|
|
84064
|
+
* [Api set: WordApiOnline 1.1]
|
|
84155
84065
|
*/
|
|
84156
84066
|
class CommentReply extends OfficeExtension.ClientObject {
|
|
84157
84067
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -84160,56 +84070,49 @@ declare namespace Word {
|
|
|
84160
84070
|
* Gets or sets the commentReply's content range.
|
|
84161
84071
|
*
|
|
84162
84072
|
* @remarks
|
|
84163
|
-
* [Api set: WordApiOnline
|
|
84164
|
-
* @beta
|
|
84073
|
+
* [Api set: WordApiOnline 1.1]
|
|
84165
84074
|
*/
|
|
84166
84075
|
contentRange: Word.CommentContentRange;
|
|
84167
84076
|
/**
|
|
84168
84077
|
* Gets the parent comment of this reply.
|
|
84169
84078
|
*
|
|
84170
84079
|
* @remarks
|
|
84171
|
-
* [Api set: WordApiOnline
|
|
84172
|
-
* @beta
|
|
84080
|
+
* [Api set: WordApiOnline 1.1]
|
|
84173
84081
|
*/
|
|
84174
84082
|
readonly parentComment: Word.Comment;
|
|
84175
84083
|
/**
|
|
84176
84084
|
* Gets the email of the comment reply's author.
|
|
84177
84085
|
*
|
|
84178
84086
|
* @remarks
|
|
84179
|
-
* [Api set: WordApiOnline
|
|
84180
|
-
* @beta
|
|
84087
|
+
* [Api set: WordApiOnline 1.1]
|
|
84181
84088
|
*/
|
|
84182
84089
|
readonly authorEmail: string;
|
|
84183
84090
|
/**
|
|
84184
84091
|
* Gets the name of the comment reply's author.
|
|
84185
84092
|
*
|
|
84186
84093
|
* @remarks
|
|
84187
|
-
* [Api set: WordApiOnline
|
|
84188
|
-
* @beta
|
|
84094
|
+
* [Api set: WordApiOnline 1.1]
|
|
84189
84095
|
*/
|
|
84190
84096
|
readonly authorName: string;
|
|
84191
84097
|
/**
|
|
84192
84098
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
84193
84099
|
*
|
|
84194
84100
|
* @remarks
|
|
84195
|
-
* [Api set: WordApiOnline
|
|
84196
|
-
* @beta
|
|
84101
|
+
* [Api set: WordApiOnline 1.1]
|
|
84197
84102
|
*/
|
|
84198
84103
|
content: string;
|
|
84199
84104
|
/**
|
|
84200
84105
|
* Gets the creation date of the comment reply.
|
|
84201
84106
|
*
|
|
84202
84107
|
* @remarks
|
|
84203
|
-
* [Api set: WordApiOnline
|
|
84204
|
-
* @beta
|
|
84108
|
+
* [Api set: WordApiOnline 1.1]
|
|
84205
84109
|
*/
|
|
84206
84110
|
readonly creationDate: Date;
|
|
84207
84111
|
/**
|
|
84208
84112
|
* Gets the ID of the comment reply. Read-only.
|
|
84209
84113
|
*
|
|
84210
84114
|
* @remarks
|
|
84211
|
-
* [Api set: WordApiOnline
|
|
84212
|
-
* @beta
|
|
84115
|
+
* [Api set: WordApiOnline 1.1]
|
|
84213
84116
|
*/
|
|
84214
84117
|
readonly id: string;
|
|
84215
84118
|
/**
|
|
@@ -84224,8 +84127,7 @@ declare namespace Word {
|
|
|
84224
84127
|
* Deletes the comment reply.
|
|
84225
84128
|
*
|
|
84226
84129
|
* @remarks
|
|
84227
|
-
* [Api set: WordApiOnline
|
|
84228
|
-
* @beta
|
|
84130
|
+
* [Api set: WordApiOnline 1.1]
|
|
84229
84131
|
*/
|
|
84230
84132
|
delete(): void;
|
|
84231
84133
|
/**
|
|
@@ -84267,8 +84169,7 @@ declare namespace Word {
|
|
|
84267
84169
|
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
84268
84170
|
*
|
|
84269
84171
|
* @remarks
|
|
84270
|
-
* [Api set: WordApiOnline
|
|
84271
|
-
* @beta
|
|
84172
|
+
* [Api set: WordApiOnline 1.1]
|
|
84272
84173
|
*/
|
|
84273
84174
|
class CommentReplyCollection extends OfficeExtension.ClientObject {
|
|
84274
84175
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -84279,24 +84180,21 @@ declare namespace Word {
|
|
|
84279
84180
|
* Gets the first comment reply in the collection. Throws an error if this collection is empty.
|
|
84280
84181
|
*
|
|
84281
84182
|
* @remarks
|
|
84282
|
-
* [Api set: WordApiOnline
|
|
84283
|
-
* @beta
|
|
84183
|
+
* [Api set: WordApiOnline 1.1]
|
|
84284
84184
|
*/
|
|
84285
84185
|
getFirst(): Word.CommentReply;
|
|
84286
84186
|
/**
|
|
84287
84187
|
* Gets the first comment reply in the collection. If the collection is empty, returns a null object.
|
|
84288
84188
|
*
|
|
84289
84189
|
* @remarks
|
|
84290
|
-
* [Api set: WordApiOnline
|
|
84291
|
-
* @beta
|
|
84190
|
+
* [Api set: WordApiOnline 1.1]
|
|
84292
84191
|
*/
|
|
84293
84192
|
getFirstOrNullObject(): Word.CommentReply;
|
|
84294
84193
|
/**
|
|
84295
84194
|
* Gets a comment reply object by its index in the collection.
|
|
84296
84195
|
*
|
|
84297
84196
|
* @remarks
|
|
84298
|
-
* [Api set: WordApiOnline
|
|
84299
|
-
* @beta
|
|
84197
|
+
* [Api set: WordApiOnline 1.1]
|
|
84300
84198
|
*
|
|
84301
84199
|
* @param index A number that identifies the index location of a comment reply object.
|
|
84302
84200
|
*/
|
|
@@ -84353,8 +84251,7 @@ declare namespace Word {
|
|
|
84353
84251
|
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
84354
84252
|
*
|
|
84355
84253
|
* @remarks
|
|
84356
|
-
* [Api set: WordApiOnline
|
|
84357
|
-
* @beta
|
|
84254
|
+
* [Api set: WordApiOnline 1.1]
|
|
84358
84255
|
*/
|
|
84359
84256
|
readonly endnotes: Word.NoteItemCollection;
|
|
84360
84257
|
/**
|
|
@@ -84376,8 +84273,7 @@ declare namespace Word {
|
|
|
84376
84273
|
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
84377
84274
|
*
|
|
84378
84275
|
* @remarks
|
|
84379
|
-
* [Api set: WordApiOnline
|
|
84380
|
-
* @beta
|
|
84276
|
+
* [Api set: WordApiOnline 1.1]
|
|
84381
84277
|
*/
|
|
84382
84278
|
readonly footnotes: Word.NoteItemCollection;
|
|
84383
84279
|
/**
|
|
@@ -84584,8 +84480,7 @@ declare namespace Word {
|
|
|
84584
84480
|
* Gets comments associated with the body.
|
|
84585
84481
|
*
|
|
84586
84482
|
* @remarks
|
|
84587
|
-
* [Api set: WordApiOnline
|
|
84588
|
-
* @beta
|
|
84483
|
+
* [Api set: WordApiOnline 1.1]
|
|
84589
84484
|
*/
|
|
84590
84485
|
getComments(): Word.CommentCollection;
|
|
84591
84486
|
/**
|
|
@@ -84624,8 +84519,7 @@ declare namespace Word {
|
|
|
84624
84519
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
84625
84520
|
*
|
|
84626
84521
|
* @remarks
|
|
84627
|
-
* [Api set: WordApiOnline
|
|
84628
|
-
* @beta
|
|
84522
|
+
* [Api set: WordApiOnline 1.1]
|
|
84629
84523
|
*
|
|
84630
84524
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
84631
84525
|
*/
|
|
@@ -84634,8 +84528,7 @@ declare namespace Word {
|
|
|
84634
84528
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
84635
84529
|
*
|
|
84636
84530
|
* @remarks
|
|
84637
|
-
* [Api set: WordApiOnline
|
|
84638
|
-
* @beta
|
|
84531
|
+
* [Api set: WordApiOnline 1.1]
|
|
84639
84532
|
*
|
|
84640
84533
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
84641
84534
|
*/
|
|
@@ -85732,8 +85625,7 @@ declare namespace Word {
|
|
|
85732
85625
|
* Gets or sets the ChangeTracking mode.
|
|
85733
85626
|
*
|
|
85734
85627
|
* @remarks
|
|
85735
|
-
* [Api set: WordApiOnline
|
|
85736
|
-
* @beta
|
|
85628
|
+
* [Api set: WordApiOnline 1.1]
|
|
85737
85629
|
*/
|
|
85738
85630
|
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
85739
85631
|
/**
|
|
@@ -85786,8 +85678,7 @@ declare namespace Word {
|
|
|
85786
85678
|
Not implemented in Word on the web.
|
|
85787
85679
|
*
|
|
85788
85680
|
* @remarks
|
|
85789
|
-
* [Api set: WordApiOnline
|
|
85790
|
-
* @beta
|
|
85681
|
+
* [Api set: WordApiOnline 1.1]
|
|
85791
85682
|
*/
|
|
85792
85683
|
getEndnoteBody(): Word.Body;
|
|
85793
85684
|
/**
|
|
@@ -85795,8 +85686,7 @@ declare namespace Word {
|
|
|
85795
85686
|
Not implemented in Word on the web.
|
|
85796
85687
|
*
|
|
85797
85688
|
* @remarks
|
|
85798
|
-
* [Api set: WordApiOnline
|
|
85799
|
-
* @beta
|
|
85689
|
+
* [Api set: WordApiOnline 1.1]
|
|
85800
85690
|
*/
|
|
85801
85691
|
getFootnoteBody(): Word.Body;
|
|
85802
85692
|
/**
|
|
@@ -85817,8 +85707,7 @@ declare namespace Word {
|
|
|
85817
85707
|
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
85818
85708
|
*
|
|
85819
85709
|
* @remarks
|
|
85820
|
-
* [Api set:
|
|
85821
|
-
* @beta
|
|
85710
|
+
* [Api set: WordApiOnline 1.1]
|
|
85822
85711
|
*/
|
|
85823
85712
|
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
85824
85713
|
ignorePunct?: boolean;
|
|
@@ -87384,34 +87273,30 @@ declare namespace Word {
|
|
|
87384
87273
|
* Represents a footnote or endnote.
|
|
87385
87274
|
*
|
|
87386
87275
|
* @remarks
|
|
87387
|
-
* [Api set: WordApiOnline
|
|
87388
|
-
* @beta
|
|
87276
|
+
* [Api set: WordApiOnline 1.1]
|
|
87389
87277
|
*/
|
|
87390
87278
|
class NoteItem extends OfficeExtension.ClientObject {
|
|
87391
87279
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
87392
87280
|
context: RequestContext;
|
|
87393
87281
|
/**
|
|
87394
|
-
* Represents the body object of the note item. It
|
|
87282
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
87395
87283
|
*
|
|
87396
87284
|
* @remarks
|
|
87397
|
-
* [Api set: WordApiOnline
|
|
87398
|
-
* @beta
|
|
87285
|
+
* [Api set: WordApiOnline 1.1]
|
|
87399
87286
|
*/
|
|
87400
87287
|
readonly body: Word.Body;
|
|
87401
87288
|
/**
|
|
87402
87289
|
* Represents a footnote or endnote reference in the main document.
|
|
87403
87290
|
*
|
|
87404
87291
|
* @remarks
|
|
87405
|
-
* [Api set: WordApiOnline
|
|
87406
|
-
* @beta
|
|
87292
|
+
* [Api set: WordApiOnline 1.1]
|
|
87407
87293
|
*/
|
|
87408
87294
|
readonly reference: Word.Range;
|
|
87409
87295
|
/**
|
|
87410
87296
|
* Represents the note item type: footnote or endnote.
|
|
87411
87297
|
*
|
|
87412
87298
|
* @remarks
|
|
87413
|
-
* [Api set: WordApiOnline
|
|
87414
|
-
* @beta
|
|
87299
|
+
* [Api set: WordApiOnline 1.1]
|
|
87415
87300
|
*/
|
|
87416
87301
|
readonly type: Word.NoteItemType | "Footnote" | "Endnote";
|
|
87417
87302
|
/**
|
|
@@ -87426,24 +87311,21 @@ declare namespace Word {
|
|
|
87426
87311
|
* Deletes the note item.
|
|
87427
87312
|
*
|
|
87428
87313
|
* @remarks
|
|
87429
|
-
* [Api set: WordApiOnline
|
|
87430
|
-
* @beta
|
|
87314
|
+
* [Api set: WordApiOnline 1.1]
|
|
87431
87315
|
*/
|
|
87432
87316
|
delete(): void;
|
|
87433
87317
|
/**
|
|
87434
87318
|
* Gets the next note item of the same type. Throws an error if this note item is the last one.
|
|
87435
87319
|
*
|
|
87436
87320
|
* @remarks
|
|
87437
|
-
* [Api set: WordApiOnline
|
|
87438
|
-
* @beta
|
|
87321
|
+
* [Api set: WordApiOnline 1.1]
|
|
87439
87322
|
*/
|
|
87440
87323
|
getNext(): Word.NoteItem;
|
|
87441
87324
|
/**
|
|
87442
87325
|
* Gets the next note item of the same type. Returns a null object if this note item is the last one.
|
|
87443
87326
|
*
|
|
87444
87327
|
* @remarks
|
|
87445
|
-
* [Api set: WordApiOnline
|
|
87446
|
-
* @beta
|
|
87328
|
+
* [Api set: WordApiOnline 1.1]
|
|
87447
87329
|
*/
|
|
87448
87330
|
getNextOrNullObject(): Word.NoteItem;
|
|
87449
87331
|
/**
|
|
@@ -87485,8 +87367,7 @@ declare namespace Word {
|
|
|
87485
87367
|
* Contains a collection of {@link Word.NoteItem} objects.
|
|
87486
87368
|
*
|
|
87487
87369
|
* @remarks
|
|
87488
|
-
* [Api set: WordApiOnline
|
|
87489
|
-
* @beta
|
|
87370
|
+
* [Api set: WordApiOnline 1.1]
|
|
87490
87371
|
*/
|
|
87491
87372
|
class NoteItemCollection extends OfficeExtension.ClientObject {
|
|
87492
87373
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -87497,16 +87378,14 @@ declare namespace Word {
|
|
|
87497
87378
|
* Gets the first note item in this collection. Throws an error if this collection is empty.
|
|
87498
87379
|
*
|
|
87499
87380
|
* @remarks
|
|
87500
|
-
* [Api set: WordApiOnline
|
|
87501
|
-
* @beta
|
|
87381
|
+
* [Api set: WordApiOnline 1.1]
|
|
87502
87382
|
*/
|
|
87503
87383
|
getFirst(): Word.NoteItem;
|
|
87504
87384
|
/**
|
|
87505
87385
|
* Gets the first note item in this collection. Returns a null object if this collection is empty.
|
|
87506
87386
|
*
|
|
87507
87387
|
* @remarks
|
|
87508
|
-
* [Api set: WordApiOnline
|
|
87509
|
-
* @beta
|
|
87388
|
+
* [Api set: WordApiOnline 1.1]
|
|
87510
87389
|
*/
|
|
87511
87390
|
getFirstOrNullObject(): Word.NoteItem;
|
|
87512
87391
|
/**
|
|
@@ -87561,8 +87440,7 @@ declare namespace Word {
|
|
|
87561
87440
|
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
87562
87441
|
*
|
|
87563
87442
|
* @remarks
|
|
87564
|
-
* [Api set: WordApiOnline
|
|
87565
|
-
* @beta
|
|
87443
|
+
* [Api set: WordApiOnline 1.1]
|
|
87566
87444
|
*/
|
|
87567
87445
|
readonly endnotes: Word.NoteItemCollection;
|
|
87568
87446
|
/**
|
|
@@ -87584,8 +87462,7 @@ declare namespace Word {
|
|
|
87584
87462
|
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
87585
87463
|
*
|
|
87586
87464
|
* @remarks
|
|
87587
|
-
* [Api set: WordApiOnline
|
|
87588
|
-
* @beta
|
|
87465
|
+
* [Api set: WordApiOnline 1.1]
|
|
87589
87466
|
*/
|
|
87590
87467
|
readonly footnotes: Word.NoteItemCollection;
|
|
87591
87468
|
/**
|
|
@@ -87827,8 +87704,7 @@ declare namespace Word {
|
|
|
87827
87704
|
* Gets comments associated with the paragraph.
|
|
87828
87705
|
*
|
|
87829
87706
|
* @remarks
|
|
87830
|
-
* [Api set: WordApiOnline
|
|
87831
|
-
* @beta
|
|
87707
|
+
* [Api set: WordApiOnline 1.1]
|
|
87832
87708
|
*/
|
|
87833
87709
|
getComments(): Word.CommentCollection;
|
|
87834
87710
|
/**
|
|
@@ -87895,8 +87771,7 @@ declare namespace Word {
|
|
|
87895
87771
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87896
87772
|
*
|
|
87897
87773
|
* @remarks
|
|
87898
|
-
* [Api set: WordApiOnline
|
|
87899
|
-
* @beta
|
|
87774
|
+
* [Api set: WordApiOnline 1.1]
|
|
87900
87775
|
*
|
|
87901
87776
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
87902
87777
|
*/
|
|
@@ -87905,8 +87780,7 @@ declare namespace Word {
|
|
|
87905
87780
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87906
87781
|
*
|
|
87907
87782
|
* @remarks
|
|
87908
|
-
* [Api set: WordApiOnline
|
|
87909
|
-
* @beta
|
|
87783
|
+
* [Api set: WordApiOnline 1.1]
|
|
87910
87784
|
*
|
|
87911
87785
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
87912
87786
|
*/
|
|
@@ -88272,8 +88146,7 @@ declare namespace Word {
|
|
|
88272
88146
|
* Gets the collection of endnotes in the range. Read-only.
|
|
88273
88147
|
*
|
|
88274
88148
|
* @remarks
|
|
88275
|
-
* [Api set: WordApiOnline
|
|
88276
|
-
* @beta
|
|
88149
|
+
* [Api set: WordApiOnline 1.1]
|
|
88277
88150
|
*/
|
|
88278
88151
|
readonly endnotes: Word.NoteItemCollection;
|
|
88279
88152
|
/**
|
|
@@ -88295,8 +88168,7 @@ declare namespace Word {
|
|
|
88295
88168
|
* Gets the collection of footnotes in the range. Read-only.
|
|
88296
88169
|
*
|
|
88297
88170
|
* @remarks
|
|
88298
|
-
* [Api set: WordApiOnline
|
|
88299
|
-
* @beta
|
|
88171
|
+
* [Api set: WordApiOnline 1.1]
|
|
88300
88172
|
*/
|
|
88301
88173
|
readonly footnotes: Word.NoteItemCollection;
|
|
88302
88174
|
/**
|
|
@@ -88475,8 +88347,7 @@ declare namespace Word {
|
|
|
88475
88347
|
* Gets comments associated with the range.
|
|
88476
88348
|
*
|
|
88477
88349
|
* @remarks
|
|
88478
|
-
* [Api set: WordApiOnline
|
|
88479
|
-
* @beta
|
|
88350
|
+
* [Api set: WordApiOnline 1.1]
|
|
88480
88351
|
* @returns
|
|
88481
88352
|
*/
|
|
88482
88353
|
getComments(): Word.CommentCollection;
|
|
@@ -88543,8 +88414,7 @@ declare namespace Word {
|
|
|
88543
88414
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88544
88415
|
*
|
|
88545
88416
|
* @remarks
|
|
88546
|
-
* [Api set: WordApiOnline
|
|
88547
|
-
* @beta
|
|
88417
|
+
* [Api set: WordApiOnline 1.1]
|
|
88548
88418
|
*
|
|
88549
88419
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
88550
88420
|
*/
|
|
@@ -88553,8 +88423,7 @@ declare namespace Word {
|
|
|
88553
88423
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
88554
88424
|
*
|
|
88555
88425
|
* @remarks
|
|
88556
|
-
* [Api set: WordApiOnline
|
|
88557
|
-
* @beta
|
|
88426
|
+
* [Api set: WordApiOnline 1.1]
|
|
88558
88427
|
*
|
|
88559
88428
|
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
88560
88429
|
*/
|
|
@@ -88603,8 +88472,7 @@ declare namespace Word {
|
|
|
88603
88472
|
* Insert a comment on the range.
|
|
88604
88473
|
*
|
|
88605
88474
|
* @remarks
|
|
88606
|
-
* [Api set: WordApiOnline
|
|
88607
|
-
* @beta
|
|
88475
|
+
* [Api set: WordApiOnline 1.1]
|
|
88608
88476
|
*
|
|
88609
88477
|
* @param commentText Required. The comment text to be inserted.
|
|
88610
88478
|
* @returns comment object
|
|
@@ -88621,8 +88489,7 @@ declare namespace Word {
|
|
|
88621
88489
|
* Inserts an endnote. The endnote reference is placed after the range.
|
|
88622
88490
|
*
|
|
88623
88491
|
* @remarks
|
|
88624
|
-
* [Api set: WordApiOnline
|
|
88625
|
-
* @beta
|
|
88492
|
+
* [Api set: WordApiOnline 1.1]
|
|
88626
88493
|
*
|
|
88627
88494
|
* @param insertText Optional. Text to be inserted into the endnote body. The default is "".
|
|
88628
88495
|
*/
|
|
@@ -88651,8 +88518,7 @@ declare namespace Word {
|
|
|
88651
88518
|
* Inserts a footnote. The footnote reference is placed after the range.
|
|
88652
88519
|
*
|
|
88653
88520
|
* @remarks
|
|
88654
|
-
* [Api set: WordApiOnline
|
|
88655
|
-
* @beta
|
|
88521
|
+
* [Api set: WordApiOnline 1.1]
|
|
88656
88522
|
*
|
|
88657
88523
|
* @param insertText Optional. Text to be inserted into the footnote body. The default is "".
|
|
88658
88524
|
*/
|
|
@@ -89385,8 +89251,7 @@ declare namespace Word {
|
|
|
89385
89251
|
* Gets the collection of endnotes in the table. Read-only.
|
|
89386
89252
|
*
|
|
89387
89253
|
* @remarks
|
|
89388
|
-
* [Api set: WordApiOnline
|
|
89389
|
-
* @beta
|
|
89254
|
+
* [Api set: WordApiOnline 1.1]
|
|
89390
89255
|
*/
|
|
89391
89256
|
readonly endnotes: Word.NoteItemCollection;
|
|
89392
89257
|
/**
|
|
@@ -89408,8 +89273,7 @@ declare namespace Word {
|
|
|
89408
89273
|
* Gets the collection of footnotes in the table. Read-only.
|
|
89409
89274
|
*
|
|
89410
89275
|
* @remarks
|
|
89411
|
-
* [Api set: WordApiOnline
|
|
89412
|
-
* @beta
|
|
89276
|
+
* [Api set: WordApiOnline 1.1]
|
|
89413
89277
|
*/
|
|
89414
89278
|
readonly footnotes: Word.NoteItemCollection;
|
|
89415
89279
|
/**
|
|
@@ -90042,8 +89906,7 @@ declare namespace Word {
|
|
|
90042
89906
|
* Gets the collection of endnotes in the table row. Read-only.
|
|
90043
89907
|
*
|
|
90044
89908
|
* @remarks
|
|
90045
|
-
* [Api set: WordApiOnline
|
|
90046
|
-
* @beta
|
|
89909
|
+
* [Api set: WordApiOnline 1.1]
|
|
90047
89910
|
*/
|
|
90048
89911
|
readonly endnotes: Word.NoteItemCollection;
|
|
90049
89912
|
/**
|
|
@@ -90065,8 +89928,7 @@ declare namespace Word {
|
|
|
90065
89928
|
* Gets the collection of footnotes in the table row. Read-only.
|
|
90066
89929
|
*
|
|
90067
89930
|
* @remarks
|
|
90068
|
-
* [Api set: WordApiOnline
|
|
90069
|
-
* @beta
|
|
89931
|
+
* [Api set: WordApiOnline 1.1]
|
|
90070
89932
|
*/
|
|
90071
89933
|
readonly footnotes: Word.NoteItemCollection;
|
|
90072
89934
|
/**
|
|
@@ -90792,29 +90654,25 @@ declare namespace Word {
|
|
|
90792
90654
|
* ChangeTracking mode.
|
|
90793
90655
|
*
|
|
90794
90656
|
* @remarks
|
|
90795
|
-
* [Api set: WordApiOnline
|
|
90796
|
-
* @beta
|
|
90657
|
+
* [Api set: WordApiOnline 1.1]
|
|
90797
90658
|
*/
|
|
90798
90659
|
enum ChangeTrackingMode {
|
|
90799
90660
|
/**
|
|
90800
90661
|
* ChangeTracking is turned off.
|
|
90801
90662
|
* @remarks
|
|
90802
|
-
* [Api set: WordApiOnline
|
|
90803
|
-
* @beta
|
|
90663
|
+
* [Api set: WordApiOnline 1.1]
|
|
90804
90664
|
*/
|
|
90805
90665
|
off = "Off",
|
|
90806
90666
|
/**
|
|
90807
90667
|
* ChangeTracking is turned on for everyone.
|
|
90808
90668
|
* @remarks
|
|
90809
|
-
* [Api set: WordApiOnline
|
|
90810
|
-
* @beta
|
|
90669
|
+
* [Api set: WordApiOnline 1.1]
|
|
90811
90670
|
*/
|
|
90812
90671
|
trackAll = "TrackAll",
|
|
90813
90672
|
/**
|
|
90814
90673
|
* Tracking is turned on for my changes only.
|
|
90815
90674
|
* @remarks
|
|
90816
|
-
* [Api set: WordApiOnline
|
|
90817
|
-
* @beta
|
|
90675
|
+
* [Api set: WordApiOnline 1.1]
|
|
90818
90676
|
*/
|
|
90819
90677
|
trackMineOnly = "TrackMineOnly",
|
|
90820
90678
|
}
|
|
@@ -90822,18 +90680,17 @@ declare namespace Word {
|
|
|
90822
90680
|
* Specify the current version or the original version of the text.
|
|
90823
90681
|
*
|
|
90824
90682
|
* @remarks
|
|
90825
|
-
* [Api set: WordApiOnline
|
|
90826
|
-
* @beta
|
|
90683
|
+
* [Api set: WordApiOnline 1.1]
|
|
90827
90684
|
*/
|
|
90828
90685
|
enum ChangeTrackingVersion {
|
|
90829
90686
|
/**
|
|
90830
90687
|
* @remarks
|
|
90831
|
-
* [Api set: WordApiOnline
|
|
90688
|
+
* [Api set: WordApiOnline 1.1]
|
|
90832
90689
|
*/
|
|
90833
90690
|
original = "Original",
|
|
90834
90691
|
/**
|
|
90835
90692
|
* @remarks
|
|
90836
|
-
* [Api set: WordApiOnline
|
|
90693
|
+
* [Api set: WordApiOnline 1.1]
|
|
90837
90694
|
*/
|
|
90838
90695
|
current = "Current",
|
|
90839
90696
|
}
|
|
@@ -90841,18 +90698,17 @@ declare namespace Word {
|
|
|
90841
90698
|
* Note item type
|
|
90842
90699
|
*
|
|
90843
90700
|
* @remarks
|
|
90844
|
-
* [Api set: WordApiOnline
|
|
90845
|
-
* @beta
|
|
90701
|
+
* [Api set: WordApiOnline 1.1]
|
|
90846
90702
|
*/
|
|
90847
90703
|
enum NoteItemType {
|
|
90848
90704
|
/**
|
|
90849
90705
|
* @remarks
|
|
90850
|
-
* [Api set: WordApiOnline
|
|
90706
|
+
* [Api set: WordApiOnline 1.1]
|
|
90851
90707
|
*/
|
|
90852
90708
|
footnote = "Footnote",
|
|
90853
90709
|
/**
|
|
90854
90710
|
* @remarks
|
|
90855
|
-
* [Api set: WordApiOnline
|
|
90711
|
+
* [Api set: WordApiOnline 1.1]
|
|
90856
90712
|
*/
|
|
90857
90713
|
endnote = "Endnote",
|
|
90858
90714
|
}
|
|
@@ -91381,17 +91237,17 @@ declare namespace Word {
|
|
|
91381
91237
|
tableCell = "TableCell",
|
|
91382
91238
|
/**
|
|
91383
91239
|
* @remarks
|
|
91384
|
-
* [Api set:
|
|
91240
|
+
* [Api set: WordApiOnline 1.1]
|
|
91385
91241
|
*/
|
|
91386
91242
|
footnote = "Footnote",
|
|
91387
91243
|
/**
|
|
91388
91244
|
* @remarks
|
|
91389
|
-
* [Api set:
|
|
91245
|
+
* [Api set: WordApiOnline 1.1]
|
|
91390
91246
|
*/
|
|
91391
91247
|
endnote = "Endnote",
|
|
91392
91248
|
/**
|
|
91393
91249
|
* @remarks
|
|
91394
|
-
* [Api set:
|
|
91250
|
+
* [Api set: WordApiOnline 1.1]
|
|
91395
91251
|
*/
|
|
91396
91252
|
noteItem = "NoteItem",
|
|
91397
91253
|
}
|
|
@@ -92791,27 +92647,24 @@ declare namespace Word {
|
|
|
92791
92647
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
92792
92648
|
interface CommentUpdateData {
|
|
92793
92649
|
/**
|
|
92794
|
-
* Gets or sets the comment
|
|
92650
|
+
* Gets or sets the comment's content range.
|
|
92795
92651
|
*
|
|
92796
92652
|
* @remarks
|
|
92797
|
-
* [Api set: WordApiOnline
|
|
92798
|
-
* @beta
|
|
92653
|
+
* [Api set: WordApiOnline 1.1]
|
|
92799
92654
|
*/
|
|
92800
92655
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
92801
92656
|
/**
|
|
92802
92657
|
* Gets or sets the comment's content as plain text.
|
|
92803
92658
|
*
|
|
92804
92659
|
* @remarks
|
|
92805
|
-
* [Api set: WordApiOnline
|
|
92806
|
-
* @beta
|
|
92660
|
+
* [Api set: WordApiOnline 1.1]
|
|
92807
92661
|
*/
|
|
92808
92662
|
content?: string;
|
|
92809
92663
|
/**
|
|
92810
92664
|
* 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.
|
|
92811
92665
|
*
|
|
92812
92666
|
* @remarks
|
|
92813
|
-
* [Api set: WordApiOnline
|
|
92814
|
-
* @beta
|
|
92667
|
+
* [Api set: WordApiOnline 1.1]
|
|
92815
92668
|
*/
|
|
92816
92669
|
resolved?: boolean;
|
|
92817
92670
|
}
|
|
@@ -92825,40 +92678,35 @@ declare namespace Word {
|
|
|
92825
92678
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
92826
92679
|
*
|
|
92827
92680
|
* @remarks
|
|
92828
|
-
* [Api set: WordApiOnline
|
|
92829
|
-
* @beta
|
|
92681
|
+
* [Api set: WordApiOnline 1.1]
|
|
92830
92682
|
*/
|
|
92831
92683
|
bold?: boolean;
|
|
92832
92684
|
/**
|
|
92833
92685
|
* 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.
|
|
92834
92686
|
*
|
|
92835
92687
|
* @remarks
|
|
92836
|
-
* [Api set: WordApiOnline
|
|
92837
|
-
* @beta
|
|
92688
|
+
* [Api set: WordApiOnline 1.1]
|
|
92838
92689
|
*/
|
|
92839
92690
|
hyperlink?: string;
|
|
92840
92691
|
/**
|
|
92841
92692
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
92842
92693
|
*
|
|
92843
92694
|
* @remarks
|
|
92844
|
-
* [Api set: WordApiOnline
|
|
92845
|
-
* @beta
|
|
92695
|
+
* [Api set: WordApiOnline 1.1]
|
|
92846
92696
|
*/
|
|
92847
92697
|
italic?: boolean;
|
|
92848
92698
|
/**
|
|
92849
92699
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
92850
92700
|
*
|
|
92851
92701
|
* @remarks
|
|
92852
|
-
* [Api set: WordApiOnline
|
|
92853
|
-
* @beta
|
|
92702
|
+
* [Api set: WordApiOnline 1.1]
|
|
92854
92703
|
*/
|
|
92855
92704
|
strikeThrough?: boolean;
|
|
92856
92705
|
/**
|
|
92857
92706
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
92858
92707
|
*
|
|
92859
92708
|
* @remarks
|
|
92860
|
-
* [Api set: WordApiOnline
|
|
92861
|
-
* @beta
|
|
92709
|
+
* [Api set: WordApiOnline 1.1]
|
|
92862
92710
|
*/
|
|
92863
92711
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
92864
92712
|
}
|
|
@@ -92868,24 +92716,21 @@ declare namespace Word {
|
|
|
92868
92716
|
* Gets or sets the commentReply's content range.
|
|
92869
92717
|
*
|
|
92870
92718
|
* @remarks
|
|
92871
|
-
* [Api set: WordApiOnline
|
|
92872
|
-
* @beta
|
|
92719
|
+
* [Api set: WordApiOnline 1.1]
|
|
92873
92720
|
*/
|
|
92874
92721
|
contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
|
|
92875
92722
|
/**
|
|
92876
92723
|
* Gets the parent comment of this reply.
|
|
92877
92724
|
*
|
|
92878
92725
|
* @remarks
|
|
92879
|
-
* [Api set: WordApiOnline
|
|
92880
|
-
* @beta
|
|
92726
|
+
* [Api set: WordApiOnline 1.1]
|
|
92881
92727
|
*/
|
|
92882
92728
|
parentComment?: Word.Interfaces.CommentUpdateData;
|
|
92883
92729
|
/**
|
|
92884
92730
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
92885
92731
|
*
|
|
92886
92732
|
* @remarks
|
|
92887
|
-
* [Api set: WordApiOnline
|
|
92888
|
-
* @beta
|
|
92733
|
+
* [Api set: WordApiOnline 1.1]
|
|
92889
92734
|
*/
|
|
92890
92735
|
content?: string;
|
|
92891
92736
|
}
|
|
@@ -93020,8 +92865,7 @@ declare namespace Word {
|
|
|
93020
92865
|
* Gets or sets the ChangeTracking mode.
|
|
93021
92866
|
*
|
|
93022
92867
|
* @remarks
|
|
93023
|
-
* [Api set: WordApiOnline
|
|
93024
|
-
* @beta
|
|
92868
|
+
* [Api set: WordApiOnline 1.1]
|
|
93025
92869
|
*/
|
|
93026
92870
|
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
93027
92871
|
}
|
|
@@ -93259,19 +93103,17 @@ declare namespace Word {
|
|
|
93259
93103
|
/** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
|
|
93260
93104
|
interface NoteItemUpdateData {
|
|
93261
93105
|
/**
|
|
93262
|
-
* Represents the body object of the note item. It
|
|
93106
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
93263
93107
|
*
|
|
93264
93108
|
* @remarks
|
|
93265
|
-
* [Api set: WordApiOnline
|
|
93266
|
-
* @beta
|
|
93109
|
+
* [Api set: WordApiOnline 1.1]
|
|
93267
93110
|
*/
|
|
93268
93111
|
body?: Word.Interfaces.BodyUpdateData;
|
|
93269
93112
|
/**
|
|
93270
93113
|
* Represents a footnote or endnote reference in the main document.
|
|
93271
93114
|
*
|
|
93272
93115
|
* @remarks
|
|
93273
|
-
* [Api set: WordApiOnline
|
|
93274
|
-
* @beta
|
|
93116
|
+
* [Api set: WordApiOnline 1.1]
|
|
93275
93117
|
*/
|
|
93276
93118
|
reference?: Word.Interfaces.RangeUpdateData;
|
|
93277
93119
|
}
|
|
@@ -93825,67 +93667,59 @@ declare namespace Word {
|
|
|
93825
93667
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
93826
93668
|
interface CommentData {
|
|
93827
93669
|
/**
|
|
93828
|
-
* Gets or sets the comment
|
|
93670
|
+
* Gets or sets the comment's content range.
|
|
93829
93671
|
*
|
|
93830
93672
|
* @remarks
|
|
93831
|
-
* [Api set: WordApiOnline
|
|
93832
|
-
* @beta
|
|
93673
|
+
* [Api set: WordApiOnline 1.1]
|
|
93833
93674
|
*/
|
|
93834
93675
|
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
93835
93676
|
/**
|
|
93836
93677
|
* Gets the collection of reply objects associated with the comment.
|
|
93837
93678
|
*
|
|
93838
93679
|
* @remarks
|
|
93839
|
-
* [Api set: WordApiOnline
|
|
93840
|
-
* @beta
|
|
93680
|
+
* [Api set: WordApiOnline 1.1]
|
|
93841
93681
|
*/
|
|
93842
93682
|
replies?: Word.Interfaces.CommentReplyData[];
|
|
93843
93683
|
/**
|
|
93844
93684
|
* Gets the email of the comment's author.
|
|
93845
93685
|
*
|
|
93846
93686
|
* @remarks
|
|
93847
|
-
* [Api set: WordApiOnline
|
|
93848
|
-
* @beta
|
|
93687
|
+
* [Api set: WordApiOnline 1.1]
|
|
93849
93688
|
*/
|
|
93850
93689
|
authorEmail?: string;
|
|
93851
93690
|
/**
|
|
93852
93691
|
* Gets the name of the comment's author.
|
|
93853
93692
|
*
|
|
93854
93693
|
* @remarks
|
|
93855
|
-
* [Api set: WordApiOnline
|
|
93856
|
-
* @beta
|
|
93694
|
+
* [Api set: WordApiOnline 1.1]
|
|
93857
93695
|
*/
|
|
93858
93696
|
authorName?: string;
|
|
93859
93697
|
/**
|
|
93860
93698
|
* Gets or sets the comment's content as plain text.
|
|
93861
93699
|
*
|
|
93862
93700
|
* @remarks
|
|
93863
|
-
* [Api set: WordApiOnline
|
|
93864
|
-
* @beta
|
|
93701
|
+
* [Api set: WordApiOnline 1.1]
|
|
93865
93702
|
*/
|
|
93866
93703
|
content?: string;
|
|
93867
93704
|
/**
|
|
93868
93705
|
* Gets the creation date of the comment.
|
|
93869
93706
|
*
|
|
93870
93707
|
* @remarks
|
|
93871
|
-
* [Api set: WordApiOnline
|
|
93872
|
-
* @beta
|
|
93708
|
+
* [Api set: WordApiOnline 1.1]
|
|
93873
93709
|
*/
|
|
93874
93710
|
creationDate?: Date;
|
|
93875
93711
|
/**
|
|
93876
93712
|
* Gets the ID of the comment. Read-only.
|
|
93877
93713
|
*
|
|
93878
93714
|
* @remarks
|
|
93879
|
-
* [Api set: WordApiOnline
|
|
93880
|
-
* @beta
|
|
93715
|
+
* [Api set: WordApiOnline 1.1]
|
|
93881
93716
|
*/
|
|
93882
93717
|
id?: string;
|
|
93883
93718
|
/**
|
|
93884
93719
|
* 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.
|
|
93885
93720
|
*
|
|
93886
93721
|
* @remarks
|
|
93887
|
-
* [Api set: WordApiOnline
|
|
93888
|
-
* @beta
|
|
93722
|
+
* [Api set: WordApiOnline 1.1]
|
|
93889
93723
|
*/
|
|
93890
93724
|
resolved?: boolean;
|
|
93891
93725
|
}
|
|
@@ -93899,56 +93733,49 @@ declare namespace Word {
|
|
|
93899
93733
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
93900
93734
|
*
|
|
93901
93735
|
* @remarks
|
|
93902
|
-
* [Api set: WordApiOnline
|
|
93903
|
-
* @beta
|
|
93736
|
+
* [Api set: WordApiOnline 1.1]
|
|
93904
93737
|
*/
|
|
93905
93738
|
bold?: boolean;
|
|
93906
93739
|
/**
|
|
93907
93740
|
* 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.
|
|
93908
93741
|
*
|
|
93909
93742
|
* @remarks
|
|
93910
|
-
* [Api set: WordApiOnline
|
|
93911
|
-
* @beta
|
|
93743
|
+
* [Api set: WordApiOnline 1.1]
|
|
93912
93744
|
*/
|
|
93913
93745
|
hyperlink?: string;
|
|
93914
93746
|
/**
|
|
93915
93747
|
* Checks whether the range length is zero. Read-only.
|
|
93916
93748
|
*
|
|
93917
93749
|
* @remarks
|
|
93918
|
-
* [Api set: WordApiOnline
|
|
93919
|
-
* @beta
|
|
93750
|
+
* [Api set: WordApiOnline 1.1]
|
|
93920
93751
|
*/
|
|
93921
93752
|
isEmpty?: boolean;
|
|
93922
93753
|
/**
|
|
93923
93754
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
93924
93755
|
*
|
|
93925
93756
|
* @remarks
|
|
93926
|
-
* [Api set: WordApiOnline
|
|
93927
|
-
* @beta
|
|
93757
|
+
* [Api set: WordApiOnline 1.1]
|
|
93928
93758
|
*/
|
|
93929
93759
|
italic?: boolean;
|
|
93930
93760
|
/**
|
|
93931
93761
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
93932
93762
|
*
|
|
93933
93763
|
* @remarks
|
|
93934
|
-
* [Api set: WordApiOnline
|
|
93935
|
-
* @beta
|
|
93764
|
+
* [Api set: WordApiOnline 1.1]
|
|
93936
93765
|
*/
|
|
93937
93766
|
strikeThrough?: boolean;
|
|
93938
93767
|
/**
|
|
93939
93768
|
* Gets the text of the comment range. Read-only.
|
|
93940
93769
|
*
|
|
93941
93770
|
* @remarks
|
|
93942
|
-
* [Api set: WordApiOnline
|
|
93943
|
-
* @beta
|
|
93771
|
+
* [Api set: WordApiOnline 1.1]
|
|
93944
93772
|
*/
|
|
93945
93773
|
text?: string;
|
|
93946
93774
|
/**
|
|
93947
93775
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
93948
93776
|
*
|
|
93949
93777
|
* @remarks
|
|
93950
|
-
* [Api set: WordApiOnline
|
|
93951
|
-
* @beta
|
|
93778
|
+
* [Api set: WordApiOnline 1.1]
|
|
93952
93779
|
*/
|
|
93953
93780
|
underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
|
|
93954
93781
|
}
|
|
@@ -93958,56 +93785,49 @@ declare namespace Word {
|
|
|
93958
93785
|
* Gets or sets the commentReply's content range.
|
|
93959
93786
|
*
|
|
93960
93787
|
* @remarks
|
|
93961
|
-
* [Api set: WordApiOnline
|
|
93962
|
-
* @beta
|
|
93788
|
+
* [Api set: WordApiOnline 1.1]
|
|
93963
93789
|
*/
|
|
93964
93790
|
contentRange?: Word.Interfaces.CommentContentRangeData;
|
|
93965
93791
|
/**
|
|
93966
93792
|
* Gets the parent comment of this reply.
|
|
93967
93793
|
*
|
|
93968
93794
|
* @remarks
|
|
93969
|
-
* [Api set: WordApiOnline
|
|
93970
|
-
* @beta
|
|
93795
|
+
* [Api set: WordApiOnline 1.1]
|
|
93971
93796
|
*/
|
|
93972
93797
|
parentComment?: Word.Interfaces.CommentData;
|
|
93973
93798
|
/**
|
|
93974
93799
|
* Gets the email of the comment reply's author.
|
|
93975
93800
|
*
|
|
93976
93801
|
* @remarks
|
|
93977
|
-
* [Api set: WordApiOnline
|
|
93978
|
-
* @beta
|
|
93802
|
+
* [Api set: WordApiOnline 1.1]
|
|
93979
93803
|
*/
|
|
93980
93804
|
authorEmail?: string;
|
|
93981
93805
|
/**
|
|
93982
93806
|
* Gets the name of the comment reply's author.
|
|
93983
93807
|
*
|
|
93984
93808
|
* @remarks
|
|
93985
|
-
* [Api set: WordApiOnline
|
|
93986
|
-
* @beta
|
|
93809
|
+
* [Api set: WordApiOnline 1.1]
|
|
93987
93810
|
*/
|
|
93988
93811
|
authorName?: string;
|
|
93989
93812
|
/**
|
|
93990
93813
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
93991
93814
|
*
|
|
93992
93815
|
* @remarks
|
|
93993
|
-
* [Api set: WordApiOnline
|
|
93994
|
-
* @beta
|
|
93816
|
+
* [Api set: WordApiOnline 1.1]
|
|
93995
93817
|
*/
|
|
93996
93818
|
content?: string;
|
|
93997
93819
|
/**
|
|
93998
93820
|
* Gets the creation date of the comment reply.
|
|
93999
93821
|
*
|
|
94000
93822
|
* @remarks
|
|
94001
|
-
* [Api set: WordApiOnline
|
|
94002
|
-
* @beta
|
|
93823
|
+
* [Api set: WordApiOnline 1.1]
|
|
94003
93824
|
*/
|
|
94004
93825
|
creationDate?: Date;
|
|
94005
93826
|
/**
|
|
94006
93827
|
* Gets the ID of the comment reply. Read-only.
|
|
94007
93828
|
*
|
|
94008
93829
|
* @remarks
|
|
94009
|
-
* [Api set: WordApiOnline
|
|
94010
|
-
* @beta
|
|
93830
|
+
* [Api set: WordApiOnline 1.1]
|
|
94011
93831
|
*/
|
|
94012
93832
|
id?: string;
|
|
94013
93833
|
}
|
|
@@ -94276,8 +94096,7 @@ declare namespace Word {
|
|
|
94276
94096
|
* Gets or sets the ChangeTracking mode.
|
|
94277
94097
|
*
|
|
94278
94098
|
* @remarks
|
|
94279
|
-
* [Api set: WordApiOnline
|
|
94280
|
-
* @beta
|
|
94099
|
+
* [Api set: WordApiOnline 1.1]
|
|
94281
94100
|
*/
|
|
94282
94101
|
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
94283
94102
|
/**
|
|
@@ -94694,27 +94513,24 @@ declare namespace Word {
|
|
|
94694
94513
|
/** An interface describing the data returned by calling `noteItem.toJSON()`. */
|
|
94695
94514
|
interface NoteItemData {
|
|
94696
94515
|
/**
|
|
94697
|
-
* Represents the body object of the note item. It
|
|
94516
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
94698
94517
|
*
|
|
94699
94518
|
* @remarks
|
|
94700
|
-
* [Api set: WordApiOnline
|
|
94701
|
-
* @beta
|
|
94519
|
+
* [Api set: WordApiOnline 1.1]
|
|
94702
94520
|
*/
|
|
94703
94521
|
body?: Word.Interfaces.BodyData;
|
|
94704
94522
|
/**
|
|
94705
94523
|
* Represents a footnote or endnote reference in the main document.
|
|
94706
94524
|
*
|
|
94707
94525
|
* @remarks
|
|
94708
|
-
* [Api set: WordApiOnline
|
|
94709
|
-
* @beta
|
|
94526
|
+
* [Api set: WordApiOnline 1.1]
|
|
94710
94527
|
*/
|
|
94711
94528
|
reference?: Word.Interfaces.RangeData;
|
|
94712
94529
|
/**
|
|
94713
94530
|
* Represents the note item type: footnote or endnote.
|
|
94714
94531
|
*
|
|
94715
94532
|
* @remarks
|
|
94716
|
-
* [Api set: WordApiOnline
|
|
94717
|
-
* @beta
|
|
94533
|
+
* [Api set: WordApiOnline 1.1]
|
|
94718
94534
|
*/
|
|
94719
94535
|
type?: Word.NoteItemType | "Footnote" | "Endnote";
|
|
94720
94536
|
}
|
|
@@ -95457,8 +95273,7 @@ declare namespace Word {
|
|
|
95457
95273
|
* Represents a comment in the document.
|
|
95458
95274
|
*
|
|
95459
95275
|
* @remarks
|
|
95460
|
-
* [Api set: WordApiOnline
|
|
95461
|
-
* @beta
|
|
95276
|
+
* [Api set: WordApiOnline 1.1]
|
|
95462
95277
|
*/
|
|
95463
95278
|
interface CommentLoadOptions {
|
|
95464
95279
|
/**
|
|
@@ -95466,59 +95281,52 @@ declare namespace Word {
|
|
|
95466
95281
|
*/
|
|
95467
95282
|
$all?: boolean;
|
|
95468
95283
|
/**
|
|
95469
|
-
* Gets or sets the comment
|
|
95284
|
+
* Gets or sets the comment's content range.
|
|
95470
95285
|
*
|
|
95471
95286
|
* @remarks
|
|
95472
|
-
* [Api set: WordApiOnline
|
|
95473
|
-
* @beta
|
|
95287
|
+
* [Api set: WordApiOnline 1.1]
|
|
95474
95288
|
*/
|
|
95475
95289
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95476
95290
|
/**
|
|
95477
95291
|
* Gets the email of the comment's author.
|
|
95478
95292
|
*
|
|
95479
95293
|
* @remarks
|
|
95480
|
-
* [Api set: WordApiOnline
|
|
95481
|
-
* @beta
|
|
95294
|
+
* [Api set: WordApiOnline 1.1]
|
|
95482
95295
|
*/
|
|
95483
95296
|
authorEmail?: boolean;
|
|
95484
95297
|
/**
|
|
95485
95298
|
* Gets the name of the comment's author.
|
|
95486
95299
|
*
|
|
95487
95300
|
* @remarks
|
|
95488
|
-
* [Api set: WordApiOnline
|
|
95489
|
-
* @beta
|
|
95301
|
+
* [Api set: WordApiOnline 1.1]
|
|
95490
95302
|
*/
|
|
95491
95303
|
authorName?: boolean;
|
|
95492
95304
|
/**
|
|
95493
95305
|
* Gets or sets the comment's content as plain text.
|
|
95494
95306
|
*
|
|
95495
95307
|
* @remarks
|
|
95496
|
-
* [Api set: WordApiOnline
|
|
95497
|
-
* @beta
|
|
95308
|
+
* [Api set: WordApiOnline 1.1]
|
|
95498
95309
|
*/
|
|
95499
95310
|
content?: boolean;
|
|
95500
95311
|
/**
|
|
95501
95312
|
* Gets the creation date of the comment.
|
|
95502
95313
|
*
|
|
95503
95314
|
* @remarks
|
|
95504
|
-
* [Api set: WordApiOnline
|
|
95505
|
-
* @beta
|
|
95315
|
+
* [Api set: WordApiOnline 1.1]
|
|
95506
95316
|
*/
|
|
95507
95317
|
creationDate?: boolean;
|
|
95508
95318
|
/**
|
|
95509
95319
|
* Gets the ID of the comment. Read-only.
|
|
95510
95320
|
*
|
|
95511
95321
|
* @remarks
|
|
95512
|
-
* [Api set: WordApiOnline
|
|
95513
|
-
* @beta
|
|
95322
|
+
* [Api set: WordApiOnline 1.1]
|
|
95514
95323
|
*/
|
|
95515
95324
|
id?: boolean;
|
|
95516
95325
|
/**
|
|
95517
95326
|
* 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.
|
|
95518
95327
|
*
|
|
95519
95328
|
* @remarks
|
|
95520
|
-
* [Api set: WordApiOnline
|
|
95521
|
-
* @beta
|
|
95329
|
+
* [Api set: WordApiOnline 1.1]
|
|
95522
95330
|
*/
|
|
95523
95331
|
resolved?: boolean;
|
|
95524
95332
|
}
|
|
@@ -95526,8 +95334,7 @@ declare namespace Word {
|
|
|
95526
95334
|
* Contains a collection of {@link Word.Comment} objects.
|
|
95527
95335
|
*
|
|
95528
95336
|
* @remarks
|
|
95529
|
-
* [Api set: WordApiOnline
|
|
95530
|
-
* @beta
|
|
95337
|
+
* [Api set: WordApiOnline 1.1]
|
|
95531
95338
|
*/
|
|
95532
95339
|
interface CommentCollectionLoadOptions {
|
|
95533
95340
|
/**
|
|
@@ -95535,66 +95342,58 @@ declare namespace Word {
|
|
|
95535
95342
|
*/
|
|
95536
95343
|
$all?: boolean;
|
|
95537
95344
|
/**
|
|
95538
|
-
* For EACH ITEM in the collection: Gets or sets the comment
|
|
95345
|
+
* For EACH ITEM in the collection: Gets or sets the comment's content range.
|
|
95539
95346
|
*
|
|
95540
95347
|
* @remarks
|
|
95541
|
-
* [Api set: WordApiOnline
|
|
95542
|
-
* @beta
|
|
95348
|
+
* [Api set: WordApiOnline 1.1]
|
|
95543
95349
|
*/
|
|
95544
95350
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95545
95351
|
/**
|
|
95546
95352
|
* For EACH ITEM in the collection: Gets the email of the comment's author.
|
|
95547
95353
|
*
|
|
95548
95354
|
* @remarks
|
|
95549
|
-
* [Api set: WordApiOnline
|
|
95550
|
-
* @beta
|
|
95355
|
+
* [Api set: WordApiOnline 1.1]
|
|
95551
95356
|
*/
|
|
95552
95357
|
authorEmail?: boolean;
|
|
95553
95358
|
/**
|
|
95554
95359
|
* For EACH ITEM in the collection: Gets the name of the comment's author.
|
|
95555
95360
|
*
|
|
95556
95361
|
* @remarks
|
|
95557
|
-
* [Api set: WordApiOnline
|
|
95558
|
-
* @beta
|
|
95362
|
+
* [Api set: WordApiOnline 1.1]
|
|
95559
95363
|
*/
|
|
95560
95364
|
authorName?: boolean;
|
|
95561
95365
|
/**
|
|
95562
95366
|
* For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
|
|
95563
95367
|
*
|
|
95564
95368
|
* @remarks
|
|
95565
|
-
* [Api set: WordApiOnline
|
|
95566
|
-
* @beta
|
|
95369
|
+
* [Api set: WordApiOnline 1.1]
|
|
95567
95370
|
*/
|
|
95568
95371
|
content?: boolean;
|
|
95569
95372
|
/**
|
|
95570
95373
|
* For EACH ITEM in the collection: Gets the creation date of the comment.
|
|
95571
95374
|
*
|
|
95572
95375
|
* @remarks
|
|
95573
|
-
* [Api set: WordApiOnline
|
|
95574
|
-
* @beta
|
|
95376
|
+
* [Api set: WordApiOnline 1.1]
|
|
95575
95377
|
*/
|
|
95576
95378
|
creationDate?: boolean;
|
|
95577
95379
|
/**
|
|
95578
95380
|
* For EACH ITEM in the collection: Gets the ID of the comment. Read-only.
|
|
95579
95381
|
*
|
|
95580
95382
|
* @remarks
|
|
95581
|
-
* [Api set: WordApiOnline
|
|
95582
|
-
* @beta
|
|
95383
|
+
* [Api set: WordApiOnline 1.1]
|
|
95583
95384
|
*/
|
|
95584
95385
|
id?: boolean;
|
|
95585
95386
|
/**
|
|
95586
95387
|
* 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.
|
|
95587
95388
|
*
|
|
95588
95389
|
* @remarks
|
|
95589
|
-
* [Api set: WordApiOnline
|
|
95590
|
-
* @beta
|
|
95390
|
+
* [Api set: WordApiOnline 1.1]
|
|
95591
95391
|
*/
|
|
95592
95392
|
resolved?: boolean;
|
|
95593
95393
|
}
|
|
95594
95394
|
/**
|
|
95595
95395
|
* @remarks
|
|
95596
|
-
* [Api set: WordApiOnline
|
|
95597
|
-
* @beta
|
|
95396
|
+
* [Api set: WordApiOnline 1.1]
|
|
95598
95397
|
*/
|
|
95599
95398
|
interface CommentContentRangeLoadOptions {
|
|
95600
95399
|
/**
|
|
@@ -95605,56 +95404,49 @@ declare namespace Word {
|
|
|
95605
95404
|
* Gets or sets a value that indicates whether the comment text is bold.
|
|
95606
95405
|
*
|
|
95607
95406
|
* @remarks
|
|
95608
|
-
* [Api set: WordApiOnline
|
|
95609
|
-
* @beta
|
|
95407
|
+
* [Api set: WordApiOnline 1.1]
|
|
95610
95408
|
*/
|
|
95611
95409
|
bold?: boolean;
|
|
95612
95410
|
/**
|
|
95613
95411
|
* 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.
|
|
95614
95412
|
*
|
|
95615
95413
|
* @remarks
|
|
95616
|
-
* [Api set: WordApiOnline
|
|
95617
|
-
* @beta
|
|
95414
|
+
* [Api set: WordApiOnline 1.1]
|
|
95618
95415
|
*/
|
|
95619
95416
|
hyperlink?: boolean;
|
|
95620
95417
|
/**
|
|
95621
95418
|
* Checks whether the range length is zero. Read-only.
|
|
95622
95419
|
*
|
|
95623
95420
|
* @remarks
|
|
95624
|
-
* [Api set: WordApiOnline
|
|
95625
|
-
* @beta
|
|
95421
|
+
* [Api set: WordApiOnline 1.1]
|
|
95626
95422
|
*/
|
|
95627
95423
|
isEmpty?: boolean;
|
|
95628
95424
|
/**
|
|
95629
95425
|
* Gets or sets a value that indicates whether the comment text is italicized.
|
|
95630
95426
|
*
|
|
95631
95427
|
* @remarks
|
|
95632
|
-
* [Api set: WordApiOnline
|
|
95633
|
-
* @beta
|
|
95428
|
+
* [Api set: WordApiOnline 1.1]
|
|
95634
95429
|
*/
|
|
95635
95430
|
italic?: boolean;
|
|
95636
95431
|
/**
|
|
95637
95432
|
* Gets or sets a value that indicates whether the comment text has a strikethrough.
|
|
95638
95433
|
*
|
|
95639
95434
|
* @remarks
|
|
95640
|
-
* [Api set: WordApiOnline
|
|
95641
|
-
* @beta
|
|
95435
|
+
* [Api set: WordApiOnline 1.1]
|
|
95642
95436
|
*/
|
|
95643
95437
|
strikeThrough?: boolean;
|
|
95644
95438
|
/**
|
|
95645
95439
|
* Gets the text of the comment range. Read-only.
|
|
95646
95440
|
*
|
|
95647
95441
|
* @remarks
|
|
95648
|
-
* [Api set: WordApiOnline
|
|
95649
|
-
* @beta
|
|
95442
|
+
* [Api set: WordApiOnline 1.1]
|
|
95650
95443
|
*/
|
|
95651
95444
|
text?: boolean;
|
|
95652
95445
|
/**
|
|
95653
95446
|
* Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
|
|
95654
95447
|
*
|
|
95655
95448
|
* @remarks
|
|
95656
|
-
* [Api set: WordApiOnline
|
|
95657
|
-
* @beta
|
|
95449
|
+
* [Api set: WordApiOnline 1.1]
|
|
95658
95450
|
*/
|
|
95659
95451
|
underline?: boolean;
|
|
95660
95452
|
}
|
|
@@ -95662,8 +95454,7 @@ declare namespace Word {
|
|
|
95662
95454
|
* Represents a comment reply in the document.
|
|
95663
95455
|
*
|
|
95664
95456
|
* @remarks
|
|
95665
|
-
* [Api set: WordApiOnline
|
|
95666
|
-
* @beta
|
|
95457
|
+
* [Api set: WordApiOnline 1.1]
|
|
95667
95458
|
*/
|
|
95668
95459
|
interface CommentReplyLoadOptions {
|
|
95669
95460
|
/**
|
|
@@ -95674,56 +95465,49 @@ declare namespace Word {
|
|
|
95674
95465
|
* Gets or sets the commentReply's content range.
|
|
95675
95466
|
*
|
|
95676
95467
|
* @remarks
|
|
95677
|
-
* [Api set: WordApiOnline
|
|
95678
|
-
* @beta
|
|
95468
|
+
* [Api set: WordApiOnline 1.1]
|
|
95679
95469
|
*/
|
|
95680
95470
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95681
95471
|
/**
|
|
95682
95472
|
* Gets the parent comment of this reply.
|
|
95683
95473
|
*
|
|
95684
95474
|
* @remarks
|
|
95685
|
-
* [Api set: WordApiOnline
|
|
95686
|
-
* @beta
|
|
95475
|
+
* [Api set: WordApiOnline 1.1]
|
|
95687
95476
|
*/
|
|
95688
95477
|
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
95689
95478
|
/**
|
|
95690
95479
|
* Gets the email of the comment reply's author.
|
|
95691
95480
|
*
|
|
95692
95481
|
* @remarks
|
|
95693
|
-
* [Api set: WordApiOnline
|
|
95694
|
-
* @beta
|
|
95482
|
+
* [Api set: WordApiOnline 1.1]
|
|
95695
95483
|
*/
|
|
95696
95484
|
authorEmail?: boolean;
|
|
95697
95485
|
/**
|
|
95698
95486
|
* Gets the name of the comment reply's author.
|
|
95699
95487
|
*
|
|
95700
95488
|
* @remarks
|
|
95701
|
-
* [Api set: WordApiOnline
|
|
95702
|
-
* @beta
|
|
95489
|
+
* [Api set: WordApiOnline 1.1]
|
|
95703
95490
|
*/
|
|
95704
95491
|
authorName?: boolean;
|
|
95705
95492
|
/**
|
|
95706
95493
|
* Gets or sets the comment reply's content. The string is plain text.
|
|
95707
95494
|
*
|
|
95708
95495
|
* @remarks
|
|
95709
|
-
* [Api set: WordApiOnline
|
|
95710
|
-
* @beta
|
|
95496
|
+
* [Api set: WordApiOnline 1.1]
|
|
95711
95497
|
*/
|
|
95712
95498
|
content?: boolean;
|
|
95713
95499
|
/**
|
|
95714
95500
|
* Gets the creation date of the comment reply.
|
|
95715
95501
|
*
|
|
95716
95502
|
* @remarks
|
|
95717
|
-
* [Api set: WordApiOnline
|
|
95718
|
-
* @beta
|
|
95503
|
+
* [Api set: WordApiOnline 1.1]
|
|
95719
95504
|
*/
|
|
95720
95505
|
creationDate?: boolean;
|
|
95721
95506
|
/**
|
|
95722
95507
|
* Gets the ID of the comment reply. Read-only.
|
|
95723
95508
|
*
|
|
95724
95509
|
* @remarks
|
|
95725
|
-
* [Api set: WordApiOnline
|
|
95726
|
-
* @beta
|
|
95510
|
+
* [Api set: WordApiOnline 1.1]
|
|
95727
95511
|
*/
|
|
95728
95512
|
id?: boolean;
|
|
95729
95513
|
}
|
|
@@ -95731,8 +95515,7 @@ declare namespace Word {
|
|
|
95731
95515
|
* Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
|
|
95732
95516
|
*
|
|
95733
95517
|
* @remarks
|
|
95734
|
-
* [Api set: WordApiOnline
|
|
95735
|
-
* @beta
|
|
95518
|
+
* [Api set: WordApiOnline 1.1]
|
|
95736
95519
|
*/
|
|
95737
95520
|
interface CommentReplyCollectionLoadOptions {
|
|
95738
95521
|
/**
|
|
@@ -95743,56 +95526,49 @@ declare namespace Word {
|
|
|
95743
95526
|
* For EACH ITEM in the collection: Gets or sets the commentReply's content range.
|
|
95744
95527
|
*
|
|
95745
95528
|
* @remarks
|
|
95746
|
-
* [Api set: WordApiOnline
|
|
95747
|
-
* @beta
|
|
95529
|
+
* [Api set: WordApiOnline 1.1]
|
|
95748
95530
|
*/
|
|
95749
95531
|
contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
|
|
95750
95532
|
/**
|
|
95751
95533
|
* For EACH ITEM in the collection: Gets the parent comment of this reply.
|
|
95752
95534
|
*
|
|
95753
95535
|
* @remarks
|
|
95754
|
-
* [Api set: WordApiOnline
|
|
95755
|
-
* @beta
|
|
95536
|
+
* [Api set: WordApiOnline 1.1]
|
|
95756
95537
|
*/
|
|
95757
95538
|
parentComment?: Word.Interfaces.CommentLoadOptions;
|
|
95758
95539
|
/**
|
|
95759
95540
|
* For EACH ITEM in the collection: Gets the email of the comment reply's author.
|
|
95760
95541
|
*
|
|
95761
95542
|
* @remarks
|
|
95762
|
-
* [Api set: WordApiOnline
|
|
95763
|
-
* @beta
|
|
95543
|
+
* [Api set: WordApiOnline 1.1]
|
|
95764
95544
|
*/
|
|
95765
95545
|
authorEmail?: boolean;
|
|
95766
95546
|
/**
|
|
95767
95547
|
* For EACH ITEM in the collection: Gets the name of the comment reply's author.
|
|
95768
95548
|
*
|
|
95769
95549
|
* @remarks
|
|
95770
|
-
* [Api set: WordApiOnline
|
|
95771
|
-
* @beta
|
|
95550
|
+
* [Api set: WordApiOnline 1.1]
|
|
95772
95551
|
*/
|
|
95773
95552
|
authorName?: boolean;
|
|
95774
95553
|
/**
|
|
95775
95554
|
* For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
|
|
95776
95555
|
*
|
|
95777
95556
|
* @remarks
|
|
95778
|
-
* [Api set: WordApiOnline
|
|
95779
|
-
* @beta
|
|
95557
|
+
* [Api set: WordApiOnline 1.1]
|
|
95780
95558
|
*/
|
|
95781
95559
|
content?: boolean;
|
|
95782
95560
|
/**
|
|
95783
95561
|
* For EACH ITEM in the collection: Gets the creation date of the comment reply.
|
|
95784
95562
|
*
|
|
95785
95563
|
* @remarks
|
|
95786
|
-
* [Api set: WordApiOnline
|
|
95787
|
-
* @beta
|
|
95564
|
+
* [Api set: WordApiOnline 1.1]
|
|
95788
95565
|
*/
|
|
95789
95566
|
creationDate?: boolean;
|
|
95790
95567
|
/**
|
|
95791
95568
|
* For EACH ITEM in the collection: Gets the ID of the comment reply. Read-only.
|
|
95792
95569
|
*
|
|
95793
95570
|
* @remarks
|
|
95794
|
-
* [Api set: WordApiOnline
|
|
95795
|
-
* @beta
|
|
95571
|
+
* [Api set: WordApiOnline 1.1]
|
|
95796
95572
|
*/
|
|
95797
95573
|
id?: boolean;
|
|
95798
95574
|
}
|
|
@@ -96312,8 +96088,7 @@ declare namespace Word {
|
|
|
96312
96088
|
* Gets or sets the ChangeTracking mode.
|
|
96313
96089
|
*
|
|
96314
96090
|
* @remarks
|
|
96315
|
-
* [Api set: WordApiOnline
|
|
96316
|
-
* @beta
|
|
96091
|
+
* [Api set: WordApiOnline 1.1]
|
|
96317
96092
|
*/
|
|
96318
96093
|
changeTrackingMode?: boolean;
|
|
96319
96094
|
/**
|
|
@@ -97073,8 +96848,7 @@ declare namespace Word {
|
|
|
97073
96848
|
* Represents a footnote or endnote.
|
|
97074
96849
|
*
|
|
97075
96850
|
* @remarks
|
|
97076
|
-
* [Api set: WordApiOnline
|
|
97077
|
-
* @beta
|
|
96851
|
+
* [Api set: WordApiOnline 1.1]
|
|
97078
96852
|
*/
|
|
97079
96853
|
interface NoteItemLoadOptions {
|
|
97080
96854
|
/**
|
|
@@ -97082,27 +96856,24 @@ declare namespace Word {
|
|
|
97082
96856
|
*/
|
|
97083
96857
|
$all?: boolean;
|
|
97084
96858
|
/**
|
|
97085
|
-
* Represents the body object of the note item. It
|
|
96859
|
+
* Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
|
|
97086
96860
|
*
|
|
97087
96861
|
* @remarks
|
|
97088
|
-
* [Api set: WordApiOnline
|
|
97089
|
-
* @beta
|
|
96862
|
+
* [Api set: WordApiOnline 1.1]
|
|
97090
96863
|
*/
|
|
97091
96864
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
97092
96865
|
/**
|
|
97093
96866
|
* Represents a footnote or endnote reference in the main document.
|
|
97094
96867
|
*
|
|
97095
96868
|
* @remarks
|
|
97096
|
-
* [Api set: WordApiOnline
|
|
97097
|
-
* @beta
|
|
96869
|
+
* [Api set: WordApiOnline 1.1]
|
|
97098
96870
|
*/
|
|
97099
96871
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
97100
96872
|
/**
|
|
97101
96873
|
* Represents the note item type: footnote or endnote.
|
|
97102
96874
|
*
|
|
97103
96875
|
* @remarks
|
|
97104
|
-
* [Api set: WordApiOnline
|
|
97105
|
-
* @beta
|
|
96876
|
+
* [Api set: WordApiOnline 1.1]
|
|
97106
96877
|
*/
|
|
97107
96878
|
type?: boolean;
|
|
97108
96879
|
}
|
|
@@ -97110,8 +96881,7 @@ declare namespace Word {
|
|
|
97110
96881
|
* Contains a collection of {@link Word.NoteItem} objects.
|
|
97111
96882
|
*
|
|
97112
96883
|
* @remarks
|
|
97113
|
-
* [Api set: WordApiOnline
|
|
97114
|
-
* @beta
|
|
96884
|
+
* [Api set: WordApiOnline 1.1]
|
|
97115
96885
|
*/
|
|
97116
96886
|
interface NoteItemCollectionLoadOptions {
|
|
97117
96887
|
/**
|
|
@@ -97119,27 +96889,24 @@ declare namespace Word {
|
|
|
97119
96889
|
*/
|
|
97120
96890
|
$all?: boolean;
|
|
97121
96891
|
/**
|
|
97122
|
-
* For EACH ITEM in the collection: Represents the body object of the note item. It
|
|
96892
|
+
* 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.
|
|
97123
96893
|
*
|
|
97124
96894
|
* @remarks
|
|
97125
|
-
* [Api set: WordApiOnline
|
|
97126
|
-
* @beta
|
|
96895
|
+
* [Api set: WordApiOnline 1.1]
|
|
97127
96896
|
*/
|
|
97128
96897
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
97129
96898
|
/**
|
|
97130
96899
|
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
97131
96900
|
*
|
|
97132
96901
|
* @remarks
|
|
97133
|
-
* [Api set: WordApiOnline
|
|
97134
|
-
* @beta
|
|
96902
|
+
* [Api set: WordApiOnline 1.1]
|
|
97135
96903
|
*/
|
|
97136
96904
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
97137
96905
|
/**
|
|
97138
96906
|
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
97139
96907
|
*
|
|
97140
96908
|
* @remarks
|
|
97141
|
-
* [Api set: WordApiOnline
|
|
97142
|
-
* @beta
|
|
96909
|
+
* [Api set: WordApiOnline 1.1]
|
|
97143
96910
|
*/
|
|
97144
96911
|
type?: boolean;
|
|
97145
96912
|
}
|