@types/office-js 1.0.228 → 1.0.232
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 +1941 -708
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -329,6 +329,10 @@ declare namespace Office {
|
|
|
329
329
|
* @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true.
|
|
330
330
|
*/
|
|
331
331
|
function useShortNamespace(useShortNamespace: boolean): void;
|
|
332
|
+
/**
|
|
333
|
+
* Provides a method for associating action names with functions that carry out an action.
|
|
334
|
+
*/
|
|
335
|
+
const actions: Actions;
|
|
332
336
|
/**
|
|
333
337
|
* Represents the add-in.
|
|
334
338
|
*/
|
|
@@ -19528,7 +19532,7 @@ declare namespace Excel {
|
|
|
19528
19532
|
*/
|
|
19529
19533
|
getItem(key: string): Excel.LinkedWorkbook;
|
|
19530
19534
|
/**
|
|
19531
|
-
* Gets information about a linked workbook by its URL. If the workbook does not exist, then this
|
|
19535
|
+
* 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`.
|
|
19532
19536
|
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}.
|
|
19533
19537
|
*
|
|
19534
19538
|
* @remarks
|
|
@@ -22103,7 +22107,7 @@ declare namespace Excel {
|
|
|
22103
22107
|
*/
|
|
22104
22108
|
getActiveChart(): Excel.Chart;
|
|
22105
22109
|
/**
|
|
22106
|
-
* Gets the currently active chart in the workbook. If there is no active chart, then this
|
|
22110
|
+
* 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`.
|
|
22107
22111
|
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}.
|
|
22108
22112
|
*
|
|
22109
22113
|
* @remarks
|
|
@@ -22118,7 +22122,7 @@ declare namespace Excel {
|
|
|
22118
22122
|
*/
|
|
22119
22123
|
getActiveSlicer(): Excel.Slicer;
|
|
22120
22124
|
/**
|
|
22121
|
-
* Gets the currently active slicer in the workbook. If there is no active slicer, then this
|
|
22125
|
+
* 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`.
|
|
22122
22126
|
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}.
|
|
22123
22127
|
*
|
|
22124
22128
|
* @remarks
|
|
@@ -22591,7 +22595,7 @@ declare namespace Excel {
|
|
|
22591
22595
|
*
|
|
22592
22596
|
* @param text The string to find.
|
|
22593
22597
|
* @param criteria Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
|
|
22594
|
-
* @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this
|
|
22598
|
+
* @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
22595
22599
|
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}.
|
|
22596
22600
|
*/
|
|
22597
22601
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
|
|
@@ -22615,7 +22619,7 @@ declare namespace Excel {
|
|
|
22615
22619
|
*/
|
|
22616
22620
|
getNext(visibleOnly?: boolean): Excel.Worksheet;
|
|
22617
22621
|
/**
|
|
22618
|
-
* Gets the worksheet that follows this one. If there are no worksheets following this one, then this method
|
|
22622
|
+
* 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`.
|
|
22619
22623
|
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}.
|
|
22620
22624
|
*
|
|
22621
22625
|
* @remarks
|
|
@@ -22634,7 +22638,7 @@ declare namespace Excel {
|
|
|
22634
22638
|
*/
|
|
22635
22639
|
getPrevious(visibleOnly?: boolean): Excel.Worksheet;
|
|
22636
22640
|
/**
|
|
22637
|
-
* Gets the worksheet that precedes this one. If there are no previous worksheets, then this method
|
|
22641
|
+
* 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`.
|
|
22638
22642
|
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}.
|
|
22639
22643
|
*
|
|
22640
22644
|
* @remarks
|
|
@@ -22683,7 +22687,7 @@ declare namespace Excel {
|
|
|
22683
22687
|
*/
|
|
22684
22688
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
22685
22689
|
/**
|
|
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
|
|
22690
|
+
* 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}.
|
|
22687
22691
|
*
|
|
22688
22692
|
* @remarks
|
|
22689
22693
|
* [Api set: ExcelApi 1.4]
|
|
@@ -22929,7 +22933,7 @@ declare namespace Excel {
|
|
|
22929
22933
|
*/
|
|
22930
22934
|
getItem(key: string): Excel.Worksheet;
|
|
22931
22935
|
/**
|
|
22932
|
-
* Gets a worksheet object using its name or ID. If the worksheet does not exist, then this
|
|
22936
|
+
* 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`.
|
|
22933
22937
|
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}.
|
|
22934
22938
|
*
|
|
22935
22939
|
* @remarks
|
|
@@ -23347,7 +23351,7 @@ declare namespace Excel {
|
|
|
23347
23351
|
/**
|
|
23348
23352
|
* Gets a range that describes the frozen cells in the active worksheet view.
|
|
23349
23353
|
The frozen range corresponds to cells that are frozen in the top- and left-most pane.
|
|
23350
|
-
If there is no frozen pane, then this
|
|
23354
|
+
If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`.
|
|
23351
23355
|
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}.
|
|
23352
23356
|
*
|
|
23353
23357
|
* @remarks
|
|
@@ -23799,7 +23803,7 @@ declare namespace Excel {
|
|
|
23799
23803
|
/**
|
|
23800
23804
|
* Finds the given string based on the criteria specified.
|
|
23801
23805
|
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.
|
|
23802
|
-
If there are no matches, then this
|
|
23806
|
+
If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
23803
23807
|
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}.
|
|
23804
23808
|
*
|
|
23805
23809
|
* @remarks
|
|
@@ -23959,7 +23963,7 @@ declare namespace Excel {
|
|
|
23959
23963
|
*/
|
|
23960
23964
|
getIntersection(anotherRange: Range | string): Excel.Range;
|
|
23961
23965
|
/**
|
|
23962
|
-
* Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this
|
|
23966
|
+
* 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`.
|
|
23963
23967
|
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}.
|
|
23964
23968
|
*
|
|
23965
23969
|
* @remarks
|
|
@@ -24114,7 +24118,7 @@ declare namespace Excel {
|
|
|
24114
24118
|
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;
|
|
24115
24119
|
/**
|
|
24116
24120
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
24117
|
-
If no special cells are found, then this
|
|
24121
|
+
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24118
24122
|
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}.
|
|
24119
24123
|
*
|
|
24120
24124
|
* @remarks
|
|
@@ -24126,7 +24130,7 @@ declare namespace Excel {
|
|
|
24126
24130
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
24127
24131
|
/**
|
|
24128
24132
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
24129
|
-
If no special cells are found, then this
|
|
24133
|
+
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24130
24134
|
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}.
|
|
24131
24135
|
*
|
|
24132
24136
|
* @remarks
|
|
@@ -24145,7 +24149,7 @@ declare namespace Excel {
|
|
|
24145
24149
|
getSpillParent(): Excel.Range;
|
|
24146
24150
|
/**
|
|
24147
24151
|
* Gets the range object containing the anchor cell for the cell getting spilled into.
|
|
24148
|
-
If it's not a spilled cell, or more than one cell is given, then this
|
|
24152
|
+
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`.
|
|
24149
24153
|
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}.
|
|
24150
24154
|
*
|
|
24151
24155
|
* @remarks
|
|
@@ -24161,7 +24165,7 @@ declare namespace Excel {
|
|
|
24161
24165
|
getSpillingToRange(): Excel.Range;
|
|
24162
24166
|
/**
|
|
24163
24167
|
* Gets the range object containing the spill range when called on an anchor cell.
|
|
24164
|
-
If the range isn't an anchor cell or the spill range can't be found, then this
|
|
24168
|
+
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`.
|
|
24165
24169
|
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}.
|
|
24166
24170
|
*
|
|
24167
24171
|
* @remarks
|
|
@@ -24194,7 +24198,7 @@ declare namespace Excel {
|
|
|
24194
24198
|
*/
|
|
24195
24199
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
24196
24200
|
/**
|
|
24197
|
-
* Returns the used range of the given range object. If there are no used cells within the range, then this
|
|
24201
|
+
* 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`.
|
|
24198
24202
|
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}.
|
|
24199
24203
|
*
|
|
24200
24204
|
* @remarks
|
|
@@ -24685,7 +24689,7 @@ declare namespace Excel {
|
|
|
24685
24689
|
*/
|
|
24686
24690
|
getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
|
|
24687
24691
|
/**
|
|
24688
|
-
* Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this
|
|
24692
|
+
* 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`.
|
|
24689
24693
|
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}.
|
|
24690
24694
|
*
|
|
24691
24695
|
* @remarks
|
|
@@ -24725,7 +24729,7 @@ declare namespace Excel {
|
|
|
24725
24729
|
*/
|
|
24726
24730
|
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;
|
|
24727
24731
|
/**
|
|
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
|
|
24732
|
+
* 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`.
|
|
24729
24733
|
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}.
|
|
24730
24734
|
*
|
|
24731
24735
|
* @remarks
|
|
@@ -24736,7 +24740,7 @@ declare namespace Excel {
|
|
|
24736
24740
|
*/
|
|
24737
24741
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
24738
24742
|
/**
|
|
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
|
|
24743
|
+
* 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`.
|
|
24740
24744
|
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}.
|
|
24741
24745
|
*
|
|
24742
24746
|
* @remarks
|
|
@@ -24767,7 +24771,7 @@ declare namespace Excel {
|
|
|
24767
24771
|
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;
|
|
24768
24772
|
/**
|
|
24769
24773
|
* Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.
|
|
24770
|
-
If there are no used cells within the `RangeAreas`, then this
|
|
24774
|
+
If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`.
|
|
24771
24775
|
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}.
|
|
24772
24776
|
*
|
|
24773
24777
|
* @remarks
|
|
@@ -24858,7 +24862,7 @@ declare namespace Excel {
|
|
|
24858
24862
|
*/
|
|
24859
24863
|
getRangeAreasBySheet(key: string): Excel.RangeAreas;
|
|
24860
24864
|
/**
|
|
24861
|
-
* Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this
|
|
24865
|
+
* 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`.
|
|
24862
24866
|
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}.
|
|
24863
24867
|
*
|
|
24864
24868
|
* @remarks
|
|
@@ -25605,7 +25609,7 @@ declare namespace Excel {
|
|
|
25605
25609
|
*/
|
|
25606
25610
|
getItem(key: string): Excel.Setting;
|
|
25607
25611
|
/**
|
|
25608
|
-
* Gets a setting entry via the key. If the setting does not exist, then this
|
|
25612
|
+
* 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`.
|
|
25609
25613
|
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}.
|
|
25610
25614
|
*
|
|
25611
25615
|
* @remarks
|
|
@@ -25764,7 +25768,7 @@ declare namespace Excel {
|
|
|
25764
25768
|
*/
|
|
25765
25769
|
getItem(name: string): Excel.NamedItem;
|
|
25766
25770
|
/**
|
|
25767
|
-
* Gets a `NamedItem` object using its name. If the object does not exist, then this
|
|
25771
|
+
* 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`.
|
|
25768
25772
|
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}.
|
|
25769
25773
|
*
|
|
25770
25774
|
* @remarks
|
|
@@ -25821,7 +25825,7 @@ declare namespace Excel {
|
|
|
25821
25825
|
*/
|
|
25822
25826
|
readonly worksheet: Excel.Worksheet;
|
|
25823
25827
|
/**
|
|
25824
|
-
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
|
|
25828
|
+
* 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`.
|
|
25825
25829
|
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}.
|
|
25826
25830
|
*
|
|
25827
25831
|
* @remarks
|
|
@@ -25900,7 +25904,7 @@ declare namespace Excel {
|
|
|
25900
25904
|
*/
|
|
25901
25905
|
getRange(): Excel.Range;
|
|
25902
25906
|
/**
|
|
25903
|
-
* Returns the range object that is associated with the name. If the named item's type is not a range, then this
|
|
25907
|
+
* 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`.
|
|
25904
25908
|
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}.
|
|
25905
25909
|
*
|
|
25906
25910
|
* @remarks
|
|
@@ -26194,7 +26198,7 @@ declare namespace Excel {
|
|
|
26194
26198
|
*/
|
|
26195
26199
|
getItemAt(index: number): Excel.Binding;
|
|
26196
26200
|
/**
|
|
26197
|
-
* Gets a binding object by ID. If the binding object does not exist, then this
|
|
26201
|
+
* 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`.
|
|
26198
26202
|
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}.
|
|
26199
26203
|
*
|
|
26200
26204
|
* @remarks
|
|
@@ -26281,7 +26285,7 @@ declare namespace Excel {
|
|
|
26281
26285
|
*/
|
|
26282
26286
|
getItemAt(index: number): Excel.Table;
|
|
26283
26287
|
/**
|
|
26284
|
-
* Gets a table by name or ID. If the table doesn't exist, then this
|
|
26288
|
+
* 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`.
|
|
26285
26289
|
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}.
|
|
26286
26290
|
*
|
|
26287
26291
|
* @remarks
|
|
@@ -26377,7 +26381,7 @@ declare namespace Excel {
|
|
|
26377
26381
|
getItem(key: string): Excel.Table;
|
|
26378
26382
|
/**
|
|
26379
26383
|
* Gets a table by name or ID.
|
|
26380
|
-
If the table object does not exist, then this
|
|
26384
|
+
If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
26381
26385
|
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}.
|
|
26382
26386
|
*
|
|
26383
26387
|
* @remarks
|
|
@@ -26707,7 +26711,7 @@ declare namespace Excel {
|
|
|
26707
26711
|
*/
|
|
26708
26712
|
getItemAt(index: number): Excel.TableColumn;
|
|
26709
26713
|
/**
|
|
26710
|
-
* Gets a column object by name or ID. If the column doesn't exist, then this
|
|
26714
|
+
* 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`.
|
|
26711
26715
|
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}.
|
|
26712
26716
|
*
|
|
26713
26717
|
* @remarks
|
|
@@ -28107,7 +28111,7 @@ declare namespace Excel {
|
|
|
28107
28111
|
*/
|
|
28108
28112
|
getItemAt(index: number): Excel.Chart;
|
|
28109
28113
|
/**
|
|
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
|
|
28114
|
+
* 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`.
|
|
28111
28115
|
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}.
|
|
28112
28116
|
*
|
|
28113
28117
|
* @remarks
|
|
@@ -28386,7 +28390,7 @@ declare namespace Excel {
|
|
|
28386
28390
|
*/
|
|
28387
28391
|
getDataTable(): Excel.ChartDataTable;
|
|
28388
28392
|
/**
|
|
28389
|
-
* Gets the data table on the chart. If the chart doesn't allow a data table, then this
|
|
28393
|
+
* 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`.
|
|
28390
28394
|
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}.
|
|
28391
28395
|
*
|
|
28392
28396
|
* @remarks
|
|
@@ -33360,7 +33364,7 @@ declare namespace Excel {
|
|
|
33360
33364
|
getItem(id: string): Excel.CustomXmlPart;
|
|
33361
33365
|
/**
|
|
33362
33366
|
* Gets a custom XML part based on its ID.
|
|
33363
|
-
If the `CustomXmlPart` does not exist, then this
|
|
33367
|
+
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33364
33368
|
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}.
|
|
33365
33369
|
*
|
|
33366
33370
|
* @remarks
|
|
@@ -33456,7 +33460,7 @@ declare namespace Excel {
|
|
|
33456
33460
|
getItem(id: string): Excel.CustomXmlPart;
|
|
33457
33461
|
/**
|
|
33458
33462
|
* Gets a custom XML part based on its ID.
|
|
33459
|
-
If the `CustomXmlPart` does not exist, then this
|
|
33463
|
+
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33460
33464
|
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}.
|
|
33461
33465
|
*
|
|
33462
33466
|
* @remarks
|
|
@@ -33597,7 +33601,7 @@ declare namespace Excel {
|
|
|
33597
33601
|
*/
|
|
33598
33602
|
getItem(key: string): Excel.PivotTable;
|
|
33599
33603
|
/**
|
|
33600
|
-
* Gets a PivotTable by name. If the PivotTable does not exist, then this
|
|
33604
|
+
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33601
33605
|
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}.
|
|
33602
33606
|
*
|
|
33603
33607
|
* @remarks
|
|
@@ -33670,7 +33674,7 @@ declare namespace Excel {
|
|
|
33670
33674
|
*/
|
|
33671
33675
|
getItem(name: string): Excel.PivotTable;
|
|
33672
33676
|
/**
|
|
33673
|
-
* Gets a PivotTable by name. If the PivotTable does not exist, then this
|
|
33677
|
+
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33674
33678
|
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}.
|
|
33675
33679
|
*
|
|
33676
33680
|
* @remarks
|
|
@@ -34133,7 +34137,7 @@ declare namespace Excel {
|
|
|
34133
34137
|
*/
|
|
34134
34138
|
getItem(name: string): Excel.PivotHierarchy;
|
|
34135
34139
|
/**
|
|
34136
|
-
* Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this
|
|
34140
|
+
* Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34137
34141
|
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}.
|
|
34138
34142
|
*
|
|
34139
34143
|
* @remarks
|
|
@@ -34267,7 +34271,7 @@ declare namespace Excel {
|
|
|
34267
34271
|
*/
|
|
34268
34272
|
getItem(name: string): Excel.RowColumnPivotHierarchy;
|
|
34269
34273
|
/**
|
|
34270
|
-
* Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this
|
|
34274
|
+
* Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34271
34275
|
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}.
|
|
34272
34276
|
*
|
|
34273
34277
|
* @remarks
|
|
@@ -34422,7 +34426,7 @@ declare namespace Excel {
|
|
|
34422
34426
|
*/
|
|
34423
34427
|
getItem(name: string): Excel.FilterPivotHierarchy;
|
|
34424
34428
|
/**
|
|
34425
|
-
* Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this
|
|
34429
|
+
* Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34426
34430
|
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}.
|
|
34427
34431
|
*
|
|
34428
34432
|
* @remarks
|
|
@@ -34583,7 +34587,7 @@ declare namespace Excel {
|
|
|
34583
34587
|
*/
|
|
34584
34588
|
getItem(name: string): Excel.DataPivotHierarchy;
|
|
34585
34589
|
/**
|
|
34586
|
-
* Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this
|
|
34590
|
+
* Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34587
34591
|
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}.
|
|
34588
34592
|
*
|
|
34589
34593
|
* @remarks
|
|
@@ -34778,7 +34782,7 @@ declare namespace Excel {
|
|
|
34778
34782
|
*/
|
|
34779
34783
|
getItem(name: string): Excel.PivotField;
|
|
34780
34784
|
/**
|
|
34781
|
-
* Gets a PivotField by name. If the PivotField does not exist, then this
|
|
34785
|
+
* Gets a PivotField by name. If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34782
34786
|
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}.
|
|
34783
34787
|
*
|
|
34784
34788
|
* @remarks
|
|
@@ -35020,7 +35024,7 @@ declare namespace Excel {
|
|
|
35020
35024
|
*/
|
|
35021
35025
|
getItem(name: string): Excel.PivotItem;
|
|
35022
35026
|
/**
|
|
35023
|
-
* Gets a PivotItem by name. If the PivotItem does not exist, then this
|
|
35027
|
+
* Gets a PivotItem by name. If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35024
35028
|
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}.
|
|
35025
35029
|
*
|
|
35026
35030
|
* @remarks
|
|
@@ -35546,7 +35550,7 @@ declare namespace Excel {
|
|
|
35546
35550
|
*/
|
|
35547
35551
|
getItem(key: string): Excel.WorksheetCustomProperty;
|
|
35548
35552
|
/**
|
|
35549
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this
|
|
35553
|
+
* 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`.
|
|
35550
35554
|
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}.
|
|
35551
35555
|
*
|
|
35552
35556
|
* @remarks
|
|
@@ -35589,7 +35593,7 @@ declare namespace Excel {
|
|
|
35589
35593
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35590
35594
|
context: RequestContext;
|
|
35591
35595
|
/**
|
|
35592
|
-
* Gets the collection of custom properties of the workbook.
|
|
35596
|
+
* Gets the collection of custom properties of the workbook.
|
|
35593
35597
|
*
|
|
35594
35598
|
* @remarks
|
|
35595
35599
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35624,7 +35628,7 @@ declare namespace Excel {
|
|
|
35624
35628
|
*/
|
|
35625
35629
|
company: string;
|
|
35626
35630
|
/**
|
|
35627
|
-
* Gets the creation date of the workbook.
|
|
35631
|
+
* Gets the creation date of the workbook.
|
|
35628
35632
|
*
|
|
35629
35633
|
* @remarks
|
|
35630
35634
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35638,7 +35642,7 @@ declare namespace Excel {
|
|
|
35638
35642
|
*/
|
|
35639
35643
|
keywords: string;
|
|
35640
35644
|
/**
|
|
35641
|
-
* Gets the last author of the workbook.
|
|
35645
|
+
* Gets the last author of the workbook.
|
|
35642
35646
|
*
|
|
35643
35647
|
* @remarks
|
|
35644
35648
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35652,7 +35656,7 @@ declare namespace Excel {
|
|
|
35652
35656
|
*/
|
|
35653
35657
|
manager: string;
|
|
35654
35658
|
/**
|
|
35655
|
-
* Gets the revision number of the workbook.
|
|
35659
|
+
* Gets the revision number of the workbook.
|
|
35656
35660
|
*
|
|
35657
35661
|
* @remarks
|
|
35658
35662
|
* [Api set: ExcelApi 1.7]
|
|
@@ -35824,7 +35828,7 @@ declare namespace Excel {
|
|
|
35824
35828
|
*/
|
|
35825
35829
|
getItem(key: string): Excel.CustomProperty;
|
|
35826
35830
|
/**
|
|
35827
|
-
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this
|
|
35831
|
+
* 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`.
|
|
35828
35832
|
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}.
|
|
35829
35833
|
*
|
|
35830
35834
|
* @remarks
|
|
@@ -35921,7 +35925,7 @@ declare namespace Excel {
|
|
|
35921
35925
|
getItemAt(index: number): Excel.ConditionalFormat;
|
|
35922
35926
|
/**
|
|
35923
35927
|
* Returns a conditional format identified by its ID.
|
|
35924
|
-
If the conditional format object does not exist, then this
|
|
35928
|
+
If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35925
35929
|
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}.
|
|
35926
35930
|
*
|
|
35927
35931
|
* @remarks
|
|
@@ -36136,7 +36140,7 @@ declare namespace Excel {
|
|
|
36136
36140
|
*/
|
|
36137
36141
|
getRange(): Excel.Range;
|
|
36138
36142
|
/**
|
|
36139
|
-
* Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this
|
|
36143
|
+
* 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`.
|
|
36140
36144
|
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}.
|
|
36141
36145
|
*
|
|
36142
36146
|
* @remarks
|
|
@@ -37745,7 +37749,7 @@ declare namespace Excel {
|
|
|
37745
37749
|
getItemAt(index: number): Excel.Style;
|
|
37746
37750
|
/**
|
|
37747
37751
|
* Gets a style by name.
|
|
37748
|
-
If the style object does not exist, then this
|
|
37752
|
+
If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37749
37753
|
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}.
|
|
37750
37754
|
*
|
|
37751
37755
|
* @remarks
|
|
@@ -37826,7 +37830,7 @@ declare namespace Excel {
|
|
|
37826
37830
|
*/
|
|
37827
37831
|
getItem(name: string): Excel.TableStyle;
|
|
37828
37832
|
/**
|
|
37829
|
-
* Gets a `TableStyle` by name. If the table style does not exist, then this
|
|
37833
|
+
* 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`.
|
|
37830
37834
|
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}.
|
|
37831
37835
|
*
|
|
37832
37836
|
* @remarks
|
|
@@ -37990,7 +37994,7 @@ declare namespace Excel {
|
|
|
37990
37994
|
*/
|
|
37991
37995
|
getItem(name: string): Excel.PivotTableStyle;
|
|
37992
37996
|
/**
|
|
37993
|
-
* Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this
|
|
37997
|
+
* Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37994
37998
|
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}.
|
|
37995
37999
|
*
|
|
37996
38000
|
* @remarks
|
|
@@ -38154,7 +38158,7 @@ declare namespace Excel {
|
|
|
38154
38158
|
*/
|
|
38155
38159
|
getItem(name: string): Excel.SlicerStyle;
|
|
38156
38160
|
/**
|
|
38157
|
-
* Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this
|
|
38161
|
+
* 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`.
|
|
38158
38162
|
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}.
|
|
38159
38163
|
*
|
|
38160
38164
|
* @remarks
|
|
@@ -38318,7 +38322,7 @@ declare namespace Excel {
|
|
|
38318
38322
|
*/
|
|
38319
38323
|
getItem(name: string): Excel.TimelineStyle;
|
|
38320
38324
|
/**
|
|
38321
|
-
* Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this
|
|
38325
|
+
* 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`.
|
|
38322
38326
|
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}.
|
|
38323
38327
|
*
|
|
38324
38328
|
* @remarks
|
|
@@ -38600,7 +38604,7 @@ declare namespace Excel {
|
|
|
38600
38604
|
*/
|
|
38601
38605
|
getPrintArea(): Excel.RangeAreas;
|
|
38602
38606
|
/**
|
|
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
|
|
38607
|
+
* 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`.
|
|
38604
38608
|
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}.
|
|
38605
38609
|
*
|
|
38606
38610
|
* @remarks
|
|
@@ -38615,7 +38619,7 @@ declare namespace Excel {
|
|
|
38615
38619
|
*/
|
|
38616
38620
|
getPrintTitleColumns(): Excel.Range;
|
|
38617
38621
|
/**
|
|
38618
|
-
* Gets the range object representing the title columns. If not set, then this
|
|
38622
|
+
* Gets the range object representing the title columns. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38619
38623
|
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}.
|
|
38620
38624
|
*
|
|
38621
38625
|
* @remarks
|
|
@@ -38630,7 +38634,7 @@ declare namespace Excel {
|
|
|
38630
38634
|
*/
|
|
38631
38635
|
getPrintTitleRows(): Excel.Range;
|
|
38632
38636
|
/**
|
|
38633
|
-
* Gets the range object representing the title rows. If not set, then this
|
|
38637
|
+
* Gets the range object representing the title rows. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38634
38638
|
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}.
|
|
38635
38639
|
*
|
|
38636
38640
|
* @remarks
|
|
@@ -39351,7 +39355,7 @@ declare namespace Excel {
|
|
|
39351
39355
|
getItemByReplyId(replyId: string): Excel.Comment;
|
|
39352
39356
|
/**
|
|
39353
39357
|
* Gets a comment from the collection based on its ID.
|
|
39354
|
-
If the comment object does not exist, then this
|
|
39358
|
+
If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39355
39359
|
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}.
|
|
39356
39360
|
*
|
|
39357
39361
|
* @remarks
|
|
@@ -39606,7 +39610,7 @@ declare namespace Excel {
|
|
|
39606
39610
|
getItemAt(index: number): Excel.CommentReply;
|
|
39607
39611
|
/**
|
|
39608
39612
|
* Returns a comment reply identified by its ID.
|
|
39609
|
-
If the comment reply object does not exist, then this
|
|
39613
|
+
If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39610
39614
|
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}.
|
|
39611
39615
|
*
|
|
39612
39616
|
* @remarks
|
|
@@ -39885,7 +39889,7 @@ declare namespace Excel {
|
|
|
39885
39889
|
getItemAt(index: number): Excel.Shape;
|
|
39886
39890
|
/**
|
|
39887
39891
|
* Gets a shape using its name or ID.
|
|
39888
|
-
If the shape object does not exist, then this
|
|
39892
|
+
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39889
39893
|
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}.
|
|
39890
39894
|
*
|
|
39891
39895
|
* @remarks
|
|
@@ -39978,7 +39982,7 @@ declare namespace Excel {
|
|
|
39978
39982
|
*/
|
|
39979
39983
|
readonly parentGroup: Excel.Shape;
|
|
39980
39984
|
/**
|
|
39981
|
-
* Returns the text frame object of this shape.
|
|
39985
|
+
* Returns the text frame object of this shape.
|
|
39982
39986
|
*
|
|
39983
39987
|
* @remarks
|
|
39984
39988
|
* [Api set: ExcelApi 1.9]
|
|
@@ -40494,7 +40498,7 @@ declare namespace Excel {
|
|
|
40494
40498
|
getItemAt(index: number): Excel.Shape;
|
|
40495
40499
|
/**
|
|
40496
40500
|
* Gets a shape using its name or ID.
|
|
40497
|
-
If the shape object does not exist, then this
|
|
40501
|
+
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
40498
40502
|
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}.
|
|
40499
40503
|
*
|
|
40500
40504
|
* @remarks
|
|
@@ -41385,7 +41389,7 @@ declare namespace Excel {
|
|
|
41385
41389
|
*/
|
|
41386
41390
|
getItemAt(index: number): Excel.Slicer;
|
|
41387
41391
|
/**
|
|
41388
|
-
* Gets a slicer using its name or ID. If the slicer doesn't exist, then this
|
|
41392
|
+
* 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`.
|
|
41389
41393
|
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}.
|
|
41390
41394
|
*
|
|
41391
41395
|
* @remarks
|
|
@@ -41529,7 +41533,7 @@ declare namespace Excel {
|
|
|
41529
41533
|
*/
|
|
41530
41534
|
getItemAt(index: number): Excel.SlicerItem;
|
|
41531
41535
|
/**
|
|
41532
|
-
* Gets a slicer item using its key or name. If the slicer item doesn't exist, then this
|
|
41536
|
+
* 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`.
|
|
41533
41537
|
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}.
|
|
41534
41538
|
*
|
|
41535
41539
|
* @remarks
|
|
@@ -52449,6 +52453,7 @@ declare namespace Excel {
|
|
|
52449
52453
|
nonBlankCellOffSheet = "NonBlankCellOffSheet",
|
|
52450
52454
|
notImplemented = "NotImplemented",
|
|
52451
52455
|
openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked",
|
|
52456
|
+
operationCellsExceedLimit = "OperationCellsExceedLimit",
|
|
52452
52457
|
pivotTableRangeConflict = "PivotTableRangeConflict",
|
|
52453
52458
|
rangeExceedsLimit = "RangeExceedsLimit",
|
|
52454
52459
|
refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
|
|
@@ -55694,7 +55699,7 @@ declare namespace Excel {
|
|
|
55694
55699
|
*/
|
|
55695
55700
|
manager?: string;
|
|
55696
55701
|
/**
|
|
55697
|
-
* Gets the revision number of the workbook.
|
|
55702
|
+
* Gets the revision number of the workbook.
|
|
55698
55703
|
*
|
|
55699
55704
|
* @remarks
|
|
55700
55705
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61699,7 +61704,7 @@ declare namespace Excel {
|
|
|
61699
61704
|
/** An interface describing the data returned by calling `documentProperties.toJSON()`. */
|
|
61700
61705
|
interface DocumentPropertiesData {
|
|
61701
61706
|
/**
|
|
61702
|
-
* Gets the collection of custom properties of the workbook.
|
|
61707
|
+
* Gets the collection of custom properties of the workbook.
|
|
61703
61708
|
*
|
|
61704
61709
|
* @remarks
|
|
61705
61710
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61734,7 +61739,7 @@ declare namespace Excel {
|
|
|
61734
61739
|
*/
|
|
61735
61740
|
company?: string;
|
|
61736
61741
|
/**
|
|
61737
|
-
* Gets the creation date of the workbook.
|
|
61742
|
+
* Gets the creation date of the workbook.
|
|
61738
61743
|
*
|
|
61739
61744
|
* @remarks
|
|
61740
61745
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61748,7 +61753,7 @@ declare namespace Excel {
|
|
|
61748
61753
|
*/
|
|
61749
61754
|
keywords?: string;
|
|
61750
61755
|
/**
|
|
61751
|
-
* Gets the last author of the workbook.
|
|
61756
|
+
* Gets the last author of the workbook.
|
|
61752
61757
|
*
|
|
61753
61758
|
* @remarks
|
|
61754
61759
|
* [Api set: ExcelApi 1.7]
|
|
@@ -61762,7 +61767,7 @@ declare namespace Excel {
|
|
|
61762
61767
|
*/
|
|
61763
61768
|
manager?: string;
|
|
61764
61769
|
/**
|
|
61765
|
-
* Gets the revision number of the workbook.
|
|
61770
|
+
* Gets the revision number of the workbook.
|
|
61766
61771
|
*
|
|
61767
61772
|
* @remarks
|
|
61768
61773
|
* [Api set: ExcelApi 1.7]
|
|
@@ -64990,7 +64995,7 @@ declare namespace Excel {
|
|
|
64990
64995
|
*/
|
|
64991
64996
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
64992
64997
|
/**
|
|
64993
|
-
* 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
|
|
64998
|
+
* 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`.
|
|
64994
64999
|
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}.
|
|
64995
65000
|
*
|
|
64996
65001
|
* @remarks
|
|
@@ -65073,7 +65078,7 @@ declare namespace Excel {
|
|
|
65073
65078
|
*/
|
|
65074
65079
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
65075
65080
|
/**
|
|
65076
|
-
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
|
|
65081
|
+
* 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`.
|
|
65077
65082
|
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}.
|
|
65078
65083
|
*
|
|
65079
65084
|
* @remarks
|
|
@@ -70612,7 +70617,7 @@ declare namespace Excel {
|
|
|
70612
70617
|
*/
|
|
70613
70618
|
company?: boolean;
|
|
70614
70619
|
/**
|
|
70615
|
-
* Gets the creation date of the workbook.
|
|
70620
|
+
* Gets the creation date of the workbook.
|
|
70616
70621
|
*
|
|
70617
70622
|
* @remarks
|
|
70618
70623
|
* [Api set: ExcelApi 1.7]
|
|
@@ -70626,7 +70631,7 @@ declare namespace Excel {
|
|
|
70626
70631
|
*/
|
|
70627
70632
|
keywords?: boolean;
|
|
70628
70633
|
/**
|
|
70629
|
-
* Gets the last author of the workbook.
|
|
70634
|
+
* Gets the last author of the workbook.
|
|
70630
70635
|
*
|
|
70631
70636
|
* @remarks
|
|
70632
70637
|
* [Api set: ExcelApi 1.7]
|
|
@@ -70640,7 +70645,7 @@ declare namespace Excel {
|
|
|
70640
70645
|
*/
|
|
70641
70646
|
manager?: boolean;
|
|
70642
70647
|
/**
|
|
70643
|
-
* Gets the revision number of the workbook.
|
|
70648
|
+
* Gets the revision number of the workbook.
|
|
70644
70649
|
*
|
|
70645
70650
|
* @remarks
|
|
70646
70651
|
* [Api set: ExcelApi 1.7]
|
|
@@ -73164,7 +73169,7 @@ declare namespace Excel {
|
|
|
73164
73169
|
*/
|
|
73165
73170
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73166
73171
|
/**
|
|
73167
|
-
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73172
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73168
73173
|
*
|
|
73169
73174
|
* @remarks
|
|
73170
73175
|
* [Api set: ExcelApi 1.9]
|
|
@@ -73356,7 +73361,7 @@ declare namespace Excel {
|
|
|
73356
73361
|
*/
|
|
73357
73362
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73358
73363
|
/**
|
|
73359
|
-
* Returns the text frame object of this shape.
|
|
73364
|
+
* Returns the text frame object of this shape.
|
|
73360
73365
|
*
|
|
73361
73366
|
* @remarks
|
|
73362
73367
|
* [Api set: ExcelApi 1.9]
|
|
@@ -73632,7 +73637,7 @@ declare namespace Excel {
|
|
|
73632
73637
|
*/
|
|
73633
73638
|
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
|
|
73634
73639
|
/**
|
|
73635
|
-
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73640
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
73636
73641
|
*
|
|
73637
73642
|
* @remarks
|
|
73638
73643
|
* [Api set: ExcelApi 1.9]
|
|
@@ -93490,32 +93495,91 @@ declare namespace OneNote {
|
|
|
93490
93495
|
declare namespace Visio {
|
|
93491
93496
|
/**
|
|
93492
93497
|
*
|
|
93493
|
-
* Provides information about the
|
|
93498
|
+
* Provides information about the shape that raised the ShapeMouseEnter event.
|
|
93494
93499
|
*
|
|
93495
93500
|
* [Api set: 1.1]
|
|
93496
93501
|
*/
|
|
93497
|
-
interface
|
|
93502
|
+
interface ShapeMouseEnterEventArgs {
|
|
93498
93503
|
/**
|
|
93499
93504
|
*
|
|
93500
|
-
* Gets the
|
|
93505
|
+
* Gets the name of the page which has the shape object that raised the ShapeMouseEnter event.
|
|
93501
93506
|
*
|
|
93502
93507
|
* [Api set: 1.1]
|
|
93503
93508
|
*/
|
|
93504
|
-
|
|
93509
|
+
pageName: string;
|
|
93505
93510
|
/**
|
|
93506
93511
|
*
|
|
93507
|
-
*
|
|
93512
|
+
* Gets the name of the shape object that raised the ShapeMouseEnter event.
|
|
93508
93513
|
*
|
|
93509
93514
|
* [Api set: 1.1]
|
|
93510
93515
|
*/
|
|
93511
|
-
|
|
93516
|
+
shapeName: string;
|
|
93517
|
+
}
|
|
93518
|
+
/**
|
|
93519
|
+
*
|
|
93520
|
+
* Provides information about the shape that raised the ShapeMouseLeave event.
|
|
93521
|
+
*
|
|
93522
|
+
* [Api set: 1.1]
|
|
93523
|
+
*/
|
|
93524
|
+
interface ShapeMouseLeaveEventArgs {
|
|
93512
93525
|
/**
|
|
93513
93526
|
*
|
|
93514
|
-
*
|
|
93527
|
+
* Gets the name of the page which has the shape object that raised the ShapeMouseLeave event.
|
|
93515
93528
|
*
|
|
93516
93529
|
* [Api set: 1.1]
|
|
93517
93530
|
*/
|
|
93518
|
-
|
|
93531
|
+
pageName: string;
|
|
93532
|
+
/**
|
|
93533
|
+
*
|
|
93534
|
+
* Gets the name of the shape object that raised the ShapeMouseLeave event.
|
|
93535
|
+
*
|
|
93536
|
+
* [Api set: 1.1]
|
|
93537
|
+
*/
|
|
93538
|
+
shapeName: string;
|
|
93539
|
+
}
|
|
93540
|
+
/**
|
|
93541
|
+
*
|
|
93542
|
+
* Provides information about the page that raised the PageLoadComplete event.
|
|
93543
|
+
*
|
|
93544
|
+
* [Api set: 1.1]
|
|
93545
|
+
*/
|
|
93546
|
+
interface PageLoadCompleteEventArgs {
|
|
93547
|
+
/**
|
|
93548
|
+
*
|
|
93549
|
+
* Gets the name of the page that raised the PageLoad event.
|
|
93550
|
+
*
|
|
93551
|
+
* [Api set: 1.1]
|
|
93552
|
+
*/
|
|
93553
|
+
pageName: string;
|
|
93554
|
+
/**
|
|
93555
|
+
*
|
|
93556
|
+
* Gets the success or failure of the PageLoadComplete event.
|
|
93557
|
+
*
|
|
93558
|
+
* [Api set: 1.1]
|
|
93559
|
+
*/
|
|
93560
|
+
success: boolean;
|
|
93561
|
+
}
|
|
93562
|
+
/**
|
|
93563
|
+
*
|
|
93564
|
+
* Provides information about the document that raised the DataRefreshComplete event.
|
|
93565
|
+
*
|
|
93566
|
+
* [Api set: 1.1]
|
|
93567
|
+
*/
|
|
93568
|
+
interface DataRefreshCompleteEventArgs {
|
|
93569
|
+
/**
|
|
93570
|
+
*
|
|
93571
|
+
* Gets the document object that raised the DataRefreshComplete event.
|
|
93572
|
+
*
|
|
93573
|
+
* [Api set: 1.1]
|
|
93574
|
+
*/
|
|
93575
|
+
document: Visio.Document;
|
|
93576
|
+
/**
|
|
93577
|
+
*
|
|
93578
|
+
* Gets the success or failure of the DataRefreshComplete event.
|
|
93579
|
+
*
|
|
93580
|
+
* [Api set: 1.1]
|
|
93581
|
+
*/
|
|
93582
|
+
success: boolean;
|
|
93519
93583
|
}
|
|
93520
93584
|
/**
|
|
93521
93585
|
*
|
|
@@ -93526,68 +93590,137 @@ declare namespace Visio {
|
|
|
93526
93590
|
interface SelectionChangedEventArgs {
|
|
93527
93591
|
/**
|
|
93528
93592
|
*
|
|
93529
|
-
* Gets the page
|
|
93593
|
+
* Gets the name of the page which has the ShapeCollection object that raised the SelectionChanged event.
|
|
93530
93594
|
*
|
|
93531
93595
|
* [Api set: 1.1]
|
|
93532
93596
|
*/
|
|
93533
|
-
|
|
93597
|
+
pageName: string;
|
|
93534
93598
|
/**
|
|
93535
93599
|
*
|
|
93536
|
-
* Gets the array of shape
|
|
93600
|
+
* Gets the array of shape names that raised the SelectionChanged event.
|
|
93537
93601
|
*
|
|
93538
93602
|
* [Api set: 1.1]
|
|
93539
93603
|
*/
|
|
93540
|
-
|
|
93604
|
+
shapeNames: string[];
|
|
93541
93605
|
}
|
|
93542
93606
|
/**
|
|
93607
|
+
*
|
|
93608
|
+
* Provides information about the success or failure of the DocumentLoadComplete event.
|
|
93609
|
+
*
|
|
93543
93610
|
* [Api set: 1.1]
|
|
93544
93611
|
*/
|
|
93545
|
-
|
|
93546
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
93547
|
-
context: RequestContext;
|
|
93612
|
+
interface DocumentLoadCompleteEventArgs {
|
|
93548
93613
|
/**
|
|
93549
93614
|
*
|
|
93550
|
-
*
|
|
93615
|
+
* Gets the success or failure of the DocumentLoadComplete event.
|
|
93551
93616
|
*
|
|
93552
93617
|
* [Api set: 1.1]
|
|
93553
93618
|
*/
|
|
93554
|
-
|
|
93619
|
+
success: boolean;
|
|
93620
|
+
}
|
|
93621
|
+
/**
|
|
93622
|
+
*
|
|
93623
|
+
* Provides information about the page that raised the PageRenderComplete event.
|
|
93624
|
+
*
|
|
93625
|
+
* [Api set: 1.1]
|
|
93626
|
+
*/
|
|
93627
|
+
interface PageRenderCompleteEventArgs {
|
|
93555
93628
|
/**
|
|
93556
93629
|
*
|
|
93557
|
-
*
|
|
93630
|
+
* Gets the name of the page that raised the PageLoad event.
|
|
93558
93631
|
*
|
|
93559
93632
|
* [Api set: 1.1]
|
|
93560
93633
|
*/
|
|
93561
|
-
|
|
93634
|
+
pageName: string;
|
|
93562
93635
|
/**
|
|
93563
93636
|
*
|
|
93564
|
-
*
|
|
93637
|
+
* Gets the success/failure of the PageRender event.
|
|
93565
93638
|
*
|
|
93566
93639
|
* [Api set: 1.1]
|
|
93567
93640
|
*/
|
|
93568
|
-
|
|
93641
|
+
success: boolean;
|
|
93642
|
+
}
|
|
93643
|
+
/**
|
|
93644
|
+
*
|
|
93645
|
+
* Provides information about DocumentError event
|
|
93646
|
+
*
|
|
93647
|
+
* [Api set: 1.1]
|
|
93648
|
+
*/
|
|
93649
|
+
interface DocumentErrorEventArgs {
|
|
93569
93650
|
/**
|
|
93570
93651
|
*
|
|
93571
|
-
*
|
|
93652
|
+
* Visio Error code
|
|
93653
|
+
*
|
|
93654
|
+
* [Api set: 1.1]
|
|
93655
|
+
*/
|
|
93656
|
+
errorCode: number;
|
|
93657
|
+
/**
|
|
93658
|
+
*
|
|
93659
|
+
* Message about error that occured
|
|
93660
|
+
*
|
|
93661
|
+
* [Api set: 1.1]
|
|
93662
|
+
*/
|
|
93663
|
+
errorMessage: string;
|
|
93664
|
+
/**
|
|
93665
|
+
*
|
|
93666
|
+
* Tells if the error is critical or not. If critical the session cannot continue.
|
|
93667
|
+
*
|
|
93668
|
+
* [Api set: 1.1]
|
|
93669
|
+
*/
|
|
93670
|
+
isCritical: boolean;
|
|
93671
|
+
}
|
|
93672
|
+
/**
|
|
93673
|
+
*
|
|
93674
|
+
* Provides information about the TaskPaneStateChanged event.
|
|
93675
|
+
*
|
|
93676
|
+
* [Api set: 1.1]
|
|
93677
|
+
*/
|
|
93678
|
+
interface TaskPaneStateChangedEventArgs {
|
|
93679
|
+
/**
|
|
93680
|
+
*
|
|
93681
|
+
* Current state of the taskpane
|
|
93572
93682
|
*
|
|
93573
93683
|
* [Api set: 1.1]
|
|
93574
93684
|
*/
|
|
93575
93685
|
isVisible: boolean;
|
|
93576
93686
|
/**
|
|
93577
93687
|
*
|
|
93578
|
-
*
|
|
93688
|
+
* Type of the TaskPane.
|
|
93579
93689
|
*
|
|
93580
93690
|
* [Api set: 1.1]
|
|
93581
93691
|
*/
|
|
93582
|
-
|
|
93692
|
+
paneType: Visio.TaskPaneType | "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings";
|
|
93693
|
+
}
|
|
93694
|
+
/**
|
|
93695
|
+
*
|
|
93696
|
+
* Represents the Application.
|
|
93697
|
+
*
|
|
93698
|
+
* [Api set: 1.1]
|
|
93699
|
+
*/
|
|
93700
|
+
class Application extends OfficeExtension.ClientObject {
|
|
93701
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
93702
|
+
context: RequestContext;
|
|
93583
93703
|
/**
|
|
93584
93704
|
*
|
|
93585
|
-
*
|
|
93705
|
+
* Show or hide the iFrame application borders.
|
|
93586
93706
|
*
|
|
93587
93707
|
* [Api set: 1.1]
|
|
93588
93708
|
*/
|
|
93589
|
-
|
|
93709
|
+
showBorders: boolean;
|
|
93710
|
+
/**
|
|
93711
|
+
*
|
|
93712
|
+
* Show or hide the standard toolbars.
|
|
93713
|
+
*
|
|
93714
|
+
* [Api set: 1.1]
|
|
93715
|
+
*/
|
|
93716
|
+
showToolbars: boolean;
|
|
93590
93717
|
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
93718
|
+
*
|
|
93719
|
+
* @remarks
|
|
93720
|
+
*
|
|
93721
|
+
* This method has the following additional signature:
|
|
93722
|
+
*
|
|
93723
|
+
* `set(properties: Visio.Application): void`
|
|
93591
93724
|
*
|
|
93592
93725
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
93593
93726
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
@@ -93597,14 +93730,24 @@ declare namespace Visio {
|
|
|
93597
93730
|
set(properties: Visio.Application): void;
|
|
93598
93731
|
/**
|
|
93599
93732
|
*
|
|
93600
|
-
*
|
|
93733
|
+
* Sets the visibility of a specific toolbar in the application.
|
|
93601
93734
|
*
|
|
93602
93735
|
* [Api set: 1.1]
|
|
93603
93736
|
*
|
|
93604
|
-
* @param
|
|
93605
|
-
* @param
|
|
93737
|
+
* @param id The type of the Toolbar
|
|
93738
|
+
* @param show Whether the toolbar is visibile or not.
|
|
93606
93739
|
*/
|
|
93607
|
-
|
|
93740
|
+
showToolbar(id: Visio.ToolBarType, show: boolean): void;
|
|
93741
|
+
/**
|
|
93742
|
+
*
|
|
93743
|
+
* Sets the visibility of a specific toolbar in the application.
|
|
93744
|
+
*
|
|
93745
|
+
* [Api set: 1.1]
|
|
93746
|
+
*
|
|
93747
|
+
* @param id The type of the Toolbar
|
|
93748
|
+
* @param show Whether the toolbar is visibile or not.
|
|
93749
|
+
*/
|
|
93750
|
+
showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;
|
|
93608
93751
|
/**
|
|
93609
93752
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93610
93753
|
*
|
|
@@ -93631,8 +93774,15 @@ declare namespace Visio {
|
|
|
93631
93774
|
* Whereas the original Visio.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93632
93775
|
*/
|
|
93633
93776
|
toJSON(): Visio.Interfaces.ApplicationData;
|
|
93777
|
+
/**
|
|
93778
|
+
* Set mock data
|
|
93779
|
+
*/
|
|
93780
|
+
setMockData(data: Visio.Interfaces.ApplicationData): void;
|
|
93634
93781
|
}
|
|
93635
93782
|
/**
|
|
93783
|
+
*
|
|
93784
|
+
* Represents the Document class.
|
|
93785
|
+
*
|
|
93636
93786
|
* [Api set: 1.1]
|
|
93637
93787
|
*/
|
|
93638
93788
|
class Document extends OfficeExtension.ClientObject {
|
|
@@ -93654,40 +93804,18 @@ declare namespace Visio {
|
|
|
93654
93804
|
readonly pages: Visio.PageCollection;
|
|
93655
93805
|
/**
|
|
93656
93806
|
*
|
|
93657
|
-
*
|
|
93658
|
-
*
|
|
93659
|
-
* [Api set: 1.1]
|
|
93660
|
-
*/
|
|
93661
|
-
description: string;
|
|
93662
|
-
/**
|
|
93663
|
-
*
|
|
93664
|
-
* Returns the name of the document, including the drive and path. Read-only.
|
|
93665
|
-
*
|
|
93666
|
-
* [Api set: 1.1]
|
|
93667
|
-
*/
|
|
93668
|
-
readonly fullName: string;
|
|
93669
|
-
/**
|
|
93670
|
-
*
|
|
93671
|
-
* Returns the ID of the document. Read-only
|
|
93807
|
+
* Returns the DocumentView object. Read-only.
|
|
93672
93808
|
*
|
|
93673
93809
|
* [Api set: 1.1]
|
|
93674
93810
|
*/
|
|
93675
|
-
readonly
|
|
93676
|
-
/**
|
|
93811
|
+
readonly view: Visio.DocumentView;
|
|
93812
|
+
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
93677
93813
|
*
|
|
93678
|
-
*
|
|
93814
|
+
* @remarks
|
|
93679
93815
|
*
|
|
93680
|
-
*
|
|
93681
|
-
*/
|
|
93682
|
-
readonly index: number;
|
|
93683
|
-
/**
|
|
93816
|
+
* This method has the following additional signature:
|
|
93684
93817
|
*
|
|
93685
|
-
*
|
|
93686
|
-
*
|
|
93687
|
-
* [Api set: 1.1]
|
|
93688
|
-
*/
|
|
93689
|
-
readonly name: string;
|
|
93690
|
-
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
93818
|
+
* `set(properties: Visio.Document): void`
|
|
93691
93819
|
*
|
|
93692
93820
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
93693
93821
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
@@ -93697,21 +93825,14 @@ declare namespace Visio {
|
|
|
93697
93825
|
set(properties: Visio.Document): void;
|
|
93698
93826
|
/**
|
|
93699
93827
|
*
|
|
93700
|
-
*
|
|
93701
|
-
*
|
|
93702
|
-
* [Api set: 1.1]
|
|
93703
|
-
*/
|
|
93704
|
-
close(): void;
|
|
93705
|
-
/**
|
|
93706
|
-
*
|
|
93707
|
-
* Returns the active page of the document.
|
|
93828
|
+
* Returns the Active Page of the document.
|
|
93708
93829
|
*
|
|
93709
93830
|
* [Api set: 1.1]
|
|
93710
93831
|
*/
|
|
93711
93832
|
getActivePage(): Visio.Page;
|
|
93712
93833
|
/**
|
|
93713
93834
|
*
|
|
93714
|
-
* Set the
|
|
93835
|
+
* Set the Active Page of the document.
|
|
93715
93836
|
*
|
|
93716
93837
|
* [Api set: 1.1]
|
|
93717
93838
|
*
|
|
@@ -93720,28 +93841,35 @@ declare namespace Visio {
|
|
|
93720
93841
|
setActivePage(PageName: string): void;
|
|
93721
93842
|
/**
|
|
93722
93843
|
*
|
|
93723
|
-
* Show or
|
|
93844
|
+
* Show or Hide a TaskPane.
|
|
93724
93845
|
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
|
|
93725
93846
|
*
|
|
93726
93847
|
* [Api set: 1.1]
|
|
93727
93848
|
*
|
|
93728
|
-
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
93729
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
|
|
93730
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
|
|
93849
|
+
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
93850
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
|
|
93851
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
|
|
93731
93852
|
*/
|
|
93732
93853
|
showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;
|
|
93733
93854
|
/**
|
|
93734
93855
|
*
|
|
93735
|
-
* Show or
|
|
93856
|
+
* Show or Hide a TaskPane.
|
|
93736
93857
|
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
|
|
93737
93858
|
*
|
|
93738
93859
|
* [Api set: 1.1]
|
|
93739
93860
|
*
|
|
93740
|
-
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
93741
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
|
|
93742
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
|
|
93861
|
+
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
93862
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
|
|
93863
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
|
|
93743
93864
|
*/
|
|
93744
93865
|
showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
|
|
93866
|
+
/**
|
|
93867
|
+
*
|
|
93868
|
+
* Triggers the refresh of the data in the Diagram, for all pages.
|
|
93869
|
+
*
|
|
93870
|
+
* [Api set: 1.1]
|
|
93871
|
+
*/
|
|
93872
|
+
startDataRefresh(): void;
|
|
93745
93873
|
/**
|
|
93746
93874
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93747
93875
|
*
|
|
@@ -93765,12 +93893,40 @@ declare namespace Visio {
|
|
|
93765
93893
|
}): Visio.Document;
|
|
93766
93894
|
/**
|
|
93767
93895
|
*
|
|
93768
|
-
*
|
|
93896
|
+
* Occurs when the data is refreshed in the diagram.
|
|
93897
|
+
*
|
|
93898
|
+
* [Api set: 1.1]
|
|
93899
|
+
*
|
|
93900
|
+
* @eventproperty
|
|
93901
|
+
*/
|
|
93902
|
+
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
|
|
93903
|
+
/**
|
|
93904
|
+
*
|
|
93905
|
+
* Occurs when there is an expected or unexpected error occured in the session.
|
|
93769
93906
|
*
|
|
93770
93907
|
* [Api set: 1.1]
|
|
93771
93908
|
*
|
|
93772
93909
|
* @eventproperty
|
|
93773
93910
|
*/
|
|
93911
|
+
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;
|
|
93912
|
+
/**
|
|
93913
|
+
*
|
|
93914
|
+
* Occurs when the Document is loaded, refreshed, or changed.
|
|
93915
|
+
*
|
|
93916
|
+
* [Api set: 1.1]
|
|
93917
|
+
*
|
|
93918
|
+
* @eventproperty
|
|
93919
|
+
*/
|
|
93920
|
+
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;
|
|
93921
|
+
/**
|
|
93922
|
+
*
|
|
93923
|
+
* Occurs when the page is finished loading.
|
|
93924
|
+
*
|
|
93925
|
+
* [Api set: 1.1]
|
|
93926
|
+
*
|
|
93927
|
+
* @eventproperty
|
|
93928
|
+
*/
|
|
93929
|
+
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;
|
|
93774
93930
|
/**
|
|
93775
93931
|
*
|
|
93776
93932
|
* Occurs when the current selection of shapes changes.
|
|
@@ -93782,81 +93938,134 @@ declare namespace Visio {
|
|
|
93782
93938
|
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;
|
|
93783
93939
|
/**
|
|
93784
93940
|
*
|
|
93785
|
-
* Occurs when the
|
|
93941
|
+
* Occurs when the user moves the mouse pointer into the bounding box of a shape.
|
|
93942
|
+
*
|
|
93943
|
+
* [Api set: 1.1]
|
|
93944
|
+
*
|
|
93945
|
+
* @eventproperty
|
|
93946
|
+
*/
|
|
93947
|
+
readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;
|
|
93948
|
+
/**
|
|
93949
|
+
*
|
|
93950
|
+
* Occurs when the user moves the mouse out of the bounding box of a shape.
|
|
93786
93951
|
*
|
|
93787
93952
|
* [Api set: 1.1]
|
|
93788
93953
|
*
|
|
93789
93954
|
* @eventproperty
|
|
93790
93955
|
*/
|
|
93791
|
-
readonly
|
|
93956
|
+
readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;
|
|
93957
|
+
/**
|
|
93958
|
+
*
|
|
93959
|
+
* Occurs whenever a task pane state is changed
|
|
93960
|
+
*
|
|
93961
|
+
* [Api set: 1.1]
|
|
93962
|
+
*
|
|
93963
|
+
* @eventproperty
|
|
93964
|
+
*/
|
|
93965
|
+
readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;
|
|
93792
93966
|
/**
|
|
93793
93967
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
93794
93968
|
* Whereas the original Visio.Document object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93795
93969
|
*/
|
|
93796
93970
|
toJSON(): Visio.Interfaces.DocumentData;
|
|
93971
|
+
/**
|
|
93972
|
+
* Set mock data
|
|
93973
|
+
*/
|
|
93974
|
+
setMockData(data: Visio.Interfaces.DocumentData): void;
|
|
93797
93975
|
}
|
|
93798
93976
|
/**
|
|
93977
|
+
*
|
|
93978
|
+
* Represents the DocumentView class.
|
|
93979
|
+
*
|
|
93799
93980
|
* [Api set: 1.1]
|
|
93800
93981
|
*/
|
|
93801
|
-
class
|
|
93982
|
+
class DocumentView extends OfficeExtension.ClientObject {
|
|
93802
93983
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
93803
93984
|
context: RequestContext;
|
|
93804
|
-
/** Gets the loaded child items in this collection. */
|
|
93805
|
-
readonly items: Visio.Document[];
|
|
93806
93985
|
/**
|
|
93807
93986
|
*
|
|
93808
|
-
*
|
|
93987
|
+
* Disable Hyperlinks.
|
|
93809
93988
|
*
|
|
93810
93989
|
* [Api set: 1.1]
|
|
93990
|
+
*/
|
|
93991
|
+
disableHyperlinks: boolean;
|
|
93992
|
+
/**
|
|
93811
93993
|
*
|
|
93812
|
-
*
|
|
93813
|
-
*
|
|
93994
|
+
* Disable Pan.
|
|
93995
|
+
*
|
|
93996
|
+
* [Api set: 1.1]
|
|
93814
93997
|
*/
|
|
93815
|
-
|
|
93998
|
+
disablePan: boolean;
|
|
93816
93999
|
/**
|
|
93817
94000
|
*
|
|
93818
|
-
*
|
|
94001
|
+
* Disable PanZoomWindow.
|
|
93819
94002
|
*
|
|
93820
94003
|
* [Api set: 1.1]
|
|
93821
|
-
* @returns
|
|
93822
94004
|
*/
|
|
93823
|
-
|
|
93824
|
-
|
|
94005
|
+
disablePanZoomWindow: boolean;
|
|
94006
|
+
/**
|
|
94007
|
+
*
|
|
94008
|
+
* Disable Zoom.
|
|
94009
|
+
*
|
|
94010
|
+
* [Api set: 1.1]
|
|
94011
|
+
*/
|
|
94012
|
+
disableZoom: boolean;
|
|
93825
94013
|
/**
|
|
93826
94014
|
*
|
|
93827
|
-
*
|
|
94015
|
+
* Hide Diagram Boundary.
|
|
93828
94016
|
*
|
|
93829
94017
|
* [Api set: 1.1]
|
|
94018
|
+
*/
|
|
94019
|
+
hideDiagramBoundary: boolean;
|
|
94020
|
+
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
93830
94021
|
*
|
|
93831
|
-
* @
|
|
93832
|
-
*
|
|
94022
|
+
* @remarks
|
|
94023
|
+
*
|
|
94024
|
+
* This method has the following additional signature:
|
|
94025
|
+
*
|
|
94026
|
+
* `set(properties: Visio.DocumentView): void`
|
|
94027
|
+
*
|
|
94028
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
94029
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
93833
94030
|
*/
|
|
93834
|
-
|
|
94031
|
+
set(properties: Interfaces.DocumentViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
94032
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
94033
|
+
set(properties: Visio.DocumentView): void;
|
|
93835
94034
|
/**
|
|
93836
94035
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93837
94036
|
*
|
|
93838
94037
|
* @param options Provides options for which properties of the object to load.
|
|
93839
94038
|
*/
|
|
93840
|
-
load(options?: Visio.Interfaces.
|
|
94039
|
+
load(options?: Visio.Interfaces.DocumentViewLoadOptions): Visio.DocumentView;
|
|
93841
94040
|
/**
|
|
93842
94041
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93843
94042
|
*
|
|
93844
94043
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
93845
94044
|
*/
|
|
93846
|
-
load(propertyNames?: string | string[]): Visio.
|
|
94045
|
+
load(propertyNames?: string | string[]): Visio.DocumentView;
|
|
93847
94046
|
/**
|
|
93848
94047
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93849
94048
|
*
|
|
93850
94049
|
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
93851
94050
|
*/
|
|
93852
|
-
load(propertyNamesAndPaths?:
|
|
94051
|
+
load(propertyNamesAndPaths?: {
|
|
94052
|
+
select?: string;
|
|
94053
|
+
expand?: string;
|
|
94054
|
+
}): Visio.DocumentView;
|
|
93853
94055
|
/**
|
|
93854
94056
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
93855
|
-
* Whereas the original
|
|
94057
|
+
* Whereas the original Visio.DocumentView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.DocumentViewData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93856
94058
|
*/
|
|
93857
|
-
toJSON(): Visio.Interfaces.
|
|
94059
|
+
toJSON(): Visio.Interfaces.DocumentViewData;
|
|
94060
|
+
/**
|
|
94061
|
+
* Set mock data
|
|
94062
|
+
*/
|
|
94063
|
+
setMockData(data: Visio.Interfaces.DocumentViewData): void;
|
|
93858
94064
|
}
|
|
93859
94065
|
/**
|
|
94066
|
+
*
|
|
94067
|
+
* Represents the Page class.
|
|
94068
|
+
*
|
|
93860
94069
|
* [Api set: 1.1]
|
|
93861
94070
|
*/
|
|
93862
94071
|
class Page extends OfficeExtension.ClientObject {
|
|
@@ -93864,39 +94073,53 @@ declare namespace Visio {
|
|
|
93864
94073
|
context: RequestContext;
|
|
93865
94074
|
/**
|
|
93866
94075
|
*
|
|
93867
|
-
*
|
|
94076
|
+
* All shapes in the Page, including subshapes. Read-only.
|
|
93868
94077
|
*
|
|
93869
94078
|
* [Api set: 1.1]
|
|
93870
94079
|
*/
|
|
93871
|
-
readonly
|
|
94080
|
+
readonly allShapes: Visio.ShapeCollection;
|
|
93872
94081
|
/**
|
|
93873
94082
|
*
|
|
93874
|
-
*
|
|
94083
|
+
* Returns the Comments Collection. Read-only.
|
|
93875
94084
|
*
|
|
93876
94085
|
* [Api set: 1.1]
|
|
93877
94086
|
*/
|
|
93878
|
-
readonly
|
|
94087
|
+
readonly comments: Visio.CommentCollection;
|
|
93879
94088
|
/**
|
|
93880
94089
|
*
|
|
93881
|
-
*
|
|
94090
|
+
* All top-level shapes in the Page.Read-only.
|
|
93882
94091
|
*
|
|
93883
94092
|
* [Api set: 1.1]
|
|
93884
94093
|
*/
|
|
93885
94094
|
readonly shapes: Visio.ShapeCollection;
|
|
93886
94095
|
/**
|
|
93887
94096
|
*
|
|
93888
|
-
* Returns the
|
|
94097
|
+
* Returns the view of the page. Read-only.
|
|
93889
94098
|
*
|
|
93890
94099
|
* [Api set: 1.1]
|
|
93891
94100
|
*/
|
|
93892
|
-
readonly
|
|
94101
|
+
readonly view: Visio.PageView;
|
|
94102
|
+
/**
|
|
94103
|
+
*
|
|
94104
|
+
* Returns the height of the page. Read-only.
|
|
94105
|
+
*
|
|
94106
|
+
* [Api set: 1.1]
|
|
94107
|
+
*/
|
|
94108
|
+
readonly height: number;
|
|
93893
94109
|
/**
|
|
93894
94110
|
*
|
|
93895
|
-
* Index of the Page.
|
|
94111
|
+
* Index of the Page. Read-only.
|
|
93896
94112
|
*
|
|
93897
94113
|
* [Api set: 1.1]
|
|
93898
94114
|
*/
|
|
93899
94115
|
readonly index: number;
|
|
94116
|
+
/**
|
|
94117
|
+
*
|
|
94118
|
+
* Whether the page is a background page or not. Read-only.
|
|
94119
|
+
*
|
|
94120
|
+
* [Api set: 1.1]
|
|
94121
|
+
*/
|
|
94122
|
+
readonly isBackground: boolean;
|
|
93900
94123
|
/**
|
|
93901
94124
|
*
|
|
93902
94125
|
* Page name. Read-only.
|
|
@@ -93904,7 +94127,20 @@ declare namespace Visio {
|
|
|
93904
94127
|
* [Api set: 1.1]
|
|
93905
94128
|
*/
|
|
93906
94129
|
readonly name: string;
|
|
94130
|
+
/**
|
|
94131
|
+
*
|
|
94132
|
+
* Returns the width of the page. Read-only.
|
|
94133
|
+
*
|
|
94134
|
+
* [Api set: 1.1]
|
|
94135
|
+
*/
|
|
94136
|
+
readonly width: number;
|
|
93907
94137
|
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
94138
|
+
*
|
|
94139
|
+
* @remarks
|
|
94140
|
+
*
|
|
94141
|
+
* This method has the following additional signature:
|
|
94142
|
+
*
|
|
94143
|
+
* `set(properties: Visio.Page): void`
|
|
93908
94144
|
*
|
|
93909
94145
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
93910
94146
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
@@ -93914,17 +94150,11 @@ declare namespace Visio {
|
|
|
93914
94150
|
set(properties: Visio.Page): void;
|
|
93915
94151
|
/**
|
|
93916
94152
|
*
|
|
93917
|
-
*
|
|
94153
|
+
* Set the page as Active Page of the document.
|
|
93918
94154
|
*
|
|
93919
94155
|
* [Api set: 1.1]
|
|
93920
|
-
*
|
|
93921
|
-
* @param Flags
|
|
93922
|
-
* @param lpr8Left
|
|
93923
|
-
* @param lpr8Bottom
|
|
93924
|
-
* @param lpr8Right
|
|
93925
|
-
* @param lpr8Top
|
|
93926
94156
|
*/
|
|
93927
|
-
|
|
94157
|
+
activate(): void;
|
|
93928
94158
|
/**
|
|
93929
94159
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93930
94160
|
*
|
|
@@ -93951,28 +94181,131 @@ declare namespace Visio {
|
|
|
93951
94181
|
* Whereas the original Visio.Page object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object.
|
|
93952
94182
|
*/
|
|
93953
94183
|
toJSON(): Visio.Interfaces.PageData;
|
|
94184
|
+
/**
|
|
94185
|
+
* Set mock data
|
|
94186
|
+
*/
|
|
94187
|
+
setMockData(data: Visio.Interfaces.PageData): void;
|
|
93954
94188
|
}
|
|
93955
94189
|
/**
|
|
93956
94190
|
*
|
|
93957
|
-
* Represents
|
|
94191
|
+
* Represents the PageView class.
|
|
93958
94192
|
*
|
|
93959
94193
|
* [Api set: 1.1]
|
|
93960
94194
|
*/
|
|
93961
|
-
class
|
|
94195
|
+
class PageView extends OfficeExtension.ClientObject {
|
|
93962
94196
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
93963
94197
|
context: RequestContext;
|
|
93964
|
-
/** Gets the loaded child items in this collection. */
|
|
93965
|
-
readonly items: Visio.Page[];
|
|
93966
94198
|
/**
|
|
93967
94199
|
*
|
|
93968
|
-
*
|
|
94200
|
+
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
93969
94201
|
*
|
|
93970
94202
|
* [Api set: 1.1]
|
|
94203
|
+
*/
|
|
94204
|
+
zoom: number;
|
|
94205
|
+
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
93971
94206
|
*
|
|
93972
|
-
* @
|
|
93973
|
-
*
|
|
94207
|
+
* @remarks
|
|
94208
|
+
*
|
|
94209
|
+
* This method has the following additional signature:
|
|
94210
|
+
*
|
|
94211
|
+
* `set(properties: Visio.PageView): void`
|
|
94212
|
+
*
|
|
94213
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
94214
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
94215
|
+
*/
|
|
94216
|
+
set(properties: Interfaces.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
94217
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
94218
|
+
set(properties: Visio.PageView): void;
|
|
94219
|
+
/**
|
|
94220
|
+
*
|
|
94221
|
+
* Pans the Visio drawing to place the specified shape in the center of the view.
|
|
94222
|
+
*
|
|
94223
|
+
* [Api set: 1.1]
|
|
94224
|
+
*
|
|
94225
|
+
* @param ShapeId ShapeId to be seen in the center.
|
|
94226
|
+
*/
|
|
94227
|
+
centerViewportOnShape(ShapeId: number): void;
|
|
94228
|
+
/**
|
|
94229
|
+
*
|
|
94230
|
+
* Fit Page to current window.
|
|
94231
|
+
*
|
|
94232
|
+
* [Api set: 1.1]
|
|
94233
|
+
*/
|
|
94234
|
+
fitToWindow(): void;
|
|
94235
|
+
/**
|
|
94236
|
+
*
|
|
94237
|
+
* Returns the position object that specifies the position of the page in the view.
|
|
94238
|
+
*
|
|
94239
|
+
* [Api set: 1.1]
|
|
94240
|
+
*/
|
|
94241
|
+
getPosition(): OfficeExtension.ClientResult<Visio.Position>;
|
|
94242
|
+
/**
|
|
94243
|
+
*
|
|
94244
|
+
* Represents the Selection in the page.
|
|
94245
|
+
*
|
|
94246
|
+
* [Api set: 1.1]
|
|
94247
|
+
*/
|
|
94248
|
+
getSelection(): Visio.Selection;
|
|
94249
|
+
/**
|
|
94250
|
+
*
|
|
94251
|
+
* To check if the shape is in view of the page or not.
|
|
94252
|
+
*
|
|
94253
|
+
* [Api set: 1.1]
|
|
94254
|
+
*
|
|
94255
|
+
* @param Shape Shape to be checked.
|
|
94256
|
+
*/
|
|
94257
|
+
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;
|
|
94258
|
+
/**
|
|
94259
|
+
*
|
|
94260
|
+
* Sets the position of the page in the view.
|
|
94261
|
+
*
|
|
94262
|
+
* [Api set: 1.1]
|
|
94263
|
+
*
|
|
94264
|
+
* @param Position Position object that specifies the new position of the page in the view.
|
|
93974
94265
|
*/
|
|
93975
|
-
|
|
94266
|
+
setPosition(Position: Visio.Position): void;
|
|
94267
|
+
/**
|
|
94268
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94269
|
+
*
|
|
94270
|
+
* @param options Provides options for which properties of the object to load.
|
|
94271
|
+
*/
|
|
94272
|
+
load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;
|
|
94273
|
+
/**
|
|
94274
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94275
|
+
*
|
|
94276
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94277
|
+
*/
|
|
94278
|
+
load(propertyNames?: string | string[]): Visio.PageView;
|
|
94279
|
+
/**
|
|
94280
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94281
|
+
*
|
|
94282
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94283
|
+
*/
|
|
94284
|
+
load(propertyNamesAndPaths?: {
|
|
94285
|
+
select?: string;
|
|
94286
|
+
expand?: string;
|
|
94287
|
+
}): Visio.PageView;
|
|
94288
|
+
/**
|
|
94289
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94290
|
+
* Whereas the original Visio.PageView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageViewData`) that contains shallow copies of any loaded child properties from the original object.
|
|
94291
|
+
*/
|
|
94292
|
+
toJSON(): Visio.Interfaces.PageViewData;
|
|
94293
|
+
/**
|
|
94294
|
+
* Set mock data
|
|
94295
|
+
*/
|
|
94296
|
+
setMockData(data: Visio.Interfaces.PageViewData): void;
|
|
94297
|
+
}
|
|
94298
|
+
/**
|
|
94299
|
+
*
|
|
94300
|
+
* Represents a collection of Page objects that are part of the document.
|
|
94301
|
+
*
|
|
94302
|
+
* [Api set: 1.1]
|
|
94303
|
+
*/
|
|
94304
|
+
class PageCollection extends OfficeExtension.ClientObject {
|
|
94305
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94306
|
+
context: RequestContext;
|
|
94307
|
+
/** Gets the loaded child items in this collection. */
|
|
94308
|
+
readonly items: Visio.Page[];
|
|
93976
94309
|
/**
|
|
93977
94310
|
*
|
|
93978
94311
|
* Gets the number of pages in the collection.
|
|
@@ -93980,17 +94313,15 @@ declare namespace Visio {
|
|
|
93980
94313
|
* [Api set: 1.1]
|
|
93981
94314
|
*/
|
|
93982
94315
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
93983
|
-
getItem(key: number | string): Visio.Page;
|
|
93984
94316
|
/**
|
|
93985
94317
|
*
|
|
93986
|
-
*
|
|
94318
|
+
* Gets a page using its key (name or Id).
|
|
93987
94319
|
*
|
|
93988
94320
|
* [Api set: 1.1]
|
|
93989
94321
|
*
|
|
93990
|
-
* @param
|
|
93991
|
-
* @returns
|
|
94322
|
+
* @param key Key is the name or Id of the page to be retrieved.
|
|
93992
94323
|
*/
|
|
93993
|
-
|
|
94324
|
+
getItem(key: number | string): Visio.Page;
|
|
93994
94325
|
/**
|
|
93995
94326
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
93996
94327
|
*
|
|
@@ -94014,6 +94345,65 @@ declare namespace Visio {
|
|
|
94014
94345
|
* Whereas the original `Visio.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
94015
94346
|
*/
|
|
94016
94347
|
toJSON(): Visio.Interfaces.PageCollectionData;
|
|
94348
|
+
/**
|
|
94349
|
+
* Set mock data
|
|
94350
|
+
*/
|
|
94351
|
+
setMockData(data: Visio.Interfaces.PageCollectionData): void;
|
|
94352
|
+
}
|
|
94353
|
+
/**
|
|
94354
|
+
*
|
|
94355
|
+
* Represents the Shape Collection.
|
|
94356
|
+
*
|
|
94357
|
+
* [Api set: 1.1]
|
|
94358
|
+
*/
|
|
94359
|
+
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
94360
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94361
|
+
context: RequestContext;
|
|
94362
|
+
/** Gets the loaded child items in this collection. */
|
|
94363
|
+
readonly items: Visio.Shape[];
|
|
94364
|
+
/**
|
|
94365
|
+
*
|
|
94366
|
+
* Gets the number of Shapes in the collection.
|
|
94367
|
+
*
|
|
94368
|
+
* [Api set: 1.1]
|
|
94369
|
+
*/
|
|
94370
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
94371
|
+
/**
|
|
94372
|
+
*
|
|
94373
|
+
* Gets a Shape using its key (name or Index).
|
|
94374
|
+
*
|
|
94375
|
+
* [Api set: 1.1]
|
|
94376
|
+
*
|
|
94377
|
+
* @param key Key is the Name or Index of the shape to be retrieved.
|
|
94378
|
+
*/
|
|
94379
|
+
getItem(key: number | string): Visio.Shape;
|
|
94380
|
+
/**
|
|
94381
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94382
|
+
*
|
|
94383
|
+
* @param options Provides options for which properties of the object to load.
|
|
94384
|
+
*/
|
|
94385
|
+
load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;
|
|
94386
|
+
/**
|
|
94387
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94388
|
+
*
|
|
94389
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94390
|
+
*/
|
|
94391
|
+
load(propertyNames?: string | string[]): Visio.ShapeCollection;
|
|
94392
|
+
/**
|
|
94393
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94394
|
+
*
|
|
94395
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94396
|
+
*/
|
|
94397
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;
|
|
94398
|
+
/**
|
|
94399
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94400
|
+
* Whereas the original `Visio.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
94401
|
+
*/
|
|
94402
|
+
toJSON(): Visio.Interfaces.ShapeCollectionData;
|
|
94403
|
+
/**
|
|
94404
|
+
* Set mock data
|
|
94405
|
+
*/
|
|
94406
|
+
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
|
|
94017
94407
|
}
|
|
94018
94408
|
/**
|
|
94019
94409
|
*
|
|
@@ -94026,68 +94416,74 @@ declare namespace Visio {
|
|
|
94026
94416
|
context: RequestContext;
|
|
94027
94417
|
/**
|
|
94028
94418
|
*
|
|
94029
|
-
* Returns the
|
|
94419
|
+
* Returns the Comments Collection. Read-only.
|
|
94030
94420
|
*
|
|
94031
94421
|
* [Api set: 1.1]
|
|
94032
94422
|
*/
|
|
94033
|
-
readonly
|
|
94423
|
+
readonly comments: Visio.CommentCollection;
|
|
94034
94424
|
/**
|
|
94035
94425
|
*
|
|
94036
|
-
*
|
|
94426
|
+
* Returns the Hyperlinks collection for a Shape object. Read-only.
|
|
94037
94427
|
*
|
|
94038
94428
|
* [Api set: 1.1]
|
|
94039
94429
|
*/
|
|
94040
|
-
readonly
|
|
94430
|
+
readonly hyperlinks: Visio.HyperlinkCollection;
|
|
94041
94431
|
/**
|
|
94042
94432
|
*
|
|
94043
|
-
* Shape's
|
|
94433
|
+
* Returns the Shape's Data Section. Read-only.
|
|
94044
94434
|
*
|
|
94045
94435
|
* [Api set: 1.1]
|
|
94046
94436
|
*/
|
|
94047
|
-
readonly
|
|
94437
|
+
readonly shapeDataItems: Visio.ShapeDataItemCollection;
|
|
94048
94438
|
/**
|
|
94049
94439
|
*
|
|
94050
|
-
*
|
|
94440
|
+
* Gets SubShape Collection. Read-only.
|
|
94051
94441
|
*
|
|
94052
94442
|
* [Api set: 1.1]
|
|
94053
94443
|
*/
|
|
94054
|
-
readonly
|
|
94444
|
+
readonly subShapes: Visio.ShapeCollection;
|
|
94055
94445
|
/**
|
|
94056
94446
|
*
|
|
94057
|
-
*
|
|
94447
|
+
* Returns the view of the shape. Read-only.
|
|
94058
94448
|
*
|
|
94059
94449
|
* [Api set: 1.1]
|
|
94060
94450
|
*/
|
|
94061
|
-
readonly
|
|
94451
|
+
readonly view: Visio.ShapeView;
|
|
94062
94452
|
/**
|
|
94063
94453
|
*
|
|
94064
|
-
*
|
|
94454
|
+
* Shape's identifier. Read-only.
|
|
94065
94455
|
*
|
|
94066
94456
|
* [Api set: 1.1]
|
|
94067
94457
|
*/
|
|
94068
|
-
readonly
|
|
94458
|
+
readonly id: number;
|
|
94069
94459
|
/**
|
|
94070
94460
|
*
|
|
94071
|
-
* Shape's name.
|
|
94461
|
+
* Shape's name. Read-only.
|
|
94072
94462
|
*
|
|
94073
94463
|
* [Api set: 1.1]
|
|
94074
94464
|
*/
|
|
94075
94465
|
readonly name: string;
|
|
94076
94466
|
/**
|
|
94077
94467
|
*
|
|
94078
|
-
* Returns
|
|
94468
|
+
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
94079
94469
|
*
|
|
94080
94470
|
* [Api set: 1.1]
|
|
94081
94471
|
*/
|
|
94082
|
-
|
|
94472
|
+
select: boolean;
|
|
94083
94473
|
/**
|
|
94084
94474
|
*
|
|
94085
|
-
* Shape's
|
|
94475
|
+
* Shape's text. Read-only.
|
|
94086
94476
|
*
|
|
94087
94477
|
* [Api set: 1.1]
|
|
94088
94478
|
*/
|
|
94089
94479
|
readonly text: string;
|
|
94090
94480
|
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
94481
|
+
*
|
|
94482
|
+
* @remarks
|
|
94483
|
+
*
|
|
94484
|
+
* This method has the following additional signature:
|
|
94485
|
+
*
|
|
94486
|
+
* `set(properties: Visio.Shape): void`
|
|
94091
94487
|
*
|
|
94092
94488
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
94093
94489
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
@@ -94097,17 +94493,11 @@ declare namespace Visio {
|
|
|
94097
94493
|
set(properties: Visio.Shape): void;
|
|
94098
94494
|
/**
|
|
94099
94495
|
*
|
|
94100
|
-
* Returns
|
|
94496
|
+
* Returns the BoundingBox object that specifies bounding box of the shape.
|
|
94101
94497
|
*
|
|
94102
94498
|
* [Api set: 1.1]
|
|
94103
|
-
*
|
|
94104
|
-
* @param Flags
|
|
94105
|
-
* @param left
|
|
94106
|
-
* @param bottom
|
|
94107
|
-
* @param right
|
|
94108
|
-
* @param top
|
|
94109
94499
|
*/
|
|
94110
|
-
|
|
94500
|
+
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
|
|
94111
94501
|
/**
|
|
94112
94502
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94113
94503
|
*
|
|
@@ -94134,723 +94524,1192 @@ declare namespace Visio {
|
|
|
94134
94524
|
* Whereas the original Visio.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
94135
94525
|
*/
|
|
94136
94526
|
toJSON(): Visio.Interfaces.ShapeData;
|
|
94527
|
+
/**
|
|
94528
|
+
* Set mock data
|
|
94529
|
+
*/
|
|
94530
|
+
setMockData(data: Visio.Interfaces.ShapeData): void;
|
|
94137
94531
|
}
|
|
94138
94532
|
/**
|
|
94139
94533
|
*
|
|
94140
|
-
* Represents the
|
|
94534
|
+
* Represents the ShapeView class.
|
|
94141
94535
|
*
|
|
94142
94536
|
* [Api set: 1.1]
|
|
94143
94537
|
*/
|
|
94144
|
-
class
|
|
94538
|
+
class ShapeView extends OfficeExtension.ClientObject {
|
|
94145
94539
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94146
94540
|
context: RequestContext;
|
|
94147
|
-
/** Gets the loaded child items in this collection. */
|
|
94148
|
-
readonly items: Visio.Shape[];
|
|
94149
94541
|
/**
|
|
94150
94542
|
*
|
|
94151
|
-
*
|
|
94543
|
+
* Represents the highlight around the shape.
|
|
94152
94544
|
*
|
|
94153
94545
|
* [Api set: 1.1]
|
|
94546
|
+
*/
|
|
94547
|
+
highlight: Visio.Highlight;
|
|
94548
|
+
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
94154
94549
|
*
|
|
94155
|
-
* @
|
|
94156
|
-
*
|
|
94550
|
+
* @remarks
|
|
94551
|
+
*
|
|
94552
|
+
* This method has the following additional signature:
|
|
94553
|
+
*
|
|
94554
|
+
* `set(properties: Visio.ShapeView): void`
|
|
94555
|
+
*
|
|
94556
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
94557
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
94157
94558
|
*/
|
|
94158
|
-
|
|
94559
|
+
set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
94560
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
94561
|
+
set(properties: Visio.ShapeView): void;
|
|
94159
94562
|
/**
|
|
94160
94563
|
*
|
|
94161
|
-
*
|
|
94564
|
+
* Adds an overlay on top of the shape.
|
|
94162
94565
|
*
|
|
94163
94566
|
* [Api set: 1.1]
|
|
94567
|
+
*
|
|
94568
|
+
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
94569
|
+
* @param Content Content of Overlay.
|
|
94570
|
+
* @param OverlayHorizontalAlignment Horizontal Alignment of Overlay. Can be 'Left', 'Center', or 'Right'.
|
|
94571
|
+
* @param OverlayVerticalAlignment Vertical Alignment of Overlay. Can be 'Top', 'Middle', 'Bottom'.
|
|
94572
|
+
* @param Width Overlay Width.
|
|
94573
|
+
* @param Height Overlay Height.
|
|
94164
94574
|
*/
|
|
94165
|
-
|
|
94166
|
-
getItem(key: number | string): Visio.Shape;
|
|
94575
|
+
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
94167
94576
|
/**
|
|
94168
94577
|
*
|
|
94169
|
-
*
|
|
94578
|
+
* Adds an overlay on top of the shape.
|
|
94170
94579
|
*
|
|
94171
94580
|
* [Api set: 1.1]
|
|
94172
94581
|
*
|
|
94173
|
-
* @param
|
|
94174
|
-
* @
|
|
94582
|
+
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
94583
|
+
* @param Content Content of Overlay.
|
|
94584
|
+
* @param OverlayHorizontalAlignment Horizontal Alignment of Overlay. Can be 'Left', 'Center', or 'Right'.
|
|
94585
|
+
* @param OverlayVerticalAlignment Vertical Alignment of Overlay. Can be 'Top', 'Middle', 'Bottom'.
|
|
94586
|
+
* @param Width Overlay Width.
|
|
94587
|
+
* @param Height Overlay Height.
|
|
94588
|
+
*/
|
|
94589
|
+
addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
94590
|
+
/**
|
|
94591
|
+
*
|
|
94592
|
+
* Removes particular overlay or all overlays on the Shape.
|
|
94593
|
+
*
|
|
94594
|
+
* [Api set: 1.1]
|
|
94595
|
+
*
|
|
94596
|
+
* @param OverlayId An Overlay Id. Removes the specific overlay id from the shape.
|
|
94175
94597
|
*/
|
|
94176
|
-
|
|
94598
|
+
removeOverlay(OverlayId: number): void;
|
|
94599
|
+
/**
|
|
94600
|
+
*
|
|
94601
|
+
* Shows particular overlay on the Shape.
|
|
94602
|
+
*
|
|
94603
|
+
* [Api set: 1.1]
|
|
94604
|
+
*
|
|
94605
|
+
* @param overlayId overlay id in context
|
|
94606
|
+
* @param show to show or hide
|
|
94607
|
+
*/
|
|
94608
|
+
showOverlay(overlayId: number, show: boolean): void;
|
|
94177
94609
|
/**
|
|
94178
94610
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94179
94611
|
*
|
|
94180
94612
|
* @param options Provides options for which properties of the object to load.
|
|
94181
94613
|
*/
|
|
94182
|
-
load(options?: Visio.Interfaces.
|
|
94614
|
+
load(options?: Visio.Interfaces.ShapeViewLoadOptions): Visio.ShapeView;
|
|
94183
94615
|
/**
|
|
94184
94616
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94185
94617
|
*
|
|
94186
94618
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94187
94619
|
*/
|
|
94188
|
-
load(propertyNames?: string | string[]): Visio.
|
|
94620
|
+
load(propertyNames?: string | string[]): Visio.ShapeView;
|
|
94189
94621
|
/**
|
|
94190
94622
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94191
94623
|
*
|
|
94192
94624
|
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94193
94625
|
*/
|
|
94194
|
-
load(propertyNamesAndPaths?:
|
|
94626
|
+
load(propertyNamesAndPaths?: {
|
|
94627
|
+
select?: string;
|
|
94628
|
+
expand?: string;
|
|
94629
|
+
}): Visio.ShapeView;
|
|
94195
94630
|
/**
|
|
94196
94631
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94197
|
-
* Whereas the original
|
|
94632
|
+
* Whereas the original Visio.ShapeView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeViewData`) that contains shallow copies of any loaded child properties from the original object.
|
|
94198
94633
|
*/
|
|
94199
|
-
toJSON(): Visio.Interfaces.
|
|
94634
|
+
toJSON(): Visio.Interfaces.ShapeViewData;
|
|
94635
|
+
/**
|
|
94636
|
+
* Set mock data
|
|
94637
|
+
*/
|
|
94638
|
+
setMockData(data: Visio.Interfaces.ShapeViewData): void;
|
|
94200
94639
|
}
|
|
94201
94640
|
/**
|
|
94202
94641
|
*
|
|
94203
|
-
*
|
|
94642
|
+
* Represents the Position of the object in the view.
|
|
94204
94643
|
*
|
|
94205
94644
|
* [Api set: 1.1]
|
|
94206
94645
|
*/
|
|
94207
|
-
interface
|
|
94646
|
+
interface Position {
|
|
94208
94647
|
/**
|
|
94209
94648
|
*
|
|
94210
|
-
*
|
|
94649
|
+
* An integer that specifies the x-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the left boundary of the page.
|
|
94211
94650
|
*
|
|
94212
94651
|
* [Api set: 1.1]
|
|
94213
94652
|
*/
|
|
94214
|
-
|
|
94653
|
+
x: number;
|
|
94215
94654
|
/**
|
|
94216
94655
|
*
|
|
94217
|
-
*
|
|
94656
|
+
* An integer that specifies the y-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the top boundary of the page.
|
|
94218
94657
|
*
|
|
94219
94658
|
* [Api set: 1.1]
|
|
94220
94659
|
*/
|
|
94221
|
-
|
|
94660
|
+
y: number;
|
|
94222
94661
|
}
|
|
94223
94662
|
/**
|
|
94224
94663
|
*
|
|
94225
|
-
*
|
|
94664
|
+
* Represents the BoundingBox of the shape.
|
|
94226
94665
|
*
|
|
94227
94666
|
* [Api set: 1.1]
|
|
94228
94667
|
*/
|
|
94229
|
-
interface
|
|
94668
|
+
interface BoundingBox {
|
|
94230
94669
|
/**
|
|
94231
94670
|
*
|
|
94232
|
-
*
|
|
94671
|
+
* The distance between the top and bottom edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
94233
94672
|
*
|
|
94234
94673
|
* [Api set: 1.1]
|
|
94235
94674
|
*/
|
|
94236
|
-
|
|
94675
|
+
height: number;
|
|
94237
94676
|
/**
|
|
94238
94677
|
*
|
|
94239
|
-
*
|
|
94678
|
+
* The distance between the left and right edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
94240
94679
|
*
|
|
94241
94680
|
* [Api set: 1.1]
|
|
94242
94681
|
*/
|
|
94243
|
-
|
|
94682
|
+
width: number;
|
|
94244
94683
|
/**
|
|
94245
94684
|
*
|
|
94246
|
-
*
|
|
94685
|
+
* An integer that specifies the x-coordinate of the bounding box.
|
|
94247
94686
|
*
|
|
94248
94687
|
* [Api set: 1.1]
|
|
94249
94688
|
*/
|
|
94250
|
-
|
|
94689
|
+
x: number;
|
|
94690
|
+
/**
|
|
94691
|
+
*
|
|
94692
|
+
* An integer that specifies the y-coordinate of the bounding box.
|
|
94693
|
+
*
|
|
94694
|
+
* [Api set: 1.1]
|
|
94695
|
+
*/
|
|
94696
|
+
y: number;
|
|
94251
94697
|
}
|
|
94252
94698
|
/**
|
|
94253
94699
|
*
|
|
94254
|
-
*
|
|
94700
|
+
* Represents the highlight data added to the shape.
|
|
94255
94701
|
*
|
|
94256
94702
|
* [Api set: 1.1]
|
|
94257
94703
|
*/
|
|
94258
|
-
|
|
94704
|
+
interface Highlight {
|
|
94259
94705
|
/**
|
|
94260
94706
|
*
|
|
94261
|
-
*
|
|
94707
|
+
* A string that specifies the color of the highlight. It must have the form "#RRGGBB", where each letter represents a hexadecimal digit between 0 and F, and where RR is the red value between 0 and 0xFF (255), GG the green value between 0 and 0xFF (255), and BB is the blue value between 0 and 0xFF (255).
|
|
94262
94708
|
*
|
|
94709
|
+
* [Api set: 1.1]
|
|
94263
94710
|
*/
|
|
94264
|
-
|
|
94711
|
+
color: string;
|
|
94265
94712
|
/**
|
|
94266
94713
|
*
|
|
94267
|
-
*
|
|
94714
|
+
* A positive integer that specifies the width of the highlight's stroke in pixels.
|
|
94268
94715
|
*
|
|
94716
|
+
* [Api set: 1.1]
|
|
94269
94717
|
*/
|
|
94270
|
-
|
|
94718
|
+
width: number;
|
|
94271
94719
|
}
|
|
94272
94720
|
/**
|
|
94273
94721
|
*
|
|
94274
|
-
*
|
|
94722
|
+
* Represents the ShapeDataItemCollection for a given Shape.
|
|
94275
94723
|
*
|
|
94276
94724
|
* [Api set: 1.1]
|
|
94277
94725
|
*/
|
|
94278
|
-
|
|
94726
|
+
class ShapeDataItemCollection extends OfficeExtension.ClientObject {
|
|
94727
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94728
|
+
context: RequestContext;
|
|
94729
|
+
/** Gets the loaded child items in this collection. */
|
|
94730
|
+
readonly items: Visio.ShapeDataItem[];
|
|
94279
94731
|
/**
|
|
94280
94732
|
*
|
|
94281
|
-
*
|
|
94733
|
+
* Gets the number of Shape Data Items.
|
|
94282
94734
|
*
|
|
94735
|
+
* [Api set: 1.1]
|
|
94283
94736
|
*/
|
|
94284
|
-
|
|
94737
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
94285
94738
|
/**
|
|
94286
94739
|
*
|
|
94287
|
-
*
|
|
94740
|
+
* Gets the ShapeDataItem using its name.
|
|
94741
|
+
*
|
|
94742
|
+
* [Api set: 1.1]
|
|
94288
94743
|
*
|
|
94744
|
+
* @param key Key is the name of the ShapeDataItem to be retrieved.
|
|
94289
94745
|
*/
|
|
94290
|
-
|
|
94746
|
+
getItem(key: string): Visio.ShapeDataItem;
|
|
94291
94747
|
/**
|
|
94748
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94292
94749
|
*
|
|
94293
|
-
*
|
|
94294
|
-
*
|
|
94750
|
+
* @param options Provides options for which properties of the object to load.
|
|
94295
94751
|
*/
|
|
94296
|
-
|
|
94752
|
+
load(options?: Visio.Interfaces.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeDataItemCollection;
|
|
94297
94753
|
/**
|
|
94754
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94298
94755
|
*
|
|
94299
|
-
*
|
|
94756
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94757
|
+
*/
|
|
94758
|
+
load(propertyNames?: string | string[]): Visio.ShapeDataItemCollection;
|
|
94759
|
+
/**
|
|
94760
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94300
94761
|
*
|
|
94762
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94763
|
+
*/
|
|
94764
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeDataItemCollection;
|
|
94765
|
+
/**
|
|
94766
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94767
|
+
* Whereas the original `Visio.ShapeDataItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeDataItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
94768
|
+
*/
|
|
94769
|
+
toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;
|
|
94770
|
+
/**
|
|
94771
|
+
* Set mock data
|
|
94301
94772
|
*/
|
|
94302
|
-
|
|
94773
|
+
setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
|
|
94303
94774
|
}
|
|
94304
94775
|
/**
|
|
94305
94776
|
*
|
|
94306
|
-
*
|
|
94777
|
+
* Represents the ShapeDataItem.
|
|
94307
94778
|
*
|
|
94308
94779
|
* [Api set: 1.1]
|
|
94309
94780
|
*/
|
|
94310
|
-
|
|
94781
|
+
class ShapeDataItem extends OfficeExtension.ClientObject {
|
|
94782
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94783
|
+
context: RequestContext;
|
|
94311
94784
|
/**
|
|
94312
94785
|
*
|
|
94313
|
-
*
|
|
94786
|
+
* A string that specifies the format of the shape data item. Read-only.
|
|
94314
94787
|
*
|
|
94788
|
+
* [Api set: 1.1]
|
|
94315
94789
|
*/
|
|
94316
|
-
|
|
94790
|
+
readonly format: string;
|
|
94317
94791
|
/**
|
|
94318
94792
|
*
|
|
94319
|
-
*
|
|
94793
|
+
* A string that specifies the formatted value of the shape data item. Read-only.
|
|
94320
94794
|
*
|
|
94795
|
+
* [Api set: 1.1]
|
|
94321
94796
|
*/
|
|
94322
|
-
|
|
94797
|
+
readonly formattedValue: string;
|
|
94323
94798
|
/**
|
|
94324
94799
|
*
|
|
94325
|
-
*
|
|
94800
|
+
* A string that specifies the label of the shape data item. Read-only.
|
|
94326
94801
|
*
|
|
94802
|
+
* [Api set: 1.1]
|
|
94327
94803
|
*/
|
|
94328
|
-
|
|
94329
|
-
}
|
|
94330
|
-
/**
|
|
94331
|
-
*
|
|
94332
|
-
* TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API/ TaskPane State Changed Event etc.
|
|
94333
|
-
*
|
|
94334
|
-
* [Api set: 1.1]
|
|
94335
|
-
*/
|
|
94336
|
-
enum TaskPaneType {
|
|
94804
|
+
readonly label: string;
|
|
94337
94805
|
/**
|
|
94338
94806
|
*
|
|
94339
|
-
*
|
|
94807
|
+
* A string that specifies the value of the shape data item. Read-only.
|
|
94340
94808
|
*
|
|
94809
|
+
* [Api set: 1.1]
|
|
94341
94810
|
*/
|
|
94342
|
-
|
|
94811
|
+
readonly value: string;
|
|
94343
94812
|
/**
|
|
94813
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94344
94814
|
*
|
|
94345
|
-
*
|
|
94346
|
-
*
|
|
94815
|
+
* @param options Provides options for which properties of the object to load.
|
|
94347
94816
|
*/
|
|
94348
|
-
|
|
94817
|
+
load(options?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;
|
|
94349
94818
|
/**
|
|
94819
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94350
94820
|
*
|
|
94351
|
-
*
|
|
94821
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94822
|
+
*/
|
|
94823
|
+
load(propertyNames?: string | string[]): Visio.ShapeDataItem;
|
|
94824
|
+
/**
|
|
94825
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94352
94826
|
*
|
|
94827
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94353
94828
|
*/
|
|
94354
|
-
|
|
94829
|
+
load(propertyNamesAndPaths?: {
|
|
94830
|
+
select?: string;
|
|
94831
|
+
expand?: string;
|
|
94832
|
+
}): Visio.ShapeDataItem;
|
|
94833
|
+
/**
|
|
94834
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94835
|
+
* Whereas the original Visio.ShapeDataItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeDataItemData`) that contains shallow copies of any loaded child properties from the original object.
|
|
94836
|
+
*/
|
|
94837
|
+
toJSON(): Visio.Interfaces.ShapeDataItemData;
|
|
94838
|
+
/**
|
|
94839
|
+
* Set mock data
|
|
94840
|
+
*/
|
|
94841
|
+
setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
|
|
94355
94842
|
}
|
|
94356
94843
|
/**
|
|
94357
94844
|
*
|
|
94358
|
-
*
|
|
94845
|
+
* Represents the Hyperlink Collection.
|
|
94359
94846
|
*
|
|
94360
94847
|
* [Api set: 1.1]
|
|
94361
94848
|
*/
|
|
94362
|
-
|
|
94849
|
+
class HyperlinkCollection extends OfficeExtension.ClientObject {
|
|
94850
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94851
|
+
context: RequestContext;
|
|
94852
|
+
/** Gets the loaded child items in this collection. */
|
|
94853
|
+
readonly items: Visio.Hyperlink[];
|
|
94363
94854
|
/**
|
|
94364
94855
|
*
|
|
94365
|
-
*
|
|
94856
|
+
* Gets the number of hyperlinks.
|
|
94366
94857
|
*
|
|
94858
|
+
* [Api set: 1.1]
|
|
94367
94859
|
*/
|
|
94368
|
-
|
|
94860
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
94369
94861
|
/**
|
|
94370
94862
|
*
|
|
94371
|
-
*
|
|
94863
|
+
* Gets a Hyperlink using its key (name or Id).
|
|
94864
|
+
*
|
|
94865
|
+
* [Api set: 1.1]
|
|
94372
94866
|
*
|
|
94867
|
+
* @param Key Key is the name or index of the Hyperlink to be retrieved.
|
|
94373
94868
|
*/
|
|
94374
|
-
|
|
94869
|
+
getItem(Key: number | string): Visio.Hyperlink;
|
|
94375
94870
|
/**
|
|
94871
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94376
94872
|
*
|
|
94377
|
-
*
|
|
94378
|
-
*
|
|
94873
|
+
* @param options Provides options for which properties of the object to load.
|
|
94379
94874
|
*/
|
|
94380
|
-
|
|
94875
|
+
load(options?: Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.HyperlinkCollection;
|
|
94381
94876
|
/**
|
|
94877
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94382
94878
|
*
|
|
94383
|
-
*
|
|
94879
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94880
|
+
*/
|
|
94881
|
+
load(propertyNames?: string | string[]): Visio.HyperlinkCollection;
|
|
94882
|
+
/**
|
|
94883
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94384
94884
|
*
|
|
94885
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94385
94886
|
*/
|
|
94386
|
-
|
|
94887
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.HyperlinkCollection;
|
|
94888
|
+
/**
|
|
94889
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94890
|
+
* Whereas the original `Visio.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
94891
|
+
*/
|
|
94892
|
+
toJSON(): Visio.Interfaces.HyperlinkCollectionData;
|
|
94893
|
+
/**
|
|
94894
|
+
* Set mock data
|
|
94895
|
+
*/
|
|
94896
|
+
setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
|
|
94387
94897
|
}
|
|
94388
94898
|
/**
|
|
94389
94899
|
*
|
|
94390
|
-
*
|
|
94900
|
+
* Represents the Hyperlink.
|
|
94391
94901
|
*
|
|
94392
94902
|
* [Api set: 1.1]
|
|
94393
94903
|
*/
|
|
94394
|
-
|
|
94904
|
+
class Hyperlink extends OfficeExtension.ClientObject {
|
|
94905
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94906
|
+
context: RequestContext;
|
|
94395
94907
|
/**
|
|
94396
94908
|
*
|
|
94397
|
-
*
|
|
94909
|
+
* Gets the address of the Hyperlink object. Read-only.
|
|
94398
94910
|
*
|
|
94911
|
+
* [Api set: 1.1]
|
|
94399
94912
|
*/
|
|
94400
|
-
|
|
94913
|
+
readonly address: string;
|
|
94401
94914
|
/**
|
|
94402
94915
|
*
|
|
94403
|
-
*
|
|
94916
|
+
* Gets the description of a hyperlink. Read-only.
|
|
94404
94917
|
*
|
|
94918
|
+
* [Api set: 1.1]
|
|
94405
94919
|
*/
|
|
94406
|
-
|
|
94920
|
+
readonly description: string;
|
|
94407
94921
|
/**
|
|
94408
94922
|
*
|
|
94409
|
-
*
|
|
94923
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
94410
94924
|
*
|
|
94925
|
+
* [Api set: 1.1]
|
|
94411
94926
|
*/
|
|
94412
|
-
|
|
94927
|
+
readonly extraInfo: string;
|
|
94413
94928
|
/**
|
|
94414
94929
|
*
|
|
94415
|
-
*
|
|
94930
|
+
* Gets the sub-address of the Hyperlink object. Read-only.
|
|
94416
94931
|
*
|
|
94932
|
+
* [Api set: 1.1]
|
|
94417
94933
|
*/
|
|
94418
|
-
|
|
94934
|
+
readonly subAddress: string;
|
|
94419
94935
|
/**
|
|
94936
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94420
94937
|
*
|
|
94421
|
-
*
|
|
94422
|
-
*
|
|
94938
|
+
* @param options Provides options for which properties of the object to load.
|
|
94423
94939
|
*/
|
|
94424
|
-
|
|
94940
|
+
load(options?: Visio.Interfaces.HyperlinkLoadOptions): Visio.Hyperlink;
|
|
94425
94941
|
/**
|
|
94942
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94426
94943
|
*
|
|
94427
|
-
*
|
|
94944
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94945
|
+
*/
|
|
94946
|
+
load(propertyNames?: string | string[]): Visio.Hyperlink;
|
|
94947
|
+
/**
|
|
94948
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94428
94949
|
*
|
|
94950
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94429
94951
|
*/
|
|
94430
|
-
|
|
94952
|
+
load(propertyNamesAndPaths?: {
|
|
94953
|
+
select?: string;
|
|
94954
|
+
expand?: string;
|
|
94955
|
+
}): Visio.Hyperlink;
|
|
94956
|
+
/**
|
|
94957
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
94958
|
+
* Whereas the original Visio.Hyperlink object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
|
|
94959
|
+
*/
|
|
94960
|
+
toJSON(): Visio.Interfaces.HyperlinkData;
|
|
94961
|
+
/**
|
|
94962
|
+
* Set mock data
|
|
94963
|
+
*/
|
|
94964
|
+
setMockData(data: Visio.Interfaces.HyperlinkData): void;
|
|
94431
94965
|
}
|
|
94432
94966
|
/**
|
|
94433
94967
|
*
|
|
94434
|
-
*
|
|
94968
|
+
* Represents the CommentCollection for a given Shape.
|
|
94435
94969
|
*
|
|
94436
94970
|
* [Api set: 1.1]
|
|
94437
94971
|
*/
|
|
94438
|
-
|
|
94972
|
+
class CommentCollection extends OfficeExtension.ClientObject {
|
|
94973
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
94974
|
+
context: RequestContext;
|
|
94975
|
+
/** Gets the loaded child items in this collection. */
|
|
94976
|
+
readonly items: Visio.Comment[];
|
|
94439
94977
|
/**
|
|
94440
94978
|
*
|
|
94441
|
-
*
|
|
94979
|
+
* Gets the number of Comments.
|
|
94442
94980
|
*
|
|
94981
|
+
* [Api set: 1.1]
|
|
94443
94982
|
*/
|
|
94444
|
-
|
|
94983
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
94445
94984
|
/**
|
|
94446
94985
|
*
|
|
94447
|
-
*
|
|
94448
|
-
*
|
|
94449
|
-
*/
|
|
94450
|
-
basicFlowchart = "BasicFlowchart",
|
|
94451
|
-
/**
|
|
94986
|
+
* Gets the Comment using its name.
|
|
94452
94987
|
*
|
|
94453
|
-
*
|
|
94988
|
+
* [Api set: 1.1]
|
|
94454
94989
|
*
|
|
94990
|
+
* @param key Key is the name of the Comment to be retrieved.
|
|
94455
94991
|
*/
|
|
94456
|
-
|
|
94992
|
+
getItem(key: string): Visio.Comment;
|
|
94457
94993
|
/**
|
|
94994
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94458
94995
|
*
|
|
94459
|
-
*
|
|
94460
|
-
*
|
|
94996
|
+
* @param options Provides options for which properties of the object to load.
|
|
94461
94997
|
*/
|
|
94462
|
-
|
|
94998
|
+
load(options?: Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.CommentCollection;
|
|
94463
94999
|
/**
|
|
95000
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94464
95001
|
*
|
|
94465
|
-
*
|
|
94466
|
-
*
|
|
95002
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
94467
95003
|
*/
|
|
94468
|
-
|
|
95004
|
+
load(propertyNames?: string | string[]): Visio.CommentCollection;
|
|
94469
95005
|
/**
|
|
95006
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94470
95007
|
*
|
|
94471
|
-
*
|
|
94472
|
-
*
|
|
95008
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94473
95009
|
*/
|
|
94474
|
-
|
|
95010
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.CommentCollection;
|
|
94475
95011
|
/**
|
|
94476
|
-
|
|
94477
|
-
|
|
94478
|
-
|
|
95012
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
95013
|
+
* Whereas the original `Visio.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
95014
|
+
*/
|
|
95015
|
+
toJSON(): Visio.Interfaces.CommentCollectionData;
|
|
95016
|
+
/**
|
|
95017
|
+
* Set mock data
|
|
94479
95018
|
*/
|
|
94480
|
-
|
|
95019
|
+
setMockData(data: Visio.Interfaces.CommentCollectionData): void;
|
|
94481
95020
|
}
|
|
94482
95021
|
/**
|
|
94483
95022
|
*
|
|
94484
|
-
* Represents the
|
|
95023
|
+
* Represents the Comment.
|
|
94485
95024
|
*
|
|
94486
95025
|
* [Api set: 1.1]
|
|
94487
95026
|
*/
|
|
94488
|
-
|
|
95027
|
+
class Comment extends OfficeExtension.ClientObject {
|
|
95028
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95029
|
+
context: RequestContext;
|
|
94489
95030
|
/**
|
|
94490
95031
|
*
|
|
94491
|
-
*
|
|
95032
|
+
* A string that specifies the name of the author of the comment.
|
|
94492
95033
|
*
|
|
95034
|
+
* [Api set: 1.1]
|
|
94493
95035
|
*/
|
|
94494
|
-
|
|
95036
|
+
author: string;
|
|
94495
95037
|
/**
|
|
94496
95038
|
*
|
|
94497
|
-
*
|
|
95039
|
+
* A string that specifies the date when the comment was created.
|
|
94498
95040
|
*
|
|
95041
|
+
* [Api set: 1.1]
|
|
94499
95042
|
*/
|
|
94500
|
-
string
|
|
95043
|
+
date: string;
|
|
94501
95044
|
/**
|
|
94502
95045
|
*
|
|
94503
|
-
*
|
|
95046
|
+
* A string that contains the comment text.
|
|
94504
95047
|
*
|
|
95048
|
+
* [Api set: 1.1]
|
|
94505
95049
|
*/
|
|
94506
|
-
|
|
94507
|
-
/**
|
|
95050
|
+
text: string;
|
|
95051
|
+
/** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
95052
|
+
*
|
|
95053
|
+
* @remarks
|
|
95054
|
+
*
|
|
95055
|
+
* This method has the following additional signature:
|
|
94508
95056
|
*
|
|
94509
|
-
*
|
|
95057
|
+
* `set(properties: Visio.Comment): void`
|
|
95058
|
+
*
|
|
95059
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
95060
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
95061
|
+
*/
|
|
95062
|
+
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
95063
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
95064
|
+
set(properties: Visio.Comment): void;
|
|
95065
|
+
/**
|
|
95066
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94510
95067
|
*
|
|
95068
|
+
* @param options Provides options for which properties of the object to load.
|
|
94511
95069
|
*/
|
|
94512
|
-
|
|
95070
|
+
load(options?: Visio.Interfaces.CommentLoadOptions): Visio.Comment;
|
|
94513
95071
|
/**
|
|
95072
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94514
95073
|
*
|
|
94515
|
-
*
|
|
95074
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95075
|
+
*/
|
|
95076
|
+
load(propertyNames?: string | string[]): Visio.Comment;
|
|
95077
|
+
/**
|
|
95078
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94516
95079
|
*
|
|
95080
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94517
95081
|
*/
|
|
94518
|
-
|
|
95082
|
+
load(propertyNamesAndPaths?: {
|
|
95083
|
+
select?: string;
|
|
95084
|
+
expand?: string;
|
|
95085
|
+
}): Visio.Comment;
|
|
95086
|
+
/**
|
|
95087
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
95088
|
+
* Whereas the original Visio.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
95089
|
+
*/
|
|
95090
|
+
toJSON(): Visio.Interfaces.CommentData;
|
|
95091
|
+
/**
|
|
95092
|
+
* Set mock data
|
|
95093
|
+
*/
|
|
95094
|
+
setMockData(data: Visio.Interfaces.CommentData): void;
|
|
94519
95095
|
}
|
|
94520
95096
|
/**
|
|
94521
95097
|
*
|
|
94522
|
-
* Represents the
|
|
95098
|
+
* Represents the Selection in the page.
|
|
94523
95099
|
*
|
|
94524
95100
|
* [Api set: 1.1]
|
|
94525
95101
|
*/
|
|
94526
|
-
|
|
95102
|
+
class Selection extends OfficeExtension.ClientObject {
|
|
95103
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
95104
|
+
context: RequestContext;
|
|
94527
95105
|
/**
|
|
94528
95106
|
*
|
|
94529
|
-
*
|
|
95107
|
+
* Gets the Shapes of the Selection. Read-only.
|
|
94530
95108
|
*
|
|
95109
|
+
* [Api set: 1.1]
|
|
94531
95110
|
*/
|
|
94532
|
-
|
|
95111
|
+
readonly shapes: Visio.ShapeCollection;
|
|
94533
95112
|
/**
|
|
95113
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94534
95114
|
*
|
|
94535
|
-
*
|
|
95115
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
95116
|
+
*/
|
|
95117
|
+
load(propertyNames?: string | string[]): Visio.Selection;
|
|
95118
|
+
/**
|
|
95119
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
94536
95120
|
*
|
|
95121
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
94537
95122
|
*/
|
|
94538
|
-
|
|
95123
|
+
load(propertyNamesAndPaths?: {
|
|
95124
|
+
select?: string;
|
|
95125
|
+
expand?: string;
|
|
95126
|
+
}): Visio.Selection;
|
|
95127
|
+
/**
|
|
95128
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
95129
|
+
* Whereas the original Visio.Selection object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object.
|
|
95130
|
+
*/
|
|
95131
|
+
toJSON(): Visio.Interfaces.SelectionData;
|
|
94539
95132
|
}
|
|
94540
95133
|
/**
|
|
94541
95134
|
*
|
|
94542
|
-
*
|
|
95135
|
+
* Shape binding informations required for data visualizer diagram
|
|
94543
95136
|
*
|
|
94544
95137
|
* [Api set: 1.1]
|
|
94545
95138
|
*/
|
|
94546
|
-
|
|
95139
|
+
interface ShapeBinding {
|
|
94547
95140
|
/**
|
|
94548
95141
|
*
|
|
94549
|
-
*
|
|
95142
|
+
* Column for alternative text for shape.
|
|
94550
95143
|
*
|
|
95144
|
+
* [Api set: 1.1]
|
|
94551
95145
|
*/
|
|
94552
|
-
|
|
95146
|
+
alternativeTextColumnName: string;
|
|
94553
95147
|
/**
|
|
94554
95148
|
*
|
|
94555
|
-
*
|
|
95149
|
+
* Column for Shape label.
|
|
94556
95150
|
*
|
|
95151
|
+
* [Api set: 1.1]
|
|
94557
95152
|
*/
|
|
94558
|
-
|
|
95153
|
+
labelColumnName: string;
|
|
95154
|
+
/**
|
|
95155
|
+
*
|
|
95156
|
+
* Unique Id column.
|
|
95157
|
+
*
|
|
95158
|
+
* [Api set: 1.1]
|
|
95159
|
+
*/
|
|
95160
|
+
uniqueIDColumnName: string;
|
|
94559
95161
|
}
|
|
94560
95162
|
/**
|
|
94561
95163
|
*
|
|
94562
|
-
*
|
|
94563
|
-
Make sure that this enum is same as DVSupportedLayouts visio/Engine/inc/databindingtypes.h
|
|
95164
|
+
* Connector bindings for data visualizer diagram.
|
|
94564
95165
|
*
|
|
94565
95166
|
* [Api set: 1.1]
|
|
94566
95167
|
*/
|
|
94567
|
-
|
|
95168
|
+
interface ConnectorBinding {
|
|
94568
95169
|
/**
|
|
94569
95170
|
*
|
|
94570
|
-
*
|
|
95171
|
+
* If true then connectors are added in sequence according to the uniqueId column.
|
|
94571
95172
|
*
|
|
95173
|
+
* [Api set: 1.1]
|
|
94572
95174
|
*/
|
|
94573
|
-
|
|
95175
|
+
connectSequentially: boolean;
|
|
94574
95176
|
/**
|
|
94575
95177
|
*
|
|
94576
|
-
*
|
|
95178
|
+
* Delimiter for TargetColumn. It should not have more then one character.
|
|
94577
95179
|
*
|
|
95180
|
+
* [Api set: 1.1]
|
|
94578
95181
|
*/
|
|
94579
|
-
|
|
95182
|
+
delimiter: string;
|
|
94580
95183
|
/**
|
|
94581
95184
|
*
|
|
94582
|
-
*
|
|
95185
|
+
* Direction of connector to use in diagram.
|
|
94583
95186
|
*
|
|
95187
|
+
* [Api set: 1.1]
|
|
94584
95188
|
*/
|
|
94585
|
-
|
|
95189
|
+
direction: Visio.ConnectorDirection | "FromTarget" | "ToTarget";
|
|
94586
95190
|
/**
|
|
94587
95191
|
*
|
|
94588
|
-
*
|
|
95192
|
+
* Column for ConnectorLabel (shape text of connector).
|
|
94589
95193
|
*
|
|
95194
|
+
* [Api set: 1.1]
|
|
94590
95195
|
*/
|
|
94591
|
-
|
|
95196
|
+
labelColumnName: string;
|
|
94592
95197
|
/**
|
|
94593
95198
|
*
|
|
94594
|
-
*
|
|
95199
|
+
* Column for proving connected target shape.
|
|
94595
95200
|
*
|
|
95201
|
+
* [Api set: 1.1]
|
|
94596
95202
|
*/
|
|
94597
|
-
|
|
95203
|
+
targetColumnName: string;
|
|
95204
|
+
}
|
|
95205
|
+
/**
|
|
95206
|
+
*
|
|
95207
|
+
* Represents the Horizontal Alignment of the Overlay relative to the shape.
|
|
95208
|
+
*
|
|
95209
|
+
* [Api set: 1.1]
|
|
95210
|
+
*/
|
|
95211
|
+
enum OverlayHorizontalAlignment {
|
|
94598
95212
|
/**
|
|
94599
95213
|
*
|
|
94600
|
-
*
|
|
95214
|
+
* left
|
|
94601
95215
|
*
|
|
94602
95216
|
*/
|
|
94603
|
-
|
|
95217
|
+
left = "Left",
|
|
94604
95218
|
/**
|
|
94605
95219
|
*
|
|
94606
|
-
*
|
|
95220
|
+
* center
|
|
94607
95221
|
*
|
|
94608
95222
|
*/
|
|
94609
|
-
|
|
95223
|
+
center = "Center",
|
|
94610
95224
|
/**
|
|
94611
95225
|
*
|
|
94612
|
-
*
|
|
95226
|
+
* right
|
|
94613
95227
|
*
|
|
94614
95228
|
*/
|
|
94615
|
-
|
|
95229
|
+
right = "Right",
|
|
95230
|
+
}
|
|
95231
|
+
/**
|
|
95232
|
+
*
|
|
95233
|
+
* Represents the Vertical Alignment of the Overlay relative to the shape.
|
|
95234
|
+
*
|
|
95235
|
+
* [Api set: 1.1]
|
|
95236
|
+
*/
|
|
95237
|
+
enum OverlayVerticalAlignment {
|
|
94616
95238
|
/**
|
|
94617
95239
|
*
|
|
94618
|
-
*
|
|
95240
|
+
* top
|
|
94619
95241
|
*
|
|
94620
95242
|
*/
|
|
94621
|
-
|
|
95243
|
+
top = "Top",
|
|
94622
95244
|
/**
|
|
94623
95245
|
*
|
|
94624
|
-
*
|
|
95246
|
+
* middle
|
|
94625
95247
|
*
|
|
94626
95248
|
*/
|
|
94627
|
-
|
|
95249
|
+
middle = "Middle",
|
|
94628
95250
|
/**
|
|
94629
95251
|
*
|
|
94630
|
-
*
|
|
95252
|
+
* bottom
|
|
94631
95253
|
*
|
|
94632
95254
|
*/
|
|
94633
|
-
|
|
95255
|
+
bottom = "Bottom",
|
|
95256
|
+
}
|
|
95257
|
+
/**
|
|
95258
|
+
*
|
|
95259
|
+
* Represents the type of the overlay.
|
|
95260
|
+
*
|
|
95261
|
+
* [Api set: 1.1]
|
|
95262
|
+
*/
|
|
95263
|
+
enum OverlayType {
|
|
95264
|
+
/**
|
|
95265
|
+
*
|
|
95266
|
+
* text
|
|
95267
|
+
*
|
|
95268
|
+
*/
|
|
95269
|
+
text = "Text",
|
|
94634
95270
|
/**
|
|
94635
95271
|
*
|
|
94636
|
-
*
|
|
95272
|
+
* image
|
|
94637
95273
|
*
|
|
94638
95274
|
*/
|
|
94639
|
-
|
|
95275
|
+
image = "Image",
|
|
94640
95276
|
/**
|
|
94641
95277
|
*
|
|
94642
|
-
*
|
|
95278
|
+
* html
|
|
94643
95279
|
*
|
|
94644
95280
|
*/
|
|
94645
|
-
|
|
95281
|
+
html = "Html",
|
|
95282
|
+
}
|
|
95283
|
+
/**
|
|
95284
|
+
*
|
|
95285
|
+
* Toolbar IDs of the app
|
|
95286
|
+
*
|
|
95287
|
+
* [Api set: 1.1]
|
|
95288
|
+
*/
|
|
95289
|
+
enum ToolBarType {
|
|
94646
95290
|
/**
|
|
94647
95291
|
*
|
|
94648
|
-
*
|
|
95292
|
+
* CommandBar
|
|
94649
95293
|
*
|
|
94650
95294
|
*/
|
|
94651
|
-
|
|
95295
|
+
commandBar = "CommandBar",
|
|
94652
95296
|
/**
|
|
94653
95297
|
*
|
|
94654
|
-
*
|
|
95298
|
+
* PageNavigationBar
|
|
94655
95299
|
*
|
|
94656
95300
|
*/
|
|
94657
|
-
|
|
95301
|
+
pageNavigationBar = "PageNavigationBar",
|
|
94658
95302
|
/**
|
|
94659
95303
|
*
|
|
94660
|
-
*
|
|
95304
|
+
* StatusBar
|
|
94661
95305
|
*
|
|
94662
95306
|
*/
|
|
94663
|
-
|
|
95307
|
+
statusBar = "StatusBar",
|
|
95308
|
+
}
|
|
95309
|
+
/**
|
|
95310
|
+
*
|
|
95311
|
+
* Result of Data Visualizer Diagram operations.
|
|
95312
|
+
*
|
|
95313
|
+
* [Api set: 1.1]
|
|
95314
|
+
*/
|
|
95315
|
+
enum DataVisualizerDiagramResultType {
|
|
94664
95316
|
/**
|
|
94665
95317
|
*
|
|
94666
|
-
*
|
|
95318
|
+
* Operation is success.
|
|
94667
95319
|
*
|
|
94668
95320
|
*/
|
|
94669
|
-
|
|
95321
|
+
success = "Success",
|
|
94670
95322
|
/**
|
|
94671
95323
|
*
|
|
94672
|
-
*
|
|
95324
|
+
* Unexpected error during operation.
|
|
94673
95325
|
*
|
|
94674
95326
|
*/
|
|
94675
|
-
|
|
95327
|
+
unexpected = "Unexpected",
|
|
94676
95328
|
/**
|
|
94677
95329
|
*
|
|
94678
|
-
*
|
|
95330
|
+
* Validation error in operation.
|
|
94679
95331
|
*
|
|
94680
95332
|
*/
|
|
94681
|
-
|
|
95333
|
+
validationError = "ValidationError",
|
|
94682
95334
|
/**
|
|
94683
95335
|
*
|
|
94684
|
-
*
|
|
95336
|
+
* Conflict error in operation.
|
|
94685
95337
|
*
|
|
94686
95338
|
*/
|
|
94687
|
-
|
|
95339
|
+
conflictError = "ConflictError",
|
|
95340
|
+
}
|
|
95341
|
+
/**
|
|
95342
|
+
*
|
|
95343
|
+
* Type of the Data Visualizer Diagram operation
|
|
95344
|
+
*
|
|
95345
|
+
* [Api set: 1.1]
|
|
95346
|
+
*/
|
|
95347
|
+
enum DataVisualizerDiagramOperationType {
|
|
94688
95348
|
/**
|
|
94689
95349
|
*
|
|
94690
|
-
*
|
|
95350
|
+
* unknown operation type.
|
|
94691
95351
|
*
|
|
94692
95352
|
*/
|
|
94693
|
-
|
|
95353
|
+
unknown = "Unknown",
|
|
94694
95354
|
/**
|
|
94695
95355
|
*
|
|
94696
|
-
*
|
|
95356
|
+
* Creation operation.
|
|
94697
95357
|
*
|
|
94698
95358
|
*/
|
|
94699
|
-
|
|
95359
|
+
create = "Create",
|
|
94700
95360
|
/**
|
|
94701
95361
|
*
|
|
94702
|
-
*
|
|
95362
|
+
* Update Mappings operation.
|
|
94703
95363
|
*
|
|
94704
95364
|
*/
|
|
94705
|
-
|
|
95365
|
+
updateMappings = "UpdateMappings",
|
|
94706
95366
|
/**
|
|
94707
95367
|
*
|
|
94708
|
-
*
|
|
95368
|
+
* Update data associated with diagram.
|
|
94709
95369
|
*
|
|
94710
95370
|
*/
|
|
94711
|
-
|
|
95371
|
+
updateData = "UpdateData",
|
|
94712
95372
|
/**
|
|
94713
95373
|
*
|
|
94714
|
-
*
|
|
95374
|
+
* Update both data and mappings.
|
|
94715
95375
|
*
|
|
94716
95376
|
*/
|
|
94717
|
-
|
|
95377
|
+
update = "Update",
|
|
94718
95378
|
/**
|
|
94719
95379
|
*
|
|
94720
|
-
*
|
|
95380
|
+
* Delete the diagram content.
|
|
94721
95381
|
*
|
|
94722
95382
|
*/
|
|
94723
|
-
|
|
95383
|
+
delete = "Delete",
|
|
95384
|
+
}
|
|
95385
|
+
/**
|
|
95386
|
+
*
|
|
95387
|
+
* DiagramType for Data Visualizer diagrams
|
|
95388
|
+
*
|
|
95389
|
+
* [Api set: 1.1]
|
|
95390
|
+
*/
|
|
95391
|
+
enum DataVisualizerDiagramType {
|
|
94724
95392
|
/**
|
|
94725
95393
|
*
|
|
94726
|
-
*
|
|
95394
|
+
* Unknown
|
|
94727
95395
|
*
|
|
94728
95396
|
*/
|
|
94729
|
-
|
|
95397
|
+
unknown = "Unknown",
|
|
94730
95398
|
/**
|
|
94731
95399
|
*
|
|
94732
|
-
*
|
|
95400
|
+
* Basic Flowchart
|
|
94733
95401
|
*
|
|
94734
95402
|
*/
|
|
94735
|
-
|
|
95403
|
+
basicFlowchart = "BasicFlowchart",
|
|
94736
95404
|
/**
|
|
94737
95405
|
*
|
|
94738
|
-
*
|
|
95406
|
+
* Horizontal Cross-Functional Flowchart
|
|
94739
95407
|
*
|
|
94740
95408
|
*/
|
|
94741
|
-
|
|
95409
|
+
crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
|
|
94742
95410
|
/**
|
|
94743
95411
|
*
|
|
94744
|
-
*
|
|
95412
|
+
* Vertical Cross-Functional Flowchart
|
|
94745
95413
|
*
|
|
94746
95414
|
*/
|
|
94747
|
-
|
|
95415
|
+
crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
|
|
94748
95416
|
/**
|
|
94749
95417
|
*
|
|
94750
|
-
*
|
|
95418
|
+
* Audit
|
|
94751
95419
|
*
|
|
94752
95420
|
*/
|
|
94753
|
-
|
|
95421
|
+
audit = "Audit",
|
|
94754
95422
|
/**
|
|
94755
95423
|
*
|
|
94756
|
-
*
|
|
95424
|
+
* OrgChart
|
|
94757
95425
|
*
|
|
94758
95426
|
*/
|
|
94759
|
-
|
|
95427
|
+
orgChart = "OrgChart",
|
|
94760
95428
|
/**
|
|
94761
95429
|
*
|
|
94762
|
-
*
|
|
95430
|
+
* Network
|
|
94763
95431
|
*
|
|
94764
95432
|
*/
|
|
94765
|
-
|
|
95433
|
+
network = "Network",
|
|
94766
95434
|
}
|
|
94767
95435
|
/**
|
|
94768
95436
|
*
|
|
94769
|
-
* Represents the
|
|
95437
|
+
* Represents the type of column values.
|
|
94770
95438
|
*
|
|
94771
95439
|
* [Api set: 1.1]
|
|
94772
95440
|
*/
|
|
94773
|
-
enum
|
|
95441
|
+
enum ColumnType {
|
|
94774
95442
|
/**
|
|
94775
95443
|
*
|
|
94776
|
-
*
|
|
95444
|
+
* Other
|
|
94777
95445
|
*
|
|
94778
95446
|
*/
|
|
94779
|
-
|
|
95447
|
+
unknown = "Unknown",
|
|
94780
95448
|
/**
|
|
94781
95449
|
*
|
|
94782
|
-
*
|
|
95450
|
+
* String values
|
|
94783
95451
|
*
|
|
94784
95452
|
*/
|
|
94785
|
-
|
|
95453
|
+
string = "String",
|
|
94786
95454
|
/**
|
|
94787
95455
|
*
|
|
94788
|
-
*
|
|
95456
|
+
* Numerical values
|
|
94789
95457
|
*
|
|
94790
95458
|
*/
|
|
94791
|
-
|
|
95459
|
+
number = "Number",
|
|
94792
95460
|
/**
|
|
94793
95461
|
*
|
|
94794
|
-
*
|
|
95462
|
+
* Date
|
|
94795
95463
|
*
|
|
94796
95464
|
*/
|
|
94797
|
-
|
|
95465
|
+
date = "Date",
|
|
94798
95466
|
/**
|
|
94799
95467
|
*
|
|
94800
|
-
*
|
|
95468
|
+
* Currency
|
|
94801
95469
|
*
|
|
94802
95470
|
*/
|
|
94803
|
-
|
|
95471
|
+
currency = "Currency",
|
|
95472
|
+
}
|
|
95473
|
+
/**
|
|
95474
|
+
*
|
|
95475
|
+
* Represents the type of source for the data connection.
|
|
95476
|
+
*
|
|
95477
|
+
* [Api set: 1.1]
|
|
95478
|
+
*/
|
|
95479
|
+
enum DataSourceType {
|
|
94804
95480
|
/**
|
|
94805
95481
|
*
|
|
94806
|
-
*
|
|
95482
|
+
* Unknown Data Source
|
|
94807
95483
|
*
|
|
94808
95484
|
*/
|
|
94809
|
-
|
|
95485
|
+
unknown = "Unknown",
|
|
94810
95486
|
/**
|
|
94811
95487
|
*
|
|
94812
|
-
*
|
|
94813
|
-
to another setting.
|
|
95488
|
+
* Microsoft Excel workbook
|
|
94814
95489
|
*
|
|
94815
95490
|
*/
|
|
94816
|
-
|
|
95491
|
+
excel = "Excel",
|
|
95492
|
+
}
|
|
95493
|
+
/**
|
|
95494
|
+
*
|
|
95495
|
+
* Represents the orientation of the Cross Functional Flowchart diagram.
|
|
95496
|
+
*
|
|
95497
|
+
* [Api set: 1.1]
|
|
95498
|
+
*/
|
|
95499
|
+
enum CrossFunctionalFlowchartOrientation {
|
|
94817
95500
|
/**
|
|
94818
95501
|
*
|
|
94819
|
-
*
|
|
94820
|
-
to other setting.
|
|
95502
|
+
* Horizontal Cross Functional Flowchart.
|
|
94821
95503
|
*
|
|
94822
95504
|
*/
|
|
94823
|
-
|
|
95505
|
+
horizontal = "Horizontal",
|
|
94824
95506
|
/**
|
|
94825
95507
|
*
|
|
94826
|
-
*
|
|
94827
|
-
already mapped to other setting.
|
|
95508
|
+
* Vertical Cross Functional Flowchart.
|
|
94828
95509
|
*
|
|
94829
95510
|
*/
|
|
94830
|
-
|
|
95511
|
+
vertical = "Vertical",
|
|
94831
95512
|
}
|
|
94832
95513
|
/**
|
|
94833
95514
|
*
|
|
94834
|
-
*
|
|
95515
|
+
* Represents the type of layout.
|
|
94835
95516
|
*
|
|
94836
95517
|
* [Api set: 1.1]
|
|
94837
95518
|
*/
|
|
94838
|
-
enum
|
|
95519
|
+
enum LayoutVariant {
|
|
94839
95520
|
/**
|
|
94840
95521
|
*
|
|
94841
|
-
*
|
|
95522
|
+
* Invalid layout
|
|
94842
95523
|
*
|
|
94843
95524
|
*/
|
|
94844
|
-
|
|
95525
|
+
unknown = "Unknown",
|
|
94845
95526
|
/**
|
|
94846
95527
|
*
|
|
94847
|
-
*
|
|
95528
|
+
* Use the Page default layout
|
|
95529
|
+
*
|
|
95530
|
+
*/
|
|
95531
|
+
pageDefault = "PageDefault",
|
|
95532
|
+
/**
|
|
95533
|
+
*
|
|
95534
|
+
* Use Flowchart with TopToBottom orientation
|
|
95535
|
+
*
|
|
95536
|
+
*/
|
|
95537
|
+
flowchart_TopToBottom = "Flowchart_TopToBottom",
|
|
95538
|
+
/**
|
|
95539
|
+
*
|
|
95540
|
+
* Use Flowchart with BottomToTop orientation
|
|
95541
|
+
*
|
|
95542
|
+
*/
|
|
95543
|
+
flowchart_BottomToTop = "Flowchart_BottomToTop",
|
|
95544
|
+
/**
|
|
95545
|
+
*
|
|
95546
|
+
* Use Flowchart with LeftToRight orientation
|
|
95547
|
+
*
|
|
95548
|
+
*/
|
|
95549
|
+
flowchart_LeftToRight = "Flowchart_LeftToRight",
|
|
95550
|
+
/**
|
|
95551
|
+
*
|
|
95552
|
+
* Use Flowchart with RightToLeft orientation
|
|
95553
|
+
*
|
|
95554
|
+
*/
|
|
95555
|
+
flowchart_RightToLeft = "Flowchart_RightToLeft",
|
|
95556
|
+
/**
|
|
95557
|
+
*
|
|
95558
|
+
* Use WideTree with DownThenRight orientation
|
|
95559
|
+
*
|
|
95560
|
+
*/
|
|
95561
|
+
wideTree_DownThenRight = "WideTree_DownThenRight",
|
|
95562
|
+
/**
|
|
95563
|
+
*
|
|
95564
|
+
* Use WideTree with DownThenLeft orientation
|
|
95565
|
+
*
|
|
95566
|
+
*/
|
|
95567
|
+
wideTree_DownThenLeft = "WideTree_DownThenLeft",
|
|
95568
|
+
/**
|
|
95569
|
+
*
|
|
95570
|
+
* Use WideTree with RightThenDown orientation
|
|
95571
|
+
*
|
|
95572
|
+
*/
|
|
95573
|
+
wideTree_RightThenDown = "WideTree_RightThenDown",
|
|
95574
|
+
/**
|
|
95575
|
+
*
|
|
95576
|
+
* Use WideTree with LeftThenDown orientation
|
|
95577
|
+
*
|
|
95578
|
+
*/
|
|
95579
|
+
wideTree_LeftThenDown = "WideTree_LeftThenDown",
|
|
95580
|
+
}
|
|
95581
|
+
/**
|
|
95582
|
+
*
|
|
95583
|
+
* Represents the types of data validation error.
|
|
95584
|
+
*
|
|
95585
|
+
* [Api set: 1.1]
|
|
95586
|
+
*/
|
|
95587
|
+
enum DataValidationErrorType {
|
|
95588
|
+
/**
|
|
95589
|
+
*
|
|
95590
|
+
* No error
|
|
95591
|
+
*
|
|
95592
|
+
*/
|
|
95593
|
+
none = "None",
|
|
95594
|
+
/**
|
|
95595
|
+
*
|
|
95596
|
+
* Data does not have one of the mapped column.
|
|
95597
|
+
*
|
|
95598
|
+
*/
|
|
95599
|
+
columnNotMapped = "ColumnNotMapped",
|
|
95600
|
+
/**
|
|
95601
|
+
*
|
|
95602
|
+
* UniqueId column has error.
|
|
95603
|
+
*
|
|
95604
|
+
*/
|
|
95605
|
+
uniqueIdColumnError = "UniqueIdColumnError",
|
|
95606
|
+
/**
|
|
95607
|
+
*
|
|
95608
|
+
* Swim-lane column is empty.
|
|
95609
|
+
*
|
|
95610
|
+
*/
|
|
95611
|
+
swimlaneColumnError = "SwimlaneColumnError",
|
|
95612
|
+
/**
|
|
95613
|
+
*
|
|
95614
|
+
* Delimiter can not have more then one character.
|
|
95615
|
+
*
|
|
95616
|
+
*/
|
|
95617
|
+
delimiterError = "DelimiterError",
|
|
95618
|
+
/**
|
|
95619
|
+
*
|
|
95620
|
+
* Connector column has error
|
|
95621
|
+
*
|
|
95622
|
+
*/
|
|
95623
|
+
connectorColumnError = "ConnectorColumnError",
|
|
95624
|
+
/**
|
|
95625
|
+
*
|
|
95626
|
+
* Connector column is already mapped
|
|
95627
|
+
to another setting
|
|
95628
|
+
*
|
|
95629
|
+
*/
|
|
95630
|
+
connectorColumnMappedElsewhere = "ConnectorColumnMappedElsewhere",
|
|
95631
|
+
/**
|
|
95632
|
+
*
|
|
95633
|
+
* Connector label column already mapped
|
|
95634
|
+
to other setting
|
|
95635
|
+
*
|
|
95636
|
+
*/
|
|
95637
|
+
connectorLabelColumnMappedElsewhere = "ConnectorLabelColumnMappedElsewhere",
|
|
95638
|
+
/**
|
|
95639
|
+
*
|
|
95640
|
+
* Connector column and connector label column are
|
|
95641
|
+
already mapped to other setting.
|
|
95642
|
+
*
|
|
95643
|
+
*/
|
|
95644
|
+
connectorColumnAndConnectorLabelMappedElsewhere = "ConnectorColumnAndConnectorLabelMappedElsewhere",
|
|
95645
|
+
}
|
|
95646
|
+
/**
|
|
95647
|
+
*
|
|
95648
|
+
* Direction of connector in DataVisualizer diagram.
|
|
95649
|
+
*
|
|
95650
|
+
* [Api set: 1.1]
|
|
95651
|
+
*/
|
|
95652
|
+
enum ConnectorDirection {
|
|
95653
|
+
/**
|
|
95654
|
+
*
|
|
95655
|
+
* Direction will be from target to source shape.
|
|
95656
|
+
*
|
|
95657
|
+
*/
|
|
95658
|
+
fromTarget = "FromTarget",
|
|
95659
|
+
/**
|
|
95660
|
+
*
|
|
95661
|
+
* Direction will be from source to target shape.
|
|
94848
95662
|
*
|
|
94849
95663
|
*/
|
|
94850
95664
|
toTarget = "ToTarget",
|
|
94851
95665
|
}
|
|
95666
|
+
/**
|
|
95667
|
+
*
|
|
95668
|
+
* TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API/ TaskPane State Changed Event etc
|
|
95669
|
+
*
|
|
95670
|
+
* [Api set: 1.1]
|
|
95671
|
+
*/
|
|
95672
|
+
enum TaskPaneType {
|
|
95673
|
+
/**
|
|
95674
|
+
*
|
|
95675
|
+
* None Type
|
|
95676
|
+
*
|
|
95677
|
+
*/
|
|
95678
|
+
none = "None",
|
|
95679
|
+
/**
|
|
95680
|
+
*
|
|
95681
|
+
* Data Visualizer Process Mapping Pane
|
|
95682
|
+
*
|
|
95683
|
+
*/
|
|
95684
|
+
dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
|
|
95685
|
+
/**
|
|
95686
|
+
*
|
|
95687
|
+
* Data Visualizer Organisation Mapping Pane
|
|
95688
|
+
*
|
|
95689
|
+
*/
|
|
95690
|
+
dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
|
|
95691
|
+
}
|
|
95692
|
+
/**
|
|
95693
|
+
*
|
|
95694
|
+
* EventType represents the type of the events Host supports
|
|
95695
|
+
*
|
|
95696
|
+
* [Api set: 1.1]
|
|
95697
|
+
*/
|
|
95698
|
+
enum EventType {
|
|
95699
|
+
/**
|
|
95700
|
+
*
|
|
95701
|
+
* DataVisualizer diagram operation complete Event
|
|
95702
|
+
*
|
|
95703
|
+
*/
|
|
95704
|
+
dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
|
|
95705
|
+
}
|
|
94852
95706
|
enum ErrorCodes {
|
|
95707
|
+
accessDenied = "AccessDenied",
|
|
94853
95708
|
generalException = "GeneralException",
|
|
95709
|
+
invalidArgument = "InvalidArgument",
|
|
95710
|
+
itemNotFound = "ItemNotFound",
|
|
95711
|
+
notImplemented = "NotImplemented",
|
|
95712
|
+
unsupportedOperation = "UnsupportedOperation",
|
|
94854
95713
|
}
|
|
94855
95714
|
module Interfaces {
|
|
94856
95715
|
/**
|
|
@@ -94868,142 +95727,183 @@ declare namespace Visio {
|
|
|
94868
95727
|
}
|
|
94869
95728
|
/** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
|
|
94870
95729
|
interface ApplicationUpdateData {
|
|
95730
|
+
/**
|
|
95731
|
+
*
|
|
95732
|
+
* Show or hide the iFrame application borders.
|
|
95733
|
+
*
|
|
95734
|
+
* [Api set: 1.1]
|
|
95735
|
+
*/
|
|
95736
|
+
showBorders?: boolean;
|
|
95737
|
+
/**
|
|
95738
|
+
*
|
|
95739
|
+
* Show or hide the standard toolbars.
|
|
95740
|
+
*
|
|
95741
|
+
* [Api set: 1.1]
|
|
95742
|
+
*/
|
|
95743
|
+
showToolbars?: boolean;
|
|
95744
|
+
}
|
|
95745
|
+
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
95746
|
+
interface DocumentUpdateData {
|
|
94871
95747
|
/**
|
|
94872
95748
|
*
|
|
94873
|
-
*
|
|
95749
|
+
* Represents a Visio application instance that contains this document.
|
|
94874
95750
|
*
|
|
94875
95751
|
* [Api set: 1.1]
|
|
94876
95752
|
*/
|
|
94877
|
-
|
|
95753
|
+
application?: Visio.Interfaces.ApplicationUpdateData;
|
|
94878
95754
|
/**
|
|
94879
95755
|
*
|
|
94880
|
-
* Returns the
|
|
95756
|
+
* Returns the DocumentView object.
|
|
94881
95757
|
*
|
|
94882
95758
|
* [Api set: 1.1]
|
|
94883
95759
|
*/
|
|
94884
|
-
|
|
95760
|
+
view?: Visio.Interfaces.DocumentViewUpdateData;
|
|
95761
|
+
}
|
|
95762
|
+
/** An interface for updating data on the DocumentView object, for use in `documentView.set({ ... })`. */
|
|
95763
|
+
interface DocumentViewUpdateData {
|
|
94885
95764
|
/**
|
|
94886
95765
|
*
|
|
94887
|
-
*
|
|
95766
|
+
* Disable Hyperlinks.
|
|
94888
95767
|
*
|
|
94889
95768
|
* [Api set: 1.1]
|
|
94890
95769
|
*/
|
|
94891
|
-
|
|
95770
|
+
disableHyperlinks?: boolean;
|
|
94892
95771
|
/**
|
|
94893
95772
|
*
|
|
94894
|
-
*
|
|
95773
|
+
* Disable Pan.
|
|
94895
95774
|
*
|
|
94896
95775
|
* [Api set: 1.1]
|
|
94897
95776
|
*/
|
|
94898
|
-
|
|
94899
|
-
}
|
|
94900
|
-
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
94901
|
-
interface DocumentUpdateData {
|
|
95777
|
+
disablePan?: boolean;
|
|
94902
95778
|
/**
|
|
94903
|
-
|
|
94904
|
-
|
|
94905
|
-
|
|
94906
|
-
|
|
94907
|
-
|
|
94908
|
-
|
|
95779
|
+
*
|
|
95780
|
+
* Disable PanZoomWindow.
|
|
95781
|
+
*
|
|
95782
|
+
* [Api set: 1.1]
|
|
95783
|
+
*/
|
|
95784
|
+
disablePanZoomWindow?: boolean;
|
|
94909
95785
|
/**
|
|
94910
95786
|
*
|
|
94911
|
-
*
|
|
95787
|
+
* Disable Zoom.
|
|
94912
95788
|
*
|
|
94913
95789
|
* [Api set: 1.1]
|
|
94914
95790
|
*/
|
|
94915
|
-
|
|
94916
|
-
|
|
94917
|
-
|
|
94918
|
-
|
|
94919
|
-
|
|
95791
|
+
disableZoom?: boolean;
|
|
95792
|
+
/**
|
|
95793
|
+
*
|
|
95794
|
+
* Hide Diagram Boundary.
|
|
95795
|
+
*
|
|
95796
|
+
* [Api set: 1.1]
|
|
95797
|
+
*/
|
|
95798
|
+
hideDiagramBoundary?: boolean;
|
|
94920
95799
|
}
|
|
94921
95800
|
/** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
|
|
94922
95801
|
interface PageUpdateData {
|
|
94923
95802
|
/**
|
|
94924
95803
|
*
|
|
94925
|
-
* Returns the
|
|
95804
|
+
* Returns the view of the page.
|
|
94926
95805
|
*
|
|
94927
95806
|
* [Api set: 1.1]
|
|
94928
95807
|
*/
|
|
94929
|
-
|
|
95808
|
+
view?: Visio.Interfaces.PageViewUpdateData;
|
|
95809
|
+
}
|
|
95810
|
+
/** An interface for updating data on the PageView object, for use in `pageView.set({ ... })`. */
|
|
95811
|
+
interface PageViewUpdateData {
|
|
94930
95812
|
/**
|
|
94931
|
-
|
|
94932
|
-
|
|
94933
|
-
|
|
94934
|
-
|
|
94935
|
-
|
|
94936
|
-
|
|
95813
|
+
*
|
|
95814
|
+
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
95815
|
+
*
|
|
95816
|
+
* [Api set: 1.1]
|
|
95817
|
+
*/
|
|
95818
|
+
zoom?: number;
|
|
94937
95819
|
}
|
|
94938
95820
|
/** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */
|
|
94939
95821
|
interface PageCollectionUpdateData {
|
|
94940
95822
|
items?: Visio.Interfaces.PageData[];
|
|
94941
95823
|
}
|
|
95824
|
+
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
95825
|
+
interface ShapeCollectionUpdateData {
|
|
95826
|
+
items?: Visio.Interfaces.ShapeData[];
|
|
95827
|
+
}
|
|
94942
95828
|
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
94943
95829
|
interface ShapeUpdateData {
|
|
94944
95830
|
/**
|
|
94945
95831
|
*
|
|
94946
|
-
* Returns the
|
|
95832
|
+
* Returns the view of the shape.
|
|
94947
95833
|
*
|
|
94948
95834
|
* [Api set: 1.1]
|
|
94949
95835
|
*/
|
|
94950
|
-
|
|
95836
|
+
view?: Visio.Interfaces.ShapeViewUpdateData;
|
|
94951
95837
|
/**
|
|
94952
|
-
|
|
94953
|
-
|
|
94954
|
-
|
|
94955
|
-
|
|
94956
|
-
|
|
94957
|
-
|
|
94958
|
-
}
|
|
94959
|
-
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
94960
|
-
interface ShapeCollectionUpdateData {
|
|
94961
|
-
items?: Visio.Interfaces.ShapeData[];
|
|
95838
|
+
*
|
|
95839
|
+
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
95840
|
+
*
|
|
95841
|
+
* [Api set: 1.1]
|
|
95842
|
+
*/
|
|
95843
|
+
select?: boolean;
|
|
94962
95844
|
}
|
|
94963
|
-
/** An interface
|
|
94964
|
-
interface
|
|
95845
|
+
/** An interface for updating data on the ShapeView object, for use in `shapeView.set({ ... })`. */
|
|
95846
|
+
interface ShapeViewUpdateData {
|
|
94965
95847
|
/**
|
|
94966
|
-
|
|
94967
|
-
|
|
94968
|
-
|
|
94969
|
-
|
|
94970
|
-
|
|
94971
|
-
|
|
95848
|
+
*
|
|
95849
|
+
* Represents the highlight around the shape.
|
|
95850
|
+
*
|
|
95851
|
+
* [Api set: 1.1]
|
|
95852
|
+
*/
|
|
95853
|
+
highlight?: Visio.Highlight;
|
|
95854
|
+
}
|
|
95855
|
+
/** An interface for updating data on the ShapeDataItemCollection object, for use in `shapeDataItemCollection.set({ ... })`. */
|
|
95856
|
+
interface ShapeDataItemCollectionUpdateData {
|
|
95857
|
+
items?: Visio.Interfaces.ShapeDataItemData[];
|
|
95858
|
+
}
|
|
95859
|
+
/** An interface for updating data on the HyperlinkCollection object, for use in `hyperlinkCollection.set({ ... })`. */
|
|
95860
|
+
interface HyperlinkCollectionUpdateData {
|
|
95861
|
+
items?: Visio.Interfaces.HyperlinkData[];
|
|
95862
|
+
}
|
|
95863
|
+
/** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
|
|
95864
|
+
interface CommentCollectionUpdateData {
|
|
95865
|
+
items?: Visio.Interfaces.CommentData[];
|
|
95866
|
+
}
|
|
95867
|
+
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
95868
|
+
interface CommentUpdateData {
|
|
94972
95869
|
/**
|
|
94973
|
-
|
|
94974
|
-
|
|
94975
|
-
|
|
94976
|
-
|
|
94977
|
-
|
|
94978
|
-
|
|
95870
|
+
*
|
|
95871
|
+
* A string that specifies the name of the author of the comment.
|
|
95872
|
+
*
|
|
95873
|
+
* [Api set: 1.1]
|
|
95874
|
+
*/
|
|
95875
|
+
author?: string;
|
|
94979
95876
|
/**
|
|
94980
|
-
|
|
94981
|
-
|
|
94982
|
-
|
|
94983
|
-
|
|
94984
|
-
|
|
94985
|
-
|
|
95877
|
+
*
|
|
95878
|
+
* A string that specifies the date when the comment was created.
|
|
95879
|
+
*
|
|
95880
|
+
* [Api set: 1.1]
|
|
95881
|
+
*/
|
|
95882
|
+
date?: string;
|
|
94986
95883
|
/**
|
|
94987
95884
|
*
|
|
94988
|
-
*
|
|
95885
|
+
* A string that contains the comment text.
|
|
94989
95886
|
*
|
|
94990
95887
|
* [Api set: 1.1]
|
|
94991
95888
|
*/
|
|
94992
|
-
|
|
95889
|
+
text?: string;
|
|
95890
|
+
}
|
|
95891
|
+
/** An interface describing the data returned by calling `application.toJSON()`. */
|
|
95892
|
+
interface ApplicationData {
|
|
94993
95893
|
/**
|
|
94994
95894
|
*
|
|
94995
|
-
*
|
|
95895
|
+
* Show or hide the iFrame application borders.
|
|
94996
95896
|
*
|
|
94997
95897
|
* [Api set: 1.1]
|
|
94998
95898
|
*/
|
|
94999
|
-
|
|
95899
|
+
showBorders?: boolean;
|
|
95000
95900
|
/**
|
|
95001
95901
|
*
|
|
95002
|
-
*
|
|
95902
|
+
* Show or hide the standard toolbars.
|
|
95003
95903
|
*
|
|
95004
95904
|
* [Api set: 1.1]
|
|
95005
95905
|
*/
|
|
95006
|
-
|
|
95906
|
+
showToolbars?: boolean;
|
|
95007
95907
|
}
|
|
95008
95908
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
95009
95909
|
interface DocumentData {
|
|
@@ -95021,83 +95921,103 @@ declare namespace Visio {
|
|
|
95021
95921
|
* [Api set: 1.1]
|
|
95022
95922
|
*/
|
|
95023
95923
|
pages?: Visio.Interfaces.PageData[];
|
|
95924
|
+
/**
|
|
95925
|
+
*
|
|
95926
|
+
* Returns the DocumentView object. Read-only.
|
|
95927
|
+
*
|
|
95928
|
+
* [Api set: 1.1]
|
|
95929
|
+
*/
|
|
95930
|
+
view?: Visio.Interfaces.DocumentViewData;
|
|
95931
|
+
}
|
|
95932
|
+
/** An interface describing the data returned by calling `documentView.toJSON()`. */
|
|
95933
|
+
interface DocumentViewData {
|
|
95024
95934
|
/**
|
|
95025
95935
|
*
|
|
95026
|
-
*
|
|
95936
|
+
* Disable Hyperlinks.
|
|
95027
95937
|
*
|
|
95028
95938
|
* [Api set: 1.1]
|
|
95029
95939
|
*/
|
|
95030
|
-
|
|
95940
|
+
disableHyperlinks?: boolean;
|
|
95031
95941
|
/**
|
|
95032
95942
|
*
|
|
95033
|
-
*
|
|
95943
|
+
* Disable Pan.
|
|
95034
95944
|
*
|
|
95035
95945
|
* [Api set: 1.1]
|
|
95036
95946
|
*/
|
|
95037
|
-
|
|
95947
|
+
disablePan?: boolean;
|
|
95038
95948
|
/**
|
|
95039
95949
|
*
|
|
95040
|
-
*
|
|
95950
|
+
* Disable PanZoomWindow.
|
|
95041
95951
|
*
|
|
95042
95952
|
* [Api set: 1.1]
|
|
95043
95953
|
*/
|
|
95044
|
-
|
|
95954
|
+
disablePanZoomWindow?: boolean;
|
|
95045
95955
|
/**
|
|
95046
95956
|
*
|
|
95047
|
-
*
|
|
95957
|
+
* Disable Zoom.
|
|
95048
95958
|
*
|
|
95049
95959
|
* [Api set: 1.1]
|
|
95050
95960
|
*/
|
|
95051
|
-
|
|
95961
|
+
disableZoom?: boolean;
|
|
95052
95962
|
/**
|
|
95053
95963
|
*
|
|
95054
|
-
*
|
|
95964
|
+
* Hide Diagram Boundary.
|
|
95055
95965
|
*
|
|
95056
95966
|
* [Api set: 1.1]
|
|
95057
95967
|
*/
|
|
95058
|
-
|
|
95059
|
-
}
|
|
95060
|
-
/** An interface describing the data returned by calling `documentCollection.toJSON()`. */
|
|
95061
|
-
interface DocumentCollectionData {
|
|
95062
|
-
items?: Visio.Interfaces.DocumentData[];
|
|
95968
|
+
hideDiagramBoundary?: boolean;
|
|
95063
95969
|
}
|
|
95064
95970
|
/** An interface describing the data returned by calling `page.toJSON()`. */
|
|
95065
95971
|
interface PageData {
|
|
95066
95972
|
/**
|
|
95067
95973
|
*
|
|
95068
|
-
*
|
|
95974
|
+
* All shapes in the Page, including subshapes. Read-only.
|
|
95069
95975
|
*
|
|
95070
95976
|
* [Api set: 1.1]
|
|
95071
95977
|
*/
|
|
95072
|
-
|
|
95978
|
+
allShapes?: Visio.Interfaces.ShapeData[];
|
|
95073
95979
|
/**
|
|
95074
95980
|
*
|
|
95075
|
-
*
|
|
95981
|
+
* Returns the Comments Collection. Read-only.
|
|
95076
95982
|
*
|
|
95077
95983
|
* [Api set: 1.1]
|
|
95078
95984
|
*/
|
|
95079
|
-
|
|
95985
|
+
comments?: Visio.Interfaces.CommentData[];
|
|
95080
95986
|
/**
|
|
95081
95987
|
*
|
|
95082
|
-
*
|
|
95988
|
+
* All top-level shapes in the Page.Read-only.
|
|
95083
95989
|
*
|
|
95084
95990
|
* [Api set: 1.1]
|
|
95085
95991
|
*/
|
|
95086
95992
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
95993
|
+
/**
|
|
95994
|
+
*
|
|
95995
|
+
* Returns the view of the page. Read-only.
|
|
95996
|
+
*
|
|
95997
|
+
* [Api set: 1.1]
|
|
95998
|
+
*/
|
|
95999
|
+
view?: Visio.Interfaces.PageViewData;
|
|
95087
96000
|
/**
|
|
95088
96001
|
*
|
|
95089
|
-
* Returns the
|
|
96002
|
+
* Returns the height of the page. Read-only.
|
|
95090
96003
|
*
|
|
95091
96004
|
* [Api set: 1.1]
|
|
95092
96005
|
*/
|
|
95093
|
-
|
|
96006
|
+
height?: number;
|
|
95094
96007
|
/**
|
|
95095
96008
|
*
|
|
95096
|
-
* Index of the Page.
|
|
96009
|
+
* Index of the Page. Read-only.
|
|
95097
96010
|
*
|
|
95098
96011
|
* [Api set: 1.1]
|
|
95099
96012
|
*/
|
|
95100
96013
|
index?: number;
|
|
96014
|
+
/**
|
|
96015
|
+
*
|
|
96016
|
+
* Whether the page is a background page or not. Read-only.
|
|
96017
|
+
*
|
|
96018
|
+
* [Api set: 1.1]
|
|
96019
|
+
*/
|
|
96020
|
+
isBackground?: boolean;
|
|
95101
96021
|
/**
|
|
95102
96022
|
*
|
|
95103
96023
|
* Page name. Read-only.
|
|
@@ -95105,477 +96025,790 @@ declare namespace Visio {
|
|
|
95105
96025
|
* [Api set: 1.1]
|
|
95106
96026
|
*/
|
|
95107
96027
|
name?: string;
|
|
96028
|
+
/**
|
|
96029
|
+
*
|
|
96030
|
+
* Returns the width of the page. Read-only.
|
|
96031
|
+
*
|
|
96032
|
+
* [Api set: 1.1]
|
|
96033
|
+
*/
|
|
96034
|
+
width?: number;
|
|
96035
|
+
}
|
|
96036
|
+
/** An interface describing the data returned by calling `pageView.toJSON()`. */
|
|
96037
|
+
interface PageViewData {
|
|
96038
|
+
/**
|
|
96039
|
+
*
|
|
96040
|
+
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
96041
|
+
*
|
|
96042
|
+
* [Api set: 1.1]
|
|
96043
|
+
*/
|
|
96044
|
+
zoom?: number;
|
|
95108
96045
|
}
|
|
95109
96046
|
/** An interface describing the data returned by calling `pageCollection.toJSON()`. */
|
|
95110
96047
|
interface PageCollectionData {
|
|
95111
96048
|
items?: Visio.Interfaces.PageData[];
|
|
95112
96049
|
}
|
|
96050
|
+
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
96051
|
+
interface ShapeCollectionData {
|
|
96052
|
+
items?: Visio.Interfaces.ShapeData[];
|
|
96053
|
+
}
|
|
95113
96054
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
95114
96055
|
interface ShapeData {
|
|
95115
96056
|
/**
|
|
95116
96057
|
*
|
|
95117
|
-
* Returns the
|
|
96058
|
+
* Returns the Comments Collection. Read-only.
|
|
95118
96059
|
*
|
|
95119
96060
|
* [Api set: 1.1]
|
|
95120
96061
|
*/
|
|
95121
|
-
|
|
96062
|
+
comments?: Visio.Interfaces.CommentData[];
|
|
95122
96063
|
/**
|
|
95123
96064
|
*
|
|
95124
|
-
*
|
|
96065
|
+
* Returns the Hyperlinks collection for a Shape object. Read-only.
|
|
95125
96066
|
*
|
|
95126
96067
|
* [Api set: 1.1]
|
|
95127
96068
|
*/
|
|
95128
|
-
|
|
96069
|
+
hyperlinks?: Visio.Interfaces.HyperlinkData[];
|
|
96070
|
+
/**
|
|
96071
|
+
*
|
|
96072
|
+
* Returns the Shape's Data Section. Read-only.
|
|
96073
|
+
*
|
|
96074
|
+
* [Api set: 1.1]
|
|
96075
|
+
*/
|
|
96076
|
+
shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
|
|
96077
|
+
/**
|
|
96078
|
+
*
|
|
96079
|
+
* Gets SubShape Collection. Read-only.
|
|
96080
|
+
*
|
|
96081
|
+
* [Api set: 1.1]
|
|
96082
|
+
*/
|
|
96083
|
+
subShapes?: Visio.Interfaces.ShapeData[];
|
|
96084
|
+
/**
|
|
96085
|
+
*
|
|
96086
|
+
* Returns the view of the shape. Read-only.
|
|
96087
|
+
*
|
|
96088
|
+
* [Api set: 1.1]
|
|
96089
|
+
*/
|
|
96090
|
+
view?: Visio.Interfaces.ShapeViewData;
|
|
95129
96091
|
/**
|
|
95130
96092
|
*
|
|
95131
|
-
* Shape's
|
|
96093
|
+
* Shape's identifier. Read-only.
|
|
95132
96094
|
*
|
|
95133
96095
|
* [Api set: 1.1]
|
|
95134
96096
|
*/
|
|
95135
96097
|
id?: number;
|
|
95136
96098
|
/**
|
|
95137
96099
|
*
|
|
95138
|
-
*
|
|
96100
|
+
* Shape's name. Read-only.
|
|
95139
96101
|
*
|
|
95140
96102
|
* [Api set: 1.1]
|
|
95141
96103
|
*/
|
|
95142
|
-
|
|
96104
|
+
name?: string;
|
|
95143
96105
|
/**
|
|
95144
96106
|
*
|
|
95145
|
-
*
|
|
96107
|
+
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
95146
96108
|
*
|
|
95147
96109
|
* [Api set: 1.1]
|
|
95148
96110
|
*/
|
|
95149
|
-
|
|
96111
|
+
select?: boolean;
|
|
95150
96112
|
/**
|
|
95151
96113
|
*
|
|
95152
|
-
*
|
|
96114
|
+
* Shape's text. Read-only.
|
|
95153
96115
|
*
|
|
95154
96116
|
* [Api set: 1.1]
|
|
95155
96117
|
*/
|
|
95156
|
-
|
|
96118
|
+
text?: string;
|
|
96119
|
+
}
|
|
96120
|
+
/** An interface describing the data returned by calling `shapeView.toJSON()`. */
|
|
96121
|
+
interface ShapeViewData {
|
|
95157
96122
|
/**
|
|
95158
96123
|
*
|
|
95159
|
-
*
|
|
96124
|
+
* Represents the highlight around the shape.
|
|
95160
96125
|
*
|
|
95161
96126
|
* [Api set: 1.1]
|
|
95162
96127
|
*/
|
|
95163
|
-
|
|
96128
|
+
highlight?: Visio.Highlight;
|
|
96129
|
+
}
|
|
96130
|
+
/** An interface describing the data returned by calling `shapeDataItemCollection.toJSON()`. */
|
|
96131
|
+
interface ShapeDataItemCollectionData {
|
|
96132
|
+
items?: Visio.Interfaces.ShapeDataItemData[];
|
|
96133
|
+
}
|
|
96134
|
+
/** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
|
|
96135
|
+
interface ShapeDataItemData {
|
|
96136
|
+
/**
|
|
96137
|
+
*
|
|
96138
|
+
* A string that specifies the format of the shape data item. Read-only.
|
|
96139
|
+
*
|
|
96140
|
+
* [Api set: 1.1]
|
|
96141
|
+
*/
|
|
96142
|
+
format?: string;
|
|
96143
|
+
/**
|
|
96144
|
+
*
|
|
96145
|
+
* A string that specifies the formatted value of the shape data item. Read-only.
|
|
96146
|
+
*
|
|
96147
|
+
* [Api set: 1.1]
|
|
96148
|
+
*/
|
|
96149
|
+
formattedValue?: string;
|
|
96150
|
+
/**
|
|
96151
|
+
*
|
|
96152
|
+
* A string that specifies the label of the shape data item. Read-only.
|
|
96153
|
+
*
|
|
96154
|
+
* [Api set: 1.1]
|
|
96155
|
+
*/
|
|
96156
|
+
label?: string;
|
|
96157
|
+
/**
|
|
96158
|
+
*
|
|
96159
|
+
* A string that specifies the value of the shape data item. Read-only.
|
|
96160
|
+
*
|
|
96161
|
+
* [Api set: 1.1]
|
|
96162
|
+
*/
|
|
96163
|
+
value?: string;
|
|
96164
|
+
}
|
|
96165
|
+
/** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
|
|
96166
|
+
interface HyperlinkCollectionData {
|
|
96167
|
+
items?: Visio.Interfaces.HyperlinkData[];
|
|
96168
|
+
}
|
|
96169
|
+
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
|
|
96170
|
+
interface HyperlinkData {
|
|
95164
96171
|
/**
|
|
95165
96172
|
*
|
|
95166
|
-
*
|
|
96173
|
+
* Gets the address of the Hyperlink object. Read-only.
|
|
95167
96174
|
*
|
|
95168
96175
|
* [Api set: 1.1]
|
|
95169
96176
|
*/
|
|
95170
|
-
|
|
96177
|
+
address?: string;
|
|
95171
96178
|
/**
|
|
95172
96179
|
*
|
|
95173
|
-
*
|
|
96180
|
+
* Gets the description of a hyperlink. Read-only.
|
|
96181
|
+
*
|
|
96182
|
+
* [Api set: 1.1]
|
|
96183
|
+
*/
|
|
96184
|
+
description?: string;
|
|
96185
|
+
/**
|
|
96186
|
+
*
|
|
96187
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
96188
|
+
*
|
|
96189
|
+
* [Api set: 1.1]
|
|
96190
|
+
*/
|
|
96191
|
+
extraInfo?: string;
|
|
96192
|
+
/**
|
|
96193
|
+
*
|
|
96194
|
+
* Gets the sub-address of the Hyperlink object. Read-only.
|
|
96195
|
+
*
|
|
96196
|
+
* [Api set: 1.1]
|
|
96197
|
+
*/
|
|
96198
|
+
subAddress?: string;
|
|
96199
|
+
}
|
|
96200
|
+
/** An interface describing the data returned by calling `commentCollection.toJSON()`. */
|
|
96201
|
+
interface CommentCollectionData {
|
|
96202
|
+
items?: Visio.Interfaces.CommentData[];
|
|
96203
|
+
}
|
|
96204
|
+
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
96205
|
+
interface CommentData {
|
|
96206
|
+
/**
|
|
96207
|
+
*
|
|
96208
|
+
* A string that specifies the name of the author of the comment.
|
|
96209
|
+
*
|
|
96210
|
+
* [Api set: 1.1]
|
|
96211
|
+
*/
|
|
96212
|
+
author?: string;
|
|
96213
|
+
/**
|
|
96214
|
+
*
|
|
96215
|
+
* A string that specifies the date when the comment was created.
|
|
96216
|
+
*
|
|
96217
|
+
* [Api set: 1.1]
|
|
96218
|
+
*/
|
|
96219
|
+
date?: string;
|
|
96220
|
+
/**
|
|
96221
|
+
*
|
|
96222
|
+
* A string that contains the comment text.
|
|
95174
96223
|
*
|
|
95175
96224
|
* [Api set: 1.1]
|
|
95176
96225
|
*/
|
|
95177
96226
|
text?: string;
|
|
95178
96227
|
}
|
|
95179
|
-
/** An interface describing the data returned by calling `
|
|
95180
|
-
interface
|
|
95181
|
-
|
|
96228
|
+
/** An interface describing the data returned by calling `selection.toJSON()`. */
|
|
96229
|
+
interface SelectionData {
|
|
96230
|
+
/**
|
|
96231
|
+
*
|
|
96232
|
+
* Gets the Shapes of the Selection. Read-only.
|
|
96233
|
+
*
|
|
96234
|
+
* [Api set: 1.1]
|
|
96235
|
+
*/
|
|
96236
|
+
shapes?: Visio.Interfaces.ShapeData[];
|
|
95182
96237
|
}
|
|
95183
96238
|
/**
|
|
96239
|
+
*
|
|
96240
|
+
* Represents the Application.
|
|
96241
|
+
*
|
|
95184
96242
|
* [Api set: 1.1]
|
|
95185
96243
|
*/
|
|
95186
96244
|
interface ApplicationLoadOptions {
|
|
96245
|
+
/**
|
|
96246
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96247
|
+
*/
|
|
96248
|
+
$all?: boolean;
|
|
96249
|
+
/**
|
|
96250
|
+
*
|
|
96251
|
+
* Show or hide the iFrame application borders.
|
|
96252
|
+
*
|
|
96253
|
+
* [Api set: 1.1]
|
|
96254
|
+
*/
|
|
96255
|
+
showBorders?: boolean;
|
|
96256
|
+
/**
|
|
96257
|
+
*
|
|
96258
|
+
* Show or hide the standard toolbars.
|
|
96259
|
+
*
|
|
96260
|
+
* [Api set: 1.1]
|
|
96261
|
+
*/
|
|
96262
|
+
showToolbars?: boolean;
|
|
96263
|
+
}
|
|
96264
|
+
/**
|
|
96265
|
+
*
|
|
96266
|
+
* Represents the Document class.
|
|
96267
|
+
*
|
|
96268
|
+
* [Api set: 1.1]
|
|
96269
|
+
*/
|
|
96270
|
+
interface DocumentLoadOptions {
|
|
95187
96271
|
/**
|
|
95188
96272
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95189
96273
|
*/
|
|
95190
96274
|
$all?: boolean;
|
|
95191
96275
|
/**
|
|
95192
96276
|
*
|
|
95193
|
-
*
|
|
96277
|
+
* Represents a Visio application instance that contains this document.
|
|
95194
96278
|
*
|
|
95195
96279
|
* [Api set: 1.1]
|
|
95196
96280
|
*/
|
|
95197
|
-
|
|
96281
|
+
application?: Visio.Interfaces.ApplicationLoadOptions;
|
|
95198
96282
|
/**
|
|
95199
96283
|
*
|
|
95200
|
-
* Returns the
|
|
96284
|
+
* Returns the DocumentView object.
|
|
95201
96285
|
*
|
|
95202
96286
|
* [Api set: 1.1]
|
|
95203
96287
|
*/
|
|
95204
|
-
|
|
96288
|
+
view?: Visio.Interfaces.DocumentViewLoadOptions;
|
|
96289
|
+
}
|
|
96290
|
+
/**
|
|
96291
|
+
*
|
|
96292
|
+
* Represents the DocumentView class.
|
|
96293
|
+
*
|
|
96294
|
+
* [Api set: 1.1]
|
|
96295
|
+
*/
|
|
96296
|
+
interface DocumentViewLoadOptions {
|
|
96297
|
+
/**
|
|
96298
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96299
|
+
*/
|
|
96300
|
+
$all?: boolean;
|
|
95205
96301
|
/**
|
|
95206
96302
|
*
|
|
95207
|
-
*
|
|
96303
|
+
* Disable Hyperlinks.
|
|
95208
96304
|
*
|
|
95209
96305
|
* [Api set: 1.1]
|
|
95210
96306
|
*/
|
|
95211
|
-
|
|
96307
|
+
disableHyperlinks?: boolean;
|
|
95212
96308
|
/**
|
|
95213
96309
|
*
|
|
95214
|
-
*
|
|
96310
|
+
* Disable Pan.
|
|
95215
96311
|
*
|
|
95216
96312
|
* [Api set: 1.1]
|
|
95217
96313
|
*/
|
|
95218
|
-
|
|
96314
|
+
disablePan?: boolean;
|
|
95219
96315
|
/**
|
|
95220
96316
|
*
|
|
95221
|
-
*
|
|
96317
|
+
* Disable PanZoomWindow.
|
|
95222
96318
|
*
|
|
95223
96319
|
* [Api set: 1.1]
|
|
95224
96320
|
*/
|
|
95225
|
-
|
|
96321
|
+
disablePanZoomWindow?: boolean;
|
|
96322
|
+
/**
|
|
96323
|
+
*
|
|
96324
|
+
* Disable Zoom.
|
|
96325
|
+
*
|
|
96326
|
+
* [Api set: 1.1]
|
|
96327
|
+
*/
|
|
96328
|
+
disableZoom?: boolean;
|
|
96329
|
+
/**
|
|
96330
|
+
*
|
|
96331
|
+
* Hide Diagram Boundary.
|
|
96332
|
+
*
|
|
96333
|
+
* [Api set: 1.1]
|
|
96334
|
+
*/
|
|
96335
|
+
hideDiagramBoundary?: boolean;
|
|
95226
96336
|
}
|
|
95227
96337
|
/**
|
|
96338
|
+
*
|
|
96339
|
+
* Represents the Page class.
|
|
96340
|
+
*
|
|
95228
96341
|
* [Api set: 1.1]
|
|
95229
96342
|
*/
|
|
95230
|
-
interface
|
|
96343
|
+
interface PageLoadOptions {
|
|
95231
96344
|
/**
|
|
95232
96345
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95233
96346
|
*/
|
|
95234
96347
|
$all?: boolean;
|
|
95235
96348
|
/**
|
|
95236
96349
|
*
|
|
95237
|
-
*
|
|
96350
|
+
* Returns the view of the page.
|
|
95238
96351
|
*
|
|
95239
96352
|
* [Api set: 1.1]
|
|
95240
96353
|
*/
|
|
95241
|
-
|
|
96354
|
+
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
95242
96355
|
/**
|
|
95243
96356
|
*
|
|
95244
|
-
*
|
|
96357
|
+
* Returns the height of the page. Read-only.
|
|
95245
96358
|
*
|
|
95246
96359
|
* [Api set: 1.1]
|
|
95247
96360
|
*/
|
|
95248
|
-
|
|
96361
|
+
height?: boolean;
|
|
95249
96362
|
/**
|
|
95250
96363
|
*
|
|
95251
|
-
*
|
|
96364
|
+
* Index of the Page. Read-only.
|
|
95252
96365
|
*
|
|
95253
96366
|
* [Api set: 1.1]
|
|
95254
96367
|
*/
|
|
95255
|
-
|
|
96368
|
+
index?: boolean;
|
|
95256
96369
|
/**
|
|
95257
96370
|
*
|
|
95258
|
-
*
|
|
96371
|
+
* Whether the page is a background page or not. Read-only.
|
|
95259
96372
|
*
|
|
95260
96373
|
* [Api set: 1.1]
|
|
95261
96374
|
*/
|
|
95262
|
-
|
|
96375
|
+
isBackground?: boolean;
|
|
95263
96376
|
/**
|
|
95264
96377
|
*
|
|
95265
|
-
*
|
|
96378
|
+
* Page name. Read-only.
|
|
95266
96379
|
*
|
|
95267
96380
|
* [Api set: 1.1]
|
|
95268
96381
|
*/
|
|
95269
|
-
|
|
96382
|
+
name?: boolean;
|
|
95270
96383
|
/**
|
|
95271
96384
|
*
|
|
95272
|
-
* Returns the
|
|
96385
|
+
* Returns the width of the page. Read-only.
|
|
95273
96386
|
*
|
|
95274
96387
|
* [Api set: 1.1]
|
|
95275
96388
|
*/
|
|
95276
|
-
|
|
96389
|
+
width?: boolean;
|
|
95277
96390
|
}
|
|
95278
96391
|
/**
|
|
96392
|
+
*
|
|
96393
|
+
* Represents the PageView class.
|
|
96394
|
+
*
|
|
95279
96395
|
* [Api set: 1.1]
|
|
95280
96396
|
*/
|
|
95281
|
-
interface
|
|
96397
|
+
interface PageViewLoadOptions {
|
|
96398
|
+
/**
|
|
96399
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96400
|
+
*/
|
|
96401
|
+
$all?: boolean;
|
|
96402
|
+
/**
|
|
96403
|
+
*
|
|
96404
|
+
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
96405
|
+
*
|
|
96406
|
+
* [Api set: 1.1]
|
|
96407
|
+
*/
|
|
96408
|
+
zoom?: boolean;
|
|
96409
|
+
}
|
|
96410
|
+
/**
|
|
96411
|
+
*
|
|
96412
|
+
* Represents a collection of Page objects that are part of the document.
|
|
96413
|
+
*
|
|
96414
|
+
* [Api set: 1.1]
|
|
96415
|
+
*/
|
|
96416
|
+
interface PageCollectionLoadOptions {
|
|
95282
96417
|
/**
|
|
95283
96418
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95284
96419
|
*/
|
|
95285
96420
|
$all?: boolean;
|
|
95286
96421
|
/**
|
|
95287
96422
|
*
|
|
95288
|
-
* For EACH ITEM in the collection:
|
|
96423
|
+
* For EACH ITEM in the collection: Returns the view of the page.
|
|
95289
96424
|
*
|
|
95290
96425
|
* [Api set: 1.1]
|
|
95291
96426
|
*/
|
|
95292
|
-
|
|
96427
|
+
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
95293
96428
|
/**
|
|
95294
96429
|
*
|
|
95295
|
-
* For EACH ITEM in the collection:
|
|
96430
|
+
* For EACH ITEM in the collection: Returns the height of the page. Read-only.
|
|
95296
96431
|
*
|
|
95297
96432
|
* [Api set: 1.1]
|
|
95298
96433
|
*/
|
|
95299
|
-
|
|
96434
|
+
height?: boolean;
|
|
95300
96435
|
/**
|
|
95301
96436
|
*
|
|
95302
|
-
* For EACH ITEM in the collection:
|
|
96437
|
+
* For EACH ITEM in the collection: Index of the Page. Read-only.
|
|
95303
96438
|
*
|
|
95304
96439
|
* [Api set: 1.1]
|
|
95305
96440
|
*/
|
|
95306
|
-
|
|
96441
|
+
index?: boolean;
|
|
95307
96442
|
/**
|
|
95308
96443
|
*
|
|
95309
|
-
* For EACH ITEM in the collection:
|
|
96444
|
+
* For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
|
|
95310
96445
|
*
|
|
95311
96446
|
* [Api set: 1.1]
|
|
95312
96447
|
*/
|
|
95313
|
-
|
|
96448
|
+
isBackground?: boolean;
|
|
95314
96449
|
/**
|
|
95315
96450
|
*
|
|
95316
|
-
* For EACH ITEM in the collection:
|
|
96451
|
+
* For EACH ITEM in the collection: Page name. Read-only.
|
|
95317
96452
|
*
|
|
95318
96453
|
* [Api set: 1.1]
|
|
95319
96454
|
*/
|
|
95320
|
-
|
|
96455
|
+
name?: boolean;
|
|
95321
96456
|
/**
|
|
95322
96457
|
*
|
|
95323
|
-
* For EACH ITEM in the collection: Returns the
|
|
96458
|
+
* For EACH ITEM in the collection: Returns the width of the page. Read-only.
|
|
95324
96459
|
*
|
|
95325
96460
|
* [Api set: 1.1]
|
|
95326
96461
|
*/
|
|
95327
|
-
|
|
96462
|
+
width?: boolean;
|
|
95328
96463
|
}
|
|
95329
96464
|
/**
|
|
96465
|
+
*
|
|
96466
|
+
* Represents the Shape Collection.
|
|
96467
|
+
*
|
|
95330
96468
|
* [Api set: 1.1]
|
|
95331
96469
|
*/
|
|
95332
|
-
interface
|
|
96470
|
+
interface ShapeCollectionLoadOptions {
|
|
95333
96471
|
/**
|
|
95334
96472
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95335
96473
|
*/
|
|
95336
96474
|
$all?: boolean;
|
|
95337
96475
|
/**
|
|
95338
96476
|
*
|
|
95339
|
-
*
|
|
95340
|
-
*
|
|
95341
|
-
* [Api set: 1.1]
|
|
95342
|
-
*/
|
|
95343
|
-
application?: Visio.Interfaces.ApplicationLoadOptions;
|
|
95344
|
-
/**
|
|
95345
|
-
*
|
|
95346
|
-
* Gets the document object that is assocaited with the page.
|
|
96477
|
+
* For EACH ITEM in the collection: Returns the view of the shape.
|
|
95347
96478
|
*
|
|
95348
96479
|
* [Api set: 1.1]
|
|
95349
96480
|
*/
|
|
95350
|
-
|
|
96481
|
+
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
95351
96482
|
/**
|
|
95352
96483
|
*
|
|
95353
|
-
*
|
|
96484
|
+
* For EACH ITEM in the collection: Shape's identifier. Read-only.
|
|
95354
96485
|
*
|
|
95355
96486
|
* [Api set: 1.1]
|
|
95356
96487
|
*/
|
|
95357
96488
|
id?: boolean;
|
|
95358
96489
|
/**
|
|
95359
96490
|
*
|
|
95360
|
-
*
|
|
96491
|
+
* For EACH ITEM in the collection: Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
|
|
95361
96492
|
*
|
|
95362
96493
|
* [Api set: 1.1]
|
|
95363
96494
|
*/
|
|
95364
|
-
|
|
96495
|
+
isBoundToData?: boolean;
|
|
95365
96496
|
/**
|
|
95366
96497
|
*
|
|
95367
|
-
*
|
|
96498
|
+
* For EACH ITEM in the collection: Shape's name. Read-only.
|
|
95368
96499
|
*
|
|
95369
96500
|
* [Api set: 1.1]
|
|
95370
96501
|
*/
|
|
95371
96502
|
name?: boolean;
|
|
96503
|
+
/**
|
|
96504
|
+
*
|
|
96505
|
+
* For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
96506
|
+
*
|
|
96507
|
+
* [Api set: 1.1]
|
|
96508
|
+
*/
|
|
96509
|
+
select?: boolean;
|
|
96510
|
+
/**
|
|
96511
|
+
*
|
|
96512
|
+
* For EACH ITEM in the collection: Shape's text. Read-only.
|
|
96513
|
+
*
|
|
96514
|
+
* [Api set: 1.1]
|
|
96515
|
+
*/
|
|
96516
|
+
text?: boolean;
|
|
95372
96517
|
}
|
|
95373
96518
|
/**
|
|
95374
96519
|
*
|
|
95375
|
-
* Represents
|
|
96520
|
+
* Represents the Shape class.
|
|
95376
96521
|
*
|
|
95377
96522
|
* [Api set: 1.1]
|
|
95378
96523
|
*/
|
|
95379
|
-
interface
|
|
96524
|
+
interface ShapeLoadOptions {
|
|
95380
96525
|
/**
|
|
95381
96526
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95382
96527
|
*/
|
|
95383
96528
|
$all?: boolean;
|
|
95384
96529
|
/**
|
|
95385
96530
|
*
|
|
95386
|
-
*
|
|
96531
|
+
* Returns the view of the shape.
|
|
95387
96532
|
*
|
|
95388
96533
|
* [Api set: 1.1]
|
|
95389
96534
|
*/
|
|
95390
|
-
|
|
95391
|
-
/**
|
|
95392
|
-
*
|
|
95393
|
-
* For EACH ITEM in the collection: Gets the document object that is assocaited with the page.
|
|
95394
|
-
*
|
|
95395
|
-
* [Api set: 1.1]
|
|
95396
|
-
*/
|
|
95397
|
-
document?: Visio.Interfaces.DocumentLoadOptions;
|
|
96535
|
+
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
95398
96536
|
/**
|
|
95399
96537
|
*
|
|
95400
|
-
*
|
|
96538
|
+
* Shape's identifier. Read-only.
|
|
95401
96539
|
*
|
|
95402
96540
|
* [Api set: 1.1]
|
|
95403
96541
|
*/
|
|
95404
96542
|
id?: boolean;
|
|
95405
96543
|
/**
|
|
95406
96544
|
*
|
|
95407
|
-
*
|
|
96545
|
+
* Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
|
|
95408
96546
|
*
|
|
95409
96547
|
* [Api set: 1.1]
|
|
95410
96548
|
*/
|
|
95411
|
-
|
|
96549
|
+
isBoundToData?: boolean;
|
|
95412
96550
|
/**
|
|
95413
96551
|
*
|
|
95414
|
-
*
|
|
96552
|
+
* Shape's name. Read-only.
|
|
95415
96553
|
*
|
|
95416
96554
|
* [Api set: 1.1]
|
|
95417
96555
|
*/
|
|
95418
96556
|
name?: boolean;
|
|
96557
|
+
/**
|
|
96558
|
+
*
|
|
96559
|
+
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
96560
|
+
*
|
|
96561
|
+
* [Api set: 1.1]
|
|
96562
|
+
*/
|
|
96563
|
+
select?: boolean;
|
|
96564
|
+
/**
|
|
96565
|
+
*
|
|
96566
|
+
* Shape's text. Read-only.
|
|
96567
|
+
*
|
|
96568
|
+
* [Api set: 1.1]
|
|
96569
|
+
*/
|
|
96570
|
+
text?: boolean;
|
|
95419
96571
|
}
|
|
95420
96572
|
/**
|
|
95421
96573
|
*
|
|
95422
|
-
* Represents the
|
|
96574
|
+
* Represents the ShapeView class.
|
|
95423
96575
|
*
|
|
95424
96576
|
* [Api set: 1.1]
|
|
95425
96577
|
*/
|
|
95426
|
-
interface
|
|
96578
|
+
interface ShapeViewLoadOptions {
|
|
95427
96579
|
/**
|
|
95428
96580
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95429
96581
|
*/
|
|
95430
96582
|
$all?: boolean;
|
|
95431
96583
|
/**
|
|
95432
|
-
|
|
95433
|
-
|
|
95434
|
-
|
|
95435
|
-
|
|
95436
|
-
|
|
95437
|
-
|
|
96584
|
+
*
|
|
96585
|
+
* Represents the highlight around the shape.
|
|
96586
|
+
*
|
|
96587
|
+
* [Api set: 1.1]
|
|
96588
|
+
*/
|
|
96589
|
+
highlight?: boolean;
|
|
96590
|
+
}
|
|
96591
|
+
/**
|
|
96592
|
+
*
|
|
96593
|
+
* Represents the ShapeDataItemCollection for a given Shape.
|
|
96594
|
+
*
|
|
96595
|
+
* [Api set: 1.1]
|
|
96596
|
+
*/
|
|
96597
|
+
interface ShapeDataItemCollectionLoadOptions {
|
|
95438
96598
|
/**
|
|
95439
|
-
|
|
95440
|
-
|
|
95441
|
-
|
|
95442
|
-
* [Api set: 1.1]
|
|
95443
|
-
*/
|
|
95444
|
-
document?: Visio.Interfaces.DocumentLoadOptions;
|
|
96599
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96600
|
+
*/
|
|
96601
|
+
$all?: boolean;
|
|
95445
96602
|
/**
|
|
95446
96603
|
*
|
|
95447
|
-
*
|
|
96604
|
+
* For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.
|
|
95448
96605
|
*
|
|
95449
96606
|
* [Api set: 1.1]
|
|
95450
96607
|
*/
|
|
95451
|
-
|
|
96608
|
+
format?: boolean;
|
|
95452
96609
|
/**
|
|
95453
96610
|
*
|
|
95454
|
-
*
|
|
96611
|
+
* For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.
|
|
95455
96612
|
*
|
|
95456
96613
|
* [Api set: 1.1]
|
|
95457
96614
|
*/
|
|
95458
|
-
|
|
96615
|
+
formattedValue?: boolean;
|
|
95459
96616
|
/**
|
|
95460
96617
|
*
|
|
95461
|
-
*
|
|
96618
|
+
* For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.
|
|
95462
96619
|
*
|
|
95463
96620
|
* [Api set: 1.1]
|
|
95464
96621
|
*/
|
|
95465
|
-
|
|
96622
|
+
label?: boolean;
|
|
95466
96623
|
/**
|
|
95467
96624
|
*
|
|
95468
|
-
*
|
|
96625
|
+
* For EACH ITEM in the collection: A string that specifies the value of the shape data item. Read-only.
|
|
95469
96626
|
*
|
|
95470
96627
|
* [Api set: 1.1]
|
|
95471
96628
|
*/
|
|
95472
|
-
|
|
96629
|
+
value?: boolean;
|
|
96630
|
+
}
|
|
96631
|
+
/**
|
|
96632
|
+
*
|
|
96633
|
+
* Represents the ShapeDataItem.
|
|
96634
|
+
*
|
|
96635
|
+
* [Api set: 1.1]
|
|
96636
|
+
*/
|
|
96637
|
+
interface ShapeDataItemLoadOptions {
|
|
96638
|
+
/**
|
|
96639
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96640
|
+
*/
|
|
96641
|
+
$all?: boolean;
|
|
95473
96642
|
/**
|
|
95474
96643
|
*
|
|
95475
|
-
*
|
|
96644
|
+
* A string that specifies the format of the shape data item. Read-only.
|
|
95476
96645
|
*
|
|
95477
96646
|
* [Api set: 1.1]
|
|
95478
96647
|
*/
|
|
95479
|
-
|
|
96648
|
+
format?: boolean;
|
|
95480
96649
|
/**
|
|
95481
96650
|
*
|
|
95482
|
-
*
|
|
96651
|
+
* A string that specifies the formatted value of the shape data item. Read-only.
|
|
95483
96652
|
*
|
|
95484
96653
|
* [Api set: 1.1]
|
|
95485
96654
|
*/
|
|
95486
|
-
|
|
96655
|
+
formattedValue?: boolean;
|
|
95487
96656
|
/**
|
|
95488
96657
|
*
|
|
95489
|
-
*
|
|
96658
|
+
* A string that specifies the label of the shape data item. Read-only.
|
|
95490
96659
|
*
|
|
95491
96660
|
* [Api set: 1.1]
|
|
95492
96661
|
*/
|
|
95493
|
-
|
|
96662
|
+
label?: boolean;
|
|
95494
96663
|
/**
|
|
95495
96664
|
*
|
|
95496
|
-
*
|
|
96665
|
+
* A string that specifies the value of the shape data item. Read-only.
|
|
95497
96666
|
*
|
|
95498
96667
|
* [Api set: 1.1]
|
|
95499
96668
|
*/
|
|
95500
|
-
|
|
96669
|
+
value?: boolean;
|
|
95501
96670
|
}
|
|
95502
96671
|
/**
|
|
95503
96672
|
*
|
|
95504
|
-
* Represents the
|
|
96673
|
+
* Represents the Hyperlink Collection.
|
|
95505
96674
|
*
|
|
95506
96675
|
* [Api set: 1.1]
|
|
95507
96676
|
*/
|
|
95508
|
-
interface
|
|
96677
|
+
interface HyperlinkCollectionLoadOptions {
|
|
95509
96678
|
/**
|
|
95510
96679
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
95511
96680
|
*/
|
|
95512
96681
|
$all?: boolean;
|
|
95513
96682
|
/**
|
|
95514
|
-
|
|
95515
|
-
|
|
95516
|
-
|
|
95517
|
-
|
|
95518
|
-
|
|
95519
|
-
|
|
96683
|
+
*
|
|
96684
|
+
* For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.
|
|
96685
|
+
*
|
|
96686
|
+
* [Api set: 1.1]
|
|
96687
|
+
*/
|
|
96688
|
+
address?: boolean;
|
|
95520
96689
|
/**
|
|
95521
|
-
|
|
95522
|
-
|
|
95523
|
-
|
|
95524
|
-
|
|
95525
|
-
|
|
95526
|
-
|
|
96690
|
+
*
|
|
96691
|
+
* For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.
|
|
96692
|
+
*
|
|
96693
|
+
* [Api set: 1.1]
|
|
96694
|
+
*/
|
|
96695
|
+
description?: boolean;
|
|
95527
96696
|
/**
|
|
95528
96697
|
*
|
|
95529
|
-
* For EACH ITEM in the collection:
|
|
96698
|
+
* For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
95530
96699
|
*
|
|
95531
96700
|
* [Api set: 1.1]
|
|
95532
96701
|
*/
|
|
95533
|
-
|
|
96702
|
+
extraInfo?: boolean;
|
|
95534
96703
|
/**
|
|
95535
96704
|
*
|
|
95536
|
-
* For EACH ITEM in the collection:
|
|
96705
|
+
* For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.
|
|
95537
96706
|
*
|
|
95538
96707
|
* [Api set: 1.1]
|
|
95539
96708
|
*/
|
|
95540
|
-
|
|
96709
|
+
subAddress?: boolean;
|
|
96710
|
+
}
|
|
96711
|
+
/**
|
|
96712
|
+
*
|
|
96713
|
+
* Represents the Hyperlink.
|
|
96714
|
+
*
|
|
96715
|
+
* [Api set: 1.1]
|
|
96716
|
+
*/
|
|
96717
|
+
interface HyperlinkLoadOptions {
|
|
96718
|
+
/**
|
|
96719
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96720
|
+
*/
|
|
96721
|
+
$all?: boolean;
|
|
95541
96722
|
/**
|
|
95542
96723
|
*
|
|
95543
|
-
*
|
|
96724
|
+
* Gets the address of the Hyperlink object. Read-only.
|
|
95544
96725
|
*
|
|
95545
96726
|
* [Api set: 1.1]
|
|
95546
96727
|
*/
|
|
95547
|
-
|
|
96728
|
+
address?: boolean;
|
|
95548
96729
|
/**
|
|
95549
96730
|
*
|
|
95550
|
-
*
|
|
96731
|
+
* Gets the description of a hyperlink. Read-only.
|
|
95551
96732
|
*
|
|
95552
96733
|
* [Api set: 1.1]
|
|
95553
96734
|
*/
|
|
95554
|
-
|
|
96735
|
+
description?: boolean;
|
|
95555
96736
|
/**
|
|
95556
96737
|
*
|
|
95557
|
-
*
|
|
96738
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
95558
96739
|
*
|
|
95559
96740
|
* [Api set: 1.1]
|
|
95560
96741
|
*/
|
|
95561
|
-
|
|
96742
|
+
extraInfo?: boolean;
|
|
95562
96743
|
/**
|
|
95563
96744
|
*
|
|
95564
|
-
*
|
|
96745
|
+
* Gets the sub-address of the Hyperlink object. Read-only.
|
|
95565
96746
|
*
|
|
95566
96747
|
* [Api set: 1.1]
|
|
95567
96748
|
*/
|
|
95568
|
-
|
|
96749
|
+
subAddress?: boolean;
|
|
96750
|
+
}
|
|
96751
|
+
/**
|
|
96752
|
+
*
|
|
96753
|
+
* Represents the CommentCollection for a given Shape.
|
|
96754
|
+
*
|
|
96755
|
+
* [Api set: 1.1]
|
|
96756
|
+
*/
|
|
96757
|
+
interface CommentCollectionLoadOptions {
|
|
96758
|
+
/**
|
|
96759
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96760
|
+
*/
|
|
96761
|
+
$all?: boolean;
|
|
96762
|
+
/**
|
|
96763
|
+
*
|
|
96764
|
+
* For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
|
|
96765
|
+
*
|
|
96766
|
+
* [Api set: 1.1]
|
|
96767
|
+
*/
|
|
96768
|
+
author?: boolean;
|
|
96769
|
+
/**
|
|
96770
|
+
*
|
|
96771
|
+
* For EACH ITEM in the collection: A string that specifies the date when the comment was created.
|
|
96772
|
+
*
|
|
96773
|
+
* [Api set: 1.1]
|
|
96774
|
+
*/
|
|
96775
|
+
date?: boolean;
|
|
96776
|
+
/**
|
|
96777
|
+
*
|
|
96778
|
+
* For EACH ITEM in the collection: A string that contains the comment text.
|
|
96779
|
+
*
|
|
96780
|
+
* [Api set: 1.1]
|
|
96781
|
+
*/
|
|
96782
|
+
text?: boolean;
|
|
96783
|
+
}
|
|
96784
|
+
/**
|
|
96785
|
+
*
|
|
96786
|
+
* Represents the Comment.
|
|
96787
|
+
*
|
|
96788
|
+
* [Api set: 1.1]
|
|
96789
|
+
*/
|
|
96790
|
+
interface CommentLoadOptions {
|
|
96791
|
+
/**
|
|
96792
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
96793
|
+
*/
|
|
96794
|
+
$all?: boolean;
|
|
96795
|
+
/**
|
|
96796
|
+
*
|
|
96797
|
+
* A string that specifies the name of the author of the comment.
|
|
96798
|
+
*
|
|
96799
|
+
* [Api set: 1.1]
|
|
96800
|
+
*/
|
|
96801
|
+
author?: boolean;
|
|
95569
96802
|
/**
|
|
95570
96803
|
*
|
|
95571
|
-
*
|
|
96804
|
+
* A string that specifies the date when the comment was created.
|
|
95572
96805
|
*
|
|
95573
96806
|
* [Api set: 1.1]
|
|
95574
96807
|
*/
|
|
95575
|
-
|
|
96808
|
+
date?: boolean;
|
|
95576
96809
|
/**
|
|
95577
96810
|
*
|
|
95578
|
-
*
|
|
96811
|
+
* A string that contains the comment text.
|
|
95579
96812
|
*
|
|
95580
96813
|
* [Api set: 1.1]
|
|
95581
96814
|
*/
|