@types/office-js-preview 1.0.527 → 1.0.529
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +1701 -482
- office-js-preview/package.json +3 -3
office-js-preview/index.d.ts
CHANGED
|
@@ -22129,7 +22129,7 @@ declare namespace Excel {
|
|
|
22129
22129
|
referencedValues?: ReferencedValue[];
|
|
22130
22130
|
}
|
|
22131
22131
|
/**
|
|
22132
|
-
* The
|
|
22132
|
+
* The Base64-encoded type and data of an image.
|
|
22133
22133
|
*
|
|
22134
22134
|
* @remarks
|
|
22135
22135
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -22137,15 +22137,15 @@ declare namespace Excel {
|
|
|
22137
22137
|
*/
|
|
22138
22138
|
interface Base64EncodedImage {
|
|
22139
22139
|
/**
|
|
22140
|
-
* The file type of the encoded image.
|
|
22140
|
+
* The file type of the Base64-encoded image.
|
|
22141
22141
|
*
|
|
22142
22142
|
* @remarks
|
|
22143
22143
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22144
22144
|
* @beta
|
|
22145
22145
|
*/
|
|
22146
|
-
type: Base64EncodingType | "JPG" | "PNG";
|
|
22146
|
+
type: Base64EncodingType | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP";
|
|
22147
22147
|
/**
|
|
22148
|
-
* The
|
|
22148
|
+
* The Base64-encoded string.
|
|
22149
22149
|
*
|
|
22150
22150
|
* @remarks
|
|
22151
22151
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -22154,7 +22154,7 @@ declare namespace Excel {
|
|
|
22154
22154
|
data: string;
|
|
22155
22155
|
}
|
|
22156
22156
|
/**
|
|
22157
|
-
* The file type represented by the
|
|
22157
|
+
* The file type represented by the Base64 encoding.
|
|
22158
22158
|
*
|
|
22159
22159
|
* @remarks
|
|
22160
22160
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -22162,7 +22162,31 @@ declare namespace Excel {
|
|
|
22162
22162
|
*/
|
|
22163
22163
|
enum Base64EncodingType {
|
|
22164
22164
|
/**
|
|
22165
|
-
* The
|
|
22165
|
+
* The BMP file type.
|
|
22166
|
+
*
|
|
22167
|
+
* @remarks
|
|
22168
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22169
|
+
* @beta
|
|
22170
|
+
*/
|
|
22171
|
+
BMP = "BMP",
|
|
22172
|
+
/**
|
|
22173
|
+
* The GIF file type.
|
|
22174
|
+
*
|
|
22175
|
+
* @remarks
|
|
22176
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22177
|
+
* @beta
|
|
22178
|
+
*/
|
|
22179
|
+
GIF = "GIF",
|
|
22180
|
+
/**
|
|
22181
|
+
* The ICO file type.
|
|
22182
|
+
*
|
|
22183
|
+
* @remarks
|
|
22184
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22185
|
+
* @beta
|
|
22186
|
+
*/
|
|
22187
|
+
ICO = "ICO",
|
|
22188
|
+
/**
|
|
22189
|
+
* The JPG (or JPEG) file type.
|
|
22166
22190
|
*
|
|
22167
22191
|
* @remarks
|
|
22168
22192
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -22176,7 +22200,23 @@ declare namespace Excel {
|
|
|
22176
22200
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22177
22201
|
* @beta
|
|
22178
22202
|
*/
|
|
22179
|
-
PNG = "PNG"
|
|
22203
|
+
PNG = "PNG",
|
|
22204
|
+
/**
|
|
22205
|
+
* The TIFF file type.
|
|
22206
|
+
*
|
|
22207
|
+
* @remarks
|
|
22208
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22209
|
+
* @beta
|
|
22210
|
+
*/
|
|
22211
|
+
TIF = "TIF",
|
|
22212
|
+
/**
|
|
22213
|
+
* The WEBP file type.
|
|
22214
|
+
*
|
|
22215
|
+
* @remarks
|
|
22216
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22217
|
+
* @beta
|
|
22218
|
+
*/
|
|
22219
|
+
WEBP = "WEBP"
|
|
22180
22220
|
}
|
|
22181
22221
|
/**
|
|
22182
22222
|
* Represents a card layout that is best used for an array.
|
|
@@ -22297,7 +22337,159 @@ declare namespace Excel {
|
|
|
22297
22337
|
* @remarks
|
|
22298
22338
|
* [Api set: ExcelApi 1.16]
|
|
22299
22339
|
*/
|
|
22300
|
-
noLicense = "NoLicense"
|
|
22340
|
+
noLicense = "NoLicense",
|
|
22341
|
+
/**
|
|
22342
|
+
* An error caused by Excel 4.0 macros being disabled in Trust Center. Displays as error type #BLOCKED! in Excel.
|
|
22343
|
+
*
|
|
22344
|
+
* @remarks
|
|
22345
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22346
|
+
* @beta
|
|
22347
|
+
*/
|
|
22348
|
+
xlmDisabledInTrustCenter = "XlmDisabledInTrustCenter",
|
|
22349
|
+
/**
|
|
22350
|
+
* An error caused by Excel 4.0 macros not being supported on the platform. Displays as error type #BLOCKED! in Excel.
|
|
22351
|
+
*
|
|
22352
|
+
* @remarks
|
|
22353
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22354
|
+
* @beta
|
|
22355
|
+
*/
|
|
22356
|
+
xlmNotSupportedOnPlatform = "XlmNotSupportedOnPlatform",
|
|
22357
|
+
/**
|
|
22358
|
+
* An error caused by the image download coming from an untrusted URL. Displays as error type #BLOCKED! in Excel.
|
|
22359
|
+
*
|
|
22360
|
+
* @remarks
|
|
22361
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22362
|
+
* @beta
|
|
22363
|
+
*/
|
|
22364
|
+
imageDownloadBlocked = "ImageDownloadBlocked",
|
|
22365
|
+
/**
|
|
22366
|
+
* An error caused by the image URL not being HTTPS. Displays as error type #BLOCKED! in Excel.
|
|
22367
|
+
*
|
|
22368
|
+
* @remarks
|
|
22369
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22370
|
+
* @beta
|
|
22371
|
+
*/
|
|
22372
|
+
imageInvalidUrlNonHttps = "ImageInvalidUrlNonHttps",
|
|
22373
|
+
/**
|
|
22374
|
+
* An error caused by the image exceeding the size limit set in ExcelServerSettings.CacheBackedAsyncImageDownloaderMaxFileSizeInKBytes. Displays as error type #BLOCKED! in Excel.
|
|
22375
|
+
*
|
|
22376
|
+
* @remarks
|
|
22377
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22378
|
+
* @beta
|
|
22379
|
+
*/
|
|
22380
|
+
imageExceedsSizeLimit = "ImageExceedsSizeLimit",
|
|
22381
|
+
/**
|
|
22382
|
+
* An error caused by the image exceeding the size limit for an entire workbook set in `ExcelWorkbookSizeMax`. Displays as error type #BLOCKED! in Excel.
|
|
22383
|
+
*
|
|
22384
|
+
* @remarks
|
|
22385
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22386
|
+
* @beta
|
|
22387
|
+
*/
|
|
22388
|
+
imageExceedsTotalSizeLimit = "ImageExceedsTotalSizeLimit",
|
|
22389
|
+
/**
|
|
22390
|
+
* An error caused by the user exceeding their quota of concurrently active external code service execution environments. Displays as error type #BLOCKED! in Excel.
|
|
22391
|
+
*
|
|
22392
|
+
* @remarks
|
|
22393
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22394
|
+
* @beta
|
|
22395
|
+
*/
|
|
22396
|
+
environmentExceedsQuota = "EnvironmentExceedsQuota",
|
|
22397
|
+
/**
|
|
22398
|
+
* An error caused by the user exceeding their daily quota of external code service execution environments. Displays as error type #BLOCKED! in Excel.
|
|
22399
|
+
*
|
|
22400
|
+
* @remarks
|
|
22401
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22402
|
+
* @beta
|
|
22403
|
+
*/
|
|
22404
|
+
environmentExceedsQuotaDaily = "EnvironmentExceedsQuotaDaily",
|
|
22405
|
+
/**
|
|
22406
|
+
* An error caused by the user exceeding their monthly quota of external code service execution environments. Displays as error type #BLOCKED! in Excel.
|
|
22407
|
+
*
|
|
22408
|
+
* @remarks
|
|
22409
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22410
|
+
* @beta
|
|
22411
|
+
*/
|
|
22412
|
+
environmentExceedsQuotaMonthly = "EnvironmentExceedsQuotaMonthly",
|
|
22413
|
+
/**
|
|
22414
|
+
* An error caused by the user who is not licensed for a feature which uses an external code service exceeding their monthly quota of external code service execution environments. Displays as error type #BLOCKED! in Excel.
|
|
22415
|
+
*
|
|
22416
|
+
* @remarks
|
|
22417
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22418
|
+
* @beta
|
|
22419
|
+
*/
|
|
22420
|
+
environmentExceedsTakerQuotaMonthly = "EnvironmentExceedsTakerQuotaMonthly",
|
|
22421
|
+
/**
|
|
22422
|
+
* An error caused by using an unsupported identity provider. Displays as error type #BLOCKED! in Excel.
|
|
22423
|
+
*
|
|
22424
|
+
* @remarks
|
|
22425
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22426
|
+
* @beta
|
|
22427
|
+
*/
|
|
22428
|
+
wrongAccountType = "WrongAccountType",
|
|
22429
|
+
/**
|
|
22430
|
+
* An error caused by an external code service execution environment exceeding its lifetime resource use. Displays as error type #BLOCKED! in Excel.
|
|
22431
|
+
*
|
|
22432
|
+
* @remarks
|
|
22433
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22434
|
+
* @beta
|
|
22435
|
+
*/
|
|
22436
|
+
environmentExceedsComputeResourceEver = "EnvironmentExceedsComputeResourceEver",
|
|
22437
|
+
/**
|
|
22438
|
+
* An error caused by a user exceeding their daily quota of compute. Displays as error type #BLOCKED! in Excel.
|
|
22439
|
+
*
|
|
22440
|
+
* @remarks
|
|
22441
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22442
|
+
* @beta
|
|
22443
|
+
*/
|
|
22444
|
+
environmentExceedsComputeResourceCountDaily = "EnvironmentExceedsComputeResourceCountDaily",
|
|
22445
|
+
/**
|
|
22446
|
+
* An error caused by Python not being supported in Excel on a platform. Displays as error type #BLOCKED! in Excel.
|
|
22447
|
+
*
|
|
22448
|
+
* @remarks
|
|
22449
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22450
|
+
* @beta
|
|
22451
|
+
*/
|
|
22452
|
+
pythonUnsupportedOnThisPlatform = "PythonUnsupportedOnThisPlatform",
|
|
22453
|
+
/**
|
|
22454
|
+
* An error caused by Excel not meeting the requirements to use a feature. Displays as error type #BLOCKED! in Excel.
|
|
22455
|
+
*
|
|
22456
|
+
* @remarks
|
|
22457
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22458
|
+
* @beta
|
|
22459
|
+
*/
|
|
22460
|
+
unmetRequirements = "UnmetRequirements",
|
|
22461
|
+
/**
|
|
22462
|
+
* An error caused by the PY function being disabled. Displays as error type #BLOCKED! in Excel.
|
|
22463
|
+
*
|
|
22464
|
+
* @remarks
|
|
22465
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22466
|
+
* @beta
|
|
22467
|
+
*/
|
|
22468
|
+
pythonFunction = "PythonFunction",
|
|
22469
|
+
/**
|
|
22470
|
+
* An error caused by the user exceeding their quota of concurrent connections to external code service environments. Displays as error type #BLOCKED! in Excel.
|
|
22471
|
+
*
|
|
22472
|
+
* @remarks
|
|
22473
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22474
|
+
* @beta
|
|
22475
|
+
*/
|
|
22476
|
+
environmentConnectionExceedQuota = "EnvironmentConnectionExceedQuota",
|
|
22477
|
+
/**
|
|
22478
|
+
* An error caused by an environment definition not being supported by an external code service. Displays as error type #BLOCKED! in Excel.
|
|
22479
|
+
*
|
|
22480
|
+
* @remarks
|
|
22481
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22482
|
+
* @beta
|
|
22483
|
+
*/
|
|
22484
|
+
unsupportedEnvironment = "UnsupportedEnvironment",
|
|
22485
|
+
/**
|
|
22486
|
+
* An error caused by function being unavailable in Partial or Manual calculation modes. Displays as error type #BLOCKED! in Excel.
|
|
22487
|
+
*
|
|
22488
|
+
* @remarks
|
|
22489
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22490
|
+
* @beta
|
|
22491
|
+
*/
|
|
22492
|
+
unsupportedInCalculationMode = "UnsupportedInCalculationMode"
|
|
22301
22493
|
}
|
|
22302
22494
|
/**
|
|
22303
22495
|
* Represents the value of a cell containing a #BLOCKED! error.
|
|
@@ -22342,7 +22534,7 @@ declare namespace Excel {
|
|
|
22342
22534
|
* @remarks
|
|
22343
22535
|
* [Api set: ExcelApi 1.16]
|
|
22344
22536
|
*/
|
|
22345
|
-
errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense";
|
|
22537
|
+
errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense" | "XlmDisabledInTrustCenter" | "XlmNotSupportedOnPlatform" | "ImageDownloadBlocked" | "ImageInvalidUrlNonHttps" | "ImageExceedsSizeLimit" | "ImageExceedsTotalSizeLimit" | "EnvironmentExceedsQuota" | "EnvironmentExceedsQuotaDaily" | "EnvironmentExceedsQuotaMonthly" | "EnvironmentExceedsTakerQuotaMonthly" | "WrongAccountType" | "EnvironmentExceedsComputeResourceEver" | "EnvironmentExceedsComputeResourceCountDaily" | "PythonUnsupportedOnThisPlatform" | "UnmetRequirements" | "PythonFunction" | "EnvironmentConnectionExceedQuota" | "UnsupportedEnvironment" | "UnsupportedInCalculationMode";
|
|
22346
22538
|
}
|
|
22347
22539
|
/**
|
|
22348
22540
|
* Represents the value of a cell containing a boolean.
|
|
@@ -22400,7 +22592,15 @@ declare namespace Excel {
|
|
|
22400
22592
|
* @remarks
|
|
22401
22593
|
* [Api set: ExcelApi 1.16]
|
|
22402
22594
|
*/
|
|
22403
|
-
loadingImage = "LoadingImage"
|
|
22595
|
+
loadingImage = "LoadingImage",
|
|
22596
|
+
/**
|
|
22597
|
+
* An error caused by a function being unable to process a placeholder value. Displays as error type #BUSY! in Excel.
|
|
22598
|
+
*
|
|
22599
|
+
* @remarks
|
|
22600
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22601
|
+
* @beta
|
|
22602
|
+
*/
|
|
22603
|
+
placeholderInFormula = "PlaceholderInFormula"
|
|
22404
22604
|
}
|
|
22405
22605
|
/**
|
|
22406
22606
|
* Represents the value of a cell containing a #BUSY! error.
|
|
@@ -22445,7 +22645,7 @@ declare namespace Excel {
|
|
|
22445
22645
|
* @remarks
|
|
22446
22646
|
* [Api set: ExcelApi 1.16]
|
|
22447
22647
|
*/
|
|
22448
|
-
errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage";
|
|
22648
|
+
errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage" | "PlaceholderInFormula";
|
|
22449
22649
|
}
|
|
22450
22650
|
/**
|
|
22451
22651
|
* Represents types of #CALC! errors.
|
|
@@ -22524,7 +22724,87 @@ declare namespace Excel {
|
|
|
22524
22724
|
* @remarks
|
|
22525
22725
|
* [Api set: ExcelApi 1.16]
|
|
22526
22726
|
*/
|
|
22527
|
-
textOverflow = "TextOverflow"
|
|
22727
|
+
textOverflow = "TextOverflow",
|
|
22728
|
+
/**
|
|
22729
|
+
* An error caused by a formula generating too large a request for an external code service. Displays as error type #CALC! in Excel.
|
|
22730
|
+
*
|
|
22731
|
+
* @remarks
|
|
22732
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22733
|
+
* @beta
|
|
22734
|
+
*/
|
|
22735
|
+
requestTooLarge = "RequestTooLarge",
|
|
22736
|
+
/**
|
|
22737
|
+
* An error caused by a Power Query query referencing data in a sheet. Displays as error type #CALC! in Excel.
|
|
22738
|
+
*
|
|
22739
|
+
* @remarks
|
|
22740
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22741
|
+
* @beta
|
|
22742
|
+
*/
|
|
22743
|
+
pythonGridQuery = "PythonGridQuery",
|
|
22744
|
+
/**
|
|
22745
|
+
* An error caused by a Power Query query ID change. Displays as error type #CALC! in Excel.
|
|
22746
|
+
*
|
|
22747
|
+
* @remarks
|
|
22748
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22749
|
+
* @beta
|
|
22750
|
+
*/
|
|
22751
|
+
pythonPowerQueryDataUploadEtagChanged = "PythonPowerQueryDataUploadEtagChanged",
|
|
22752
|
+
/**
|
|
22753
|
+
* An error caused by Power Query exceeding the limit for data uploaded to an external code service. Displays as error type #CALC! in Excel.
|
|
22754
|
+
*
|
|
22755
|
+
* @remarks
|
|
22756
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22757
|
+
* @beta
|
|
22758
|
+
*/
|
|
22759
|
+
pythonPowerQueryDataUploadSizeLimitExceeded = "PythonPowerQueryDataUploadSizeLimitExceeded",
|
|
22760
|
+
/**
|
|
22761
|
+
* An error caused by a formula referencing a value returned by an external code service in a different workbook. Displays as error type #CALC! in Excel.
|
|
22762
|
+
*
|
|
22763
|
+
* @remarks
|
|
22764
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22765
|
+
* @beta
|
|
22766
|
+
*/
|
|
22767
|
+
invalidPythonObject = "InvalidPythonObject",
|
|
22768
|
+
/**
|
|
22769
|
+
* An error caused by a formula returning a reference to a Power Query query. Displays as error type #CALC! in Excel.
|
|
22770
|
+
*
|
|
22771
|
+
* @remarks
|
|
22772
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22773
|
+
* @beta
|
|
22774
|
+
*/
|
|
22775
|
+
queryInCell = "QueryInCell",
|
|
22776
|
+
/**
|
|
22777
|
+
* An error caused by an uninitialized Python Object. Displays as error type #CALC! in Excel.
|
|
22778
|
+
*
|
|
22779
|
+
* @remarks
|
|
22780
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22781
|
+
* @beta
|
|
22782
|
+
*/
|
|
22783
|
+
uninitializedPythonObject = "UninitializedPythonObject",
|
|
22784
|
+
/**
|
|
22785
|
+
* An error caused by a reference to a Power Query query in a different workbook. Displays as error type #CALC! in Excel.
|
|
22786
|
+
*
|
|
22787
|
+
* @remarks
|
|
22788
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22789
|
+
* @beta
|
|
22790
|
+
*/
|
|
22791
|
+
externalQueryRef = "ExternalQueryRef",
|
|
22792
|
+
/**
|
|
22793
|
+
* An error caused by text that is longer than 65,535 characters. Displays as error type #CALC! in Excel.
|
|
22794
|
+
*
|
|
22795
|
+
* @remarks
|
|
22796
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22797
|
+
* @beta
|
|
22798
|
+
*/
|
|
22799
|
+
eRegexReplaceCharLimit = "ERegexReplaceCharLimit",
|
|
22800
|
+
/**
|
|
22801
|
+
* An error caused by an external code service returning an unexpected result. Displays as error type #CALC! in Excel.
|
|
22802
|
+
*
|
|
22803
|
+
* @remarks
|
|
22804
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
22805
|
+
* @beta
|
|
22806
|
+
*/
|
|
22807
|
+
unexpectedReturnValue = "UnexpectedReturnValue"
|
|
22528
22808
|
}
|
|
22529
22809
|
/**
|
|
22530
22810
|
* Represents the value of a cell containing a #CALC! error.
|
|
@@ -22569,7 +22849,7 @@ declare namespace Excel {
|
|
|
22569
22849
|
* @remarks
|
|
22570
22850
|
* [Api set: ExcelApi 1.16]
|
|
22571
22851
|
*/
|
|
22572
|
-
errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow";
|
|
22852
|
+
errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow" | "RequestTooLarge" | "PythonGridQuery" | "PythonPowerQueryDataUploadEtagChanged" | "PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject" | "QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" | "ERegexReplaceCharLimit" | "UnexpectedReturnValue";
|
|
22573
22853
|
/**
|
|
22574
22854
|
* Represents the name of the function causing the error.
|
|
22575
22855
|
*
|
|
@@ -27209,7 +27489,71 @@ declare namespace Excel {
|
|
|
27209
27489
|
* @remarks
|
|
27210
27490
|
* [Api set: ExcelApi 1.16]
|
|
27211
27491
|
*/
|
|
27212
|
-
genericServerError = "GenericServerError"
|
|
27492
|
+
genericServerError = "GenericServerError",
|
|
27493
|
+
/**
|
|
27494
|
+
* An error caused by an image download receiving an HTTP response code between 300 and 499. Displays as error type #CONNECT! in Excel.
|
|
27495
|
+
*
|
|
27496
|
+
* @remarks
|
|
27497
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27498
|
+
* @beta
|
|
27499
|
+
*/
|
|
27500
|
+
imageUnableToRetrieve = "ImageUnableToRetrieve",
|
|
27501
|
+
/**
|
|
27502
|
+
* An error caused by not being able to find an external code service execution environment. Displays as error type #CONNECT! in Excel.
|
|
27503
|
+
*
|
|
27504
|
+
* @remarks
|
|
27505
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27506
|
+
* @beta
|
|
27507
|
+
*/
|
|
27508
|
+
externalCodeServiceEnvironmentNotFound = "ExternalCodeServiceEnvironmentNotFound",
|
|
27509
|
+
/**
|
|
27510
|
+
* An error caused by not being able to find the runtime in an external code service's execution environment. Displays as error type #CONNECT! in Excel.
|
|
27511
|
+
*
|
|
27512
|
+
* @remarks
|
|
27513
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27514
|
+
* @beta
|
|
27515
|
+
*/
|
|
27516
|
+
externalCodeServiceRuntimeNotFound = "ExternalCodeServiceRuntimeNotFound",
|
|
27517
|
+
/**
|
|
27518
|
+
* An error caused by an external code service execution environment being in an inoperative state. Displays as error type #CONNECT! in Excel.
|
|
27519
|
+
*
|
|
27520
|
+
* @remarks
|
|
27521
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27522
|
+
* @beta
|
|
27523
|
+
*/
|
|
27524
|
+
externalCodeServiceEnvironmentBadState = "ExternalCodeServiceEnvironmentBadState",
|
|
27525
|
+
/**
|
|
27526
|
+
* An error caused by an external code service runtime being in an inoperative state. Displays as error type #CONNECT! in Excel.
|
|
27527
|
+
*
|
|
27528
|
+
* @remarks
|
|
27529
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27530
|
+
* @beta
|
|
27531
|
+
*/
|
|
27532
|
+
externalCodeServiceRuntimeBadState = "ExternalCodeServiceRuntimeBadState",
|
|
27533
|
+
/**
|
|
27534
|
+
* An error caused by an external code service compute resource not being available. Displays as error type #CONNECT! in Excel.
|
|
27535
|
+
*
|
|
27536
|
+
* @remarks
|
|
27537
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27538
|
+
* @beta
|
|
27539
|
+
*/
|
|
27540
|
+
externalCodeServiceComputeResourceNotAvailable = "ExternalCodeServiceComputeResourceNotAvailable",
|
|
27541
|
+
/**
|
|
27542
|
+
* An error caused by Power Query not having started upload of data to an external code service. Displays as error type #CONNECT! in Excel.
|
|
27543
|
+
*
|
|
27544
|
+
* @remarks
|
|
27545
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27546
|
+
* @beta
|
|
27547
|
+
*/
|
|
27548
|
+
pythonPowerQueryDataUploadHasNotStarted = "PythonPowerQueryDataUploadHasNotStarted",
|
|
27549
|
+
/**
|
|
27550
|
+
* An error caused by Excel being incorrectly configured for connection to an external code service. Displays as error type #CONNECT! in Excel.
|
|
27551
|
+
*
|
|
27552
|
+
* @remarks
|
|
27553
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27554
|
+
* @beta
|
|
27555
|
+
*/
|
|
27556
|
+
excelClientMisconfigurationError = "ExcelClientMisconfigurationError"
|
|
27213
27557
|
}
|
|
27214
27558
|
/**
|
|
27215
27559
|
* Represents the value of a cell containing a #CONNECT! error.
|
|
@@ -27254,7 +27598,7 @@ declare namespace Excel {
|
|
|
27254
27598
|
* @remarks
|
|
27255
27599
|
* [Api set: ExcelApi 1.16]
|
|
27256
27600
|
*/
|
|
27257
|
-
errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError";
|
|
27601
|
+
errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError" | "ImageUnableToRetrieve" | "ExternalCodeServiceEnvironmentNotFound" | "ExternalCodeServiceRuntimeNotFound" | "ExternalCodeServiceEnvironmentBadState" | "ExternalCodeServiceRuntimeBadState" | "ExternalCodeServiceComputeResourceNotAvailable" | "PythonPowerQueryDataUploadHasNotStarted" | "ExcelClientMisconfigurationError";
|
|
27258
27602
|
}
|
|
27259
27603
|
/**
|
|
27260
27604
|
* Represents the value of a cell containing a #DIV/0! error.
|
|
@@ -27467,7 +27811,7 @@ declare namespace Excel {
|
|
|
27467
27811
|
compact?: CompactLayout;
|
|
27468
27812
|
}
|
|
27469
27813
|
/**
|
|
27470
|
-
* Represents a card layout that is best used for an
|
|
27814
|
+
* Represents a card layout that is best used for an entity.
|
|
27471
27815
|
*
|
|
27472
27816
|
* @remarks
|
|
27473
27817
|
* [Api set: ExcelApi 1.16]
|
|
@@ -27756,6 +28100,15 @@ declare namespace Excel {
|
|
|
27756
28100
|
* @beta
|
|
27757
28101
|
*/
|
|
27758
28102
|
Python_str: string;
|
|
28103
|
+
/**
|
|
28104
|
+
* Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.
|
|
28105
|
+
* This field is not writable.
|
|
28106
|
+
*
|
|
28107
|
+
* @remarks
|
|
28108
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28109
|
+
* @beta
|
|
28110
|
+
*/
|
|
28111
|
+
provider?: CellValueProviderAttributes;
|
|
27759
28112
|
}
|
|
27760
28113
|
/**
|
|
27761
28114
|
* Represents types of #FIELD! errors.
|
|
@@ -27846,7 +28199,7 @@ declare namespace Excel {
|
|
|
27846
28199
|
fieldName?: string;
|
|
27847
28200
|
}
|
|
27848
28201
|
/**
|
|
27849
|
-
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/
|
|
28202
|
+
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
27850
28203
|
* In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.
|
|
27851
28204
|
*
|
|
27852
28205
|
* @remarks
|
|
@@ -27878,7 +28231,7 @@ declare namespace Excel {
|
|
|
27878
28231
|
* Returns the number format string that is used to display this value.
|
|
27879
28232
|
* When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale.
|
|
27880
28233
|
* Number format strings must conform to Excel guidelines.
|
|
27881
|
-
* To learn more, see {@link https://support.microsoft.com/office/
|
|
28234
|
+
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
27882
28235
|
*
|
|
27883
28236
|
* @remarks
|
|
27884
28237
|
* [Api set: ExcelApi 1.16]
|
|
@@ -28015,13 +28368,12 @@ declare namespace Excel {
|
|
|
28015
28368
|
};
|
|
28016
28369
|
};
|
|
28017
28370
|
/**
|
|
28018
|
-
* Represents
|
|
28019
|
-
* If the `CardLayout` object doesn't have a layout property, it default value is "Entity".
|
|
28371
|
+
* Represents layout information for views of this linked entity.
|
|
28020
28372
|
*
|
|
28021
28373
|
* @remarks
|
|
28022
28374
|
* [Api set: ExcelApi 1.16]
|
|
28023
28375
|
*/
|
|
28024
|
-
|
|
28376
|
+
layouts?: EntityViewLayouts;
|
|
28025
28377
|
/**
|
|
28026
28378
|
* Represents information that describes the service that provided data in this `LinkedEntityCellValue`.
|
|
28027
28379
|
* This information can be used for branding in entity cards.
|
|
@@ -28114,7 +28466,88 @@ declare namespace Excel {
|
|
|
28114
28466
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28115
28467
|
* @beta
|
|
28116
28468
|
*/
|
|
28117
|
-
|
|
28469
|
+
cachedUid: string;
|
|
28470
|
+
}
|
|
28471
|
+
/**
|
|
28472
|
+
* Represents types of #N/A! errors.
|
|
28473
|
+
*
|
|
28474
|
+
* @remarks
|
|
28475
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28476
|
+
* @beta
|
|
28477
|
+
*/
|
|
28478
|
+
enum NotAvailableErrorCellValueSubType {
|
|
28479
|
+
/**
|
|
28480
|
+
* An unknown type of error. Displays as error type #N/A! in Excel.
|
|
28481
|
+
*
|
|
28482
|
+
* @remarks
|
|
28483
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28484
|
+
* @beta
|
|
28485
|
+
*/
|
|
28486
|
+
unknown = "Unknown",
|
|
28487
|
+
/**
|
|
28488
|
+
* An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel.
|
|
28489
|
+
*
|
|
28490
|
+
* @remarks
|
|
28491
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28492
|
+
* @beta
|
|
28493
|
+
*/
|
|
28494
|
+
vlookupValueNotFound = "VlookupValueNotFound",
|
|
28495
|
+
/**
|
|
28496
|
+
* An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel.
|
|
28497
|
+
*
|
|
28498
|
+
* @remarks
|
|
28499
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28500
|
+
* @beta
|
|
28501
|
+
*/
|
|
28502
|
+
hlookupValueNotFound = "HlookupValueNotFound",
|
|
28503
|
+
/**
|
|
28504
|
+
* An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A! in Excel.
|
|
28505
|
+
*
|
|
28506
|
+
* @remarks
|
|
28507
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28508
|
+
* @beta
|
|
28509
|
+
*/
|
|
28510
|
+
stockHistoryInvalidProperty = "StockHistoryInvalidProperty",
|
|
28511
|
+
/**
|
|
28512
|
+
* An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A! in Excel.
|
|
28513
|
+
*
|
|
28514
|
+
* @remarks
|
|
28515
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28516
|
+
* @beta
|
|
28517
|
+
*/
|
|
28518
|
+
stockHistoryNoData = "StockHistoryNoData",
|
|
28519
|
+
/**
|
|
28520
|
+
* An error caused by an external code service returning an unknown object. Displays as error type #N/A! in Excel.
|
|
28521
|
+
*
|
|
28522
|
+
* @remarks
|
|
28523
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28524
|
+
* @beta
|
|
28525
|
+
*/
|
|
28526
|
+
pythonObjectUnknown = "PythonObjectUnknown",
|
|
28527
|
+
/**
|
|
28528
|
+
* No match was found for the pattern in the text provided. Displays as error type #N/A! in Excel.
|
|
28529
|
+
*
|
|
28530
|
+
* @remarks
|
|
28531
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28532
|
+
* @beta
|
|
28533
|
+
*/
|
|
28534
|
+
eRegexMatchNoResult = "ERegexMatchNoResult",
|
|
28535
|
+
/**
|
|
28536
|
+
* Occurrence is greater than the total number of matches. Displays as error type #N/A! in Excel.
|
|
28537
|
+
*
|
|
28538
|
+
* @remarks
|
|
28539
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28540
|
+
* @beta
|
|
28541
|
+
*/
|
|
28542
|
+
eRegexReplaceOccurrenceNoResult = "ERegexReplaceOccurrenceNoResult",
|
|
28543
|
+
/**
|
|
28544
|
+
* No capture groups were matched. Displays as error type #N/A! in Excel.
|
|
28545
|
+
*
|
|
28546
|
+
* @remarks
|
|
28547
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28548
|
+
* @beta
|
|
28549
|
+
*/
|
|
28550
|
+
eRegexMatchNoCapture = "ERegexMatchNoCapture"
|
|
28118
28551
|
}
|
|
28119
28552
|
/**
|
|
28120
28553
|
* Represents the value of a cell containing a #N/A! error.
|
|
@@ -28153,6 +28586,39 @@ declare namespace Excel {
|
|
|
28153
28586
|
* [Api set: ExcelApi 1.16]
|
|
28154
28587
|
*/
|
|
28155
28588
|
errorType?: ErrorCellValueType.notAvailable | "NotAvailable";
|
|
28589
|
+
/**
|
|
28590
|
+
* Represents the type of `NotAvailableErrorCellValue`.
|
|
28591
|
+
*
|
|
28592
|
+
* @remarks
|
|
28593
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28594
|
+
* @beta
|
|
28595
|
+
*/
|
|
28596
|
+
errorSubType?: NotAvailableErrorCellValueSubType | "Unknown" | "VlookupValueNotFound" | "HlookupValueNotFound" | "StockHistoryInvalidProperty" | "StockHistoryNoData" | "PythonObjectUnknown" | "ERegexMatchNoResult" | "ERegexReplaceOccurrenceNoResult" | "ERegexMatchNoCapture";
|
|
28597
|
+
}
|
|
28598
|
+
/**
|
|
28599
|
+
* Represents types of #NAME? errors.
|
|
28600
|
+
*
|
|
28601
|
+
* @remarks
|
|
28602
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28603
|
+
* @beta
|
|
28604
|
+
*/
|
|
28605
|
+
enum NameErrorCellValueSubType {
|
|
28606
|
+
/**
|
|
28607
|
+
* An unknown type of error. Displays as error type #NAME? in Excel.
|
|
28608
|
+
*
|
|
28609
|
+
* @remarks
|
|
28610
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28611
|
+
* @beta
|
|
28612
|
+
*/
|
|
28613
|
+
unknown = "Unknown",
|
|
28614
|
+
/**
|
|
28615
|
+
* An error caused by a formula containing an unsupported function. Displays as error type #NAME? in Excel.
|
|
28616
|
+
*
|
|
28617
|
+
* @remarks
|
|
28618
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28619
|
+
* @beta
|
|
28620
|
+
*/
|
|
28621
|
+
unsupportedFunction = "UnsupportedFunction"
|
|
28156
28622
|
}
|
|
28157
28623
|
/**
|
|
28158
28624
|
* Represents the value of a cell containing a #NAME? error.
|
|
@@ -28191,6 +28657,14 @@ declare namespace Excel {
|
|
|
28191
28657
|
* [Api set: ExcelApi 1.16]
|
|
28192
28658
|
*/
|
|
28193
28659
|
errorType?: ErrorCellValueType.name | "Name";
|
|
28660
|
+
/**
|
|
28661
|
+
* Represents the type of `NameErrorCellValue`.
|
|
28662
|
+
*
|
|
28663
|
+
* @remarks
|
|
28664
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28665
|
+
* @beta
|
|
28666
|
+
*/
|
|
28667
|
+
errorSubType?: NameErrorCellValueSubType | "Unknown" | "UnsupportedFunction";
|
|
28194
28668
|
}
|
|
28195
28669
|
/**
|
|
28196
28670
|
* Represents the value of a cell containing a #NULL! error.
|
|
@@ -28331,7 +28805,15 @@ declare namespace Excel {
|
|
|
28331
28805
|
* @remarks
|
|
28332
28806
|
* [Api set: ExcelApi 1.16]
|
|
28333
28807
|
*/
|
|
28334
|
-
externalLinksCalculatedRef = "ExternalLinksCalculatedRef"
|
|
28808
|
+
externalLinksCalculatedRef = "ExternalLinksCalculatedRef",
|
|
28809
|
+
/**
|
|
28810
|
+
* An error caused by a corrupt formula. Displays as error type #REF! in Excel.
|
|
28811
|
+
*
|
|
28812
|
+
* @remarks
|
|
28813
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28814
|
+
* @beta
|
|
28815
|
+
*/
|
|
28816
|
+
corruptCellRef = "CorruptCellRef"
|
|
28335
28817
|
}
|
|
28336
28818
|
/**
|
|
28337
28819
|
* Represents the value of a cell containing a #REF! error.
|
|
@@ -28376,7 +28858,7 @@ declare namespace Excel {
|
|
|
28376
28858
|
* @remarks
|
|
28377
28859
|
* [Api set: ExcelApi 1.16]
|
|
28378
28860
|
*/
|
|
28379
|
-
errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef";
|
|
28861
|
+
errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef" | "CorruptCellRef";
|
|
28380
28862
|
}
|
|
28381
28863
|
/**
|
|
28382
28864
|
* Represents types of #SPILL! errors.
|
|
@@ -28745,7 +29227,777 @@ declare namespace Excel {
|
|
|
28745
29227
|
* @remarks
|
|
28746
29228
|
* [Api set: ExcelApi 1.16]
|
|
28747
29229
|
*/
|
|
28748
|
-
lambdaWrongParamCount = "LambdaWrongParamCount"
|
|
29230
|
+
lambdaWrongParamCount = "LambdaWrongParamCount",
|
|
29231
|
+
/**
|
|
29232
|
+
* An error caused by passing too many arguments to an `IMAGE` function. Displays as error type #VALUE! in Excel.
|
|
29233
|
+
*
|
|
29234
|
+
* @remarks
|
|
29235
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29236
|
+
* @beta
|
|
29237
|
+
*/
|
|
29238
|
+
imageFormulaTooManyArgs = "ImageFormulaTooManyArgs",
|
|
29239
|
+
/**
|
|
29240
|
+
* An error caused by an unsupported image formula. Displays as error type #VALUE! in Excel.
|
|
29241
|
+
*
|
|
29242
|
+
* @remarks
|
|
29243
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29244
|
+
* @beta
|
|
29245
|
+
*/
|
|
29246
|
+
imageFormulaInvalidImageFormat = "ImageFormulaInvalidImageFormat",
|
|
29247
|
+
/**
|
|
29248
|
+
* An error caused by a non-string `source` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel.
|
|
29249
|
+
*
|
|
29250
|
+
* @remarks
|
|
29251
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29252
|
+
* @beta
|
|
29253
|
+
*/
|
|
29254
|
+
imageFormulaInvalidSource = "ImageFormulaInvalidSource",
|
|
29255
|
+
/**
|
|
29256
|
+
* An error caused by a non-string `alt_text` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel.
|
|
29257
|
+
*
|
|
29258
|
+
* @remarks
|
|
29259
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29260
|
+
* @beta
|
|
29261
|
+
*/
|
|
29262
|
+
imageFormulaInvalidAltText = "ImageFormulaInvalidAltText",
|
|
29263
|
+
/**
|
|
29264
|
+
* An error caused by invalid size parameters to `IMAGE`. Displays as error type #VALUE! in Excel.
|
|
29265
|
+
*
|
|
29266
|
+
* @remarks
|
|
29267
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29268
|
+
* @beta
|
|
29269
|
+
*/
|
|
29270
|
+
imageFormulaInvalidSizing = "ImageFormulaInvalidSizing",
|
|
29271
|
+
/**
|
|
29272
|
+
* An error caused by too few arguments passed to `IMAGE`. Displays as error type #VALUE! in Excel.
|
|
29273
|
+
*
|
|
29274
|
+
* @remarks
|
|
29275
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29276
|
+
* @beta
|
|
29277
|
+
*/
|
|
29278
|
+
imageFormulaNotEnoughArgs = "ImageFormulaNotEnoughArgs",
|
|
29279
|
+
/**
|
|
29280
|
+
* An error caused by a non-numerical or invalid `height` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel.
|
|
29281
|
+
*
|
|
29282
|
+
* @remarks
|
|
29283
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29284
|
+
* @beta
|
|
29285
|
+
*/
|
|
29286
|
+
imageFormulaInvalidHeight = "ImageFormulaInvalidHeight",
|
|
29287
|
+
/**
|
|
29288
|
+
* An error caused by a non-numerical or invalid `width` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel.
|
|
29289
|
+
*
|
|
29290
|
+
* @remarks
|
|
29291
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29292
|
+
* @beta
|
|
29293
|
+
*/
|
|
29294
|
+
imageFormulaInvalidWidth = "ImageFormulaInvalidWidth",
|
|
29295
|
+
/**
|
|
29296
|
+
* An error caused by an argument with the wrong data type passed to a custom function. Displays as error type #VALUE! in Excel.
|
|
29297
|
+
*
|
|
29298
|
+
* @remarks
|
|
29299
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29300
|
+
* @beta
|
|
29301
|
+
*/
|
|
29302
|
+
invalidCellValueTypeCoercion = "InvalidCellValueTypeCoercion",
|
|
29303
|
+
/**
|
|
29304
|
+
* An error in the regex `pattern`. An unknown compile error has occurred. Displays as error type #VALUE! in Excel.
|
|
29305
|
+
*
|
|
29306
|
+
* @remarks
|
|
29307
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29308
|
+
* @beta
|
|
29309
|
+
*/
|
|
29310
|
+
cRegexErrorGeneric = "CRegexErrorGeneric",
|
|
29311
|
+
/**
|
|
29312
|
+
* An error in the regex `pattern`. \ at end of pattern. Displays as error type #VALUE! in Excel.
|
|
29313
|
+
*
|
|
29314
|
+
* @remarks
|
|
29315
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29316
|
+
* @beta
|
|
29317
|
+
*/
|
|
29318
|
+
cRegexEndBackslash = "CRegexEndBackslash",
|
|
29319
|
+
/**
|
|
29320
|
+
* An error in the regex `pattern`. \c at end of pattern. Displays as error type #VALUE! in Excel.
|
|
29321
|
+
*
|
|
29322
|
+
* @remarks
|
|
29323
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29324
|
+
* @beta
|
|
29325
|
+
*/
|
|
29326
|
+
cRegexEndBackslashC = "CRegexEndBackslashC",
|
|
29327
|
+
/**
|
|
29328
|
+
* An error in the regex `pattern`. Unrecognized character follows \. Displays as error type #VALUE! in Excel.
|
|
29329
|
+
*
|
|
29330
|
+
* @remarks
|
|
29331
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29332
|
+
* @beta
|
|
29333
|
+
*/
|
|
29334
|
+
cRegexUnknownEscape = "CRegexUnknownEscape",
|
|
29335
|
+
/**
|
|
29336
|
+
* An error in the regex `pattern`. Number out of order in {} quantifier. Displays as error type #VALUE! in Excel.
|
|
29337
|
+
*
|
|
29338
|
+
* @remarks
|
|
29339
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29340
|
+
* @beta
|
|
29341
|
+
*/
|
|
29342
|
+
cRegexQuantifierOutOfOrder = "CRegexQuantifierOutOfOrder",
|
|
29343
|
+
/**
|
|
29344
|
+
* An error in the regex `pattern`. Number too big in quantifier {}. Displays as error type #VALUE! in Excel.
|
|
29345
|
+
*
|
|
29346
|
+
* @remarks
|
|
29347
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29348
|
+
* @beta
|
|
29349
|
+
*/
|
|
29350
|
+
cRegexQuantifierTooBig = "CRegexQuantifierTooBig",
|
|
29351
|
+
/**
|
|
29352
|
+
* An error in the regex `pattern`. Missing terminating ] for character class. Displays as error type #VALUE! in Excel.
|
|
29353
|
+
*
|
|
29354
|
+
* @remarks
|
|
29355
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29356
|
+
* @beta
|
|
29357
|
+
*/
|
|
29358
|
+
cRegexMissingSquareBracket = "CRegexMissingSquareBracket",
|
|
29359
|
+
/**
|
|
29360
|
+
* An error in the regex `pattern`. Escape sequence is invalid in character class. Displays as error type #VALUE! in Excel.
|
|
29361
|
+
*
|
|
29362
|
+
* @remarks
|
|
29363
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29364
|
+
* @beta
|
|
29365
|
+
*/
|
|
29366
|
+
cRegexEscapeInvalidInClass = "CRegexEscapeInvalidInClass",
|
|
29367
|
+
/**
|
|
29368
|
+
* An error in the regex `pattern`. Quantifier does not follow a repeatable item. Displays as error type #VALUE! in Excel.
|
|
29369
|
+
*
|
|
29370
|
+
* @remarks
|
|
29371
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29372
|
+
* @beta
|
|
29373
|
+
*/
|
|
29374
|
+
cRegexQuantifierInvalid = "CRegexQuantifierInvalid",
|
|
29375
|
+
/**
|
|
29376
|
+
* An error in the regex `pattern`. Unrecognized character after (? or (?-. Displays as error type #VALUE! in Excel.
|
|
29377
|
+
*
|
|
29378
|
+
* @remarks
|
|
29379
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29380
|
+
* @beta
|
|
29381
|
+
*/
|
|
29382
|
+
cRegexInvalidAfterParensQuery = "CRegexInvalidAfterParensQuery",
|
|
29383
|
+
/**
|
|
29384
|
+
* An error in the regex `pattern`. POSIX named classes are supported only within a class. Displays as error type #VALUE! in Excel.
|
|
29385
|
+
*
|
|
29386
|
+
* @remarks
|
|
29387
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29388
|
+
* @beta
|
|
29389
|
+
*/
|
|
29390
|
+
cRegexPosixClassNotInClass = "CRegexPosixClassNotInClass",
|
|
29391
|
+
/**
|
|
29392
|
+
* An error in the regex `pattern`. POSIX collating elements are not supported. Displays as error type #VALUE! in Excel.
|
|
29393
|
+
*
|
|
29394
|
+
* @remarks
|
|
29395
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29396
|
+
* @beta
|
|
29397
|
+
*/
|
|
29398
|
+
cRegexPosixNoSupportCollating = "CRegexPosixNoSupportCollating",
|
|
29399
|
+
/**
|
|
29400
|
+
* An error in the regex `pattern`. Missing closing parenthesis. Displays as error type #VALUE! in Excel.
|
|
29401
|
+
*
|
|
29402
|
+
* @remarks
|
|
29403
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29404
|
+
* @beta
|
|
29405
|
+
*/
|
|
29406
|
+
cRegexMissingClosingParenthesis = "CRegexMissingClosingParenthesis",
|
|
29407
|
+
/**
|
|
29408
|
+
* An error in the regex `pattern`. Reference to nonexistent subpattern. Displays as error type #VALUE! in Excel.
|
|
29409
|
+
*
|
|
29410
|
+
* @remarks
|
|
29411
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29412
|
+
* @beta
|
|
29413
|
+
*/
|
|
29414
|
+
cRegexBadSubpatternReference = "CRegexBadSubpatternReference",
|
|
29415
|
+
/**
|
|
29416
|
+
* An error in the regex `pattern`. Missing ) after (?# comment. Displays as error type #VALUE! in Excel.
|
|
29417
|
+
*
|
|
29418
|
+
* @remarks
|
|
29419
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29420
|
+
* @beta
|
|
29421
|
+
*/
|
|
29422
|
+
cRegexMissingCommentClosing = "CRegexMissingCommentClosing",
|
|
29423
|
+
/**
|
|
29424
|
+
* An error in the regex `pattern`. Parentheses are too deeply nested. Displays as error type #VALUE! in Excel.
|
|
29425
|
+
*
|
|
29426
|
+
* @remarks
|
|
29427
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29428
|
+
* @beta
|
|
29429
|
+
*/
|
|
29430
|
+
cRegexParenthesesNestTooDeep = "CRegexParenthesesNestTooDeep",
|
|
29431
|
+
/**
|
|
29432
|
+
* An error in the regex `pattern`. Regular expression is too large. Displays as error type #VALUE! in Excel.
|
|
29433
|
+
*
|
|
29434
|
+
* @remarks
|
|
29435
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29436
|
+
* @beta
|
|
29437
|
+
*/
|
|
29438
|
+
cRegexPatternTooLarge = "CRegexPatternTooLarge",
|
|
29439
|
+
/**
|
|
29440
|
+
* An error in the regex `pattern`. Unmatched closing parenthesis. Displays as error type #VALUE! in Excel.
|
|
29441
|
+
*
|
|
29442
|
+
* @remarks
|
|
29443
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29444
|
+
* @beta
|
|
29445
|
+
*/
|
|
29446
|
+
cRegexUnmatchedClosingParenthesis = "CRegexUnmatchedClosingParenthesis",
|
|
29447
|
+
/**
|
|
29448
|
+
* An error in the regex `pattern`. Missing closing parenthesis for condition. Displays as error type #VALUE! in Excel.
|
|
29449
|
+
*
|
|
29450
|
+
* @remarks
|
|
29451
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29452
|
+
* @beta
|
|
29453
|
+
*/
|
|
29454
|
+
cRegexMissingConditionClosing = "CRegexMissingConditionClosing",
|
|
29455
|
+
/**
|
|
29456
|
+
* An error in the regex `pattern`. Length of `lookbehind` assertion is not limited. Displays as error type #VALUE! in Excel.
|
|
29457
|
+
*
|
|
29458
|
+
* @remarks
|
|
29459
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29460
|
+
* @beta
|
|
29461
|
+
*/
|
|
29462
|
+
cRegexLookbehindNotFixedLength = "CRegexLookbehindNotFixedLength",
|
|
29463
|
+
/**
|
|
29464
|
+
* An error in the regex `pattern`. A relative value of zero is not allowed. Displays as error type #VALUE! in Excel.
|
|
29465
|
+
*
|
|
29466
|
+
* @remarks
|
|
29467
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29468
|
+
* @beta
|
|
29469
|
+
*/
|
|
29470
|
+
cRegexZeroRelativeReference = "CRegexZeroRelativeReference",
|
|
29471
|
+
/**
|
|
29472
|
+
* An error in the regex `pattern`. Conditional subpattern contains more than two branches. Displays as error type #VALUE! in Excel.
|
|
29473
|
+
*
|
|
29474
|
+
* @remarks
|
|
29475
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29476
|
+
* @beta
|
|
29477
|
+
*/
|
|
29478
|
+
cRegexTooManyConditionBranches = "CRegexTooManyConditionBranches",
|
|
29479
|
+
/**
|
|
29480
|
+
* An error in the regex `pattern`. Digit expected after (?+ or (?-. Displays as error type #VALUE! in Excel.
|
|
29481
|
+
*
|
|
29482
|
+
* @remarks
|
|
29483
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29484
|
+
* @beta
|
|
29485
|
+
*/
|
|
29486
|
+
cRegexBadRelativeReference = "CRegexBadRelativeReference",
|
|
29487
|
+
/**
|
|
29488
|
+
* An error in the regex `pattern`. Unknown POSIX class name. Displays as error type #VALUE! in Excel.
|
|
29489
|
+
*
|
|
29490
|
+
* @remarks
|
|
29491
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29492
|
+
* @beta
|
|
29493
|
+
*/
|
|
29494
|
+
cRegexUnknownPosixClass = "CRegexUnknownPosixClass",
|
|
29495
|
+
/**
|
|
29496
|
+
* An error in the regex `pattern`. Character code point value in \x{} or \o{} is too large. Displays as error type #VALUE! in Excel.
|
|
29497
|
+
*
|
|
29498
|
+
* @remarks
|
|
29499
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29500
|
+
* @beta
|
|
29501
|
+
*/
|
|
29502
|
+
cRegexCodePointTooBig = "CRegexCodePointTooBig",
|
|
29503
|
+
/**
|
|
29504
|
+
* An error in the regex `pattern`. `lookbehind` is too complicated. Displays as error type #VALUE! in Excel.
|
|
29505
|
+
*
|
|
29506
|
+
* @remarks
|
|
29507
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29508
|
+
* @beta
|
|
29509
|
+
*/
|
|
29510
|
+
cRegexLookbehindTooComplicated = "CRegexLookbehindTooComplicated",
|
|
29511
|
+
/**
|
|
29512
|
+
* An error in the regex `pattern`. PCRE2 does not support \F, \L, \l, \N{name}, \U, or \u. Displays as error type #VALUE! in Excel.
|
|
29513
|
+
*
|
|
29514
|
+
* @remarks
|
|
29515
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29516
|
+
* @beta
|
|
29517
|
+
*/
|
|
29518
|
+
cRegexUnsupportedEscapeSequence = "CRegexUnsupportedEscapeSequence",
|
|
29519
|
+
/**
|
|
29520
|
+
* An error in the regex `pattern`. Number after (?C is greater than 255. Displays as error type #VALUE! in Excel.
|
|
29521
|
+
*
|
|
29522
|
+
* @remarks
|
|
29523
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29524
|
+
* @beta
|
|
29525
|
+
*/
|
|
29526
|
+
cRegexCalloutNumberTooBig = "CRegexCalloutNumberTooBig",
|
|
29527
|
+
/**
|
|
29528
|
+
* An error in the regex `pattern`. Closing parenthesis for (?C expected. Displays as error type #VALUE! in Excel.
|
|
29529
|
+
*
|
|
29530
|
+
* @remarks
|
|
29531
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29532
|
+
* @beta
|
|
29533
|
+
*/
|
|
29534
|
+
cRegexMissingCalloutClosing = "CRegexMissingCalloutClosing",
|
|
29535
|
+
/**
|
|
29536
|
+
* An error in the regex `pattern`. Invalid escape sequence in (*VERB) name. Displays as error type #VALUE! in Excel.
|
|
29537
|
+
*
|
|
29538
|
+
* @remarks
|
|
29539
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29540
|
+
* @beta
|
|
29541
|
+
*/
|
|
29542
|
+
cRegexEscapeInvalidInVerb = "CRegexEscapeInvalidInVerb",
|
|
29543
|
+
/**
|
|
29544
|
+
* An error in the regex `pattern`. Unrecongnized character after (?P. Displays as error type #VALUE! in Excel.
|
|
29545
|
+
*
|
|
29546
|
+
* @remarks
|
|
29547
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29548
|
+
* @beta
|
|
29549
|
+
*/
|
|
29550
|
+
cRegexUnrecognizedAfterQueryP = "CRegexUnrecognizedAfterQueryP",
|
|
29551
|
+
/**
|
|
29552
|
+
* An error in the regex `pattern`. Syntax error in subpattern name (missing terminator?). Displays as error type #VALUE! in Excel.
|
|
29553
|
+
*
|
|
29554
|
+
* @remarks
|
|
29555
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29556
|
+
* @beta
|
|
29557
|
+
*/
|
|
29558
|
+
cRegexMissingNameTerminator = "CRegexMissingNameTerminator",
|
|
29559
|
+
/**
|
|
29560
|
+
* An error in the regex `pattern`. Two named subpatterns have the same name. Displays as error type #VALUE! in Excel.
|
|
29561
|
+
*
|
|
29562
|
+
* @remarks
|
|
29563
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29564
|
+
* @beta
|
|
29565
|
+
*/
|
|
29566
|
+
cRegexDuplicateSubpatternName = "CRegexDuplicateSubpatternName",
|
|
29567
|
+
/**
|
|
29568
|
+
* An error in the regex `pattern`. Subpattern name must start with a non-digit. Displays as error type #VALUE! in Excel.
|
|
29569
|
+
*
|
|
29570
|
+
* @remarks
|
|
29571
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29572
|
+
* @beta
|
|
29573
|
+
*/
|
|
29574
|
+
cRegexInvalidSubpatternName = "CRegexInvalidSubpatternName",
|
|
29575
|
+
/**
|
|
29576
|
+
* An error in the regex `pattern`. This version of PCRE2 does not have support for \P, \p, or \X. Displays as error type #VALUE! in Excel.
|
|
29577
|
+
*
|
|
29578
|
+
* @remarks
|
|
29579
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29580
|
+
* @beta
|
|
29581
|
+
*/
|
|
29582
|
+
cRegexUnicodePropertiesUnavailable = "CRegexUnicodePropertiesUnavailable",
|
|
29583
|
+
/**
|
|
29584
|
+
* An error in the regex `pattern`. Malformed \P or \p sequence. Displays as error type #VALUE! in Excel.
|
|
29585
|
+
*
|
|
29586
|
+
* @remarks
|
|
29587
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29588
|
+
* @beta
|
|
29589
|
+
*/
|
|
29590
|
+
cRegexMalformedUnicodeProperty = "CRegexMalformedUnicodeProperty",
|
|
29591
|
+
/**
|
|
29592
|
+
* An error in the regex `pattern`. Unknown property after \P or \p. Displays as error type #VALUE! in Excel.
|
|
29593
|
+
*
|
|
29594
|
+
* @remarks
|
|
29595
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29596
|
+
* @beta
|
|
29597
|
+
*/
|
|
29598
|
+
cRegexUnknownUnicodeProperty = "CRegexUnknownUnicodeProperty",
|
|
29599
|
+
/**
|
|
29600
|
+
* An error in the regex `pattern`. Subpattern name is too long. Displays as error type #VALUE! in Excel.
|
|
29601
|
+
*
|
|
29602
|
+
* @remarks
|
|
29603
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29604
|
+
* @beta
|
|
29605
|
+
*/
|
|
29606
|
+
cRegexSubpatternNameTooLong = "CRegexSubpatternNameTooLong",
|
|
29607
|
+
/**
|
|
29608
|
+
* An error in the regex `pattern`. Too many named subpatterns. Displays as error type #VALUE! in Excel.
|
|
29609
|
+
*
|
|
29610
|
+
* @remarks
|
|
29611
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29612
|
+
* @beta
|
|
29613
|
+
*/
|
|
29614
|
+
cRegexTooManyNamedSubpatterns = "CRegexTooManyNamedSubpatterns",
|
|
29615
|
+
/**
|
|
29616
|
+
* An error in the regex `pattern`. Invalid range in character class. Displays as error type #VALUE! in Excel.
|
|
29617
|
+
*
|
|
29618
|
+
* @remarks
|
|
29619
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29620
|
+
* @beta
|
|
29621
|
+
*/
|
|
29622
|
+
cRegexClassInvalidRange = "CRegexClassInvalidRange",
|
|
29623
|
+
/**
|
|
29624
|
+
* An error in the regex `pattern`. `DEFINE` subpattern contains more than one branch. Displays as error type #VALUE! in Excel.
|
|
29625
|
+
*
|
|
29626
|
+
* @remarks
|
|
29627
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29628
|
+
* @beta
|
|
29629
|
+
*/
|
|
29630
|
+
cRegexDefineTooManyBranches = "CRegexDefineTooManyBranches",
|
|
29631
|
+
/**
|
|
29632
|
+
* An error in the regex `pattern`. Missing opening brace after \o. Displays as error type #VALUE! in Excel.
|
|
29633
|
+
*
|
|
29634
|
+
* @remarks
|
|
29635
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29636
|
+
* @beta
|
|
29637
|
+
*/
|
|
29638
|
+
cRegexBackslashOMissingBrace = "CRegexBackslashOMissingBrace",
|
|
29639
|
+
/**
|
|
29640
|
+
* An error in the regex `pattern`. \g is not followed by a braced, angle-bracketed, or quoted name or number, or by a plain number. Displays as error type #VALUE! in Excel.
|
|
29641
|
+
*
|
|
29642
|
+
* @remarks
|
|
29643
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29644
|
+
* @beta
|
|
29645
|
+
*/
|
|
29646
|
+
cRegexBackslashGSyntax = "CRegexBackslashGSyntax",
|
|
29647
|
+
/**
|
|
29648
|
+
* An error in the regex `pattern`. The recursive pattern call (?R must be followed by a closing parenthesis. Displays as error type #VALUE! in Excel.
|
|
29649
|
+
*
|
|
29650
|
+
* @remarks
|
|
29651
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29652
|
+
* @beta
|
|
29653
|
+
*/
|
|
29654
|
+
cRegexParensQueryRMissingClosing = "CRegexParensQueryRMissingClosing",
|
|
29655
|
+
/**
|
|
29656
|
+
* An error in the regex `pattern`. The (*VERB) is not recognized or is malformed. Displays as error type #VALUE! in Excel.
|
|
29657
|
+
*
|
|
29658
|
+
* @remarks
|
|
29659
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29660
|
+
* @beta
|
|
29661
|
+
*/
|
|
29662
|
+
cRegexVerbUnknown = "CRegexVerbUnknown",
|
|
29663
|
+
/**
|
|
29664
|
+
* An error in the regex `pattern`. The subpattern number exceeds the limit of 65,535. Displays as error type #VALUE! in Excel.
|
|
29665
|
+
*
|
|
29666
|
+
* @remarks
|
|
29667
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29668
|
+
* @beta
|
|
29669
|
+
*/
|
|
29670
|
+
cRegexSubpatternNumberTooBig = "CRegexSubpatternNumberTooBig",
|
|
29671
|
+
/**
|
|
29672
|
+
* An error in the regex `pattern`. Subpattern name expected. Displays as error type #VALUE! in Excel.
|
|
29673
|
+
*
|
|
29674
|
+
* @remarks
|
|
29675
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29676
|
+
* @beta
|
|
29677
|
+
*/
|
|
29678
|
+
cRegexSubpatternNameExpected = "CRegexSubpatternNameExpected",
|
|
29679
|
+
/**
|
|
29680
|
+
* An error in the regex `pattern`. A non-octal character in \o{} is present. The most common reason for this error is a missing closing brace. Displays as error type #VALUE! in Excel.
|
|
29681
|
+
*
|
|
29682
|
+
* @remarks
|
|
29683
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29684
|
+
* @beta
|
|
29685
|
+
*/
|
|
29686
|
+
cRegexInvalidOctal = "CRegexInvalidOctal",
|
|
29687
|
+
/**
|
|
29688
|
+
* An error in the regex `pattern`. Different names for subpatterns of the same number are not allowed. Displays as error type #VALUE! in Excel.
|
|
29689
|
+
*
|
|
29690
|
+
* @remarks
|
|
29691
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29692
|
+
* @beta
|
|
29693
|
+
*/
|
|
29694
|
+
cRegexSubpatternNamesMismatch = "CRegexSubpatternNamesMismatch",
|
|
29695
|
+
/**
|
|
29696
|
+
* An error in the regex `pattern`. The (*MARK) must have an argument. Displays as error type #VALUE! in Excel.
|
|
29697
|
+
*
|
|
29698
|
+
* @remarks
|
|
29699
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29700
|
+
* @beta
|
|
29701
|
+
*/
|
|
29702
|
+
cRegexMarkMissingArgument = "CRegexMarkMissingArgument",
|
|
29703
|
+
/**
|
|
29704
|
+
* An error in the regex `pattern`. A non-hexadecimal character in \x{} is present. The most common reason for this error is a missing closing brace. Displays as error type #VALUE! in Excel.
|
|
29705
|
+
*
|
|
29706
|
+
* @remarks
|
|
29707
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29708
|
+
* @beta
|
|
29709
|
+
*/
|
|
29710
|
+
cRegexInvalidHexadecimal = "CRegexInvalidHexadecimal",
|
|
29711
|
+
/**
|
|
29712
|
+
* An error in the regex `pattern`. \c must be followed by a printable American Standard Code for Information Interchange (ASCII) character. Displays as error type #VALUE! in Excel.
|
|
29713
|
+
*
|
|
29714
|
+
* @remarks
|
|
29715
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29716
|
+
* @beta
|
|
29717
|
+
*/
|
|
29718
|
+
cRegexBackslashCSyntax = "CRegexBackslashCSyntax",
|
|
29719
|
+
/**
|
|
29720
|
+
* An error in the regex `pattern`. \N is not supported in class. Displays as error type #VALUE! in Excel.
|
|
29721
|
+
*
|
|
29722
|
+
* @remarks
|
|
29723
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29724
|
+
* @beta
|
|
29725
|
+
*/
|
|
29726
|
+
cRegexBackslashNInClass = "CRegexBackslashNInClass",
|
|
29727
|
+
/**
|
|
29728
|
+
* An error in the regex `pattern`. The callout string is too long. Displays as error type #VALUE! in Excel.
|
|
29729
|
+
*
|
|
29730
|
+
* @remarks
|
|
29731
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29732
|
+
* @beta
|
|
29733
|
+
*/
|
|
29734
|
+
cRegexCalloutStringTooLong = "CRegexCalloutStringTooLong",
|
|
29735
|
+
/**
|
|
29736
|
+
* An error in the regex `pattern`. Disallowed Unicode point (>= 0xD800 && <= 0xDFFF). Displays as error type #VALUE! in Excel.
|
|
29737
|
+
*
|
|
29738
|
+
* @remarks
|
|
29739
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29740
|
+
* @beta
|
|
29741
|
+
*/
|
|
29742
|
+
cRegexUnicodeDisallowedCodePoint = "CRegexUnicodeDisallowedCodePoint",
|
|
29743
|
+
/**
|
|
29744
|
+
* An error in the regex `pattern`. A name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN). Displays as error type #VALUE! in Excel.
|
|
29745
|
+
*
|
|
29746
|
+
* @remarks
|
|
29747
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29748
|
+
* @beta
|
|
29749
|
+
*/
|
|
29750
|
+
cRegexVerbNameTooLong = "CRegexVerbNameTooLong",
|
|
29751
|
+
/**
|
|
29752
|
+
* An error in the regex `pattern`. A character code point value in the \u... sequence is too large. Displays as error type #VALUE! in Excel.
|
|
29753
|
+
*
|
|
29754
|
+
* @remarks
|
|
29755
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29756
|
+
* @beta
|
|
29757
|
+
*/
|
|
29758
|
+
cRegexBackslashUCodePointTooBig = "CRegexBackslashUCodePointTooBig",
|
|
29759
|
+
/**
|
|
29760
|
+
* An error in the regex `pattern`. Digits are missing in \x{}, \o{}, or \N{U+}. Displays as error type #VALUE! in Excel.
|
|
29761
|
+
*
|
|
29762
|
+
* @remarks
|
|
29763
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29764
|
+
* @beta
|
|
29765
|
+
*/
|
|
29766
|
+
cRegexMissingOctalOrHexDigits = "CRegexMissingOctalOrHexDigits",
|
|
29767
|
+
/**
|
|
29768
|
+
* An error in the regex `pattern`. There is a syntax error, or a number is too big in the (?(VERSION condition. Displays as error type #VALUE! in Excel.
|
|
29769
|
+
*
|
|
29770
|
+
* @remarks
|
|
29771
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29772
|
+
* @beta
|
|
29773
|
+
*/
|
|
29774
|
+
cRegexVersionConditionSyntax = "CRegexVersionConditionSyntax",
|
|
29775
|
+
/**
|
|
29776
|
+
* An error in the regex `pattern`. Missing terminating delimiter for callout with string argument. Displays as error type #VALUE! in Excel.
|
|
29777
|
+
*
|
|
29778
|
+
* @remarks
|
|
29779
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29780
|
+
* @beta
|
|
29781
|
+
*/
|
|
29782
|
+
cRegexCalloutNoStringDelimiter = "CRegexCalloutNoStringDelimiter",
|
|
29783
|
+
/**
|
|
29784
|
+
* An error in the regex `pattern`. Unrecognized string delimiter follows (?C. Displays as error type #VALUE! in Excel.
|
|
29785
|
+
*
|
|
29786
|
+
* @remarks
|
|
29787
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29788
|
+
* @beta
|
|
29789
|
+
*/
|
|
29790
|
+
cRegexCalloutBadStringDelimiter = "CRegexCalloutBadStringDelimiter",
|
|
29791
|
+
/**
|
|
29792
|
+
* An error in the regex `pattern`. The (?|, (?J:, or (?x: parentheses are too deeply nested. Displays as error type #VALUE! in Excel.
|
|
29793
|
+
*
|
|
29794
|
+
* @remarks
|
|
29795
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29796
|
+
* @beta
|
|
29797
|
+
*/
|
|
29798
|
+
cRegexQueryBarjxNestTooDeep = "CRegexQueryBarjxNestTooDeep",
|
|
29799
|
+
/**
|
|
29800
|
+
* An error in the regex `pattern`. Regular expression is too complicated. Displays as error type #VALUE! in Excel.
|
|
29801
|
+
*
|
|
29802
|
+
* @remarks
|
|
29803
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29804
|
+
* @beta
|
|
29805
|
+
*/
|
|
29806
|
+
cRegexPatternTooComplicated = "CRegexPatternTooComplicated",
|
|
29807
|
+
/**
|
|
29808
|
+
* An error in the regex `pattern`. `lookbehind` assertion is too long. Displays as error type #VALUE! in Excel.
|
|
29809
|
+
*
|
|
29810
|
+
* @remarks
|
|
29811
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29812
|
+
* @beta
|
|
29813
|
+
*/
|
|
29814
|
+
cRegexLookbehindTooLong = "CRegexLookbehindTooLong",
|
|
29815
|
+
/**
|
|
29816
|
+
* An error in the regex `pattern`. Pattern string is longer than the limit set by the application. Displays as error type #VALUE! in Excel.
|
|
29817
|
+
*
|
|
29818
|
+
* @remarks
|
|
29819
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29820
|
+
* @beta
|
|
29821
|
+
*/
|
|
29822
|
+
cRegexPatternStringTooLong = "CRegexPatternStringTooLong",
|
|
29823
|
+
/**
|
|
29824
|
+
* An error in the regex `pattern`. Invalid hyphen in option setting. Displays as error type #VALUE! in Excel.
|
|
29825
|
+
*
|
|
29826
|
+
* @remarks
|
|
29827
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29828
|
+
* @beta
|
|
29829
|
+
*/
|
|
29830
|
+
cRegexInvalidHyphenInOptions = "CRegexInvalidHyphenInOptions",
|
|
29831
|
+
/**
|
|
29832
|
+
* An error in the regex `pattern`. The (*alpha_assertion) isn't recognized. Displays as error type #VALUE! in Excel.
|
|
29833
|
+
*
|
|
29834
|
+
* @remarks
|
|
29835
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29836
|
+
* @beta
|
|
29837
|
+
*/
|
|
29838
|
+
cRegexAlphaAssertionUnknown = "CRegexAlphaAssertionUnknown",
|
|
29839
|
+
/**
|
|
29840
|
+
* An error in the regex `pattern`. Too many capturing groups (maximum 65535). Displays as error type #VALUE! in Excel.
|
|
29841
|
+
*
|
|
29842
|
+
* @remarks
|
|
29843
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29844
|
+
* @beta
|
|
29845
|
+
*/
|
|
29846
|
+
cRegexTooManyCaptures = "CRegexTooManyCaptures",
|
|
29847
|
+
/**
|
|
29848
|
+
* An error in the regex `pattern`. Atomic assertion expected after (?( or (?(?C). Displays as error type #VALUE! in Excel.
|
|
29849
|
+
*
|
|
29850
|
+
* @remarks
|
|
29851
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29852
|
+
* @beta
|
|
29853
|
+
*/
|
|
29854
|
+
cRegexConditionAtomicAssertionExpected = "CRegexConditionAtomicAssertionExpected",
|
|
29855
|
+
/**
|
|
29856
|
+
* An error in the regex `pattern`. \K is not allowed in `lookarounds=`. Displays as error type #VALUE! in Excel.
|
|
29857
|
+
*
|
|
29858
|
+
* @remarks
|
|
29859
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29860
|
+
* @beta
|
|
29861
|
+
*/
|
|
29862
|
+
cRegexBackslashKInLookaround = "CRegexBackslashKInLookaround",
|
|
29863
|
+
/**
|
|
29864
|
+
* An error in regex match. An unknown match error has occurred. Displays as error type #VALUE! in Excel.
|
|
29865
|
+
*
|
|
29866
|
+
* @remarks
|
|
29867
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29868
|
+
* @beta
|
|
29869
|
+
*/
|
|
29870
|
+
mRegexErrorGeneric = "MRegexErrorGeneric",
|
|
29871
|
+
/**
|
|
29872
|
+
* An error in regex match. Invalid replacement string. Displays as error type #VALUE! in Excel.
|
|
29873
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29874
|
+
*
|
|
29875
|
+
* @remarks
|
|
29876
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29877
|
+
* @beta
|
|
29878
|
+
*/
|
|
29879
|
+
mRegexBadreplacement = "MRegexBadreplacement",
|
|
29880
|
+
/**
|
|
29881
|
+
* An error in regex match. Match limit exceeded. Displays as error type #VALUE! in Excel.
|
|
29882
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29883
|
+
*
|
|
29884
|
+
* @remarks
|
|
29885
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29886
|
+
* @beta
|
|
29887
|
+
*/
|
|
29888
|
+
mRegexMatchlimit = "MRegexMatchlimit",
|
|
29889
|
+
/**
|
|
29890
|
+
* An error in regex match. Unknown substring. Displays as error type #VALUE! in Excel.
|
|
29891
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29892
|
+
*
|
|
29893
|
+
* @remarks
|
|
29894
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29895
|
+
* @beta
|
|
29896
|
+
*/
|
|
29897
|
+
mRegexNosubstring = "MRegexNosubstring",
|
|
29898
|
+
/**
|
|
29899
|
+
* An error in regex match. Nonunique substring name. Displays as error type #VALUE! in Excel.
|
|
29900
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29901
|
+
*
|
|
29902
|
+
* @remarks
|
|
29903
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29904
|
+
* @beta
|
|
29905
|
+
*/
|
|
29906
|
+
mRegexNouniquesubstring = "MRegexNouniquesubstring",
|
|
29907
|
+
/**
|
|
29908
|
+
* An error in regex match. Matching depth limit exceeded. Displays as error type #VALUE! in Excel.
|
|
29909
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29910
|
+
*
|
|
29911
|
+
* @remarks
|
|
29912
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29913
|
+
* @beta
|
|
29914
|
+
*/
|
|
29915
|
+
mRegexDepthlimit = "MRegexDepthlimit",
|
|
29916
|
+
/**
|
|
29917
|
+
* An error in regex match. There's an incorrect escape sequence in the replacement string. Displays as error type #VALUE! in Excel.
|
|
29918
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29919
|
+
*
|
|
29920
|
+
* @remarks
|
|
29921
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29922
|
+
* @beta
|
|
29923
|
+
*/
|
|
29924
|
+
mRegexBadrepescape = "MRegexBadrepescape",
|
|
29925
|
+
/**
|
|
29926
|
+
* An error in regex match. Expected closing curly bracket in replacement string. Displays as error type #VALUE! in Excel.
|
|
29927
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29928
|
+
*
|
|
29929
|
+
* @remarks
|
|
29930
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29931
|
+
* @beta
|
|
29932
|
+
*/
|
|
29933
|
+
mRegexRepmissingbrace = "MRegexRepmissingbrace",
|
|
29934
|
+
/**
|
|
29935
|
+
* An error in regex match. There's an incorrect substitution in the replacement string. Displays as error type #VALUE! in Excel.
|
|
29936
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29937
|
+
*
|
|
29938
|
+
* @remarks
|
|
29939
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29940
|
+
* @beta
|
|
29941
|
+
*/
|
|
29942
|
+
mRegexBadsubstitution = "MRegexBadsubstitution",
|
|
29943
|
+
/**
|
|
29944
|
+
* An error in regex match. Match with end before start or start moved backwards is not supported. Displays as error type #VALUE! in Excel.
|
|
29945
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29946
|
+
*
|
|
29947
|
+
* @remarks
|
|
29948
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29949
|
+
* @beta
|
|
29950
|
+
*/
|
|
29951
|
+
mRegexBadsubspattern = "MRegexBadsubspattern",
|
|
29952
|
+
/**
|
|
29953
|
+
* An error in regex match. Recursive loop. Displays as error type #VALUE! in Excel.
|
|
29954
|
+
* Note: The name of this API is likely to change in the near future.
|
|
29955
|
+
*
|
|
29956
|
+
* @remarks
|
|
29957
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29958
|
+
* @beta
|
|
29959
|
+
*/
|
|
29960
|
+
mRegexRecurseLoop = "MRegexRecurseLoop",
|
|
29961
|
+
/**
|
|
29962
|
+
* An unknown regex error occurred. Displays as error type #VALUE! in Excel.
|
|
29963
|
+
*
|
|
29964
|
+
* @remarks
|
|
29965
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29966
|
+
* @beta
|
|
29967
|
+
*/
|
|
29968
|
+
eRegexErrorGeneric = "ERegexErrorGeneric",
|
|
29969
|
+
/**
|
|
29970
|
+
* No capture groups were found in the regex pattern. Displays as error type #VALUE! in Excel.
|
|
29971
|
+
*
|
|
29972
|
+
* @remarks
|
|
29973
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29974
|
+
* @beta
|
|
29975
|
+
*/
|
|
29976
|
+
eRegexNoCaptureGroups = "ERegexNoCaptureGroups",
|
|
29977
|
+
/**
|
|
29978
|
+
* An error caused by the `text` parameter to `TRANSLATE` being too long. Displays as error type #VALUE! in Excel.
|
|
29979
|
+
*
|
|
29980
|
+
* @remarks
|
|
29981
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29982
|
+
* @beta
|
|
29983
|
+
*/
|
|
29984
|
+
translateStringTooLong = "TranslateStringTooLong",
|
|
29985
|
+
/**
|
|
29986
|
+
* An error caused because the `source_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel.
|
|
29987
|
+
*
|
|
29988
|
+
* @remarks
|
|
29989
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29990
|
+
* @beta
|
|
29991
|
+
*/
|
|
29992
|
+
translateUnsupportedSrcLanguage = "TranslateUnsupportedSrcLanguage",
|
|
29993
|
+
/**
|
|
29994
|
+
* An error caused because the `target_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel.
|
|
29995
|
+
*
|
|
29996
|
+
* @remarks
|
|
29997
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29998
|
+
* @beta
|
|
29999
|
+
*/
|
|
30000
|
+
translateUnsupportedTargetLanguage = "TranslateUnsupportedTargetLanguage"
|
|
28749
30001
|
}
|
|
28750
30002
|
/**
|
|
28751
30003
|
* Represents the value of a cell containing a #VALUE! error.
|
|
@@ -28790,7 +30042,7 @@ declare namespace Excel {
|
|
|
28790
30042
|
* @remarks
|
|
28791
30043
|
* [Api set: ExcelApi 1.16]
|
|
28792
30044
|
*/
|
|
28793
|
-
errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
|
|
30045
|
+
errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount" | "ImageFormulaTooManyArgs" | "ImageFormulaInvalidImageFormat" | "ImageFormulaInvalidSource" | "ImageFormulaInvalidAltText" | "ImageFormulaInvalidSizing" | "ImageFormulaNotEnoughArgs" | "ImageFormulaInvalidHeight" | "ImageFormulaInvalidWidth" | "InvalidCellValueTypeCoercion" | "CRegexErrorGeneric" | "CRegexEndBackslash" | "CRegexEndBackslashC" | "CRegexUnknownEscape" | "CRegexQuantifierOutOfOrder" | "CRegexQuantifierTooBig" | "CRegexMissingSquareBracket" | "CRegexEscapeInvalidInClass" | "CRegexQuantifierInvalid" | "CRegexInvalidAfterParensQuery" | "CRegexPosixClassNotInClass" | "CRegexPosixNoSupportCollating" | "CRegexMissingClosingParenthesis" | "CRegexBadSubpatternReference" | "CRegexMissingCommentClosing" | "CRegexParenthesesNestTooDeep" | "CRegexPatternTooLarge" | "CRegexUnmatchedClosingParenthesis" | "CRegexMissingConditionClosing" | "CRegexLookbehindNotFixedLength" | "CRegexZeroRelativeReference" | "CRegexTooManyConditionBranches" | "CRegexBadRelativeReference" | "CRegexUnknownPosixClass" | "CRegexCodePointTooBig" | "CRegexLookbehindTooComplicated" | "CRegexUnsupportedEscapeSequence" | "CRegexCalloutNumberTooBig" | "CRegexMissingCalloutClosing" | "CRegexEscapeInvalidInVerb" | "CRegexUnrecognizedAfterQueryP" | "CRegexMissingNameTerminator" | "CRegexDuplicateSubpatternName" | "CRegexInvalidSubpatternName" | "CRegexUnicodePropertiesUnavailable" | "CRegexMalformedUnicodeProperty" | "CRegexUnknownUnicodeProperty" | "CRegexSubpatternNameTooLong" | "CRegexTooManyNamedSubpatterns" | "CRegexClassInvalidRange" | "CRegexDefineTooManyBranches" | "CRegexBackslashOMissingBrace" | "CRegexBackslashGSyntax" | "CRegexParensQueryRMissingClosing" | "CRegexVerbUnknown" | "CRegexSubpatternNumberTooBig" | "CRegexSubpatternNameExpected" | "CRegexInvalidOctal" | "CRegexSubpatternNamesMismatch" | "CRegexMarkMissingArgument" | "CRegexInvalidHexadecimal" | "CRegexBackslashCSyntax" | "CRegexBackslashNInClass" | "CRegexCalloutStringTooLong" | "CRegexUnicodeDisallowedCodePoint" | "CRegexVerbNameTooLong" | "CRegexBackslashUCodePointTooBig" | "CRegexMissingOctalOrHexDigits" | "CRegexVersionConditionSyntax" | "CRegexCalloutNoStringDelimiter" | "CRegexCalloutBadStringDelimiter" | "CRegexQueryBarjxNestTooDeep" | "CRegexPatternTooComplicated" | "CRegexLookbehindTooLong" | "CRegexPatternStringTooLong" | "CRegexInvalidHyphenInOptions" | "CRegexAlphaAssertionUnknown" | "CRegexTooManyCaptures" | "CRegexConditionAtomicAssertionExpected" | "CRegexBackslashKInLookaround" | "MRegexErrorGeneric" | "MRegexBadreplacement" | "MRegexMatchlimit" | "MRegexNosubstring" | "MRegexNouniquesubstring" | "MRegexDepthlimit" | "MRegexBadrepescape" | "MRegexRepmissingbrace" | "MRegexBadsubstitution" | "MRegexBadsubspattern" | "MRegexRecurseLoop" | "ERegexErrorGeneric" | "ERegexNoCaptureGroups" | "TranslateStringTooLong" | "TranslateUnsupportedSrcLanguage" | "TranslateUnsupportedTargetLanguage";
|
|
28794
30046
|
}
|
|
28795
30047
|
/**
|
|
28796
30048
|
* Represents the value of a cell containing a type of value which cannot be serialized.
|
|
@@ -36932,7 +38184,7 @@ declare namespace Excel {
|
|
|
36932
38184
|
*/
|
|
36933
38185
|
getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;
|
|
36934
38186
|
/**
|
|
36935
|
-
* Renders the range as a Base64-encoded
|
|
38187
|
+
* Renders the range as a Base64-encoded PNG image.
|
|
36936
38188
|
**Important**: This API is currently unsupported in Excel for Mac. Visit {@link https://github.com/OfficeDev/office-js/issues/235 | OfficeDev/office-js Issue #235} for the current status.
|
|
36937
38189
|
*
|
|
36938
38190
|
* @remarks
|
|
@@ -48969,7 +50221,7 @@ declare namespace Excel {
|
|
|
48969
50221
|
*/
|
|
48970
50222
|
category: string;
|
|
48971
50223
|
/**
|
|
48972
|
-
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
|
|
50224
|
+
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
|
|
48973
50225
|
*
|
|
48974
50226
|
* @remarks
|
|
48975
50227
|
* [Api set: ExcelApi 1.7]
|
|
@@ -59818,6 +61070,13 @@ declare namespace Excel {
|
|
|
59818
61070
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59819
61071
|
*/
|
|
59820
61072
|
annotationAdded = "AnnotationAdded",
|
|
61073
|
+
/**
|
|
61074
|
+
* TableQueryRefreshCompleted represents the type of event registered when a table query refresh is completed.
|
|
61075
|
+
* @remarks
|
|
61076
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
61077
|
+
* @beta
|
|
61078
|
+
*/
|
|
61079
|
+
queryQueryRefreshCompleted = "QueryQueryRefreshCompleted"
|
|
59821
61080
|
}
|
|
59822
61081
|
/**
|
|
59823
61082
|
* @remarks
|
|
@@ -69890,7 +71149,7 @@ declare namespace Excel {
|
|
|
69890
71149
|
*/
|
|
69891
71150
|
category?: string;
|
|
69892
71151
|
/**
|
|
69893
|
-
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
|
|
71152
|
+
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
|
|
69894
71153
|
*
|
|
69895
71154
|
* @remarks
|
|
69896
71155
|
* [Api set: ExcelApi 1.7]
|
|
@@ -76414,7 +77673,7 @@ declare namespace Excel {
|
|
|
76414
77673
|
*/
|
|
76415
77674
|
category?: string;
|
|
76416
77675
|
/**
|
|
76417
|
-
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
|
|
77676
|
+
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
|
|
76418
77677
|
*
|
|
76419
77678
|
* @remarks
|
|
76420
77679
|
* [Api set: ExcelApi 1.7]
|
|
@@ -86193,7 +87452,7 @@ declare namespace Excel {
|
|
|
86193
87452
|
*/
|
|
86194
87453
|
category?: boolean;
|
|
86195
87454
|
/**
|
|
86196
|
-
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
|
|
87455
|
+
* The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
|
|
86197
87456
|
*
|
|
86198
87457
|
* @remarks
|
|
86199
87458
|
* [Api set: ExcelApi 1.7]
|
|
@@ -112321,6 +113580,7 @@ declare namespace OneNote {
|
|
|
112321
113580
|
* [Api set: OneNoteApi 1.1]
|
|
112322
113581
|
*/
|
|
112323
113582
|
getActiveSectionOrNull(): OneNote.Section;
|
|
113583
|
+
getDecimalSeparator(): OfficeExtension.ClientResult<string>;
|
|
112324
113584
|
/**
|
|
112325
113585
|
* Gets the currently selected ink strokes.
|
|
112326
113586
|
*
|
|
@@ -112329,6 +113589,7 @@ declare namespace OneNote {
|
|
|
112329
113589
|
*/
|
|
112330
113590
|
getSelectedInkStrokes(): OneNote.InkStrokeCollection;
|
|
112331
113591
|
getWindowSize(): OfficeExtension.ClientResult<number[]>;
|
|
113592
|
+
insertAndEmbedLinkAtCurrentPosition(url: string): void;
|
|
112332
113593
|
insertHtmlAtCurrentPosition(html: string): void;
|
|
112333
113594
|
isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;
|
|
112334
113595
|
/**
|
|
@@ -112372,9 +113633,9 @@ declare namespace OneNote {
|
|
|
112372
113633
|
expand?: string;
|
|
112373
113634
|
}): OneNote.Application;
|
|
112374
113635
|
/**
|
|
112375
|
-
|
|
112376
|
-
|
|
112377
|
-
|
|
113636
|
+
* 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's passed to it.)
|
|
113637
|
+
* Whereas the original OneNote.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
113638
|
+
*/
|
|
112378
113639
|
toJSON(): OneNote.Interfaces.ApplicationData;
|
|
112379
113640
|
}
|
|
112380
113641
|
/**
|
|
@@ -112430,17 +113691,17 @@ declare namespace OneNote {
|
|
|
112430
113691
|
expand?: string;
|
|
112431
113692
|
}): OneNote.InkAnalysis;
|
|
112432
113693
|
/**
|
|
112433
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
113694
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112434
113695
|
*/
|
|
112435
113696
|
track(): OneNote.InkAnalysis;
|
|
112436
113697
|
/**
|
|
112437
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
113698
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112438
113699
|
*/
|
|
112439
113700
|
untrack(): OneNote.InkAnalysis;
|
|
112440
113701
|
/**
|
|
112441
|
-
|
|
112442
|
-
|
|
112443
|
-
|
|
113702
|
+
* 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's passed to it.)
|
|
113703
|
+
* Whereas the original `OneNote.InkAnalysis` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisData`) that contains shallow copies of any loaded child properties from the original object.
|
|
113704
|
+
*/
|
|
112444
113705
|
toJSON(): OneNote.Interfaces.InkAnalysisData;
|
|
112445
113706
|
}
|
|
112446
113707
|
/**
|
|
@@ -112503,17 +113764,17 @@ declare namespace OneNote {
|
|
|
112503
113764
|
expand?: string;
|
|
112504
113765
|
}): OneNote.InkAnalysisParagraph;
|
|
112505
113766
|
/**
|
|
112506
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
113767
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112507
113768
|
*/
|
|
112508
113769
|
track(): OneNote.InkAnalysisParagraph;
|
|
112509
113770
|
/**
|
|
112510
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
113771
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112511
113772
|
*/
|
|
112512
113773
|
untrack(): OneNote.InkAnalysisParagraph;
|
|
112513
113774
|
/**
|
|
112514
|
-
|
|
112515
|
-
|
|
112516
|
-
|
|
113775
|
+
* 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's passed to it.)
|
|
113776
|
+
* Whereas the original `OneNote.InkAnalysisParagraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphData`) that contains shallow copies of any loaded child properties from the original object.
|
|
113777
|
+
*/
|
|
112517
113778
|
toJSON(): OneNote.Interfaces.InkAnalysisParagraphData;
|
|
112518
113779
|
}
|
|
112519
113780
|
/**
|
|
@@ -112571,17 +113832,17 @@ declare namespace OneNote {
|
|
|
112571
113832
|
*/
|
|
112572
113833
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection;
|
|
112573
113834
|
/**
|
|
112574
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
113835
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112575
113836
|
*/
|
|
112576
113837
|
track(): OneNote.InkAnalysisParagraphCollection;
|
|
112577
113838
|
/**
|
|
112578
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
113839
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112579
113840
|
*/
|
|
112580
113841
|
untrack(): OneNote.InkAnalysisParagraphCollection;
|
|
112581
113842
|
/**
|
|
112582
|
-
|
|
112583
|
-
|
|
112584
|
-
|
|
113843
|
+
* 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's passed to it.)
|
|
113844
|
+
* Whereas the original `OneNote.InkAnalysisParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
113845
|
+
*/
|
|
112585
113846
|
toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData;
|
|
112586
113847
|
}
|
|
112587
113848
|
/**
|
|
@@ -112644,17 +113905,17 @@ declare namespace OneNote {
|
|
|
112644
113905
|
expand?: string;
|
|
112645
113906
|
}): OneNote.InkAnalysisLine;
|
|
112646
113907
|
/**
|
|
112647
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
113908
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112648
113909
|
*/
|
|
112649
113910
|
track(): OneNote.InkAnalysisLine;
|
|
112650
113911
|
/**
|
|
112651
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
113912
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112652
113913
|
*/
|
|
112653
113914
|
untrack(): OneNote.InkAnalysisLine;
|
|
112654
113915
|
/**
|
|
112655
|
-
|
|
112656
|
-
|
|
112657
|
-
|
|
113916
|
+
* 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's passed to it.)
|
|
113917
|
+
* Whereas the original `OneNote.InkAnalysisLine` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineData`) that contains shallow copies of any loaded child properties from the original object.
|
|
113918
|
+
*/
|
|
112658
113919
|
toJSON(): OneNote.Interfaces.InkAnalysisLineData;
|
|
112659
113920
|
}
|
|
112660
113921
|
/**
|
|
@@ -112712,17 +113973,17 @@ declare namespace OneNote {
|
|
|
112712
113973
|
*/
|
|
112713
113974
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisLineCollection;
|
|
112714
113975
|
/**
|
|
112715
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
113976
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112716
113977
|
*/
|
|
112717
113978
|
track(): OneNote.InkAnalysisLineCollection;
|
|
112718
113979
|
/**
|
|
112719
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
113980
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112720
113981
|
*/
|
|
112721
113982
|
untrack(): OneNote.InkAnalysisLineCollection;
|
|
112722
113983
|
/**
|
|
112723
|
-
|
|
112724
|
-
|
|
112725
|
-
|
|
113984
|
+
* 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's passed to it.)
|
|
113985
|
+
* Whereas the original `OneNote.InkAnalysisLineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
113986
|
+
*/
|
|
112726
113987
|
toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData;
|
|
112727
113988
|
}
|
|
112728
113989
|
/**
|
|
@@ -112799,17 +114060,17 @@ declare namespace OneNote {
|
|
|
112799
114060
|
expand?: string;
|
|
112800
114061
|
}): OneNote.InkAnalysisWord;
|
|
112801
114062
|
/**
|
|
112802
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114063
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112803
114064
|
*/
|
|
112804
114065
|
track(): OneNote.InkAnalysisWord;
|
|
112805
114066
|
/**
|
|
112806
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114067
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112807
114068
|
*/
|
|
112808
114069
|
untrack(): OneNote.InkAnalysisWord;
|
|
112809
114070
|
/**
|
|
112810
|
-
|
|
112811
|
-
|
|
112812
|
-
|
|
114071
|
+
* 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's passed to it.)
|
|
114072
|
+
* Whereas the original `OneNote.InkAnalysisWord` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114073
|
+
*/
|
|
112813
114074
|
toJSON(): OneNote.Interfaces.InkAnalysisWordData;
|
|
112814
114075
|
}
|
|
112815
114076
|
/**
|
|
@@ -112867,17 +114128,17 @@ declare namespace OneNote {
|
|
|
112867
114128
|
*/
|
|
112868
114129
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisWordCollection;
|
|
112869
114130
|
/**
|
|
112870
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114131
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112871
114132
|
*/
|
|
112872
114133
|
track(): OneNote.InkAnalysisWordCollection;
|
|
112873
114134
|
/**
|
|
112874
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114135
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112875
114136
|
*/
|
|
112876
114137
|
untrack(): OneNote.InkAnalysisWordCollection;
|
|
112877
114138
|
/**
|
|
112878
|
-
|
|
112879
|
-
|
|
112880
|
-
|
|
114139
|
+
* 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's passed to it.)
|
|
114140
|
+
* Whereas the original `OneNote.InkAnalysisWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114141
|
+
*/
|
|
112881
114142
|
toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData;
|
|
112882
114143
|
}
|
|
112883
114144
|
/**
|
|
@@ -112932,17 +114193,17 @@ declare namespace OneNote {
|
|
|
112932
114193
|
expand?: string;
|
|
112933
114194
|
}): OneNote.FloatingInk;
|
|
112934
114195
|
/**
|
|
112935
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114196
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112936
114197
|
*/
|
|
112937
114198
|
track(): OneNote.FloatingInk;
|
|
112938
114199
|
/**
|
|
112939
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114200
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
112940
114201
|
*/
|
|
112941
114202
|
untrack(): OneNote.FloatingInk;
|
|
112942
114203
|
/**
|
|
112943
|
-
|
|
112944
|
-
|
|
112945
|
-
|
|
114204
|
+
* 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's passed to it.)
|
|
114205
|
+
* Whereas the original `OneNote.FloatingInk` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.FloatingInkData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114206
|
+
*/
|
|
112946
114207
|
toJSON(): OneNote.Interfaces.FloatingInkData;
|
|
112947
114208
|
}
|
|
112948
114209
|
/**
|
|
@@ -112990,17 +114251,17 @@ declare namespace OneNote {
|
|
|
112990
114251
|
expand?: string;
|
|
112991
114252
|
}): OneNote.InkStroke;
|
|
112992
114253
|
/**
|
|
112993
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114254
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
112994
114255
|
*/
|
|
112995
114256
|
track(): OneNote.InkStroke;
|
|
112996
114257
|
/**
|
|
112997
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114258
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
112998
114259
|
*/
|
|
112999
114260
|
untrack(): OneNote.InkStroke;
|
|
113000
114261
|
/**
|
|
113001
|
-
|
|
113002
|
-
|
|
113003
|
-
|
|
114262
|
+
* 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's passed to it.)
|
|
114263
|
+
* Whereas the original `OneNote.InkStroke` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114264
|
+
*/
|
|
113004
114265
|
toJSON(): OneNote.Interfaces.InkStrokeData;
|
|
113005
114266
|
}
|
|
113006
114267
|
/**
|
|
@@ -113058,17 +114319,17 @@ declare namespace OneNote {
|
|
|
113058
114319
|
*/
|
|
113059
114320
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection;
|
|
113060
114321
|
/**
|
|
113061
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114322
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113062
114323
|
*/
|
|
113063
114324
|
track(): OneNote.InkStrokeCollection;
|
|
113064
114325
|
/**
|
|
113065
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114326
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
113066
114327
|
*/
|
|
113067
114328
|
untrack(): OneNote.InkStrokeCollection;
|
|
113068
114329
|
/**
|
|
113069
|
-
|
|
113070
|
-
|
|
113071
|
-
|
|
114330
|
+
* 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's passed to it.)
|
|
114331
|
+
* Whereas the original `OneNote.InkStrokeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114332
|
+
*/
|
|
113072
114333
|
toJSON(): OneNote.Interfaces.InkStrokeCollectionData;
|
|
113073
114334
|
}
|
|
113074
114335
|
/**
|
|
@@ -113111,17 +114372,17 @@ declare namespace OneNote {
|
|
|
113111
114372
|
expand?: string;
|
|
113112
114373
|
}): OneNote.Point;
|
|
113113
114374
|
/**
|
|
113114
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114375
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113115
114376
|
*/
|
|
113116
114377
|
track(): OneNote.Point;
|
|
113117
114378
|
/**
|
|
113118
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114379
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
113119
114380
|
*/
|
|
113120
114381
|
untrack(): OneNote.Point;
|
|
113121
114382
|
/**
|
|
113122
|
-
|
|
113123
|
-
|
|
113124
|
-
|
|
114383
|
+
* 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's passed to it.)
|
|
114384
|
+
* Whereas the original `OneNote.Point` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PointData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114385
|
+
*/
|
|
113125
114386
|
toJSON(): OneNote.Interfaces.PointData;
|
|
113126
114387
|
}
|
|
113127
114388
|
/**
|
|
@@ -113179,17 +114440,17 @@ declare namespace OneNote {
|
|
|
113179
114440
|
*/
|
|
113180
114441
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PointCollection;
|
|
113181
114442
|
/**
|
|
113182
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114443
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113183
114444
|
*/
|
|
113184
114445
|
track(): OneNote.PointCollection;
|
|
113185
114446
|
/**
|
|
113186
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114447
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113187
114448
|
*/
|
|
113188
114449
|
untrack(): OneNote.PointCollection;
|
|
113189
114450
|
/**
|
|
113190
|
-
|
|
113191
|
-
|
|
113192
|
-
|
|
114451
|
+
* 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's passed to it.)
|
|
114452
|
+
* Whereas the original `OneNote.PointCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PointCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114453
|
+
*/
|
|
113193
114454
|
toJSON(): OneNote.Interfaces.PointCollectionData;
|
|
113194
114455
|
}
|
|
113195
114456
|
/**
|
|
@@ -113251,17 +114512,17 @@ declare namespace OneNote {
|
|
|
113251
114512
|
expand?: string;
|
|
113252
114513
|
}): OneNote.InkWord;
|
|
113253
114514
|
/**
|
|
113254
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114515
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113255
114516
|
*/
|
|
113256
114517
|
track(): OneNote.InkWord;
|
|
113257
114518
|
/**
|
|
113258
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114519
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113259
114520
|
*/
|
|
113260
114521
|
untrack(): OneNote.InkWord;
|
|
113261
114522
|
/**
|
|
113262
|
-
|
|
113263
|
-
|
|
113264
|
-
|
|
114523
|
+
* 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's passed to it.)
|
|
114524
|
+
* Whereas the original `OneNote.InkWord` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114525
|
+
*/
|
|
113265
114526
|
toJSON(): OneNote.Interfaces.InkWordData;
|
|
113266
114527
|
}
|
|
113267
114528
|
/**
|
|
@@ -113319,17 +114580,17 @@ declare namespace OneNote {
|
|
|
113319
114580
|
*/
|
|
113320
114581
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkWordCollection;
|
|
113321
114582
|
/**
|
|
113322
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114583
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113323
114584
|
*/
|
|
113324
114585
|
track(): OneNote.InkWordCollection;
|
|
113325
114586
|
/**
|
|
113326
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114587
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113327
114588
|
*/
|
|
113328
114589
|
untrack(): OneNote.InkWordCollection;
|
|
113329
114590
|
/**
|
|
113330
|
-
|
|
113331
|
-
|
|
113332
|
-
|
|
114591
|
+
* 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's passed to it.)
|
|
114592
|
+
* Whereas the original `OneNote.InkWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114593
|
+
*/
|
|
113333
114594
|
toJSON(): OneNote.Interfaces.InkWordCollectionData;
|
|
113334
114595
|
}
|
|
113335
114596
|
/**
|
|
@@ -113342,28 +114603,28 @@ declare namespace OneNote {
|
|
|
113342
114603
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
113343
114604
|
context: RequestContext;
|
|
113344
114605
|
/**
|
|
113345
|
-
* The section groups in the notebook. Read
|
|
114606
|
+
* The section groups in the notebook. Read-only.
|
|
113346
114607
|
*
|
|
113347
114608
|
* @remarks
|
|
113348
114609
|
* [Api set: OneNoteApi 1.1]
|
|
113349
114610
|
*/
|
|
113350
114611
|
readonly sectionGroups: OneNote.SectionGroupCollection;
|
|
113351
114612
|
/**
|
|
113352
|
-
* The sections of the notebook. Read
|
|
114613
|
+
* The sections of the notebook. Read-only.
|
|
113353
114614
|
*
|
|
113354
114615
|
* @remarks
|
|
113355
114616
|
* [Api set: OneNoteApi 1.1]
|
|
113356
114617
|
*/
|
|
113357
114618
|
readonly sections: OneNote.SectionCollection;
|
|
113358
114619
|
/**
|
|
113359
|
-
* The
|
|
114620
|
+
* The URL of the site where this notebook is located. Read-only.
|
|
113360
114621
|
*
|
|
113361
114622
|
* @remarks
|
|
113362
114623
|
* [Api set: OneNoteApi 1.1]
|
|
113363
114624
|
*/
|
|
113364
114625
|
readonly baseUrl: string;
|
|
113365
114626
|
/**
|
|
113366
|
-
* The client
|
|
114627
|
+
* The client URL of the notebook. Read-only.
|
|
113367
114628
|
*
|
|
113368
114629
|
* @remarks
|
|
113369
114630
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -113377,7 +114638,7 @@ declare namespace OneNote {
|
|
|
113377
114638
|
*/
|
|
113378
114639
|
readonly id: string;
|
|
113379
114640
|
/**
|
|
113380
|
-
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read
|
|
114641
|
+
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read-only.
|
|
113381
114642
|
*
|
|
113382
114643
|
* @remarks
|
|
113383
114644
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -113437,17 +114698,17 @@ declare namespace OneNote {
|
|
|
113437
114698
|
expand?: string;
|
|
113438
114699
|
}): OneNote.Notebook;
|
|
113439
114700
|
/**
|
|
113440
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114701
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113441
114702
|
*/
|
|
113442
114703
|
track(): OneNote.Notebook;
|
|
113443
114704
|
/**
|
|
113444
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114705
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113445
114706
|
*/
|
|
113446
114707
|
untrack(): OneNote.Notebook;
|
|
113447
114708
|
/**
|
|
113448
|
-
|
|
113449
|
-
|
|
113450
|
-
|
|
114709
|
+
* 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's passed to it.)
|
|
114710
|
+
* Whereas the original `OneNote.Notebook` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114711
|
+
*/
|
|
113451
114712
|
toJSON(): OneNote.Interfaces.NotebookData;
|
|
113452
114713
|
}
|
|
113453
114714
|
/**
|
|
@@ -113514,17 +114775,17 @@ declare namespace OneNote {
|
|
|
113514
114775
|
*/
|
|
113515
114776
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection;
|
|
113516
114777
|
/**
|
|
113517
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114778
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113518
114779
|
*/
|
|
113519
114780
|
track(): OneNote.NotebookCollection;
|
|
113520
114781
|
/**
|
|
113521
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114782
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113522
114783
|
*/
|
|
113523
114784
|
untrack(): OneNote.NotebookCollection;
|
|
113524
114785
|
/**
|
|
113525
|
-
|
|
113526
|
-
|
|
113527
|
-
|
|
114786
|
+
* 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's passed to it.)
|
|
114787
|
+
* Whereas the original `OneNote.NotebookCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114788
|
+
*/
|
|
113528
114789
|
toJSON(): OneNote.Interfaces.NotebookCollectionData;
|
|
113529
114790
|
}
|
|
113530
114791
|
/**
|
|
@@ -113639,17 +114900,17 @@ declare namespace OneNote {
|
|
|
113639
114900
|
expand?: string;
|
|
113640
114901
|
}): OneNote.SectionGroup;
|
|
113641
114902
|
/**
|
|
113642
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114903
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113643
114904
|
*/
|
|
113644
114905
|
track(): OneNote.SectionGroup;
|
|
113645
114906
|
/**
|
|
113646
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114907
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113647
114908
|
*/
|
|
113648
114909
|
untrack(): OneNote.SectionGroup;
|
|
113649
114910
|
/**
|
|
113650
|
-
|
|
113651
|
-
|
|
113652
|
-
|
|
114911
|
+
* 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's passed to it.)
|
|
114912
|
+
* Whereas the original `OneNote.SectionGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114913
|
+
*/
|
|
113653
114914
|
toJSON(): OneNote.Interfaces.SectionGroupData;
|
|
113654
114915
|
}
|
|
113655
114916
|
/**
|
|
@@ -113716,17 +114977,17 @@ declare namespace OneNote {
|
|
|
113716
114977
|
*/
|
|
113717
114978
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection;
|
|
113718
114979
|
/**
|
|
113719
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
114980
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113720
114981
|
*/
|
|
113721
114982
|
track(): OneNote.SectionGroupCollection;
|
|
113722
114983
|
/**
|
|
113723
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
114984
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
113724
114985
|
*/
|
|
113725
114986
|
untrack(): OneNote.SectionGroupCollection;
|
|
113726
114987
|
/**
|
|
113727
|
-
|
|
113728
|
-
|
|
113729
|
-
|
|
114988
|
+
* 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's passed to it.)
|
|
114989
|
+
* Whereas the original `OneNote.SectionGroupCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
114990
|
+
*/
|
|
113730
114991
|
toJSON(): OneNote.Interfaces.SectionGroupCollectionData;
|
|
113731
114992
|
}
|
|
113732
114993
|
/**
|
|
@@ -113884,17 +115145,17 @@ declare namespace OneNote {
|
|
|
113884
115145
|
expand?: string;
|
|
113885
115146
|
}): OneNote.Section;
|
|
113886
115147
|
/**
|
|
113887
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115148
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113888
115149
|
*/
|
|
113889
115150
|
track(): OneNote.Section;
|
|
113890
115151
|
/**
|
|
113891
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115152
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113892
115153
|
*/
|
|
113893
115154
|
untrack(): OneNote.Section;
|
|
113894
115155
|
/**
|
|
113895
|
-
|
|
113896
|
-
|
|
113897
|
-
|
|
115156
|
+
* 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's passed to it.)
|
|
115157
|
+
* Whereas the original `OneNote.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115158
|
+
*/
|
|
113898
115159
|
toJSON(): OneNote.Interfaces.SectionData;
|
|
113899
115160
|
}
|
|
113900
115161
|
/**
|
|
@@ -113961,17 +115222,17 @@ declare namespace OneNote {
|
|
|
113961
115222
|
*/
|
|
113962
115223
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionCollection;
|
|
113963
115224
|
/**
|
|
113964
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115225
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
113965
115226
|
*/
|
|
113966
115227
|
track(): OneNote.SectionCollection;
|
|
113967
115228
|
/**
|
|
113968
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115229
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
113969
115230
|
*/
|
|
113970
115231
|
untrack(): OneNote.SectionCollection;
|
|
113971
115232
|
/**
|
|
113972
|
-
|
|
113973
|
-
|
|
113974
|
-
|
|
115233
|
+
* 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.)
|
|
115234
|
+
* Whereas the original `OneNote.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
115235
|
+
*/
|
|
113975
115236
|
toJSON(): OneNote.Interfaces.SectionCollectionData;
|
|
113976
115237
|
}
|
|
113977
115238
|
/**
|
|
@@ -113984,7 +115245,7 @@ declare namespace OneNote {
|
|
|
113984
115245
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
113985
115246
|
context: RequestContext;
|
|
113986
115247
|
/**
|
|
113987
|
-
* The collection of PageContent objects on the page.
|
|
115248
|
+
* The collection of PageContent objects on the page.
|
|
113988
115249
|
*
|
|
113989
115250
|
* @remarks
|
|
113990
115251
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -113998,7 +115259,7 @@ declare namespace OneNote {
|
|
|
113998
115259
|
*/
|
|
113999
115260
|
readonly inkAnalysisOrNull: OneNote.InkAnalysis;
|
|
114000
115261
|
/**
|
|
114001
|
-
* Gets the section that contains the page.
|
|
115262
|
+
* Gets the section that contains the page.
|
|
114002
115263
|
*
|
|
114003
115264
|
* @remarks
|
|
114004
115265
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -114012,14 +115273,14 @@ declare namespace OneNote {
|
|
|
114012
115273
|
*/
|
|
114013
115274
|
readonly classNotebookPageSource: string;
|
|
114014
115275
|
/**
|
|
114015
|
-
* The client
|
|
115276
|
+
* The client URL of the page.
|
|
114016
115277
|
*
|
|
114017
115278
|
* @remarks
|
|
114018
115279
|
* [Api set: OneNoteApi 1.1]
|
|
114019
115280
|
*/
|
|
114020
115281
|
readonly clientUrl: string;
|
|
114021
115282
|
/**
|
|
114022
|
-
* Gets the ID of the page.
|
|
115283
|
+
* Gets the ID of the page.
|
|
114023
115284
|
*
|
|
114024
115285
|
* @remarks
|
|
114025
115286
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -114153,17 +115414,17 @@ declare namespace OneNote {
|
|
|
114153
115414
|
expand?: string;
|
|
114154
115415
|
}): OneNote.Page;
|
|
114155
115416
|
/**
|
|
114156
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115417
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114157
115418
|
*/
|
|
114158
115419
|
track(): OneNote.Page;
|
|
114159
115420
|
/**
|
|
114160
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115421
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114161
115422
|
*/
|
|
114162
115423
|
untrack(): OneNote.Page;
|
|
114163
115424
|
/**
|
|
114164
|
-
|
|
114165
|
-
|
|
114166
|
-
|
|
115425
|
+
* 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's passed to it.)
|
|
115426
|
+
* Whereas the original `OneNote.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115427
|
+
*/
|
|
114167
115428
|
toJSON(): OneNote.Interfaces.PageData;
|
|
114168
115429
|
}
|
|
114169
115430
|
/**
|
|
@@ -114230,17 +115491,17 @@ declare namespace OneNote {
|
|
|
114230
115491
|
*/
|
|
114231
115492
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection;
|
|
114232
115493
|
/**
|
|
114233
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115494
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114234
115495
|
*/
|
|
114235
115496
|
track(): OneNote.PageCollection;
|
|
114236
115497
|
/**
|
|
114237
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115498
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114238
115499
|
*/
|
|
114239
115500
|
untrack(): OneNote.PageCollection;
|
|
114240
115501
|
/**
|
|
114241
|
-
|
|
114242
|
-
|
|
114243
|
-
|
|
115502
|
+
* 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.)
|
|
115503
|
+
* Whereas the original `OneNote.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
115504
|
+
*/
|
|
114244
115505
|
toJSON(): OneNote.Interfaces.PageCollectionData;
|
|
114245
115506
|
}
|
|
114246
115507
|
/**
|
|
@@ -114345,17 +115606,17 @@ declare namespace OneNote {
|
|
|
114345
115606
|
expand?: string;
|
|
114346
115607
|
}): OneNote.PageContent;
|
|
114347
115608
|
/**
|
|
114348
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115609
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114349
115610
|
*/
|
|
114350
115611
|
track(): OneNote.PageContent;
|
|
114351
115612
|
/**
|
|
114352
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115613
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114353
115614
|
*/
|
|
114354
115615
|
untrack(): OneNote.PageContent;
|
|
114355
115616
|
/**
|
|
114356
|
-
|
|
114357
|
-
|
|
114358
|
-
|
|
115617
|
+
* 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's passed to it.)
|
|
115618
|
+
* Whereas the original `OneNote.PageContent` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115619
|
+
*/
|
|
114359
115620
|
toJSON(): OneNote.Interfaces.PageContentData;
|
|
114360
115621
|
}
|
|
114361
115622
|
/**
|
|
@@ -114413,17 +115674,17 @@ declare namespace OneNote {
|
|
|
114413
115674
|
*/
|
|
114414
115675
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection;
|
|
114415
115676
|
/**
|
|
114416
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115677
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114417
115678
|
*/
|
|
114418
115679
|
track(): OneNote.PageContentCollection;
|
|
114419
115680
|
/**
|
|
114420
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115681
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114421
115682
|
*/
|
|
114422
115683
|
untrack(): OneNote.PageContentCollection;
|
|
114423
115684
|
/**
|
|
114424
|
-
|
|
114425
|
-
|
|
114426
|
-
|
|
115685
|
+
* 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's passed to it.)
|
|
115686
|
+
* Whereas the original `OneNote.PageContentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
115687
|
+
*/
|
|
114427
115688
|
toJSON(): OneNote.Interfaces.PageContentCollectionData;
|
|
114428
115689
|
}
|
|
114429
115690
|
/**
|
|
@@ -114525,17 +115786,17 @@ declare namespace OneNote {
|
|
|
114525
115786
|
expand?: string;
|
|
114526
115787
|
}): OneNote.Outline;
|
|
114527
115788
|
/**
|
|
114528
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
115789
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114529
115790
|
*/
|
|
114530
115791
|
track(): OneNote.Outline;
|
|
114531
115792
|
/**
|
|
114532
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
115793
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114533
115794
|
*/
|
|
114534
115795
|
untrack(): OneNote.Outline;
|
|
114535
115796
|
/**
|
|
114536
|
-
|
|
114537
|
-
|
|
114538
|
-
|
|
115797
|
+
* 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's passed to it.)
|
|
115798
|
+
* Whereas the original `OneNote.Outline` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.OutlineData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115799
|
+
*/
|
|
114539
115800
|
toJSON(): OneNote.Interfaces.OutlineData;
|
|
114540
115801
|
}
|
|
114541
115802
|
/**
|
|
@@ -114548,84 +115809,84 @@ declare namespace OneNote {
|
|
|
114548
115809
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
114549
115810
|
context: RequestContext;
|
|
114550
115811
|
/**
|
|
114551
|
-
* Gets the Image object in the Paragraph. Throws an exception if ParagraphType
|
|
115812
|
+
* Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
|
|
114552
115813
|
*
|
|
114553
115814
|
* @remarks
|
|
114554
115815
|
* [Api set: OneNoteApi 1.1]
|
|
114555
115816
|
*/
|
|
114556
115817
|
readonly image: OneNote.Image;
|
|
114557
115818
|
/**
|
|
114558
|
-
* Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType
|
|
115819
|
+
* Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
|
|
114559
115820
|
*
|
|
114560
115821
|
* @remarks
|
|
114561
115822
|
* [Api set: OneNoteApi 1.1]
|
|
114562
115823
|
*/
|
|
114563
115824
|
readonly inkWords: OneNote.InkWordCollection;
|
|
114564
115825
|
/**
|
|
114565
|
-
* Gets the Outline object that contains the Paragraph.
|
|
115826
|
+
* Gets the Outline object that contains the Paragraph.
|
|
114566
115827
|
*
|
|
114567
115828
|
* @remarks
|
|
114568
115829
|
* [Api set: OneNoteApi 1.1]
|
|
114569
115830
|
*/
|
|
114570
115831
|
readonly outline: OneNote.Outline;
|
|
114571
115832
|
/**
|
|
114572
|
-
* The collection of paragraphs under this paragraph.
|
|
115833
|
+
* The collection of paragraphs under this paragraph.
|
|
114573
115834
|
*
|
|
114574
115835
|
* @remarks
|
|
114575
115836
|
* [Api set: OneNoteApi 1.1]
|
|
114576
115837
|
*/
|
|
114577
115838
|
readonly paragraphs: OneNote.ParagraphCollection;
|
|
114578
115839
|
/**
|
|
114579
|
-
* Gets the parent paragraph object. Throws if a parent paragraph
|
|
115840
|
+
* Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
|
|
114580
115841
|
*
|
|
114581
115842
|
* @remarks
|
|
114582
115843
|
* [Api set: OneNoteApi 1.1]
|
|
114583
115844
|
*/
|
|
114584
115845
|
readonly parentParagraph: OneNote.Paragraph;
|
|
114585
115846
|
/**
|
|
114586
|
-
* Gets the parent paragraph object. Returns null if a parent paragraph
|
|
115847
|
+
* Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
|
|
114587
115848
|
*
|
|
114588
115849
|
* @remarks
|
|
114589
115850
|
* [Api set: OneNoteApi 1.1]
|
|
114590
115851
|
*/
|
|
114591
115852
|
readonly parentParagraphOrNull: OneNote.Paragraph;
|
|
114592
115853
|
/**
|
|
114593
|
-
* Gets the TableCell object that contains the Paragraph if one exists. If parent
|
|
115854
|
+
* Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
|
|
114594
115855
|
*
|
|
114595
115856
|
* @remarks
|
|
114596
115857
|
* [Api set: OneNoteApi 1.1]
|
|
114597
115858
|
*/
|
|
114598
115859
|
readonly parentTableCell: OneNote.TableCell;
|
|
114599
115860
|
/**
|
|
114600
|
-
* Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null.
|
|
115861
|
+
* Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null.
|
|
114601
115862
|
*
|
|
114602
115863
|
* @remarks
|
|
114603
115864
|
* [Api set: OneNoteApi 1.1]
|
|
114604
115865
|
*/
|
|
114605
115866
|
readonly parentTableCellOrNull: OneNote.TableCell;
|
|
114606
115867
|
/**
|
|
114607
|
-
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
|
|
115868
|
+
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
|
|
114608
115869
|
*
|
|
114609
115870
|
* @remarks
|
|
114610
115871
|
* [Api set: OneNoteApi 1.1]
|
|
114611
115872
|
*/
|
|
114612
115873
|
readonly richText: OneNote.RichText;
|
|
114613
115874
|
/**
|
|
114614
|
-
* Gets the Table object in the Paragraph. Throws an exception if ParagraphType
|
|
115875
|
+
* Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
|
|
114615
115876
|
*
|
|
114616
115877
|
* @remarks
|
|
114617
115878
|
* [Api set: OneNoteApi 1.1]
|
|
114618
115879
|
*/
|
|
114619
115880
|
readonly table: OneNote.Table;
|
|
114620
115881
|
/**
|
|
114621
|
-
* Gets the ID of the Paragraph object.
|
|
115882
|
+
* Gets the ID of the Paragraph object.
|
|
114622
115883
|
*
|
|
114623
115884
|
* @remarks
|
|
114624
115885
|
* [Api set: OneNoteApi 1.1]
|
|
114625
115886
|
*/
|
|
114626
115887
|
readonly id: string;
|
|
114627
115888
|
/**
|
|
114628
|
-
* Gets the type of the Paragraph object.
|
|
115889
|
+
* Gets the type of the Paragraph object.
|
|
114629
115890
|
*
|
|
114630
115891
|
* @remarks
|
|
114631
115892
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -114783,17 +116044,17 @@ declare namespace OneNote {
|
|
|
114783
116044
|
expand?: string;
|
|
114784
116045
|
}): OneNote.Paragraph;
|
|
114785
116046
|
/**
|
|
114786
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116047
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114787
116048
|
*/
|
|
114788
116049
|
track(): OneNote.Paragraph;
|
|
114789
116050
|
/**
|
|
114790
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116051
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114791
116052
|
*/
|
|
114792
116053
|
untrack(): OneNote.Paragraph;
|
|
114793
116054
|
/**
|
|
114794
|
-
|
|
114795
|
-
|
|
114796
|
-
|
|
116055
|
+
* 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.)
|
|
116056
|
+
* Whereas the original `OneNote.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116057
|
+
*/
|
|
114797
116058
|
toJSON(): OneNote.Interfaces.ParagraphData;
|
|
114798
116059
|
}
|
|
114799
116060
|
/**
|
|
@@ -114851,17 +116112,17 @@ declare namespace OneNote {
|
|
|
114851
116112
|
*/
|
|
114852
116113
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection;
|
|
114853
116114
|
/**
|
|
114854
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116115
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114855
116116
|
*/
|
|
114856
116117
|
track(): OneNote.ParagraphCollection;
|
|
114857
116118
|
/**
|
|
114858
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116119
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114859
116120
|
*/
|
|
114860
116121
|
untrack(): OneNote.ParagraphCollection;
|
|
114861
116122
|
/**
|
|
114862
|
-
|
|
114863
|
-
|
|
114864
|
-
|
|
116123
|
+
* 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.)
|
|
116124
|
+
* Whereas the original `OneNote.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
116125
|
+
*/
|
|
114865
116126
|
toJSON(): OneNote.Interfaces.ParagraphCollectionData;
|
|
114866
116127
|
}
|
|
114867
116128
|
/**
|
|
@@ -114916,17 +116177,17 @@ declare namespace OneNote {
|
|
|
114916
116177
|
expand?: string;
|
|
114917
116178
|
}): OneNote.NoteTag;
|
|
114918
116179
|
/**
|
|
114919
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116180
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
114920
116181
|
*/
|
|
114921
116182
|
track(): OneNote.NoteTag;
|
|
114922
116183
|
/**
|
|
114923
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116184
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
114924
116185
|
*/
|
|
114925
116186
|
untrack(): OneNote.NoteTag;
|
|
114926
116187
|
/**
|
|
114927
|
-
|
|
114928
|
-
|
|
114929
|
-
|
|
116188
|
+
* 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.)
|
|
116189
|
+
* Whereas the original `OneNote.NoteTag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NoteTagData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116190
|
+
*/
|
|
114930
116191
|
toJSON(): OneNote.Interfaces.NoteTagData;
|
|
114931
116192
|
}
|
|
114932
116193
|
/**
|
|
@@ -114960,25 +116221,25 @@ declare namespace OneNote {
|
|
|
114960
116221
|
*/
|
|
114961
116222
|
readonly languageId: string;
|
|
114962
116223
|
/**
|
|
114963
|
-
* Gets the text style of the RichText object.
|
|
116224
|
+
* Gets the text style of the RichText object.
|
|
114964
116225
|
*
|
|
114965
116226
|
* @remarks
|
|
114966
116227
|
* [Api set: OneNoteApi 1.8]
|
|
114967
116228
|
*/
|
|
114968
116229
|
readonly style: OneNote.ParagraphStyle;
|
|
114969
116230
|
/**
|
|
114970
|
-
* Gets the text content of the RichText object.
|
|
116231
|
+
* Gets the text content of the RichText object.
|
|
114971
116232
|
*
|
|
114972
116233
|
* @remarks
|
|
114973
116234
|
* [Api set: OneNoteApi 1.1]
|
|
114974
116235
|
*/
|
|
114975
116236
|
readonly text: string;
|
|
114976
116237
|
/**
|
|
114977
|
-
* Get the HTML of the rich text
|
|
116238
|
+
* Get the HTML of the rich text.
|
|
114978
116239
|
*
|
|
114979
116240
|
* @remarks
|
|
114980
116241
|
* [Api set: OneNoteApi 1.1]
|
|
114981
|
-
* @returns The
|
|
116242
|
+
* @returns The HTML of the rich text.
|
|
114982
116243
|
*/
|
|
114983
116244
|
getHtml(): OfficeExtension.ClientResult<string>;
|
|
114984
116245
|
/**
|
|
@@ -115003,17 +116264,17 @@ declare namespace OneNote {
|
|
|
115003
116264
|
expand?: string;
|
|
115004
116265
|
}): OneNote.RichText;
|
|
115005
116266
|
/**
|
|
115006
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116267
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115007
116268
|
*/
|
|
115008
116269
|
track(): OneNote.RichText;
|
|
115009
116270
|
/**
|
|
115010
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116271
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
115011
116272
|
*/
|
|
115012
116273
|
untrack(): OneNote.RichText;
|
|
115013
116274
|
/**
|
|
115014
|
-
|
|
115015
|
-
|
|
115016
|
-
|
|
116275
|
+
* 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's passed to it.)
|
|
116276
|
+
* Whereas the original `OneNote.RichText` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.RichTextData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116277
|
+
*/
|
|
115017
116278
|
toJSON(): OneNote.Interfaces.RichTextData;
|
|
115018
116279
|
}
|
|
115019
116280
|
/**
|
|
@@ -115090,7 +116351,7 @@ declare namespace OneNote {
|
|
|
115090
116351
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
115091
116352
|
set(properties: OneNote.Image): void;
|
|
115092
116353
|
/**
|
|
115093
|
-
* Gets the
|
|
116354
|
+
* Gets the Base64-encoded binary representation of the Image.
|
|
115094
116355
|
Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
|
|
115095
116356
|
*
|
|
115096
116357
|
* @remarks
|
|
@@ -115119,17 +116380,17 @@ declare namespace OneNote {
|
|
|
115119
116380
|
expand?: string;
|
|
115120
116381
|
}): OneNote.Image;
|
|
115121
116382
|
/**
|
|
115122
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116383
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115123
116384
|
*/
|
|
115124
116385
|
track(): OneNote.Image;
|
|
115125
116386
|
/**
|
|
115126
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116387
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
115127
116388
|
*/
|
|
115128
116389
|
untrack(): OneNote.Image;
|
|
115129
116390
|
/**
|
|
115130
|
-
|
|
115131
|
-
|
|
115132
|
-
|
|
116391
|
+
* 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's passed to it.)
|
|
116392
|
+
* Whereas the original `OneNote.Image` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ImageData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116393
|
+
*/
|
|
115133
116394
|
toJSON(): OneNote.Interfaces.ImageData;
|
|
115134
116395
|
}
|
|
115135
116396
|
/**
|
|
@@ -115276,17 +116537,17 @@ declare namespace OneNote {
|
|
|
115276
116537
|
expand?: string;
|
|
115277
116538
|
}): OneNote.Table;
|
|
115278
116539
|
/**
|
|
115279
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116540
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115280
116541
|
*/
|
|
115281
116542
|
track(): OneNote.Table;
|
|
115282
116543
|
/**
|
|
115283
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116544
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
115284
116545
|
*/
|
|
115285
116546
|
untrack(): OneNote.Table;
|
|
115286
116547
|
/**
|
|
115287
|
-
|
|
115288
|
-
|
|
115289
|
-
|
|
116548
|
+
* 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's passed to it.)
|
|
116549
|
+
* Whereas the original OneNote.Table object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116550
|
+
*/
|
|
115290
116551
|
toJSON(): OneNote.Interfaces.TableData;
|
|
115291
116552
|
}
|
|
115292
116553
|
/**
|
|
@@ -115390,17 +116651,17 @@ declare namespace OneNote {
|
|
|
115390
116651
|
expand?: string;
|
|
115391
116652
|
}): OneNote.TableRow;
|
|
115392
116653
|
/**
|
|
115393
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116654
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115394
116655
|
*/
|
|
115395
116656
|
track(): OneNote.TableRow;
|
|
115396
116657
|
/**
|
|
115397
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116658
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
115398
116659
|
*/
|
|
115399
116660
|
untrack(): OneNote.TableRow;
|
|
115400
116661
|
/**
|
|
115401
|
-
|
|
115402
|
-
|
|
115403
|
-
|
|
116662
|
+
* 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.)
|
|
116663
|
+
* Whereas the original `OneNote.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116664
|
+
*/
|
|
115404
116665
|
toJSON(): OneNote.Interfaces.TableRowData;
|
|
115405
116666
|
}
|
|
115406
116667
|
/**
|
|
@@ -115458,17 +116719,17 @@ declare namespace OneNote {
|
|
|
115458
116719
|
*/
|
|
115459
116720
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableRowCollection;
|
|
115460
116721
|
/**
|
|
115461
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116722
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115462
116723
|
*/
|
|
115463
116724
|
track(): OneNote.TableRowCollection;
|
|
115464
116725
|
/**
|
|
115465
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116726
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
115466
116727
|
*/
|
|
115467
116728
|
untrack(): OneNote.TableRowCollection;
|
|
115468
116729
|
/**
|
|
115469
|
-
|
|
115470
|
-
|
|
115471
|
-
|
|
116730
|
+
* 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's passed to it.)
|
|
116731
|
+
* Whereas the original `OneNote.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
116732
|
+
*/
|
|
115472
116733
|
toJSON(): OneNote.Interfaces.TableRowCollectionData;
|
|
115473
116734
|
}
|
|
115474
116735
|
/**
|
|
@@ -115599,17 +116860,17 @@ declare namespace OneNote {
|
|
|
115599
116860
|
expand?: string;
|
|
115600
116861
|
}): OneNote.TableCell;
|
|
115601
116862
|
/**
|
|
115602
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116863
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115603
116864
|
*/
|
|
115604
116865
|
track(): OneNote.TableCell;
|
|
115605
116866
|
/**
|
|
115606
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116867
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
115607
116868
|
*/
|
|
115608
116869
|
untrack(): OneNote.TableCell;
|
|
115609
116870
|
/**
|
|
115610
|
-
|
|
115611
|
-
|
|
115612
|
-
|
|
116871
|
+
* 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's passed to it.)
|
|
116872
|
+
* Whereas the original `OneNote.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116873
|
+
*/
|
|
115613
116874
|
toJSON(): OneNote.Interfaces.TableCellData;
|
|
115614
116875
|
}
|
|
115615
116876
|
/**
|
|
@@ -115667,17 +116928,17 @@ declare namespace OneNote {
|
|
|
115667
116928
|
*/
|
|
115668
116929
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableCellCollection;
|
|
115669
116930
|
/**
|
|
115670
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
116931
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
|
|
115671
116932
|
*/
|
|
115672
116933
|
track(): OneNote.TableCellCollection;
|
|
115673
116934
|
/**
|
|
115674
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
116935
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
115675
116936
|
*/
|
|
115676
116937
|
untrack(): OneNote.TableCellCollection;
|
|
115677
116938
|
/**
|
|
115678
|
-
|
|
115679
|
-
|
|
115680
|
-
|
|
116939
|
+
* 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's passed to it.)
|
|
116940
|
+
* Whereas the original `OneNote.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
116941
|
+
*/
|
|
115681
116942
|
toJSON(): OneNote.Interfaces.TableCellCollectionData;
|
|
115682
116943
|
}
|
|
115683
116944
|
/**
|
|
@@ -116388,6 +117649,7 @@ declare namespace OneNote {
|
|
|
116388
117649
|
}
|
|
116389
117650
|
enum ErrorCodes {
|
|
116390
117651
|
accessDenied = "AccessDenied",
|
|
117652
|
+
corruptedContent = "CorruptedContent",
|
|
116391
117653
|
generalException = "GeneralException",
|
|
116392
117654
|
invalidArgument = "InvalidArgument",
|
|
116393
117655
|
invalidOperation = "InvalidOperation",
|
|
@@ -116411,10 +117673,10 @@ declare namespace OneNote {
|
|
|
116411
117673
|
*/
|
|
116412
117674
|
$skip?: number;
|
|
116413
117675
|
}
|
|
116414
|
-
/** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
|
|
117676
|
+
/** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */
|
|
116415
117677
|
interface ApplicationUpdateData {
|
|
116416
117678
|
}
|
|
116417
|
-
/** An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`. */
|
|
117679
|
+
/** An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`. */
|
|
116418
117680
|
interface InkAnalysisUpdateData {
|
|
116419
117681
|
/**
|
|
116420
117682
|
* Gets the parent page object.
|
|
@@ -116424,7 +117686,7 @@ declare namespace OneNote {
|
|
|
116424
117686
|
*/
|
|
116425
117687
|
page?: OneNote.Interfaces.PageUpdateData;
|
|
116426
117688
|
}
|
|
116427
|
-
/** An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. */
|
|
117689
|
+
/** An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... })`. */
|
|
116428
117690
|
interface InkAnalysisParagraphUpdateData {
|
|
116429
117691
|
/**
|
|
116430
117692
|
* Reference to the parent InkAnalysisPage.
|
|
@@ -116434,11 +117696,11 @@ declare namespace OneNote {
|
|
|
116434
117696
|
*/
|
|
116435
117697
|
inkAnalysis?: OneNote.Interfaces.InkAnalysisUpdateData;
|
|
116436
117698
|
}
|
|
116437
|
-
/** An interface for updating data on the InkAnalysisParagraphCollection object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */
|
|
117699
|
+
/** An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */
|
|
116438
117700
|
interface InkAnalysisParagraphCollectionUpdateData {
|
|
116439
117701
|
items?: OneNote.Interfaces.InkAnalysisParagraphData[];
|
|
116440
117702
|
}
|
|
116441
|
-
/** An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`. */
|
|
117703
|
+
/** An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`. */
|
|
116442
117704
|
interface InkAnalysisLineUpdateData {
|
|
116443
117705
|
/**
|
|
116444
117706
|
* Reference to the parent InkAnalysisParagraph.
|
|
@@ -116448,11 +117710,11 @@ declare namespace OneNote {
|
|
|
116448
117710
|
*/
|
|
116449
117711
|
paragraph?: OneNote.Interfaces.InkAnalysisParagraphUpdateData;
|
|
116450
117712
|
}
|
|
116451
|
-
/** An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ ... })`. */
|
|
117713
|
+
/** An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. */
|
|
116452
117714
|
interface InkAnalysisLineCollectionUpdateData {
|
|
116453
117715
|
items?: OneNote.Interfaces.InkAnalysisLineData[];
|
|
116454
117716
|
}
|
|
116455
|
-
/** An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`. */
|
|
117717
|
+
/** An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`. */
|
|
116456
117718
|
interface InkAnalysisWordUpdateData {
|
|
116457
117719
|
/**
|
|
116458
117720
|
* Reference to the parent InkAnalysisLine.
|
|
@@ -116462,38 +117724,38 @@ declare namespace OneNote {
|
|
|
116462
117724
|
*/
|
|
116463
117725
|
line?: OneNote.Interfaces.InkAnalysisLineUpdateData;
|
|
116464
117726
|
}
|
|
116465
|
-
/** An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ ... })`. */
|
|
117727
|
+
/** An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. */
|
|
116466
117728
|
interface InkAnalysisWordCollectionUpdateData {
|
|
116467
117729
|
items?: OneNote.Interfaces.InkAnalysisWordData[];
|
|
116468
117730
|
}
|
|
116469
|
-
/** An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. */
|
|
117731
|
+
/** An interface for updating data on the `InkStrokeCollection` object, for use in `inkStrokeCollection.set({ ... })`. */
|
|
116470
117732
|
interface InkStrokeCollectionUpdateData {
|
|
116471
117733
|
items?: OneNote.Interfaces.InkStrokeData[];
|
|
116472
117734
|
}
|
|
116473
|
-
/** An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`. */
|
|
117735
|
+
/** An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`. */
|
|
116474
117736
|
interface PointCollectionUpdateData {
|
|
116475
117737
|
items?: OneNote.Interfaces.PointData[];
|
|
116476
117738
|
}
|
|
116477
|
-
/** An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`. */
|
|
117739
|
+
/** An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`. */
|
|
116478
117740
|
interface InkWordCollectionUpdateData {
|
|
116479
117741
|
items?: OneNote.Interfaces.InkWordData[];
|
|
116480
117742
|
}
|
|
116481
|
-
/** An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`. */
|
|
117743
|
+
/** An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. */
|
|
116482
117744
|
interface NotebookCollectionUpdateData {
|
|
116483
117745
|
items?: OneNote.Interfaces.NotebookData[];
|
|
116484
117746
|
}
|
|
116485
|
-
/** An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... })`. */
|
|
117747
|
+
/** An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. */
|
|
116486
117748
|
interface SectionGroupCollectionUpdateData {
|
|
116487
117749
|
items?: OneNote.Interfaces.SectionGroupData[];
|
|
116488
117750
|
}
|
|
116489
|
-
/** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */
|
|
117751
|
+
/** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */
|
|
116490
117752
|
interface SectionCollectionUpdateData {
|
|
116491
117753
|
items?: OneNote.Interfaces.SectionData[];
|
|
116492
117754
|
}
|
|
116493
|
-
/** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
|
|
117755
|
+
/** An interface for updating data on the `Page` object, for use in `page.set({ ... })`. */
|
|
116494
117756
|
interface PageUpdateData {
|
|
116495
117757
|
/**
|
|
116496
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
117758
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read only.
|
|
116497
117759
|
*
|
|
116498
117760
|
* @remarks
|
|
116499
117761
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -116514,11 +117776,11 @@ declare namespace OneNote {
|
|
|
116514
117776
|
*/
|
|
116515
117777
|
title?: string;
|
|
116516
117778
|
}
|
|
116517
|
-
/** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */
|
|
117779
|
+
/** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */
|
|
116518
117780
|
interface PageCollectionUpdateData {
|
|
116519
117781
|
items?: OneNote.Interfaces.PageData[];
|
|
116520
117782
|
}
|
|
116521
|
-
/** An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`. */
|
|
117783
|
+
/** An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`. */
|
|
116522
117784
|
interface PageContentUpdateData {
|
|
116523
117785
|
/**
|
|
116524
117786
|
* Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
|
|
@@ -116542,11 +117804,11 @@ declare namespace OneNote {
|
|
|
116542
117804
|
*/
|
|
116543
117805
|
top?: number;
|
|
116544
117806
|
}
|
|
116545
|
-
/** An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... })`. */
|
|
117807
|
+
/** An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. */
|
|
116546
117808
|
interface PageContentCollectionUpdateData {
|
|
116547
117809
|
items?: OneNote.Interfaces.PageContentData[];
|
|
116548
117810
|
}
|
|
116549
|
-
/** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
|
|
117811
|
+
/** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
|
|
116550
117812
|
interface ParagraphUpdateData {
|
|
116551
117813
|
/**
|
|
116552
117814
|
* Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
|
|
@@ -116556,6 +117818,13 @@ declare namespace OneNote {
|
|
|
116556
117818
|
*/
|
|
116557
117819
|
image?: OneNote.Interfaces.ImageUpdateData;
|
|
116558
117820
|
/**
|
|
117821
|
+
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink.
|
|
117822
|
+
*
|
|
117823
|
+
* @remarks
|
|
117824
|
+
* [Api set: OneNoteApi 1.1]
|
|
117825
|
+
*/
|
|
117826
|
+
richText?: OneNote.Interfaces.RichTextUpdateData;
|
|
117827
|
+
/**
|
|
116559
117828
|
* Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.
|
|
116560
117829
|
*
|
|
116561
117830
|
* @remarks
|
|
@@ -116563,11 +117832,21 @@ declare namespace OneNote {
|
|
|
116563
117832
|
*/
|
|
116564
117833
|
table?: OneNote.Interfaces.TableUpdateData;
|
|
116565
117834
|
}
|
|
116566
|
-
/** An interface for updating data on the ParagraphCollection object, for use in `paragraphCollection.set({ ... })`. */
|
|
117835
|
+
/** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */
|
|
116567
117836
|
interface ParagraphCollectionUpdateData {
|
|
116568
117837
|
items?: OneNote.Interfaces.ParagraphData[];
|
|
116569
117838
|
}
|
|
116570
|
-
/** An interface for updating data on the
|
|
117839
|
+
/** An interface for updating data on the `RichText` object, for use in `richText.set({ ... })`. */
|
|
117840
|
+
interface RichTextUpdateData {
|
|
117841
|
+
/**
|
|
117842
|
+
* Gets the text style of the RichText object. Read-only.
|
|
117843
|
+
*
|
|
117844
|
+
* @remarks
|
|
117845
|
+
* [Api set: OneNoteApi 1.8]
|
|
117846
|
+
*/
|
|
117847
|
+
style?: OneNote.ParagraphStyle;
|
|
117848
|
+
}
|
|
117849
|
+
/** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */
|
|
116571
117850
|
interface ImageUpdateData {
|
|
116572
117851
|
/**
|
|
116573
117852
|
* Gets or sets the description of the Image.
|
|
@@ -116598,7 +117877,7 @@ declare namespace OneNote {
|
|
|
116598
117877
|
*/
|
|
116599
117878
|
width?: number;
|
|
116600
117879
|
}
|
|
116601
|
-
/** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
|
|
117880
|
+
/** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
|
|
116602
117881
|
interface TableUpdateData {
|
|
116603
117882
|
/**
|
|
116604
117883
|
* Gets or sets whether the borders are visible or not. True if they are visible, false if they are hidden.
|
|
@@ -116608,11 +117887,11 @@ declare namespace OneNote {
|
|
|
116608
117887
|
*/
|
|
116609
117888
|
borderVisible?: boolean;
|
|
116610
117889
|
}
|
|
116611
|
-
/** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */
|
|
117890
|
+
/** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */
|
|
116612
117891
|
interface TableRowCollectionUpdateData {
|
|
116613
117892
|
items?: OneNote.Interfaces.TableRowData[];
|
|
116614
117893
|
}
|
|
116615
|
-
/** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */
|
|
117894
|
+
/** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
|
|
116616
117895
|
interface TableCellUpdateData {
|
|
116617
117896
|
/**
|
|
116618
117897
|
* Gets and sets the shading color of the cell
|
|
@@ -116622,7 +117901,7 @@ declare namespace OneNote {
|
|
|
116622
117901
|
*/
|
|
116623
117902
|
shadingColor?: string;
|
|
116624
117903
|
}
|
|
116625
|
-
/** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */
|
|
117904
|
+
/** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
|
|
116626
117905
|
interface TableCellCollectionUpdateData {
|
|
116627
117906
|
items?: OneNote.Interfaces.TableCellData[];
|
|
116628
117907
|
}
|
|
@@ -116843,21 +118122,21 @@ declare namespace OneNote {
|
|
|
116843
118122
|
*/
|
|
116844
118123
|
sectionGroups?: OneNote.Interfaces.SectionGroupData[];
|
|
116845
118124
|
/**
|
|
116846
|
-
* The sections of the notebook. Read
|
|
118125
|
+
* The sections of the notebook. Read-only.
|
|
116847
118126
|
*
|
|
116848
118127
|
* @remarks
|
|
116849
118128
|
* [Api set: OneNoteApi 1.1]
|
|
116850
118129
|
*/
|
|
116851
118130
|
sections?: OneNote.Interfaces.SectionData[];
|
|
116852
118131
|
/**
|
|
116853
|
-
* The
|
|
118132
|
+
* The URL of the site where this notebook is located. Read.only.
|
|
116854
118133
|
*
|
|
116855
118134
|
* @remarks
|
|
116856
118135
|
* [Api set: OneNoteApi 1.1]
|
|
116857
118136
|
*/
|
|
116858
118137
|
baseUrl?: string;
|
|
116859
118138
|
/**
|
|
116860
|
-
* The client
|
|
118139
|
+
* The client URL of the notebook. Read-only.
|
|
116861
118140
|
*
|
|
116862
118141
|
* @remarks
|
|
116863
118142
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -116871,7 +118150,7 @@ declare namespace OneNote {
|
|
|
116871
118150
|
*/
|
|
116872
118151
|
id?: string;
|
|
116873
118152
|
/**
|
|
116874
|
-
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read
|
|
118153
|
+
* True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read-only.
|
|
116875
118154
|
*
|
|
116876
118155
|
* @remarks
|
|
116877
118156
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -116990,14 +118269,14 @@ declare namespace OneNote {
|
|
|
116990
118269
|
/** An interface describing the data returned by calling `page.toJSON()`. */
|
|
116991
118270
|
interface PageData {
|
|
116992
118271
|
/**
|
|
116993
|
-
* The collection of PageContent objects on the page. Read
|
|
118272
|
+
* The collection of PageContent objects on the page. Read-only.
|
|
116994
118273
|
*
|
|
116995
118274
|
* @remarks
|
|
116996
118275
|
* [Api set: OneNoteApi 1.1]
|
|
116997
118276
|
*/
|
|
116998
118277
|
contents?: OneNote.Interfaces.PageContentData[];
|
|
116999
118278
|
/**
|
|
117000
|
-
* Text interpretation for the ink on the page. Returns null if there
|
|
118279
|
+
* Text interpretation for the ink on the page. Returns null if there's no ink analysis information.
|
|
117001
118280
|
*
|
|
117002
118281
|
* @remarks
|
|
117003
118282
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -117011,7 +118290,7 @@ declare namespace OneNote {
|
|
|
117011
118290
|
*/
|
|
117012
118291
|
classNotebookPageSource?: string;
|
|
117013
118292
|
/**
|
|
117014
|
-
* The client url of the page. Read
|
|
118293
|
+
* The client url of the page. Read-only.
|
|
117015
118294
|
*
|
|
117016
118295
|
* @remarks
|
|
117017
118296
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -117039,7 +118318,7 @@ declare namespace OneNote {
|
|
|
117039
118318
|
*/
|
|
117040
118319
|
title?: string;
|
|
117041
118320
|
/**
|
|
117042
|
-
* The web
|
|
118321
|
+
* The web URL of the page. Read-only.
|
|
117043
118322
|
*
|
|
117044
118323
|
* @remarks
|
|
117045
118324
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -117147,7 +118426,7 @@ declare namespace OneNote {
|
|
|
117147
118426
|
*/
|
|
117148
118427
|
paragraphs?: OneNote.Interfaces.ParagraphData[];
|
|
117149
118428
|
/**
|
|
117150
|
-
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType
|
|
118429
|
+
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink. Read-only.
|
|
117151
118430
|
*
|
|
117152
118431
|
* @remarks
|
|
117153
118432
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -117402,7 +118681,7 @@ declare namespace OneNote {
|
|
|
117402
118681
|
*/
|
|
117403
118682
|
interface ApplicationLoadOptions {
|
|
117404
118683
|
/**
|
|
117405
|
-
Specifying `$all` for the
|
|
118684
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117406
118685
|
*/
|
|
117407
118686
|
$all?: boolean;
|
|
117408
118687
|
/**
|
|
@@ -117421,7 +118700,7 @@ declare namespace OneNote {
|
|
|
117421
118700
|
*/
|
|
117422
118701
|
interface InkAnalysisLoadOptions {
|
|
117423
118702
|
/**
|
|
117424
|
-
Specifying `$all` for the
|
|
118703
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117425
118704
|
*/
|
|
117426
118705
|
$all?: boolean;
|
|
117427
118706
|
/**
|
|
@@ -117447,7 +118726,7 @@ declare namespace OneNote {
|
|
|
117447
118726
|
*/
|
|
117448
118727
|
interface InkAnalysisParagraphLoadOptions {
|
|
117449
118728
|
/**
|
|
117450
|
-
Specifying `$all` for the
|
|
118729
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117451
118730
|
*/
|
|
117452
118731
|
$all?: boolean;
|
|
117453
118732
|
/**
|
|
@@ -117480,7 +118759,7 @@ declare namespace OneNote {
|
|
|
117480
118759
|
*/
|
|
117481
118760
|
interface InkAnalysisParagraphCollectionLoadOptions {
|
|
117482
118761
|
/**
|
|
117483
|
-
Specifying `$all` for the
|
|
118762
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117484
118763
|
*/
|
|
117485
118764
|
$all?: boolean;
|
|
117486
118765
|
/**
|
|
@@ -117513,7 +118792,7 @@ declare namespace OneNote {
|
|
|
117513
118792
|
*/
|
|
117514
118793
|
interface InkAnalysisLineLoadOptions {
|
|
117515
118794
|
/**
|
|
117516
|
-
Specifying `$all` for the
|
|
118795
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117517
118796
|
*/
|
|
117518
118797
|
$all?: boolean;
|
|
117519
118798
|
/**
|
|
@@ -117546,7 +118825,7 @@ declare namespace OneNote {
|
|
|
117546
118825
|
*/
|
|
117547
118826
|
interface InkAnalysisLineCollectionLoadOptions {
|
|
117548
118827
|
/**
|
|
117549
|
-
Specifying `$all` for the
|
|
118828
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117550
118829
|
*/
|
|
117551
118830
|
$all?: boolean;
|
|
117552
118831
|
/**
|
|
@@ -117579,7 +118858,7 @@ declare namespace OneNote {
|
|
|
117579
118858
|
*/
|
|
117580
118859
|
interface InkAnalysisWordLoadOptions {
|
|
117581
118860
|
/**
|
|
117582
|
-
Specifying `$all` for the
|
|
118861
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117583
118862
|
*/
|
|
117584
118863
|
$all?: boolean;
|
|
117585
118864
|
/**
|
|
@@ -117626,7 +118905,7 @@ declare namespace OneNote {
|
|
|
117626
118905
|
*/
|
|
117627
118906
|
interface InkAnalysisWordCollectionLoadOptions {
|
|
117628
118907
|
/**
|
|
117629
|
-
Specifying `$all` for the
|
|
118908
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117630
118909
|
*/
|
|
117631
118910
|
$all?: boolean;
|
|
117632
118911
|
/**
|
|
@@ -117673,7 +118952,7 @@ declare namespace OneNote {
|
|
|
117673
118952
|
*/
|
|
117674
118953
|
interface FloatingInkLoadOptions {
|
|
117675
118954
|
/**
|
|
117676
|
-
Specifying `$all` for the
|
|
118955
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117677
118956
|
*/
|
|
117678
118957
|
$all?: boolean;
|
|
117679
118958
|
/**
|
|
@@ -117706,7 +118985,7 @@ declare namespace OneNote {
|
|
|
117706
118985
|
*/
|
|
117707
118986
|
interface InkStrokeLoadOptions {
|
|
117708
118987
|
/**
|
|
117709
|
-
Specifying `$all` for the
|
|
118988
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117710
118989
|
*/
|
|
117711
118990
|
$all?: boolean;
|
|
117712
118991
|
/**
|
|
@@ -117732,7 +119011,7 @@ declare namespace OneNote {
|
|
|
117732
119011
|
*/
|
|
117733
119012
|
interface InkStrokeCollectionLoadOptions {
|
|
117734
119013
|
/**
|
|
117735
|
-
Specifying `$all` for the
|
|
119014
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117736
119015
|
*/
|
|
117737
119016
|
$all?: boolean;
|
|
117738
119017
|
/**
|
|
@@ -117758,7 +119037,7 @@ declare namespace OneNote {
|
|
|
117758
119037
|
*/
|
|
117759
119038
|
interface PointLoadOptions {
|
|
117760
119039
|
/**
|
|
117761
|
-
Specifying `$all` for the
|
|
119040
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117762
119041
|
*/
|
|
117763
119042
|
$all?: boolean;
|
|
117764
119043
|
/**
|
|
@@ -117779,7 +119058,7 @@ declare namespace OneNote {
|
|
|
117779
119058
|
*/
|
|
117780
119059
|
interface PointCollectionLoadOptions {
|
|
117781
119060
|
/**
|
|
117782
|
-
Specifying `$all` for the
|
|
119061
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117783
119062
|
*/
|
|
117784
119063
|
$all?: boolean;
|
|
117785
119064
|
/**
|
|
@@ -117806,7 +119085,7 @@ declare namespace OneNote {
|
|
|
117806
119085
|
*/
|
|
117807
119086
|
interface InkWordLoadOptions {
|
|
117808
119087
|
/**
|
|
117809
|
-
Specifying `$all` for the
|
|
119088
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117810
119089
|
*/
|
|
117811
119090
|
$all?: boolean;
|
|
117812
119091
|
/**
|
|
@@ -117846,7 +119125,7 @@ declare namespace OneNote {
|
|
|
117846
119125
|
*/
|
|
117847
119126
|
interface InkWordCollectionLoadOptions {
|
|
117848
119127
|
/**
|
|
117849
|
-
Specifying `$all` for the
|
|
119128
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117850
119129
|
*/
|
|
117851
119130
|
$all?: boolean;
|
|
117852
119131
|
/**
|
|
@@ -117886,32 +119165,32 @@ declare namespace OneNote {
|
|
|
117886
119165
|
*/
|
|
117887
119166
|
interface NotebookLoadOptions {
|
|
117888
119167
|
/**
|
|
117889
|
-
Specifying `$all` for the
|
|
119168
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117890
119169
|
*/
|
|
117891
119170
|
$all?: boolean;
|
|
117892
119171
|
/**
|
|
117893
|
-
* The section groups in the notebook. Read
|
|
119172
|
+
* The section groups in the notebook. Read-only.
|
|
117894
119173
|
*
|
|
117895
119174
|
* @remarks
|
|
117896
119175
|
* [Api set: OneNoteApi 1.1]
|
|
117897
119176
|
*/
|
|
117898
119177
|
sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
|
|
117899
119178
|
/**
|
|
117900
|
-
* The sections of the notebook. Read
|
|
119179
|
+
* The sections of the notebook. Read-only.
|
|
117901
119180
|
*
|
|
117902
119181
|
* @remarks
|
|
117903
119182
|
* [Api set: OneNoteApi 1.1]
|
|
117904
119183
|
*/
|
|
117905
119184
|
sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
|
|
117906
119185
|
/**
|
|
117907
|
-
* The
|
|
119186
|
+
* The URL of the site where this notebook is located. Read-only.
|
|
117908
119187
|
*
|
|
117909
119188
|
* @remarks
|
|
117910
119189
|
* [Api set: OneNoteApi 1.1]
|
|
117911
119190
|
*/
|
|
117912
119191
|
baseUrl?: boolean;
|
|
117913
119192
|
/**
|
|
117914
|
-
* The client
|
|
119193
|
+
* The client URL of the notebook. Read-only.
|
|
117915
119194
|
*
|
|
117916
119195
|
* @remarks
|
|
117917
119196
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -117925,7 +119204,7 @@ declare namespace OneNote {
|
|
|
117925
119204
|
*/
|
|
117926
119205
|
id?: boolean;
|
|
117927
119206
|
/**
|
|
117928
|
-
* True if the notebook
|
|
119207
|
+
* True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
|
|
117929
119208
|
*
|
|
117930
119209
|
* @remarks
|
|
117931
119210
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -117947,7 +119226,7 @@ declare namespace OneNote {
|
|
|
117947
119226
|
*/
|
|
117948
119227
|
interface NotebookCollectionLoadOptions {
|
|
117949
119228
|
/**
|
|
117950
|
-
Specifying `$all` for the
|
|
119229
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
117951
119230
|
*/
|
|
117952
119231
|
$all?: boolean;
|
|
117953
119232
|
/**
|
|
@@ -117958,21 +119237,21 @@ declare namespace OneNote {
|
|
|
117958
119237
|
*/
|
|
117959
119238
|
sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
|
|
117960
119239
|
/**
|
|
117961
|
-
* For EACH ITEM in the collection: The sections of the notebook. Read
|
|
119240
|
+
* For EACH ITEM in the collection: The sections of the notebook. Read-only.
|
|
117962
119241
|
*
|
|
117963
119242
|
* @remarks
|
|
117964
119243
|
* [Api set: OneNoteApi 1.1]
|
|
117965
119244
|
*/
|
|
117966
119245
|
sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
|
|
117967
119246
|
/**
|
|
117968
|
-
* For EACH ITEM in the collection: The
|
|
119247
|
+
* For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only.
|
|
117969
119248
|
*
|
|
117970
119249
|
* @remarks
|
|
117971
119250
|
* [Api set: OneNoteApi 1.1]
|
|
117972
119251
|
*/
|
|
117973
119252
|
baseUrl?: boolean;
|
|
117974
119253
|
/**
|
|
117975
|
-
* For EACH ITEM in the collection: The client
|
|
119254
|
+
* For EACH ITEM in the collection: The client URL of the notebook. Read-only.
|
|
117976
119255
|
*
|
|
117977
119256
|
* @remarks
|
|
117978
119257
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118008,7 +119287,7 @@ declare namespace OneNote {
|
|
|
118008
119287
|
*/
|
|
118009
119288
|
interface SectionGroupLoadOptions {
|
|
118010
119289
|
/**
|
|
118011
|
-
Specifying `$all` for the
|
|
119290
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118012
119291
|
*/
|
|
118013
119292
|
$all?: boolean;
|
|
118014
119293
|
/**
|
|
@@ -118076,7 +119355,7 @@ declare namespace OneNote {
|
|
|
118076
119355
|
*/
|
|
118077
119356
|
interface SectionGroupCollectionLoadOptions {
|
|
118078
119357
|
/**
|
|
118079
|
-
Specifying `$all` for the
|
|
119358
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118080
119359
|
*/
|
|
118081
119360
|
$all?: boolean;
|
|
118082
119361
|
/**
|
|
@@ -118144,7 +119423,7 @@ declare namespace OneNote {
|
|
|
118144
119423
|
*/
|
|
118145
119424
|
interface SectionLoadOptions {
|
|
118146
119425
|
/**
|
|
118147
|
-
Specifying `$all` for the
|
|
119426
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118148
119427
|
*/
|
|
118149
119428
|
$all?: boolean;
|
|
118150
119429
|
/**
|
|
@@ -118155,7 +119434,7 @@ declare namespace OneNote {
|
|
|
118155
119434
|
*/
|
|
118156
119435
|
notebook?: OneNote.Interfaces.NotebookLoadOptions;
|
|
118157
119436
|
/**
|
|
118158
|
-
* The collection of pages in the section. Read
|
|
119437
|
+
* The collection of pages in the section. Read-only.
|
|
118159
119438
|
*
|
|
118160
119439
|
* @remarks
|
|
118161
119440
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118176,7 +119455,7 @@ declare namespace OneNote {
|
|
|
118176
119455
|
*/
|
|
118177
119456
|
parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;
|
|
118178
119457
|
/**
|
|
118179
|
-
* The client url of the section. Read
|
|
119458
|
+
* The client url of the section. Read-only.
|
|
118180
119459
|
*
|
|
118181
119460
|
* @remarks
|
|
118182
119461
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118190,7 +119469,7 @@ declare namespace OneNote {
|
|
|
118190
119469
|
*/
|
|
118191
119470
|
id?: boolean;
|
|
118192
119471
|
/**
|
|
118193
|
-
* True if this section is encrypted with a password. Read
|
|
119472
|
+
* True if this section is encrypted with a password. Read-only.
|
|
118194
119473
|
*
|
|
118195
119474
|
* @remarks
|
|
118196
119475
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -118211,7 +119490,7 @@ declare namespace OneNote {
|
|
|
118211
119490
|
*/
|
|
118212
119491
|
name?: boolean;
|
|
118213
119492
|
/**
|
|
118214
|
-
* The web url of the page. Read
|
|
119493
|
+
* The web url of the page. Read-only.
|
|
118215
119494
|
*
|
|
118216
119495
|
* @remarks
|
|
118217
119496
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118226,7 +119505,7 @@ declare namespace OneNote {
|
|
|
118226
119505
|
*/
|
|
118227
119506
|
interface SectionCollectionLoadOptions {
|
|
118228
119507
|
/**
|
|
118229
|
-
Specifying `$all` for the
|
|
119508
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118230
119509
|
*/
|
|
118231
119510
|
$all?: boolean;
|
|
118232
119511
|
/**
|
|
@@ -118258,7 +119537,7 @@ declare namespace OneNote {
|
|
|
118258
119537
|
*/
|
|
118259
119538
|
parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;
|
|
118260
119539
|
/**
|
|
118261
|
-
* For EACH ITEM in the collection: The client
|
|
119540
|
+
* For EACH ITEM in the collection: The client URL of the section. Read-only.
|
|
118262
119541
|
*
|
|
118263
119542
|
* @remarks
|
|
118264
119543
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118279,7 +119558,7 @@ declare namespace OneNote {
|
|
|
118279
119558
|
*/
|
|
118280
119559
|
isEncrypted?: boolean;
|
|
118281
119560
|
/**
|
|
118282
|
-
* For EACH ITEM in the collection: True if this section is locked. Read
|
|
119561
|
+
* For EACH ITEM in the collection: True if this section is locked. Read-only.
|
|
118283
119562
|
*
|
|
118284
119563
|
* @remarks
|
|
118285
119564
|
* [Api set: OneNoteApi 1.2]
|
|
@@ -118293,7 +119572,7 @@ declare namespace OneNote {
|
|
|
118293
119572
|
*/
|
|
118294
119573
|
name?: boolean;
|
|
118295
119574
|
/**
|
|
118296
|
-
* For EACH ITEM in the collection: The web
|
|
119575
|
+
* For EACH ITEM in the collection: The web URL of the page. Read-only.
|
|
118297
119576
|
*
|
|
118298
119577
|
* @remarks
|
|
118299
119578
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118308,18 +119587,18 @@ declare namespace OneNote {
|
|
|
118308
119587
|
*/
|
|
118309
119588
|
interface PageLoadOptions {
|
|
118310
119589
|
/**
|
|
118311
|
-
Specifying `$all` for the
|
|
119590
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118312
119591
|
*/
|
|
118313
119592
|
$all?: boolean;
|
|
118314
119593
|
/**
|
|
118315
|
-
* The collection of PageContent objects on the page. Read
|
|
119594
|
+
* The collection of PageContent objects on the page. Read-only.
|
|
118316
119595
|
*
|
|
118317
119596
|
* @remarks
|
|
118318
119597
|
* [Api set: OneNoteApi 1.1]
|
|
118319
119598
|
*/
|
|
118320
119599
|
contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
|
|
118321
119600
|
/**
|
|
118322
|
-
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
|
|
119601
|
+
* Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only.
|
|
118323
119602
|
*
|
|
118324
119603
|
* @remarks
|
|
118325
119604
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118368,7 +119647,7 @@ declare namespace OneNote {
|
|
|
118368
119647
|
*/
|
|
118369
119648
|
title?: boolean;
|
|
118370
119649
|
/**
|
|
118371
|
-
* The web url of the page. Read
|
|
119650
|
+
* The web url of the page. Read-only.
|
|
118372
119651
|
*
|
|
118373
119652
|
* @remarks
|
|
118374
119653
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118383,7 +119662,7 @@ declare namespace OneNote {
|
|
|
118383
119662
|
*/
|
|
118384
119663
|
interface PageCollectionLoadOptions {
|
|
118385
119664
|
/**
|
|
118386
|
-
Specifying `$all` for the
|
|
119665
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118387
119666
|
*/
|
|
118388
119667
|
$all?: boolean;
|
|
118389
119668
|
/**
|
|
@@ -118394,7 +119673,7 @@ declare namespace OneNote {
|
|
|
118394
119673
|
*/
|
|
118395
119674
|
contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
|
|
118396
119675
|
/**
|
|
118397
|
-
* For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there
|
|
119676
|
+
* For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there's no ink analysis information. Read-only.
|
|
118398
119677
|
*
|
|
118399
119678
|
* @remarks
|
|
118400
119679
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118458,18 +119737,18 @@ declare namespace OneNote {
|
|
|
118458
119737
|
*/
|
|
118459
119738
|
interface PageContentLoadOptions {
|
|
118460
119739
|
/**
|
|
118461
|
-
Specifying `$all` for the
|
|
119740
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118462
119741
|
*/
|
|
118463
119742
|
$all?: boolean;
|
|
118464
119743
|
/**
|
|
118465
|
-
* Gets the Image in the PageContent object. Throws an exception if PageContentType
|
|
119744
|
+
* Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
|
|
118466
119745
|
*
|
|
118467
119746
|
* @remarks
|
|
118468
119747
|
* [Api set: OneNoteApi 1.1]
|
|
118469
119748
|
*/
|
|
118470
119749
|
image?: OneNote.Interfaces.ImageLoadOptions;
|
|
118471
119750
|
/**
|
|
118472
|
-
* Gets the ink in the PageContent object. Throws an exception if PageContentType
|
|
119751
|
+
* Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
|
|
118473
119752
|
*
|
|
118474
119753
|
* @remarks
|
|
118475
119754
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118526,18 +119805,18 @@ declare namespace OneNote {
|
|
|
118526
119805
|
*/
|
|
118527
119806
|
interface PageContentCollectionLoadOptions {
|
|
118528
119807
|
/**
|
|
118529
|
-
Specifying `$all` for the
|
|
119808
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118530
119809
|
*/
|
|
118531
119810
|
$all?: boolean;
|
|
118532
119811
|
/**
|
|
118533
|
-
* For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType
|
|
119812
|
+
* For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
|
|
118534
119813
|
*
|
|
118535
119814
|
* @remarks
|
|
118536
119815
|
* [Api set: OneNoteApi 1.1]
|
|
118537
119816
|
*/
|
|
118538
119817
|
image?: OneNote.Interfaces.ImageLoadOptions;
|
|
118539
119818
|
/**
|
|
118540
|
-
* For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType
|
|
119819
|
+
* For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
|
|
118541
119820
|
*
|
|
118542
119821
|
* @remarks
|
|
118543
119822
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118594,7 +119873,7 @@ declare namespace OneNote {
|
|
|
118594
119873
|
*/
|
|
118595
119874
|
interface OutlineLoadOptions {
|
|
118596
119875
|
/**
|
|
118597
|
-
Specifying `$all` for the
|
|
119876
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118598
119877
|
*/
|
|
118599
119878
|
$all?: boolean;
|
|
118600
119879
|
/**
|
|
@@ -118627,18 +119906,18 @@ declare namespace OneNote {
|
|
|
118627
119906
|
*/
|
|
118628
119907
|
interface ParagraphLoadOptions {
|
|
118629
119908
|
/**
|
|
118630
|
-
Specifying `$all` for the
|
|
119909
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118631
119910
|
*/
|
|
118632
119911
|
$all?: boolean;
|
|
118633
119912
|
/**
|
|
118634
|
-
* Gets the Image object in the Paragraph. Throws an exception if ParagraphType
|
|
119913
|
+
* Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
|
|
118635
119914
|
*
|
|
118636
119915
|
* @remarks
|
|
118637
119916
|
* [Api set: OneNoteApi 1.1]
|
|
118638
119917
|
*/
|
|
118639
119918
|
image?: OneNote.Interfaces.ImageLoadOptions;
|
|
118640
119919
|
/**
|
|
118641
|
-
* Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType
|
|
119920
|
+
* Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
|
|
118642
119921
|
*
|
|
118643
119922
|
* @remarks
|
|
118644
119923
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118652,28 +119931,28 @@ declare namespace OneNote {
|
|
|
118652
119931
|
*/
|
|
118653
119932
|
outline?: OneNote.Interfaces.OutlineLoadOptions;
|
|
118654
119933
|
/**
|
|
118655
|
-
* The collection of paragraphs under this paragraph. Read
|
|
119934
|
+
* The collection of paragraphs under this paragraph. Read-only.
|
|
118656
119935
|
*
|
|
118657
119936
|
* @remarks
|
|
118658
119937
|
* [Api set: OneNoteApi 1.1]
|
|
118659
119938
|
*/
|
|
118660
119939
|
paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
|
|
118661
119940
|
/**
|
|
118662
|
-
* Gets the parent paragraph object. Throws if a parent paragraph
|
|
119941
|
+
* Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
|
|
118663
119942
|
*
|
|
118664
119943
|
* @remarks
|
|
118665
119944
|
* [Api set: OneNoteApi 1.1]
|
|
118666
119945
|
*/
|
|
118667
119946
|
parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;
|
|
118668
119947
|
/**
|
|
118669
|
-
* Gets the parent paragraph object. Returns null if a parent paragraph
|
|
119948
|
+
* Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
|
|
118670
119949
|
*
|
|
118671
119950
|
* @remarks
|
|
118672
119951
|
* [Api set: OneNoteApi 1.1]
|
|
118673
119952
|
*/
|
|
118674
119953
|
parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;
|
|
118675
119954
|
/**
|
|
118676
|
-
* Gets the TableCell object that contains the Paragraph if one exists. If parent
|
|
119955
|
+
* Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
|
|
118677
119956
|
*
|
|
118678
119957
|
* @remarks
|
|
118679
119958
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118687,14 +119966,14 @@ declare namespace OneNote {
|
|
|
118687
119966
|
*/
|
|
118688
119967
|
parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions;
|
|
118689
119968
|
/**
|
|
118690
|
-
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType
|
|
119969
|
+
* Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText.
|
|
118691
119970
|
*
|
|
118692
119971
|
* @remarks
|
|
118693
119972
|
* [Api set: OneNoteApi 1.1]
|
|
118694
119973
|
*/
|
|
118695
119974
|
richText?: OneNote.Interfaces.RichTextLoadOptions;
|
|
118696
119975
|
/**
|
|
118697
|
-
* Gets the Table object in the Paragraph. Throws an exception if ParagraphType
|
|
119976
|
+
* Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
|
|
118698
119977
|
*
|
|
118699
119978
|
* @remarks
|
|
118700
119979
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118723,18 +120002,18 @@ declare namespace OneNote {
|
|
|
118723
120002
|
*/
|
|
118724
120003
|
interface ParagraphCollectionLoadOptions {
|
|
118725
120004
|
/**
|
|
118726
|
-
Specifying `$all` for the
|
|
120005
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118727
120006
|
*/
|
|
118728
120007
|
$all?: boolean;
|
|
118729
120008
|
/**
|
|
118730
|
-
* For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType
|
|
120009
|
+
* For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
|
|
118731
120010
|
*
|
|
118732
120011
|
* @remarks
|
|
118733
120012
|
* [Api set: OneNoteApi 1.1]
|
|
118734
120013
|
*/
|
|
118735
120014
|
image?: OneNote.Interfaces.ImageLoadOptions;
|
|
118736
120015
|
/**
|
|
118737
|
-
* For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType
|
|
120016
|
+
* For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
|
|
118738
120017
|
*
|
|
118739
120018
|
* @remarks
|
|
118740
120019
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118748,49 +120027,49 @@ declare namespace OneNote {
|
|
|
118748
120027
|
*/
|
|
118749
120028
|
outline?: OneNote.Interfaces.OutlineLoadOptions;
|
|
118750
120029
|
/**
|
|
118751
|
-
* For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read
|
|
120030
|
+
* For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.
|
|
118752
120031
|
*
|
|
118753
120032
|
* @remarks
|
|
118754
120033
|
* [Api set: OneNoteApi 1.1]
|
|
118755
120034
|
*/
|
|
118756
120035
|
paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
|
|
118757
120036
|
/**
|
|
118758
|
-
* For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph
|
|
120037
|
+
* For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
|
|
118759
120038
|
*
|
|
118760
120039
|
* @remarks
|
|
118761
120040
|
* [Api set: OneNoteApi 1.1]
|
|
118762
120041
|
*/
|
|
118763
120042
|
parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;
|
|
118764
120043
|
/**
|
|
118765
|
-
* For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph
|
|
120044
|
+
* For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
|
|
118766
120045
|
*
|
|
118767
120046
|
* @remarks
|
|
118768
120047
|
* [Api set: OneNoteApi 1.1]
|
|
118769
120048
|
*/
|
|
118770
120049
|
parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;
|
|
118771
120050
|
/**
|
|
118772
|
-
* For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent
|
|
120051
|
+
* For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
|
|
118773
120052
|
*
|
|
118774
120053
|
* @remarks
|
|
118775
120054
|
* [Api set: OneNoteApi 1.1]
|
|
118776
120055
|
*/
|
|
118777
120056
|
parentTableCell?: OneNote.Interfaces.TableCellLoadOptions;
|
|
118778
120057
|
/**
|
|
118779
|
-
* For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent
|
|
120058
|
+
* For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, returns null.
|
|
118780
120059
|
*
|
|
118781
120060
|
* @remarks
|
|
118782
120061
|
* [Api set: OneNoteApi 1.1]
|
|
118783
120062
|
*/
|
|
118784
120063
|
parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions;
|
|
118785
120064
|
/**
|
|
118786
|
-
* For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType
|
|
120065
|
+
* For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink.
|
|
118787
120066
|
*
|
|
118788
120067
|
* @remarks
|
|
118789
120068
|
* [Api set: OneNoteApi 1.1]
|
|
118790
120069
|
*/
|
|
118791
120070
|
richText?: OneNote.Interfaces.RichTextLoadOptions;
|
|
118792
120071
|
/**
|
|
118793
|
-
* For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType
|
|
120072
|
+
* For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
|
|
118794
120073
|
*
|
|
118795
120074
|
* @remarks
|
|
118796
120075
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118819,7 +120098,7 @@ declare namespace OneNote {
|
|
|
118819
120098
|
*/
|
|
118820
120099
|
interface NoteTagLoadOptions {
|
|
118821
120100
|
/**
|
|
118822
|
-
Specifying `$all` for the
|
|
120101
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118823
120102
|
*/
|
|
118824
120103
|
$all?: boolean;
|
|
118825
120104
|
/**
|
|
@@ -118852,7 +120131,7 @@ declare namespace OneNote {
|
|
|
118852
120131
|
*/
|
|
118853
120132
|
interface RichTextLoadOptions {
|
|
118854
120133
|
/**
|
|
118855
|
-
Specifying `$all` for the
|
|
120134
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118856
120135
|
*/
|
|
118857
120136
|
$all?: boolean;
|
|
118858
120137
|
/**
|
|
@@ -118899,7 +120178,7 @@ declare namespace OneNote {
|
|
|
118899
120178
|
*/
|
|
118900
120179
|
interface ImageLoadOptions {
|
|
118901
120180
|
/**
|
|
118902
|
-
Specifying `$all` for the
|
|
120181
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118903
120182
|
*/
|
|
118904
120183
|
$all?: boolean;
|
|
118905
120184
|
/**
|
|
@@ -118910,7 +120189,7 @@ declare namespace OneNote {
|
|
|
118910
120189
|
*/
|
|
118911
120190
|
pageContent?: OneNote.Interfaces.PageContentLoadOptions;
|
|
118912
120191
|
/**
|
|
118913
|
-
* Gets the Paragraph object that contains the Image. Throws if the Image
|
|
120192
|
+
* Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph.
|
|
118914
120193
|
*
|
|
118915
120194
|
* @remarks
|
|
118916
120195
|
* [Api set: OneNoteApi 1.1]
|
|
@@ -118967,7 +120246,7 @@ declare namespace OneNote {
|
|
|
118967
120246
|
*/
|
|
118968
120247
|
interface TableLoadOptions {
|
|
118969
120248
|
/**
|
|
118970
|
-
Specifying `$all` for the
|
|
120249
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118971
120250
|
*/
|
|
118972
120251
|
$all?: boolean;
|
|
118973
120252
|
/**
|
|
@@ -119021,7 +120300,7 @@ declare namespace OneNote {
|
|
|
119021
120300
|
*/
|
|
119022
120301
|
interface TableRowLoadOptions {
|
|
119023
120302
|
/**
|
|
119024
|
-
Specifying `$all` for the
|
|
120303
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119025
120304
|
*/
|
|
119026
120305
|
$all?: boolean;
|
|
119027
120306
|
/**
|
|
@@ -119068,7 +120347,7 @@ declare namespace OneNote {
|
|
|
119068
120347
|
*/
|
|
119069
120348
|
interface TableRowCollectionLoadOptions {
|
|
119070
120349
|
/**
|
|
119071
|
-
Specifying `$all` for the
|
|
120350
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119072
120351
|
*/
|
|
119073
120352
|
$all?: boolean;
|
|
119074
120353
|
/**
|
|
@@ -119115,7 +120394,7 @@ declare namespace OneNote {
|
|
|
119115
120394
|
*/
|
|
119116
120395
|
interface TableCellLoadOptions {
|
|
119117
120396
|
/**
|
|
119118
|
-
Specifying `$all` for the
|
|
120397
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119119
120398
|
*/
|
|
119120
120399
|
$all?: boolean;
|
|
119121
120400
|
/**
|
|
@@ -119169,7 +120448,7 @@ declare namespace OneNote {
|
|
|
119169
120448
|
*/
|
|
119170
120449
|
interface TableCellCollectionLoadOptions {
|
|
119171
120450
|
/**
|
|
119172
|
-
Specifying `$all` for the
|
|
120451
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119173
120452
|
*/
|
|
119174
120453
|
$all?: boolean;
|
|
119175
120454
|
/**
|
|
@@ -119532,10 +120811,6 @@ declare namespace Visio {
|
|
|
119532
120811
|
* 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.
|
|
119533
120812
|
*/
|
|
119534
120813
|
toJSON(): Visio.Interfaces.ApplicationData;
|
|
119535
|
-
/**
|
|
119536
|
-
* Set mock data
|
|
119537
|
-
*/
|
|
119538
|
-
setMockData(data: Visio.Interfaces.ApplicationData): void;
|
|
119539
120814
|
}
|
|
119540
120815
|
/**
|
|
119541
120816
|
* Represents the Document class.
|
|
@@ -119612,7 +120887,7 @@ declare namespace Visio {
|
|
|
119612
120887
|
*
|
|
119613
120888
|
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
119614
120889
|
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
|
|
119615
|
-
* @param show Optional Parameter. If it
|
|
120890
|
+
* @param show Optional Parameter. If it's set to false, it will hide the specified task pane.
|
|
119616
120891
|
*/
|
|
119617
120892
|
showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
|
|
119618
120893
|
/**
|
|
@@ -119653,7 +120928,7 @@ declare namespace Visio {
|
|
|
119653
120928
|
*/
|
|
119654
120929
|
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
|
|
119655
120930
|
/**
|
|
119656
|
-
* Occurs when
|
|
120931
|
+
* Occurs when an expected or unexpected error occurred in the session.
|
|
119657
120932
|
*
|
|
119658
120933
|
* @remarks
|
|
119659
120934
|
* [Api set: 1.1]
|
|
@@ -119720,10 +120995,6 @@ declare namespace Visio {
|
|
|
119720
120995
|
* 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.
|
|
119721
120996
|
*/
|
|
119722
120997
|
toJSON(): Visio.Interfaces.DocumentData;
|
|
119723
|
-
/**
|
|
119724
|
-
* Set mock data
|
|
119725
|
-
*/
|
|
119726
|
-
setMockData(data: Visio.Interfaces.DocumentData): void;
|
|
119727
120998
|
}
|
|
119728
120999
|
/**
|
|
119729
121000
|
* Represents the DocumentView class.
|
|
@@ -119803,10 +121074,6 @@ declare namespace Visio {
|
|
|
119803
121074
|
* 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.
|
|
119804
121075
|
*/
|
|
119805
121076
|
toJSON(): Visio.Interfaces.DocumentViewData;
|
|
119806
|
-
/**
|
|
119807
|
-
* Set mock data
|
|
119808
|
-
*/
|
|
119809
|
-
setMockData(data: Visio.Interfaces.DocumentViewData): void;
|
|
119810
121077
|
}
|
|
119811
121078
|
/**
|
|
119812
121079
|
* Represents the Page class.
|
|
@@ -119921,10 +121188,6 @@ declare namespace Visio {
|
|
|
119921
121188
|
* 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.
|
|
119922
121189
|
*/
|
|
119923
121190
|
toJSON(): Visio.Interfaces.PageData;
|
|
119924
|
-
/**
|
|
119925
|
-
* Set mock data
|
|
119926
|
-
*/
|
|
119927
|
-
setMockData(data: Visio.Interfaces.PageData): void;
|
|
119928
121191
|
}
|
|
119929
121192
|
/**
|
|
119930
121193
|
* Represents the PageView class.
|
|
@@ -120024,10 +121287,6 @@ declare namespace Visio {
|
|
|
120024
121287
|
* 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.
|
|
120025
121288
|
*/
|
|
120026
121289
|
toJSON(): Visio.Interfaces.PageViewData;
|
|
120027
|
-
/**
|
|
120028
|
-
* Set mock data
|
|
120029
|
-
*/
|
|
120030
|
-
setMockData(data: Visio.Interfaces.PageViewData): void;
|
|
120031
121290
|
}
|
|
120032
121291
|
/**
|
|
120033
121292
|
* Represents a collection of Page objects that are part of the document.
|
|
@@ -120079,10 +121338,6 @@ declare namespace Visio {
|
|
|
120079
121338
|
* 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.
|
|
120080
121339
|
*/
|
|
120081
121340
|
toJSON(): Visio.Interfaces.PageCollectionData;
|
|
120082
|
-
/**
|
|
120083
|
-
* Set mock data
|
|
120084
|
-
*/
|
|
120085
|
-
setMockData(data: Visio.Interfaces.PageCollectionData): void;
|
|
120086
121341
|
}
|
|
120087
121342
|
/**
|
|
120088
121343
|
* Represents the Shape Collection.
|
|
@@ -120134,10 +121389,6 @@ declare namespace Visio {
|
|
|
120134
121389
|
* 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.
|
|
120135
121390
|
*/
|
|
120136
121391
|
toJSON(): Visio.Interfaces.ShapeCollectionData;
|
|
120137
|
-
/**
|
|
120138
|
-
* Set mock data
|
|
120139
|
-
*/
|
|
120140
|
-
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
|
|
120141
121392
|
}
|
|
120142
121393
|
/**
|
|
120143
121394
|
* Represents the Shape class.
|
|
@@ -120259,10 +121510,6 @@ declare namespace Visio {
|
|
|
120259
121510
|
* 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.
|
|
120260
121511
|
*/
|
|
120261
121512
|
toJSON(): Visio.Interfaces.ShapeData;
|
|
120262
|
-
/**
|
|
120263
|
-
* Set mock data
|
|
120264
|
-
*/
|
|
120265
|
-
setMockData(data: Visio.Interfaces.ShapeData): void;
|
|
120266
121513
|
}
|
|
120267
121514
|
/**
|
|
120268
121515
|
* Represents the ShapeView class.
|
|
@@ -120370,10 +121617,6 @@ declare namespace Visio {
|
|
|
120370
121617
|
* 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.
|
|
120371
121618
|
*/
|
|
120372
121619
|
toJSON(): Visio.Interfaces.ShapeViewData;
|
|
120373
|
-
/**
|
|
120374
|
-
* Set mock data
|
|
120375
|
-
*/
|
|
120376
|
-
setMockData(data: Visio.Interfaces.ShapeViewData): void;
|
|
120377
121620
|
}
|
|
120378
121621
|
/**
|
|
120379
121622
|
* Represents the Position of the object in the view.
|
|
@@ -120505,10 +121748,6 @@ declare namespace Visio {
|
|
|
120505
121748
|
* 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.
|
|
120506
121749
|
*/
|
|
120507
121750
|
toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;
|
|
120508
|
-
/**
|
|
120509
|
-
* Set mock data
|
|
120510
|
-
*/
|
|
120511
|
-
setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
|
|
120512
121751
|
}
|
|
120513
121752
|
/**
|
|
120514
121753
|
* Represents the ShapeDataItem.
|
|
@@ -120573,10 +121812,6 @@ declare namespace Visio {
|
|
|
120573
121812
|
* 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.
|
|
120574
121813
|
*/
|
|
120575
121814
|
toJSON(): Visio.Interfaces.ShapeDataItemData;
|
|
120576
|
-
/**
|
|
120577
|
-
* Set mock data
|
|
120578
|
-
*/
|
|
120579
|
-
setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
|
|
120580
121815
|
}
|
|
120581
121816
|
/**
|
|
120582
121817
|
* Represents the Hyperlink Collection.
|
|
@@ -120628,10 +121863,6 @@ declare namespace Visio {
|
|
|
120628
121863
|
* 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.
|
|
120629
121864
|
*/
|
|
120630
121865
|
toJSON(): Visio.Interfaces.HyperlinkCollectionData;
|
|
120631
|
-
/**
|
|
120632
|
-
* Set mock data
|
|
120633
|
-
*/
|
|
120634
|
-
setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
|
|
120635
121866
|
}
|
|
120636
121867
|
/**
|
|
120637
121868
|
* Represents the Hyperlink.
|
|
@@ -120696,10 +121927,6 @@ declare namespace Visio {
|
|
|
120696
121927
|
* 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.
|
|
120697
121928
|
*/
|
|
120698
121929
|
toJSON(): Visio.Interfaces.HyperlinkData;
|
|
120699
|
-
/**
|
|
120700
|
-
* Set mock data
|
|
120701
|
-
*/
|
|
120702
|
-
setMockData(data: Visio.Interfaces.HyperlinkData): void;
|
|
120703
121930
|
}
|
|
120704
121931
|
/**
|
|
120705
121932
|
* Represents the CommentCollection for a given Shape.
|
|
@@ -120751,10 +121978,6 @@ declare namespace Visio {
|
|
|
120751
121978
|
* 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.
|
|
120752
121979
|
*/
|
|
120753
121980
|
toJSON(): Visio.Interfaces.CommentCollectionData;
|
|
120754
|
-
/**
|
|
120755
|
-
* Set mock data
|
|
120756
|
-
*/
|
|
120757
|
-
setMockData(data: Visio.Interfaces.CommentCollectionData): void;
|
|
120758
121981
|
}
|
|
120759
121982
|
/**
|
|
120760
121983
|
* Represents the Comment.
|
|
@@ -120820,10 +122043,6 @@ declare namespace Visio {
|
|
|
120820
122043
|
* 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.
|
|
120821
122044
|
*/
|
|
120822
122045
|
toJSON(): Visio.Interfaces.CommentData;
|
|
120823
|
-
/**
|
|
120824
|
-
* Set mock data
|
|
120825
|
-
*/
|
|
120826
|
-
setMockData(data: Visio.Interfaces.CommentData): void;
|
|
120827
122046
|
}
|
|
120828
122047
|
/**
|
|
120829
122048
|
* Represents the Selection in the page.
|
|
@@ -121567,21 +122786,21 @@ declare namespace Visio {
|
|
|
121567
122786
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
121568
122787
|
interface DocumentData {
|
|
121569
122788
|
/**
|
|
121570
|
-
* Represents a Visio application instance that contains this document.
|
|
122789
|
+
* Represents a Visio application instance that contains this document. Read-only.
|
|
121571
122790
|
*
|
|
121572
122791
|
* @remarks
|
|
121573
122792
|
* [Api set: 1.1]
|
|
121574
122793
|
*/
|
|
121575
122794
|
application?: Visio.Interfaces.ApplicationData;
|
|
121576
122795
|
/**
|
|
121577
|
-
* Represents a collection of pages associated with the document.
|
|
122796
|
+
* Represents a collection of pages associated with the document. Read-only.
|
|
121578
122797
|
*
|
|
121579
122798
|
* @remarks
|
|
121580
122799
|
* [Api set: 1.1]
|
|
121581
122800
|
*/
|
|
121582
122801
|
pages?: Visio.Interfaces.PageData[];
|
|
121583
122802
|
/**
|
|
121584
|
-
* Returns the DocumentView object.
|
|
122803
|
+
* Returns the DocumentView object. Read-only.
|
|
121585
122804
|
*
|
|
121586
122805
|
* @remarks
|
|
121587
122806
|
* [Api set: 1.1]
|
|
@@ -121629,63 +122848,63 @@ declare namespace Visio {
|
|
|
121629
122848
|
/** An interface describing the data returned by calling `page.toJSON()`. */
|
|
121630
122849
|
interface PageData {
|
|
121631
122850
|
/**
|
|
121632
|
-
* All shapes in the Page, including subshapes.
|
|
122851
|
+
* All shapes in the Page, including subshapes. Read-only.
|
|
121633
122852
|
*
|
|
121634
122853
|
* @remarks
|
|
121635
122854
|
* [Api set: 1.1]
|
|
121636
122855
|
*/
|
|
121637
122856
|
allShapes?: Visio.Interfaces.ShapeData[];
|
|
121638
122857
|
/**
|
|
121639
|
-
* Returns the Comments Collection.
|
|
122858
|
+
* Returns the Comments Collection. Read-only.
|
|
121640
122859
|
*
|
|
121641
122860
|
* @remarks
|
|
121642
122861
|
* [Api set: 1.1]
|
|
121643
122862
|
*/
|
|
121644
122863
|
comments?: Visio.Interfaces.CommentData[];
|
|
121645
122864
|
/**
|
|
121646
|
-
* All top-level shapes in the Page.
|
|
122865
|
+
* All top-level shapes in the Page. Read-only.
|
|
121647
122866
|
*
|
|
121648
122867
|
* @remarks
|
|
121649
122868
|
* [Api set: 1.1]
|
|
121650
122869
|
*/
|
|
121651
122870
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
121652
122871
|
/**
|
|
121653
|
-
* Returns the view of the page.
|
|
122872
|
+
* Returns the view of the page. Read-only.
|
|
121654
122873
|
*
|
|
121655
122874
|
* @remarks
|
|
121656
122875
|
* [Api set: 1.1]
|
|
121657
122876
|
*/
|
|
121658
122877
|
view?: Visio.Interfaces.PageViewData;
|
|
121659
122878
|
/**
|
|
121660
|
-
* Returns the height of the page.
|
|
122879
|
+
* Returns the height of the page. Read-only.
|
|
121661
122880
|
*
|
|
121662
122881
|
* @remarks
|
|
121663
122882
|
* [Api set: 1.1]
|
|
121664
122883
|
*/
|
|
121665
122884
|
height?: number;
|
|
121666
122885
|
/**
|
|
121667
|
-
* Index of the Page.
|
|
122886
|
+
* Index of the Page. Read-only.
|
|
121668
122887
|
*
|
|
121669
122888
|
* @remarks
|
|
121670
122889
|
* [Api set: 1.1]
|
|
121671
122890
|
*/
|
|
121672
122891
|
index?: number;
|
|
121673
122892
|
/**
|
|
121674
|
-
* Whether the page is a background page or not.
|
|
122893
|
+
* Whether the page is a background page or not. Read-only.
|
|
121675
122894
|
*
|
|
121676
122895
|
* @remarks
|
|
121677
122896
|
* [Api set: 1.1]
|
|
121678
122897
|
*/
|
|
121679
122898
|
isBackground?: boolean;
|
|
121680
122899
|
/**
|
|
121681
|
-
* Page name.
|
|
122900
|
+
* Page name. Read-only.
|
|
121682
122901
|
*
|
|
121683
122902
|
* @remarks
|
|
121684
122903
|
* [Api set: 1.1]
|
|
121685
122904
|
*/
|
|
121686
122905
|
name?: string;
|
|
121687
122906
|
/**
|
|
121688
|
-
* Returns the width of the page.
|
|
122907
|
+
* Returns the width of the page. Read-only.
|
|
121689
122908
|
*
|
|
121690
122909
|
* @remarks
|
|
121691
122910
|
* [Api set: 1.1]
|
|
@@ -121713,49 +122932,49 @@ declare namespace Visio {
|
|
|
121713
122932
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
121714
122933
|
interface ShapeData {
|
|
121715
122934
|
/**
|
|
121716
|
-
* Returns the Comments Collection.
|
|
122935
|
+
* Returns the Comments Collection. Read-only.
|
|
121717
122936
|
*
|
|
121718
122937
|
* @remarks
|
|
121719
122938
|
* [Api set: 1.1]
|
|
121720
122939
|
*/
|
|
121721
122940
|
comments?: Visio.Interfaces.CommentData[];
|
|
121722
122941
|
/**
|
|
121723
|
-
* Returns the Hyperlinks collection for a Shape object.
|
|
122942
|
+
* Returns the Hyperlinks collection for a Shape object. Read-only.
|
|
121724
122943
|
*
|
|
121725
122944
|
* @remarks
|
|
121726
122945
|
* [Api set: 1.1]
|
|
121727
122946
|
*/
|
|
121728
122947
|
hyperlinks?: Visio.Interfaces.HyperlinkData[];
|
|
121729
122948
|
/**
|
|
121730
|
-
* Returns the Shape's Data Section.
|
|
122949
|
+
* Returns the Shape's Data Section. Read-only.
|
|
121731
122950
|
*
|
|
121732
122951
|
* @remarks
|
|
121733
122952
|
* [Api set: 1.1]
|
|
121734
122953
|
*/
|
|
121735
122954
|
shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
|
|
121736
122955
|
/**
|
|
121737
|
-
* Gets SubShape Collection.
|
|
122956
|
+
* Gets SubShape Collection. Read-only.
|
|
121738
122957
|
*
|
|
121739
122958
|
* @remarks
|
|
121740
122959
|
* [Api set: 1.1]
|
|
121741
122960
|
*/
|
|
121742
122961
|
subShapes?: Visio.Interfaces.ShapeData[];
|
|
121743
122962
|
/**
|
|
121744
|
-
* Returns the view of the shape.
|
|
122963
|
+
* Returns the view of the shape. Read-only.
|
|
121745
122964
|
*
|
|
121746
122965
|
* @remarks
|
|
121747
122966
|
* [Api set: 1.1]
|
|
121748
122967
|
*/
|
|
121749
122968
|
view?: Visio.Interfaces.ShapeViewData;
|
|
121750
122969
|
/**
|
|
121751
|
-
* Shape's identifier.
|
|
122970
|
+
* Shape's identifier. Read-only.
|
|
121752
122971
|
*
|
|
121753
122972
|
* @remarks
|
|
121754
122973
|
* [Api set: 1.1]
|
|
121755
122974
|
*/
|
|
121756
122975
|
id?: number;
|
|
121757
122976
|
/**
|
|
121758
|
-
* Shape's name.
|
|
122977
|
+
* Shape's name. Read-only.
|
|
121759
122978
|
*
|
|
121760
122979
|
* @remarks
|
|
121761
122980
|
* [Api set: 1.1]
|
|
@@ -121769,7 +122988,7 @@ declare namespace Visio {
|
|
|
121769
122988
|
*/
|
|
121770
122989
|
select?: boolean;
|
|
121771
122990
|
/**
|
|
121772
|
-
* Shape's text.
|
|
122991
|
+
* Shape's text. Read-only.
|
|
121773
122992
|
*
|
|
121774
122993
|
* @remarks
|
|
121775
122994
|
* [Api set: 1.1]
|
|
@@ -121793,28 +123012,28 @@ declare namespace Visio {
|
|
|
121793
123012
|
/** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
|
|
121794
123013
|
interface ShapeDataItemData {
|
|
121795
123014
|
/**
|
|
121796
|
-
* A string that specifies the format of the shape data item.
|
|
123015
|
+
* A string that specifies the format of the shape data item. Read-only.
|
|
121797
123016
|
*
|
|
121798
123017
|
* @remarks
|
|
121799
123018
|
* [Api set: 1.1]
|
|
121800
123019
|
*/
|
|
121801
123020
|
format?: string;
|
|
121802
123021
|
/**
|
|
121803
|
-
* A string that specifies the formatted value of the shape data item.
|
|
123022
|
+
* A string that specifies the formatted value of the shape data item. Read-only.
|
|
121804
123023
|
*
|
|
121805
123024
|
* @remarks
|
|
121806
123025
|
* [Api set: 1.1]
|
|
121807
123026
|
*/
|
|
121808
123027
|
formattedValue?: string;
|
|
121809
123028
|
/**
|
|
121810
|
-
* A string that specifies the label of the shape data item.
|
|
123029
|
+
* A string that specifies the label of the shape data item. Read-only.
|
|
121811
123030
|
*
|
|
121812
123031
|
* @remarks
|
|
121813
123032
|
* [Api set: 1.1]
|
|
121814
123033
|
*/
|
|
121815
123034
|
label?: string;
|
|
121816
123035
|
/**
|
|
121817
|
-
* A string that specifies the value of the shape data item.
|
|
123036
|
+
* A string that specifies the value of the shape data item. Read-only.
|
|
121818
123037
|
*
|
|
121819
123038
|
* @remarks
|
|
121820
123039
|
* [Api set: 1.1]
|
|
@@ -121828,28 +123047,28 @@ declare namespace Visio {
|
|
|
121828
123047
|
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
|
|
121829
123048
|
interface HyperlinkData {
|
|
121830
123049
|
/**
|
|
121831
|
-
* Gets the address of the Hyperlink object.
|
|
123050
|
+
* Gets the address of the Hyperlink object. Read-only.
|
|
121832
123051
|
*
|
|
121833
123052
|
* @remarks
|
|
121834
123053
|
* [Api set: 1.1]
|
|
121835
123054
|
*/
|
|
121836
123055
|
address?: string;
|
|
121837
123056
|
/**
|
|
121838
|
-
* Gets the description of a hyperlink.
|
|
123057
|
+
* Gets the description of a hyperlink. Read-only.
|
|
121839
123058
|
*
|
|
121840
123059
|
* @remarks
|
|
121841
123060
|
* [Api set: 1.1]
|
|
121842
123061
|
*/
|
|
121843
123062
|
description?: string;
|
|
121844
123063
|
/**
|
|
121845
|
-
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
123064
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
121846
123065
|
*
|
|
121847
123066
|
* @remarks
|
|
121848
123067
|
* [Api set: 1.1]
|
|
121849
123068
|
*/
|
|
121850
123069
|
extraInfo?: string;
|
|
121851
123070
|
/**
|
|
121852
|
-
* Gets the sub-address of the Hyperlink object.
|
|
123071
|
+
* Gets the sub-address of the Hyperlink object. Read-only.
|
|
121853
123072
|
*
|
|
121854
123073
|
* @remarks
|
|
121855
123074
|
* [Api set: 1.1]
|
|
@@ -121887,7 +123106,7 @@ declare namespace Visio {
|
|
|
121887
123106
|
/** An interface describing the data returned by calling `selection.toJSON()`. */
|
|
121888
123107
|
interface SelectionData {
|
|
121889
123108
|
/**
|
|
121890
|
-
* Gets the Shapes of the Selection.
|
|
123109
|
+
* Gets the Shapes of the Selection. Read-only.
|
|
121891
123110
|
*
|
|
121892
123111
|
* @remarks
|
|
121893
123112
|
* [Api set: 1.1]
|
|
@@ -122012,35 +123231,35 @@ declare namespace Visio {
|
|
|
122012
123231
|
*/
|
|
122013
123232
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
122014
123233
|
/**
|
|
122015
|
-
* Returns the height of the page.
|
|
123234
|
+
* Returns the height of the page. Read-only.
|
|
122016
123235
|
*
|
|
122017
123236
|
* @remarks
|
|
122018
123237
|
* [Api set: 1.1]
|
|
122019
123238
|
*/
|
|
122020
123239
|
height?: boolean;
|
|
122021
123240
|
/**
|
|
122022
|
-
* Index of the Page.
|
|
123241
|
+
* Index of the Page. Read-only.
|
|
122023
123242
|
*
|
|
122024
123243
|
* @remarks
|
|
122025
123244
|
* [Api set: 1.1]
|
|
122026
123245
|
*/
|
|
122027
123246
|
index?: boolean;
|
|
122028
123247
|
/**
|
|
122029
|
-
* Whether the page is a background page or not.
|
|
123248
|
+
* Whether the page is a background page or not. Read-only.
|
|
122030
123249
|
*
|
|
122031
123250
|
* @remarks
|
|
122032
123251
|
* [Api set: 1.1]
|
|
122033
123252
|
*/
|
|
122034
123253
|
isBackground?: boolean;
|
|
122035
123254
|
/**
|
|
122036
|
-
* Page name.
|
|
123255
|
+
* Page name. Read-only.
|
|
122037
123256
|
*
|
|
122038
123257
|
* @remarks
|
|
122039
123258
|
* [Api set: 1.1]
|
|
122040
123259
|
*/
|
|
122041
123260
|
name?: boolean;
|
|
122042
123261
|
/**
|
|
122043
|
-
* Returns the width of the page.
|
|
123262
|
+
* Returns the width of the page. Read-only.
|
|
122044
123263
|
*
|
|
122045
123264
|
* @remarks
|
|
122046
123265
|
* [Api set: 1.1]
|
|
@@ -122085,7 +123304,7 @@ declare namespace Visio {
|
|
|
122085
123304
|
*/
|
|
122086
123305
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
122087
123306
|
/**
|
|
122088
|
-
* For EACH ITEM in the collection: Returns the height of the page.
|
|
123307
|
+
* For EACH ITEM in the collection: Returns the height of the page. Read-only.
|
|
122089
123308
|
*
|
|
122090
123309
|
* @remarks
|
|
122091
123310
|
* [Api set: 1.1]
|
|
@@ -122093,27 +123312,27 @@ declare namespace Visio {
|
|
|
122093
123312
|
height?: boolean;
|
|
122094
123313
|
/**
|
|
122095
123314
|
* For EACH ITEM in the collection: Index of the Page.
|
|
122096
|
-
*
|
|
123315
|
+
* Read-only.
|
|
122097
123316
|
* @remarks
|
|
122098
123317
|
* [Api set: 1.1]
|
|
122099
123318
|
*/
|
|
122100
123319
|
index?: boolean;
|
|
122101
123320
|
/**
|
|
122102
|
-
* For EACH ITEM in the collection: Whether the page is a background page or not.
|
|
123321
|
+
* For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
|
|
122103
123322
|
*
|
|
122104
123323
|
* @remarks
|
|
122105
123324
|
* [Api set: 1.1]
|
|
122106
123325
|
*/
|
|
122107
123326
|
isBackground?: boolean;
|
|
122108
123327
|
/**
|
|
122109
|
-
* For EACH ITEM in the collection: Page name.
|
|
123328
|
+
* For EACH ITEM in the collection: Page name. Read-only.
|
|
122110
123329
|
*
|
|
122111
123330
|
* @remarks
|
|
122112
123331
|
* [Api set: 1.1]
|
|
122113
123332
|
*/
|
|
122114
123333
|
name?: boolean;
|
|
122115
123334
|
/**
|
|
122116
|
-
* For EACH ITEM in the collection: Returns the width of the page.
|
|
123335
|
+
* For EACH ITEM in the collection: Returns the width of the page. Read-only.
|
|
122117
123336
|
*
|
|
122118
123337
|
* @remarks
|
|
122119
123338
|
* [Api set: 1.1]
|
|
@@ -122139,14 +123358,14 @@ declare namespace Visio {
|
|
|
122139
123358
|
*/
|
|
122140
123359
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
122141
123360
|
/**
|
|
122142
|
-
* For EACH ITEM in the collection: Shape's identifier.
|
|
123361
|
+
* For EACH ITEM in the collection: Shape's identifier. Read-only.
|
|
122143
123362
|
*
|
|
122144
123363
|
* @remarks
|
|
122145
123364
|
* [Api set: 1.1]
|
|
122146
123365
|
*/
|
|
122147
123366
|
id?: boolean;
|
|
122148
123367
|
/**
|
|
122149
|
-
* For EACH ITEM in the collection: Shape's name.
|
|
123368
|
+
* For EACH ITEM in the collection: Shape's name. Read-only.
|
|
122150
123369
|
*
|
|
122151
123370
|
* @remarks
|
|
122152
123371
|
* [Api set: 1.1]
|
|
@@ -122160,7 +123379,7 @@ declare namespace Visio {
|
|
|
122160
123379
|
*/
|
|
122161
123380
|
select?: boolean;
|
|
122162
123381
|
/**
|
|
122163
|
-
* For EACH ITEM in the collection: Shape's text.
|
|
123382
|
+
* For EACH ITEM in the collection: Shape's text. Read-only.
|
|
122164
123383
|
*
|
|
122165
123384
|
* @remarks
|
|
122166
123385
|
* [Api set: 1.1]
|
|
@@ -122186,14 +123405,14 @@ declare namespace Visio {
|
|
|
122186
123405
|
*/
|
|
122187
123406
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
122188
123407
|
/**
|
|
122189
|
-
* Shape's identifier.
|
|
123408
|
+
* Shape's identifier. Read-only.
|
|
122190
123409
|
*
|
|
122191
123410
|
* @remarks
|
|
122192
123411
|
* [Api set: 1.1]
|
|
122193
123412
|
*/
|
|
122194
123413
|
id?: boolean;
|
|
122195
123414
|
/**
|
|
122196
|
-
* Shape's name.
|
|
123415
|
+
* Shape's name. Read-only.
|
|
122197
123416
|
*
|
|
122198
123417
|
* @remarks
|
|
122199
123418
|
* [Api set: 1.1]
|
|
@@ -122207,7 +123426,7 @@ declare namespace Visio {
|
|
|
122207
123426
|
*/
|
|
122208
123427
|
select?: boolean;
|
|
122209
123428
|
/**
|
|
122210
|
-
* Shape's text.
|
|
123429
|
+
* Shape's text. Read-only.
|
|
122211
123430
|
*
|
|
122212
123431
|
* @remarks
|
|
122213
123432
|
* [Api set: 1.1]
|
|
@@ -122245,28 +123464,28 @@ declare namespace Visio {
|
|
|
122245
123464
|
*/
|
|
122246
123465
|
$all?: boolean;
|
|
122247
123466
|
/**
|
|
122248
|
-
* For EACH ITEM in the collection: A string that specifies the format of the shape data item.
|
|
123467
|
+
* For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.
|
|
122249
123468
|
*
|
|
122250
123469
|
* @remarks
|
|
122251
123470
|
* [Api set: 1.1]
|
|
122252
123471
|
*/
|
|
122253
123472
|
format?: boolean;
|
|
122254
123473
|
/**
|
|
122255
|
-
* For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.
|
|
123474
|
+
* For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.
|
|
122256
123475
|
*
|
|
122257
123476
|
* @remarks
|
|
122258
123477
|
* [Api set: 1.1]
|
|
122259
123478
|
*/
|
|
122260
123479
|
formattedValue?: boolean;
|
|
122261
123480
|
/**
|
|
122262
|
-
* For EACH ITEM in the collection: A string that specifies the label of the shape data item.
|
|
123481
|
+
* For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.
|
|
122263
123482
|
*
|
|
122264
123483
|
* @remarks
|
|
122265
123484
|
* [Api set: 1.1]
|
|
122266
123485
|
*/
|
|
122267
123486
|
label?: boolean;
|
|
122268
123487
|
/**
|
|
122269
|
-
* For EACH ITEM in the collection: A string that specifies the value of the shape data item.
|
|
123488
|
+
* For EACH ITEM in the collection: A string that specifies the value of the shape data item. Read-only.
|
|
122270
123489
|
*
|
|
122271
123490
|
* @remarks
|
|
122272
123491
|
* [Api set: 1.1]
|
|
@@ -122285,28 +123504,28 @@ declare namespace Visio {
|
|
|
122285
123504
|
*/
|
|
122286
123505
|
$all?: boolean;
|
|
122287
123506
|
/**
|
|
122288
|
-
* A string that specifies the format of the shape data item.
|
|
123507
|
+
* A string that specifies the format of the shape data item. Read-only.
|
|
122289
123508
|
*
|
|
122290
123509
|
* @remarks
|
|
122291
123510
|
* [Api set: 1.1]
|
|
122292
123511
|
*/
|
|
122293
123512
|
format?: boolean;
|
|
122294
123513
|
/**
|
|
122295
|
-
* A string that specifies the formatted value of the shape data item.
|
|
123514
|
+
* A string that specifies the formatted value of the shape data item. Read-only.
|
|
122296
123515
|
*
|
|
122297
123516
|
* @remarks
|
|
122298
123517
|
* [Api set: 1.1]
|
|
122299
123518
|
*/
|
|
122300
123519
|
formattedValue?: boolean;
|
|
122301
123520
|
/**
|
|
122302
|
-
* A string that specifies the label of the shape data item.
|
|
123521
|
+
* A string that specifies the label of the shape data item. Read-only.
|
|
122303
123522
|
*
|
|
122304
123523
|
* @remarks
|
|
122305
123524
|
* [Api set: 1.1]
|
|
122306
123525
|
*/
|
|
122307
123526
|
label?: boolean;
|
|
122308
123527
|
/**
|
|
122309
|
-
* A string that specifies the value of the shape data item.
|
|
123528
|
+
* A string that specifies the value of the shape data item. Read-only.
|
|
122310
123529
|
*
|
|
122311
123530
|
* @remarks
|
|
122312
123531
|
* [Api set: 1.1]
|
|
@@ -122325,28 +123544,28 @@ declare namespace Visio {
|
|
|
122325
123544
|
*/
|
|
122326
123545
|
$all?: boolean;
|
|
122327
123546
|
/**
|
|
122328
|
-
* For EACH ITEM in the collection: Gets the address of the Hyperlink object.
|
|
123547
|
+
* For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.
|
|
122329
123548
|
*
|
|
122330
123549
|
* @remarks
|
|
122331
123550
|
* [Api set: 1.1]
|
|
122332
123551
|
*/
|
|
122333
123552
|
address?: boolean;
|
|
122334
123553
|
/**
|
|
122335
|
-
* For EACH ITEM in the collection: Gets the description of a hyperlink.
|
|
123554
|
+
* For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.
|
|
122336
123555
|
*
|
|
122337
123556
|
* @remarks
|
|
122338
123557
|
* [Api set: 1.1]
|
|
122339
123558
|
*/
|
|
122340
123559
|
description?: boolean;
|
|
122341
123560
|
/**
|
|
122342
|
-
* For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
123561
|
+
* For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
122343
123562
|
*
|
|
122344
123563
|
* @remarks
|
|
122345
123564
|
* [Api set: 1.1]
|
|
122346
123565
|
*/
|
|
122347
123566
|
extraInfo?: boolean;
|
|
122348
123567
|
/**
|
|
122349
|
-
* For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.
|
|
123568
|
+
* For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.
|
|
122350
123569
|
*
|
|
122351
123570
|
* @remarks
|
|
122352
123571
|
* [Api set: 1.1]
|
|
@@ -122365,28 +123584,28 @@ declare namespace Visio {
|
|
|
122365
123584
|
*/
|
|
122366
123585
|
$all?: boolean;
|
|
122367
123586
|
/**
|
|
122368
|
-
* Gets the address of the Hyperlink object.
|
|
123587
|
+
* Gets the address of the Hyperlink object. Read-only.
|
|
122369
123588
|
*
|
|
122370
123589
|
* @remarks
|
|
122371
123590
|
* [Api set: 1.1]
|
|
122372
123591
|
*/
|
|
122373
123592
|
address?: boolean;
|
|
122374
123593
|
/**
|
|
122375
|
-
* Gets the description of a hyperlink.
|
|
123594
|
+
* Gets the description of a hyperlink. Read-only.
|
|
122376
123595
|
*
|
|
122377
123596
|
* @remarks
|
|
122378
123597
|
* [Api set: 1.1]
|
|
122379
123598
|
*/
|
|
122380
123599
|
description?: boolean;
|
|
122381
123600
|
/**
|
|
122382
|
-
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
123601
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
|
|
122383
123602
|
*
|
|
122384
123603
|
* @remarks
|
|
122385
123604
|
* [Api set: 1.1]
|
|
122386
123605
|
*/
|
|
122387
123606
|
extraInfo?: boolean;
|
|
122388
123607
|
/**
|
|
122389
|
-
* Gets the sub-address of the Hyperlink object.
|
|
123608
|
+
* Gets the sub-address of the Hyperlink object. Read-only.
|
|
122390
123609
|
*
|
|
122391
123610
|
* @remarks
|
|
122392
123611
|
* [Api set: 1.1]
|
|
@@ -122471,25 +123690,25 @@ declare namespace Visio {
|
|
|
122471
123690
|
}
|
|
122472
123691
|
/**
|
|
122473
123692
|
* Executes a batch script that performs actions on the Visio object model, using a new request context. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
122474
|
-
* @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of
|
|
123693
|
+
* @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of `context.sync()`). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the request context is required to get access to the Visio object model from the add-in.
|
|
122475
123694
|
*/
|
|
122476
123695
|
function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
122477
123696
|
/**
|
|
122478
123697
|
* Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object.
|
|
122479
|
-
* @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by
|
|
122480
|
-
* @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of
|
|
123698
|
+
* @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by `context.sync()`.
|
|
123699
|
+
* @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of `context.sync()`). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
122481
123700
|
*/
|
|
122482
123701
|
function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
122483
123702
|
/**
|
|
122484
123703
|
* Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects.
|
|
122485
|
-
* @param objects - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared request context, which means that any changes applied to these objects will be picked up by
|
|
122486
|
-
* @param batch - A function that takes in a Visio.RequestContext and returns a promise (typically, just the result of
|
|
123704
|
+
* @param objects - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared request context, which means that any changes applied to these objects will be picked up by `context.sync()`.
|
|
123705
|
+
* @param batch - A function that takes in a Visio.RequestContext and returns a promise (typically, just the result of `context.sync()`). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
122487
123706
|
*/
|
|
122488
123707
|
function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
122489
123708
|
/**
|
|
122490
123709
|
* Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
122491
123710
|
* @param contextObject - A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context.
|
|
122492
|
-
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of
|
|
123711
|
+
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of `context.sync()`). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in.
|
|
122493
123712
|
*/
|
|
122494
123713
|
function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
122495
123714
|
}
|
|
@@ -126243,9 +127462,9 @@ declare namespace PowerPoint {
|
|
|
126243
127462
|
*/
|
|
126244
127463
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;
|
|
126245
127464
|
/**
|
|
126246
|
-
|
|
126247
|
-
|
|
126248
|
-
|
|
127465
|
+
* 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's passed to it.)
|
|
127466
|
+
* Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
127467
|
+
*/
|
|
126249
127468
|
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;
|
|
126250
127469
|
}
|
|
126251
127470
|
/**
|
|
@@ -126376,9 +127595,9 @@ declare namespace PowerPoint {
|
|
|
126376
127595
|
expand?: string;
|
|
126377
127596
|
}): PowerPoint.DocumentProperties;
|
|
126378
127597
|
/**
|
|
126379
|
-
|
|
126380
|
-
|
|
126381
|
-
|
|
127598
|
+
* 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's passed to it.)
|
|
127599
|
+
* Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
|
|
127600
|
+
*/
|
|
126382
127601
|
toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;
|
|
126383
127602
|
}
|
|
126384
127603
|
/**
|