@types/office-js-preview 1.0.273 → 1.0.277
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 +336 -61
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Mon, 03 Jan 2022 21:01:38 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -337,6 +337,10 @@ declare namespace Office {
|
|
|
337
337
|
* Represents the add-in.
|
|
338
338
|
*/
|
|
339
339
|
const addin: Addin;
|
|
340
|
+
/**
|
|
341
|
+
* Represents the Auth interface.
|
|
342
|
+
*/
|
|
343
|
+
const auth: Auth;
|
|
340
344
|
/**
|
|
341
345
|
* Represents the ribbon associated with the Office application.
|
|
342
346
|
*/
|
|
@@ -1767,7 +1771,7 @@ declare namespace Office {
|
|
|
1767
1771
|
*/
|
|
1768
1772
|
interface GetFileOptions {
|
|
1769
1773
|
/**
|
|
1770
|
-
* The
|
|
1774
|
+
* The size of the slices in bytes. The maximum (and the default) is 4194304 (4MB).
|
|
1771
1775
|
*/
|
|
1772
1776
|
sliceSize?: number
|
|
1773
1777
|
/**
|
|
@@ -19735,6 +19739,12 @@ declare namespace Excel {
|
|
|
19735
19739
|
*/
|
|
19736
19740
|
formattedNumber = "FormattedNumber",
|
|
19737
19741
|
/**
|
|
19742
|
+
* Represents a `LinkedEntityCellValue`.
|
|
19743
|
+
*
|
|
19744
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19745
|
+
*/
|
|
19746
|
+
linkedEntity = "LinkedEntity",
|
|
19747
|
+
/**
|
|
19738
19748
|
* Represents a `StringCellValue`.
|
|
19739
19749
|
*
|
|
19740
19750
|
* @remarks
|
|
@@ -19766,7 +19776,7 @@ declare namespace Excel {
|
|
|
19766
19776
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19767
19777
|
* @beta
|
|
19768
19778
|
*/
|
|
19769
|
-
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue
|
|
19779
|
+
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
|
|
19770
19780
|
/**
|
|
19771
19781
|
* Represents whether this `CellValue` will be used to overwrite a cell.
|
|
19772
19782
|
* When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
|
|
@@ -20026,7 +20036,7 @@ declare namespace Excel {
|
|
|
20026
20036
|
*/
|
|
20027
20037
|
requestThrottle = "RequestThrottle",
|
|
20028
20038
|
/**
|
|
20029
|
-
* An error caused by external
|
|
20039
|
+
* An error caused by external links failing to refresh. Displays as error type #CONNECT! in Excel.
|
|
20030
20040
|
*
|
|
20031
20041
|
* @remarks
|
|
20032
20042
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -20635,6 +20645,91 @@ declare namespace Excel {
|
|
|
20635
20645
|
errorType?: ErrorCellValueType.gettingData | "GettingData";
|
|
20636
20646
|
}
|
|
20637
20647
|
/**
|
|
20648
|
+
* The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.
|
|
20649
|
+
*
|
|
20650
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20651
|
+
*/
|
|
20652
|
+
interface LinkedEntityId {
|
|
20653
|
+
/**
|
|
20654
|
+
* Represents which service was used to create the `CellValue`.
|
|
20655
|
+
*
|
|
20656
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20657
|
+
*/
|
|
20658
|
+
serviceId: number;
|
|
20659
|
+
/**
|
|
20660
|
+
* Represents a domain specific to a service used to create the `CellValue`.
|
|
20661
|
+
*
|
|
20662
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20663
|
+
*/
|
|
20664
|
+
domainId?: string;
|
|
20665
|
+
/**
|
|
20666
|
+
* Represents an identifier specific to a service used to create the `CellValue`.
|
|
20667
|
+
*
|
|
20668
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20669
|
+
*/
|
|
20670
|
+
entityId: string;
|
|
20671
|
+
/**
|
|
20672
|
+
* Represents which language culture was used to create this `CellValue`.
|
|
20673
|
+
*
|
|
20674
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20675
|
+
*/
|
|
20676
|
+
culture: string;
|
|
20677
|
+
}
|
|
20678
|
+
/**
|
|
20679
|
+
* Represents a value whose properties derive from a service.
|
|
20680
|
+
*
|
|
20681
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20682
|
+
*/
|
|
20683
|
+
interface LinkedEntityCellValue {
|
|
20684
|
+
/**
|
|
20685
|
+
* Represents the type of this cell value.
|
|
20686
|
+
*
|
|
20687
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20688
|
+
*/
|
|
20689
|
+
type: CellValueType.linkedEntity | "LinkedEntity";
|
|
20690
|
+
/**
|
|
20691
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20692
|
+
*
|
|
20693
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20694
|
+
*/
|
|
20695
|
+
basicValue?: "#VALUE!";
|
|
20696
|
+
/**
|
|
20697
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20698
|
+
*
|
|
20699
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20700
|
+
*/
|
|
20701
|
+
basicType?: RangeValueType.error | "Error";
|
|
20702
|
+
/**
|
|
20703
|
+
* Represents the service source that provided the information in this value.
|
|
20704
|
+
*
|
|
20705
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20706
|
+
*/
|
|
20707
|
+
id: LinkedEntityId;
|
|
20708
|
+
/**
|
|
20709
|
+
* Represents the text shown when a cell with this value is rendered.
|
|
20710
|
+
*
|
|
20711
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20712
|
+
*/
|
|
20713
|
+
text?: string;
|
|
20714
|
+
/**
|
|
20715
|
+
* Represents the properties of this entity and their metadata.
|
|
20716
|
+
*
|
|
20717
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20718
|
+
*/
|
|
20719
|
+
properties?: {
|
|
20720
|
+
[key: string]: CellValue & {
|
|
20721
|
+
propertyMetadata?: CellValuePropertyMetadata;
|
|
20722
|
+
};
|
|
20723
|
+
};
|
|
20724
|
+
/**
|
|
20725
|
+
* Represents information that describes the service which provided the image.
|
|
20726
|
+
* This information can be used for branding in entity cards.
|
|
20727
|
+
*
|
|
20728
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20729
|
+
*/
|
|
20730
|
+
provider?: CellValueProviderAttributes;
|
|
20731
|
+
}
|
|
20732
|
+
/**
|
|
20638
20733
|
* Represents the value of a cell containing a #N/A! error.
|
|
20639
20734
|
*
|
|
20640
20735
|
* @remarks
|
|
@@ -20885,7 +20980,19 @@ declare namespace Excel {
|
|
|
20885
20980
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20886
20981
|
* @beta
|
|
20887
20982
|
*/
|
|
20888
|
-
subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn"
|
|
20983
|
+
subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn",
|
|
20984
|
+
/**
|
|
20985
|
+
* An error caused by structured references from the linked workbook. Displays as error type #REF! in Excel.
|
|
20986
|
+
*
|
|
20987
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20988
|
+
*/
|
|
20989
|
+
externalLinksStructuredRef = "ExternalLinksStructuredRef",
|
|
20990
|
+
/**
|
|
20991
|
+
* An error caused by dynamic array references from the linked workbook. Displays as error type #REF! in Excel.
|
|
20992
|
+
*
|
|
20993
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20994
|
+
*/
|
|
20995
|
+
externalLinksArrayRef = "ExternalLinksArrayRef"
|
|
20889
20996
|
}
|
|
20890
20997
|
/**
|
|
20891
20998
|
* Represents the value of a cell containing a #REF! error.
|
|
@@ -20934,7 +21041,7 @@ declare namespace Excel {
|
|
|
20934
21041
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20935
21042
|
* @beta
|
|
20936
21043
|
*/
|
|
20937
|
-
errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn";
|
|
21044
|
+
errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn" | "ExternalLinksStructuredRef" | "ExternalLinksArrayRef";
|
|
20938
21045
|
}
|
|
20939
21046
|
/**
|
|
20940
21047
|
* Represents types of #SPILL! errors.
|
|
@@ -21164,7 +21271,7 @@ declare namespace Excel {
|
|
|
21164
21271
|
*/
|
|
21165
21272
|
coerceStringToBoolInvalid = "CoerceStringToBoolInvalid",
|
|
21166
21273
|
/**
|
|
21167
|
-
* An error caused by
|
|
21274
|
+
* An error caused by conversion of a string to a type other than a boolean or number. Displays as error type #VALUE! in Excel.
|
|
21168
21275
|
*
|
|
21169
21276
|
* @remarks
|
|
21170
21277
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -27421,6 +27528,16 @@ declare namespace Excel {
|
|
|
27421
27528
|
* [Api set: ExcelApi 1.9]
|
|
27422
27529
|
*/
|
|
27423
27530
|
getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;
|
|
27531
|
+
/**
|
|
27532
|
+
* Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.
|
|
27533
|
+
*
|
|
27534
|
+
* @remarks
|
|
27535
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27536
|
+
* @beta
|
|
27537
|
+
*
|
|
27538
|
+
* @param linkedEntityCellValueId An identifier that specifies an individual `LinkedEntityCellValue`.
|
|
27539
|
+
*/
|
|
27540
|
+
getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;
|
|
27424
27541
|
/**
|
|
27425
27542
|
* Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error.
|
|
27426
27543
|
*
|
|
@@ -27488,7 +27605,7 @@ declare namespace Excel {
|
|
|
27488
27605
|
expand?: string;
|
|
27489
27606
|
}): Excel.Workbook;
|
|
27490
27607
|
/**
|
|
27491
|
-
* Occurs when the
|
|
27608
|
+
* Occurs when the workbook is activated. Note: This event will not fire when the workbook is opened.
|
|
27492
27609
|
*
|
|
27493
27610
|
* @remarks
|
|
27494
27611
|
* [Api set: ExcelApi 1.13]
|
|
@@ -29977,7 +30094,7 @@ declare namespace Excel {
|
|
|
29977
30094
|
*/
|
|
29978
30095
|
readonly dataValidation: Excel.DataValidation;
|
|
29979
30096
|
/**
|
|
29980
|
-
* Returns a `RangeFormat` object, encapsulating the
|
|
30097
|
+
* Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.
|
|
29981
30098
|
*
|
|
29982
30099
|
* @remarks
|
|
29983
30100
|
* [Api set: ExcelApi 1.9]
|
|
@@ -42522,7 +42639,7 @@ declare namespace Excel {
|
|
|
42522
42639
|
type: Excel.ConditionalTopBottomCriterionType | "Invalid" | "TopItems" | "TopPercent" | "BottomItems" | "BottomPercent";
|
|
42523
42640
|
}
|
|
42524
42641
|
/**
|
|
42525
|
-
* Represents the
|
|
42642
|
+
* Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.
|
|
42526
42643
|
*
|
|
42527
42644
|
* @remarks
|
|
42528
42645
|
* [Api set: ExcelApi 1.6]
|
|
@@ -59121,7 +59238,7 @@ declare namespace Excel {
|
|
|
59121
59238
|
*/
|
|
59122
59239
|
dataValidation?: Excel.Interfaces.DataValidationUpdateData;
|
|
59123
59240
|
/**
|
|
59124
|
-
* Returns a `RangeFormat` object, encapsulating the
|
|
59241
|
+
* Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.
|
|
59125
59242
|
*
|
|
59126
59243
|
* @remarks
|
|
59127
59244
|
* [Api set: ExcelApi 1.9]
|
|
@@ -64800,7 +64917,7 @@ declare namespace Excel {
|
|
|
64800
64917
|
*/
|
|
64801
64918
|
dataValidation?: Excel.Interfaces.DataValidationData;
|
|
64802
64919
|
/**
|
|
64803
|
-
* Returns a `RangeFormat` object, encapsulating the
|
|
64920
|
+
* Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.
|
|
64804
64921
|
*
|
|
64805
64922
|
* @remarks
|
|
64806
64923
|
* [Api set: ExcelApi 1.9]
|
|
@@ -72163,7 +72280,7 @@ declare namespace Excel {
|
|
|
72163
72280
|
*/
|
|
72164
72281
|
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;
|
|
72165
72282
|
/**
|
|
72166
|
-
* Returns a `RangeFormat` object, encapsulating the
|
|
72283
|
+
* Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.
|
|
72167
72284
|
*
|
|
72168
72285
|
* @remarks
|
|
72169
72286
|
* [Api set: ExcelApi 1.9]
|
|
@@ -78974,7 +79091,7 @@ declare namespace Excel {
|
|
|
78974
79091
|
rule?: boolean;
|
|
78975
79092
|
}
|
|
78976
79093
|
/**
|
|
78977
|
-
* Represents the
|
|
79094
|
+
* Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.
|
|
78978
79095
|
*
|
|
78979
79096
|
* @remarks
|
|
78980
79097
|
* [Api set: ExcelApi 1.6]
|
|
@@ -80373,7 +80490,7 @@ declare namespace Excel {
|
|
|
80373
80490
|
*/
|
|
80374
80491
|
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;
|
|
80375
80492
|
/**
|
|
80376
|
-
* For EACH ITEM in the collection: Returns a `RangeFormat` object, encapsulating the
|
|
80493
|
+
* For EACH ITEM in the collection: Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.
|
|
80377
80494
|
*
|
|
80378
80495
|
* @remarks
|
|
80379
80496
|
* [Api set: ExcelApi 1.9]
|
|
@@ -82393,7 +82510,7 @@ declare namespace Word {
|
|
|
82393
82510
|
*/
|
|
82394
82511
|
readonly contentControls: Word.ContentControlCollection;
|
|
82395
82512
|
/**
|
|
82396
|
-
* Gets the collection of endnotes in the body. Read-only
|
|
82513
|
+
* Gets the collection of endnotes in the body. Read-only.
|
|
82397
82514
|
*
|
|
82398
82515
|
* @remarks
|
|
82399
82516
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -82408,7 +82525,7 @@ declare namespace Word {
|
|
|
82408
82525
|
*/
|
|
82409
82526
|
readonly font: Word.Font;
|
|
82410
82527
|
/**
|
|
82411
|
-
* Gets the collection of footnotes in the body. Read-only
|
|
82528
|
+
* Gets the collection of footnotes in the body. Read-only.
|
|
82412
82529
|
*
|
|
82413
82530
|
* @remarks
|
|
82414
82531
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -82571,6 +82688,26 @@ declare namespace Word {
|
|
|
82571
82688
|
* @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
82572
82689
|
*/
|
|
82573
82690
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
82691
|
+
/**
|
|
82692
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
82693
|
+
*
|
|
82694
|
+
* @remarks
|
|
82695
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
82696
|
+
* @beta
|
|
82697
|
+
*
|
|
82698
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
|
|
82699
|
+
*/
|
|
82700
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
82701
|
+
/**
|
|
82702
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
82703
|
+
*
|
|
82704
|
+
* @remarks
|
|
82705
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
82706
|
+
* @beta
|
|
82707
|
+
*
|
|
82708
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
|
|
82709
|
+
*/
|
|
82710
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
82574
82711
|
/**
|
|
82575
82712
|
* Inserts a break at the specified location in the main document.
|
|
82576
82713
|
*
|
|
@@ -83216,7 +83353,7 @@ declare namespace Word {
|
|
|
83216
83353
|
*/
|
|
83217
83354
|
readonly contentControls: Word.ContentControlCollection;
|
|
83218
83355
|
/**
|
|
83219
|
-
* Gets the collection of endnotes in the contentcontrol. Read-only
|
|
83356
|
+
* Gets the collection of endnotes in the contentcontrol. Read-only.
|
|
83220
83357
|
*
|
|
83221
83358
|
* @remarks
|
|
83222
83359
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -83231,7 +83368,7 @@ declare namespace Word {
|
|
|
83231
83368
|
*/
|
|
83232
83369
|
readonly font: Word.Font;
|
|
83233
83370
|
/**
|
|
83234
|
-
* Gets the collection of footnotes in the contentcontrol. Read-only
|
|
83371
|
+
* Gets the collection of footnotes in the contentcontrol. Read-only.
|
|
83235
83372
|
*
|
|
83236
83373
|
* @remarks
|
|
83237
83374
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -83482,6 +83619,26 @@ declare namespace Word {
|
|
|
83482
83619
|
* @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
83483
83620
|
*/
|
|
83484
83621
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
83622
|
+
/**
|
|
83623
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83624
|
+
*
|
|
83625
|
+
* @remarks
|
|
83626
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
83627
|
+
* @beta
|
|
83628
|
+
*
|
|
83629
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
83630
|
+
*/
|
|
83631
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
83632
|
+
/**
|
|
83633
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
83634
|
+
*
|
|
83635
|
+
* @remarks
|
|
83636
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
83637
|
+
* @beta
|
|
83638
|
+
*
|
|
83639
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
83640
|
+
*/
|
|
83641
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
83485
83642
|
/**
|
|
83486
83643
|
* Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
|
|
83487
83644
|
*
|
|
@@ -84513,14 +84670,14 @@ declare namespace Word {
|
|
|
84513
84670
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
84514
84671
|
context: RequestContext;
|
|
84515
84672
|
/**
|
|
84516
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
84673
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
|
|
84517
84674
|
*
|
|
84518
84675
|
* @remarks
|
|
84519
84676
|
* [Api set: WordApi 1.1]
|
|
84520
84677
|
*/
|
|
84521
84678
|
readonly body: Word.Body;
|
|
84522
84679
|
/**
|
|
84523
|
-
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc
|
|
84680
|
+
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. Read-only.
|
|
84524
84681
|
*
|
|
84525
84682
|
* @remarks
|
|
84526
84683
|
* [Api set: WordApi 1.1]
|
|
@@ -84556,6 +84713,14 @@ declare namespace Word {
|
|
|
84556
84713
|
* @beta
|
|
84557
84714
|
*/
|
|
84558
84715
|
readonly settings: Word.SettingCollection;
|
|
84716
|
+
/**
|
|
84717
|
+
* Gets or sets the ChangeTracking mode.
|
|
84718
|
+
*
|
|
84719
|
+
* @remarks
|
|
84720
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
84721
|
+
* @beta
|
|
84722
|
+
*/
|
|
84723
|
+
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
84559
84724
|
/**
|
|
84560
84725
|
* 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.
|
|
84561
84726
|
*
|
|
@@ -84602,7 +84767,8 @@ declare namespace Word {
|
|
|
84602
84767
|
*/
|
|
84603
84768
|
getBookmarkRangeOrNullObject(name: string): Word.Range;
|
|
84604
84769
|
/**
|
|
84605
|
-
* Gets the
|
|
84770
|
+
* Gets the document's endnotes in a single body. Read-only.
|
|
84771
|
+
Not implemented in Word on the web.
|
|
84606
84772
|
*
|
|
84607
84773
|
* @remarks
|
|
84608
84774
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -84610,7 +84776,8 @@ declare namespace Word {
|
|
|
84610
84776
|
*/
|
|
84611
84777
|
getEndnoteBody(): Word.Body;
|
|
84612
84778
|
/**
|
|
84613
|
-
* Gets the
|
|
84779
|
+
* Gets the document's footnotes in a single body. Read-only.
|
|
84780
|
+
Not implemented in Word on the web.
|
|
84614
84781
|
*
|
|
84615
84782
|
* @remarks
|
|
84616
84783
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -84632,7 +84799,7 @@ declare namespace Word {
|
|
|
84632
84799
|
*/
|
|
84633
84800
|
save(): void;
|
|
84634
84801
|
/**
|
|
84635
|
-
* Performs a search with the specified
|
|
84802
|
+
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
84636
84803
|
*
|
|
84637
84804
|
* @remarks
|
|
84638
84805
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86008,7 +86175,7 @@ declare namespace Word {
|
|
|
86008
86175
|
*/
|
|
86009
86176
|
readonly body: Word.Body;
|
|
86010
86177
|
/**
|
|
86011
|
-
* Represents a footnote
|
|
86178
|
+
* Represents a footnote or endnote reference in the main document.
|
|
86012
86179
|
*
|
|
86013
86180
|
* @remarks
|
|
86014
86181
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86016,7 +86183,7 @@ declare namespace Word {
|
|
|
86016
86183
|
*/
|
|
86017
86184
|
readonly reference: Word.Range;
|
|
86018
86185
|
/**
|
|
86019
|
-
*
|
|
86186
|
+
* Represents the note item type: footnote or endnote.
|
|
86020
86187
|
*
|
|
86021
86188
|
* @remarks
|
|
86022
86189
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86167,7 +86334,7 @@ declare namespace Word {
|
|
|
86167
86334
|
*/
|
|
86168
86335
|
readonly contentControls: Word.ContentControlCollection;
|
|
86169
86336
|
/**
|
|
86170
|
-
* Gets the collection of endnotes in the
|
|
86337
|
+
* Gets the collection of endnotes in the paragraph. Read-only.
|
|
86171
86338
|
*
|
|
86172
86339
|
* @remarks
|
|
86173
86340
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86182,7 +86349,7 @@ declare namespace Word {
|
|
|
86182
86349
|
*/
|
|
86183
86350
|
readonly font: Word.Font;
|
|
86184
86351
|
/**
|
|
86185
|
-
* Gets the collection of footnotes in the
|
|
86352
|
+
* Gets the collection of footnotes in the paragraph. Read-only.
|
|
86186
86353
|
*
|
|
86187
86354
|
* @remarks
|
|
86188
86355
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86492,6 +86659,26 @@ declare namespace Word {
|
|
|
86492
86659
|
* @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
86493
86660
|
*/
|
|
86494
86661
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
86662
|
+
/**
|
|
86663
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
86664
|
+
*
|
|
86665
|
+
* @remarks
|
|
86666
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
86667
|
+
* @beta
|
|
86668
|
+
*
|
|
86669
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
86670
|
+
*/
|
|
86671
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
86672
|
+
/**
|
|
86673
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
86674
|
+
*
|
|
86675
|
+
* @remarks
|
|
86676
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
86677
|
+
* @beta
|
|
86678
|
+
*
|
|
86679
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
86680
|
+
*/
|
|
86681
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
86495
86682
|
/**
|
|
86496
86683
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
86497
86684
|
*
|
|
@@ -86850,7 +87037,7 @@ declare namespace Word {
|
|
|
86850
87037
|
*/
|
|
86851
87038
|
readonly contentControls: Word.ContentControlCollection;
|
|
86852
87039
|
/**
|
|
86853
|
-
* Gets the collection of endnotes in the
|
|
87040
|
+
* Gets the collection of endnotes in the range. Read-only.
|
|
86854
87041
|
*
|
|
86855
87042
|
* @remarks
|
|
86856
87043
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -86865,7 +87052,7 @@ declare namespace Word {
|
|
|
86865
87052
|
*/
|
|
86866
87053
|
readonly font: Word.Font;
|
|
86867
87054
|
/**
|
|
86868
|
-
* Gets the collection of footnotes in the
|
|
87055
|
+
* Gets the collection of footnotes in the range. Read-only.
|
|
86869
87056
|
*
|
|
86870
87057
|
* @remarks
|
|
86871
87058
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -87115,6 +87302,26 @@ declare namespace Word {
|
|
|
87115
87302
|
* @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
87116
87303
|
*/
|
|
87117
87304
|
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
87305
|
+
/**
|
|
87306
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87307
|
+
*
|
|
87308
|
+
* @remarks
|
|
87309
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
87310
|
+
* @beta
|
|
87311
|
+
*
|
|
87312
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
87313
|
+
*/
|
|
87314
|
+
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
87315
|
+
/**
|
|
87316
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
87317
|
+
*
|
|
87318
|
+
* @remarks
|
|
87319
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
87320
|
+
* @beta
|
|
87321
|
+
*
|
|
87322
|
+
* @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
|
|
87323
|
+
*/
|
|
87324
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
87118
87325
|
/**
|
|
87119
87326
|
* Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
|
|
87120
87327
|
*
|
|
@@ -87934,7 +88141,7 @@ declare namespace Word {
|
|
|
87934
88141
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
87935
88142
|
context: RequestContext;
|
|
87936
88143
|
/**
|
|
87937
|
-
* Gets the collection of endnotes in the table. Read-only
|
|
88144
|
+
* Gets the collection of endnotes in the table. Read-only.
|
|
87938
88145
|
*
|
|
87939
88146
|
* @remarks
|
|
87940
88147
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -87949,7 +88156,7 @@ declare namespace Word {
|
|
|
87949
88156
|
*/
|
|
87950
88157
|
readonly font: Word.Font;
|
|
87951
88158
|
/**
|
|
87952
|
-
* Gets the collection of footnotes in the table. Read-only
|
|
88159
|
+
* Gets the collection of footnotes in the table. Read-only.
|
|
87953
88160
|
*
|
|
87954
88161
|
* @remarks
|
|
87955
88162
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -88583,7 +88790,7 @@ declare namespace Word {
|
|
|
88583
88790
|
*/
|
|
88584
88791
|
readonly cells: Word.TableCellCollection;
|
|
88585
88792
|
/**
|
|
88586
|
-
* Gets the collection of endnotes in the table row. Read-only
|
|
88793
|
+
* Gets the collection of endnotes in the table row. Read-only.
|
|
88587
88794
|
*
|
|
88588
88795
|
* @remarks
|
|
88589
88796
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -88598,7 +88805,7 @@ declare namespace Word {
|
|
|
88598
88805
|
*/
|
|
88599
88806
|
readonly font: Word.Font;
|
|
88600
88807
|
/**
|
|
88601
|
-
* Gets the collection of footnotes in the table row. Read-only
|
|
88808
|
+
* Gets the collection of footnotes in the table row. Read-only.
|
|
88602
88809
|
*
|
|
88603
88810
|
* @remarks
|
|
88604
88811
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -89324,6 +89531,50 @@ declare namespace Word {
|
|
|
89324
89531
|
*/
|
|
89325
89532
|
toJSON(): Word.Interfaces.TableBorderData;
|
|
89326
89533
|
}
|
|
89534
|
+
/**
|
|
89535
|
+
* ChangeTracking mode.
|
|
89536
|
+
*
|
|
89537
|
+
* @remarks
|
|
89538
|
+
* [Api set: WordApi]
|
|
89539
|
+
*/
|
|
89540
|
+
enum ChangeTrackingMode {
|
|
89541
|
+
/**
|
|
89542
|
+
* ChangeTracking is turned off.
|
|
89543
|
+
* @remarks
|
|
89544
|
+
* [Api set: WordApi]
|
|
89545
|
+
*/
|
|
89546
|
+
off = "Off",
|
|
89547
|
+
/**
|
|
89548
|
+
* ChangeTracking is turned on for everyone.
|
|
89549
|
+
* @remarks
|
|
89550
|
+
* [Api set: WordApi]
|
|
89551
|
+
*/
|
|
89552
|
+
trackAll = "TrackAll",
|
|
89553
|
+
/**
|
|
89554
|
+
* Tracking is turned on for my changes only.
|
|
89555
|
+
* @remarks
|
|
89556
|
+
* [Api set: WordApi]
|
|
89557
|
+
*/
|
|
89558
|
+
trackMineOnly = "TrackMineOnly",
|
|
89559
|
+
}
|
|
89560
|
+
/**
|
|
89561
|
+
* Specify the current version or the original version of the document.
|
|
89562
|
+
*
|
|
89563
|
+
* @remarks
|
|
89564
|
+
* [Api set: WordApi]
|
|
89565
|
+
*/
|
|
89566
|
+
enum ChangeTrackingVersion {
|
|
89567
|
+
/**
|
|
89568
|
+
* @remarks
|
|
89569
|
+
* [Api set: WordApi]
|
|
89570
|
+
*/
|
|
89571
|
+
original = "Original",
|
|
89572
|
+
/**
|
|
89573
|
+
* @remarks
|
|
89574
|
+
* [Api set: WordApi]
|
|
89575
|
+
*/
|
|
89576
|
+
current = "Current",
|
|
89577
|
+
}
|
|
89327
89578
|
/**
|
|
89328
89579
|
* Note item type
|
|
89329
89580
|
*
|
|
@@ -91492,7 +91743,7 @@ declare namespace Word {
|
|
|
91492
91743
|
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
91493
91744
|
interface DocumentUpdateData {
|
|
91494
91745
|
/**
|
|
91495
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
91746
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
91496
91747
|
*
|
|
91497
91748
|
* @remarks
|
|
91498
91749
|
* [Api set: WordApi 1.1]
|
|
@@ -91505,6 +91756,14 @@ declare namespace Word {
|
|
|
91505
91756
|
* [Api set: WordApi 1.3]
|
|
91506
91757
|
*/
|
|
91507
91758
|
properties?: Word.Interfaces.DocumentPropertiesUpdateData;
|
|
91759
|
+
/**
|
|
91760
|
+
* Gets or sets the ChangeTracking mode.
|
|
91761
|
+
*
|
|
91762
|
+
* @remarks
|
|
91763
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
91764
|
+
* @beta
|
|
91765
|
+
*/
|
|
91766
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
91508
91767
|
}
|
|
91509
91768
|
/** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
|
|
91510
91769
|
interface DocumentCreatedUpdateData {
|
|
@@ -91744,7 +92003,7 @@ declare namespace Word {
|
|
|
91744
92003
|
*/
|
|
91745
92004
|
body?: Word.Interfaces.BodyUpdateData;
|
|
91746
92005
|
/**
|
|
91747
|
-
* Represents a footnote
|
|
92006
|
+
* Represents a footnote or endnote reference in the main document.
|
|
91748
92007
|
*
|
|
91749
92008
|
* @remarks
|
|
91750
92009
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -92614,14 +92873,14 @@ declare namespace Word {
|
|
|
92614
92873
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
92615
92874
|
interface DocumentData {
|
|
92616
92875
|
/**
|
|
92617
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
92876
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
|
|
92618
92877
|
*
|
|
92619
92878
|
* @remarks
|
|
92620
92879
|
* [Api set: WordApi 1.1]
|
|
92621
92880
|
*/
|
|
92622
92881
|
body?: Word.Interfaces.BodyData;
|
|
92623
92882
|
/**
|
|
92624
|
-
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc
|
|
92883
|
+
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. Read-only.
|
|
92625
92884
|
*
|
|
92626
92885
|
* @remarks
|
|
92627
92886
|
* [Api set: WordApi 1.1]
|
|
@@ -92657,6 +92916,14 @@ declare namespace Word {
|
|
|
92657
92916
|
* @beta
|
|
92658
92917
|
*/
|
|
92659
92918
|
settings?: Word.Interfaces.SettingData[];
|
|
92919
|
+
/**
|
|
92920
|
+
* Gets or sets the ChangeTracking mode.
|
|
92921
|
+
*
|
|
92922
|
+
* @remarks
|
|
92923
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
92924
|
+
* @beta
|
|
92925
|
+
*/
|
|
92926
|
+
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
|
|
92660
92927
|
/**
|
|
92661
92928
|
* 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.
|
|
92662
92929
|
*
|
|
@@ -93056,7 +93323,7 @@ declare namespace Word {
|
|
|
93056
93323
|
*/
|
|
93057
93324
|
body?: Word.Interfaces.BodyData;
|
|
93058
93325
|
/**
|
|
93059
|
-
* Represents a footnote
|
|
93326
|
+
* Represents a footnote or endnote reference in the main document.
|
|
93060
93327
|
*
|
|
93061
93328
|
* @remarks
|
|
93062
93329
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -93064,7 +93331,7 @@ declare namespace Word {
|
|
|
93064
93331
|
*/
|
|
93065
93332
|
reference?: Word.Interfaces.RangeData;
|
|
93066
93333
|
/**
|
|
93067
|
-
*
|
|
93334
|
+
* Represents the note item type: footnote or endnote.
|
|
93068
93335
|
*
|
|
93069
93336
|
* @remarks
|
|
93070
93337
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -94516,7 +94783,7 @@ declare namespace Word {
|
|
|
94516
94783
|
*/
|
|
94517
94784
|
$all?: boolean;
|
|
94518
94785
|
/**
|
|
94519
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
94786
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
94520
94787
|
*
|
|
94521
94788
|
* @remarks
|
|
94522
94789
|
* [Api set: WordApi 1.1]
|
|
@@ -94529,6 +94796,14 @@ declare namespace Word {
|
|
|
94529
94796
|
* [Api set: WordApi 1.3]
|
|
94530
94797
|
*/
|
|
94531
94798
|
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
|
|
94799
|
+
/**
|
|
94800
|
+
* Gets or sets the ChangeTracking mode.
|
|
94801
|
+
*
|
|
94802
|
+
* @remarks
|
|
94803
|
+
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
94804
|
+
* @beta
|
|
94805
|
+
*/
|
|
94806
|
+
changeTrackingMode?: boolean;
|
|
94532
94807
|
/**
|
|
94533
94808
|
* 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.
|
|
94534
94809
|
*
|
|
@@ -95133,7 +95408,7 @@ declare namespace Word {
|
|
|
95133
95408
|
*/
|
|
95134
95409
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
95135
95410
|
/**
|
|
95136
|
-
* Represents a footnote
|
|
95411
|
+
* Represents a footnote or endnote reference in the main document.
|
|
95137
95412
|
*
|
|
95138
95413
|
* @remarks
|
|
95139
95414
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -95141,7 +95416,7 @@ declare namespace Word {
|
|
|
95141
95416
|
*/
|
|
95142
95417
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
95143
95418
|
/**
|
|
95144
|
-
*
|
|
95419
|
+
* Represents the note item type: footnote or endnote.
|
|
95145
95420
|
*
|
|
95146
95421
|
* @remarks
|
|
95147
95422
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -95170,7 +95445,7 @@ declare namespace Word {
|
|
|
95170
95445
|
*/
|
|
95171
95446
|
body?: Word.Interfaces.BodyLoadOptions;
|
|
95172
95447
|
/**
|
|
95173
|
-
* For EACH ITEM in the collection: Represents a footnote
|
|
95448
|
+
* For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
|
|
95174
95449
|
*
|
|
95175
95450
|
* @remarks
|
|
95176
95451
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -95178,7 +95453,7 @@ declare namespace Word {
|
|
|
95178
95453
|
*/
|
|
95179
95454
|
reference?: Word.Interfaces.RangeLoadOptions;
|
|
95180
95455
|
/**
|
|
95181
|
-
* For EACH ITEM in the collection:
|
|
95456
|
+
* For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
|
|
95182
95457
|
*
|
|
95183
95458
|
* @remarks
|
|
95184
95459
|
* [Api set: WordApiOnline BETA (PREVIEW ONLY)]
|
|
@@ -97884,14 +98159,14 @@ declare namespace OneNote {
|
|
|
97884
98159
|
*/
|
|
97885
98160
|
readonly sectionGroups: OneNote.SectionGroupCollection;
|
|
97886
98161
|
/**
|
|
97887
|
-
* The
|
|
98162
|
+
* The sections of the notebook. Read only
|
|
97888
98163
|
*
|
|
97889
98164
|
* @remarks
|
|
97890
98165
|
* [Api set: OneNoteApi 1.1]
|
|
97891
98166
|
*/
|
|
97892
98167
|
readonly sections: OneNote.SectionCollection;
|
|
97893
98168
|
/**
|
|
97894
|
-
* The url of the site
|
|
98169
|
+
* The url of the site where this notebook is located. Read only
|
|
97895
98170
|
*
|
|
97896
98171
|
* @remarks
|
|
97897
98172
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -97912,7 +98187,7 @@ declare namespace OneNote {
|
|
|
97912
98187
|
*/
|
|
97913
98188
|
readonly id: string;
|
|
97914
98189
|
/**
|
|
97915
|
-
* True if the
|
|
98190
|
+
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
|
|
97916
98191
|
*
|
|
97917
98192
|
* @remarks
|
|
97918
98193
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -98526,7 +98801,7 @@ declare namespace OneNote {
|
|
|
98526
98801
|
*/
|
|
98527
98802
|
readonly contents: OneNote.PageContentCollection;
|
|
98528
98803
|
/**
|
|
98529
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
98804
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
98530
98805
|
*
|
|
98531
98806
|
* @remarks
|
|
98532
98807
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -101028,7 +101303,7 @@ declare namespace OneNote {
|
|
|
101028
101303
|
/** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
|
|
101029
101304
|
interface PageUpdateData {
|
|
101030
101305
|
/**
|
|
101031
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
101306
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
101032
101307
|
*
|
|
101033
101308
|
* @remarks
|
|
101034
101309
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -101378,14 +101653,14 @@ declare namespace OneNote {
|
|
|
101378
101653
|
*/
|
|
101379
101654
|
sectionGroups?: OneNote.Interfaces.SectionGroupData[];
|
|
101380
101655
|
/**
|
|
101381
|
-
* The
|
|
101656
|
+
* The sections of the notebook. Read only
|
|
101382
101657
|
*
|
|
101383
101658
|
* @remarks
|
|
101384
101659
|
* [Api set: OneNoteApi 1.1]
|
|
101385
101660
|
*/
|
|
101386
101661
|
sections?: OneNote.Interfaces.SectionData[];
|
|
101387
101662
|
/**
|
|
101388
|
-
* The url of the site
|
|
101663
|
+
* The url of the site where this notebook is located. Read only
|
|
101389
101664
|
*
|
|
101390
101665
|
* @remarks
|
|
101391
101666
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -101406,7 +101681,7 @@ declare namespace OneNote {
|
|
|
101406
101681
|
*/
|
|
101407
101682
|
id?: string;
|
|
101408
101683
|
/**
|
|
101409
|
-
* True if the
|
|
101684
|
+
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
|
|
101410
101685
|
*
|
|
101411
101686
|
* @remarks
|
|
101412
101687
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -101532,7 +101807,7 @@ declare namespace OneNote {
|
|
|
101532
101807
|
*/
|
|
101533
101808
|
contents?: OneNote.Interfaces.PageContentData[];
|
|
101534
101809
|
/**
|
|
101535
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
101810
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
101536
101811
|
*
|
|
101537
101812
|
* @remarks
|
|
101538
101813
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -102432,14 +102707,14 @@ declare namespace OneNote {
|
|
|
102432
102707
|
*/
|
|
102433
102708
|
sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
|
|
102434
102709
|
/**
|
|
102435
|
-
* The
|
|
102710
|
+
* The sections of the notebook. Read only
|
|
102436
102711
|
*
|
|
102437
102712
|
* @remarks
|
|
102438
102713
|
* [Api set: OneNoteApi 1.1]
|
|
102439
102714
|
*/
|
|
102440
102715
|
sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
|
|
102441
102716
|
/**
|
|
102442
|
-
* The url of the site
|
|
102717
|
+
* The url of the site where this notebook is located. Read only
|
|
102443
102718
|
*
|
|
102444
102719
|
* @remarks
|
|
102445
102720
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -102460,7 +102735,7 @@ declare namespace OneNote {
|
|
|
102460
102735
|
*/
|
|
102461
102736
|
id?: boolean;
|
|
102462
102737
|
/**
|
|
102463
|
-
* True if the
|
|
102738
|
+
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
|
|
102464
102739
|
*
|
|
102465
102740
|
* @remarks
|
|
102466
102741
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -102493,14 +102768,14 @@ declare namespace OneNote {
|
|
|
102493
102768
|
*/
|
|
102494
102769
|
sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
|
|
102495
102770
|
/**
|
|
102496
|
-
* For EACH ITEM in the collection: The
|
|
102771
|
+
* For EACH ITEM in the collection: The sections of the notebook. Read only
|
|
102497
102772
|
*
|
|
102498
102773
|
* @remarks
|
|
102499
102774
|
* [Api set: OneNoteApi 1.1]
|
|
102500
102775
|
*/
|
|
102501
102776
|
sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
|
|
102502
102777
|
/**
|
|
102503
|
-
* For EACH ITEM in the collection: The url of the site
|
|
102778
|
+
* For EACH ITEM in the collection: The url of the site where this notebook is located. Read only
|
|
102504
102779
|
*
|
|
102505
102780
|
* @remarks
|
|
102506
102781
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -102521,7 +102796,7 @@ declare namespace OneNote {
|
|
|
102521
102796
|
*/
|
|
102522
102797
|
id?: boolean;
|
|
102523
102798
|
/**
|
|
102524
|
-
* For EACH ITEM in the collection: True if the
|
|
102799
|
+
* For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
|
|
102525
102800
|
*
|
|
102526
102801
|
* @remarks
|
|
102527
102802
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -102854,7 +103129,7 @@ declare namespace OneNote {
|
|
|
102854
103129
|
*/
|
|
102855
103130
|
contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
|
|
102856
103131
|
/**
|
|
102857
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
103132
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
102858
103133
|
*
|
|
102859
103134
|
* @remarks
|
|
102860
103135
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -102929,7 +103204,7 @@ declare namespace OneNote {
|
|
|
102929
103204
|
*/
|
|
102930
103205
|
contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
|
|
102931
103206
|
/**
|
|
102932
|
-
* For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
103207
|
+
* For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
102933
103208
|
*
|
|
102934
103209
|
* @remarks
|
|
102935
103210
|
* [Api set: OneNoteApi 1.1]
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.277",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
43
|
+
"typesPublisherContentHash": "48047cad490905a3955f7ba347135403a11e79dfdee70add88882ec38ce9b9e7",
|
|
44
44
|
"typeScriptVersion": "3.8"
|
|
45
45
|
}
|