@types/office-js 1.0.225 → 1.0.229
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +90 -83
- office-js/package.json +2 -2
office-js/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.
|
|
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/index.d.ts
CHANGED
|
@@ -334,13 +334,19 @@ declare namespace Office {
|
|
|
334
334
|
*/
|
|
335
335
|
const addin: Addin;
|
|
336
336
|
/**
|
|
337
|
-
* Represents the Auth interface
|
|
337
|
+
* Represents the Auth interface.
|
|
338
338
|
*/
|
|
339
339
|
const auth: Auth;
|
|
340
340
|
/**
|
|
341
341
|
* Represents the ribbon associated with the Office application.
|
|
342
342
|
*/
|
|
343
343
|
const ribbon: Ribbon;
|
|
344
|
+
/**
|
|
345
|
+
* Checks if the specified requirement set is supported by the host Office application.
|
|
346
|
+
* @param name - Set name; e.g., "MatrixBindings".
|
|
347
|
+
* @param minVersion - The minimum required version; e.g., "1.4".
|
|
348
|
+
*/
|
|
349
|
+
function isSetSupported(name: string, minVersion?: string): boolean;
|
|
344
350
|
// Enumerations
|
|
345
351
|
/**
|
|
346
352
|
* Provides options to determine the startup behavior of the add-in upon next start-up.
|
|
@@ -19522,7 +19528,7 @@ declare namespace Excel {
|
|
|
19522
19528
|
*/
|
|
19523
19529
|
getItem(key: string): Excel.LinkedWorkbook;
|
|
19524
19530
|
/**
|
|
19525
|
-
* Gets information about a linked workbook by its URL. If the workbook does not exist, then this
|
|
19531
|
+
* Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
19526
19532
|
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}.
|
|
19527
19533
|
*
|
|
19528
19534
|
* @remarks
|
|
@@ -22097,7 +22103,7 @@ declare namespace Excel {
|
|
|
22097
22103
|
*/
|
|
22098
22104
|
getActiveChart(): Excel.Chart;
|
|
22099
22105
|
/**
|
|
22100
|
-
* Gets the currently active chart in the workbook. If there is no active chart, then this
|
|
22106
|
+
* Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22101
22107
|
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}.
|
|
22102
22108
|
*
|
|
22103
22109
|
* @remarks
|
|
@@ -22112,7 +22118,7 @@ declare namespace Excel {
|
|
|
22112
22118
|
*/
|
|
22113
22119
|
getActiveSlicer(): Excel.Slicer;
|
|
22114
22120
|
/**
|
|
22115
|
-
* Gets the currently active slicer in the workbook. If there is no active slicer, then this
|
|
22121
|
+
* Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22116
22122
|
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}.
|
|
22117
22123
|
*
|
|
22118
22124
|
* @remarks
|
|
@@ -22609,7 +22615,7 @@ declare namespace Excel {
|
|
|
22609
22615
|
*/
|
|
22610
22616
|
getNext(visibleOnly?: boolean): Excel.Worksheet;
|
|
22611
22617
|
/**
|
|
22612
|
-
* Gets the worksheet that follows this one. If there are no worksheets following this one, then this method
|
|
22618
|
+
* Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22613
22619
|
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}.
|
|
22614
22620
|
*
|
|
22615
22621
|
* @remarks
|
|
@@ -22628,7 +22634,7 @@ declare namespace Excel {
|
|
|
22628
22634
|
*/
|
|
22629
22635
|
getPrevious(visibleOnly?: boolean): Excel.Worksheet;
|
|
22630
22636
|
/**
|
|
22631
|
-
* Gets the worksheet that precedes this one. If there are no previous worksheets, then this method
|
|
22637
|
+
* Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22632
22638
|
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}.
|
|
22633
22639
|
*
|
|
22634
22640
|
* @remarks
|
|
@@ -22677,7 +22683,7 @@ declare namespace Excel {
|
|
|
22677
22683
|
*/
|
|
22678
22684
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
22679
22685
|
/**
|
|
22680
|
-
* The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this
|
|
22686
|
+
* The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`. 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}.
|
|
22681
22687
|
*
|
|
22682
22688
|
* @remarks
|
|
22683
22689
|
* [Api set: ExcelApi 1.4]
|
|
@@ -22923,7 +22929,7 @@ declare namespace Excel {
|
|
|
22923
22929
|
*/
|
|
22924
22930
|
getItem(key: string): Excel.Worksheet;
|
|
22925
22931
|
/**
|
|
22926
|
-
* Gets a worksheet object using its name or ID. If the worksheet does not exist, then this
|
|
22932
|
+
* Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22927
22933
|
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}.
|
|
22928
22934
|
*
|
|
22929
22935
|
* @remarks
|
|
@@ -23341,7 +23347,7 @@ declare namespace Excel {
|
|
|
23341
23347
|
/**
|
|
23342
23348
|
* Gets a range that describes the frozen cells in the active worksheet view.
|
|
23343
23349
|
The frozen range corresponds to cells that are frozen in the top- and left-most pane.
|
|
23344
|
-
If there is no frozen pane, then this
|
|
23350
|
+
If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`.
|
|
23345
23351
|
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}.
|
|
23346
23352
|
*
|
|
23347
23353
|
* @remarks
|
|
@@ -23793,7 +23799,7 @@ declare namespace Excel {
|
|
|
23793
23799
|
/**
|
|
23794
23800
|
* Finds the given string based on the criteria specified.
|
|
23795
23801
|
If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell.
|
|
23796
|
-
If there are no matches, then this
|
|
23802
|
+
If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
23797
23803
|
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}.
|
|
23798
23804
|
*
|
|
23799
23805
|
* @remarks
|
|
@@ -23953,7 +23959,7 @@ declare namespace Excel {
|
|
|
23953
23959
|
*/
|
|
23954
23960
|
getIntersection(anotherRange: Range | string): Excel.Range;
|
|
23955
23961
|
/**
|
|
23956
|
-
* Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this
|
|
23962
|
+
* Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
23957
23963
|
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}.
|
|
23958
23964
|
*
|
|
23959
23965
|
* @remarks
|
|
@@ -24108,7 +24114,7 @@ declare namespace Excel {
|
|
|
24108
24114
|
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
|
|
24109
24115
|
/**
|
|
24110
24116
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
24111
|
-
If no special cells are found, then this
|
|
24117
|
+
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24112
24118
|
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}.
|
|
24113
24119
|
*
|
|
24114
24120
|
* @remarks
|
|
@@ -24120,7 +24126,7 @@ declare namespace Excel {
|
|
|
24120
24126
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
24121
24127
|
/**
|
|
24122
24128
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
24123
|
-
If no special cells are found, then this
|
|
24129
|
+
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24124
24130
|
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}.
|
|
24125
24131
|
*
|
|
24126
24132
|
* @remarks
|
|
@@ -24139,7 +24145,7 @@ declare namespace Excel {
|
|
|
24139
24145
|
getSpillParent(): Excel.Range;
|
|
24140
24146
|
/**
|
|
24141
24147
|
* Gets the range object containing the anchor cell for the cell getting spilled into.
|
|
24142
|
-
If it's not a spilled cell, or more than one cell is given, then this
|
|
24148
|
+
If it's not a spilled cell, or more than one cell is given, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24143
24149
|
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}.
|
|
24144
24150
|
*
|
|
24145
24151
|
* @remarks
|
|
@@ -24155,7 +24161,7 @@ declare namespace Excel {
|
|
|
24155
24161
|
getSpillingToRange(): Excel.Range;
|
|
24156
24162
|
/**
|
|
24157
24163
|
* Gets the range object containing the spill range when called on an anchor cell.
|
|
24158
|
-
If the range isn't an anchor cell or the spill range can't be found, then this
|
|
24164
|
+
If the range isn't an anchor cell or the spill range can't be found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24159
24165
|
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}.
|
|
24160
24166
|
*
|
|
24161
24167
|
* @remarks
|
|
@@ -24188,7 +24194,7 @@ declare namespace Excel {
|
|
|
24188
24194
|
*/
|
|
24189
24195
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
24190
24196
|
/**
|
|
24191
|
-
* Returns the used range of the given range object. If there are no used cells within the range, then this
|
|
24197
|
+
* Returns the used range of the given range object. If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24192
24198
|
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}.
|
|
24193
24199
|
*
|
|
24194
24200
|
* @remarks
|
|
@@ -24679,7 +24685,7 @@ declare namespace Excel {
|
|
|
24679
24685
|
*/
|
|
24680
24686
|
getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
|
|
24681
24687
|
/**
|
|
24682
|
-
* Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this
|
|
24688
|
+
* Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24683
24689
|
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}.
|
|
24684
24690
|
*
|
|
24685
24691
|
* @remarks
|
|
@@ -24719,7 +24725,7 @@ declare namespace Excel {
|
|
|
24719
24725
|
*/
|
|
24720
24726
|
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
|
|
24721
24727
|
/**
|
|
24722
|
-
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this
|
|
24728
|
+
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24723
24729
|
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}.
|
|
24724
24730
|
*
|
|
24725
24731
|
* @remarks
|
|
@@ -24730,7 +24736,7 @@ declare namespace Excel {
|
|
|
24730
24736
|
*/
|
|
24731
24737
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
24732
24738
|
/**
|
|
24733
|
-
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this
|
|
24739
|
+
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24734
24740
|
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}.
|
|
24735
24741
|
*
|
|
24736
24742
|
* @remarks
|
|
@@ -24761,7 +24767,7 @@ declare namespace Excel {
|
|
|
24761
24767
|
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;
|
|
24762
24768
|
/**
|
|
24763
24769
|
* Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.
|
|
24764
|
-
If there are no used cells within the `RangeAreas`, then this
|
|
24770
|
+
If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24765
24771
|
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}.
|
|
24766
24772
|
*
|
|
24767
24773
|
* @remarks
|
|
@@ -24852,7 +24858,7 @@ declare namespace Excel {
|
|
|
24852
24858
|
*/
|
|
24853
24859
|
getRangeAreasBySheet(key: string): Excel.RangeAreas;
|
|
24854
24860
|
/**
|
|
24855
|
-
* Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this
|
|
24861
|
+
* Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24856
24862
|
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}.
|
|
24857
24863
|
*
|
|
24858
24864
|
* @remarks
|
|
@@ -25599,7 +25605,7 @@ declare namespace Excel {
|
|
|
25599
25605
|
*/
|
|
25600
25606
|
getItem(key: string): Excel.Setting;
|
|
25601
25607
|
/**
|
|
25602
|
-
* Gets a setting entry via the key. If the setting does not exist, then this
|
|
25608
|
+
* Gets a setting entry via the key. If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
25603
25609
|
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}.
|
|
25604
25610
|
*
|
|
25605
25611
|
* @remarks
|
|
@@ -25758,7 +25764,7 @@ declare namespace Excel {
|
|
|
25758
25764
|
*/
|
|
25759
25765
|
getItem(name: string): Excel.NamedItem;
|
|
25760
25766
|
/**
|
|
25761
|
-
* Gets a `NamedItem` object using its name. If the object does not exist, then this
|
|
25767
|
+
* Gets a `NamedItem` object using its name. If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
25762
25768
|
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}.
|
|
25763
25769
|
*
|
|
25764
25770
|
* @remarks
|
|
@@ -25815,7 +25821,7 @@ declare namespace Excel {
|
|
|
25815
25821
|
*/
|
|
25816
25822
|
readonly worksheet: Excel.Worksheet;
|
|
25817
25823
|
/**
|
|
25818
|
-
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
|
|
25824
|
+
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
25819
25825
|
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}.
|
|
25820
25826
|
*
|
|
25821
25827
|
* @remarks
|
|
@@ -25894,7 +25900,7 @@ declare namespace Excel {
|
|
|
25894
25900
|
*/
|
|
25895
25901
|
getRange(): Excel.Range;
|
|
25896
25902
|
/**
|
|
25897
|
-
* Returns the range object that is associated with the name. If the named item's type is not a range, then this
|
|
25903
|
+
* Returns the range object that is associated with the name. If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`.
|
|
25898
25904
|
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}.
|
|
25899
25905
|
*
|
|
25900
25906
|
* @remarks
|
|
@@ -26188,7 +26194,7 @@ declare namespace Excel {
|
|
|
26188
26194
|
*/
|
|
26189
26195
|
getItemAt(index: number): Excel.Binding;
|
|
26190
26196
|
/**
|
|
26191
|
-
* Gets a binding object by ID. If the binding object does not exist, then this
|
|
26197
|
+
* Gets a binding object by ID. If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
26192
26198
|
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}.
|
|
26193
26199
|
*
|
|
26194
26200
|
* @remarks
|
|
@@ -26275,7 +26281,7 @@ declare namespace Excel {
|
|
|
26275
26281
|
*/
|
|
26276
26282
|
getItemAt(index: number): Excel.Table;
|
|
26277
26283
|
/**
|
|
26278
|
-
* Gets a table by name or ID. If the table doesn't exist, then this
|
|
26284
|
+
* Gets a table by name or ID. If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
26279
26285
|
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}.
|
|
26280
26286
|
*
|
|
26281
26287
|
* @remarks
|
|
@@ -26371,7 +26377,7 @@ declare namespace Excel {
|
|
|
26371
26377
|
getItem(key: string): Excel.Table;
|
|
26372
26378
|
/**
|
|
26373
26379
|
* Gets a table by name or ID.
|
|
26374
|
-
If the table object does not exist, then this
|
|
26380
|
+
If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
26375
26381
|
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}.
|
|
26376
26382
|
*
|
|
26377
26383
|
* @remarks
|
|
@@ -26701,7 +26707,7 @@ declare namespace Excel {
|
|
|
26701
26707
|
*/
|
|
26702
26708
|
getItemAt(index: number): Excel.TableColumn;
|
|
26703
26709
|
/**
|
|
26704
|
-
* Gets a column object by name or ID. If the column doesn't exist, then this
|
|
26710
|
+
* Gets a column object by name or ID. If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
26705
26711
|
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}.
|
|
26706
26712
|
*
|
|
26707
26713
|
* @remarks
|
|
@@ -28101,7 +28107,7 @@ declare namespace Excel {
|
|
|
28101
28107
|
*/
|
|
28102
28108
|
getItemAt(index: number): Excel.Chart;
|
|
28103
28109
|
/**
|
|
28104
|
-
* Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this
|
|
28110
|
+
* Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
28105
28111
|
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}.
|
|
28106
28112
|
*
|
|
28107
28113
|
* @remarks
|
|
@@ -28380,7 +28386,7 @@ declare namespace Excel {
|
|
|
28380
28386
|
*/
|
|
28381
28387
|
getDataTable(): Excel.ChartDataTable;
|
|
28382
28388
|
/**
|
|
28383
|
-
* Gets the data table on the chart. If the chart doesn't allow a data table, then this
|
|
28389
|
+
* Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`.
|
|
28384
28390
|
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}.
|
|
28385
28391
|
*
|
|
28386
28392
|
* @remarks
|
|
@@ -33354,7 +33360,7 @@ declare namespace Excel {
|
|
|
33354
33360
|
getItem(id: string): Excel.CustomXmlPart;
|
|
33355
33361
|
/**
|
|
33356
33362
|
* Gets a custom XML part based on its ID.
|
|
33357
|
-
If the `CustomXmlPart` does not exist, then this
|
|
33363
|
+
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33358
33364
|
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}.
|
|
33359
33365
|
*
|
|
33360
33366
|
* @remarks
|
|
@@ -33450,7 +33456,7 @@ declare namespace Excel {
|
|
|
33450
33456
|
getItem(id: string): Excel.CustomXmlPart;
|
|
33451
33457
|
/**
|
|
33452
33458
|
* Gets a custom XML part based on its ID.
|
|
33453
|
-
If the `CustomXmlPart` does not exist, then this
|
|
33459
|
+
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33454
33460
|
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}.
|
|
33455
33461
|
*
|
|
33456
33462
|
* @remarks
|
|
@@ -33591,7 +33597,7 @@ declare namespace Excel {
|
|
|
33591
33597
|
*/
|
|
33592
33598
|
getItem(key: string): Excel.PivotTable;
|
|
33593
33599
|
/**
|
|
33594
|
-
* Gets a PivotTable by name. If the PivotTable does not exist, then this
|
|
33600
|
+
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33595
33601
|
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}.
|
|
33596
33602
|
*
|
|
33597
33603
|
* @remarks
|
|
@@ -33664,7 +33670,7 @@ declare namespace Excel {
|
|
|
33664
33670
|
*/
|
|
33665
33671
|
getItem(name: string): Excel.PivotTable;
|
|
33666
33672
|
/**
|
|
33667
|
-
* Gets a PivotTable by name. If the PivotTable does not exist, then this
|
|
33673
|
+
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33668
33674
|
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}.
|
|
33669
33675
|
*
|
|
33670
33676
|
* @remarks
|
|
@@ -34127,7 +34133,7 @@ declare namespace Excel {
|
|
|
34127
34133
|
*/
|
|
34128
34134
|
getItem(name: string): Excel.PivotHierarchy;
|
|
34129
34135
|
/**
|
|
34130
|
-
* Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this
|
|
34136
|
+
* Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34131
34137
|
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}.
|
|
34132
34138
|
*
|
|
34133
34139
|
* @remarks
|
|
@@ -34261,7 +34267,7 @@ declare namespace Excel {
|
|
|
34261
34267
|
*/
|
|
34262
34268
|
getItem(name: string): Excel.RowColumnPivotHierarchy;
|
|
34263
34269
|
/**
|
|
34264
|
-
* Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this
|
|
34270
|
+
* Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34265
34271
|
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}.
|
|
34266
34272
|
*
|
|
34267
34273
|
* @remarks
|
|
@@ -34416,7 +34422,7 @@ declare namespace Excel {
|
|
|
34416
34422
|
*/
|
|
34417
34423
|
getItem(name: string): Excel.FilterPivotHierarchy;
|
|
34418
34424
|
/**
|
|
34419
|
-
* Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this
|
|
34425
|
+
* Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34420
34426
|
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}.
|
|
34421
34427
|
*
|
|
34422
34428
|
* @remarks
|
|
@@ -34577,7 +34583,7 @@ declare namespace Excel {
|
|
|
34577
34583
|
*/
|
|
34578
34584
|
getItem(name: string): Excel.DataPivotHierarchy;
|
|
34579
34585
|
/**
|
|
34580
|
-
* Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this
|
|
34586
|
+
* Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34581
34587
|
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}.
|
|
34582
34588
|
*
|
|
34583
34589
|
* @remarks
|
|
@@ -34772,7 +34778,7 @@ declare namespace Excel {
|
|
|
34772
34778
|
*/
|
|
34773
34779
|
getItem(name: string): Excel.PivotField;
|
|
34774
34780
|
/**
|
|
34775
|
-
* Gets a PivotField by name. If the PivotField does not exist, then this
|
|
34781
|
+
* Gets a PivotField by name. If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34776
34782
|
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}.
|
|
34777
34783
|
*
|
|
34778
34784
|
* @remarks
|
|
@@ -35014,7 +35020,7 @@ declare namespace Excel {
|
|
|
35014
35020
|
*/
|
|
35015
35021
|
getItem(name: string): Excel.PivotItem;
|
|
35016
35022
|
/**
|
|
35017
|
-
* Gets a PivotItem by name. If the PivotItem does not exist, then this
|
|
35023
|
+
* Gets a PivotItem by name. If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35018
35024
|
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}.
|
|
35019
35025
|
*
|
|
35020
35026
|
* @remarks
|
|
@@ -35540,7 +35546,7 @@ declare namespace Excel {
|
|
|
35540
35546
|
*/
|
|
35541
35547
|
getItem(key: string): Excel.WorksheetCustomProperty;
|
|
35542
35548
|
/**
|
|
35543
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this
|
|
35549
|
+
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35544
35550
|
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}.
|
|
35545
35551
|
*
|
|
35546
35552
|
* @remarks
|
|
@@ -35583,7 +35589,7 @@ declare namespace Excel {
|
|
|
35583
35589
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35584
35590
|
context: RequestContext;
|
|
35585
35591
|
/**
|
|
35586
|
-
* Gets the collection of custom properties of the workbook.
|
|
35592
|
+
* Gets the collection of custom properties of the workbook.
|
|
35587
35593
|
*
|
|
35588
35594
|
* @remarks
|
|
35589
35595
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35618,7 +35624,7 @@ declare namespace Excel {
|
|
|
35618
35624
|
*/
|
|
35619
35625
|
company: string;
|
|
35620
35626
|
/**
|
|
35621
|
-
* Gets the creation date of the workbook.
|
|
35627
|
+
* Gets the creation date of the workbook.
|
|
35622
35628
|
*
|
|
35623
35629
|
* @remarks
|
|
35624
35630
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35632,7 +35638,7 @@ declare namespace Excel {
|
|
|
35632
35638
|
*/
|
|
35633
35639
|
keywords: string;
|
|
35634
35640
|
/**
|
|
35635
|
-
* Gets the last author of the workbook.
|
|
35641
|
+
* Gets the last author of the workbook.
|
|
35636
35642
|
*
|
|
35637
35643
|
* @remarks
|
|
35638
35644
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35646,7 +35652,7 @@ declare namespace Excel {
|
|
|
35646
35652
|
*/
|
|
35647
35653
|
manager: string;
|
|
35648
35654
|
/**
|
|
35649
|
-
* Gets the revision number of the workbook.
|
|
35655
|
+
* Gets the revision number of the workbook.
|
|
35650
35656
|
*
|
|
35651
35657
|
* @remarks
|
|
35652
35658
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35818,7 +35824,7 @@ declare namespace Excel {
|
|
|
35818
35824
|
*/
|
|
35819
35825
|
getItem(key: string): Excel.CustomProperty;
|
|
35820
35826
|
/**
|
|
35821
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this
|
|
35827
|
+
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35822
35828
|
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}.
|
|
35823
35829
|
*
|
|
35824
35830
|
* @remarks
|
|
@@ -35915,7 +35921,7 @@ declare namespace Excel {
|
|
|
35915
35921
|
getItemAt(index: number): Excel.ConditionalFormat;
|
|
35916
35922
|
/**
|
|
35917
35923
|
* Returns a conditional format identified by its ID.
|
|
35918
|
-
If the conditional format object does not exist, then this
|
|
35924
|
+
If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35919
35925
|
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}.
|
|
35920
35926
|
*
|
|
35921
35927
|
* @remarks
|
|
@@ -36130,7 +36136,7 @@ declare namespace Excel {
|
|
|
36130
36136
|
*/
|
|
36131
36137
|
getRange(): Excel.Range;
|
|
36132
36138
|
/**
|
|
36133
|
-
* Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this
|
|
36139
|
+
* Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36134
36140
|
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}.
|
|
36135
36141
|
*
|
|
36136
36142
|
* @remarks
|
|
@@ -37739,7 +37745,7 @@ declare namespace Excel {
|
|
|
37739
37745
|
getItemAt(index: number): Excel.Style;
|
|
37740
37746
|
/**
|
|
37741
37747
|
* Gets a style by name.
|
|
37742
|
-
If the style object does not exist, then this
|
|
37748
|
+
If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37743
37749
|
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}.
|
|
37744
37750
|
*
|
|
37745
37751
|
* @remarks
|
|
@@ -37820,7 +37826,7 @@ declare namespace Excel {
|
|
|
37820
37826
|
*/
|
|
37821
37827
|
getItem(name: string): Excel.TableStyle;
|
|
37822
37828
|
/**
|
|
37823
|
-
* Gets a `TableStyle` by name. If the table style does not exist, then this
|
|
37829
|
+
* Gets a `TableStyle` by name. If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37824
37830
|
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}.
|
|
37825
37831
|
*
|
|
37826
37832
|
* @remarks
|
|
@@ -37984,7 +37990,7 @@ declare namespace Excel {
|
|
|
37984
37990
|
*/
|
|
37985
37991
|
getItem(name: string): Excel.PivotTableStyle;
|
|
37986
37992
|
/**
|
|
37987
|
-
* Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this
|
|
37993
|
+
* Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37988
37994
|
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}.
|
|
37989
37995
|
*
|
|
37990
37996
|
* @remarks
|
|
@@ -38148,7 +38154,7 @@ declare namespace Excel {
|
|
|
38148
38154
|
*/
|
|
38149
38155
|
getItem(name: string): Excel.SlicerStyle;
|
|
38150
38156
|
/**
|
|
38151
|
-
* Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this
|
|
38157
|
+
* Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38152
38158
|
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}.
|
|
38153
38159
|
*
|
|
38154
38160
|
* @remarks
|
|
@@ -38312,7 +38318,7 @@ declare namespace Excel {
|
|
|
38312
38318
|
*/
|
|
38313
38319
|
getItem(name: string): Excel.TimelineStyle;
|
|
38314
38320
|
/**
|
|
38315
|
-
* Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this
|
|
38321
|
+
* Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38316
38322
|
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}.
|
|
38317
38323
|
*
|
|
38318
38324
|
* @remarks
|
|
@@ -38594,7 +38600,7 @@ declare namespace Excel {
|
|
|
38594
38600
|
*/
|
|
38595
38601
|
getPrintArea(): Excel.RangeAreas;
|
|
38596
38602
|
/**
|
|
38597
|
-
* Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this
|
|
38603
|
+
* Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38598
38604
|
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}.
|
|
38599
38605
|
*
|
|
38600
38606
|
* @remarks
|
|
@@ -38609,7 +38615,7 @@ declare namespace Excel {
|
|
|
38609
38615
|
*/
|
|
38610
38616
|
getPrintTitleColumns(): Excel.Range;
|
|
38611
38617
|
/**
|
|
38612
|
-
* Gets the range object representing the title columns. If not set, then this
|
|
38618
|
+
* Gets the range object representing the title columns. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38613
38619
|
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}.
|
|
38614
38620
|
*
|
|
38615
38621
|
* @remarks
|
|
@@ -38624,7 +38630,7 @@ declare namespace Excel {
|
|
|
38624
38630
|
*/
|
|
38625
38631
|
getPrintTitleRows(): Excel.Range;
|
|
38626
38632
|
/**
|
|
38627
|
-
* Gets the range object representing the title rows. If not set, then this
|
|
38633
|
+
* Gets the range object representing the title rows. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38628
38634
|
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}.
|
|
38629
38635
|
*
|
|
38630
38636
|
* @remarks
|
|
@@ -39345,7 +39351,7 @@ declare namespace Excel {
|
|
|
39345
39351
|
getItemByReplyId(replyId: string): Excel.Comment;
|
|
39346
39352
|
/**
|
|
39347
39353
|
* Gets a comment from the collection based on its ID.
|
|
39348
|
-
If the comment object does not exist, then this
|
|
39354
|
+
If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39349
39355
|
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}.
|
|
39350
39356
|
*
|
|
39351
39357
|
* @remarks
|
|
@@ -39600,7 +39606,7 @@ declare namespace Excel {
|
|
|
39600
39606
|
getItemAt(index: number): Excel.CommentReply;
|
|
39601
39607
|
/**
|
|
39602
39608
|
* Returns a comment reply identified by its ID.
|
|
39603
|
-
If the comment reply object does not exist, then this
|
|
39609
|
+
If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39604
39610
|
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}.
|
|
39605
39611
|
*
|
|
39606
39612
|
* @remarks
|
|
@@ -39879,7 +39885,7 @@ declare namespace Excel {
|
|
|
39879
39885
|
getItemAt(index: number): Excel.Shape;
|
|
39880
39886
|
/**
|
|
39881
39887
|
* Gets a shape using its name or ID.
|
|
39882
|
-
If the shape object does not exist, then this
|
|
39888
|
+
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39883
39889
|
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}.
|
|
39884
39890
|
*
|
|
39885
39891
|
* @remarks
|
|
@@ -39972,7 +39978,7 @@ declare namespace Excel {
|
|
|
39972
39978
|
*/
|
|
39973
39979
|
readonly parentGroup: Excel.Shape;
|
|
39974
39980
|
/**
|
|
39975
|
-
* Returns the text frame object of this shape.
|
|
39981
|
+
* Returns the text frame object of this shape.
|
|
39976
39982
|
*
|
|
39977
39983
|
* @remarks
|
|
39978
39984
|
* [Api set: ExcelApi 1.9]
|
|
@@ -40488,7 +40494,7 @@ declare namespace Excel {
|
|
|
40488
40494
|
getItemAt(index: number): Excel.Shape;
|
|
40489
40495
|
/**
|
|
40490
40496
|
* Gets a shape using its name or ID.
|
|
40491
|
-
If the shape object does not exist, then this
|
|
40497
|
+
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
40492
40498
|
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}.
|
|
40493
40499
|
*
|
|
40494
40500
|
* @remarks
|
|
@@ -41379,7 +41385,7 @@ declare namespace Excel {
|
|
|
41379
41385
|
*/
|
|
41380
41386
|
getItemAt(index: number): Excel.Slicer;
|
|
41381
41387
|
/**
|
|
41382
|
-
* Gets a slicer using its name or ID. If the slicer doesn't exist, then this
|
|
41388
|
+
* Gets a slicer using its name or ID. If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
41383
41389
|
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}.
|
|
41384
41390
|
*
|
|
41385
41391
|
* @remarks
|
|
@@ -41523,7 +41529,7 @@ declare namespace Excel {
|
|
|
41523
41529
|
*/
|
|
41524
41530
|
getItemAt(index: number): Excel.SlicerItem;
|
|
41525
41531
|
/**
|
|
41526
|
-
* Gets a slicer item using its key or name. If the slicer item doesn't exist, then this
|
|
41532
|
+
* Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
41527
41533
|
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}.
|
|
41528
41534
|
*
|
|
41529
41535
|
* @remarks
|
|
@@ -52443,6 +52449,7 @@ declare namespace Excel {
|
|
|
52443
52449
|
nonBlankCellOffSheet = "NonBlankCellOffSheet",
|
|
52444
52450
|
notImplemented = "NotImplemented",
|
|
52445
52451
|
openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked",
|
|
52452
|
+
operationCellsExceedLimit = "OperationCellsExceedLimit",
|
|
52446
52453
|
pivotTableRangeConflict = "PivotTableRangeConflict",
|
|
52447
52454
|
rangeExceedsLimit = "RangeExceedsLimit",
|
|
52448
52455
|
refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
|
|
@@ -55688,7 +55695,7 @@ declare namespace Excel {
|
|
|
55688
55695
|
*/
|
|
55689
55696
|
manager?: string;
|
|
55690
55697
|
/**
|
|
55691
|
-
* Gets the revision number of the workbook.
|
|
55698
|
+
* Gets the revision number of the workbook.
|
|
55692
55699
|
*
|
|
55693
55700
|
* @remarks
|
|
55694
55701
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61693,7 +61700,7 @@ declare namespace Excel {
|
|
|
61693
61700
|
/** An interface describing the data returned by calling `documentProperties.toJSON()`. */
|
|
61694
61701
|
interface DocumentPropertiesData {
|
|
61695
61702
|
/**
|
|
61696
|
-
* Gets the collection of custom properties of the workbook.
|
|
61703
|
+
* Gets the collection of custom properties of the workbook.
|
|
61697
61704
|
*
|
|
61698
61705
|
* @remarks
|
|
61699
61706
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61728,7 +61735,7 @@ declare namespace Excel {
|
|
|
61728
61735
|
*/
|
|
61729
61736
|
company?: string;
|
|
61730
61737
|
/**
|
|
61731
|
-
* Gets the creation date of the workbook.
|
|
61738
|
+
* Gets the creation date of the workbook.
|
|
61732
61739
|
*
|
|
61733
61740
|
* @remarks
|
|
61734
61741
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61742,7 +61749,7 @@ declare namespace Excel {
|
|
|
61742
61749
|
*/
|
|
61743
61750
|
keywords?: string;
|
|
61744
61751
|
/**
|
|
61745
|
-
* Gets the last author of the workbook.
|
|
61752
|
+
* Gets the last author of the workbook.
|
|
61746
61753
|
*
|
|
61747
61754
|
* @remarks
|
|
61748
61755
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61756,7 +61763,7 @@ declare namespace Excel {
|
|
|
61756
61763
|
*/
|
|
61757
61764
|
manager?: string;
|
|
61758
61765
|
/**
|
|
61759
|
-
* Gets the revision number of the workbook.
|
|
61766
|
+
* Gets the revision number of the workbook.
|
|
61760
61767
|
*
|
|
61761
61768
|
* @remarks
|
|
61762
61769
|
* [Api set: ExcelApi 1.7]
|
|
@@ -64984,7 +64991,7 @@ declare namespace Excel {
|
|
|
64984
64991
|
*/
|
|
64985
64992
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
64986
64993
|
/**
|
|
64987
|
-
* For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
|
|
64994
|
+
* For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
64988
64995
|
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}.
|
|
64989
64996
|
*
|
|
64990
64997
|
* @remarks
|
|
@@ -65067,7 +65074,7 @@ declare namespace Excel {
|
|
|
65067
65074
|
*/
|
|
65068
65075
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
65069
65076
|
/**
|
|
65070
|
-
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
|
|
65077
|
+
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
65071
65078
|
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}.
|
|
65072
65079
|
*
|
|
65073
65080
|
* @remarks
|
|
@@ -70606,7 +70613,7 @@ declare namespace Excel {
|
|
|
70606
70613
|
*/
|
|
70607
70614
|
company?: boolean;
|
|
70608
70615
|
/**
|
|
70609
|
-
* Gets the creation date of the workbook.
|
|
70616
|
+
* Gets the creation date of the workbook.
|
|
70610
70617
|
*
|
|
70611
70618
|
* @remarks
|
|
70612
70619
|
* [Api set: ExcelApi 1.7]
|
|
@@ -70620,7 +70627,7 @@ declare namespace Excel {
|
|
|
70620
70627
|
*/
|
|
70621
70628
|
keywords?: boolean;
|
|
70622
70629
|
/**
|
|
70623
|
-
* Gets the last author of the workbook.
|
|
70630
|
+
* Gets the last author of the workbook.
|
|
70624
70631
|
*
|
|
70625
70632
|
* @remarks
|
|
70626
70633
|
* [Api set: ExcelApi 1.7]
|
|
@@ -70634,7 +70641,7 @@ declare namespace Excel {
|
|
|
70634
70641
|
*/
|
|
70635
70642
|
manager?: boolean;
|
|
70636
70643
|
/**
|
|
70637
|
-
* Gets the revision number of the workbook.
|
|
70644
|
+
* Gets the revision number of the workbook.
|
|
70638
70645
|
*
|
|
70639
70646
|
* @remarks
|
|
70640
70647
|
* [Api set: ExcelApi 1.7]
|
|
@@ -73158,7 +73165,7 @@ declare namespace Excel {
|
|
|
73158
73165
|
*/
|
|
73159
73166
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73160
73167
|
/**
|
|
73161
|
-
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73168
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73162
73169
|
*
|
|
73163
73170
|
* @remarks
|
|
73164
73171
|
* [Api set: ExcelApi 1.9]
|
|
@@ -73350,7 +73357,7 @@ declare namespace Excel {
|
|
|
73350
73357
|
*/
|
|
73351
73358
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73352
73359
|
/**
|
|
73353
|
-
* Returns the text frame object of this shape.
|
|
73360
|
+
* Returns the text frame object of this shape.
|
|
73354
73361
|
*
|
|
73355
73362
|
* @remarks
|
|
73356
73363
|
* [Api set: ExcelApi 1.9]
|
|
@@ -73626,7 +73633,7 @@ declare namespace Excel {
|
|
|
73626
73633
|
*/
|
|
73627
73634
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73628
73635
|
/**
|
|
73629
|
-
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73636
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73630
73637
|
*
|
|
73631
73638
|
* @remarks
|
|
73632
73639
|
* [Api set: ExcelApi 1.9]
|
|
@@ -75747,14 +75754,14 @@ declare namespace Word {
|
|
|
75747
75754
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
75748
75755
|
context: RequestContext;
|
|
75749
75756
|
/**
|
|
75750
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
75757
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
|
|
75751
75758
|
*
|
|
75752
75759
|
* @remarks
|
|
75753
75760
|
* [Api set: WordApi 1.1]
|
|
75754
75761
|
*/
|
|
75755
75762
|
readonly body: Word.Body;
|
|
75756
75763
|
/**
|
|
75757
|
-
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc
|
|
75764
|
+
* 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.
|
|
75758
75765
|
*
|
|
75759
75766
|
* @remarks
|
|
75760
75767
|
* [Api set: WordApi 1.1]
|
|
@@ -81932,7 +81939,7 @@ declare namespace Word {
|
|
|
81932
81939
|
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
81933
81940
|
interface DocumentUpdateData {
|
|
81934
81941
|
/**
|
|
81935
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
81942
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
81936
81943
|
*
|
|
81937
81944
|
* @remarks
|
|
81938
81945
|
* [Api set: WordApi 1.1]
|
|
@@ -82873,14 +82880,14 @@ declare namespace Word {
|
|
|
82873
82880
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
82874
82881
|
interface DocumentData {
|
|
82875
82882
|
/**
|
|
82876
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
82883
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
|
|
82877
82884
|
*
|
|
82878
82885
|
* @remarks
|
|
82879
82886
|
* [Api set: WordApi 1.1]
|
|
82880
82887
|
*/
|
|
82881
82888
|
body?: Word.Interfaces.BodyData;
|
|
82882
82889
|
/**
|
|
82883
|
-
* Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc
|
|
82890
|
+
* 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.
|
|
82884
82891
|
*
|
|
82885
82892
|
* @remarks
|
|
82886
82893
|
* [Api set: WordApi 1.1]
|
|
@@ -84354,7 +84361,7 @@ declare namespace Word {
|
|
|
84354
84361
|
*/
|
|
84355
84362
|
$all?: boolean;
|
|
84356
84363
|
/**
|
|
84357
|
-
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc
|
|
84364
|
+
* Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
|
|
84358
84365
|
*
|
|
84359
84366
|
* @remarks
|
|
84360
84367
|
* [Api set: WordApi 1.1]
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.229",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
43
|
+
"typesPublisherContentHash": "66b01b702b8f15be6bd0b972bb6651cda68b9b3d93e9f79a095b2c87ee4cc79d",
|
|
44
44
|
"typeScriptVersion": "3.8"
|
|
45
45
|
}
|