From 8aec65f73dffe1c403db94bf9eaccff530a0a25e Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 7 Nov 2024 07:31:10 -0800 Subject: [PATCH 1/3] Automatically generated docs (#2126) Co-authored-by: github-actions --- .../onenote/onenote/onenote.application.yml | 34 +- .../onenote/onenote/onenote.floatingink.yml | 25 +- .../onenote/onenote/onenote.image.yml | 27 +- .../onenote/onenote/onenote.imageocrdata.yml | 4 +- .../onenote/onenote/onenote.inkanalysis.yml | 23 +- .../onenote/onenote.inkanalysisline.yml | 27 +- .../onenote.inkanalysislinecollection.yml | 19 +- .../onenote/onenote.inkanalysisparagraph.yml | 25 +- ...onenote.inkanalysisparagraphcollection.yml | 21 +- .../onenote/onenote.inkanalysisword.yml | 31 +- .../onenote.inkanalysiswordcollection.yml | 17 +- .../onenote/onenote/onenote.inkstroke.yml | 25 +- .../onenote/onenote.inkstrokecollection.yml | 19 +- .../onenote/onenote.inkstrokepointer.yml | 4 +- .../onenote/onenote/onenote.inkword.yml | 27 +- .../onenote/onenote.inkwordcollection.yml | 19 +- ...note.interfaces.applicationloadoptions.yml | 4 +- ...enote.interfaces.applicationupdatedata.yml | 2 +- ...note.interfaces.floatinginkloadoptions.yml | 4 +- .../onenote.interfaces.imageloadoptions.yml | 8 +- .../onenote.interfaces.imageupdatedata.yml | 2 +- ...s.inkanalysislinecollectionloadoptions.yml | 4 +- ...es.inkanalysislinecollectionupdatedata.yml | 2 +- ....interfaces.inkanalysislineloadoptions.yml | 4 +- ...e.interfaces.inkanalysislineupdatedata.yml | 2 +- ...analysisparagraphcollectionloadoptions.yml | 4 +- ...kanalysisparagraphcollectionupdatedata.yml | 2 +- ...rfaces.inkanalysisparagraphloadoptions.yml | 4 +- ...erfaces.inkanalysisparagraphupdatedata.yml | 4 +- ...enote.interfaces.inkanalysisupdatedata.yml | 2 +- ...s.inkanalysiswordcollectionloadoptions.yml | 4 +- ...es.inkanalysiswordcollectionupdatedata.yml | 2 +- ....interfaces.inkanalysiswordloadoptions.yml | 4 +- ...e.interfaces.inkanalysiswordupdatedata.yml | 2 +- ...erfaces.inkstrokecollectionloadoptions.yml | 4 +- ...terfaces.inkstrokecollectionupdatedata.yml | 2 +- ...nenote.interfaces.inkstrokeloadoptions.yml | 4 +- ...nterfaces.inkwordcollectionloadoptions.yml | 6 +- ...interfaces.inkwordcollectionupdatedata.yml | 2 +- .../onenote.interfaces.inkwordloadoptions.yml | 6 +- ...terfaces.notebookcollectionloadoptions.yml | 14 +- ...nterfaces.notebookcollectionupdatedata.yml | 4 +- .../onenote.interfaces.notebookdata.yml | 8 +- ...onenote.interfaces.notebookloadoptions.yml | 14 +- .../onenote.interfaces.notetagloadoptions.yml | 4 +- .../onenote.interfaces.outlineloadoptions.yml | 4 +- ...e.interfaces.pagecollectionloadoptions.yml | 8 +- ...te.interfaces.pagecollectionupdatedata.yml | 2 +- ...faces.pagecontentcollectionloadoptions.yml | 12 +- ...rfaces.pagecontentcollectionupdatedata.yml | 2 +- .../onenote.interfaces.pagecontentdata.yml | 6 +- ...note.interfaces.pagecontentloadoptions.yml | 4 +- ...enote.interfaces.pagecontentupdatedata.yml | 4 +- .../onenote/onenote.interfaces.pagedata.yml | 4 +- .../onenote.interfaces.pageloadoptions.yml | 10 +- .../onenote.interfaces.pageupdatedata.yml | 4 +- ...erfaces.paragraphcollectionloadoptions.yml | 28 +- .../onenote.interfaces.paragraphdata.yml | 4 +- ...nenote.interfaces.paragraphloadoptions.yml | 20 +- ...onenote.interfaces.paragraphupdatedata.yml | 2 +- ....interfaces.pointcollectionloadoptions.yml | 4 +- ...e.interfaces.pointcollectionupdatedata.yml | 2 +- .../onenote.interfaces.pointloadoptions.yml | 4 +- .../onenote.interfaces.richtextdata.yml | 2 +- ...onenote.interfaces.richtextloadoptions.yml | 6 +- ...nterfaces.sectioncollectionloadoptions.yml | 8 +- ...interfaces.sectioncollectionupdatedata.yml | 2 +- .../onenote.interfaces.sectiondata.yml | 10 +- ...aces.sectiongroupcollectionloadoptions.yml | 8 +- ...faces.sectiongroupcollectionupdatedata.yml | 2 +- .../onenote.interfaces.sectiongroupdata.yml | 6 +- ...ote.interfaces.sectiongrouploadoptions.yml | 10 +- .../onenote.interfaces.sectionloadoptions.yml | 12 +- ...erfaces.tablecellcollectionloadoptions.yml | 4 +- ...terfaces.tablecellcollectionupdatedata.yml | 2 +- .../onenote.interfaces.tablecelldata.yml | 2 +- ...nenote.interfaces.tablecellloadoptions.yml | 4 +- ...onenote.interfaces.tablecellupdatedata.yml | 2 +- .../onenote.interfaces.tableloadoptions.yml | 4 +- ...terfaces.tablerowcollectionloadoptions.yml | 4 +- ...nterfaces.tablerowcollectionupdatedata.yml | 4 +- ...onenote.interfaces.tablerowloadoptions.yml | 4 +- .../onenote.interfaces.tableupdatedata.yml | 2 +- .../onenote/onenote/onenote.notebook.yml | 35 +- .../onenote/onenote.notebookcollection.yml | 19 +- .../onenote/onenote/onenote.notetag.yml | 25 +- .../onenote/onenote/onenote.outline.yml | 29 +- .../onenote/onenote/onenote.page.yml | 35 +- .../onenote/onenote.pagecollection.yml | 19 +- .../onenote/onenote/onenote.pagecontent.yml | 25 +- .../onenote/onenote.pagecontentcollection.yml | 19 +- .../onenote/onenote/onenote.paragraph.yml | 55 +- .../onenote/onenote.paragraphcollection.yml | 19 +- .../onenote/onenote/onenote.paragraphinfo.yml | 10 +- .../onenote/onenote/onenote.point.yml | 21 +- .../onenote/onenote.pointcollection.yml | 19 +- .../onenote/onenote/onenote.richtext.yml | 31 +- .../onenote/onenote/onenote.section.yml | 37 +- .../onenote/onenote.sectioncollection.yml | 19 +- .../onenote/onenote/onenote.sectiongroup.yml | 35 +- .../onenote.sectiongroupcollection.yml | 19 +- .../onenote/onenote/onenote.table.yml | 25 +- .../onenote/onenote/onenote.tablecell.yml | 39 +- .../onenote/onenote.tablecellcollection.yml | 19 +- .../onenote/onenote/onenote.tablerow.yml | 33 +- .../onenote/onenote.tablerowcollection.yml | 19 +- docs/docs-ref-autogen/visio/visio.yml | 24 +- .../visio/visio/visio.application.yml | 17 - .../visio/visio/visio.comment.yml | 17 - .../visio/visio/visio.commentcollection.yml | 17 - .../visio/visio/visio.document.yml | 19 +- .../visio/visio/visio.documentview.yml | 17 - .../visio/visio/visio.hyperlink.yml | 17 - .../visio/visio/visio.hyperlinkcollection.yml | 17 - ...erfaces.hyperlinkcollectionloadoptions.yml | 10 +- .../visio/visio.interfaces.hyperlinkdata.yml | 8 +- .../visio.interfaces.hyperlinkloadoptions.yml | 8 +- ...o.interfaces.pagecollectionloadoptions.yml | 10 +- .../visio.interfaces.pageloadoptions.yml | 10 +- .../visio/visio.interfaces.selectiondata.yml | 2 +- ....interfaces.shapecollectionloadoptions.yml | 6 +- ...ces.shapedataitemcollectionloadoptions.yml | 6 +- .../visio.interfaces.shapedataitemdata.yml | 8 +- ...io.interfaces.shapedataitemloadoptions.yml | 8 +- .../visio.interfaces.shapeloadoptions.yml | 6 +- .../visio/visio/visio.page.yml | 17 - .../visio/visio/visio.pagecollection.yml | 17 - .../visio/visio/visio.pageview.yml | 17 - .../visio/visio/visio.shape.yml | 17 - .../visio/visio/visio.shapecollection.yml | 17 - .../visio/visio/visio.shapedataitem.yml | 17 - .../visio/visio.shapedataitemcollection.yml | 17 - .../visio/visio/visio.shapeview.yml | 17 - generate-docs/API Coverage Report.csv | 39 +- .../api-extractor-inputs-onenote/onenote.d.ts | 920 +++++++------- .../powerpoint.d.ts | 12 +- .../api-extractor-inputs-visio/visio.d.ts | 154 +-- generate-docs/script-inputs/office.d.ts | 1074 ++++++++--------- .../script-inputs/office_preview.d.ts | 862 +++++++------ 139 files changed, 2183 insertions(+), 2544 deletions(-) diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.application.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.application.yml index bfc71e9c67..f4c9e64e58 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.application.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.application.yml @@ -348,6 +348,19 @@ methods: return: type: '' description: '' + - name: getDecimalSeparator() + uid: 'onenote!OneNote.Application#getDecimalSeparator:member(1)' + package: onenote! + fullName: getDecimalSeparator() + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'getDecimalSeparator(): OfficeExtension.ClientResult;' + return: + type: '<string>' + description: '' - name: getSelectedInkStrokes() uid: 'onenote!OneNote.Application#getSelectedInkStrokes:member(1)' package: onenote! @@ -374,6 +387,23 @@ methods: return: type: '<number[]>' description: '' + - name: insertAndEmbedLinkAtCurrentPosition(url) + uid: 'onenote!OneNote.Application#insertAndEmbedLinkAtCurrentPosition:member(1)' + package: onenote! + fullName: insertAndEmbedLinkAtCurrentPosition(url) + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'insertAndEmbedLinkAtCurrentPosition(url: string): void;' + parameters: + - id: url + description: '' + type: string + return: + type: void + description: '' - name: insertHtmlAtCurrentPosition(html) uid: 'onenote!OneNote.Application#insertHtmlAtCurrentPosition:member(1)' package: onenote! @@ -608,8 +638,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Application object is an API object, the `toJSON` method returns a + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.floatingink.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.floatingink.yml index 0ea76458c2..e17f3b9e55 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.floatingink.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.floatingink.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.FloatingInk#id:member' package: onenote! fullName: id - summary: Gets the ID of the FloatingInk object. Read-only. + summary: Gets the ID of the FloatingInk object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.FloatingInk#inkStrokes:member' package: onenote! fullName: inkStrokes - summary: Gets the strokes of the FloatingInk object. Read-only. + summary: Gets the strokes of the FloatingInk object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.FloatingInk#pageContent:member' package: onenote! fullName: pageContent - summary: Gets the PageContent parent of the FloatingInk object. Read-only. + summary: Gets the PageContent parent of the FloatingInk object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -166,8 +166,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.FloatingInk object is an API object, the `toJSON` method returns a + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -184,10 +184,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -202,9 +203,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.image.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.image.yml index 83f7f63b70..6871b44875 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.image.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.image.yml @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Image#id:member' package: onenote! fullName: id - summary: Gets the ID of the Image object. Read-only. + summary: Gets the ID of the Image object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -122,7 +122,7 @@ properties: fullName: pageContent summary: >- Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. - This object defines the position of the Image on the page. Read-only. + This object defines the position of the Image on the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -134,9 +134,7 @@ properties: uid: 'onenote!OneNote.Image#paragraph:member' package: onenote! fullName: paragraph - summary: >- - Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. - Read-only. + summary: Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -352,8 +350,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Image object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -370,10 +368,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -388,9 +387,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.imageocrdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.imageocrdata.yml index a54a40142d..d3476dbf97 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.imageocrdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.imageocrdata.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.ImageOcrData#ocrLanguageId:member' package: onenote! fullName: ocrLanguageId - summary: 'Represents the OCR language, with values such as EN-US' + summary: 'Represents the OCR language, with values such as EN-US.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.ImageOcrData#ocrText:member' package: onenote! fullName: ocrText - summary: Represents the text obtained by OCR of the image + summary: Represents the text obtained by OCR of the image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysis.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysis.yml index fb84ae8c99..d8e2a8635b 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysis.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysis.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysis#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkAnalysis object. Read-only. + summary: Gets the ID of the InkAnalysis object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkAnalysis#page:member' package: onenote! fullName: page - summary: Gets the parent page object. Read-only. + summary: Gets the parent page object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -162,8 +162,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.InkAnalysis object is an API object, the `toJSON` method returns a + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -180,10 +180,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -198,9 +199,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisline.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisline.yml index f699e165de..a5c9541cb8 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisline.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisline.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisLine#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkAnalysisLine object. Read-only. + summary: Gets the ID of the InkAnalysisLine object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisLine#paragraph:member' package: onenote! fullName: paragraph - summary: Reference to the parent InkAnalysisParagraph. Read-only. + summary: Reference to the parent InkAnalysisParagraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisLine#words:member' package: onenote! fullName: words - summary: Gets the ink analysis words in this ink analysis line. Read-only. + summary: Gets the ink analysis words in this ink analysis line. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -174,9 +174,9 @@ methods: fullName: toJSON() summary: >- 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.) 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false @@ -192,10 +192,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -210,9 +211,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysislinecollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysislinecollection.yml index 03b00a4f2d..2a15e99f54 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysislinecollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysislinecollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisLineCollection#count:member' package: onenote! fullName: count - summary: Returns the number of InkAnalysisLines in the page. Read-only. + summary: Returns the number of InkAnalysisLines in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraph.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraph.yml index 8d6e36654a..7561742a36 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraph.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraph.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisParagraph#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkAnalysisParagraph object. Read-only. + summary: Gets the ID of the InkAnalysisParagraph object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisParagraph#inkAnalysis:member' package: onenote! fullName: inkAnalysis - summary: Reference to the parent InkAnalysisPage. Read-only. + summary: Reference to the parent InkAnalysisPage. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisParagraph#lines:member' package: onenote! fullName: lines - summary: Gets the ink analysis lines in this ink analysis paragraph. Read-only. + summary: Gets the ink analysis lines in this ink analysis paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -174,8 +174,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.InkAnalysisParagraph object is an API object, the `toJSON` method + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -192,10 +192,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -210,9 +211,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraphcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraphcollection.yml index 88b7f95a64..c9f67fd963 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraphcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisparagraphcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisParagraphCollection#count:member' package: onenote! fullName: count - summary: Returns the number of InkAnalysisParagraphs in the page. Read-only. + summary: Returns the number of InkAnalysisParagraphs in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -52,7 +52,7 @@ methods: uid: 'onenote!OneNote.InkAnalysisParagraphCollection#getItem:member(1)' package: onenote! fullName: getItem(index) - summary: Gets a InkAnalysisParagraph object by ID or by its index in the collection. Read-only. + summary: Gets a InkAnalysisParagraph object by ID or by its index in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -153,7 +153,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -171,10 +171,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -189,9 +190,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisword.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisword.yml index e3c7ec2c1a..32a0fd3603 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisword.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysisword.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWord#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkAnalysisWord object. Read-only. + summary: Gets the ID of the InkAnalysisWord object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWord#languageId:member' package: onenote! fullName: languageId - summary: The id of the recognized language in this inkAnalysisWord. Read-only. + summary: The ID of the recognized language in this inkAnalysisWord. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWord#line:member' package: onenote! fullName: line - summary: Reference to the parent InkAnalysisLine. Read-only. + summary: Reference to the parent InkAnalysisLine. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWord#strokePointers:member' package: onenote! fullName: strokePointers - summary: Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only. + summary: Weak references to the ink strokes that were recognized as part of this ink analysis word. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWord#wordAlternates:member' package: onenote! fullName: wordAlternates - summary: 'The words that were recognized in this ink word, in order of likelihood. Read-only.' + summary: 'The words that were recognized in this ink word, in order of likelihood.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -198,9 +198,9 @@ methods: fullName: toJSON() summary: >- 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.) 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false @@ -216,10 +216,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -234,9 +235,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysiswordcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysiswordcollection.yml index 337145fd5d..90ede74020 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysiswordcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkanalysiswordcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkAnalysisWordCollection#count:member' package: onenote! fullName: count - summary: Returns the number of InkAnalysisWords in the page. Read-only. + summary: Returns the number of InkAnalysisWords in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -186,6 +187,10 @@ methods: package: onenote! fullName: untrack() summary: >- + Release the memory associated with this object, if it has previously been tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstroke.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstroke.yml index e05e153e96..c6b1dffde9 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstroke.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstroke.yml @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkStroke#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkStroke object. Read-only. + summary: Gets the ID of the InkStroke object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -121,10 +121,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -139,10 +139,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -157,9 +158,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokecollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokecollection.yml index 328078bb54..c332d56e21 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokecollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokecollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkStrokeCollection#count:member' package: onenote! fullName: count - summary: Returns the number of InkStrokes in the page. Read-only. + summary: Returns the number of InkStrokes in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokepointer.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokepointer.yml index dadeea8dd6..4cd1b89f38 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokepointer.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkstrokepointer.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.InkStrokePointer#contentId:member' package: onenote! fullName: contentId - summary: Represents the id of the page content object corresponding to this stroke + summary: Represents the ID of the page content object corresponding to this stroke. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.InkStrokePointer#inkStrokeId:member' package: onenote! fullName: inkStrokeId - summary: Represents the id of the ink stroke + summary: Represents the ID of the ink stroke. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkword.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkword.yml index 268dc23a4c..e81e28e63d 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkword.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkword.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkWord#id:member' package: onenote! fullName: id - summary: Gets the ID of the InkWord object. Read-only. + summary: Gets the ID of the InkWord object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.InkWord#languageId:member' package: onenote! fullName: languageId - summary: The id of the recognized language in this ink word. Read-only. + summary: The ID of the recognized language in this ink word. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.InkWord#paragraph:member' package: onenote! fullName: paragraph - summary: The parent paragraph containing the ink word. Read-only. + summary: The parent paragraph containing the ink word. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.InkWord#wordAlternates:member' package: onenote! fullName: wordAlternates - summary: 'The words that were recognized in this ink word, in order of likelihood. Read-only.' + summary: 'The words that were recognized in this ink word, in order of likelihood.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -145,8 +145,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.InkWord object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -163,10 +163,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -181,9 +182,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.inkwordcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.inkwordcollection.yml index 5bbe33e0b0..a379c098cf 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.inkwordcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.inkwordcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.InkWordCollection#count:member' package: onenote! fullName: count - summary: Returns the number of InkWords in the page. Read-only. + summary: Returns the number of InkWords in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationloadoptions.yml index a556e469d2..478699ad45 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationloadoptions.yml @@ -16,8 +16,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationupdatedata.yml index 6b47c7cdc7..0618d665d0 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.applicationupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.ApplicationUpdateData uid: 'onenote!OneNote.Interfaces.ApplicationUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.ApplicationUpdateData -summary: 'An interface for updating data on the Application object, for use in `application.set({ ... })`.' +summary: 'An interface for updating data on the `Application` object, for use in `application.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.floatinginkloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.floatinginkloadoptions.yml index 5a2171d7da..3015a7dcfc 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.floatinginkloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.floatinginkloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageloadoptions.yml index 887c8dbc7e..a56134d65f 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -88,7 +88,7 @@ properties: package: onenote! fullName: pageContent summary: >- - Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. + Gets the PageContent object that contains the Image. Throws if the Image isn't a direct child of a PageContent. This object defines the position of the Image on the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false @@ -101,7 +101,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ImageLoadOptions#paragraph:member' package: onenote! fullName: paragraph - summary: Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. + summary: Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageupdatedata.yml index fc55b3b39b..bee3082bb9 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.imageupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.ImageUpdateData uid: 'onenote!OneNote.Interfaces.ImageUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.ImageUpdateData -summary: 'An interface for updating data on the Image object, for use in `image.set({ ... })`.' +summary: 'An interface for updating data on the `Image` object, for use in `image.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionloadoptions.yml index 000a7a9798..e6303379eb 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionupdatedata.yml index 5bb7e2e51b..c12599e7f3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislinecollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.InkAnalysisLineCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisLineCollectionUpdateData summary: >- - An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ + An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineloadoptions.yml index a1059c8efc..d1cdf3027c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineupdatedata.yml index a7207a9c89..04297e15bb 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysislineupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.InkAnalysisLineUpdateData uid: 'onenote!OneNote.Interfaces.InkAnalysisLineUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisLineUpdateData -summary: 'An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`.' +summary: 'An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionloadoptions.yml index bcff0cfa35..d6367c6323 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionupdatedata.yml index 0862fe8401..fd78c3ccd2 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphcollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData:interf package: onenote! fullName: OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData summary: >- - An interface for updating data on the InkAnalysisParagraphCollection object, for use in + An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphloadoptions.yml index cd6c92d941..d17964a85c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphupdatedata.yml index c640496b67..1776db5547 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisparagraphupdatedata.yml @@ -4,8 +4,8 @@ uid: 'onenote!OneNote.Interfaces.InkAnalysisParagraphUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisParagraphUpdateData summary: >- - An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. + An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... + })`. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisupdatedata.yml index 0ea7dd0d03..5b10e78d74 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysisupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.InkAnalysisUpdateData uid: 'onenote!OneNote.Interfaces.InkAnalysisUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisUpdateData -summary: 'An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`.' +summary: 'An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionloadoptions.yml index f93ffb124a..f179060b94 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionupdatedata.yml index c5292bf5eb..313ee20dd0 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordcollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.InkAnalysisWordCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisWordCollectionUpdateData summary: >- - An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ + An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordloadoptions.yml index d14b2c304e..c0c42d41d5 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordupdatedata.yml index 16d2f3e703..a47e9049be 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkanalysiswordupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.InkAnalysisWordUpdateData uid: 'onenote!OneNote.Interfaces.InkAnalysisWordUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkAnalysisWordUpdateData -summary: 'An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`.' +summary: 'An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionloadoptions.yml index 040ec2371e..a5b3b6bd08 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionupdatedata.yml index dcfd7cf0f1..082132a2fe 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokecollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.InkStrokeCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkStrokeCollectionUpdateData summary: >- - An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokeloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokeloadoptions.yml index 93399833dc..1a44d0caee 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokeloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkstrokeloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionloadoptions.yml index 0c4482e0a9..f12567bc54 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.InkWordCollectionLoadOptions#languageId:member' package: onenote! fullName: languageId - summary: 'For EACH ITEM in the collection: The id of the recognized language in this ink word. Read-only.' + summary: 'For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionupdatedata.yml index 048842a773..477677ec05 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordcollectionupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.InkWordCollectionUpdateData uid: 'onenote!OneNote.Interfaces.InkWordCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.InkWordCollectionUpdateData -summary: 'An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`.' +summary: 'An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordloadoptions.yml index 199f21fbbc..b844348521 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.inkwordloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.InkWordLoadOptions#languageId:member' package: onenote! fullName: languageId - summary: The id of the recognized language in this ink word. Read-only. + summary: The ID of the recognized language in this ink word. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionloadoptions.yml index 8d1546b6bf..aa1bb8187e 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookCollectionLoadOptions#baseUrl:member' package: onenote! fullName: baseUrl - summary: 'For EACH ITEM in the collection: The url of the site where this notebook is located. Read only' + summary: 'For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookCollectionLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: 'For EACH ITEM in the collection: The client url of the notebook. Read only' + summary: 'For EACH ITEM in the collection: The client URL of the notebook. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -64,8 +64,8 @@ properties: package: onenote! fullName: isVirtual summary: >- - For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). - Read only + For EACH ITEM in the collection: True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). + Read-only. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -101,7 +101,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookCollectionLoadOptions#sections:member' package: onenote! fullName: sections - summary: 'For EACH ITEM in the collection: The sections of the notebook. Read only' + summary: 'For EACH ITEM in the collection: The sections of the notebook. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionupdatedata.yml index 3e784f1877..b0e2c1698c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookcollectionupdatedata.yml @@ -3,7 +3,9 @@ name: OneNote.Interfaces.NotebookCollectionUpdateData uid: 'onenote!OneNote.Interfaces.NotebookCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.NotebookCollectionUpdateData -summary: 'An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`.' +summary: >- + An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookdata.yml index 9e7d16d460..542de99fb3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookdata.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookData#baseUrl:member' package: onenote! fullName: baseUrl - summary: The url of the site where this notebook is located. Read only + summary: The URL of the site where this notebook is located. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookData#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the notebook. Read only + summary: The client URL of the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookData#isVirtual:member' package: onenote! fullName: isVirtual - summary: 'True if the notebook is not created by the user (i.e., ''Misplaced Sections''). Read only' + summary: '''* True if the notebook isn''t created by the user (i.e., ''Misplaced Sections''). Read-only.' remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -85,7 +85,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookData#sections:member' package: onenote! fullName: sections - summary: The sections of the notebook. Read only + summary: The sections of the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookloadoptions.yml index 3e0d896500..66b09b9c02 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notebookloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookLoadOptions#baseUrl:member' package: onenote! fullName: baseUrl - summary: The url of the site where this notebook is located. Read only + summary: The URL of the site where this notebook is located. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the notebook. Read only + summary: The client URL of the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookLoadOptions#isVirtual:member' package: onenote! fullName: isVirtual - summary: 'True if the notebook is not created by the user (i.e., ''Misplaced Sections''). Read only' + summary: 'True if the notebook isn''t created by the user (i.e., ''Misplaced Sections''). Read-only.' remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookLoadOptions#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: The section groups in the notebook. Read only + summary: The section groups in the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Interfaces.NotebookLoadOptions#sections:member' package: onenote! fullName: sections - summary: The sections of the notebook. Read only + summary: The sections of the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notetagloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notetagloadoptions.yml index 101306484d..afc82292f1 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notetagloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.notetagloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.outlineloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.outlineloadoptions.yml index 7c38b2590d..f4fa57f568 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.outlineloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.outlineloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionloadoptions.yml index 6865766f8c..ebd052c086 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageCollectionLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: 'For EACH ITEM in the collection: The client url of the page. Read only' + summary: 'For EACH ITEM in the collection: The client URL of the page. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -77,7 +77,7 @@ properties: fullName: inkAnalysisOrNull summary: >- For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink - analysis information. + analysis information. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionupdatedata.yml index 9defff3539..78e3907140 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecollectionupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.PageCollectionUpdateData uid: 'onenote!OneNote.Interfaces.PageCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.PageCollectionUpdateData -summary: 'An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`.' +summary: 'An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionloadoptions.yml index 61334e5537..768ecbbd8f 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -41,7 +41,7 @@ properties: fullName: image summary: >- For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType - is not Image. + isn't Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -54,8 +54,8 @@ properties: package: onenote! fullName: ink summary: >- - For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType is - not Ink. + For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType + isn't Ink. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -81,7 +81,7 @@ properties: fullName: outline summary: >- For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if - PageContentType is not Outline. + PageContentType isn't Outline. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionupdatedata.yml index d9d865b0c9..5332400e7c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentcollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.PageContentCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.PageContentCollectionUpdateData summary: >- - An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... + An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentdata.yml index 5cd69bcdd0..ec6f1ec5e3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentdata.yml @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageContentData#image:member' package: onenote! fullName: image - summary: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + summary: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageContentData#ink:member' package: onenote! fullName: ink - summary: Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + summary: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -61,7 +61,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageContentData#outline:member' package: onenote! fullName: outline - summary: Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. + summary: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentloadoptions.yml index ef67fb9aa9..3cf31ff8c2 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentloadoptions.yml @@ -16,8 +16,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentupdatedata.yml index a616eb0312..d5386b9666 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagecontentupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.PageContentUpdateData uid: 'onenote!OneNote.Interfaces.PageContentUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.PageContentUpdateData -summary: 'An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`.' +summary: 'An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageContentUpdateData#image:member' package: onenote! fullName: image - summary: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + summary: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagedata.yml index 84aa99fd65..2e88633616 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pagedata.yml @@ -61,7 +61,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageData#inkAnalysisOrNull:member' package: onenote! fullName: inkAnalysisOrNull - summary: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + summary: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -97,7 +97,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageData#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web URL of the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageloadoptions.yml index 5c91928400..cff67dfae6 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the page. Read only + summary: The client URL of the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageLoadOptions#contents:member' package: onenote! fullName: contents - summary: The collection of PageContent objects on the page. Read only + summary: The collection of PageContent objects on the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -123,7 +123,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageLoadOptions#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web URL of the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageupdatedata.yml index b5e2127e7b..a5ca3460a1 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pageupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.PageUpdateData uid: 'onenote!OneNote.Interfaces.PageUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.PageUpdateData -summary: 'An interface for updating data on the Page object, for use in `page.set({ ... })`.' +summary: 'An interface for updating data on the `Page` object, for use in `page.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Interfaces.PageUpdateData#inkAnalysisOrNull:member' package: onenote! fullName: inkAnalysisOrNull - summary: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + summary: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphcollectionloadoptions.yml index 09f7e4af01..f11b5485c7 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -40,8 +40,8 @@ properties: package: onenote! fullName: image summary: >- - For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is - not Image. + For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType + isn't Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -54,8 +54,8 @@ properties: package: onenote! fullName: inkWords summary: >- - For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is - not Ink. + For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType + isn't Ink. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -79,7 +79,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphCollectionLoadOptions#paragraphs:member' package: onenote! fullName: paragraphs - summary: 'For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read only' + summary: 'For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -91,7 +91,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphCollectionLoadOptions#parentParagraph:member' package: onenote! fullName: parentParagraph - summary: 'For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph does not exist.' + summary: 'For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn''t exist.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -104,7 +104,7 @@ properties: package: onenote! fullName: parentParagraphOrNull summary: >- - For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph does not + For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false @@ -118,8 +118,8 @@ properties: package: onenote! fullName: parentTableCell summary: >- - For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is - not a TableCell, throws ItemNotFound. + 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. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -147,7 +147,7 @@ properties: fullName: richText summary: >- For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType - is not RichText. + isn't RichText. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -160,8 +160,8 @@ properties: package: onenote! fullName: table summary: >- - For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is - not Table. + For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType + isn't Table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphdata.yml index 45adce15d3..181d1cce3e 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphdata.yml @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphData#image:member' package: onenote! fullName: image - summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphData#inkWords:member' package: onenote! fullName: inkWords - summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphloadoptions.yml index cfd927f9ad..ed7cd6a9f8 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#image:member' package: onenote! fullName: image - summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. + summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#inkWords:member' package: onenote! fullName: inkWords - summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. + summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#paragraphs:member' package: onenote! fullName: paragraphs - summary: The collection of paragraphs under this paragraph. Read only + summary: The collection of paragraphs under this paragraph. Read -nly. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#parentParagraph:member' package: onenote! fullName: parentParagraph - summary: Gets the parent paragraph object. Throws if a parent paragraph does not exist. + summary: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#parentParagraphOrNull:member' package: onenote! fullName: parentParagraphOrNull - summary: Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + summary: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -112,7 +112,7 @@ properties: package: onenote! fullName: parentTableCell summary: >- - Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws + Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false @@ -137,7 +137,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#richText:member' package: onenote! fullName: richText - summary: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + summary: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -149,7 +149,7 @@ properties: uid: 'onenote!OneNote.Interfaces.ParagraphLoadOptions#table:member' package: onenote! fullName: table - summary: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + summary: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphupdatedata.yml index af783bd0a2..46ad2e4a99 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.paragraphupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.ParagraphUpdateData uid: 'onenote!OneNote.Interfaces.ParagraphUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.ParagraphUpdateData -summary: 'An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`.' +summary: 'An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionloadoptions.yml index 42d5d1d41b..d58e66ef04 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionupdatedata.yml index 5d9d463cdf..4b14d5e4b3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointcollectionupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.PointCollectionUpdateData uid: 'onenote!OneNote.Interfaces.PointCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.PointCollectionUpdateData -summary: 'An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`.' +summary: 'An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointloadoptions.yml index 0075cff088..bcbb46b31f 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.pointloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextdata.yml index e5162b8b69..acd244a2f4 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextdata.yml @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Interfaces.RichTextData#languageId:member' package: onenote! fullName: languageId - summary: The language id of the text. Read-only. + summary: The language ID of the text. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextloadoptions.yml index f18264a8fe..82410c385d 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.richtextloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Interfaces.RichTextLoadOptions#languageId:member' package: onenote! fullName: languageId - summary: The language id of the text. Read-only. + summary: The language ID of the text. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionloadoptions.yml index f271cf3187..e056b837ef 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionCollectionLoadOptions#isLocked:member' package: onenote! fullName: isLocked - summary: 'For EACH ITEM in the collection: True if this section is locked. Read only' + summary: 'For EACH ITEM in the collection: True if this section is locked. Read-only.' remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -139,7 +139,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionCollectionLoadOptions#webUrl:member' package: onenote! fullName: webUrl - summary: 'For EACH ITEM in the collection: The web url of the page. Read only' + summary: 'For EACH ITEM in the collection: The web URL of the page. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionupdatedata.yml index c546d53d51..7fb35751b8 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectioncollectionupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.SectionCollectionUpdateData uid: 'onenote!OneNote.Interfaces.SectionCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.SectionCollectionUpdateData -summary: 'An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`.' +summary: 'An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiondata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiondata.yml index 7c5499e016..a54e112333 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiondata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiondata.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionData#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section. Read only + summary: The client URL of the section. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionData#isEncrypted:member' package: onenote! fullName: isEncrypted - summary: True if this section is encrypted with a password. Read only + summary: True if this section is encrypted with a password. Read-only. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionData#isLocked:member' package: onenote! fullName: isLocked - summary: True if this section is locked. Read only + summary: True if this section is locked. Read-only. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -73,7 +73,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionData#pages:member' package: onenote! fullName: pages - summary: The collection of pages in the section. Read only + summary: The collection of pages in the section. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -85,7 +85,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionData#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web URL of the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionloadoptions.yml index 25e1df6ff9..dc1a5377e8 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -103,7 +103,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupCollectionLoadOptions#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: 'For EACH ITEM in the collection: The collection of section groups in the section group. Read only' + summary: 'For EACH ITEM in the collection: The collection of section groups in the section group. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -115,7 +115,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupCollectionLoadOptions#sections:member' package: onenote! fullName: sections - summary: 'For EACH ITEM in the collection: The collection of sections in the section group. Read only' + summary: 'For EACH ITEM in the collection: The collection of sections in the section group. Read-only.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionupdatedata.yml index b503eb0728..b7f51b00c8 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupcollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.SectionGroupCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.SectionGroupCollectionUpdateData summary: >- - An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... + An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupdata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupdata.yml index 51e6a3b8f1..aea252bf84 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupdata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongroupdata.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupData#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section group. Read only + summary: The client url of the section group. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupData#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: The collection of section groups in the section group. Read only + summary: The collection of section groups in the section group. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -61,7 +61,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupData#sections:member' package: onenote! fullName: sections - summary: The collection of sections in the section group. Read only + summary: The collection of sections in the section group. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongrouploadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongrouploadoptions.yml index e7f302ba2e..f4744531a3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongrouploadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectiongrouploadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section group. Read only + summary: The client URL of the section group. Read.only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -103,7 +103,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupLoadOptions#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: The collection of section groups in the section group. Read only + summary: The collection of section groups in the section group. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -115,7 +115,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionGroupLoadOptions#sections:member' package: onenote! fullName: sections - summary: The collection of sections in the section group. Read only + summary: The collection of sections in the section group. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectionloadoptions.yml index 07fa07d035..9c17b76ba6 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.sectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionLoadOptions#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section. Read only + summary: The client URL of the section. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionLoadOptions#isLocked:member' package: onenote! fullName: isLocked - summary: True if this section is locked. Read only + summary: True if this section is locked. Read-only. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionLoadOptions#pages:member' package: onenote! fullName: pages - summary: The collection of pages in the section. Read only + summary: The collection of pages in the section. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -137,7 +137,7 @@ properties: uid: 'onenote!OneNote.Interfaces.SectionLoadOptions#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web URL of the page. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionloadoptions.yml index 9c00c96761..0f5bc486a0 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionupdatedata.yml index 3712a08110..20de0c1ec3 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellcollectionupdatedata.yml @@ -4,7 +4,7 @@ uid: 'onenote!OneNote.Interfaces.TableCellCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.TableCellCollectionUpdateData summary: >- - An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. remarks: '' isPreview: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecelldata.yml index 59c7065d41..98524dda33 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecelldata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecelldata.yml @@ -61,7 +61,7 @@ properties: uid: 'onenote!OneNote.Interfaces.TableCellData#shadingColor:member' package: onenote! fullName: shadingColor - summary: Gets and sets the shading color of the cell + summary: Gets and sets the shading color of the cell. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellloadoptions.yml index 555321d407..b7db0dfb46 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellupdatedata.yml index 15e532e88d..9563845711 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablecellupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.TableCellUpdateData uid: 'onenote!OneNote.Interfaces.TableCellUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.TableCellUpdateData -summary: 'An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`.' +summary: 'An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableloadoptions.yml index 2afaa4e5d2..fad1846018 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionloadoptions.yml index 747b2ea3d4..a1d8e3e15d 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionupdatedata.yml index be3c6c07ce..16ffdb8bef 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowcollectionupdatedata.yml @@ -3,7 +3,9 @@ name: OneNote.Interfaces.TableRowCollectionUpdateData uid: 'onenote!OneNote.Interfaces.TableRowCollectionUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.TableRowCollectionUpdateData -summary: 'An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`.' +summary: >- + An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowloadoptions.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowloadoptions.yml index 223a6c6c07..6a2a7c7ce2 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowloadoptions.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tablerowloadoptions.yml @@ -14,8 +14,8 @@ properties: package: onenote! fullName: $all summary: >- - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the - navigational properties (e.g.: `Range.format.fill.color`). + 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`). remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableupdatedata.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableupdatedata.yml index 72941b6fc7..6e39ab1667 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableupdatedata.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.interfaces.tableupdatedata.yml @@ -3,7 +3,7 @@ name: OneNote.Interfaces.TableUpdateData uid: 'onenote!OneNote.Interfaces.TableUpdateData:interface' package: onenote! fullName: OneNote.Interfaces.TableUpdateData -summary: 'An interface for updating data on the Table object, for use in `table.set({ ... })`.' +summary: 'An interface for updating data on the `Table` object, for use in `table.set({ ... })`.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.notebook.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.notebook.yml index e6cfdae91c..db59b01ddd 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.notebook.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.notebook.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Notebook#baseUrl:member' package: onenote! fullName: baseUrl - summary: The url of the site where this notebook is located. Read only + summary: The url of the site where this notebook is located. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Notebook#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the notebook. Read only + summary: The client url of the notebook. Read-only. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Notebook#isVirtual:member' package: onenote! fullName: isVirtual - summary: 'True if the notebook is not created by the user (i.e., ''Misplaced Sections''). Read only' + summary: 'True if the notebook isn''t created by the user (i.e., ''Misplaced Sections'').' remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.Notebook#name:member' package: onenote! fullName: name - summary: Gets the name of the notebook. Read-only. + summary: Gets the name of the notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Notebook#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: The section groups in the notebook. Read only + summary: The section groups in the notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Notebook#sections:member' package: onenote! fullName: sections - summary: The sections of the notebook. Read only + summary: The sections of the notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -311,10 +311,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -329,10 +329,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -347,9 +348,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.notebookcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.notebookcollection.yml index 5e8b1eb23c..089be83db6 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.notebookcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.notebookcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.NotebookCollection#count:member' package: onenote! fullName: count - summary: Returns the number of notebooks in the collection. Read-only. + summary: Returns the number of notebooks in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -221,7 +221,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -239,10 +239,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -257,9 +258,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.notetag.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.notetag.yml index ca3243c89d..de64c89422 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.notetag.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.notetag.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.NoteTag#id:member' package: onenote! fullName: id - summary: Gets the Id of the NoteTag object. Read-only. + summary: Gets the Id of the NoteTag object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.NoteTag#status:member' package: onenote! fullName: status - summary: Gets the status of the NoteTag object. Read-only. + summary: Gets the status of the NoteTag object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -55,7 +55,7 @@ properties: uid: 'onenote!OneNote.NoteTag#type:member' package: onenote! fullName: type - summary: Gets the type of the NoteTag object. Read-only. + summary: Gets the type of the NoteTag object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -141,8 +141,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.NoteTag object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -159,10 +159,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -177,9 +178,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.outline.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.outline.yml index ef0a53ea7e..1533bcb1f4 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.outline.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.outline.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Outline#id:member' package: onenote! fullName: id - summary: Gets the ID of the Outline object. Read-only. + summary: Gets the ID of the Outline object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -41,7 +41,7 @@ properties: fullName: pageContent summary: >- Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the - page. Read-only. + page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -53,7 +53,7 @@ properties: uid: 'onenote!OneNote.Outline#paragraphs:member' package: onenote! fullName: paragraphs - summary: Gets the collection of Paragraph objects in the Outline. Read-only. + summary: Gets the collection of Paragraph objects in the Outline. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -107,8 +107,8 @@ methods: - id: html description: >- The HTML string to append. See [Supported - HTML](https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) for - the OneNote add-ins JavaScript API. + HTML](https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) + for the OneNote add-ins JavaScript API. type: string return: type: void @@ -292,8 +292,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Outline object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -310,10 +310,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -328,9 +329,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.page.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.page.yml index 0ac4b326ec..2565086299 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.page.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.page.yml @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.Page#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the page. Read only + summary: The client url of the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Page#id:member' package: onenote! fullName: id - summary: Gets the ID of the page. Read-only. + summary: Gets the ID of the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Page#parentSection:member' package: onenote! fullName: parentSection - summary: Gets the section that contains the page. Read-only. + summary: Gets the section that contains the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -123,7 +123,7 @@ properties: uid: 'onenote!OneNote.Page#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web url of the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -185,8 +185,8 @@ methods: - id: html description: >- An HTML string that describes the visual presentation of the Outline. See [Supported - HTML](https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) for - the OneNote add-ins JavaScript API. + HTML](https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) + for the OneNote add-ins JavaScript API. type: string return: type: '' @@ -195,7 +195,7 @@ methods: uid: 'onenote!OneNote.Page#analyzePage:member(1)' package: onenote! fullName: analyzePage() - summary: Return a json string with node id and content in html format. + summary: Return a JSON string with node ID and content in HTML format. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -216,7 +216,7 @@ methods: content: 'applyTranslation(translatedContent: string): void;' parameters: - id: translatedContent - description: Translated content of the page + description: Translated content of the page. type: string return: type: void @@ -537,8 +537,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Page object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -555,10 +555,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -573,9 +574,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecollection.yml index f2e579b64e..f85b122c60 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.PageCollection#count:member' package: onenote! fullName: count - summary: Returns the number of pages in the collection. Read-only. + summary: Returns the number of pages in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -224,7 +224,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -242,10 +242,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -260,9 +261,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontent.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontent.yml index 78f6dab945..57a3918b2c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontent.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontent.yml @@ -29,7 +29,7 @@ properties: uid: 'onenote!OneNote.PageContent#id:member' package: onenote! fullName: id - summary: Gets the ID of the PageContent object. Read-only. + summary: Gets the ID of the PageContent object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -89,7 +89,7 @@ properties: uid: 'onenote!OneNote.PageContent#parentPage:member' package: onenote! fullName: parentPage - summary: Gets the page that contains the PageContent object. Read-only. + summary: Gets the page that contains the PageContent object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -113,7 +113,7 @@ properties: uid: 'onenote!OneNote.PageContent#type:member' package: onenote! fullName: type - summary: Gets the type of the PageContent object. Read-only. + summary: Gets the type of the PageContent object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -270,8 +270,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.PageContent object is an API object, the `toJSON` method returns a + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -288,10 +288,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -306,9 +307,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontentcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontentcollection.yml index 293ce95aae..89f479c1ce 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontentcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.pagecontentcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.PageContentCollection#count:member' package: onenote! fullName: count - summary: Returns the number of page contents in the collection. Read-only. + summary: Returns the number of page contents in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -191,7 +191,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -209,10 +209,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -227,9 +228,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraph.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraph.yml index dcae9c3afd..2f4e80ce04 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraph.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraph.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Paragraph#id:member' package: onenote! fullName: id - summary: Gets the ID of the Paragraph object. Read-only. + summary: Gets the ID of the Paragraph object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Paragraph#image:member' package: onenote! fullName: image - summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + summary: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.Paragraph#inkWords:member' package: onenote! fullName: inkWords - summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + summary: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Paragraph#outline:member' package: onenote! fullName: outline - summary: Gets the Outline object that contains the Paragraph. Read-only. + summary: Gets the Outline object that contains the Paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.Paragraph#paragraphs:member' package: onenote! fullName: paragraphs - summary: The collection of paragraphs under this paragraph. Read only + summary: The collection of paragraphs under this paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Paragraph#parentParagraph:member' package: onenote! fullName: parentParagraph - summary: Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. + summary: Gets the parent paragraph object. Throws if a parent paragraph does not exist. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Paragraph#parentParagraphOrNull:member' package: onenote! fullName: parentParagraphOrNull - summary: Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. + summary: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -112,8 +112,8 @@ properties: package: onenote! fullName: parentTableCell summary: >- - Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws - ItemNotFound. Read-only. + Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws + ItemNotFound. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -125,9 +125,7 @@ properties: uid: 'onenote!OneNote.Paragraph#parentTableCellOrNull:member' package: onenote! fullName: parentTableCellOrNull - summary: >- - Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. - Read-only. + summary: 'Gets the TableCell object that contains the Paragraph if one exists. If parent isn''t a TableCell, returns null.' remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +149,7 @@ properties: uid: 'onenote!OneNote.Paragraph#table:member' package: onenote! fullName: table - summary: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only. + summary: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -163,7 +161,7 @@ properties: uid: 'onenote!OneNote.Paragraph#type:member' package: onenote! fullName: type - summary: Gets the type of the Paragraph object. Read-only. + summary: Gets the type of the Paragraph object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -322,8 +320,8 @@ methods: - id: html description: >- An HTML string that describes the visual presentation of the content. See [Supported - HTML](https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) for - the OneNote add-ins JavaScript API. + HTML](https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) + for the OneNote add-ins JavaScript API. type: string return: type: void @@ -413,7 +411,7 @@ methods: uid: 'onenote!OneNote.Paragraph#insertImageAsSibling:member(2)' package: onenote! fullName: 'insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)' - summary: Inserts the image at the specified insert location.. + summary: Inserts the image at the specified insert location. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -705,10 +703,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -723,10 +721,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -741,9 +740,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphcollection.yml index f09c40e969..0f81408146 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.ParagraphCollection#count:member' package: onenote! fullName: count - summary: Returns the number of paragraphs in the page. Read-only. + summary: Returns the number of paragraphs in the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -205,7 +205,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -223,10 +223,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -241,9 +242,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphinfo.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphinfo.yml index 6d4235d14e..7da7b76804 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphinfo.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.paragraphinfo.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.ParagraphInfo#bulletType:member' package: onenote! fullName: bulletType - summary: // Bullet list type of paragraph + summary: Bullet list type of paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.ParagraphInfo#indentationLevel:member' package: onenote! fullName: indentationLevel - summary: // Level of indentation of the paragraph + summary: Level of indentation of the paragraph. remarks: '\[ [API set: OneNoteApi 1.8](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'onenote!OneNote.ParagraphInfo#index:member' package: onenote! fullName: index - summary: // Index of paragraph in a list + summary: Index of paragraph in a list. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'onenote!OneNote.ParagraphInfo#listType:member' package: onenote! fullName: listType - summary: // Type of list in paragraph + summary: Type of list in paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -61,7 +61,7 @@ properties: uid: 'onenote!OneNote.ParagraphInfo#numberType:member' package: onenote! fullName: numberType - summary: // Numbered list type of paragraph + summary: Numbered list type of paragraph. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.point.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.point.yml index 786de399da..069e0a56fd 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.point.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.point.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.Point#id:member' package: onenote! fullName: id - summary: Gets the ID of the Point object. Read-only. + summary: Gets the ID of the Point object. remarks: '\[ [API set: OneNoteApi 1.9](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -133,8 +133,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Point object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -151,10 +151,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -169,9 +170,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.pointcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.pointcollection.yml index 32ddadfabe..b8755a1d82 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.pointcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.pointcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.PointCollection#count:member' package: onenote! fullName: count - summary: Returns the number of Point in the stroke. Read-only. + summary: Returns the number of Point in the stroke. remarks: '\[ [API set: OneNoteApi 1.9](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.richtext.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.richtext.yml index be4825b7f1..6de902d0fe 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.richtext.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.richtext.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.RichText#id:member' package: onenote! fullName: id - summary: Gets the ID of the RichText object. Read-only. + summary: Gets the ID of the RichText object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.RichText#languageId:member' package: onenote! fullName: languageId - summary: The language id of the text. Read-only. + summary: The language id of the text. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.RichText#paragraph:member' package: onenote! fullName: paragraph - summary: Gets the Paragraph object that contains the RichText object. Read-only. + summary: Gets the Paragraph object that contains the RichText object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -88,7 +88,7 @@ methods: uid: 'onenote!OneNote.RichText#getHtml:member(1)' package: onenote! fullName: getHtml() - summary: Get the HTML of the rich text + summary: Gets the HTML of the rich text. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -224,10 +224,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -242,10 +242,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -260,9 +261,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.section.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.section.yml index 292f37c721..7807be3de6 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.section.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.section.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.Section#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section. Read only + summary: The client url of the section. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.Section#id:member' package: onenote! fullName: id - summary: Gets the ID of the section. Read-only. + summary: Gets the ID of the section. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.Section#isEncrypted:member' package: onenote! fullName: isEncrypted - summary: True if this section is encrypted with a password. Read only + summary: True if this section is encrypted with a password. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Section#isLocked:member' package: onenote! fullName: isLocked - summary: True if this section is locked. Read only + summary: True if this section is locked. remarks: '\[ [API set: OneNoteApi 1.2](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.Section#name:member' package: onenote! fullName: name - summary: Gets the name of the section. Read-only. + summary: Gets the name of the section. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Section#notebook:member' package: onenote! fullName: notebook - summary: Gets the notebook that contains the section. Read-only. + summary: Gets the notebook that contains the section. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -99,7 +99,7 @@ properties: uid: 'onenote!OneNote.Section#pages:member' package: onenote! fullName: pages - summary: The collection of pages in the section. Read only + summary: The collection of pages in the section. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -113,7 +113,7 @@ properties: fullName: parentSectionGroup summary: >- Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the - notebook. Read-only. + notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -139,7 +139,7 @@ properties: uid: 'onenote!OneNote.Section#webUrl:member' package: onenote! fullName: webUrl - summary: The web url of the page. Read only + summary: The web URL of the page. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -458,8 +458,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Section object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -476,10 +476,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -494,9 +495,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.sectioncollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.sectioncollection.yml index 54bf8c3efb..02ef49d559 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.sectioncollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.sectioncollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.SectionCollection#count:member' package: onenote! fullName: count - summary: Returns the number of sections in the collection. Read-only. + summary: Returns the number of sections in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -226,7 +226,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -244,10 +244,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -262,9 +263,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroup.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroup.yml index dbf30b0e2f..636caf3661 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroup.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroup.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#clientUrl:member' package: onenote! fullName: clientUrl - summary: The client url of the section group. Read only + summary: The client URL of the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#id:member' package: onenote! fullName: id - summary: Gets the ID of the section group. Read-only. + summary: Gets the ID of the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#name:member' package: onenote! fullName: name - summary: Gets the name of the section group. Read-only. + summary: Gets the name of the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#notebook:member' package: onenote! fullName: notebook - summary: Gets the notebook that contains the section group. Read-only. + summary: Gets the notebook that contains the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -77,7 +77,7 @@ properties: fullName: parentSectionGroup summary: >- Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child - of the notebook. Read-only. + of the notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -91,7 +91,7 @@ properties: fullName: parentSectionGroupOrNull summary: >- Gets the section group that contains the section group. Returns null if the section group is a direct child of the - notebook. Read-only. + notebook. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -103,7 +103,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#sectionGroups:member' package: onenote! fullName: sectionGroups - summary: The collection of section groups in the section group. Read only + summary: The collection of section groups in the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -115,7 +115,7 @@ properties: uid: 'onenote!OneNote.SectionGroup#sections:member' package: onenote! fullName: sections - summary: The collection of sections in the section group. Read only + summary: The collection of sections in the section group. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -324,8 +324,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.SectionGroup object is an API object, the `toJSON` method returns a + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -342,10 +342,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -360,9 +361,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroupcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroupcollection.yml index 3d17505882..628363cf58 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroupcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.sectiongroupcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.SectionGroupCollection#count:member' package: onenote! fullName: count - summary: Returns the number of section groups in the collection. Read-only. + summary: Returns the number of section groups in the collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -223,7 +223,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -241,10 +241,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -259,9 +260,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.table.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.table.yml index 217e7d368e..3243aa221c 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.table.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.table.yml @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.Table#id:member' package: onenote! fullName: id - summary: Gets the ID of the table. Read-only. + summary: Gets the ID of the table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.Table#paragraph:member' package: onenote! fullName: paragraph - summary: Gets the Paragraph object that contains the Table object. Read-only. + summary: Gets the Paragraph object that contains the Table object. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.Table#rows:member' package: onenote! fullName: rows - summary: Gets all of the table rows. Read-only. + summary: Gets all of the table rows. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -520,8 +520,8 @@ methods: fullName: toJSON() summary: >- 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.) Whereas the original OneNote.Table object is an API object, the `toJSON` method returns a plain + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' @@ -538,10 +538,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -556,9 +557,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.tablecell.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.tablecell.yml index 3d4635004b..de96bc01ff 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.tablecell.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.tablecell.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.TableCell#cellIndex:member' package: onenote! fullName: cellIndex - summary: Gets the index of the cell in its row. Read-only. + summary: Gets the index of the cell in its row. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'onenote!OneNote.TableCell#id:member' package: onenote! fullName: id - summary: Gets the ID of the cell. Read-only. + summary: Gets the ID of the cell. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.TableCell#paragraphs:member' package: onenote! fullName: paragraphs - summary: Gets the collection of Paragraph objects in the TableCell. Read-only. + summary: Gets the collection of Paragraph objects in the TableCell. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.TableCell#parentRow:member' package: onenote! fullName: parentRow - summary: Gets the parent row of the cell. Read-only. + summary: Gets the parent row of the cell. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.TableCell#rowIndex:member' package: onenote! fullName: rowIndex - summary: Gets the index of the cell's row in the table. Read-only. + summary: Gets the index of the cell's row in the table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'onenote!OneNote.TableCell#shadingColor:member' package: onenote! fullName: shadingColor - summary: Gets and sets the shading color of the cell + summary: Gets and sets the shading color of the cell. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -139,8 +139,8 @@ methods: - id: html description: >- The HTML string to append. See [Supported - HTML](https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) for - the OneNote add-ins JavaScript API. + HTML](https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html) + for the OneNote add-ins JavaScript API. type: string return: type: void @@ -400,10 +400,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -418,10 +418,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -436,9 +437,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.tablecellcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.tablecellcollection.yml index dcec3d1449..3d37e92cf7 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.tablecellcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.tablecellcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.TableCellCollection#count:member' package: onenote! fullName: count - summary: Returns the number of tablecells in this collection. Read-only. + summary: Returns the number of tablecells in this collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.tablerow.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.tablerow.yml index 18e36eead6..0c8f1fc2f7 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.tablerow.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.tablerow.yml @@ -13,7 +13,7 @@ properties: uid: 'onenote!OneNote.TableRow#cellCount:member' package: onenote! fullName: cellCount - summary: Gets the number of cells in the row. Read-only. + summary: Gets the number of cells in the row. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'onenote!OneNote.TableRow#cells:member' package: onenote! fullName: cells - summary: Gets the cells in the row. Read-only. + summary: Gets the cells in the row. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'onenote!OneNote.TableRow#id:member' package: onenote! fullName: id - summary: Gets the ID of the row. Read-only. + summary: Gets the ID of the row. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'onenote!OneNote.TableRow#parentTable:member' package: onenote! fullName: parentTable - summary: Gets the parent table. Read-only. + summary: Gets the parent table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -75,7 +75,7 @@ properties: uid: 'onenote!OneNote.TableRow#rowIndex:member' package: onenote! fullName: rowIndex - summary: Gets the index of the row in its parent table. Read-only. + summary: Gets the index of the row in its parent table. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -307,10 +307,10 @@ methods: fullName: toJSON() summary: >- 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.) 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. + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's + passed to it.) 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. remarks: '' isPreview: false isDeprecated: false @@ -325,10 +325,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -343,9 +344,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/onenote/onenote/onenote.tablerowcollection.yml b/docs/docs-ref-autogen/onenote/onenote/onenote.tablerowcollection.yml index 930072243b..1addf4d947 100644 --- a/docs/docs-ref-autogen/onenote/onenote/onenote.tablerowcollection.yml +++ b/docs/docs-ref-autogen/onenote/onenote/onenote.tablerowcollection.yml @@ -27,7 +27,7 @@ properties: uid: 'onenote!OneNote.TableRowCollection#count:member' package: onenote! fullName: count - summary: Returns the number of table rows in this collection. Read-only. + summary: Returns the number of table rows in this collection. remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -151,7 +151,7 @@ methods: fullName: toJSON() summary: >- 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 + `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) 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. @@ -169,10 +169,11 @@ methods: fullName: track() summary: >- Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand - for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the - object was first created. + for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false @@ -187,9 +188,9 @@ methods: fullName: untrack() summary: >- Release the memory associated with this object, if it has previously been tracked. This call is shorthand for - `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. + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). 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. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio.yml b/docs/docs-ref-autogen/visio/visio.yml index a28f2432fe..a8bf831042 100644 --- a/docs/docs-ref-autogen/visio/visio.yml +++ b/docs/docs-ref-autogen/visio/visio.yml @@ -113,9 +113,9 @@ functions: - id: batch description: >- 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. + `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. type: '(context: ) => Promise<T>' return: type: Promise<T> @@ -137,15 +137,15 @@ functions: - id: object description: >- 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()". + means that any changes applied to the object will be picked up by `context.sync()`. type: >- | - id: batch description: >- 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. + `context.sync()`). When the promise is resolved, any tracked objects that were automatically + allocated during execution will be released. type: '(context: ) => Promise<T>' return: type: Promise<T> @@ -168,13 +168,13 @@ functions: description: >- 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()". + to these objects will be picked up by `context.sync()`. type: '[]' - id: batch description: >- 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. + `context.sync()`). When the promise is resolved, any tracked objects that were automatically + allocated during execution will be released. type: '(context: ) => Promise<T>' return: type: Promise<T> @@ -203,9 +203,9 @@ functions: - id: batch description: >- 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. + `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. type: '(context: ) => Promise<T>' return: type: Promise<T> diff --git a/docs/docs-ref-autogen/visio/visio/visio.application.yml b/docs/docs-ref-autogen/visio/visio/visio.application.yml index 6ebc35771a..29dda1b2bd 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.application.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.application.yml @@ -173,23 +173,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.Application#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ApplicationData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: 'showToolbar(id, show)' uid: 'visio!Visio.Application#showToolbar:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.comment.yml b/docs/docs-ref-autogen/visio/visio/visio.comment.yml index 101ff37a36..041f2223d0 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.comment.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.comment.yml @@ -195,23 +195,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.Comment#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.CommentData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.Comment#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.commentcollection.yml b/docs/docs-ref-autogen/visio/visio/visio.commentcollection.yml index ac63e18361..097b17c899 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.commentcollection.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.commentcollection.yml @@ -156,23 +156,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.CommentCollection#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.CommentCollectionData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.CommentCollection#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.document.yml b/docs/docs-ref-autogen/visio/visio/visio.document.yml index 4911daef42..8ada520a4b 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.document.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.document.yml @@ -252,23 +252,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.Document#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.DocumentData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: 'showTaskPane(taskPaneType, initialProps, show)' uid: 'visio!Visio.Document#showTaskPane:member(1)' package: visio! @@ -320,7 +303,7 @@ methods: initialize the content of the task pane. type: any - id: show - description: 'Optional Parameter. If it is set to false, it will hide the specified task pane.' + description: 'Optional Parameter. If it''s set to false, it will hide the specified task pane.' type: boolean return: type: void diff --git a/docs/docs-ref-autogen/visio/visio/visio.documentview.yml b/docs/docs-ref-autogen/visio/visio/visio.documentview.yml index 386dcdccc5..2a7b881505 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.documentview.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.documentview.yml @@ -208,23 +208,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.DocumentView#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.DocumentViewData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.DocumentView#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.hyperlink.yml b/docs/docs-ref-autogen/visio/visio/visio.hyperlink.yml index 21dea1ebaf..4c1e639aa5 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.hyperlink.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.hyperlink.yml @@ -162,23 +162,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.Hyperlink#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.HyperlinkData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.Hyperlink#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.hyperlinkcollection.yml b/docs/docs-ref-autogen/visio/visio/visio.hyperlinkcollection.yml index 0d63fce1e0..4388c3398b 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.hyperlinkcollection.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.hyperlinkcollection.yml @@ -155,23 +155,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.HyperlinkCollection#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.HyperlinkCollection#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkcollectionloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkcollectionloadoptions.yml index 5c4c89cd48..e18fc11776 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkcollectionloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkCollectionLoadOptions#address:member' package: visio! fullName: address - summary: 'For EACH ITEM in the collection: Gets the address of the Hyperlink object.' + summary: 'For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkCollectionLoadOptions#description:member' package: visio! fullName: description - summary: 'For EACH ITEM in the collection: Gets the description of a hyperlink.' + summary: 'For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,9 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkCollectionLoadOptions#extraInfo:member' package: visio! fullName: extraInfo - summary: 'For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink''s URL.' + summary: >- + For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. + Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +65,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkCollectionLoadOptions#subAddress:member' package: visio! fullName: subAddress - summary: 'For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.' + summary: 'For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkdata.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkdata.yml index eb563ec672..0fd9475365 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkdata.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkdata.yml @@ -13,7 +13,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkData#address:member' package: visio! fullName: address - summary: Gets the address of the Hyperlink object. + summary: Gets the address of the Hyperlink object. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkData#description:member' package: visio! fullName: description - summary: Gets the description of a hyperlink. + summary: Gets the description of a hyperlink. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkData#extraInfo:member' package: visio! fullName: extraInfo - summary: Gets the extra URL request information used to resolve the hyperlink's URL. + summary: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkData#subAddress:member' package: visio! fullName: subAddress - summary: Gets the sub-address of the Hyperlink object. + summary: Gets the sub-address of the Hyperlink object. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkloadoptions.yml index 8f4af99bba..34dbfac130 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.hyperlinkloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkLoadOptions#address:member' package: visio! fullName: address - summary: Gets the address of the Hyperlink object. + summary: Gets the address of the Hyperlink object. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkLoadOptions#description:member' package: visio! fullName: description - summary: Gets the description of a hyperlink. + summary: Gets the description of a hyperlink. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkLoadOptions#extraInfo:member' package: visio! fullName: extraInfo - summary: Gets the extra URL request information used to resolve the hyperlink's URL. + summary: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'visio!Visio.Interfaces.HyperlinkLoadOptions#subAddress:member' package: visio! fullName: subAddress - summary: Gets the sub-address of the Hyperlink object. + summary: Gets the sub-address of the Hyperlink object. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.pagecollectionloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.pagecollectionloadoptions.yml index 34f885689b..f4de508511 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.pagecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.pagecollectionloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.PageCollectionLoadOptions#height:member' package: visio! fullName: height - summary: 'For EACH ITEM in the collection: Returns the height of the page.' + summary: 'For EACH ITEM in the collection: Returns the height of the page. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.PageCollectionLoadOptions#index:member' package: visio! fullName: index - summary: 'For EACH ITEM in the collection: Index of the Page.' + summary: 'For EACH ITEM in the collection: Index of the Page. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'visio!Visio.Interfaces.PageCollectionLoadOptions#isBackground:member' package: visio! fullName: isBackground - summary: 'For EACH ITEM in the collection: Whether the page is a background page or not.' + summary: 'For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'visio!Visio.Interfaces.PageCollectionLoadOptions#name:member' package: visio! fullName: name - summary: 'For EACH ITEM in the collection: Page name.' + summary: 'For EACH ITEM in the collection: Page name. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'visio!Visio.Interfaces.PageCollectionLoadOptions#width:member' package: visio! fullName: width - summary: 'For EACH ITEM in the collection: Returns the width of the page.' + summary: 'For EACH ITEM in the collection: Returns the width of the page. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.pageloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.pageloadoptions.yml index e62d1b5674..977276b0d7 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.pageloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.pageloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.PageLoadOptions#height:member' package: visio! fullName: height - summary: Returns the height of the page. + summary: Returns the height of the page. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.PageLoadOptions#index:member' package: visio! fullName: index - summary: Index of the Page. + summary: Index of the Page. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'visio!Visio.Interfaces.PageLoadOptions#isBackground:member' package: visio! fullName: isBackground - summary: Whether the page is a background page or not. + summary: Whether the page is a background page or not. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'visio!Visio.Interfaces.PageLoadOptions#name:member' package: visio! fullName: name - summary: Page name. + summary: Page name. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -87,7 +87,7 @@ properties: uid: 'visio!Visio.Interfaces.PageLoadOptions#width:member' package: visio! fullName: width - summary: Returns the width of the page. + summary: Returns the width of the page. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.selectiondata.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.selectiondata.yml index a2d33e3c0e..15a0a1406b 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.selectiondata.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.selectiondata.yml @@ -13,7 +13,7 @@ properties: uid: 'visio!Visio.Interfaces.SelectionData#shapes:member' package: visio! fullName: shapes - summary: Gets the Shapes of the Selection. + summary: Gets the Shapes of the Selection. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapecollectionloadoptions.yml index fb56b1d8e0..f25bdd5836 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapecollectionloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeCollectionLoadOptions#id:member' package: visio! fullName: id - summary: 'For EACH ITEM in the collection: Shape''s identifier.' + summary: 'For EACH ITEM in the collection: Shape''s identifier. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeCollectionLoadOptions#name:member' package: visio! fullName: name - summary: 'For EACH ITEM in the collection: Shape''s name.' + summary: 'For EACH ITEM in the collection: Shape''s name. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -65,7 +65,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeCollectionLoadOptions#text:member' package: visio! fullName: text - summary: 'For EACH ITEM in the collection: Shape''s text.' + summary: 'For EACH ITEM in the collection: Shape''s text. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemcollectionloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemcollectionloadoptions.yml index 713e845e51..f3875bc564 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemcollectionloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemCollectionLoadOptions#format:member' package: visio! fullName: format - summary: 'For EACH ITEM in the collection: A string that specifies the format of the shape data item.' + summary: 'For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemCollectionLoadOptions#formattedValue:member' package: visio! fullName: formattedValue - summary: 'For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.' + summary: 'For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemCollectionLoadOptions#label:member' package: visio! fullName: label - summary: 'For EACH ITEM in the collection: A string that specifies the label of the shape data item.' + summary: 'For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.' remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemdata.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemdata.yml index a0eb26c906..f11805c1fe 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemdata.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemdata.yml @@ -13,7 +13,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemData#format:member' package: visio! fullName: format - summary: A string that specifies the format of the shape data item. + summary: A string that specifies the format of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemData#formattedValue:member' package: visio! fullName: formattedValue - summary: A string that specifies the formatted value of the shape data item. + summary: A string that specifies the formatted value of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -37,7 +37,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemData#label:member' package: visio! fullName: label - summary: A string that specifies the label of the shape data item. + summary: A string that specifies the label of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -49,7 +49,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemData#value:member' package: visio! fullName: value - summary: A string that specifies the value of the shape data item. + summary: A string that specifies the value of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemloadoptions.yml index 6182abb599..fa1d1080e9 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapedataitemloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemLoadOptions#format:member' package: visio! fullName: format - summary: A string that specifies the format of the shape data item. + summary: A string that specifies the format of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemLoadOptions#formattedValue:member' package: visio! fullName: formattedValue - summary: A string that specifies the formatted value of the shape data item. + summary: A string that specifies the formatted value of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemLoadOptions#label:member' package: visio! fullName: label - summary: A string that specifies the label of the shape data item. + summary: A string that specifies the label of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeDataItemLoadOptions#value:member' package: visio! fullName: value - summary: A string that specifies the value of the shape data item. + summary: A string that specifies the value of the shape data item. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapeloadoptions.yml index 0e0f9f5308..8b997604c6 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapeloadoptions.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.interfaces.shapeloadoptions.yml @@ -27,7 +27,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeLoadOptions#id:member' package: visio! fullName: id - summary: Shape's identifier. + summary: Shape's identifier. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -39,7 +39,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeLoadOptions#name:member' package: visio! fullName: name - summary: Shape's name. + summary: Shape's name. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false @@ -63,7 +63,7 @@ properties: uid: 'visio!Visio.Interfaces.ShapeLoadOptions#text:member' package: visio! fullName: text - summary: Shape's text. + summary: Shape's text. Read-only. remarks: '\[ [API set: 1.1](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/visio/visio/visio.page.yml b/docs/docs-ref-autogen/visio/visio/visio.page.yml index 06b6d4a118..94877c68df 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.page.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.page.yml @@ -253,23 +253,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.Page#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.PageData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.Page#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.pagecollection.yml b/docs/docs-ref-autogen/visio/visio/visio.pagecollection.yml index 2768c3502d..fe6af14039 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.pagecollection.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.pagecollection.yml @@ -146,23 +146,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.PageCollection#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.PageCollectionData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.PageCollection#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.pageview.yml b/docs/docs-ref-autogen/visio/visio/visio.pageview.yml index 440fa578d8..3064a0ea86 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.pageview.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.pageview.yml @@ -250,23 +250,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.PageView#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.PageViewData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: setPosition(Position) uid: 'visio!Visio.PageView#setPosition:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.shape.yml b/docs/docs-ref-autogen/visio/visio/visio.shape.yml index a8fa014560..0259a8a487 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.shape.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.shape.yml @@ -306,23 +306,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.Shape#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ShapeData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.Shape#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.shapecollection.yml b/docs/docs-ref-autogen/visio/visio/visio.shapecollection.yml index 8deaef0e1b..0e4b6285b3 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.shapecollection.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.shapecollection.yml @@ -147,23 +147,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.ShapeCollection#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ShapeCollectionData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.ShapeCollection#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.shapedataitem.yml b/docs/docs-ref-autogen/visio/visio/visio.shapedataitem.yml index 92d0585455..9d00ad00bf 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.shapedataitem.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.shapedataitem.yml @@ -160,23 +160,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.ShapeDataItem#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ShapeDataItemData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.ShapeDataItem#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.shapedataitemcollection.yml b/docs/docs-ref-autogen/visio/visio/visio.shapedataitemcollection.yml index 79f194dcae..4389466f76 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.shapedataitemcollection.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.shapedataitemcollection.yml @@ -152,23 +152,6 @@ methods: return: type: '' description: '' - - name: setMockData(data) - uid: 'visio!Visio.ShapeDataItemCollection#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: toJSON() uid: 'visio!Visio.ShapeDataItemCollection#toJSON:member(1)' package: visio! diff --git a/docs/docs-ref-autogen/visio/visio/visio.shapeview.yml b/docs/docs-ref-autogen/visio/visio/visio.shapeview.yml index b1ee47de05..69924368c2 100644 --- a/docs/docs-ref-autogen/visio/visio/visio.shapeview.yml +++ b/docs/docs-ref-autogen/visio/visio/visio.shapeview.yml @@ -286,23 +286,6 @@ methods: return: type: void description: '' - - name: setMockData(data) - uid: 'visio!Visio.ShapeView#setMockData:member(1)' - package: visio! - fullName: setMockData(data) - summary: Set mock data - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'setMockData(data: Visio.Interfaces.ShapeViewData): void;' - parameters: - - id: data - description: '' - type: '' - return: - type: void - description: '' - name: setText(Text) uid: 'visio!Visio.ShapeView#setText:member(1)' package: visio! diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 69c6b76b8b..f9c890e4cd 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -7765,8 +7765,10 @@ OneNote.Application,"getActiveParagraph()",Method,Poor,false OneNote.Application,"getActiveParagraphOrNull()",Method,Poor,false OneNote.Application,"getActiveSection()",Method,Poor,true OneNote.Application,"getActiveSectionOrNull()",Method,Poor,true +OneNote.Application,"getDecimalSeparator()",Method,Poor,false OneNote.Application,"getSelectedInkStrokes()",Method,Poor,false OneNote.Application,"getWindowSize()",Method,Poor,false +OneNote.Application,"insertAndEmbedLinkAtCurrentPosition(url)",Method,Poor,false OneNote.Application,"insertHtmlAtCurrentPosition(html)",Method,Poor,false OneNote.Application,"isViewingDeletedNotes()",Method,Poor,false OneNote.Application,"load(options)",Method,Poor,false @@ -7823,8 +7825,8 @@ OneNote.Image,"toJSON()",Method,Poor,false OneNote.Image,"track()",Method,Poor,false OneNote.Image,"untrack()",Method,Poor,false OneNote.ImageOcrData,N/A,Class,Good,false -OneNote.ImageOcrData,"ocrLanguageId",Property,Fine,false -OneNote.ImageOcrData,"ocrText",Property,Fine,false +OneNote.ImageOcrData,"ocrLanguageId",Property,Good,false +OneNote.ImageOcrData,"ocrText",Property,Good,false OneNote.InkAnalysis,N/A,Class,Good,false OneNote.InkAnalysis,"context",Property,Good,false OneNote.InkAnalysis,"id",Property,Good,false @@ -7937,8 +7939,8 @@ OneNote.InkStrokeCollection,"toJSON()",Method,Poor,false OneNote.InkStrokeCollection,"track()",Method,Poor,false OneNote.InkStrokeCollection,"untrack()",Method,Poor,false OneNote.InkStrokePointer,N/A,Class,Good,false -OneNote.InkStrokePointer,"contentId",Property,Fine,false -OneNote.InkStrokePointer,"inkStrokeId",Property,Fine,false +OneNote.InkStrokePointer,"contentId",Property,Good,false +OneNote.InkStrokePointer,"inkStrokeId",Property,Good,false OneNote.InkWord,N/A,Class,Good,false OneNote.InkWord,"context",Property,Good,false OneNote.InkWord,"id",Property,Good,false @@ -8236,11 +8238,11 @@ OneNote.ParagraphCollection,"toJSON()",Method,Poor,false OneNote.ParagraphCollection,"track()",Method,Poor,false OneNote.ParagraphCollection,"untrack()",Method,Poor,false OneNote.ParagraphInfo,N/A,Class,Good,false -OneNote.ParagraphInfo,"bulletType",Property,Fine,false -OneNote.ParagraphInfo,"indentationLevel",Property,Fine,false -OneNote.ParagraphInfo,"index",Property,Fine,false -OneNote.ParagraphInfo,"listType",Property,Fine,false -OneNote.ParagraphInfo,"numberType",Property,Fine,false +OneNote.ParagraphInfo,"bulletType",Property,Good,false +OneNote.ParagraphInfo,"indentationLevel",Property,Good,false +OneNote.ParagraphInfo,"index",Property,Good,false +OneNote.ParagraphInfo,"listType",Property,Good,false +OneNote.ParagraphInfo,"numberType",Property,Good,false OneNote.ParagraphStyle,N/A,Enum,Fine,false OneNote.ParagraphStyle,"citation",EnumField,Fine,false OneNote.ParagraphStyle,"code",EnumField,Fine,false @@ -8293,7 +8295,7 @@ OneNote.RichText,"languageId",Property,Good,false OneNote.RichText,"paragraph",Property,Good,false OneNote.RichText,"style",Property,Good,false OneNote.RichText,"text",Property,Good,false -OneNote.RichText,"getHtml()",Method,Poor,false +OneNote.RichText,"getHtml()",Method,Fine,false OneNote.RichText,"load(options)",Method,Poor,false OneNote.RichText,"load(propertyNames)",Method,Fine,true OneNote.RichText,"load(propertyNamesAndPaths)",Method,Poor,false @@ -8399,7 +8401,7 @@ OneNote.TableCell,"id",Property,Good,false OneNote.TableCell,"paragraphs",Property,Good,false OneNote.TableCell,"parentRow",Property,Good,false OneNote.TableCell,"rowIndex",Property,Good,false -OneNote.TableCell,"shadingColor",Property,Fine,false +OneNote.TableCell,"shadingColor",Property,Good,false OneNote.TableCell,"appendHtml(html)",Method,Poor,true OneNote.TableCell,"appendImage(base64EncodedImage, width, height)",Method,Poor,false OneNote.TableCell,"appendRichText(paragraphText)",Method,Poor,true @@ -10004,7 +10006,6 @@ Visio.Application,"load(propertyNames)",Method,Poor,false Visio.Application,"load(propertyNamesAndPaths)",Method,Poor,false Visio.Application,"set(properties, options)",Method,Poor,false Visio.Application,"set(properties)",Method,Poor,false -Visio.Application,"setMockData(data)",Method,Poor,false Visio.Application,"showToolbar(id, show)",Method,Poor,false Visio.Application,"showToolbar(idString, show)",Method,Poor,false Visio.Application,"toJSON()",Method,Poor,false @@ -10029,7 +10030,6 @@ Visio.Comment,"load(propertyNames)",Method,Poor,false Visio.Comment,"load(propertyNamesAndPaths)",Method,Poor,false Visio.Comment,"set(properties, options)",Method,Poor,false Visio.Comment,"set(properties)",Method,Poor,false -Visio.Comment,"setMockData(data)",Method,Poor,false Visio.Comment,"toJSON()",Method,Poor,false Visio.CommentCollection,N/A,Class,Good,false Visio.CommentCollection,"context",Property,Good,false @@ -10039,7 +10039,6 @@ Visio.CommentCollection,"getItem(key)",Method,Poor,false Visio.CommentCollection,"load(options)",Method,Fine,true Visio.CommentCollection,"load(propertyNames)",Method,Poor,false Visio.CommentCollection,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.CommentCollection,"setMockData(data)",Method,Poor,false Visio.CommentCollection,"toJSON()",Method,Poor,false Visio.ConnectorDirection,N/A,Enum,Good,false Visio.ConnectorDirection,"fromTarget",EnumField,Fine,false @@ -10095,7 +10094,6 @@ Visio.Document,"load(propertyNamesAndPaths)",Method,Poor,false Visio.Document,"set(properties, options)",Method,Poor,false Visio.Document,"set(properties)",Method,Poor,false Visio.Document,"setActivePage(PageName)",Method,Poor,true -Visio.Document,"setMockData(data)",Method,Poor,false Visio.Document,"showTaskPane(taskPaneType, initialProps, show)",Method,Fine,false Visio.Document,"showTaskPane(taskPaneTypeString, initialProps, show)",Method,Fine,false Visio.Document,"startDataRefresh()",Method,Poor,true @@ -10118,7 +10116,6 @@ Visio.DocumentView,"load(propertyNames)",Method,Poor,false Visio.DocumentView,"load(propertyNamesAndPaths)",Method,Poor,false Visio.DocumentView,"set(properties, options)",Method,Poor,false Visio.DocumentView,"set(properties)",Method,Poor,false -Visio.DocumentView,"setMockData(data)",Method,Poor,false Visio.DocumentView,"toJSON()",Method,Poor,false Visio.ErrorCodes,N/A,Enum,Missing,false Visio.ErrorCodes,"accessDenied",EnumField,Missing,false @@ -10141,7 +10138,6 @@ Visio.Hyperlink,"subAddress",Property,Good,false Visio.Hyperlink,"load(options)",Method,Fine,true Visio.Hyperlink,"load(propertyNames)",Method,Poor,false Visio.Hyperlink,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.Hyperlink,"setMockData(data)",Method,Poor,false Visio.Hyperlink,"toJSON()",Method,Poor,false Visio.HyperlinkCollection,N/A,Class,Good,false Visio.HyperlinkCollection,"context",Property,Good,false @@ -10151,7 +10147,6 @@ Visio.HyperlinkCollection,"getItem(Key)",Method,Poor,false Visio.HyperlinkCollection,"load(options)",Method,Fine,true Visio.HyperlinkCollection,"load(propertyNames)",Method,Poor,false Visio.HyperlinkCollection,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.HyperlinkCollection,"setMockData(data)",Method,Poor,false Visio.HyperlinkCollection,"toJSON()",Method,Poor,false Visio.LayoutVariant,N/A,Enum,Good,false Visio.LayoutVariant,"flowchart_BottomToTop",EnumField,Fine,false @@ -10196,7 +10191,6 @@ Visio.Page,"load(propertyNames)",Method,Poor,false Visio.Page,"load(propertyNamesAndPaths)",Method,Poor,false Visio.Page,"set(properties, options)",Method,Poor,false Visio.Page,"set(properties)",Method,Poor,false -Visio.Page,"setMockData(data)",Method,Poor,false Visio.Page,"toJSON()",Method,Poor,false Visio.PageCollection,N/A,Class,Good,false Visio.PageCollection,"context",Property,Good,false @@ -10206,7 +10200,6 @@ Visio.PageCollection,"getItem(key)",Method,Poor,true Visio.PageCollection,"load(options)",Method,Poor,false Visio.PageCollection,"load(propertyNames)",Method,Poor,false Visio.PageCollection,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.PageCollection,"setMockData(data)",Method,Poor,false Visio.PageCollection,"toJSON()",Method,Poor,false Visio.PageLoadCompleteEventArgs,N/A,Class,Good,true Visio.PageLoadCompleteEventArgs,"pageName",Property,Good,false @@ -10227,7 +10220,6 @@ Visio.PageView,"load(propertyNames)",Method,Poor,false Visio.PageView,"load(propertyNamesAndPaths)",Method,Poor,false Visio.PageView,"set(properties, options)",Method,Poor,false Visio.PageView,"set(properties)",Method,Poor,false -Visio.PageView,"setMockData(data)",Method,Poor,false Visio.PageView,"setPosition(Position)",Method,Poor,false Visio.PageView,"toJSON()",Method,Poor,false Visio.Position,N/A,Class,Good,false @@ -10262,7 +10254,6 @@ Visio.Shape,"load(propertyNames)",Method,Fine,true Visio.Shape,"load(propertyNamesAndPaths)",Method,Poor,false Visio.Shape,"set(properties, options)",Method,Poor,false Visio.Shape,"set(properties)",Method,Poor,false -Visio.Shape,"setMockData(data)",Method,Poor,false Visio.Shape,"toJSON()",Method,Poor,false Visio.ShapeCollection,N/A,Class,Good,false Visio.ShapeCollection,"context",Property,Good,false @@ -10272,7 +10263,6 @@ Visio.ShapeCollection,"getItem(key)",Method,Poor,false Visio.ShapeCollection,"load(options)",Method,Poor,false Visio.ShapeCollection,"load(propertyNames)",Method,Poor,false Visio.ShapeCollection,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.ShapeCollection,"setMockData(data)",Method,Poor,false Visio.ShapeCollection,"toJSON()",Method,Poor,false Visio.ShapeDataItem,N/A,Class,Good,false Visio.ShapeDataItem,"context",Property,Good,false @@ -10283,7 +10273,6 @@ Visio.ShapeDataItem,"value",Property,Good,false Visio.ShapeDataItem,"load(options)",Method,Fine,true Visio.ShapeDataItem,"load(propertyNames)",Method,Poor,false Visio.ShapeDataItem,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.ShapeDataItem,"setMockData(data)",Method,Poor,false Visio.ShapeDataItem,"toJSON()",Method,Poor,false Visio.ShapeDataItemCollection,N/A,Class,Good,false Visio.ShapeDataItemCollection,"context",Property,Good,false @@ -10293,7 +10282,6 @@ Visio.ShapeDataItemCollection,"getItem(key)",Method,Poor,false Visio.ShapeDataItemCollection,"load(options)",Method,Fine,true Visio.ShapeDataItemCollection,"load(propertyNames)",Method,Poor,false Visio.ShapeDataItemCollection,"load(propertyNamesAndPaths)",Method,Poor,false -Visio.ShapeDataItemCollection,"setMockData(data)",Method,Poor,false Visio.ShapeDataItemCollection,"toJSON()",Method,Poor,false Visio.ShapeMouseEnterEventArgs,N/A,Class,Good,true Visio.ShapeMouseEnterEventArgs,"pageName",Property,Good,false @@ -10312,7 +10300,6 @@ Visio.ShapeView,"load(propertyNamesAndPaths)",Method,Poor,false Visio.ShapeView,"removeOverlay(OverlayId)",Method,Poor,true Visio.ShapeView,"set(properties, options)",Method,Poor,false Visio.ShapeView,"set(properties)",Method,Poor,false -Visio.ShapeView,"setMockData(data)",Method,Poor,false Visio.ShapeView,"setText(Text)",Method,Poor,false Visio.ShapeView,"showOverlay(overlayId, show)",Method,Poor,false Visio.ShapeView,"toJSON()",Method,Poor,false diff --git a/generate-docs/api-extractor-inputs-onenote/onenote.d.ts b/generate-docs/api-extractor-inputs-onenote/onenote.d.ts index 205b58326a..6688052632 100644 --- a/generate-docs/api-extractor-inputs-onenote/onenote.d.ts +++ b/generate-docs/api-extractor-inputs-onenote/onenote.d.ts @@ -99,6 +99,7 @@ export declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ getActiveSectionOrNull(): OneNote.Section; + getDecimalSeparator(): OfficeExtension.ClientResult; /** * Gets the currently selected ink strokes. * @@ -107,6 +108,7 @@ export declare namespace OneNote { */ getSelectedInkStrokes(): OneNote.InkStrokeCollection; getWindowSize(): OfficeExtension.ClientResult; + insertAndEmbedLinkAtCurrentPosition(url: string): void; insertHtmlAtCurrentPosition(html: string): void; isViewingDeletedNotes(): OfficeExtension.ClientResult; /** @@ -150,9 +152,9 @@ export declare namespace OneNote { expand?: string; }): OneNote.Application; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ApplicationData; } /** @@ -165,14 +167,14 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the parent page object. Read-only. + * Gets the parent page object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly page: OneNote.Page; /** - * Gets the ID of the InkAnalysis object. Read-only. + * Gets the ID of the InkAnalysis object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -208,17 +210,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkAnalysis; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysis; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysis; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisData; } /** @@ -231,21 +233,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisPage. Read-only. + * Reference to the parent InkAnalysisPage. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkAnalysis: OneNote.InkAnalysis; /** - * Gets the ink analysis lines in this ink analysis paragraph. Read-only. + * Gets the ink analysis lines in this ink analysis paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly lines: OneNote.InkAnalysisLineCollection; /** - * Gets the ID of the InkAnalysisParagraph object. Read-only. + * Gets the ID of the InkAnalysisParagraph object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -281,17 +283,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisParagraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphData; } /** @@ -306,14 +308,14 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisParagraph[]; /** - * Returns the number of InkAnalysisParagraphs in the page. Read-only. + * Returns the number of InkAnalysisParagraphs in the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly count: number; /** - * Gets a InkAnalysisParagraph object by ID or by its index in the collection. Read-only. + * Gets a InkAnalysisParagraph object by ID or by its index in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -349,17 +351,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData; } /** @@ -372,21 +374,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisParagraph. Read-only. + * Reference to the parent InkAnalysisParagraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.InkAnalysisParagraph; /** - * Gets the ink analysis words in this ink analysis line. Read-only. + * Gets the ink analysis words in this ink analysis line. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly words: OneNote.InkAnalysisWordCollection; /** - * Gets the ID of the InkAnalysisLine object. Read-only. + * Gets the ID of the InkAnalysisLine object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -422,17 +424,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisLine; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLine; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLine; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineData; } /** @@ -447,7 +449,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisLine[]; /** - * Returns the number of InkAnalysisLines in the page. Read-only. + * Returns the number of InkAnalysisLines in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -490,17 +492,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisLineCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLineCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLineCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData; } /** @@ -513,35 +515,35 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisLine. Read-only. + * Reference to the parent InkAnalysisLine. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly line: OneNote.InkAnalysisLine; /** - * Gets the ID of the InkAnalysisWord object. Read-only. + * Gets the ID of the InkAnalysisWord object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The id of the recognized language in this inkAnalysisWord. Read-only. + * The ID of the recognized language in this inkAnalysisWord. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly languageId: string; /** - * Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only. + * Weak references to the ink strokes that were recognized as part of this ink analysis word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly strokePointers: OneNote.InkStrokePointer[]; /** - * The words that were recognized in this ink word, in order of likelihood. Read-only. + * The words that were recognized in this ink word, in order of likelihood. * * @remarks * [Api set: OneNoteApi 1.1] @@ -577,17 +579,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordData; } /** @@ -602,7 +604,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisWord[]; /** - * Returns the number of InkAnalysisWords in the page. Read-only. + * Returns the number of InkAnalysisWords in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -645,17 +647,18 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWordCollection; /** + * 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. * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. */ untrack(): OneNote.InkAnalysisWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData; } /** @@ -668,21 +671,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the strokes of the FloatingInk object. Read-only. + * Gets the strokes of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkStrokes: OneNote.InkStrokeCollection; /** - * Gets the PageContent parent of the FloatingInk object. Read-only. + * Gets the PageContent parent of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the ID of the FloatingInk object. Read-only. + * Gets the ID of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -710,17 +713,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.FloatingInk; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.FloatingInk; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.FloatingInk; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.FloatingInkData; } /** @@ -740,7 +743,7 @@ export declare namespace OneNote { */ readonly floatingInk: OneNote.FloatingInk; /** - * Gets the ID of the InkStroke object. Read-only. + * Gets the ID of the InkStroke object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -768,17 +771,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkStroke; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStroke; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStroke; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeData; } /** @@ -793,7 +796,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkStroke[]; /** - * Returns the number of InkStrokes in the page. Read-only. + * Returns the number of InkStrokes in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -836,17 +839,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStrokeCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStrokeCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeCollectionData; } /** @@ -859,7 +862,7 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the ID of the Point object. Read-only. + * Gets the ID of the Point object. * * @remarks * [Api set: OneNoteApi 1.9] @@ -889,17 +892,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Point; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Point; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Point; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointData; } /** @@ -914,7 +917,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Point[]; /** - * Returns the number of Point in the stroke. Read-only. + * Returns the number of Point in the stroke. * * @remarks * [Api set: OneNoteApi 1.9] @@ -957,17 +960,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PointCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PointCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PointCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointCollectionData; } /** @@ -980,28 +983,28 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The parent paragraph containing the ink word. Read-only. + * The parent paragraph containing the ink word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets the ID of the InkWord object. Read-only. + * Gets the ID of the InkWord object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The id of the recognized language in this ink word. Read-only. + * The ID of the recognized language in this ink word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly languageId: string; /** - * The words that were recognized in this ink word, in order of likelihood. Read-only. + * The words that were recognized in this ink word, in order of likelihood. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1029,17 +1032,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.InkWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordData; } /** @@ -1054,7 +1057,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkWord[]; /** - * Returns the number of InkWords in the page. Read-only. + * Returns the number of InkWords in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1097,17 +1100,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWordCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordCollectionData; } /** @@ -1120,28 +1123,28 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sectionGroups: OneNote.SectionGroupCollection; /** - * The sections of the notebook. Read only + * The sections of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sections: OneNote.SectionCollection; /** - * The url of the site where this notebook is located. Read only + * The url of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly baseUrl: string; /** - * The client url of the notebook. Read only + * The client url of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1155,14 +1158,14 @@ export declare namespace OneNote { */ readonly id: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isVirtual: boolean; /** - * Gets the name of the notebook. Read-only. + * Gets the name of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1215,17 +1218,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Notebook; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Notebook; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Notebook; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookData; } /** @@ -1240,7 +1243,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Notebook[]; /** - * Returns the number of notebooks in the collection. Read-only. + * Returns the number of notebooks in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1292,17 +1295,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NotebookCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NotebookCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookCollectionData; } /** @@ -1315,56 +1318,56 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the notebook that contains the section group. Read-only. + * Gets the notebook that contains the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly notebook: OneNote.Notebook; /** - * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. Read-only. + * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentSectionGroup: OneNote.SectionGroup; /** - * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. Read-only. + * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentSectionGroupOrNull: OneNote.SectionGroup; /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sectionGroups: OneNote.SectionGroupCollection; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sections: OneNote.SectionCollection; /** - * The client url of the section group. Read only + * The client URL of the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the section group. Read-only. + * Gets the ID of the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the name of the section group. Read-only. + * Gets the name of the section group. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1417,17 +1420,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.SectionGroup; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroup; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroup; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupData; } /** @@ -1442,7 +1445,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.SectionGroup[]; /** - * Returns the number of section groups in the collection. Read-only. + * Returns the number of section groups in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1494,17 +1497,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroupCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroupCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupCollectionData; } /** @@ -1517,21 +1520,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the notebook that contains the section. Read-only. + * Gets the notebook that contains the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly notebook: OneNote.Notebook; /** - * The collection of pages in the section. Read only + * The collection of pages in the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pages: OneNote.PageCollection; /** - * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. Read-only. + * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1545,42 +1548,42 @@ export declare namespace OneNote { */ readonly parentSectionGroupOrNull: OneNote.SectionGroup; /** - * The client url of the section. Read only + * The client url of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the section. Read-only. + * Gets the ID of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * True if this section is encrypted with a password. Read only + * True if this section is encrypted with a password. * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isEncrypted: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isLocked: boolean; /** - * Gets the name of the section. Read-only. + * Gets the name of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly name: string; /** - * The web url of the page. Read only + * The web URL of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1662,17 +1665,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Section; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Section; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Section; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionData; } /** @@ -1687,7 +1690,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Section[]; /** - * Returns the number of sections in the collection. Read-only. + * Returns the number of sections in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1739,17 +1742,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionCollectionData; } /** @@ -1776,7 +1779,7 @@ export declare namespace OneNote { */ readonly inkAnalysisOrNull: OneNote.InkAnalysis; /** - * Gets the section that contains the page. Read-only. + * Gets the section that contains the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1790,14 +1793,14 @@ export declare namespace OneNote { */ readonly classNotebookPageSource: string; /** - * The client url of the page. Read only + * The client url of the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the page. Read-only. + * Gets the ID of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1818,7 +1821,7 @@ export declare namespace OneNote { */ title: string; /** - * The web url of the page. Read only + * The web url of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1840,11 +1843,11 @@ export declare namespace OneNote { * * @param left - The left position of the top, left corner of the Outline. * @param top - The top position of the top, left corner of the Outline. - * @param html - An HTML string that describes the visual presentation of the Outline. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html - An HTML string that describes the visual presentation of the Outline. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ addOutline(left: number, top: number, html: string): OneNote.Outline; /** - * Return a json string with node id and content in html format. + * Return a JSON string with node ID and content in HTML format. * * @remarks * [Api set: OneNoteApi 1.1] @@ -1856,7 +1859,7 @@ export declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param translatedContent - Translated content of the page + * @param translatedContent - Translated content of the page. */ applyTranslation(translatedContent: string): void; /** @@ -1931,17 +1934,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Page; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Page; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Page; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageData; } /** @@ -1956,7 +1959,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Page[]; /** - * Returns the number of pages in the collection. Read-only. + * Returns the number of pages in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2008,17 +2011,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageCollectionData; } /** @@ -2052,14 +2055,14 @@ export declare namespace OneNote { */ readonly outline: OneNote.Outline; /** - * Gets the page that contains the PageContent object. Read-only. + * Gets the page that contains the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentPage: OneNote.Page; /** - * Gets the ID of the PageContent object. Read-only. + * Gets the ID of the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2080,7 +2083,7 @@ export declare namespace OneNote { */ top: number; /** - * Gets the type of the PageContent object. Read-only. + * Gets the type of the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2123,17 +2126,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.PageContent; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContent; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContent; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentData; } /** @@ -2148,7 +2151,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.PageContent[]; /** - * Returns the number of page contents in the collection. Read-only. + * Returns the number of page contents in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2191,17 +2194,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContentCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContentCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentCollectionData; } /** @@ -2214,21 +2217,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. + * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the collection of Paragraph objects in the Outline. Read-only. + * Gets the collection of Paragraph objects in the Outline. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the ID of the Outline object. Read-only. + * Gets the ID of the Outline object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2240,7 +2243,7 @@ export declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param html - The HTML string to append. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html - The HTML string to append. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ appendHtml(html: string): void; /** @@ -2303,17 +2306,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Outline; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Outline; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Outline; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.OutlineData; } /** @@ -2326,56 +2329,56 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly image: OneNote.Image; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkWords: OneNote.InkWordCollection; /** - * Gets the Outline object that contains the Paragraph. Read-only. + * Gets the Outline object that contains the Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly outline: OneNote.Outline; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Throws if a parent paragraph does not exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraph: OneNote.Paragraph; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraphOrNull: OneNote.Paragraph; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTableCell: OneNote.TableCell; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, returns null. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2389,21 +2392,21 @@ export declare namespace OneNote { */ readonly richText: OneNote.RichText; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly table: OneNote.Table; /** - * Gets the ID of the Paragraph object. Read-only. + * Gets the ID of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the type of the Paragraph object. Read-only. + * Gets the type of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2458,7 +2461,7 @@ export declare namespace OneNote { * [Api set: OneNoteApi 1.1] * * @param insertLocation - The location of new contents relative to the current Paragraph. - * @param html - An HTML string that describes the visual presentation of the content. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html - An HTML string that describes the visual presentation of the content. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void; /** @@ -2484,7 +2487,7 @@ export declare namespace OneNote { */ insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image; /** - * Inserts the image at the specified insert location.. + * Inserts the image at the specified insert location. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2561,17 +2564,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Paragraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Paragraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Paragraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphData; } /** @@ -2586,7 +2589,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Paragraph[]; /** - * Returns the number of paragraphs in the page. Read-only. + * Returns the number of paragraphs in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2629,17 +2632,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.ParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.ParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphCollectionData; } /** @@ -2652,21 +2655,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Id of the NoteTag object. Read-only. + * Gets the Id of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the status of the NoteTag object. Read-only. + * Gets the status of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly status: OneNote.NoteTagStatus | "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"; /** - * Gets the type of the NoteTag object. Read-only. + * Gets the type of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2694,17 +2697,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.NoteTag; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NoteTag; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NoteTag; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NoteTagData; } /** @@ -2717,21 +2720,21 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Paragraph object that contains the RichText object. Read-only. + * Gets the Paragraph object that contains the RichText object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets the ID of the RichText object. Read-only. + * Gets the ID of the RichText object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The language id of the text. Read-only. + * The language id of the text. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2752,7 +2755,7 @@ export declare namespace OneNote { */ readonly text: string; /** - * Get the HTML of the rich text + * Gets the HTML of the rich text. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2781,17 +2784,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.RichText; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.RichText; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.RichText; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.RichTextData; } /** @@ -2804,14 +2807,14 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. Read-only. + * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. Read-only. + * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2839,7 +2842,7 @@ export declare namespace OneNote { */ hyperlink: string; /** - * Gets the ID of the Image object. Read-only. + * Gets the ID of the Image object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2897,17 +2900,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Image; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Image; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Image; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ImageData; } /** @@ -2920,14 +2923,14 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Paragraph object that contains the Table object. Read-only. + * Gets the Paragraph object that contains the Table object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets all of the table rows. Read-only. + * Gets all of the table rows. * * @remarks * [Api set: OneNoteApi 1.1] @@ -2948,7 +2951,7 @@ export declare namespace OneNote { */ readonly columnCount: number; /** - * Gets the ID of the table. Read-only. + * Gets the ID of the table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3054,17 +3057,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.Table; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Table; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Table; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableData; } /** @@ -3077,35 +3080,35 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the cells in the row. Read-only. + * Gets the cells in the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cells: OneNote.TableCellCollection; /** - * Gets the parent table. Read-only. + * Gets the parent table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTable: OneNote.Table; /** - * Gets the number of cells in the row. Read-only. + * Gets the number of cells in the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cellCount: number; /** - * Gets the ID of the row. Read-only. + * Gets the ID of the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the index of the row in its parent table. Read-only. + * Gets the index of the row in its parent table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3168,17 +3171,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.TableRow; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRow; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRow; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowData; } /** @@ -3193,7 +3196,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableRow[]; /** - * Returns the number of table rows in this collection. Read-only. + * Returns the number of table rows in this collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3236,17 +3239,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableRowCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRowCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRowCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowCollectionData; } /** @@ -3259,42 +3262,42 @@ export declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of Paragraph objects in the TableCell. Read-only. + * Gets the collection of Paragraph objects in the TableCell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the parent row of the cell. Read-only. + * Gets the parent row of the cell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentRow: OneNote.TableRow; /** - * Gets the index of the cell in its row. Read-only. + * Gets the index of the cell in its row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cellIndex: number; /** - * Gets the ID of the cell. Read-only. + * Gets the ID of the cell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the index of the cell's row in the table. Read-only. + * Gets the index of the cell's row in the table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly rowIndex: number; /** - * Gets and sets the shading color of the cell + * Gets and sets the shading color of the cell. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3314,7 +3317,7 @@ export declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param html - The HTML string to append. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html - The HTML string to append. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ appendHtml(html: string): void; /** @@ -3377,17 +3380,17 @@ export declare namespace OneNote { expand?: string; }): OneNote.TableCell; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCell; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCell; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellData; } /** @@ -3402,7 +3405,7 @@ export declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableCell[]; /** - * Returns the number of tablecells in this collection. Read-only. + * Returns the number of tablecells in this collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3445,17 +3448,17 @@ export declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableCellCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCellCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCellCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellCollectionData; } /** @@ -3466,14 +3469,14 @@ export declare namespace OneNote { */ export interface ImageOcrData { /** - * Represents the OCR language, with values such as EN-US + * Represents the OCR language, with values such as EN-US. * * @remarks * [Api set: OneNoteApi 1.1] */ ocrLanguageId: string; /** - * Represents the text obtained by OCR of the image + * Represents the text obtained by OCR of the image. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3488,14 +3491,14 @@ export declare namespace OneNote { */ export interface InkStrokePointer { /** - * Represents the id of the page content object corresponding to this stroke + * Represents the ID of the page content object corresponding to this stroke. * * @remarks * [Api set: OneNoteApi 1.1] */ contentId: string; /** - * Represents the id of the ink stroke + * Represents the ID of the ink stroke. * * @remarks * [Api set: OneNoteApi 1.1] @@ -3510,40 +3513,35 @@ export declare namespace OneNote { */ export interface ParagraphInfo { /** - * // - Bullet list type of paragraph + * Bullet list type of paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ bulletType: string; /** - * // - Level of indentation of the paragraph + * Level of indentation of the paragraph. * * @remarks * [Api set: OneNoteApi 1.8] */ indentationLevel: number; /** - * // - Index of paragraph in a list + * Index of paragraph in a list. * * @remarks * [Api set: OneNoteApi 1.1] */ index: number; /** - * // - Type of list in paragraph + * Type of list in paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ listType: OneNote.ListType | "None" | "Number" | "Bullet"; /** - * // - Numbered list type of paragraph + * Numbered list type of paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4189,10 +4187,10 @@ export declare namespace OneNote { */ $skip?: number; } - /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */ + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ export interface ApplicationUpdateData { } - /** An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`. */ export interface InkAnalysisUpdateData { /** * Gets the parent page object. @@ -4202,7 +4200,7 @@ export declare namespace OneNote { */ page?: OneNote.Interfaces.PageUpdateData; } - /** An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... })`. */ export interface InkAnalysisParagraphUpdateData { /** * Reference to the parent InkAnalysisPage. @@ -4212,11 +4210,11 @@ export declare namespace OneNote { */ inkAnalysis?: OneNote.Interfaces.InkAnalysisUpdateData; } - /** An interface for updating data on the InkAnalysisParagraphCollection object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ export interface InkAnalysisParagraphCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisParagraphData[]; } - /** An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`. */ export interface InkAnalysisLineUpdateData { /** * Reference to the parent InkAnalysisParagraph. @@ -4226,11 +4224,11 @@ export declare namespace OneNote { */ paragraph?: OneNote.Interfaces.InkAnalysisParagraphUpdateData; } - /** An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. */ export interface InkAnalysisLineCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisLineData[]; } - /** An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`. */ export interface InkAnalysisWordUpdateData { /** * Reference to the parent InkAnalysisLine. @@ -4240,38 +4238,38 @@ export declare namespace OneNote { */ line?: OneNote.Interfaces.InkAnalysisLineUpdateData; } - /** An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. */ export interface InkAnalysisWordCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisWordData[]; } - /** An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. */ + /** An interface for updating data on the `InkStrokeCollection` object, for use in `inkStrokeCollection.set({ ... })`. */ export interface InkStrokeCollectionUpdateData { items?: OneNote.Interfaces.InkStrokeData[]; } - /** An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`. */ + /** An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`. */ export interface PointCollectionUpdateData { items?: OneNote.Interfaces.PointData[]; } - /** An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`. */ export interface InkWordCollectionUpdateData { items?: OneNote.Interfaces.InkWordData[]; } - /** An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`. */ + /** An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. */ export interface NotebookCollectionUpdateData { items?: OneNote.Interfaces.NotebookData[]; } - /** An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. */ export interface SectionGroupCollectionUpdateData { items?: OneNote.Interfaces.SectionGroupData[]; } - /** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ export interface SectionCollectionUpdateData { items?: OneNote.Interfaces.SectionData[]; } - /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */ + /** An interface for updating data on the `Page` object, for use in `page.set({ ... })`. */ export interface PageUpdateData { /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4292,14 +4290,14 @@ export declare namespace OneNote { */ title?: string; } - /** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */ + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ export interface PageCollectionUpdateData { items?: OneNote.Interfaces.PageData[]; } - /** An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`. */ + /** An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`. */ export interface PageContentUpdateData { /** - * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4320,11 +4318,11 @@ export declare namespace OneNote { */ top?: number; } - /** An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... })`. */ + /** An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. */ export interface PageContentCollectionUpdateData { items?: OneNote.Interfaces.PageContentData[]; } - /** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */ + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ export interface ParagraphUpdateData { /** * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. @@ -4345,7 +4343,7 @@ export declare namespace OneNote { export interface ParagraphCollectionUpdateData { items?: OneNote.Interfaces.ParagraphData[]; } - /** An interface for updating data on the Image object, for use in `image.set({ ... })`. */ + /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */ export interface ImageUpdateData { /** * Gets or sets the description of the Image. @@ -4376,7 +4374,7 @@ export declare namespace OneNote { */ width?: number; } - /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */ + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ export interface TableUpdateData { /** * Gets or sets whether the borders are visible or not. True if they are visible, false if they are hidden. @@ -4386,11 +4384,11 @@ export declare namespace OneNote { */ borderVisible?: boolean; } - /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */ + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ export interface TableRowCollectionUpdateData { items?: OneNote.Interfaces.TableRowData[]; } - /** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */ + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ export interface TableCellUpdateData { /** * Gets and sets the shading color of the cell @@ -4400,7 +4398,7 @@ export declare namespace OneNote { */ shadingColor?: string; } - /** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */ + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ export interface TableCellCollectionUpdateData { items?: OneNote.Interfaces.TableCellData[]; } @@ -4621,21 +4619,21 @@ export declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupData[]; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionData[]; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: string; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4649,7 +4647,7 @@ export declare namespace OneNote { */ id?: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + '* True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -4670,21 +4668,21 @@ export declare namespace OneNote { /** An interface describing the data returned by calling `sectionGroup.toJSON()`. */ export interface SectionGroupData { /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupData[]; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionData[]; /** - * The client url of the section group. Read only + * The client url of the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4712,14 +4710,14 @@ export declare namespace OneNote { /** An interface describing the data returned by calling `section.toJSON()`. */ export interface SectionData { /** - * The collection of pages in the section. Read only + * The collection of pages in the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ pages?: OneNote.Interfaces.PageData[]; /** - * The client url of the section. Read only + * The client URL of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4733,14 +4731,14 @@ export declare namespace OneNote { */ id?: string; /** - * True if this section is encrypted with a password. Read only + * True if this section is encrypted with a password. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] */ isEncrypted?: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -4754,7 +4752,7 @@ export declare namespace OneNote { */ name?: string; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4768,18 +4766,18 @@ export declare namespace OneNote { /** An interface describing the data returned by calling `page.toJSON()`. */ export interface PageData { /** - * The collection of PageContent objects on the page. Read only - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * The collection of PageContent objects on the page. Read only + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ contents?: OneNote.Interfaces.PageContentData[]; /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisData; /** * Gets the ClassNotebookPageSource to the page. @@ -4817,7 +4815,7 @@ export declare namespace OneNote { */ title?: string; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4831,21 +4829,21 @@ export declare namespace OneNote { /** An interface describing the data returned by calling `pageContent.toJSON()`. */ export interface PageContentData { /** - * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageData; /** - * Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ ink?: OneNote.Interfaces.FloatingInkData; /** - * Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. + * Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4904,14 +4902,14 @@ export declare namespace OneNote { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ export interface ParagraphData { /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageData; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -4991,7 +4989,7 @@ export declare namespace OneNote { */ id?: string; /** - * The language id of the text. Read-only. + * The language ID of the text. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5161,7 +5159,7 @@ export declare namespace OneNote { */ rowIndex?: number; /** - * Gets and sets the shading color of the cell + * Gets and sets the shading color of the cell. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5180,15 +5178,15 @@ export declare namespace OneNote { */ export interface ApplicationLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ notebooks?: OneNote.Interfaces.NotebookCollectionLoadOptions; } /** @@ -5225,7 +5223,7 @@ export declare namespace OneNote { */ export interface InkAnalysisParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5258,7 +5256,7 @@ export declare namespace OneNote { */ export interface InkAnalysisParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5291,7 +5289,7 @@ export declare namespace OneNote { */ export interface InkAnalysisLineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5324,7 +5322,7 @@ export declare namespace OneNote { */ export interface InkAnalysisLineCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5357,7 +5355,7 @@ export declare namespace OneNote { */ export interface InkAnalysisWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5404,7 +5402,7 @@ export declare namespace OneNote { */ export interface InkAnalysisWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5451,7 +5449,7 @@ export declare namespace OneNote { */ export interface FloatingInkLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5484,7 +5482,7 @@ export declare namespace OneNote { */ export interface InkStrokeLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5510,7 +5508,7 @@ export declare namespace OneNote { */ export interface InkStrokeCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5536,7 +5534,7 @@ export declare namespace OneNote { */ export interface PointLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5557,7 +5555,7 @@ export declare namespace OneNote { */ export interface PointCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5584,7 +5582,7 @@ export declare namespace OneNote { */ export interface InkWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5602,7 +5600,7 @@ export declare namespace OneNote { */ id?: boolean; /** - * The id of the recognized language in this ink word. Read-only. + * The ID of the recognized language in this ink word. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5624,7 +5622,7 @@ export declare namespace OneNote { */ export interface InkWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5642,7 +5640,7 @@ export declare namespace OneNote { */ id?: boolean; /** - * For EACH ITEM in the collection: The id of the recognized language in this ink word. Read-only. + * For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5664,32 +5662,32 @@ export declare namespace OneNote { */ export interface NotebookLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5703,7 +5701,7 @@ export declare namespace OneNote { */ id?: boolean; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -5725,7 +5723,7 @@ export declare namespace OneNote { */ export interface NotebookCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5736,21 +5734,21 @@ export declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * For EACH ITEM in the collection: The sections of the notebook. Read only + * For EACH ITEM in the collection: The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * For EACH ITEM in the collection: The url of the site where this notebook is located. Read only + * For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * For EACH ITEM in the collection: The client url of the notebook. Read only + * For EACH ITEM in the collection: The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5764,7 +5762,7 @@ export declare namespace OneNote { */ id?: boolean; /** - * For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * For EACH ITEM in the collection: True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -5786,7 +5784,7 @@ export declare namespace OneNote { */ export interface SectionGroupLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5811,21 +5809,21 @@ export declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * The client url of the section group. Read only + * The client URL of the section group. Read.only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5854,7 +5852,7 @@ export declare namespace OneNote { */ export interface SectionGroupCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5879,14 +5877,14 @@ export declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * For EACH ITEM in the collection: The collection of section groups in the section group. Read only + * For EACH ITEM in the collection: The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * For EACH ITEM in the collection: The collection of sections in the section group. Read only + * For EACH ITEM in the collection: The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5922,7 +5920,7 @@ export declare namespace OneNote { */ export interface SectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -5933,7 +5931,7 @@ export declare namespace OneNote { */ notebook?: OneNote.Interfaces.NotebookLoadOptions; /** - * The collection of pages in the section. Read only + * The collection of pages in the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5954,7 +5952,7 @@ export declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * The client url of the section. Read only + * The client URL of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -5975,7 +5973,7 @@ export declare namespace OneNote { */ isEncrypted?: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -5989,7 +5987,7 @@ export declare namespace OneNote { */ name?: boolean; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6004,7 +6002,7 @@ export declare namespace OneNote { */ export interface SectionCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6057,7 +6055,7 @@ export declare namespace OneNote { */ isEncrypted?: boolean; /** - * For EACH ITEM in the collection: True if this section is locked. Read only + * For EACH ITEM in the collection: True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -6071,7 +6069,7 @@ export declare namespace OneNote { */ name?: boolean; /** - * For EACH ITEM in the collection: The web url of the page. Read only + * For EACH ITEM in the collection: The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6086,11 +6084,11 @@ export declare namespace OneNote { */ export interface PageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The collection of PageContent objects on the page. Read only + * The collection of PageContent objects on the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6118,7 +6116,7 @@ export declare namespace OneNote { */ classNotebookPageSource?: boolean; /** - * The client url of the page. Read only + * The client URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6146,7 +6144,7 @@ export declare namespace OneNote { */ title?: boolean; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6161,7 +6159,7 @@ export declare namespace OneNote { */ export interface PageCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6172,7 +6170,7 @@ export declare namespace OneNote { */ contents?: OneNote.Interfaces.PageContentCollectionLoadOptions; /** - * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6193,7 +6191,7 @@ export declare namespace OneNote { */ classNotebookPageSource?: boolean; /** - * For EACH ITEM in the collection: The client url of the page. Read only + * For EACH ITEM in the collection: The client URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6236,7 +6234,7 @@ export declare namespace OneNote { */ export interface PageContentLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6304,25 +6302,25 @@ export declare namespace OneNote { */ export interface PageContentCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ ink?: OneNote.Interfaces.FloatingInkLoadOptions; /** - * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. + * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6372,7 +6370,7 @@ export declare namespace OneNote { */ export interface OutlineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6383,11 +6381,11 @@ export declare namespace OneNote { */ pageContent?: OneNote.Interfaces.PageContentLoadOptions; /** - * Gets the collection of Paragraph objects in the Outline. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the collection of Paragraph objects in the Outline. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** * Gets the ID of the Outline object. Read-only. @@ -6405,22 +6403,22 @@ export declare namespace OneNote { */ export interface ParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions; /** * Gets the Outline object that contains the Paragraph. @@ -6430,28 +6428,28 @@ export declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. Read -nly. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6465,14 +6463,14 @@ export declare namespace OneNote { */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6501,18 +6499,18 @@ export declare namespace OneNote { */ export interface ParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. + * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. + * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6526,28 +6524,28 @@ export declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read only + * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * 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. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6561,14 +6559,14 @@ export declare namespace OneNote { */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6597,7 +6595,7 @@ export declare namespace OneNote { */ export interface NoteTagLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6630,7 +6628,7 @@ export declare namespace OneNote { */ export interface RichTextLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6648,7 +6646,7 @@ export declare namespace OneNote { */ id?: boolean; /** - * The language id of the text. Read-only. + * The language ID of the text. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6677,18 +6675,18 @@ export declare namespace OneNote { */ export interface ImageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. + * Gets the PageContent object that contains the Image. Throws if the Image isn't a direct child of a PageContent. This object defines the position of the Image on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ pageContent?: OneNote.Interfaces.PageContentLoadOptions; /** - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. + * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -6745,7 +6743,7 @@ export declare namespace OneNote { */ export interface TableLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6799,7 +6797,7 @@ export declare namespace OneNote { */ export interface TableRowLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6846,7 +6844,7 @@ export declare namespace OneNote { */ export interface TableRowCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6893,7 +6891,7 @@ export declare namespace OneNote { */ export interface TableCellLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -6947,7 +6945,7 @@ export declare namespace OneNote { */ export interface TableCellCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts index 5cadfb57d5..142dcece06 100644 --- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts @@ -3735,9 +3735,9 @@ export declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData; } /** @@ -3868,9 +3868,9 @@ export declare namespace PowerPoint { expand?: string; }): PowerPoint.DocumentProperties; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData; } /** diff --git a/generate-docs/api-extractor-inputs-visio/visio.d.ts b/generate-docs/api-extractor-inputs-visio/visio.d.ts index 69d2a6f40a..301402a564 100644 --- a/generate-docs/api-extractor-inputs-visio/visio.d.ts +++ b/generate-docs/api-extractor-inputs-visio/visio.d.ts @@ -280,10 +280,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ApplicationData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ApplicationData): void; } /** * Represents the Document class. @@ -360,7 +356,7 @@ export declare namespace Visio { * * @param taskPaneTypeString - Type of the 1st Party TaskPane. It can take values from enum TaskPaneType * @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. - * @param show - Optional Parameter. If it is set to false, it will hide the specified task pane. + * @param show - Optional Parameter. If it's set to false, it will hide the specified task pane. */ showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void; /** @@ -468,10 +464,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentData): void; } /** * Represents the DocumentView class. @@ -551,10 +543,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentViewData): void; } /** * Represents the Page class. @@ -669,10 +657,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageData): void; } /** * Represents the PageView class. @@ -772,10 +756,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageViewData): void; } /** * Represents a collection of Page objects that are part of the document. @@ -827,10 +807,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageCollectionData): void; } /** * Represents the Shape Collection. @@ -882,10 +858,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeCollectionData): void; } /** * Represents the Shape class. @@ -1007,10 +979,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeData): void; } /** * Represents the ShapeView class. @@ -1118,10 +1086,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeViewData): void; } /** * Represents the Position of the object in the view. @@ -1253,10 +1217,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void; } /** * Represents the ShapeDataItem. @@ -1321,10 +1281,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemData): void; } /** * Represents the Hyperlink Collection. @@ -1376,10 +1332,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void; } /** * Represents the Hyperlink. @@ -1444,10 +1396,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkData): void; } /** * Represents the CommentCollection for a given Shape. @@ -1499,10 +1447,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentCollectionData): void; } /** * Represents the Comment. @@ -1568,10 +1512,6 @@ export declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentData): void; } /** * Represents the Selection in the page. @@ -2541,28 +2481,28 @@ export declare namespace Visio { /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */ export interface ShapeDataItemData { /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: string; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: string; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: string; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -2576,28 +2516,28 @@ export declare namespace Visio { /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ export interface HyperlinkData { /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: string; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: string; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: string; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -2635,7 +2575,7 @@ export declare namespace Visio { /** An interface describing the data returned by calling `selection.toJSON()`. */ export interface SelectionData { /** - * Gets the Shapes of the Selection. + * Gets the Shapes of the Selection. Read-only. * * @remarks * [Api set: 1.1] @@ -2760,35 +2700,35 @@ export declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * Returns the height of the page. + * Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: boolean; /** - * Index of the Page. + * Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: boolean; /** - * Whether the page is a background page or not. + * Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * Page name. + * Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * Returns the width of the page. + * Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -2833,35 +2773,35 @@ export declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * For EACH ITEM in the collection: Returns the height of the page. + * For EACH ITEM in the collection: Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: boolean; /** - * For EACH ITEM in the collection: Index of the Page. + * For EACH ITEM in the collection: Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: boolean; /** - * For EACH ITEM in the collection: Whether the page is a background page or not. + * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * For EACH ITEM in the collection: Page name. + * For EACH ITEM in the collection: Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * For EACH ITEM in the collection: Returns the width of the page. + * For EACH ITEM in the collection: Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -2887,14 +2827,14 @@ export declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * For EACH ITEM in the collection: Shape's identifier. + * For EACH ITEM in the collection: Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * For EACH ITEM in the collection: Shape's name. + * For EACH ITEM in the collection: Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -2908,7 +2848,7 @@ export declare namespace Visio { */ select?: boolean; /** - * For EACH ITEM in the collection: Shape's text. + * For EACH ITEM in the collection: Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -2934,14 +2874,14 @@ export declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * Shape's identifier. + * Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * Shape's name. + * Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -2955,7 +2895,7 @@ export declare namespace Visio { */ select?: boolean; /** - * Shape's text. + * Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -2993,21 +2933,21 @@ export declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the format of the shape data item. + * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. + * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the label of the shape data item. + * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -3033,28 +2973,28 @@ export declare namespace Visio { */ $all?: boolean; /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: boolean; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -3073,28 +3013,28 @@ export declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * For EACH ITEM in the collection: Gets the description of a hyperlink. + * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. + * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -3113,28 +3053,28 @@ export declare namespace Visio { */ $all?: boolean; /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -3219,25 +3159,25 @@ export declare namespace Visio { } /** * 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. - * @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. + * @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. */ export function run(batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object. - * @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()". - * @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. + * @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()`. + * @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. */ export function run(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects. - * @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()". - * @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. + * @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()`. + * @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. */ export function run(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise): Promise; /** * 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. * @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. - * @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. + * @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. */ export function run(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise): Promise; } diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 77c79f454a..cd8a74c655 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -106610,6 +106610,7 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ getActiveSectionOrNull(): OneNote.Section; + getDecimalSeparator(): OfficeExtension.ClientResult; /** * Gets the currently selected ink strokes. * @@ -106618,6 +106619,7 @@ declare namespace OneNote { */ getSelectedInkStrokes(): OneNote.InkStrokeCollection; getWindowSize(): OfficeExtension.ClientResult; + insertAndEmbedLinkAtCurrentPosition(url: string): void; insertHtmlAtCurrentPosition(html: string): void; isViewingDeletedNotes(): OfficeExtension.ClientResult; /** @@ -106661,9 +106663,9 @@ declare namespace OneNote { expand?: string; }): OneNote.Application; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ApplicationData; } /** @@ -106676,14 +106678,14 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the parent page object. Read-only. + * Gets the parent page object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly page: OneNote.Page; /** - * Gets the ID of the InkAnalysis object. Read-only. + * Gets the ID of the InkAnalysis object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -106719,17 +106721,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysis; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysis; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysis; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisData; } /** @@ -106742,21 +106744,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisPage. Read-only. + * Reference to the parent InkAnalysisPage. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkAnalysis: OneNote.InkAnalysis; /** - * Gets the ink analysis lines in this ink analysis paragraph. Read-only. + * Gets the ink analysis lines in this ink analysis paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly lines: OneNote.InkAnalysisLineCollection; /** - * Gets the ID of the InkAnalysisParagraph object. Read-only. + * Gets the ID of the InkAnalysisParagraph object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -106792,17 +106794,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisParagraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphData; } /** @@ -106817,14 +106819,14 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisParagraph[]; /** - * Returns the number of InkAnalysisParagraphs in the page. Read-only. + * Returns the number of InkAnalysisParagraphs in the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly count: number; /** - * Gets a InkAnalysisParagraph object by ID or by its index in the collection. Read-only. + * Gets a InkAnalysisParagraph object by ID or by its index in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -106860,17 +106862,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData; } /** @@ -106883,21 +106885,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisParagraph. Read-only. + * Reference to the parent InkAnalysisParagraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.InkAnalysisParagraph; /** - * Gets the ink analysis words in this ink analysis line. Read-only. + * Gets the ink analysis words in this ink analysis line. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly words: OneNote.InkAnalysisWordCollection; /** - * Gets the ID of the InkAnalysisLine object. Read-only. + * Gets the ID of the InkAnalysisLine object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -106933,17 +106935,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisLine; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLine; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLine; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineData; } /** @@ -106958,7 +106960,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisLine[]; /** - * Returns the number of InkAnalysisLines in the page. Read-only. + * Returns the number of InkAnalysisLines in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107001,17 +107003,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisLineCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLineCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLineCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData; } /** @@ -107024,35 +107026,35 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Reference to the parent InkAnalysisLine. Read-only. + * Reference to the parent InkAnalysisLine. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly line: OneNote.InkAnalysisLine; /** - * Gets the ID of the InkAnalysisWord object. Read-only. + * Gets the ID of the InkAnalysisWord object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The id of the recognized language in this inkAnalysisWord. Read-only. + * The ID of the recognized language in this inkAnalysisWord. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly languageId: string; /** - * Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only. + * Weak references to the ink strokes that were recognized as part of this ink analysis word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly strokePointers: OneNote.InkStrokePointer[]; /** - * The words that were recognized in this ink word, in order of likelihood. Read-only. + * The words that were recognized in this ink word, in order of likelihood. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107088,17 +107090,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordData; } /** @@ -107113,7 +107115,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisWord[]; /** - * Returns the number of InkAnalysisWords in the page. Read-only. + * Returns the number of InkAnalysisWords in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107156,17 +107158,18 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWordCollection; /** + * 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. * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. */ untrack(): OneNote.InkAnalysisWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData; } /** @@ -107179,21 +107182,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the strokes of the FloatingInk object. Read-only. + * Gets the strokes of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkStrokes: OneNote.InkStrokeCollection; /** - * Gets the PageContent parent of the FloatingInk object. Read-only. + * Gets the PageContent parent of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the ID of the FloatingInk object. Read-only. + * Gets the ID of the FloatingInk object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107221,17 +107224,17 @@ declare namespace OneNote { expand?: string; }): OneNote.FloatingInk; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.FloatingInk; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.FloatingInk; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.FloatingInkData; } /** @@ -107251,7 +107254,7 @@ declare namespace OneNote { */ readonly floatingInk: OneNote.FloatingInk; /** - * Gets the ID of the InkStroke object. Read-only. + * Gets the ID of the InkStroke object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107279,17 +107282,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkStroke; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStroke; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStroke; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeData; } /** @@ -107304,7 +107307,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkStroke[]; /** - * Returns the number of InkStrokes in the page. Read-only. + * Returns the number of InkStrokes in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107347,17 +107350,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStrokeCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStrokeCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeCollectionData; } /** @@ -107370,7 +107373,7 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the ID of the Point object. Read-only. + * Gets the ID of the Point object. * * @remarks * [Api set: OneNoteApi 1.9] @@ -107400,17 +107403,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Point; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Point; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Point; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointData; } /** @@ -107425,7 +107428,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Point[]; /** - * Returns the number of Point in the stroke. Read-only. + * Returns the number of Point in the stroke. * * @remarks * [Api set: OneNoteApi 1.9] @@ -107468,17 +107471,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PointCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PointCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PointCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointCollectionData; } /** @@ -107491,28 +107494,28 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The parent paragraph containing the ink word. Read-only. + * The parent paragraph containing the ink word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets the ID of the InkWord object. Read-only. + * Gets the ID of the InkWord object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The id of the recognized language in this ink word. Read-only. + * The ID of the recognized language in this ink word. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly languageId: string; /** - * The words that were recognized in this ink word, in order of likelihood. Read-only. + * The words that were recognized in this ink word, in order of likelihood. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107540,17 +107543,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordData; } /** @@ -107565,7 +107568,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkWord[]; /** - * Returns the number of InkWords in the page. Read-only. + * Returns the number of InkWords in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107608,17 +107611,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWordCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordCollectionData; } /** @@ -107631,28 +107634,28 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sectionGroups: OneNote.SectionGroupCollection; /** - * The sections of the notebook. Read only + * The sections of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sections: OneNote.SectionCollection; /** - * The url of the site where this notebook is located. Read only + * The url of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly baseUrl: string; /** - * The client url of the notebook. Read only + * The client url of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107666,14 +107669,14 @@ declare namespace OneNote { */ readonly id: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isVirtual: boolean; /** - * Gets the name of the notebook. Read-only. + * Gets the name of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107726,17 +107729,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Notebook; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Notebook; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Notebook; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookData; } /** @@ -107751,7 +107754,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Notebook[]; /** - * Returns the number of notebooks in the collection. Read-only. + * Returns the number of notebooks in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107803,17 +107806,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NotebookCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NotebookCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookCollectionData; } /** @@ -107826,56 +107829,56 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the notebook that contains the section group. Read-only. + * Gets the notebook that contains the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly notebook: OneNote.Notebook; /** - * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. Read-only. + * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentSectionGroup: OneNote.SectionGroup; /** - * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. Read-only. + * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentSectionGroupOrNull: OneNote.SectionGroup; /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sectionGroups: OneNote.SectionGroupCollection; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sections: OneNote.SectionCollection; /** - * The client url of the section group. Read only + * The client URL of the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the section group. Read-only. + * Gets the ID of the section group. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the name of the section group. Read-only. + * Gets the name of the section group. * * @remarks * [Api set: OneNoteApi 1.1] @@ -107928,17 +107931,17 @@ declare namespace OneNote { expand?: string; }): OneNote.SectionGroup; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroup; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroup; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupData; } /** @@ -107953,7 +107956,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.SectionGroup[]; /** - * Returns the number of section groups in the collection. Read-only. + * Returns the number of section groups in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108005,17 +108008,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroupCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroupCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupCollectionData; } /** @@ -108028,21 +108031,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the notebook that contains the section. Read-only. + * Gets the notebook that contains the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly notebook: OneNote.Notebook; /** - * The collection of pages in the section. Read only + * The collection of pages in the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pages: OneNote.PageCollection; /** - * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. Read-only. + * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108056,42 +108059,42 @@ declare namespace OneNote { */ readonly parentSectionGroupOrNull: OneNote.SectionGroup; /** - * The client url of the section. Read only + * The client url of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the section. Read-only. + * Gets the ID of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * True if this section is encrypted with a password. Read only + * True if this section is encrypted with a password. * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isEncrypted: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. * * @remarks * [Api set: OneNoteApi 1.2] */ readonly isLocked: boolean; /** - * Gets the name of the section. Read-only. + * Gets the name of the section. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly name: string; /** - * The web url of the page. Read only + * The web URL of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108173,17 +108176,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Section; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Section; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Section; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionData; } /** @@ -108198,7 +108201,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Section[]; /** - * Returns the number of sections in the collection. Read-only. + * Returns the number of sections in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108250,17 +108253,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionCollectionData; } /** @@ -108287,7 +108290,7 @@ declare namespace OneNote { */ readonly inkAnalysisOrNull: OneNote.InkAnalysis; /** - * Gets the section that contains the page. Read-only. + * Gets the section that contains the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108301,14 +108304,14 @@ declare namespace OneNote { */ readonly classNotebookPageSource: string; /** - * The client url of the page. Read only + * The client url of the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the page. Read-only. + * Gets the ID of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108329,7 +108332,7 @@ declare namespace OneNote { */ title: string; /** - * The web url of the page. Read only + * The web url of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108351,11 +108354,11 @@ declare namespace OneNote { * * @param left The left position of the top, left corner of the Outline. * @param top The top position of the top, left corner of the Outline. - * @param html An HTML string that describes the visual presentation of the Outline. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html An HTML string that describes the visual presentation of the Outline. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ addOutline(left: number, top: number, html: string): OneNote.Outline; /** - * Return a json string with node id and content in html format. + * Return a JSON string with node ID and content in HTML format. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108367,7 +108370,7 @@ declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param translatedContent Translated content of the page + * @param translatedContent Translated content of the page. */ applyTranslation(translatedContent: string): void; /** @@ -108442,17 +108445,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Page; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Page; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Page; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageData; } /** @@ -108467,7 +108470,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Page[]; /** - * Returns the number of pages in the collection. Read-only. + * Returns the number of pages in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108519,17 +108522,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageCollectionData; } /** @@ -108563,14 +108566,14 @@ declare namespace OneNote { */ readonly outline: OneNote.Outline; /** - * Gets the page that contains the PageContent object. Read-only. + * Gets the page that contains the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentPage: OneNote.Page; /** - * Gets the ID of the PageContent object. Read-only. + * Gets the ID of the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108591,7 +108594,7 @@ declare namespace OneNote { */ top: number; /** - * Gets the type of the PageContent object. Read-only. + * Gets the type of the PageContent object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108634,17 +108637,17 @@ declare namespace OneNote { expand?: string; }): OneNote.PageContent; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContent; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContent; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentData; } /** @@ -108659,7 +108662,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.PageContent[]; /** - * Returns the number of page contents in the collection. Read-only. + * Returns the number of page contents in the collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108702,17 +108705,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContentCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContentCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentCollectionData; } /** @@ -108725,21 +108728,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. + * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the collection of Paragraph objects in the Outline. Read-only. + * Gets the collection of Paragraph objects in the Outline. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the ID of the Outline object. Read-only. + * Gets the ID of the Outline object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108751,7 +108754,7 @@ declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param html The HTML string to append. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html The HTML string to append. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ appendHtml(html: string): void; /** @@ -108814,17 +108817,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Outline; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Outline; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Outline; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.OutlineData; } /** @@ -108837,56 +108840,56 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly image: OneNote.Image; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkWords: OneNote.InkWordCollection; /** - * Gets the Outline object that contains the Paragraph. Read-only. + * Gets the Outline object that contains the Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly outline: OneNote.Outline; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Throws if a parent paragraph does not exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraph: OneNote.Paragraph; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraphOrNull: OneNote.Paragraph; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTableCell: OneNote.TableCell; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, returns null. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108900,21 +108903,21 @@ declare namespace OneNote { */ readonly richText: OneNote.RichText; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly table: OneNote.Table; /** - * Gets the ID of the Paragraph object. Read-only. + * Gets the ID of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the type of the Paragraph object. Read-only. + * Gets the type of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -108969,7 +108972,7 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] * * @param insertLocation The location of new contents relative to the current Paragraph. - * @param html An HTML string that describes the visual presentation of the content. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html An HTML string that describes the visual presentation of the content. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void; /** @@ -108995,7 +108998,7 @@ declare namespace OneNote { */ insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image; /** - * Inserts the image at the specified insert location.. + * Inserts the image at the specified insert location. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109072,17 +109075,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Paragraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Paragraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Paragraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphData; } /** @@ -109097,7 +109100,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.Paragraph[]; /** - * Returns the number of paragraphs in the page. Read-only. + * Returns the number of paragraphs in the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109140,17 +109143,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.ParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.ParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphCollectionData; } /** @@ -109163,21 +109166,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Id of the NoteTag object. Read-only. + * Gets the Id of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the status of the NoteTag object. Read-only. + * Gets the status of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly status: OneNote.NoteTagStatus | "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"; /** - * Gets the type of the NoteTag object. Read-only. + * Gets the type of the NoteTag object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109205,17 +109208,17 @@ declare namespace OneNote { expand?: string; }): OneNote.NoteTag; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NoteTag; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NoteTag; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NoteTagData; } /** @@ -109228,21 +109231,21 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Paragraph object that contains the RichText object. Read-only. + * Gets the Paragraph object that contains the RichText object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets the ID of the RichText object. Read-only. + * Gets the ID of the RichText object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * The language id of the text. Read-only. + * The language id of the text. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109263,7 +109266,7 @@ declare namespace OneNote { */ readonly text: string; /** - * Get the HTML of the rich text + * Gets the HTML of the rich text. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109292,17 +109295,17 @@ declare namespace OneNote { expand?: string; }): OneNote.RichText; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.RichText; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.RichText; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.RichTextData; } /** @@ -109315,14 +109318,14 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. Read-only. + * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly pageContent: OneNote.PageContent; /** - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. Read-only. + * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109350,7 +109353,7 @@ declare namespace OneNote { */ hyperlink: string; /** - * Gets the ID of the Image object. Read-only. + * Gets the ID of the Image object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109408,17 +109411,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Image; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Image; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Image; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ImageData; } /** @@ -109431,14 +109434,14 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Paragraph object that contains the Table object. Read-only. + * Gets the Paragraph object that contains the Table object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraph: OneNote.Paragraph; /** - * Gets all of the table rows. Read-only. + * Gets all of the table rows. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109459,7 +109462,7 @@ declare namespace OneNote { */ readonly columnCount: number; /** - * Gets the ID of the table. Read-only. + * Gets the ID of the table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109565,17 +109568,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Table; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Table; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Table; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableData; } /** @@ -109588,35 +109591,35 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the cells in the row. Read-only. + * Gets the cells in the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cells: OneNote.TableCellCollection; /** - * Gets the parent table. Read-only. + * Gets the parent table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTable: OneNote.Table; /** - * Gets the number of cells in the row. Read-only. + * Gets the number of cells in the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cellCount: number; /** - * Gets the ID of the row. Read-only. + * Gets the ID of the row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the index of the row in its parent table. Read-only. + * Gets the index of the row in its parent table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109679,17 +109682,17 @@ declare namespace OneNote { expand?: string; }): OneNote.TableRow; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRow; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRow; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowData; } /** @@ -109704,7 +109707,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableRow[]; /** - * Returns the number of table rows in this collection. Read-only. + * Returns the number of table rows in this collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109747,17 +109750,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableRowCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRowCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRowCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowCollectionData; } /** @@ -109770,42 +109773,42 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of Paragraph objects in the TableCell. Read-only. + * Gets the collection of Paragraph objects in the TableCell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the parent row of the cell. Read-only. + * Gets the parent row of the cell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentRow: OneNote.TableRow; /** - * Gets the index of the cell in its row. Read-only. + * Gets the index of the cell in its row. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly cellIndex: number; /** - * Gets the ID of the cell. Read-only. + * Gets the ID of the cell. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the index of the cell's row in the table. Read-only. + * Gets the index of the cell's row in the table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly rowIndex: number; /** - * Gets and sets the shading color of the cell + * Gets and sets the shading color of the cell. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109825,7 +109828,7 @@ declare namespace OneNote { * @remarks * [Api set: OneNoteApi 1.1] * - * @param html The HTML string to append. See {@link https://docs.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. + * @param html The HTML string to append. See {@link https://learn.microsoft.com/office/dev/add-ins/onenote/onenote-add-ins-page-content#supported-html | Supported HTML} for the OneNote add-ins JavaScript API. */ appendHtml(html: string): void; /** @@ -109888,17 +109891,17 @@ declare namespace OneNote { expand?: string; }): OneNote.TableCell; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCell; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCell; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellData; } /** @@ -109913,7 +109916,7 @@ declare namespace OneNote { /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableCell[]; /** - * Returns the number of tablecells in this collection. Read-only. + * Returns the number of tablecells in this collection. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109956,17 +109959,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableCellCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCellCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCellCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellCollectionData; } /** @@ -109977,14 +109980,14 @@ declare namespace OneNote { */ interface ImageOcrData { /** - * Represents the OCR language, with values such as EN-US + * Represents the OCR language, with values such as EN-US. * * @remarks * [Api set: OneNoteApi 1.1] */ ocrLanguageId: string; /** - * Represents the text obtained by OCR of the image + * Represents the text obtained by OCR of the image. * * @remarks * [Api set: OneNoteApi 1.1] @@ -109999,14 +110002,14 @@ declare namespace OneNote { */ interface InkStrokePointer { /** - * Represents the id of the page content object corresponding to this stroke + * Represents the ID of the page content object corresponding to this stroke. * * @remarks * [Api set: OneNoteApi 1.1] */ contentId: string; /** - * Represents the id of the ink stroke + * Represents the ID of the ink stroke. * * @remarks * [Api set: OneNoteApi 1.1] @@ -110021,40 +110024,35 @@ declare namespace OneNote { */ interface ParagraphInfo { /** - * // - Bullet list type of paragraph + * Bullet list type of paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ bulletType: string; /** - * // - Level of indentation of the paragraph + * Level of indentation of the paragraph. * * @remarks * [Api set: OneNoteApi 1.8] */ indentationLevel: number; /** - * // - Index of paragraph in a list + * Index of paragraph in a list. * * @remarks * [Api set: OneNoteApi 1.1] */ index: number; /** - * // - Type of list in paragraph + * Type of list in paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ listType: OneNote.ListType | "None" | "Number" | "Bullet"; /** - * // - Numbered list type of paragraph + * Numbered list type of paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -110700,10 +110698,10 @@ declare namespace OneNote { */ $skip?: number; } - /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */ + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { } - /** An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`. */ interface InkAnalysisUpdateData { /** * Gets the parent page object. @@ -110713,7 +110711,7 @@ declare namespace OneNote { */ page?: OneNote.Interfaces.PageUpdateData; } - /** An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... })`. */ interface InkAnalysisParagraphUpdateData { /** * Reference to the parent InkAnalysisPage. @@ -110723,11 +110721,11 @@ declare namespace OneNote { */ inkAnalysis?: OneNote.Interfaces.InkAnalysisUpdateData; } - /** An interface for updating data on the InkAnalysisParagraphCollection object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ interface InkAnalysisParagraphCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisParagraphData[]; } - /** An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`. */ interface InkAnalysisLineUpdateData { /** * Reference to the parent InkAnalysisParagraph. @@ -110737,11 +110735,11 @@ declare namespace OneNote { */ paragraph?: OneNote.Interfaces.InkAnalysisParagraphUpdateData; } - /** An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. */ interface InkAnalysisLineCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisLineData[]; } - /** An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`. */ interface InkAnalysisWordUpdateData { /** * Reference to the parent InkAnalysisLine. @@ -110751,38 +110749,38 @@ declare namespace OneNote { */ line?: OneNote.Interfaces.InkAnalysisLineUpdateData; } - /** An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. */ interface InkAnalysisWordCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisWordData[]; } - /** An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. */ + /** An interface for updating data on the `InkStrokeCollection` object, for use in `inkStrokeCollection.set({ ... })`. */ interface InkStrokeCollectionUpdateData { items?: OneNote.Interfaces.InkStrokeData[]; } - /** An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`. */ + /** An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`. */ interface PointCollectionUpdateData { items?: OneNote.Interfaces.PointData[]; } - /** An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`. */ interface InkWordCollectionUpdateData { items?: OneNote.Interfaces.InkWordData[]; } - /** An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`. */ + /** An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. */ interface NotebookCollectionUpdateData { items?: OneNote.Interfaces.NotebookData[]; } - /** An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. */ interface SectionGroupCollectionUpdateData { items?: OneNote.Interfaces.SectionGroupData[]; } - /** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ interface SectionCollectionUpdateData { items?: OneNote.Interfaces.SectionData[]; } - /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */ + /** An interface for updating data on the `Page` object, for use in `page.set({ ... })`. */ interface PageUpdateData { /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -110803,14 +110801,14 @@ declare namespace OneNote { */ title?: string; } - /** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */ + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ interface PageCollectionUpdateData { items?: OneNote.Interfaces.PageData[]; } - /** An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`. */ + /** An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`. */ interface PageContentUpdateData { /** - * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] @@ -110831,11 +110829,11 @@ declare namespace OneNote { */ top?: number; } - /** An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... })`. */ + /** An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. */ interface PageContentCollectionUpdateData { items?: OneNote.Interfaces.PageContentData[]; } - /** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */ + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ interface ParagraphUpdateData { /** * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. @@ -110856,7 +110854,7 @@ declare namespace OneNote { interface ParagraphCollectionUpdateData { items?: OneNote.Interfaces.ParagraphData[]; } - /** An interface for updating data on the Image object, for use in `image.set({ ... })`. */ + /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */ interface ImageUpdateData { /** * Gets or sets the description of the Image. @@ -110887,7 +110885,7 @@ declare namespace OneNote { */ width?: number; } - /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */ + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ interface TableUpdateData { /** * Gets or sets whether the borders are visible or not. True if they are visible, false if they are hidden. @@ -110897,11 +110895,11 @@ declare namespace OneNote { */ borderVisible?: boolean; } - /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */ + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ interface TableRowCollectionUpdateData { items?: OneNote.Interfaces.TableRowData[]; } - /** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */ + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ interface TableCellUpdateData { /** * Gets and sets the shading color of the cell @@ -110911,7 +110909,7 @@ declare namespace OneNote { */ shadingColor?: string; } - /** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */ + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ interface TableCellCollectionUpdateData { items?: OneNote.Interfaces.TableCellData[]; } @@ -111132,21 +111130,21 @@ declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupData[]; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionData[]; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: string; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111160,7 +111158,7 @@ declare namespace OneNote { */ id?: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + '* True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -111181,21 +111179,21 @@ declare namespace OneNote { /** An interface describing the data returned by calling `sectionGroup.toJSON()`. */ interface SectionGroupData { /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupData[]; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionData[]; /** - * The client url of the section group. Read only + * The client url of the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111223,14 +111221,14 @@ declare namespace OneNote { /** An interface describing the data returned by calling `section.toJSON()`. */ interface SectionData { /** - * The collection of pages in the section. Read only + * The collection of pages in the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ pages?: OneNote.Interfaces.PageData[]; /** - * The client url of the section. Read only + * The client URL of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111244,14 +111242,14 @@ declare namespace OneNote { */ id?: string; /** - * True if this section is encrypted with a password. Read only + * True if this section is encrypted with a password. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] */ isEncrypted?: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -111265,7 +111263,7 @@ declare namespace OneNote { */ name?: string; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111279,18 +111277,18 @@ declare namespace OneNote { /** An interface describing the data returned by calling `page.toJSON()`. */ interface PageData { /** - * The collection of PageContent objects on the page. Read only - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * The collection of PageContent objects on the page. Read only + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ contents?: OneNote.Interfaces.PageContentData[]; /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisData; /** * Gets the ClassNotebookPageSource to the page. @@ -111328,7 +111326,7 @@ declare namespace OneNote { */ title?: string; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111342,21 +111340,21 @@ declare namespace OneNote { /** An interface describing the data returned by calling `pageContent.toJSON()`. */ interface PageContentData { /** - * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageData; /** - * Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ ink?: OneNote.Interfaces.FloatingInkData; /** - * Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. + * Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111415,14 +111413,14 @@ declare namespace OneNote { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ interface ParagraphData { /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageData; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111502,7 +111500,7 @@ declare namespace OneNote { */ id?: string; /** - * The language id of the text. Read-only. + * The language ID of the text. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111672,7 +111670,7 @@ declare namespace OneNote { */ rowIndex?: number; /** - * Gets and sets the shading color of the cell + * Gets and sets the shading color of the cell. * * @remarks * [Api set: OneNoteApi 1.1] @@ -111691,15 +111689,15 @@ declare namespace OneNote { */ interface ApplicationLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ notebooks?: OneNote.Interfaces.NotebookCollectionLoadOptions; } /** @@ -111736,7 +111734,7 @@ declare namespace OneNote { */ interface InkAnalysisParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111769,7 +111767,7 @@ declare namespace OneNote { */ interface InkAnalysisParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111802,7 +111800,7 @@ declare namespace OneNote { */ interface InkAnalysisLineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111835,7 +111833,7 @@ declare namespace OneNote { */ interface InkAnalysisLineCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111868,7 +111866,7 @@ declare namespace OneNote { */ interface InkAnalysisWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111915,7 +111913,7 @@ declare namespace OneNote { */ interface InkAnalysisWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111962,7 +111960,7 @@ declare namespace OneNote { */ interface FloatingInkLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -111995,7 +111993,7 @@ declare namespace OneNote { */ interface InkStrokeLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112021,7 +112019,7 @@ declare namespace OneNote { */ interface InkStrokeCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112047,7 +112045,7 @@ declare namespace OneNote { */ interface PointLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112068,7 +112066,7 @@ declare namespace OneNote { */ interface PointCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112095,7 +112093,7 @@ declare namespace OneNote { */ interface InkWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112113,7 +112111,7 @@ declare namespace OneNote { */ id?: boolean; /** - * The id of the recognized language in this ink word. Read-only. + * The ID of the recognized language in this ink word. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112135,7 +112133,7 @@ declare namespace OneNote { */ interface InkWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112153,7 +112151,7 @@ declare namespace OneNote { */ id?: boolean; /** - * For EACH ITEM in the collection: The id of the recognized language in this ink word. Read-only. + * For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112175,32 +112173,32 @@ declare namespace OneNote { */ interface NotebookLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112214,7 +112212,7 @@ declare namespace OneNote { */ id?: boolean; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -112236,7 +112234,7 @@ declare namespace OneNote { */ interface NotebookCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112247,21 +112245,21 @@ declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * For EACH ITEM in the collection: The sections of the notebook. Read only + * For EACH ITEM in the collection: The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * For EACH ITEM in the collection: The url of the site where this notebook is located. Read only + * For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * For EACH ITEM in the collection: The client url of the notebook. Read only + * For EACH ITEM in the collection: The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112275,7 +112273,7 @@ declare namespace OneNote { */ id?: boolean; /** - * For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * For EACH ITEM in the collection: True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -112297,7 +112295,7 @@ declare namespace OneNote { */ interface SectionGroupLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112322,21 +112320,21 @@ declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * The collection of section groups in the section group. Read only + * The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * The collection of sections in the section group. Read only + * The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * The client url of the section group. Read only + * The client URL of the section group. Read.only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112365,7 +112363,7 @@ declare namespace OneNote { */ interface SectionGroupCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112390,14 +112388,14 @@ declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * For EACH ITEM in the collection: The collection of section groups in the section group. Read only + * For EACH ITEM in the collection: The collection of section groups in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * For EACH ITEM in the collection: The collection of sections in the section group. Read only + * For EACH ITEM in the collection: The collection of sections in the section group. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112433,7 +112431,7 @@ declare namespace OneNote { */ interface SectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112444,7 +112442,7 @@ declare namespace OneNote { */ notebook?: OneNote.Interfaces.NotebookLoadOptions; /** - * The collection of pages in the section. Read only + * The collection of pages in the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112465,7 +112463,7 @@ declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * The client url of the section. Read only + * The client URL of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112486,7 +112484,7 @@ declare namespace OneNote { */ isEncrypted?: boolean; /** - * True if this section is locked. Read only + * True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -112500,7 +112498,7 @@ declare namespace OneNote { */ name?: boolean; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112515,7 +112513,7 @@ declare namespace OneNote { */ interface SectionCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112568,7 +112566,7 @@ declare namespace OneNote { */ isEncrypted?: boolean; /** - * For EACH ITEM in the collection: True if this section is locked. Read only + * For EACH ITEM in the collection: True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -112582,7 +112580,7 @@ declare namespace OneNote { */ name?: boolean; /** - * For EACH ITEM in the collection: The web url of the page. Read only + * For EACH ITEM in the collection: The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112597,11 +112595,11 @@ declare namespace OneNote { */ interface PageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The collection of PageContent objects on the page. Read only + * The collection of PageContent objects on the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112629,7 +112627,7 @@ declare namespace OneNote { */ classNotebookPageSource?: boolean; /** - * The client url of the page. Read only + * The client URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112657,7 +112655,7 @@ declare namespace OneNote { */ title?: boolean; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112672,7 +112670,7 @@ declare namespace OneNote { */ interface PageCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112683,7 +112681,7 @@ declare namespace OneNote { */ contents?: OneNote.Interfaces.PageContentCollectionLoadOptions; /** - * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112704,7 +112702,7 @@ declare namespace OneNote { */ classNotebookPageSource?: boolean; /** - * For EACH ITEM in the collection: The client url of the page. Read only + * For EACH ITEM in the collection: The client URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112747,7 +112745,7 @@ declare namespace OneNote { */ interface PageContentLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112815,25 +112813,25 @@ declare namespace OneNote { */ interface PageContentCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ ink?: OneNote.Interfaces.FloatingInkLoadOptions; /** - * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. + * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112883,7 +112881,7 @@ declare namespace OneNote { */ interface OutlineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -112894,11 +112892,11 @@ declare namespace OneNote { */ pageContent?: OneNote.Interfaces.PageContentLoadOptions; /** - * Gets the collection of Paragraph objects in the Outline. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the collection of Paragraph objects in the Outline. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** * Gets the ID of the Outline object. Read-only. @@ -112916,22 +112914,22 @@ declare namespace OneNote { */ interface ParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. - * - * @remarks - * [Api set: OneNoteApi 1.1] - */ + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions; /** * Gets the Outline object that contains the Paragraph. @@ -112941,28 +112939,28 @@ declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. Read -nly. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] @@ -112976,14 +112974,14 @@ declare namespace OneNote { */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113012,18 +113010,18 @@ declare namespace OneNote { */ interface ParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. + * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. + * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113037,28 +113035,28 @@ declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read only + * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * 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. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113072,14 +113070,14 @@ declare namespace OneNote { */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113108,7 +113106,7 @@ declare namespace OneNote { */ interface NoteTagLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113141,7 +113139,7 @@ declare namespace OneNote { */ interface RichTextLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113159,7 +113157,7 @@ declare namespace OneNote { */ id?: boolean; /** - * The language id of the text. Read-only. + * The language ID of the text. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113188,18 +113186,18 @@ declare namespace OneNote { */ interface ImageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. + * Gets the PageContent object that contains the Image. Throws if the Image isn't a direct child of a PageContent. This object defines the position of the Image on the page. * * @remarks * [Api set: OneNoteApi 1.1] */ pageContent?: OneNote.Interfaces.PageContentLoadOptions; /** - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. + * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113256,7 +113254,7 @@ declare namespace OneNote { */ interface TableLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113310,7 +113308,7 @@ declare namespace OneNote { */ interface TableRowLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113357,7 +113355,7 @@ declare namespace OneNote { */ interface TableRowCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113404,7 +113402,7 @@ declare namespace OneNote { */ interface TableCellLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113458,7 +113456,7 @@ declare namespace OneNote { */ interface TableCellCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -113821,10 +113819,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ApplicationData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ApplicationData): void; } /** * Represents the Document class. @@ -113901,7 +113895,7 @@ declare namespace Visio { * * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType * @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. - * @param show Optional Parameter. If it is set to false, it will hide the specified task pane. + * @param show Optional Parameter. If it's set to false, it will hide the specified task pane. */ showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void; /** @@ -114009,10 +114003,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentData): void; } /** * Represents the DocumentView class. @@ -114092,10 +114082,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentViewData): void; } /** * Represents the Page class. @@ -114210,10 +114196,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageData): void; } /** * Represents the PageView class. @@ -114313,10 +114295,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageViewData): void; } /** * Represents a collection of Page objects that are part of the document. @@ -114368,10 +114346,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageCollectionData): void; } /** * Represents the Shape Collection. @@ -114423,10 +114397,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeCollectionData): void; } /** * Represents the Shape class. @@ -114548,10 +114518,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeData): void; } /** * Represents the ShapeView class. @@ -114659,10 +114625,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeViewData): void; } /** * Represents the Position of the object in the view. @@ -114794,10 +114756,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void; } /** * Represents the ShapeDataItem. @@ -114862,10 +114820,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemData): void; } /** * Represents the Hyperlink Collection. @@ -114917,10 +114871,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void; } /** * Represents the Hyperlink. @@ -114985,10 +114935,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkData): void; } /** * Represents the CommentCollection for a given Shape. @@ -115040,10 +114986,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentCollectionData): void; } /** * Represents the Comment. @@ -115109,10 +115051,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentData): void; } /** * Represents the Selection in the page. @@ -116082,28 +116020,28 @@ declare namespace Visio { /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */ interface ShapeDataItemData { /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: string; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: string; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: string; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -116117,28 +116055,28 @@ declare namespace Visio { /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ interface HyperlinkData { /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: string; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: string; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: string; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -116176,7 +116114,7 @@ declare namespace Visio { /** An interface describing the data returned by calling `selection.toJSON()`. */ interface SelectionData { /** - * Gets the Shapes of the Selection. + * Gets the Shapes of the Selection. Read-only. * * @remarks * [Api set: 1.1] @@ -116301,35 +116239,35 @@ declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * Returns the height of the page. + * Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: boolean; /** - * Index of the Page. + * Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: boolean; /** - * Whether the page is a background page or not. + * Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * Page name. + * Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * Returns the width of the page. + * Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -116374,35 +116312,35 @@ declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * For EACH ITEM in the collection: Returns the height of the page. + * For EACH ITEM in the collection: Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: boolean; /** - * For EACH ITEM in the collection: Index of the Page. + * For EACH ITEM in the collection: Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: boolean; /** - * For EACH ITEM in the collection: Whether the page is a background page or not. + * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * For EACH ITEM in the collection: Page name. + * For EACH ITEM in the collection: Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * For EACH ITEM in the collection: Returns the width of the page. + * For EACH ITEM in the collection: Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -116428,14 +116366,14 @@ declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * For EACH ITEM in the collection: Shape's identifier. + * For EACH ITEM in the collection: Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * For EACH ITEM in the collection: Shape's name. + * For EACH ITEM in the collection: Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -116449,7 +116387,7 @@ declare namespace Visio { */ select?: boolean; /** - * For EACH ITEM in the collection: Shape's text. + * For EACH ITEM in the collection: Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -116475,14 +116413,14 @@ declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * Shape's identifier. + * Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * Shape's name. + * Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -116496,7 +116434,7 @@ declare namespace Visio { */ select?: boolean; /** - * Shape's text. + * Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -116534,21 +116472,21 @@ declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the format of the shape data item. + * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. + * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the label of the shape data item. + * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -116574,28 +116512,28 @@ declare namespace Visio { */ $all?: boolean; /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: boolean; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -116614,28 +116552,28 @@ declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * For EACH ITEM in the collection: Gets the description of a hyperlink. + * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. + * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -116654,28 +116592,28 @@ declare namespace Visio { */ $all?: boolean; /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -116760,25 +116698,25 @@ declare namespace Visio { } /** * 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. - * @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. + * @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. */ function run(batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object. - * @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()". - * @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. + * @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()`. + * @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. */ function run(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects. - * @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()". - * @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. + * @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()`. + * @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. */ function run(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise): Promise; /** * 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. * @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. - * @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. + * @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. */ function run(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise): Promise; } diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 28c78a6181..40eeead49e 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -112321,6 +112321,7 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ getActiveSectionOrNull(): OneNote.Section; + getDecimalSeparator(): OfficeExtension.ClientResult; /** * Gets the currently selected ink strokes. * @@ -112329,6 +112330,7 @@ declare namespace OneNote { */ getSelectedInkStrokes(): OneNote.InkStrokeCollection; getWindowSize(): OfficeExtension.ClientResult; + insertAndEmbedLinkAtCurrentPosition(url: string): void; insertHtmlAtCurrentPosition(html: string): void; isViewingDeletedNotes(): OfficeExtension.ClientResult; /** @@ -112372,9 +112374,9 @@ declare namespace OneNote { expand?: string; }): OneNote.Application; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ApplicationData; } /** @@ -112430,17 +112432,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysis; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysis; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysis; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisData; } /** @@ -112503,17 +112505,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisParagraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphData; } /** @@ -112571,17 +112573,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData; } /** @@ -112644,17 +112646,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisLine; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLine; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLine; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineData; } /** @@ -112712,17 +112714,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisLineCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisLineCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisLineCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData; } /** @@ -112799,17 +112801,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkAnalysisWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordData; } /** @@ -112867,17 +112869,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkAnalysisWordCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkAnalysisWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData; } /** @@ -112932,17 +112934,17 @@ declare namespace OneNote { expand?: string; }): OneNote.FloatingInk; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.FloatingInk; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.FloatingInk; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.FloatingInkData; } /** @@ -112990,17 +112992,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkStroke; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStroke; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStroke; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeData; } /** @@ -113058,17 +113060,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkStrokeCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkStrokeCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkStrokeCollectionData; } /** @@ -113111,17 +113113,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Point; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Point; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Point; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointData; } /** @@ -113179,17 +113181,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PointCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PointCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PointCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PointCollectionData; } /** @@ -113251,17 +113253,17 @@ declare namespace OneNote { expand?: string; }): OneNote.InkWord; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWord; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWord; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordData; } /** @@ -113319,17 +113321,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkWordCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.InkWordCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.InkWordCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.InkWordCollectionData; } /** @@ -113342,28 +113344,28 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sectionGroups: OneNote.SectionGroupCollection; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly sections: OneNote.SectionCollection; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly baseUrl: string; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113377,7 +113379,7 @@ declare namespace OneNote { */ readonly id: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -113437,17 +113439,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Notebook; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Notebook; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Notebook; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookData; } /** @@ -113514,17 +113516,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NotebookCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NotebookCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NotebookCollectionData; } /** @@ -113639,17 +113641,17 @@ declare namespace OneNote { expand?: string; }): OneNote.SectionGroup; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroup; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroup; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupData; } /** @@ -113716,17 +113718,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionGroupCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionGroupCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionGroupCollectionData; } /** @@ -113884,17 +113886,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Section; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Section; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Section; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionData; } /** @@ -113961,17 +113963,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.SectionCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.SectionCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.SectionCollectionData; } /** @@ -113984,7 +113986,7 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * The collection of PageContent objects on the page. Read only + * The collection of PageContent objects on the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -113998,7 +114000,7 @@ declare namespace OneNote { */ readonly inkAnalysisOrNull: OneNote.InkAnalysis; /** - * Gets the section that contains the page. Read-only. + * Gets the section that contains the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -114012,14 +114014,14 @@ declare namespace OneNote { */ readonly classNotebookPageSource: string; /** - * The client url of the page. Read only + * The client URL of the page. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly clientUrl: string; /** - * Gets the ID of the page. Read-only. + * Gets the ID of the page. * * @remarks * [Api set: OneNoteApi 1.1] @@ -114153,17 +114155,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Page; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Page; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Page; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageData; } /** @@ -114230,17 +114232,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageCollectionData; } /** @@ -114345,17 +114347,17 @@ declare namespace OneNote { expand?: string; }): OneNote.PageContent; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContent; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContent; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentData; } /** @@ -114413,17 +114415,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.PageContentCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.PageContentCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.PageContentCollectionData; } /** @@ -114525,17 +114527,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Outline; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Outline; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Outline; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.OutlineData; } /** @@ -114548,84 +114550,84 @@ declare namespace OneNote { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly image: OneNote.Image; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly inkWords: OneNote.InkWordCollection; /** - * Gets the Outline object that contains the Paragraph. Read-only. + * Gets the Outline object that contains the Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly outline: OneNote.Outline; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly paragraphs: OneNote.ParagraphCollection; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraph: OneNote.Paragraph; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentParagraphOrNull: OneNote.Paragraph; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTableCell: OneNote.TableCell; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only. + * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly parentTableCellOrNull: OneNote.TableCell; /** - * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. Read-only + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly richText: OneNote.RichText; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly table: OneNote.Table; /** - * Gets the ID of the Paragraph object. Read-only. + * Gets the ID of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly id: string; /** - * Gets the type of the Paragraph object. Read-only. + * Gets the type of the Paragraph object. * * @remarks * [Api set: OneNoteApi 1.1] @@ -114783,17 +114785,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Paragraph; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Paragraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Paragraph; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphData; } /** @@ -114851,17 +114853,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.ParagraphCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.ParagraphCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ParagraphCollectionData; } /** @@ -114916,17 +114918,17 @@ declare namespace OneNote { expand?: string; }): OneNote.NoteTag; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.NoteTag; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.NoteTag; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.NoteTagData; } /** @@ -114960,25 +114962,25 @@ declare namespace OneNote { */ readonly languageId: string; /** - * Gets the text style of the RichText object. Read-only. + * Gets the text style of the RichText object. * * @remarks * [Api set: OneNoteApi 1.8] */ readonly style: OneNote.ParagraphStyle; /** - * Gets the text content of the RichText object. Read-only. + * Gets the text content of the RichText object. * * @remarks * [Api set: OneNoteApi 1.1] */ readonly text: string; /** - * Get the HTML of the rich text + * Get the HTML of the rich text. * * @remarks * [Api set: OneNoteApi 1.1] - * @returns The html of the rich text + * @returns The HTML of the rich text. */ getHtml(): OfficeExtension.ClientResult; /** @@ -115003,17 +115005,17 @@ declare namespace OneNote { expand?: string; }): OneNote.RichText; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.RichText; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.RichText; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.RichTextData; } /** @@ -115090,7 +115092,7 @@ declare namespace OneNote { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: OneNote.Image): void; /** - * Gets the base64-encoded binary representation of the Image. + * Gets the Base64-encoded binary representation of the Image. Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA... * * @remarks @@ -115119,17 +115121,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Image; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Image; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Image; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.ImageData; } /** @@ -115276,17 +115278,17 @@ declare namespace OneNote { expand?: string; }): OneNote.Table; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.Table; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.Table; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableData; } /** @@ -115390,17 +115392,17 @@ declare namespace OneNote { expand?: string; }): OneNote.TableRow; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRow; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRow; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowData; } /** @@ -115458,17 +115460,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableRowCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableRowCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableRowCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableRowCollectionData; } /** @@ -115599,17 +115601,17 @@ declare namespace OneNote { expand?: string; }): OneNote.TableCell; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCell; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCell; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellData; } /** @@ -115667,17 +115669,17 @@ declare namespace OneNote { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableCellCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created. + * 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. */ track(): OneNote.TableCellCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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. + * 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. */ untrack(): OneNote.TableCellCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): OneNote.Interfaces.TableCellCollectionData; } /** @@ -116388,6 +116390,7 @@ declare namespace OneNote { } enum ErrorCodes { accessDenied = "AccessDenied", + corruptedContent = "CorruptedContent", generalException = "GeneralException", invalidArgument = "InvalidArgument", invalidOperation = "InvalidOperation", @@ -116411,10 +116414,10 @@ declare namespace OneNote { */ $skip?: number; } - /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */ + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { } - /** An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`. */ interface InkAnalysisUpdateData { /** * Gets the parent page object. @@ -116424,7 +116427,7 @@ declare namespace OneNote { */ page?: OneNote.Interfaces.PageUpdateData; } - /** An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... })`. */ interface InkAnalysisParagraphUpdateData { /** * Reference to the parent InkAnalysisPage. @@ -116434,11 +116437,11 @@ declare namespace OneNote { */ inkAnalysis?: OneNote.Interfaces.InkAnalysisUpdateData; } - /** An interface for updating data on the InkAnalysisParagraphCollection object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */ interface InkAnalysisParagraphCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisParagraphData[]; } - /** An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`. */ interface InkAnalysisLineUpdateData { /** * Reference to the parent InkAnalysisParagraph. @@ -116448,11 +116451,11 @@ declare namespace OneNote { */ paragraph?: OneNote.Interfaces.InkAnalysisParagraphUpdateData; } - /** An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. */ interface InkAnalysisLineCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisLineData[]; } - /** An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`. */ interface InkAnalysisWordUpdateData { /** * Reference to the parent InkAnalysisLine. @@ -116462,38 +116465,38 @@ declare namespace OneNote { */ line?: OneNote.Interfaces.InkAnalysisLineUpdateData; } - /** An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. */ interface InkAnalysisWordCollectionUpdateData { items?: OneNote.Interfaces.InkAnalysisWordData[]; } - /** An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. */ + /** An interface for updating data on the `InkStrokeCollection` object, for use in `inkStrokeCollection.set({ ... })`. */ interface InkStrokeCollectionUpdateData { items?: OneNote.Interfaces.InkStrokeData[]; } - /** An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`. */ + /** An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`. */ interface PointCollectionUpdateData { items?: OneNote.Interfaces.PointData[]; } - /** An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`. */ + /** An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`. */ interface InkWordCollectionUpdateData { items?: OneNote.Interfaces.InkWordData[]; } - /** An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`. */ + /** An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. */ interface NotebookCollectionUpdateData { items?: OneNote.Interfaces.NotebookData[]; } - /** An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. */ interface SectionGroupCollectionUpdateData { items?: OneNote.Interfaces.SectionGroupData[]; } - /** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */ + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ interface SectionCollectionUpdateData { items?: OneNote.Interfaces.SectionData[]; } - /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */ + /** An interface for updating data on the `Page` object, for use in `page.set({ ... })`. */ interface PageUpdateData { /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -116514,11 +116517,11 @@ declare namespace OneNote { */ title?: string; } - /** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */ + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ interface PageCollectionUpdateData { items?: OneNote.Interfaces.PageData[]; } - /** An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`. */ + /** An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`. */ interface PageContentUpdateData { /** * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. @@ -116542,11 +116545,11 @@ declare namespace OneNote { */ top?: number; } - /** An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... })`. */ + /** An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. */ interface PageContentCollectionUpdateData { items?: OneNote.Interfaces.PageContentData[]; } - /** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */ + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ interface ParagraphUpdateData { /** * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. @@ -116556,6 +116559,13 @@ declare namespace OneNote { */ image?: OneNote.Interfaces.ImageUpdateData; /** + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink. + * + * @remarks + * [Api set: OneNoteApi 1.1] + */ + richText?: OneNote.Interfaces.RichTextUpdateData; + /** * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. * * @remarks @@ -116563,11 +116573,21 @@ declare namespace OneNote { */ table?: OneNote.Interfaces.TableUpdateData; } - /** An interface for updating data on the ParagraphCollection object, for use in `paragraphCollection.set({ ... })`. */ + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ interface ParagraphCollectionUpdateData { items?: OneNote.Interfaces.ParagraphData[]; } - /** An interface for updating data on the Image object, for use in `image.set({ ... })`. */ + /** An interface for updating data on the `RichText` object, for use in `richText.set({ ... })`. */ + interface RichTextUpdateData { + /** + * Gets the text style of the RichText object. Read-only. + * + * @remarks + * [Api set: OneNoteApi 1.8] + */ + style?: OneNote.ParagraphStyle; + } + /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */ interface ImageUpdateData { /** * Gets or sets the description of the Image. @@ -116598,7 +116618,7 @@ declare namespace OneNote { */ width?: number; } - /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */ + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ interface TableUpdateData { /** * Gets or sets whether the borders are visible or not. True if they are visible, false if they are hidden. @@ -116608,11 +116628,11 @@ declare namespace OneNote { */ borderVisible?: boolean; } - /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */ + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ interface TableRowCollectionUpdateData { items?: OneNote.Interfaces.TableRowData[]; } - /** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */ + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ interface TableCellUpdateData { /** * Gets and sets the shading color of the cell @@ -116622,7 +116642,7 @@ declare namespace OneNote { */ shadingColor?: string; } - /** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */ + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ interface TableCellCollectionUpdateData { items?: OneNote.Interfaces.TableCellData[]; } @@ -116843,21 +116863,21 @@ declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupData[]; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionData[]; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read.only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: string; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -116871,7 +116891,7 @@ declare namespace OneNote { */ id?: string; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -116990,14 +117010,14 @@ declare namespace OneNote { /** An interface describing the data returned by calling `page.toJSON()`. */ interface PageData { /** - * The collection of PageContent objects on the page. Read only + * The collection of PageContent objects on the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ contents?: OneNote.Interfaces.PageContentData[]; /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * Text interpretation for the ink on the page. Returns null if there's no ink analysis information. * * @remarks * [Api set: OneNoteApi 1.1] @@ -117011,7 +117031,7 @@ declare namespace OneNote { */ classNotebookPageSource?: string; /** - * The client url of the page. Read only + * The client url of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -117039,7 +117059,7 @@ declare namespace OneNote { */ title?: string; /** - * The web url of the page. Read only + * The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -117147,7 +117167,7 @@ declare namespace OneNote { */ paragraphs?: OneNote.Interfaces.ParagraphData[]; /** - * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. Read-only + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -117402,7 +117422,7 @@ declare namespace OneNote { */ interface ApplicationLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117421,7 +117441,7 @@ declare namespace OneNote { */ interface InkAnalysisLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117447,7 +117467,7 @@ declare namespace OneNote { */ interface InkAnalysisParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117480,7 +117500,7 @@ declare namespace OneNote { */ interface InkAnalysisParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117513,7 +117533,7 @@ declare namespace OneNote { */ interface InkAnalysisLineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117546,7 +117566,7 @@ declare namespace OneNote { */ interface InkAnalysisLineCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117579,7 +117599,7 @@ declare namespace OneNote { */ interface InkAnalysisWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117626,7 +117646,7 @@ declare namespace OneNote { */ interface InkAnalysisWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117673,7 +117693,7 @@ declare namespace OneNote { */ interface FloatingInkLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117706,7 +117726,7 @@ declare namespace OneNote { */ interface InkStrokeLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117732,7 +117752,7 @@ declare namespace OneNote { */ interface InkStrokeCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117758,7 +117778,7 @@ declare namespace OneNote { */ interface PointLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117779,7 +117799,7 @@ declare namespace OneNote { */ interface PointCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117806,7 +117826,7 @@ declare namespace OneNote { */ interface InkWordLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117846,7 +117866,7 @@ declare namespace OneNote { */ interface InkWordCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117886,32 +117906,32 @@ declare namespace OneNote { */ interface NotebookLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The section groups in the notebook. Read only + * The section groups in the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * The sections of the notebook. Read only + * The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * The url of the site where this notebook is located. Read only + * The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * The client url of the notebook. Read only + * The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -117925,7 +117945,7 @@ declare namespace OneNote { */ id?: boolean; /** - * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only + * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -117947,7 +117967,7 @@ declare namespace OneNote { */ interface NotebookCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -117958,21 +117978,21 @@ declare namespace OneNote { */ sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions; /** - * For EACH ITEM in the collection: The sections of the notebook. Read only + * For EACH ITEM in the collection: The sections of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ sections?: OneNote.Interfaces.SectionCollectionLoadOptions; /** - * For EACH ITEM in the collection: The url of the site where this notebook is located. Read only + * For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ baseUrl?: boolean; /** - * For EACH ITEM in the collection: The client url of the notebook. Read only + * For EACH ITEM in the collection: The client URL of the notebook. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118008,7 +118028,7 @@ declare namespace OneNote { */ interface SectionGroupLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118076,7 +118096,7 @@ declare namespace OneNote { */ interface SectionGroupCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118144,7 +118164,7 @@ declare namespace OneNote { */ interface SectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118155,7 +118175,7 @@ declare namespace OneNote { */ notebook?: OneNote.Interfaces.NotebookLoadOptions; /** - * The collection of pages in the section. Read only + * The collection of pages in the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118176,7 +118196,7 @@ declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * The client url of the section. Read only + * The client url of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118190,7 +118210,7 @@ declare namespace OneNote { */ id?: boolean; /** - * True if this section is encrypted with a password. Read only + * True if this section is encrypted with a password. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -118211,7 +118231,7 @@ declare namespace OneNote { */ name?: boolean; /** - * The web url of the page. Read only + * The web url of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118226,7 +118246,7 @@ declare namespace OneNote { */ interface SectionCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118258,7 +118278,7 @@ declare namespace OneNote { */ parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions; /** - * For EACH ITEM in the collection: The client url of the section. Read only + * For EACH ITEM in the collection: The client URL of the section. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118279,7 +118299,7 @@ declare namespace OneNote { */ isEncrypted?: boolean; /** - * For EACH ITEM in the collection: True if this section is locked. Read only + * For EACH ITEM in the collection: True if this section is locked. Read-only. * * @remarks * [Api set: OneNoteApi 1.2] @@ -118293,7 +118313,7 @@ declare namespace OneNote { */ name?: boolean; /** - * For EACH ITEM in the collection: The web url of the page. Read only + * For EACH ITEM in the collection: The web URL of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118308,18 +118328,18 @@ declare namespace OneNote { */ interface PageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * The collection of PageContent objects on the page. Read only + * The collection of PageContent objects on the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ contents?: OneNote.Interfaces.PageContentCollectionLoadOptions; /** - * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118368,7 +118388,7 @@ declare namespace OneNote { */ title?: boolean; /** - * The web url of the page. Read only + * The web url of the page. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118383,7 +118403,7 @@ declare namespace OneNote { */ interface PageCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118394,7 +118414,7 @@ declare namespace OneNote { */ contents?: OneNote.Interfaces.PageContentCollectionLoadOptions; /** - * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. + * 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. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118458,18 +118478,18 @@ declare namespace OneNote { */ interface PageContentLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118526,18 +118546,18 @@ declare namespace OneNote { */ interface PageContentCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. + * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. + * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118594,7 +118614,7 @@ declare namespace OneNote { */ interface OutlineLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118627,18 +118647,18 @@ declare namespace OneNote { */ interface ParagraphLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. + * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. + * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118652,28 +118672,28 @@ declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * The collection of paragraphs under this paragraph. Read only + * The collection of paragraphs under this paragraph. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118687,14 +118707,14 @@ declare namespace OneNote { */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118723,18 +118743,18 @@ declare namespace OneNote { */ interface ParagraphCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. + * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. * * @remarks * [Api set: OneNoteApi 1.1] */ image?: OneNote.Interfaces.ImageLoadOptions; /** - * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. + * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118748,49 +118768,49 @@ declare namespace OneNote { */ outline?: OneNote.Interfaces.OutlineLoadOptions; /** - * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read only + * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only. * * @remarks * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph does not exist. + * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist. * * @remarks * [Api set: OneNoteApi 1.1] */ parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. + * 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. * * @remarks * [Api set: OneNoteApi 1.1] */ parentTableCell?: OneNote.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. + * 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. * * @remarks * [Api set: OneNoteApi 1.1] */ parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. + * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText nor Ink. * * @remarks * [Api set: OneNoteApi 1.1] */ richText?: OneNote.Interfaces.RichTextLoadOptions; /** - * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. + * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118819,7 +118839,7 @@ declare namespace OneNote { */ interface NoteTagLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118852,7 +118872,7 @@ declare namespace OneNote { */ interface RichTextLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118899,7 +118919,7 @@ declare namespace OneNote { */ interface ImageLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -118910,7 +118930,7 @@ declare namespace OneNote { */ pageContent?: OneNote.Interfaces.PageContentLoadOptions; /** - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. + * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph. * * @remarks * [Api set: OneNoteApi 1.1] @@ -118967,7 +118987,7 @@ declare namespace OneNote { */ interface TableLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -119021,7 +119041,7 @@ declare namespace OneNote { */ interface TableRowLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -119068,7 +119088,7 @@ declare namespace OneNote { */ interface TableRowCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -119115,7 +119135,7 @@ declare namespace OneNote { */ interface TableCellLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -119169,7 +119189,7 @@ declare namespace OneNote { */ interface TableCellCollectionLoadOptions { /** - Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + 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`). */ $all?: boolean; /** @@ -119532,10 +119552,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ApplicationData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ApplicationData): void; } /** * Represents the Document class. @@ -119612,7 +119628,7 @@ declare namespace Visio { * * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType * @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. - * @param show Optional Parameter. If it is set to false, it will hide the specified task pane. + * @param show Optional Parameter. If it's set to false, it will hide the specified task pane. */ showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void; /** @@ -119653,7 +119669,7 @@ declare namespace Visio { */ readonly onDataRefreshComplete: OfficeExtension.EventHandlers; /** - * Occurs when there is an expected or unexpected error occurred in the session. + * Occurs when an expected or unexpected error occurred in the session. * * @remarks * [Api set: 1.1] @@ -119720,10 +119736,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentData): void; } /** * Represents the DocumentView class. @@ -119803,10 +119815,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.DocumentViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.DocumentViewData): void; } /** * Represents the Page class. @@ -119921,10 +119929,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageData): void; } /** * Represents the PageView class. @@ -120024,10 +120028,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageViewData): void; } /** * Represents a collection of Page objects that are part of the document. @@ -120079,10 +120079,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.PageCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.PageCollectionData): void; } /** * Represents the Shape Collection. @@ -120134,10 +120130,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeCollectionData): void; } /** * Represents the Shape class. @@ -120259,10 +120251,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeData): void; } /** * Represents the ShapeView class. @@ -120370,10 +120358,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeViewData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeViewData): void; } /** * Represents the Position of the object in the view. @@ -120505,10 +120489,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void; } /** * Represents the ShapeDataItem. @@ -120573,10 +120553,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.ShapeDataItemData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.ShapeDataItemData): void; } /** * Represents the Hyperlink Collection. @@ -120628,10 +120604,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void; } /** * Represents the Hyperlink. @@ -120696,10 +120668,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.HyperlinkData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.HyperlinkData): void; } /** * Represents the CommentCollection for a given Shape. @@ -120751,10 +120719,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentCollectionData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentCollectionData): void; } /** * Represents the Comment. @@ -120820,10 +120784,6 @@ declare namespace Visio { * 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. */ toJSON(): Visio.Interfaces.CommentData; - /** - * Set mock data - */ - setMockData(data: Visio.Interfaces.CommentData): void; } /** * Represents the Selection in the page. @@ -121567,21 +121527,21 @@ declare namespace Visio { /** An interface describing the data returned by calling `document.toJSON()`. */ interface DocumentData { /** - * Represents a Visio application instance that contains this document. + * Represents a Visio application instance that contains this document. Read-only. * * @remarks * [Api set: 1.1] */ application?: Visio.Interfaces.ApplicationData; /** - * Represents a collection of pages associated with the document. + * Represents a collection of pages associated with the document. Read-only. * * @remarks * [Api set: 1.1] */ pages?: Visio.Interfaces.PageData[]; /** - * Returns the DocumentView object. + * Returns the DocumentView object. Read-only. * * @remarks * [Api set: 1.1] @@ -121629,63 +121589,63 @@ declare namespace Visio { /** An interface describing the data returned by calling `page.toJSON()`. */ interface PageData { /** - * All shapes in the Page, including subshapes. + * All shapes in the Page, including subshapes. Read-only. * * @remarks * [Api set: 1.1] */ allShapes?: Visio.Interfaces.ShapeData[]; /** - * Returns the Comments Collection. + * Returns the Comments Collection. Read-only. * * @remarks * [Api set: 1.1] */ comments?: Visio.Interfaces.CommentData[]; /** - * All top-level shapes in the Page. + * All top-level shapes in the Page. Read-only. * * @remarks * [Api set: 1.1] */ shapes?: Visio.Interfaces.ShapeData[]; /** - * Returns the view of the page. + * Returns the view of the page. Read-only. * * @remarks * [Api set: 1.1] */ view?: Visio.Interfaces.PageViewData; /** - * Returns the height of the page. + * Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: number; /** - * Index of the Page. + * Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: number; /** - * Whether the page is a background page or not. + * Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * Page name. + * Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: string; /** - * Returns the width of the page. + * Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -121713,49 +121673,49 @@ declare namespace Visio { /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** - * Returns the Comments Collection. + * Returns the Comments Collection. Read-only. * * @remarks * [Api set: 1.1] */ comments?: Visio.Interfaces.CommentData[]; /** - * Returns the Hyperlinks collection for a Shape object. + * Returns the Hyperlinks collection for a Shape object. Read-only. * * @remarks * [Api set: 1.1] */ hyperlinks?: Visio.Interfaces.HyperlinkData[]; /** - * Returns the Shape's Data Section. + * Returns the Shape's Data Section. Read-only. * * @remarks * [Api set: 1.1] */ shapeDataItems?: Visio.Interfaces.ShapeDataItemData[]; /** - * Gets SubShape Collection. + * Gets SubShape Collection. Read-only. * * @remarks * [Api set: 1.1] */ subShapes?: Visio.Interfaces.ShapeData[]; /** - * Returns the view of the shape. + * Returns the view of the shape. Read-only. * * @remarks * [Api set: 1.1] */ view?: Visio.Interfaces.ShapeViewData; /** - * Shape's identifier. + * Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: number; /** - * Shape's name. + * Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -121769,7 +121729,7 @@ declare namespace Visio { */ select?: boolean; /** - * Shape's text. + * Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -121793,28 +121753,28 @@ declare namespace Visio { /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */ interface ShapeDataItemData { /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: string; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: string; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: string; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -121828,28 +121788,28 @@ declare namespace Visio { /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ interface HyperlinkData { /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: string; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: string; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: string; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -121887,7 +121847,7 @@ declare namespace Visio { /** An interface describing the data returned by calling `selection.toJSON()`. */ interface SelectionData { /** - * Gets the Shapes of the Selection. + * Gets the Shapes of the Selection. Read-only. * * @remarks * [Api set: 1.1] @@ -122012,35 +121972,35 @@ declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * Returns the height of the page. + * Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] */ height?: boolean; /** - * Index of the Page. + * Index of the Page. Read-only. * * @remarks * [Api set: 1.1] */ index?: boolean; /** - * Whether the page is a background page or not. + * Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * Page name. + * Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * Returns the width of the page. + * Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -122085,7 +122045,7 @@ declare namespace Visio { */ view?: Visio.Interfaces.PageViewLoadOptions; /** - * For EACH ITEM in the collection: Returns the height of the page. + * For EACH ITEM in the collection: Returns the height of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -122093,27 +122053,27 @@ declare namespace Visio { height?: boolean; /** * For EACH ITEM in the collection: Index of the Page. - * + * Read-only. * @remarks * [Api set: 1.1] */ index?: boolean; /** - * For EACH ITEM in the collection: Whether the page is a background page or not. + * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only. * * @remarks * [Api set: 1.1] */ isBackground?: boolean; /** - * For EACH ITEM in the collection: Page name. + * For EACH ITEM in the collection: Page name. Read-only. * * @remarks * [Api set: 1.1] */ name?: boolean; /** - * For EACH ITEM in the collection: Returns the width of the page. + * For EACH ITEM in the collection: Returns the width of the page. Read-only. * * @remarks * [Api set: 1.1] @@ -122139,14 +122099,14 @@ declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * For EACH ITEM in the collection: Shape's identifier. + * For EACH ITEM in the collection: Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * For EACH ITEM in the collection: Shape's name. + * For EACH ITEM in the collection: Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -122160,7 +122120,7 @@ declare namespace Visio { */ select?: boolean; /** - * For EACH ITEM in the collection: Shape's text. + * For EACH ITEM in the collection: Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -122186,14 +122146,14 @@ declare namespace Visio { */ view?: Visio.Interfaces.ShapeViewLoadOptions; /** - * Shape's identifier. + * Shape's identifier. Read-only. * * @remarks * [Api set: 1.1] */ id?: boolean; /** - * Shape's name. + * Shape's name. Read-only. * * @remarks * [Api set: 1.1] @@ -122207,7 +122167,7 @@ declare namespace Visio { */ select?: boolean; /** - * Shape's text. + * Shape's text. Read-only. * * @remarks * [Api set: 1.1] @@ -122245,28 +122205,28 @@ declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the format of the shape data item. + * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. + * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the label of the shape data item. + * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: boolean; /** - * For EACH ITEM in the collection: A string that specifies the value of the shape data item. + * For EACH ITEM in the collection: A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -122285,28 +122245,28 @@ declare namespace Visio { */ $all?: boolean; /** - * A string that specifies the format of the shape data item. + * A string that specifies the format of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ format?: boolean; /** - * A string that specifies the formatted value of the shape data item. + * A string that specifies the formatted value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ formattedValue?: boolean; /** - * A string that specifies the label of the shape data item. + * A string that specifies the label of the shape data item. Read-only. * * @remarks * [Api set: 1.1] */ label?: boolean; /** - * A string that specifies the value of the shape data item. + * A string that specifies the value of the shape data item. Read-only. * * @remarks * [Api set: 1.1] @@ -122325,28 +122285,28 @@ declare namespace Visio { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * For EACH ITEM in the collection: Gets the description of a hyperlink. + * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. + * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. + * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -122365,28 +122325,28 @@ declare namespace Visio { */ $all?: boolean; /** - * Gets the address of the Hyperlink object. + * Gets the address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] */ address?: boolean; /** - * Gets the description of a hyperlink. + * Gets the description of a hyperlink. Read-only. * * @remarks * [Api set: 1.1] */ description?: boolean; /** - * Gets the extra URL request information used to resolve the hyperlink's URL. + * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only. * * @remarks * [Api set: 1.1] */ extraInfo?: boolean; /** - * Gets the sub-address of the Hyperlink object. + * Gets the sub-address of the Hyperlink object. Read-only. * * @remarks * [Api set: 1.1] @@ -122471,25 +122431,25 @@ declare namespace Visio { } /** * 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. - * @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. + * @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. */ function run(batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object. - * @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()". - * @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. + * @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()`. + * @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. */ function run(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects. - * @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()". - * @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. + * @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()`. + * @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. */ function run(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise): Promise; /** * 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. * @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. - * @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. + * @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. */ function run(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise): Promise; } @@ -126243,9 +126203,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData; } /** @@ -126376,9 +126336,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.DocumentProperties; /** - * 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.) - * 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. - */ + * 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.) + * 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. + */ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData; } /** From 75f5a50b6c2d207c44300deac819a654edcf9ad0 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Thu, 7 Nov 2024 12:06:32 -0800 Subject: [PATCH 2/3] [all hosts] Get latest (#2127) --- docs/docs-ref-autogen/excel/excel.yml | 2 + .../excel/excel/excel.base64encodedimage.yml | 10 +- .../excel/excel/excel.base64encodingtype.yml | 54 +- .../excel/excel.blockederrorcellvalue.yml | 16 +- .../excel.blockederrorcellvaluesubtype.yml | 203 +++ .../excel/excel/excel.busyerrorcellvalue.yml | 6 +- .../excel/excel.busyerrorcellvaluesubtype.yml | 11 + .../excel/excel/excel.calcerrorcellvalue.yml | 9 +- .../excel/excel.calcerrorcellvaluesubtype.yml | 106 ++ .../excel/excel.connecterrorcellvalue.yml | 12 +- .../excel.connecterrorcellvaluesubtype.yml | 88 ++ .../excel/excel/excel.documentproperties.yml | 2 +- .../excel/excel/excel.entitycardlayout.yml | 2 +- .../excel/excel/excel.eventtype.yml | 10 + ...cel.externalcodeserviceobjectcellvalue.yml | 14 + .../excel/excel.formattednumbercellvalue.yml | 8 +- ...xcel.interfaces.documentpropertiesdata.yml | 2 +- ...terfaces.documentpropertiesloadoptions.yml | 2 +- ...nterfaces.documentpropertiesupdatedata.yml | 2 +- .../excel/excel.linkedentitycellvalue.yml | 26 +- .../excel.localimagecellvaluecacheid.yml | 8 +- .../excel/excel/excel.nameerrorcellvalue.yml | 12 + .../excel/excel.nameerrorcellvaluesubtype.yml | 30 + .../excel.notavailableerrorcellvalue.yml | 18 + ...xcel.notavailableerrorcellvaluesubtype.yml | 102 ++ .../excel/excel/excel.range.yml | 2 +- .../excel/excel/excel.referrorcellvalue.yml | 4 +- .../excel/excel.referrorcellvaluesubtype.yml | 10 + .../excel/excel/excel.valueerrorcellvalue.yml | 65 +- .../excel.valueerrorcellvaluesubtype.yml | 1028 +++++++++++++ docs/docs-ref-autogen/excel/toc.yml | 4 + .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_10/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_11/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_12/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_13/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_14/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_15/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- .../excel/excel.entitycardlayout.yml | 2 +- .../excel/excel.formattednumbercellvalue.yml | 8 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel/excel.linkedentitycellvalue.yml | 26 +- .../excel_1_16/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- .../excel/excel.entitycardlayout.yml | 2 +- .../excel/excel.formattednumbercellvalue.yml | 8 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel/excel.linkedentitycellvalue.yml | 26 +- .../excel_1_17/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_7/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_8/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel_1_9/excel/excel.range.yml | 2 +- .../excel/excel.documentproperties.yml | 4 +- .../excel/excel.entitycardlayout.yml | 2 +- .../excel/excel.formattednumbercellvalue.yml | 8 +- ...xcel.interfaces.documentpropertiesdata.yml | 4 +- ...terfaces.documentpropertiesloadoptions.yml | 4 +- ...nterfaces.documentpropertiesupdatedata.yml | 4 +- .../excel/excel.linkedentitycellvalue.yml | 26 +- .../excel_online/excel/excel.range.yml | 2 +- docs/includes/excel-1_16.md | 2 +- docs/includes/excel-1_7.md | 4 +- docs/includes/excel-preview.md | 15 +- generate-docs/API Coverage Report.csv | 160 +- .../Excel_1_10/excel.d.ts | 10 +- .../Excel_1_11/excel.d.ts | 10 +- .../Excel_1_12/excel.d.ts | 10 +- .../Excel_1_13/excel.d.ts | 10 +- .../Excel_1_14/excel.d.ts | 10 +- .../Excel_1_15/excel.d.ts | 10 +- .../Excel_1_16/excel.d.ts | 21 +- .../Excel_1_17/excel.d.ts | 21 +- .../Excel_1_7/excel.d.ts | 10 +- .../Excel_1_8/excel.d.ts | 10 +- .../Excel_1_9/excel.d.ts | 10 +- .../Excel_online/excel.d.ts | 21 +- .../api-extractor-inputs-excel/excel.d.ts | 1321 ++++++++++++++++- generate-docs/script-inputs/office.d.ts | 21 +- .../script-inputs/office_preview.d.ts | 1321 ++++++++++++++++- 119 files changed, 4813 insertions(+), 376 deletions(-) create mode 100644 docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvaluesubtype.yml create mode 100644 docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml diff --git a/docs/docs-ref-autogen/excel/excel.yml b/docs/docs-ref-autogen/excel/excel.yml index 4f7c811ee4..44e4bfb0ef 100644 --- a/docs/docs-ref-autogen/excel/excel.yml +++ b/docs/docs-ref-autogen/excel/excel.yml @@ -123,6 +123,8 @@ enums: - 'excel!Excel.LoadToType:enum' - 'excel!Excel.NamedItemScope:enum' - 'excel!Excel.NamedItemType:enum' + - 'excel!Excel.NameErrorCellValueSubType:enum' + - 'excel!Excel.NotAvailableErrorCellValueSubType:enum' - 'excel!Excel.NumberFormatCategory:enum' - 'excel!Excel.NumErrorCellValueSubType:enum' - 'excel!Excel.PageOrientation:enum' diff --git a/docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml b/docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml index b77272dc17..8cecdef60b 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml @@ -3,7 +3,7 @@ name: Excel.Base64EncodedImage uid: 'excel!Excel.Base64EncodedImage:interface' package: excel! fullName: Excel.Base64EncodedImage -summary: The base64 encoding type and data of an image. +summary: The Base64-encoded type and data of an image. remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: true isDeprecated: false @@ -13,7 +13,7 @@ properties: uid: 'excel!Excel.Base64EncodedImage#data:member' package: excel! fullName: data - summary: The base64 string encoding. + summary: The Base64-encoded string. remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: true isDeprecated: false @@ -25,11 +25,11 @@ properties: uid: 'excel!Excel.Base64EncodedImage#type:member' package: excel! fullName: type - summary: The file type of the encoded image. + summary: The file type of the Base64-encoded image. remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: true isDeprecated: false syntax: - content: 'type: Base64EncodingType | "JPG" | "PNG";' + content: 'type: Base64EncodingType | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP";' return: - type: ' | "JPG" | "PNG"' + type: ' | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml b/docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml index 4b63b0a6b8..0909b02e64 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml @@ -3,16 +3,46 @@ name: Excel.Base64EncodingType uid: 'excel!Excel.Base64EncodingType:enum' package: excel! fullName: Excel.Base64EncodingType -summary: The file type represented by the base64 encoding. +summary: The file type represented by the Base64 encoding. remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: true isDeprecated: false fields: + - name: BMP + uid: 'excel!Excel.Base64EncodingType.BMP:member' + package: excel! + summary: >- + The BMP file type. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BMP"' + - name: GIF + uid: 'excel!Excel.Base64EncodingType.GIF:member' + package: excel! + summary: >- + The GIF file type. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GIF"' + - name: ICO + uid: 'excel!Excel.Base64EncodingType.ICO:member' + package: excel! + summary: >- + The ICO file type. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ICO"' - name: JPG uid: 'excel!Excel.Base64EncodingType.JPG:member' package: excel! summary: >- - The JPG file type. + The JPG (or JPEG) file type. * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -28,3 +58,23 @@ fields: * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"PNG"' + - name: TIF + uid: 'excel!Excel.Base64EncodingType.TIF:member' + package: excel! + summary: >- + The TIFF file type. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TIF"' + - name: WEBP + uid: 'excel!Excel.Base64EncodingType.WEBP:member' + package: excel! + summary: >- + The WEBP file type. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WEBP"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvalue.yml index 3c9242116c..6347f7c231 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvalue.yml @@ -47,12 +47,24 @@ properties: syntax: content: >- errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" - | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense"; + | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense" | + "XlmDisabledInTrustCenter" | "XlmNotSupportedOnPlatform" | "ImageDownloadBlocked" | "ImageInvalidUrlNonHttps" | + "ImageExceedsSizeLimit" | "ImageExceedsTotalSizeLimit" | "EnvironmentExceedsQuota" | + "EnvironmentExceedsQuotaDaily" | "EnvironmentExceedsQuotaMonthly" | "EnvironmentExceedsTakerQuotaMonthly" | + "WrongAccountType" | "EnvironmentExceedsComputeResourceEver" | "EnvironmentExceedsComputeResourceCountDaily" | + "PythonUnsupportedOnThisPlatform" | "UnmetRequirements" | "PythonFunction" | "EnvironmentConnectionExceedQuota" + | "UnsupportedEnvironment" | "UnsupportedInCalculationMode"; return: type: >- | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | - "SignInError" | "NoLicense" + "SignInError" | "NoLicense" | "XlmDisabledInTrustCenter" | "XlmNotSupportedOnPlatform" | + "ImageDownloadBlocked" | "ImageInvalidUrlNonHttps" | "ImageExceedsSizeLimit" | "ImageExceedsTotalSizeLimit" | + "EnvironmentExceedsQuota" | "EnvironmentExceedsQuotaDaily" | "EnvironmentExceedsQuotaMonthly" | + "EnvironmentExceedsTakerQuotaMonthly" | "WrongAccountType" | "EnvironmentExceedsComputeResourceEver" | + "EnvironmentExceedsComputeResourceCountDaily" | "PythonUnsupportedOnThisPlatform" | "UnmetRequirements" | + "PythonFunction" | "EnvironmentConnectionExceedQuota" | "UnsupportedEnvironment" | + "UnsupportedInCalculationMode" - name: errorType uid: 'excel!Excel.BlockedErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvaluesubtype.yml index 8f2537eba8..c5c4d077c0 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.blockederrorcellvaluesubtype.yml @@ -32,6 +32,82 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"DataTypeUnsupportedApp"' + - name: environmentConnectionExceedQuota + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentConnectionExceedQuota:member' + package: excel! + summary: >- + An error caused by the user exceeding their quota of concurrent connections to external code service environments. + Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentConnectionExceedQuota"' + - name: environmentExceedsComputeResourceCountDaily + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsComputeResourceCountDaily:member' + package: excel! + summary: >- + An error caused by a user exceeding their daily quota of compute. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsComputeResourceCountDaily"' + - name: environmentExceedsComputeResourceEver + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsComputeResourceEver:member' + package: excel! + summary: >- + An error caused by an external code service execution environment exceeding its lifetime resource use. Displays as + error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsComputeResourceEver"' + - name: environmentExceedsQuota + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsQuota:member' + package: excel! + summary: >- + An error caused by the user exceeding their quota of concurrently active external code service execution + environments. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsQuota"' + - name: environmentExceedsQuotaDaily + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsQuotaDaily:member' + package: excel! + summary: >- + An error caused by the user exceeding their daily quota of external code service execution environments. Displays + as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsQuotaDaily"' + - name: environmentExceedsQuotaMonthly + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsQuotaMonthly:member' + package: excel! + summary: >- + An error caused by the user exceeding their monthly quota of external code service execution environments. + Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsQuotaMonthly"' + - name: environmentExceedsTakerQuotaMonthly + uid: 'excel!Excel.BlockedErrorCellValueSubType.environmentExceedsTakerQuotaMonthly:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EnvironmentExceedsTakerQuotaMonthly"' - name: externalLinksGeneric uid: 'excel!Excel.BlockedErrorCellValueSubType.externalLinksGeneric:member' package: excel! @@ -40,6 +116,49 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"ExternalLinksGeneric"' + - name: imageDownloadBlocked + uid: 'excel!Excel.BlockedErrorCellValueSubType.imageDownloadBlocked:member' + package: excel! + summary: >- + An error caused by the image download coming from an untrusted URL. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageDownloadBlocked"' + - name: imageExceedsSizeLimit + uid: 'excel!Excel.BlockedErrorCellValueSubType.imageExceedsSizeLimit:member' + package: excel! + summary: >- + An error caused by the image exceeding the size limit set in + ExcelServerSettings.CacheBackedAsyncImageDownloaderMaxFileSizeInKBytes. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageExceedsSizeLimit"' + - name: imageExceedsTotalSizeLimit + uid: 'excel!Excel.BlockedErrorCellValueSubType.imageExceedsTotalSizeLimit:member' + package: excel! + summary: >- + An error caused by the image exceeding the size limit for an entire workbook set in `ExcelWorkbookSizeMax`. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageExceedsTotalSizeLimit"' + - name: imageInvalidUrlNonHttps + uid: 'excel!Excel.BlockedErrorCellValueSubType.imageInvalidUrlNonHttps:member' + package: excel! + summary: >- + An error caused by the image URL not being HTTPS. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageInvalidUrlNonHttps"' - name: noLicense uid: 'excel!Excel.BlockedErrorCellValueSubType.noLicense:member' package: excel! @@ -48,6 +167,26 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"NoLicense"' + - name: pythonFunction + uid: 'excel!Excel.BlockedErrorCellValueSubType.pythonFunction:member' + package: excel! + summary: >- + An error caused by the PY function being disabled. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonFunction"' + - name: pythonUnsupportedOnThisPlatform + uid: 'excel!Excel.BlockedErrorCellValueSubType.pythonUnsupportedOnThisPlatform:member' + package: excel! + summary: >- + An error caused by Python not being supported in Excel on a platform. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonUnsupportedOnThisPlatform"' - name: richDataLinkDisabled uid: 'excel!Excel.BlockedErrorCellValueSubType.richDataLinkDisabled:member' package: excel! @@ -72,3 +211,67 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"Unknown"' + - name: unmetRequirements + uid: 'excel!Excel.BlockedErrorCellValueSubType.unmetRequirements:member' + package: excel! + summary: >- + An error caused by Excel not meeting the requirements to use a feature. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnmetRequirements"' + - name: unsupportedEnvironment + uid: 'excel!Excel.BlockedErrorCellValueSubType.unsupportedEnvironment:member' + package: excel! + summary: >- + An error caused by an environment definition not being supported by an external code service. Displays as error + type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnsupportedEnvironment"' + - name: unsupportedInCalculationMode + uid: 'excel!Excel.BlockedErrorCellValueSubType.unsupportedInCalculationMode:member' + package: excel! + summary: >- + An error caused by function being unavailable in Partial or Manual calculation modes. Displays as error type + \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnsupportedInCalculationMode"' + - name: wrongAccountType + uid: 'excel!Excel.BlockedErrorCellValueSubType.wrongAccountType:member' + package: excel! + summary: >- + An error caused by using an unsupported identity provider. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WrongAccountType"' + - name: xlmDisabledInTrustCenter + uid: 'excel!Excel.BlockedErrorCellValueSubType.xlmDisabledInTrustCenter:member' + package: excel! + summary: >- + An error caused by Excel 4.0 macros being disabled in Trust Center. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"XlmDisabledInTrustCenter"' + - name: xlmNotSupportedOnPlatform + uid: 'excel!Excel.BlockedErrorCellValueSubType.xlmNotSupportedOnPlatform:member' + package: excel! + summary: >- + An error caused by Excel 4.0 macros not being supported on the platform. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"XlmNotSupportedOnPlatform"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvalue.yml index e9af6591fd..f34447db3d 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvalue.yml @@ -45,11 +45,13 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage";' + content: >- + errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage" | + "PlaceholderInFormula"; return: type: >- | "Unknown" | "ExternalLinksGeneric" | - "LoadingImage" + "LoadingImage" | "PlaceholderInFormula" - name: errorType uid: 'excel!Excel.BusyErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvaluesubtype.yml index 76c10a436a..ab20f96c33 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.busyerrorcellvaluesubtype.yml @@ -24,6 +24,17 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"LoadingImage"' + - name: placeholderInFormula + uid: 'excel!Excel.BusyErrorCellValueSubType.placeholderInFormula:member' + package: excel! + summary: >- + An error caused by a function being unable to process a placeholder value. Displays as error type \#BUSY! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PlaceholderInFormula"' - name: unknown uid: 'excel!Excel.BusyErrorCellValueSubType.unknown:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvalue.yml index 98340736b5..1ca246aa3b 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvalue.yml @@ -48,12 +48,17 @@ properties: content: >- errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" - | "TextOverflow"; + | "TextOverflow" | "RequestTooLarge" | "PythonGridQuery" | "PythonPowerQueryDataUploadEtagChanged" | + "PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject" | "QueryInCell" | + "UninitializedPythonObject" | "ExternalQueryRef" | "ERegexReplaceCharLimit" | "UnexpectedReturnValue"; return: type: >- | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | - "TooDeeplyNested" | "TextOverflow" + "TooDeeplyNested" | "TextOverflow" | "RequestTooLarge" | "PythonGridQuery" | + "PythonPowerQueryDataUploadEtagChanged" | "PythonPowerQueryDataUploadSizeLimitExceeded" | + "InvalidPythonObject" | "QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" | + "ERegexReplaceCharLimit" | "UnexpectedReturnValue" - name: errorType uid: 'excel!Excel.CalcErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvaluesubtype.yml index fd9c0b6673..abfdcaace6 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.calcerrorcellvaluesubtype.yml @@ -42,6 +42,38 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"EmptyArray"' + - name: eRegexReplaceCharLimit + uid: 'excel!Excel.CalcErrorCellValueSubType.eRegexReplaceCharLimit:member' + package: excel! + summary: >- + An error caused by text that is longer than 65,535 characters. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexReplaceCharLimit"' + - name: externalQueryRef + uid: 'excel!Excel.CalcErrorCellValueSubType.externalQueryRef:member' + package: excel! + summary: >- + An error caused by a reference to a Power Query query in a different workbook. Displays as error type \#CALC! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalQueryRef"' + - name: invalidPythonObject + uid: 'excel!Excel.CalcErrorCellValueSubType.invalidPythonObject:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"InvalidPythonObject"' - name: lambdaInCell uid: 'excel!Excel.CalcErrorCellValueSubType.lambdaInCell:member' package: excel! @@ -50,6 +82,59 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"LambdaInCell"' + - name: pythonGridQuery + uid: 'excel!Excel.CalcErrorCellValueSubType.pythonGridQuery:member' + package: excel! + summary: >- + An error caused by a Power Query query referencing data in a sheet. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonGridQuery"' + - name: pythonPowerQueryDataUploadEtagChanged + uid: 'excel!Excel.CalcErrorCellValueSubType.pythonPowerQueryDataUploadEtagChanged:member' + package: excel! + summary: >- + An error caused by a Power Query query ID change. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonPowerQueryDataUploadEtagChanged"' + - name: pythonPowerQueryDataUploadSizeLimitExceeded + uid: 'excel!Excel.CalcErrorCellValueSubType.pythonPowerQueryDataUploadSizeLimitExceeded:member' + package: excel! + summary: >- + An error caused by Power Query exceeding the limit for data uploaded to an external code service. Displays as + error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonPowerQueryDataUploadSizeLimitExceeded"' + - name: queryInCell + uid: 'excel!Excel.CalcErrorCellValueSubType.queryInCell:member' + package: excel! + summary: >- + An error caused by a formula returning a reference to a Power Query query. Displays as error type \#CALC! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"QueryInCell"' + - name: requestTooLarge + uid: 'excel!Excel.CalcErrorCellValueSubType.requestTooLarge:member' + package: excel! + summary: >- + An error caused by a formula generating too large a request for an external code service. Displays as error type + \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RequestTooLarge"' - name: textOverflow uid: 'excel!Excel.CalcErrorCellValueSubType.textOverflow:member' package: excel! @@ -80,6 +165,27 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"TooManyCells"' + - name: unexpectedReturnValue + uid: 'excel!Excel.CalcErrorCellValueSubType.unexpectedReturnValue:member' + package: excel! + summary: >- + An error caused by an external code service returning an unexpected result. Displays as error type \#CALC! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnexpectedReturnValue"' + - name: uninitializedPythonObject + uid: 'excel!Excel.CalcErrorCellValueSubType.uninitializedPythonObject:member' + package: excel! + summary: >- + An error caused by an uninitialized Python Object. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UninitializedPythonObject"' - name: unknown uid: 'excel!Excel.CalcErrorCellValueSubType.unknown:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvalue.yml index 13147518a7..fd36b7872d 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvalue.yml @@ -50,14 +50,22 @@ properties: "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | - "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError"; + "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError" | "ImageUnableToRetrieve" | + "ExternalCodeServiceEnvironmentNotFound" | "ExternalCodeServiceRuntimeNotFound" | + "ExternalCodeServiceEnvironmentBadState" | "ExternalCodeServiceRuntimeBadState" | + "ExternalCodeServiceComputeResourceNotAvailable" | "PythonPowerQueryDataUploadHasNotStarted" | + "ExcelClientMisconfigurationError"; return: type: >- | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | - "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError" + "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError" | "ImageUnableToRetrieve" | + "ExternalCodeServiceEnvironmentNotFound" | "ExternalCodeServiceRuntimeNotFound" | + "ExternalCodeServiceEnvironmentBadState" | "ExternalCodeServiceRuntimeBadState" | + "ExternalCodeServiceComputeResourceNotAvailable" | "PythonPowerQueryDataUploadHasNotStarted" | + "ExcelClientMisconfigurationError" - name: errorType uid: 'excel!Excel.ConnectErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvaluesubtype.yml index a8cc8d5f40..656a155688 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.connecterrorcellvaluesubtype.yml @@ -24,6 +24,72 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"DataTypeServiceError"' + - name: excelClientMisconfigurationError + uid: 'excel!Excel.ConnectErrorCellValueSubType.excelClientMisconfigurationError:member' + package: excel! + summary: >- + An error caused by Excel being incorrectly configured for connection to an external code service. Displays as + error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExcelClientMisconfigurationError"' + - name: externalCodeServiceComputeResourceNotAvailable + uid: 'excel!Excel.ConnectErrorCellValueSubType.externalCodeServiceComputeResourceNotAvailable:member' + package: excel! + summary: >- + An error caused by an external code service compute resource not being available. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalCodeServiceComputeResourceNotAvailable"' + - name: externalCodeServiceEnvironmentBadState + uid: 'excel!Excel.ConnectErrorCellValueSubType.externalCodeServiceEnvironmentBadState:member' + package: excel! + summary: >- + An error caused by an external code service execution environment being in an inoperative state. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalCodeServiceEnvironmentBadState"' + - name: externalCodeServiceEnvironmentNotFound + uid: 'excel!Excel.ConnectErrorCellValueSubType.externalCodeServiceEnvironmentNotFound:member' + package: excel! + summary: >- + An error caused by not being able to find an external code service execution environment. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalCodeServiceEnvironmentNotFound"' + - name: externalCodeServiceRuntimeBadState + uid: 'excel!Excel.ConnectErrorCellValueSubType.externalCodeServiceRuntimeBadState:member' + package: excel! + summary: >- + An error caused by an external code service runtime being in an inoperative state. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalCodeServiceRuntimeBadState"' + - name: externalCodeServiceRuntimeNotFound + uid: 'excel!Excel.ConnectErrorCellValueSubType.externalCodeServiceRuntimeNotFound:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalCodeServiceRuntimeNotFound"' - name: externalLinks uid: 'excel!Excel.ConnectErrorCellValueSubType.externalLinks:member' package: excel! @@ -110,6 +176,17 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"GenericServerError"' + - name: imageUnableToRetrieve + uid: 'excel!Excel.ConnectErrorCellValueSubType.imageUnableToRetrieve:member' + package: excel! + summary: >- + An error caused by an image download receiving an HTTP response code between 300 and 499. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageUnableToRetrieve"' - name: missingContent uid: 'excel!Excel.ConnectErrorCellValueSubType.missingContent:member' package: excel! @@ -126,6 +203,17 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"OutdatedLinkedEntity"' + - name: pythonPowerQueryDataUploadHasNotStarted + uid: 'excel!Excel.ConnectErrorCellValueSubType.pythonPowerQueryDataUploadHasNotStarted:member' + package: excel! + summary: >- + An error caused by Power Query not having started upload of data to an external code service. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonPowerQueryDataUploadHasNotStarted"' - name: requestThrottle uid: 'excel!Excel.ConnectErrorCellValueSubType.requestThrottle:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel/excel/excel.documentproperties.yml index b6197c5b8d..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.documentproperties.yml @@ -39,7 +39,7 @@ properties: fullName: comments summary: >- The Comments field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml index 961285bc66..2aa261e7c7 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml @@ -3,7 +3,7 @@ name: Excel.EntityCardLayout uid: 'excel!Excel.EntityCardLayout:interface' package: excel! fullName: Excel.EntityCardLayout -summary: Represents a card layout that is best used for an array. +summary: Represents a card layout that is best used for an entity. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.eventtype.yml b/docs/docs-ref-autogen/excel/excel/excel.eventtype.yml index 33a3865b9a..3f7a93ba85 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.eventtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.eventtype.yml @@ -143,6 +143,16 @@ fields: * \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"LinkedWorkbookWorkbookLinksChanged"' + - name: queryQueryRefreshCompleted + uid: 'excel!Excel.EventType.queryQueryRefreshCompleted:member' + package: excel! + summary: >- + TableQueryRefreshCompleted represents the type of event registered when a table query refresh is completed. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"QueryQueryRefreshCompleted"' - name: rangeValuesPreviewDismissed uid: 'excel!Excel.EventType.rangeValuesPreviewDismissed:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.externalcodeserviceobjectcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.externalcodeserviceobjectcellvalue.yml index 8f7962462d..c7f686e58a 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.externalcodeserviceobjectcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.externalcodeserviceobjectcellvalue.yml @@ -57,6 +57,20 @@ properties: content: 'preview?: CellValue;' return: type: '' + - name: provider + uid: 'excel!Excel.ExternalCodeServiceObjectCellValue#provider:member' + package: excel! + fullName: provider + summary: >- + Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`. This field is not writable. + remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: '' - name: Python_str uid: 'excel!Excel.ExternalCodeServiceObjectCellValue#Python_str:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.formattednumbercellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.formattednumbercellvalue.yml index 5809df67ef..89de8b9ea0 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.formattednumbercellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.formattednumbercellvalue.yml @@ -6,9 +6,8 @@ fullName: Excel.FormattedNumberCellValue summary: >- 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 [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the format is applied to the value and not to the cell, so the value retains its format string - throughout calculation. + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the + format is applied to the value and not to the cell, so the value retains its format string throughout calculation. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -47,8 +46,7 @@ properties: 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. Number format strings must conform to Excel guidelines. To learn more, see [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesdata.yml index bb69a71cee..08005873a7 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesdata.yml @@ -39,7 +39,7 @@ properties: fullName: comments summary: >- The Comments field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesloadoptions.yml index eaacef983d..52be115573 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -53,7 +53,7 @@ properties: fullName: comments summary: >- The Comments field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesupdatedata.yml index 2fbc8f9749..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -41,7 +41,7 @@ properties: fullName: comments summary: >- The Comments field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml index 495fa9a87f..8bc0a29492 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.linkedentitycellvalue.yml @@ -36,20 +36,6 @@ properties: content: 'basicValue?: "#VALUE!" | string;' return: type: '"#VALUE!" | string' - - name: cardLayout - uid: 'excel!Excel.LinkedEntityCellValue#cardLayout:member' - package: excel! - fullName: cardLayout - summary: >- - Represents the layout of this linked entity in card view. If the `CardLayout` object doesn't have a layout - property, it default value is "Entity". - remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' - isPreview: false - isDeprecated: false - syntax: - content: 'cardLayout?: CardLayout;' - return: - type: '' - name: id uid: 'excel!Excel.LinkedEntityCellValue#id:member' package: excel! @@ -62,6 +48,18 @@ properties: content: 'id: LinkedEntityId;' return: type: '' + - name: layouts + uid: 'excel!Excel.LinkedEntityCellValue#layouts:member' + package: excel! + fullName: layouts + summary: Represents layout information for views of this linked entity. + remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: '' - name: properties uid: 'excel!Excel.LinkedEntityCellValue#properties:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.localimagecellvaluecacheid.yml b/docs/docs-ref-autogen/excel/excel/excel.localimagecellvaluecacheid.yml index a17c1425b8..c8ba8c6962 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.localimagecellvaluecacheid.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.localimagecellvaluecacheid.yml @@ -9,15 +9,15 @@ isPreview: true isDeprecated: false type: interface properties: - - name: cacheUid - uid: 'excel!Excel.LocalImageCellValueCacheId#cacheUid:member' + - name: cachedUid + uid: 'excel!Excel.LocalImageCellValueCacheId#cachedUid:member' package: excel! - fullName: cacheUid + fullName: cachedUid summary: Represents the image's UID as it appears in the cache. remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: true isDeprecated: false syntax: - content: 'cacheUid: string;' + content: 'cachedUid: string;' return: type: string diff --git a/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvalue.yml index c785f89d3d..cbce7266cf 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvalue.yml @@ -36,6 +36,18 @@ properties: content: 'basicValue?: "#NAME?" | string;' return: type: '"#NAME?" | string' + - name: errorSubType + uid: 'excel!Excel.NameErrorCellValue#errorSubType:member' + package: excel! + fullName: errorSubType + summary: Represents the type of `NameErrorCellValue`. + remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: 'errorSubType?: NameErrorCellValueSubType | "Unknown" | "UnsupportedFunction";' + return: + type: ' | "Unknown" | "UnsupportedFunction"' - name: errorType uid: 'excel!Excel.NameErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..69198aee8a --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.nameerrorcellvaluesubtype.yml @@ -0,0 +1,30 @@ +### YamlMime:TSEnum +name: Excel.NameErrorCellValueSubType +uid: 'excel!Excel.NameErrorCellValueSubType:enum' +package: excel! +fullName: Excel.NameErrorCellValueSubType +summary: 'Represents types of \#NAME? errors.' +remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +fields: + - name: unknown + uid: 'excel!Excel.NameErrorCellValueSubType.unknown:member' + package: excel! + summary: >- + An unknown type of error. Displays as error type \#NAME? in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: unsupportedFunction + uid: 'excel!Excel.NameErrorCellValueSubType.unsupportedFunction:member' + package: excel! + summary: >- + An error caused by a formula containing an unsupported function. Displays as error type \#NAME? in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnsupportedFunction"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml index 724d681e18..60e8ca5874 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml @@ -36,6 +36,24 @@ properties: content: 'basicValue?: "#N/A!" | string;' return: type: '"#N/A!" | string' + - name: errorSubType + uid: 'excel!Excel.NotAvailableErrorCellValue#errorSubType:member' + package: excel! + fullName: errorSubType + summary: Represents the type of `NotAvailableErrorCellValue`. + remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: true + isDeprecated: false + syntax: + content: >- + errorSubType?: NotAvailableErrorCellValueSubType | "Unknown" | "VlookupValueNotFound" | "HlookupValueNotFound" | + "StockHistoryInvalidProperty" | "StockHistoryNoData" | "PythonObjectUnknown" | "ERegexMatchNoResult" | + "ERegexReplaceOccurrenceNoResult" | "ERegexMatchNoCapture"; + return: + type: >- + | "Unknown" | "VlookupValueNotFound" | + "HlookupValueNotFound" | "StockHistoryInvalidProperty" | "StockHistoryNoData" | "PythonObjectUnknown" | + "ERegexMatchNoResult" | "ERegexReplaceOccurrenceNoResult" | "ERegexMatchNoCapture" - name: errorType uid: 'excel!Excel.NotAvailableErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..ad0694b813 --- /dev/null +++ b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml @@ -0,0 +1,102 @@ +### YamlMime:TSEnum +name: Excel.NotAvailableErrorCellValueSubType +uid: 'excel!Excel.NotAvailableErrorCellValueSubType:enum' +package: excel! +fullName: Excel.NotAvailableErrorCellValueSubType +summary: 'Represents types of \#N/A! errors.' +remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' +isPreview: true +isDeprecated: false +fields: + - name: eRegexMatchNoCapture + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.eRegexMatchNoCapture:member' + package: excel! + summary: >- + No capture groups were matched. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexMatchNoCapture"' + - name: eRegexMatchNoResult + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.eRegexMatchNoResult:member' + package: excel! + summary: >- + No match was found for the pattern in the text provided. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexMatchNoResult"' + - name: eRegexReplaceOccurrenceNoResult + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.eRegexReplaceOccurrenceNoResult:member' + package: excel! + summary: >- + Occurrence is greater than the total number of matches. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexReplaceOccurrenceNoResult"' + - name: hlookupValueNotFound + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.hlookupValueNotFound:member' + package: excel! + summary: >- + An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type \#N/A! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HlookupValueNotFound"' + - name: pythonObjectUnknown + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.pythonObjectUnknown:member' + package: excel! + summary: >- + An error caused by an external code service returning an unknown object. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PythonObjectUnknown"' + - name: stockHistoryInvalidProperty + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.stockHistoryInvalidProperty:member' + package: excel! + summary: >- + An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryInvalidProperty"' + - name: stockHistoryNoData + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.stockHistoryNoData:member' + package: excel! + summary: >- + An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryNoData"' + - name: unknown + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.unknown:member' + package: excel! + summary: >- + An unknown type of error. Displays as error type \#N/A! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: vlookupValueNotFound + uid: 'excel!Excel.NotAvailableErrorCellValueSubType.vlookupValueNotFound:member' + package: excel! + summary: >- + An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type \#N/A! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VlookupValueNotFound"' diff --git a/docs/docs-ref-autogen/excel/excel/excel.range.yml b/docs/docs-ref-autogen/excel/excel/excel.range.yml index bb6f16ef56..7023edd22d 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.range.yml @@ -1737,7 +1737,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel/excel/excel.referrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.referrorcellvalue.yml index 6511cdde16..55086428bc 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referrorcellvalue.yml @@ -47,11 +47,11 @@ properties: syntax: content: >- errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | - "ExternalLinksCalculatedRef"; + "ExternalLinksCalculatedRef" | "CorruptCellRef"; return: type: >- | "Unknown" | "ExternalLinksStructuredRef" | - "ExternalLinksCalculatedRef" + "ExternalLinksCalculatedRef" | "CorruptCellRef" - name: errorType uid: 'excel!Excel.RefErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.referrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.referrorcellvaluesubtype.yml index 84bb58c0c6..50540abb6c 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referrorcellvaluesubtype.yml @@ -8,6 +8,16 @@ remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/exc isPreview: false isDeprecated: false fields: + - name: corruptCellRef + uid: 'excel!Excel.RefErrorCellValueSubType.corruptCellRef:member' + package: excel! + summary: >- + An error caused by a corrupt formula. Displays as error type \#REF! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CorruptCellRef"' - name: externalLinksCalculatedRef uid: 'excel!Excel.RefErrorCellValueSubType.externalLinksCalculatedRef:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvalue.yml index 0f79bc13b3..f71bb68de0 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvalue.yml @@ -51,8 +51,37 @@ properties: | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" - | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | - "LambdaWrongParamCount"; + | "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"; return: type: >- | "Unknown" | "VlookupColumnIndexLessThanOne" | @@ -61,7 +90,37 @@ properties: "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | - "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount" + "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" - name: errorType uid: 'excel!Excel.ValueErrorCellValue#errorType:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvaluesubtype.yml index e96ba5fd63..93de0b0500 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.valueerrorcellvaluesubtype.yml @@ -38,6 +38,787 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"CoerceStringToNumberInvalid"' + - name: cRegexAlphaAssertionUnknown + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexAlphaAssertionUnknown:member' + package: excel! + summary: >- + An error in the regex `pattern`. The (*alpha\_assertion) isn't recognized. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexAlphaAssertionUnknown"' + - name: cRegexBackslashCSyntax + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashCSyntax:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashCSyntax"' + - name: cRegexBackslashGSyntax + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashGSyntax:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashGSyntax"' + - name: cRegexBackslashKInLookaround + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashKInLookaround:member' + package: excel! + summary: >- + An error in the regex `pattern`. \\K is not allowed in `lookarounds=`. Displays as error + type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashKInLookaround"' + - name: cRegexBackslashNInClass + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashNInClass:member' + package: excel! + summary: >- + An error in the regex `pattern`. \\N is not supported in class. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashNInClass"' + - name: cRegexBackslashOMissingBrace + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashOMissingBrace:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing opening brace after \\o. Displays as error type \#VALUE! + in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashOMissingBrace"' + - name: cRegexBackslashUCodePointTooBig + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBackslashUCodePointTooBig:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBackslashUCodePointTooBig"' + - name: cRegexBadRelativeReference + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBadRelativeReference:member' + package: excel! + summary: >- + An error in the regex `pattern`. Digit expected after (?+ or (?-. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBadRelativeReference"' + - name: cRegexBadSubpatternReference + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexBadSubpatternReference:member' + package: excel! + summary: >- + An error in the regex `pattern`. Reference to nonexistent subpattern. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexBadSubpatternReference"' + - name: cRegexCalloutBadStringDelimiter + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexCalloutBadStringDelimiter:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unrecognized string delimiter follows (?C. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexCalloutBadStringDelimiter"' + - name: cRegexCalloutNoStringDelimiter + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexCalloutNoStringDelimiter:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing terminating delimiter for callout with string argument. Displays + as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexCalloutNoStringDelimiter"' + - name: cRegexCalloutNumberTooBig + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexCalloutNumberTooBig:member' + package: excel! + summary: >- + An error in the regex `pattern`. Number after (?C is greater than 255. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexCalloutNumberTooBig"' + - name: cRegexCalloutStringTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexCalloutStringTooLong:member' + package: excel! + summary: >- + An error in the regex `pattern`. The callout string is too long. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexCalloutStringTooLong"' + - name: cRegexClassInvalidRange + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexClassInvalidRange:member' + package: excel! + summary: >- + An error in the regex `pattern`. Invalid range in character class. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexClassInvalidRange"' + - name: cRegexCodePointTooBig + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexCodePointTooBig:member' + package: excel! + summary: >- + An error in the regex `pattern`. Character code point value in \\x{} or \\o{} is too large. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexCodePointTooBig"' + - name: cRegexConditionAtomicAssertionExpected + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexConditionAtomicAssertionExpected:member' + package: excel! + summary: >- + An error in the regex `pattern`. Atomic assertion expected after (?( or (?(?C). Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexConditionAtomicAssertionExpected"' + - name: cRegexDefineTooManyBranches + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexDefineTooManyBranches:member' + package: excel! + summary: >- + An error in the regex `pattern`. `DEFINE` subpattern contains more than one branch. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexDefineTooManyBranches"' + - name: cRegexDuplicateSubpatternName + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexDuplicateSubpatternName:member' + package: excel! + summary: >- + An error in the regex `pattern`. Two named subpatterns have the same name. Displays as error type \#VALUE! + in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexDuplicateSubpatternName"' + - name: cRegexEndBackslash + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexEndBackslash:member' + package: excel! + summary: >- + An error in the regex `pattern`. \\ at end of pattern. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexEndBackslash"' + - name: cRegexEndBackslashC + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexEndBackslashC:member' + package: excel! + summary: >- + An error in the regex `pattern`. \\c at end of pattern. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexEndBackslashC"' + - name: cRegexErrorGeneric + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexErrorGeneric:member' + package: excel! + summary: >- + An error in the regex `pattern`. An unknown compile error has occurred. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexErrorGeneric"' + - name: cRegexEscapeInvalidInClass + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexEscapeInvalidInClass:member' + package: excel! + summary: >- + An error in the regex `pattern`. Escape sequence is invalid in character class. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexEscapeInvalidInClass"' + - name: cRegexEscapeInvalidInVerb + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexEscapeInvalidInVerb:member' + package: excel! + summary: >- + An error in the regex `pattern`. Invalid escape sequence in (*VERB) name. Displays as error type \#VALUE! + in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexEscapeInvalidInVerb"' + - name: cRegexInvalidAfterParensQuery + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexInvalidAfterParensQuery:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unrecognized character after (? or (?-. Displays as error type \#VALUE! + in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexInvalidAfterParensQuery"' + - name: cRegexInvalidHexadecimal + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexInvalidHexadecimal:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexInvalidHexadecimal"' + - name: cRegexInvalidHyphenInOptions + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexInvalidHyphenInOptions:member' + package: excel! + summary: >- + An error in the regex `pattern`. Invalid hyphen in option setting. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexInvalidHyphenInOptions"' + - name: cRegexInvalidOctal + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexInvalidOctal:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexInvalidOctal"' + - name: cRegexInvalidSubpatternName + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexInvalidSubpatternName:member' + package: excel! + summary: >- + An error in the regex `pattern`. Subpattern name must start with a non-digit. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexInvalidSubpatternName"' + - name: cRegexLookbehindNotFixedLength + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexLookbehindNotFixedLength:member' + package: excel! + summary: >- + An error in the regex `pattern`. Length of `lookbehind` assertion is not limited. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexLookbehindNotFixedLength"' + - name: cRegexLookbehindTooComplicated + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexLookbehindTooComplicated:member' + package: excel! + summary: >- + An error in the regex `pattern`. `lookbehind` is too complicated. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexLookbehindTooComplicated"' + - name: cRegexLookbehindTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexLookbehindTooLong:member' + package: excel! + summary: >- + An error in the regex `pattern`. `lookbehind` assertion is too long. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexLookbehindTooLong"' + - name: cRegexMalformedUnicodeProperty + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMalformedUnicodeProperty:member' + package: excel! + summary: >- + An error in the regex `pattern`. Malformed \\P or \\p sequence. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMalformedUnicodeProperty"' + - name: cRegexMarkMissingArgument + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMarkMissingArgument:member' + package: excel! + summary: >- + An error in the regex `pattern`. The (*MARK) must have an argument. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMarkMissingArgument"' + - name: cRegexMissingCalloutClosing + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingCalloutClosing:member' + package: excel! + summary: >- + An error in the regex `pattern`. Closing parenthesis for (?C expected. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingCalloutClosing"' + - name: cRegexMissingClosingParenthesis + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingClosingParenthesis:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing closing parenthesis. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingClosingParenthesis"' + - name: cRegexMissingCommentClosing + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingCommentClosing:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing ) after (?\# comment. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingCommentClosing"' + - name: cRegexMissingConditionClosing + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingConditionClosing:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing closing parenthesis for condition. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingConditionClosing"' + - name: cRegexMissingNameTerminator + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingNameTerminator:member' + package: excel! + summary: >- + An error in the regex `pattern`. Syntax error in subpattern name (missing terminator?). Displays as error + type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingNameTerminator"' + - name: cRegexMissingOctalOrHexDigits + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingOctalOrHexDigits:member' + package: excel! + summary: >- + An error in the regex `pattern`. Digits are missing in \\x{}, \\o{}, or \\N{U+}. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingOctalOrHexDigits"' + - name: cRegexMissingSquareBracket + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexMissingSquareBracket:member' + package: excel! + summary: >- + An error in the regex `pattern`. Missing terminating \] for character class. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexMissingSquareBracket"' + - name: cRegexParensQueryRMissingClosing + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexParensQueryRMissingClosing:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexParensQueryRMissingClosing"' + - name: cRegexParenthesesNestTooDeep + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexParenthesesNestTooDeep:member' + package: excel! + summary: >- + An error in the regex `pattern`. Parentheses are too deeply nested. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexParenthesesNestTooDeep"' + - name: cRegexPatternStringTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexPatternStringTooLong:member' + package: excel! + summary: >- + An error in the regex `pattern`. Pattern string is longer than the limit set by the application. Displays + as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexPatternStringTooLong"' + - name: cRegexPatternTooComplicated + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexPatternTooComplicated:member' + package: excel! + summary: >- + An error in the regex `pattern`. Regular expression is too complicated. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexPatternTooComplicated"' + - name: cRegexPatternTooLarge + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexPatternTooLarge:member' + package: excel! + summary: >- + An error in the regex `pattern`. Regular expression is too large. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexPatternTooLarge"' + - name: cRegexPosixClassNotInClass + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexPosixClassNotInClass:member' + package: excel! + summary: >- + An error in the regex `pattern`. POSIX named classes are supported only within a class. Displays as error + type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexPosixClassNotInClass"' + - name: cRegexPosixNoSupportCollating + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexPosixNoSupportCollating:member' + package: excel! + summary: >- + An error in the regex `pattern`. POSIX collating elements are not supported. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexPosixNoSupportCollating"' + - name: cRegexQuantifierInvalid + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexQuantifierInvalid:member' + package: excel! + summary: >- + An error in the regex `pattern`. Quantifier does not follow a repeatable item. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexQuantifierInvalid"' + - name: cRegexQuantifierOutOfOrder + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexQuantifierOutOfOrder:member' + package: excel! + summary: >- + An error in the regex `pattern`. Number out of order in {} quantifier. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexQuantifierOutOfOrder"' + - name: cRegexQuantifierTooBig + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexQuantifierTooBig:member' + package: excel! + summary: >- + An error in the regex `pattern`. Number too big in quantifier {}. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexQuantifierTooBig"' + - name: cRegexQueryBarjxNestTooDeep + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexQueryBarjxNestTooDeep:member' + package: excel! + summary: >- + An error in the regex `pattern`. The (?\|, (?J:, or (?x: parentheses are too deeply nested. Displays as + error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexQueryBarjxNestTooDeep"' + - name: cRegexSubpatternNameExpected + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexSubpatternNameExpected:member' + package: excel! + summary: >- + An error in the regex `pattern`. Subpattern name expected. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexSubpatternNameExpected"' + - name: cRegexSubpatternNamesMismatch + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexSubpatternNamesMismatch:member' + package: excel! + summary: >- + An error in the regex `pattern`. Different names for subpatterns of the same number are not allowed. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexSubpatternNamesMismatch"' + - name: cRegexSubpatternNameTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexSubpatternNameTooLong:member' + package: excel! + summary: >- + An error in the regex `pattern`. Subpattern name is too long. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexSubpatternNameTooLong"' + - name: cRegexSubpatternNumberTooBig + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexSubpatternNumberTooBig:member' + package: excel! + summary: >- + An error in the regex `pattern`. The subpattern number exceeds the limit of 65,535. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexSubpatternNumberTooBig"' + - name: cRegexTooManyCaptures + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexTooManyCaptures:member' + package: excel! + summary: >- + An error in the regex `pattern`. Too many capturing groups (maximum 65535). Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexTooManyCaptures"' + - name: cRegexTooManyConditionBranches + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexTooManyConditionBranches:member' + package: excel! + summary: >- + An error in the regex `pattern`. Conditional subpattern contains more than two branches. Displays as error + type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexTooManyConditionBranches"' + - name: cRegexTooManyNamedSubpatterns + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexTooManyNamedSubpatterns:member' + package: excel! + summary: >- + An error in the regex `pattern`. Too many named subpatterns. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexTooManyNamedSubpatterns"' + - name: cRegexUnicodeDisallowedCodePoint + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnicodeDisallowedCodePoint:member' + package: excel! + summary: >- + An error in the regex `pattern`. Disallowed Unicode point (>= 0xD800 && + <= 0xDFFF). Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnicodeDisallowedCodePoint"' + - name: cRegexUnicodePropertiesUnavailable + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnicodePropertiesUnavailable:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnicodePropertiesUnavailable"' + - name: cRegexUnknownEscape + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnknownEscape:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unrecognized character follows . Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnknownEscape"' + - name: cRegexUnknownPosixClass + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnknownPosixClass:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unknown POSIX class name. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnknownPosixClass"' + - name: cRegexUnknownUnicodeProperty + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnknownUnicodeProperty:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unknown property after \\P or \\p. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnknownUnicodeProperty"' + - name: cRegexUnmatchedClosingParenthesis + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnmatchedClosingParenthesis:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unmatched closing parenthesis. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnmatchedClosingParenthesis"' + - name: cRegexUnrecognizedAfterQueryP + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnrecognizedAfterQueryP:member' + package: excel! + summary: >- + An error in the regex `pattern`. Unrecongnized character after (?P. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnrecognizedAfterQueryP"' + - name: cRegexUnsupportedEscapeSequence + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexUnsupportedEscapeSequence:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexUnsupportedEscapeSequence"' + - name: cRegexVerbNameTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexVerbNameTooLong:member' + package: excel! + summary: >- + An error in the regex `pattern`. A name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN). + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexVerbNameTooLong"' + - name: cRegexVerbUnknown + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexVerbUnknown:member' + package: excel! + summary: >- + An error in the regex `pattern`. The (*VERB) is not recognized or is malformed. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexVerbUnknown"' + - name: cRegexVersionConditionSyntax + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexVersionConditionSyntax:member' + package: excel! + summary: >- + 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. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexVersionConditionSyntax"' + - name: cRegexZeroRelativeReference + uid: 'excel!Excel.ValueErrorCellValueSubType.cRegexZeroRelativeReference:member' + package: excel! + summary: >- + An error in the regex `pattern`. A relative value of zero is not allowed. Displays as error type \#VALUE! + in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CRegexZeroRelativeReference"' + - name: eRegexErrorGeneric + uid: 'excel!Excel.ValueErrorCellValueSubType.eRegexErrorGeneric:member' + package: excel! + summary: >- + An unknown regex error occurred. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexErrorGeneric"' + - name: eRegexNoCaptureGroups + uid: 'excel!Excel.ValueErrorCellValueSubType.eRegexNoCaptureGroups:member' + package: excel! + summary: >- + No capture groups were found in the regex pattern. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ERegexNoCaptureGroups"' - name: hlookupResultNotFound uid: 'excel!Excel.ValueErrorCellValueSubType.hlookupResultNotFound:member' package: excel! @@ -56,6 +837,101 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"HlookupRowIndexLessThanOne"' + - name: imageFormulaInvalidAltText + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidAltText:member' + package: excel! + summary: >- + An error caused by a non-string `alt_text` parameter to an `IMAGE` function. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidAltText"' + - name: imageFormulaInvalidHeight + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidHeight:member' + package: excel! + summary: >- + An error caused by a non-numerical or invalid `height` argument passed to `IMAGE`. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidHeight"' + - name: imageFormulaInvalidImageFormat + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidImageFormat:member' + package: excel! + summary: >- + An error caused by an unsupported image formula. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidImageFormat"' + - name: imageFormulaInvalidSizing + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidSizing:member' + package: excel! + summary: >- + An error caused by invalid size parameters to `IMAGE`. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidSizing"' + - name: imageFormulaInvalidSource + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidSource:member' + package: excel! + summary: >- + An error caused by a non-string `source` parameter to an `IMAGE` function. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidSource"' + - name: imageFormulaInvalidWidth + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaInvalidWidth:member' + package: excel! + summary: >- + An error caused by a non-numerical or invalid `width` argument passed to `IMAGE`. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaInvalidWidth"' + - name: imageFormulaNotEnoughArgs + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaNotEnoughArgs:member' + package: excel! + summary: >- + An error caused by too few arguments passed to `IMAGE`. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaNotEnoughArgs"' + - name: imageFormulaTooManyArgs + uid: 'excel!Excel.ValueErrorCellValueSubType.imageFormulaTooManyArgs:member' + package: excel! + summary: >- + An error caused by passing too many arguments to an `IMAGE` function. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageFormulaTooManyArgs"' + - name: invalidCellValueTypeCoercion + uid: 'excel!Excel.ValueErrorCellValueSubType.invalidCellValueTypeCoercion:member' + package: excel! + summary: >- + An error caused by an argument with the wrong data type passed to a custom function. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"InvalidCellValueTypeCoercion"' - name: invalidImageUrl uid: 'excel!Excel.ValueErrorCellValueSubType.invalidImageUrl:member' package: excel! @@ -74,6 +950,126 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"LambdaWrongParamCount"' + - name: mRegexBadrepescape + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexBadrepescape:member' + package: excel! + summary: >- + An error in regex match. There's an incorrect escape sequence in the replacement string. Displays as error type + \#VALUE! in Excel. Note: The name of this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexBadrepescape"' + - name: mRegexBadreplacement + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexBadreplacement:member' + package: excel! + summary: >- + An error in regex match. Invalid replacement string. Displays as error type \#VALUE! in Excel. Note: The name of + this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexBadreplacement"' + - name: mRegexBadsubspattern + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexBadsubspattern:member' + package: excel! + summary: >- + An error in regex match. Match with end before start or start moved backwards is not supported. Displays as error + type \#VALUE! in Excel. Note: The name of this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexBadsubspattern"' + - name: mRegexBadsubstitution + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexBadsubstitution:member' + package: excel! + summary: >- + An error in regex match. There's an incorrect substitution in the replacement string. Displays as error type + \#VALUE! in Excel. Note: The name of this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexBadsubstitution"' + - name: mRegexDepthlimit + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexDepthlimit:member' + package: excel! + summary: >- + An error in regex match. Matching depth limit exceeded. Displays as error type \#VALUE! in Excel. Note: The name + of this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexDepthlimit"' + - name: mRegexErrorGeneric + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexErrorGeneric:member' + package: excel! + summary: >- + An error in regex match. An unknown match error has occurred. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexErrorGeneric"' + - name: mRegexMatchlimit + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexMatchlimit:member' + package: excel! + summary: >- + An error in regex match. Match limit exceeded. Displays as error type \#VALUE! in Excel. Note: The name of this + API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexMatchlimit"' + - name: mRegexNosubstring + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexNosubstring:member' + package: excel! + summary: >- + An error in regex match. Unknown substring. Displays as error type \#VALUE! in Excel. Note: The name of this API + is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexNosubstring"' + - name: mRegexNouniquesubstring + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexNouniquesubstring:member' + package: excel! + summary: >- + An error in regex match. Nonunique substring name. Displays as error type \#VALUE! in Excel. Note: The name of + this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexNouniquesubstring"' + - name: mRegexRecurseLoop + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexRecurseLoop:member' + package: excel! + summary: >- + An error in regex match. Recursive loop. Displays as error type \#VALUE! in Excel. Note: The name of this API is + likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexRecurseLoop"' + - name: mRegexRepmissingbrace + uid: 'excel!Excel.ValueErrorCellValueSubType.mRegexRepmissingbrace:member' + package: excel! + summary: >- + An error in regex match. Expected closing curly bracket in replacement string. Displays as error type \#VALUE! in + Excel. Note: The name of this API is likely to change in the near future. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MRegexRepmissingbrace"' - name: stockHistoryEndBeforeStart uid: 'excel!Excel.ValueErrorCellValueSubType.stockHistoryEndBeforeStart:member' package: excel! @@ -168,6 +1164,38 @@ fields: * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] value: '"SubArrayStartRowMissingEndRowNot"' + - name: translateStringTooLong + uid: 'excel!Excel.ValueErrorCellValueSubType.translateStringTooLong:member' + package: excel! + summary: >- + An error caused by the `text` parameter to `TRANSLATE` being too long. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TranslateStringTooLong"' + - name: translateUnsupportedSrcLanguage + uid: 'excel!Excel.ValueErrorCellValueSubType.translateUnsupportedSrcLanguage:member' + package: excel! + summary: >- + An error caused because the `source_language` parameter to `TRANSLATE` is not supported. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TranslateUnsupportedSrcLanguage"' + - name: translateUnsupportedTargetLanguage + uid: 'excel!Excel.ValueErrorCellValueSubType.translateUnsupportedTargetLanguage:member' + package: excel! + summary: >- + An error caused because the `target_language` parameter to `TRANSLATE` is not supported. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TranslateUnsupportedTargetLanguage"' - name: unknown uid: 'excel!Excel.ValueErrorCellValueSubType.unknown:member' package: excel! diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index e14d69a5ec..deb43718c6 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -266,6 +266,10 @@ items: uid: 'excel!Excel.NamedItemScope:enum' - name: NamedItemType uid: 'excel!Excel.NamedItemType:enum' + - name: NameErrorCellValueSubType + uid: 'excel!Excel.NameErrorCellValueSubType:enum' + - name: NotAvailableErrorCellValueSubType + uid: 'excel!Excel.NotAvailableErrorCellValueSubType:enum' - name: NumberFormatCategory uid: 'excel!Excel.NumberFormatCategory:enum' - name: NumErrorCellValueSubType diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.range.yml index 14f5aeae58..39cfd2f676 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.range.yml @@ -1363,7 +1363,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml index fe603ef1de..f915597ae7 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.range.yml @@ -1363,7 +1363,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml index 84e6bfd903..8abdf1a332 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.range.yml @@ -1454,7 +1454,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml index 40b22a6d31..e41c9d5ed2 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml @@ -1584,7 +1584,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml index df47a0f9bf..e009ddca60 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml @@ -1584,7 +1584,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml index b160f41523..5e24a6d37f 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml @@ -1636,7 +1636,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml index 2a820d0b9a..c2407f8757 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml @@ -3,7 +3,7 @@ name: Excel.EntityCardLayout uid: 'excel!Excel.EntityCardLayout:interface' package: excel! fullName: Excel.EntityCardLayout -summary: Represents a card layout that is best used for an array. +summary: Represents a card layout that is best used for an entity. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.formattednumbercellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.formattednumbercellvalue.yml index 5809df67ef..89de8b9ea0 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.formattednumbercellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.formattednumbercellvalue.yml @@ -6,9 +6,8 @@ fullName: Excel.FormattedNumberCellValue summary: >- 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 [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the format is applied to the value and not to the cell, so the value retains its format string - throughout calculation. + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the + format is applied to the value and not to the cell, so the value retains its format string throughout calculation. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -47,8 +46,7 @@ properties: 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. Number format strings must conform to Excel guidelines. To learn more, see [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.linkedentitycellvalue.yml index 495fa9a87f..8bc0a29492 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.linkedentitycellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.linkedentitycellvalue.yml @@ -36,20 +36,6 @@ properties: content: 'basicValue?: "#VALUE!" | string;' return: type: '"#VALUE!" | string' - - name: cardLayout - uid: 'excel!Excel.LinkedEntityCellValue#cardLayout:member' - package: excel! - fullName: cardLayout - summary: >- - Represents the layout of this linked entity in card view. If the `CardLayout` object doesn't have a layout - property, it default value is "Entity". - remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' - isPreview: false - isDeprecated: false - syntax: - content: 'cardLayout?: CardLayout;' - return: - type: '' - name: id uid: 'excel!Excel.LinkedEntityCellValue#id:member' package: excel! @@ -62,6 +48,18 @@ properties: content: 'id: LinkedEntityId;' return: type: '' + - name: layouts + uid: 'excel!Excel.LinkedEntityCellValue#layouts:member' + package: excel! + fullName: layouts + summary: Represents layout information for views of this linked entity. + remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: '' - name: properties uid: 'excel!Excel.LinkedEntityCellValue#properties:member' package: excel! diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml index d2326357bb..6159aaa99c 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml @@ -1704,7 +1704,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml index 2a820d0b9a..c2407f8757 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml @@ -3,7 +3,7 @@ name: Excel.EntityCardLayout uid: 'excel!Excel.EntityCardLayout:interface' package: excel! fullName: Excel.EntityCardLayout -summary: Represents a card layout that is best used for an array. +summary: Represents a card layout that is best used for an entity. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.formattednumbercellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.formattednumbercellvalue.yml index 5809df67ef..89de8b9ea0 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.formattednumbercellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.formattednumbercellvalue.yml @@ -6,9 +6,8 @@ fullName: Excel.FormattedNumberCellValue summary: >- 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 [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the format is applied to the value and not to the cell, so the value retains its format string - throughout calculation. + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the + format is applied to the value and not to the cell, so the value retains its format string throughout calculation. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -47,8 +46,7 @@ properties: 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. Number format strings must conform to Excel guidelines. To learn more, see [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.linkedentitycellvalue.yml index 495fa9a87f..8bc0a29492 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.linkedentitycellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.linkedentitycellvalue.yml @@ -36,20 +36,6 @@ properties: content: 'basicValue?: "#VALUE!" | string;' return: type: '"#VALUE!" | string' - - name: cardLayout - uid: 'excel!Excel.LinkedEntityCellValue#cardLayout:member' - package: excel! - fullName: cardLayout - summary: >- - Represents the layout of this linked entity in card view. If the `CardLayout` object doesn't have a layout - property, it default value is "Entity". - remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' - isPreview: false - isDeprecated: false - syntax: - content: 'cardLayout?: CardLayout;' - return: - type: '' - name: id uid: 'excel!Excel.LinkedEntityCellValue#id:member' package: excel! @@ -62,6 +48,18 @@ properties: content: 'id: LinkedEntityId;' return: type: '' + - name: layouts + uid: 'excel!Excel.LinkedEntityCellValue#layouts:member' + package: excel! + fullName: layouts + summary: Represents layout information for views of this linked entity. + remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: '' - name: properties uid: 'excel!Excel.LinkedEntityCellValue#properties:member' package: excel! diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml index d2326357bb..6159aaa99c 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml @@ -1704,7 +1704,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_7/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_7/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_7/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_7/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_7/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_7/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_7/excel/excel.range.yml index 855f9d8809..4cc4ff0fa3 100644 --- a/docs/docs-ref-autogen/excel_1_7/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_7/excel/excel.range.yml @@ -856,7 +856,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.range.yml index 2ea2258d76..c8a569d0cd 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.range.yml @@ -868,7 +868,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.range.yml index a7bb5d7a14..c76bee05a6 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.range.yml @@ -1315,7 +1315,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_online/excel/excel.documentproperties.yml index 8ba4ed179c..f34448f6dc 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.documentproperties.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.documentproperties.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml index 2a820d0b9a..c2407f8757 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml @@ -3,7 +3,7 @@ name: Excel.EntityCardLayout uid: 'excel!Excel.EntityCardLayout:interface' package: excel! fullName: Excel.EntityCardLayout -summary: Represents a card layout that is best used for an array. +summary: Represents a card layout that is best used for an entity. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.formattednumbercellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.formattednumbercellvalue.yml index 5809df67ef..89de8b9ea0 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.formattednumbercellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.formattednumbercellvalue.yml @@ -6,9 +6,8 @@ fullName: Excel.FormattedNumberCellValue summary: >- 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 [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the format is applied to the value and not to the cell, so the value retains its format string - throughout calculation. + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the + format is applied to the value and not to the cell, so the value retains its format string throughout calculation. remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false @@ -47,8 +46,7 @@ properties: 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. Number format strings must conform to Excel guidelines. To learn more, see [Review guidelines for customizing a number - format](https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesdata.yml index 99182e6509..08005873a7 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesdata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesdata.yml @@ -38,8 +38,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesloadoptions.yml index c0802c12a5..52be115573 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesloadoptions.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -52,8 +52,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesupdatedata.yml index 6c4328ba13..5483c5021c 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesupdatedata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -40,8 +40,8 @@ properties: package: excel! fullName: comments summary: >- - The comment field in the metadata of the workbook. These have no connection to comments by users made in the - workbork. + The Comments field in the metadata of the workbook. These have no connection to comments by users made in the + workbook. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.linkedentitycellvalue.yml index 495fa9a87f..8bc0a29492 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.linkedentitycellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.linkedentitycellvalue.yml @@ -36,20 +36,6 @@ properties: content: 'basicValue?: "#VALUE!" | string;' return: type: '"#VALUE!" | string' - - name: cardLayout - uid: 'excel!Excel.LinkedEntityCellValue#cardLayout:member' - package: excel! - fullName: cardLayout - summary: >- - Represents the layout of this linked entity in card view. If the `CardLayout` object doesn't have a layout - property, it default value is "Entity". - remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' - isPreview: false - isDeprecated: false - syntax: - content: 'cardLayout?: CardLayout;' - return: - type: '' - name: id uid: 'excel!Excel.LinkedEntityCellValue#id:member' package: excel! @@ -62,6 +48,18 @@ properties: content: 'id: LinkedEntityId;' return: type: '' + - name: layouts + uid: 'excel!Excel.LinkedEntityCellValue#layouts:member' + package: excel! + fullName: layouts + summary: Represents layout information for views of this linked entity. + remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: '' - name: properties uid: 'excel!Excel.LinkedEntityCellValue#properties:member' package: excel! diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml index d2326357bb..6159aaa99c 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml @@ -1704,7 +1704,7 @@ methods: package: excel! fullName: getImage() summary: >- - Renders the range as a Base64-encoded png image. *Important**: This API is currently unsupported in Excel for + Renders the range as a Base64-encoded PNG image. *Important**: This API is currently unsupported in Excel for Mac. Visit [OfficeDev/office-js Issue \#235](https://github.com/OfficeDev/office-js/issues/235) for the current status. remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]' diff --git a/docs/includes/excel-1_16.md b/docs/includes/excel-1_16.md index dfac5b8665..bc4f1c2a13 100644 --- a/docs/includes/excel-1_16.md +++ b/docs/includes/excel-1_16.md @@ -103,8 +103,8 @@ ||[type](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-type-member)|Represents the type of this cell value.| |[LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue)|[basicType](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| ||[basicValue](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[cardLayout](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-cardlayout-member)|Represents the layout of this linked entity in card view.| ||[id](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-id-member)|Represents the service source that provided the information in this value.| +||[layouts](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-layouts-member)|Represents layout information for views of this linked entity.| ||[properties](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-properties-member)|Represents the properties of this linked entity and their metadata.| ||[provider](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-provider-member)|Represents information that describes the service that provided data in this `LinkedEntityCellValue`.| ||[text](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| diff --git a/docs/includes/excel-1_7.md b/docs/includes/excel-1_7.md index 0d14a90032..1bae916d0c 100644 --- a/docs/includes/excel-1_7.md +++ b/docs/includes/excel-1_7.md @@ -115,7 +115,7 @@ |[DataConnectionCollection](/javascript/api/excel/excel.dataconnectioncollection)|[refreshAll()](/javascript/api/excel/excel.dataconnectioncollection#excel-excel-dataconnectioncollection-refreshall-member(1))|Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.| |[DocumentProperties](/javascript/api/excel/excel.documentproperties)|[author](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-author-member)|The author of the workbook.| ||[category](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-category-member)|The category of the workbook.| -||[comments](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-comments-member)|The comment field in the metadata of the workbook.| +||[comments](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-comments-member)|The Comments field in the metadata of the workbook.| ||[company](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-company-member)|The company of the workbook.| ||[creationDate](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-creationdate-member)|Gets the creation date of the workbook.| ||[custom](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-custom-member)|Gets the collection of custom properties of the workbook.| @@ -130,7 +130,7 @@ |[NamedItemArrayValues](/javascript/api/excel/excel.nameditemarrayvalues)|[types](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-types-member)|Represents the types for each item in the named item array| ||[values](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-values-member)|Represents the values of each item in the named item array.| |[Range](/javascript/api/excel/excel.range)|[getAbsoluteResizedRange(numRows: number, numColumns: number)](/javascript/api/excel/excel.range#excel-excel-range-getabsoluteresizedrange-member(1))|Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns.| -||[getImage()](/javascript/api/excel/excel.range#excel-excel-range-getimage-member(1))|Renders the range as a Base64-encoded png image.| +||[getImage()](/javascript/api/excel/excel.range#excel-excel-range-getimage-member(1))|Renders the range as a Base64-encoded PNG image.| ||[getSurroundingRegion()](/javascript/api/excel/excel.range#excel-excel-range-getsurroundingregion-member(1))|Returns a `Range` object that represents the surrounding region for the top-left cell in this range.| ||[hyperlink](/javascript/api/excel/excel.range#excel-excel-range-hyperlink-member)|Represents the hyperlink for the current range.| ||[isEntireColumn](/javascript/api/excel/excel.range#excel-excel-range-isentirecolumn-member)|Represents if the current range is an entire column.| diff --git a/docs/includes/excel-preview.md b/docs/includes/excel-preview.md index 2a2933f7d0..8c5ddfce36 100644 --- a/docs/includes/excel-preview.md +++ b/docs/includes/excel-preview.md @@ -1,8 +1,11 @@ | Class | Fields | Description | |:---|:---|:---| |[Application](/javascript/api/excel/excel.application)|[formatStaleValues](/javascript/api/excel/excel.application#excel-excel-application-formatstalevalues-member)|Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.| -|[Base64EncodedImage](/javascript/api/excel/excel.base64encodedimage)|[data](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-data-member)|The base64 string encoding.| -||[type](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-type-member)|The file type of the encoded image.| +|[Base64EncodedImage](/javascript/api/excel/excel.base64encodedimage)|[data](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-data-member)|The Base64-encoded string.| +||[type](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-type-member)|The file type of the Base64-encoded image.| +|[BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue)|[errorSubType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| +|[BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| +|[CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| |[Chart](/javascript/api/excel/excel.chart)|[getDataRange()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarange-member(1))|Gets the data source of the whole chart.| ||[getDataRangeOrNullObject()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarangeornullobject-member(1))|Gets the data source of the whole chart.| |[CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)|[type](/javascript/api/excel/excel.checkboxcellcontrol#excel-excel-checkboxcellcontrol-type-member)|Represents an interactable control inside of a cell.| @@ -12,6 +15,7 @@ |[CommentReply](/javascript/api/excel/excel.commentreply)|[assignTask(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-assigntask-member(1))|Assigns the task attached to the comment to the given user as the sole assignee.| ||[getTask()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| ||[getTaskOrNullObject()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| +|[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| |[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[shortDateTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| |[DocumentTask](/javascript/api/excel/excel.documenttask)|[assign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| ||[assignees](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assignees-member)|Returns a collection of assignees of the task.| @@ -68,6 +72,7 @@ ||[basicValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| ||[language](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-language-member)|Represents the runtime language of this external code service.| ||[preview](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-preview-member)|Represents the preview value shown in the cell.| +||[provider](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-provider-member)|Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.| ||[type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| |[Identity](/javascript/api/excel/excel.identity)|[displayName](/javascript/api/excel/excel.identity#excel-excel-identity-displayname-member)|Represents the user's display name.| ||[id](/javascript/api/excel/excel.identity#excel-excel-identity-id-member)|Represents the user's unique ID.| @@ -97,9 +102,11 @@ ||[image](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-image-member)|Represents the image itself, either cached or encoded.| ||[provider](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| ||[type](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-type-member)|Represents the type of this cell value.| -|[LocalImageCellValueCacheId](/javascript/api/excel/excel.localimagecellvaluecacheid)|[cacheUid](/javascript/api/excel/excel.localimagecellvaluecacheid#excel-excel-localimagecellvaluecacheid-cacheuid-member)|Represents the image's UID as it appears in the cache.| +|[LocalImageCellValueCacheId](/javascript/api/excel/excel.localimagecellvaluecacheid)|[cachedUid](/javascript/api/excel/excel.localimagecellvaluecacheid#excel-excel-localimagecellvaluecacheid-cacheduid-member)|Represents the image's UID as it appears in the cache.| |[MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol)|[type](/javascript/api/excel/excel.mixedcellcontrol#excel-excel-mixedcellcontrol-type-member)|| +|[NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-errorsubtype-member)|Represents the type of `NameErrorCellValue`.| |[NamedSheetViewCollection](/javascript/api/excel/excel.namedsheetviewcollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitemornullobject-member(1))|Gets a sheet view using its name.| +|[NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-errorsubtype-member)|Represents the type of `NotAvailableErrorCellValue`.| |[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[getCell(dataHierarchy: DataPivotHierarchy \| string, rowItems: Array, columnItems: Array)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getcell-member(1))|Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies.| ||[pivotStyle](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-pivotstyle-member)|The style applied to the PivotTable.| ||[setStyle(style: string \| PivotTableStyle \| BuiltInPivotTableStyle)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-setstyle-member(1))|Sets the style applied to the PivotTable.| @@ -115,6 +122,7 @@ |[RangeAreas](/javascript/api/excel/excel.rangeareas)|[clearOrResetContents()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-clearorresetcontents-member(1))|Clears the values of the cells in the ranges, with special consideration given to cells containing controls.| |[RangeTextRun](/javascript/api/excel/excel.rangetextrun)|[font](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-font-member)|| ||[text](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-text-member)|| +|[RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue)|[errorSubType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| |[RefreshModeChangedEventArgs](/javascript/api/excel/excel.refreshmodechangedeventargs)|[refreshMode](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-refreshmode-member)|The linked data type refresh mode.| ||[serviceId](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-serviceid-member)|The unique ID of the object whose refresh mode was changed.| ||[source](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-source-member)|Gets the source of the event.| @@ -144,6 +152,7 @@ ||[errorType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| ||[type](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-type-member)|Represents the type of this cell value.| |[UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol)|[type](/javascript/api/excel/excel.unknowncellcontrol#excel-excel-unknowncellcontrol-type-member)|| +|[ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| |[Workbook](/javascript/api/excel/excel.workbook)|[externalCodeServiceTimeout](/javascript/api/excel/excel.workbook#excel-excel-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| ||[linkedDataTypes](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkeddatatypes-member)|Returns a collection of linked data types that are part of the workbook.| ||[localImage](/javascript/api/excel/excel.workbook#excel-excel-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index f9c890e4cd..485cd69fd8 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -135,8 +135,13 @@ Excel.Base64EncodedImage,N/A,Class,Good,false Excel.Base64EncodedImage,"data",Property,Good,false Excel.Base64EncodedImage,"type",Property,Good,false Excel.Base64EncodingType,N/A,Enum,Good,false +Excel.Base64EncodingType,"BMP",EnumField,Fine,false +Excel.Base64EncodingType,"GIF",EnumField,Fine,false +Excel.Base64EncodingType,"ICO",EnumField,Fine,false Excel.Base64EncodingType,"JPG",EnumField,Fine,false Excel.Base64EncodingType,"PNG",EnumField,Fine,false +Excel.Base64EncodingType,"TIF",EnumField,Fine,false +Excel.Base64EncodingType,"WEBP",EnumField,Fine,false Excel.BasicDataValidation,N/A,Class,Good,false Excel.BasicDataValidation,"formula1",Property,Good,false Excel.BasicDataValidation,"formula2",Property,Good,false @@ -193,11 +198,30 @@ Excel.BlockedErrorCellValueSubType,N/A,Enum,Good,false Excel.BlockedErrorCellValueSubType,"dataTypePrivacySetting",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"dataTypeRestrictedDomain",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"dataTypeUnsupportedApp",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentConnectionExceedQuota",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsComputeResourceCountDaily",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsComputeResourceEver",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsQuota",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsQuotaDaily",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsQuotaMonthly",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"environmentExceedsTakerQuotaMonthly",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"externalLinksGeneric",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"imageDownloadBlocked",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"imageExceedsSizeLimit",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"imageExceedsTotalSizeLimit",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"imageInvalidUrlNonHttps",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"noLicense",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"pythonFunction",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"pythonUnsupportedOnThisPlatform",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"richDataLinkDisabled",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"signInError",EnumField,Good,false Excel.BlockedErrorCellValueSubType,"unknown",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"unmetRequirements",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"unsupportedEnvironment",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"unsupportedInCalculationMode",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"wrongAccountType",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"xlmDisabledInTrustCenter",EnumField,Good,false +Excel.BlockedErrorCellValueSubType,"xlmNotSupportedOnPlatform",EnumField,Good,false Excel.BooleanCellValue,N/A,Class,Good,false Excel.BooleanCellValue,"basicType",Property,Good,false Excel.BooleanCellValue,"basicValue",Property,Good,false @@ -449,6 +473,7 @@ Excel.BusyErrorCellValue,"type",Property,Good,false Excel.BusyErrorCellValueSubType,N/A,Enum,Good,false Excel.BusyErrorCellValueSubType,"externalLinksGeneric",EnumField,Good,false Excel.BusyErrorCellValueSubType,"loadingImage",EnumField,Good,false +Excel.BusyErrorCellValueSubType,"placeholderInFormula",EnumField,Good,false Excel.BusyErrorCellValueSubType,"unknown",EnumField,Good,false Excel.CalcErrorCellValue,N/A,Class,Good,false Excel.CalcErrorCellValue,"basicType",Property,Good,false @@ -462,10 +487,20 @@ Excel.CalcErrorCellValueSubType,"arrayOfArrays",EnumField,Good,false Excel.CalcErrorCellValueSubType,"arrayOfRanges",EnumField,Good,false Excel.CalcErrorCellValueSubType,"dataTableReferencedPendingFormula",EnumField,Good,false Excel.CalcErrorCellValueSubType,"emptyArray",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"eRegexReplaceCharLimit",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"externalQueryRef",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"invalidPythonObject",EnumField,Good,false Excel.CalcErrorCellValueSubType,"lambdaInCell",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"pythonGridQuery",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"pythonPowerQueryDataUploadEtagChanged",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"pythonPowerQueryDataUploadSizeLimitExceeded",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"queryInCell",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"requestTooLarge",EnumField,Good,false Excel.CalcErrorCellValueSubType,"textOverflow",EnumField,Good,false Excel.CalcErrorCellValueSubType,"tooDeeplyNested",EnumField,Good,false Excel.CalcErrorCellValueSubType,"tooManyCells",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"unexpectedReturnValue",EnumField,Good,false +Excel.CalcErrorCellValueSubType,"uninitializedPythonObject",EnumField,Good,false Excel.CalcErrorCellValueSubType,"unknown",EnumField,Good,false Excel.CalcErrorCellValueSubType,"unsupportedLifting",EnumField,Good,false Excel.CalculationMode,N/A,Enum,Fine,true @@ -2132,6 +2167,12 @@ Excel.ConnectErrorCellValue,"type",Property,Good,false Excel.ConnectErrorCellValueSubType,N/A,Enum,Good,false Excel.ConnectErrorCellValueSubType,"dataTypeNoConnection",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"dataTypeServiceError",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"excelClientMisconfigurationError",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"externalCodeServiceComputeResourceNotAvailable",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"externalCodeServiceEnvironmentBadState",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"externalCodeServiceEnvironmentNotFound",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"externalCodeServiceRuntimeBadState",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"externalCodeServiceRuntimeNotFound",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"externalLinks",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"externalLinksAccessFailed",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"externalLinksFailedToRefresh",EnumField,Good,false @@ -2142,8 +2183,10 @@ Excel.ConnectErrorCellValueSubType,"externalLinksServerError",EnumField,Good,fal Excel.ConnectErrorCellValueSubType,"externalLinksThrottledByHost",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"externalLinksUnAuthenticated",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"genericServerError",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"imageUnableToRetrieve",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"missingContent",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"outdatedLinkedEntity",EnumField,Good,false +Excel.ConnectErrorCellValueSubType,"pythonPowerQueryDataUploadHasNotStarted",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"requestThrottle",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"serviceError",EnumField,Good,false Excel.ConnectErrorCellValueSubType,"unknown",EnumField,Good,false @@ -3242,6 +3285,7 @@ Excel.EventType,"linkedDataTypeRefreshModeChanged",EnumField,Fine,false Excel.EventType,"linkedDataTypeRefreshRequestCompleted",EnumField,Fine,false Excel.EventType,"linkedWorkbookRefreshCompleted",EnumField,Fine,false Excel.EventType,"linkedWorkbookWorkbookLinksChanged",EnumField,Fine,false +Excel.EventType,"queryQueryRefreshCompleted",EnumField,Fine,false Excel.EventType,"rangeValuesPreviewDismissed",EnumField,Fine,false Excel.EventType,"ribbonCommandExecuted",EnumField,Fine,false Excel.EventType,"shapeActivated",EnumField,Fine,false @@ -3280,6 +3324,7 @@ Excel.ExternalCodeServiceObjectCellValue,"basicType",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"basicValue",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"language",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"preview",Property,Good,false +Excel.ExternalCodeServiceObjectCellValue,"provider",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"Python_str",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"Python_type",Property,Good,false Excel.ExternalCodeServiceObjectCellValue,"Python_typeName",Property,Good,false @@ -4286,8 +4331,8 @@ Excel.LinkedDataTypeState,"validLinkedData",EnumField,Fine,false Excel.LinkedEntityCellValue,N/A,Class,Good,false Excel.LinkedEntityCellValue,"basicType",Property,Good,false Excel.LinkedEntityCellValue,"basicValue",Property,Good,false -Excel.LinkedEntityCellValue,"cardLayout",Property,Good,false Excel.LinkedEntityCellValue,"id",Property,Good,false +Excel.LinkedEntityCellValue,"layouts",Property,Good,false Excel.LinkedEntityCellValue,"properties",Property,Good,false Excel.LinkedEntityCellValue,"provider",Property,Good,false Excel.LinkedEntityCellValue,"text",Property,Good,false @@ -4339,7 +4384,7 @@ Excel.LocalImageCellValue,"image",Property,Good,false Excel.LocalImageCellValue,"provider",Property,Good,false Excel.LocalImageCellValue,"type",Property,Good,false Excel.LocalImageCellValueCacheId,N/A,Class,Good,false -Excel.LocalImageCellValueCacheId,"cacheUid",Property,Good,false +Excel.LocalImageCellValueCacheId,"cachedUid",Property,Good,false Excel.MixedCellControl,N/A,Class,Good,false Excel.MixedCellControl,"type",Property,Missing,false Excel.NamedItem,N/A,Class,Good,true @@ -4426,13 +4471,28 @@ Excel.NamedSheetViewCollection,"toJSON()",Method,Poor,false Excel.NameErrorCellValue,N/A,Class,Good,false Excel.NameErrorCellValue,"basicType",Property,Good,false Excel.NameErrorCellValue,"basicValue",Property,Good,false +Excel.NameErrorCellValue,"errorSubType",Property,Good,false Excel.NameErrorCellValue,"errorType",Property,Good,false Excel.NameErrorCellValue,"type",Property,Good,false +Excel.NameErrorCellValueSubType,N/A,Enum,Good,false +Excel.NameErrorCellValueSubType,"unknown",EnumField,Good,false +Excel.NameErrorCellValueSubType,"unsupportedFunction",EnumField,Good,false Excel.NotAvailableErrorCellValue,N/A,Class,Good,false Excel.NotAvailableErrorCellValue,"basicType",Property,Good,false Excel.NotAvailableErrorCellValue,"basicValue",Property,Good,false +Excel.NotAvailableErrorCellValue,"errorSubType",Property,Good,false Excel.NotAvailableErrorCellValue,"errorType",Property,Good,false Excel.NotAvailableErrorCellValue,"type",Property,Good,false +Excel.NotAvailableErrorCellValueSubType,N/A,Enum,Good,false +Excel.NotAvailableErrorCellValueSubType,"eRegexMatchNoCapture",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"eRegexMatchNoResult",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"eRegexReplaceOccurrenceNoResult",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"hlookupValueNotFound",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"pythonObjectUnknown",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"stockHistoryInvalidProperty",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"stockHistoryNoData",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"unknown",EnumField,Good,false +Excel.NotAvailableErrorCellValueSubType,"vlookupValueNotFound",EnumField,Good,false Excel.NullErrorCellValue,N/A,Class,Good,false Excel.NullErrorCellValue,"basicType",Property,Good,false Excel.NullErrorCellValue,"basicValue",Property,Good,false @@ -5281,6 +5341,7 @@ Excel.RefErrorCellValue,"errorSubType",Property,Good,false Excel.RefErrorCellValue,"errorType",Property,Good,false Excel.RefErrorCellValue,"type",Property,Good,false Excel.RefErrorCellValueSubType,N/A,Enum,Good,false +Excel.RefErrorCellValueSubType,"corruptCellRef",EnumField,Good,false Excel.RefErrorCellValueSubType,"externalLinksCalculatedRef",EnumField,Good,false Excel.RefErrorCellValueSubType,"externalLinksStructuredRef",EnumField,Good,false Excel.RefErrorCellValueSubType,"unknown",EnumField,Good,false @@ -6228,10 +6289,102 @@ Excel.ValueErrorCellValueSubType,N/A,Enum,Good,false Excel.ValueErrorCellValueSubType,"coerceStringToBoolInvalid",EnumField,Good,false Excel.ValueErrorCellValueSubType,"coerceStringToInvalidType",EnumField,Good,false Excel.ValueErrorCellValueSubType,"coerceStringToNumberInvalid",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexAlphaAssertionUnknown",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashCSyntax",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashGSyntax",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashKInLookaround",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashNInClass",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashOMissingBrace",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBackslashUCodePointTooBig",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBadRelativeReference",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexBadSubpatternReference",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexCalloutBadStringDelimiter",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexCalloutNoStringDelimiter",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexCalloutNumberTooBig",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexCalloutStringTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexClassInvalidRange",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexCodePointTooBig",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexConditionAtomicAssertionExpected",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexDefineTooManyBranches",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexDuplicateSubpatternName",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexEndBackslash",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexEndBackslashC",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexErrorGeneric",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexEscapeInvalidInClass",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexEscapeInvalidInVerb",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexInvalidAfterParensQuery",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexInvalidHexadecimal",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexInvalidHyphenInOptions",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexInvalidOctal",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexInvalidSubpatternName",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexLookbehindNotFixedLength",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexLookbehindTooComplicated",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexLookbehindTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMalformedUnicodeProperty",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMarkMissingArgument",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingCalloutClosing",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingClosingParenthesis",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingCommentClosing",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingConditionClosing",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingNameTerminator",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingOctalOrHexDigits",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexMissingSquareBracket",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexParensQueryRMissingClosing",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexParenthesesNestTooDeep",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexPatternStringTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexPatternTooComplicated",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexPatternTooLarge",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexPosixClassNotInClass",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexPosixNoSupportCollating",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexQuantifierInvalid",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexQuantifierOutOfOrder",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexQuantifierTooBig",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexQueryBarjxNestTooDeep",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexSubpatternNameExpected",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexSubpatternNamesMismatch",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexSubpatternNameTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexSubpatternNumberTooBig",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexTooManyCaptures",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexTooManyConditionBranches",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexTooManyNamedSubpatterns",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnicodeDisallowedCodePoint",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnicodePropertiesUnavailable",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnknownEscape",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnknownPosixClass",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnknownUnicodeProperty",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnmatchedClosingParenthesis",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnrecognizedAfterQueryP",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexUnsupportedEscapeSequence",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexVerbNameTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexVerbUnknown",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexVersionConditionSyntax",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"cRegexZeroRelativeReference",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"eRegexErrorGeneric",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"eRegexNoCaptureGroups",EnumField,Good,false Excel.ValueErrorCellValueSubType,"hlookupResultNotFound",EnumField,Good,false Excel.ValueErrorCellValueSubType,"hlookupRowIndexLessThanOne",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidAltText",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidHeight",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidImageFormat",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidSizing",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidSource",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaInvalidWidth",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaNotEnoughArgs",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"imageFormulaTooManyArgs",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"invalidCellValueTypeCoercion",EnumField,Good,false Excel.ValueErrorCellValueSubType,"invalidImageUrl",EnumField,Good,false Excel.ValueErrorCellValueSubType,"lambdaWrongParamCount",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexBadrepescape",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexBadreplacement",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexBadsubspattern",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexBadsubstitution",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexDepthlimit",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexErrorGeneric",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexMatchlimit",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexNosubstring",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexNouniquesubstring",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexRecurseLoop",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"mRegexRepmissingbrace",EnumField,Good,false Excel.ValueErrorCellValueSubType,"stockHistoryEndBeforeStart",EnumField,Good,false Excel.ValueErrorCellValueSubType,"stockHistoryInvalidDate",EnumField,Good,false Excel.ValueErrorCellValueSubType,"stockHistoryInvalidEnum",EnumField,Good,false @@ -6242,6 +6395,9 @@ Excel.ValueErrorCellValueSubType,"stockHistoryOnlyDateRequested",EnumField,Good, Excel.ValueErrorCellValueSubType,"stockHistoryStartInFuture",EnumField,Good,false Excel.ValueErrorCellValueSubType,"subArrayStartColumnMissingEndColumnNot",EnumField,Good,false Excel.ValueErrorCellValueSubType,"subArrayStartRowMissingEndRowNot",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"translateStringTooLong",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"translateUnsupportedSrcLanguage",EnumField,Good,false +Excel.ValueErrorCellValueSubType,"translateUnsupportedTargetLanguage",EnumField,Good,false Excel.ValueErrorCellValueSubType,"unknown",EnumField,Good,false Excel.ValueErrorCellValueSubType,"vlookupColumnIndexLessThanOne",EnumField,Good,false Excel.ValueErrorCellValueSubType,"vlookupResultNotFound",EnumField,Good,false diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts index 3abeecba65..d797f5208e 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts @@ -3837,7 +3837,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -14625,7 +14625,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -34013,7 +34013,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -39786,7 +39786,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -48043,7 +48043,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts index f8716a2253..035239aeb4 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts @@ -3959,7 +3959,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -14866,7 +14866,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -34372,7 +34372,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -40200,7 +40200,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -48570,7 +48570,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts index 5843b55f59..778104a6a3 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts @@ -4879,7 +4879,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -16268,7 +16268,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -36000,7 +36000,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -41934,7 +41934,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -50537,7 +50537,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts index 58e6c65490..7e027b8544 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts @@ -5038,7 +5038,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -16524,7 +16524,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -36328,7 +36328,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -42309,7 +42309,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -50971,7 +50971,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts index 7f27dc7dce..865ef70522 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts @@ -5345,7 +5345,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -17020,7 +17020,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -36949,7 +36949,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -43022,7 +43022,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -51884,7 +51884,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts index cce26f4e18..a3cc7329e8 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts @@ -5377,7 +5377,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -17105,7 +17105,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -37073,7 +37073,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -43146,7 +43146,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -52016,7 +52016,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts index 75990b67c7..5c18740128 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts @@ -5200,7 +5200,7 @@ export declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -5490,7 +5490,7 @@ export declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -5522,7 +5522,7 @@ export declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -5659,13 +5659,12 @@ export declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -11716,7 +11715,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -23557,7 +23556,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -43589,7 +43588,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -49758,7 +49757,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -58788,7 +58787,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts index 7b629e74ff..54dea2f11d 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts @@ -5200,7 +5200,7 @@ export declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -5490,7 +5490,7 @@ export declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -5522,7 +5522,7 @@ export declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -5659,13 +5659,12 @@ export declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -11889,7 +11888,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -23736,7 +23735,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -43840,7 +43839,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -50015,7 +50014,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -59051,7 +59050,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts index b6c09348c9..52d02dcd0b 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts @@ -2202,7 +2202,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -8433,7 +8433,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -19970,7 +19970,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -23615,7 +23615,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -28557,7 +28557,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts index c37ac88662..23452605f5 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts @@ -2458,7 +2458,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -11124,7 +11124,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -23654,7 +23654,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -28095,7 +28095,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -34408,7 +34408,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts index 891b49889e..761df3da1a 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts @@ -3573,7 +3573,7 @@ export declare namespace Excel { /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -14285,7 +14285,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -32169,7 +32169,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -37756,7 +37756,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -45761,7 +45761,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts index 00e70d6edc..297b4dbf58 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts @@ -5200,7 +5200,7 @@ export declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -5490,7 +5490,7 @@ export declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -5522,7 +5522,7 @@ export declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -5659,13 +5659,12 @@ export declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -12372,7 +12371,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -24239,7 +24238,7 @@ export declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -44537,7 +44536,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -50780,7 +50779,7 @@ export declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -59968,7 +59967,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index f5eee67823..9ea3b44b2d 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -93,7 +93,7 @@ export declare namespace Excel { referencedValues?: ReferencedValue[]; } /** - * The base64 encoding type and data of an image. + * The Base64-encoded type and data of an image. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -101,15 +101,15 @@ export declare namespace Excel { */ export interface Base64EncodedImage { /** - * The file type of the encoded image. + * The file type of the Base64-encoded image. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - type: Base64EncodingType | "JPG" | "PNG"; + type: Base64EncodingType | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP"; /** - * The base64 string encoding. + * The Base64-encoded string. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -118,7 +118,7 @@ export declare namespace Excel { data: string; } /** - * The file type represented by the base64 encoding. + * The file type represented by the Base64 encoding. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -126,7 +126,31 @@ export declare namespace Excel { */ enum Base64EncodingType { /** - * The JPG file type. + * The BMP file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + BMP = "BMP", + /** + * The GIF file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + GIF = "GIF", + /** + * The ICO file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + ICO = "ICO", + /** + * The JPG (or JPEG) file type. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -140,7 +164,23 @@ export declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - PNG = "PNG" + PNG = "PNG", + /** + * The TIFF file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + TIF = "TIF", + /** + * The WEBP file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + WEBP = "WEBP" } /** * Represents a card layout that is best used for an array. @@ -261,7 +301,159 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - noLicense = "NoLicense" + noLicense = "NoLicense", + /** + * An error caused by Excel 4.0 macros being disabled in Trust Center. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + xlmDisabledInTrustCenter = "XlmDisabledInTrustCenter", + /** + * An error caused by Excel 4.0 macros not being supported on the platform. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + xlmNotSupportedOnPlatform = "XlmNotSupportedOnPlatform", + /** + * An error caused by the image download coming from an untrusted URL. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageDownloadBlocked = "ImageDownloadBlocked", + /** + * An error caused by the image URL not being HTTPS. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageInvalidUrlNonHttps = "ImageInvalidUrlNonHttps", + /** + * An error caused by the image exceeding the size limit set in ExcelServerSettings.CacheBackedAsyncImageDownloaderMaxFileSizeInKBytes. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageExceedsSizeLimit = "ImageExceedsSizeLimit", + /** + * An error caused by the image exceeding the size limit for an entire workbook set in `ExcelWorkbookSizeMax`. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageExceedsTotalSizeLimit = "ImageExceedsTotalSizeLimit", + /** + * An error caused by the user exceeding their quota of concurrently active external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuota = "EnvironmentExceedsQuota", + /** + * An error caused by the user exceeding their daily quota of external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuotaDaily = "EnvironmentExceedsQuotaDaily", + /** + * An error caused by the user exceeding their monthly quota of external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuotaMonthly = "EnvironmentExceedsQuotaMonthly", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsTakerQuotaMonthly = "EnvironmentExceedsTakerQuotaMonthly", + /** + * An error caused by using an unsupported identity provider. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + wrongAccountType = "WrongAccountType", + /** + * An error caused by an external code service execution environment exceeding its lifetime resource use. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsComputeResourceEver = "EnvironmentExceedsComputeResourceEver", + /** + * An error caused by a user exceeding their daily quota of compute. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsComputeResourceCountDaily = "EnvironmentExceedsComputeResourceCountDaily", + /** + * An error caused by Python not being supported in Excel on a platform. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonUnsupportedOnThisPlatform = "PythonUnsupportedOnThisPlatform", + /** + * An error caused by Excel not meeting the requirements to use a feature. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unmetRequirements = "UnmetRequirements", + /** + * An error caused by the PY function being disabled. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonFunction = "PythonFunction", + /** + * An error caused by the user exceeding their quota of concurrent connections to external code service environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentConnectionExceedQuota = "EnvironmentConnectionExceedQuota", + /** + * An error caused by an environment definition not being supported by an external code service. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedEnvironment = "UnsupportedEnvironment", + /** + * An error caused by function being unavailable in Partial or Manual calculation modes. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedInCalculationMode = "UnsupportedInCalculationMode" } /** * Represents the value of a cell containing a #BLOCKED! error. @@ -306,7 +498,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense"; + 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"; } /** * Represents the value of a cell containing a boolean. @@ -364,7 +556,15 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - loadingImage = "LoadingImage" + loadingImage = "LoadingImage", + /** + * An error caused by a function being unable to process a placeholder value. Displays as error type #BUSY! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderInFormula = "PlaceholderInFormula" } /** * Represents the value of a cell containing a #BUSY! error. @@ -409,7 +609,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage"; + errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage" | "PlaceholderInFormula"; } /** * Represents types of #CALC! errors. @@ -488,7 +688,87 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - textOverflow = "TextOverflow" + textOverflow = "TextOverflow", + /** + * An error caused by a formula generating too large a request for an external code service. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + requestTooLarge = "RequestTooLarge", + /** + * An error caused by a Power Query query referencing data in a sheet. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonGridQuery = "PythonGridQuery", + /** + * An error caused by a Power Query query ID change. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadEtagChanged = "PythonPowerQueryDataUploadEtagChanged", + /** + * An error caused by Power Query exceeding the limit for data uploaded to an external code service. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadSizeLimitExceeded = "PythonPowerQueryDataUploadSizeLimitExceeded", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + invalidPythonObject = "InvalidPythonObject", + /** + * An error caused by a formula returning a reference to a Power Query query. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + queryInCell = "QueryInCell", + /** + * An error caused by an uninitialized Python Object. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + uninitializedPythonObject = "UninitializedPythonObject", + /** + * An error caused by a reference to a Power Query query in a different workbook. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalQueryRef = "ExternalQueryRef", + /** + * An error caused by text that is longer than 65,535 characters. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexReplaceCharLimit = "ERegexReplaceCharLimit", + /** + * An error caused by an external code service returning an unexpected result. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unexpectedReturnValue = "UnexpectedReturnValue" } /** * Represents the value of a cell containing a #CALC! error. @@ -533,7 +813,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow"; + errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow" | "RequestTooLarge" | "PythonGridQuery" | "PythonPowerQueryDataUploadEtagChanged" | "PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject" | "QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" | "ERegexReplaceCharLimit" | "UnexpectedReturnValue"; /** * Represents the name of the function causing the error. * @@ -5173,7 +5453,71 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - genericServerError = "GenericServerError" + genericServerError = "GenericServerError", + /** + * An error caused by an image download receiving an HTTP response code between 300 and 499. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageUnableToRetrieve = "ImageUnableToRetrieve", + /** + * An error caused by not being able to find an external code service execution environment. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceEnvironmentNotFound = "ExternalCodeServiceEnvironmentNotFound", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceRuntimeNotFound = "ExternalCodeServiceRuntimeNotFound", + /** + * An error caused by an external code service execution environment being in an inoperative state. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceEnvironmentBadState = "ExternalCodeServiceEnvironmentBadState", + /** + * An error caused by an external code service runtime being in an inoperative state. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceRuntimeBadState = "ExternalCodeServiceRuntimeBadState", + /** + * An error caused by an external code service compute resource not being available. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceComputeResourceNotAvailable = "ExternalCodeServiceComputeResourceNotAvailable", + /** + * An error caused by Power Query not having started upload of data to an external code service. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadHasNotStarted = "PythonPowerQueryDataUploadHasNotStarted", + /** + * An error caused by Excel being incorrectly configured for connection to an external code service. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + excelClientMisconfigurationError = "ExcelClientMisconfigurationError" } /** * Represents the value of a cell containing a #CONNECT! error. @@ -5218,7 +5562,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError"; + 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"; } /** * Represents the value of a cell containing a #DIV/0! error. @@ -5431,7 +5775,7 @@ export declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -5720,6 +6064,15 @@ export declare namespace Excel { * @beta */ Python_str: string; + /** + * Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`. + * This field is not writable. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + provider?: CellValueProviderAttributes; } /** * Represents types of #FIELD! errors. @@ -5810,7 +6163,7 @@ export declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -5842,7 +6195,7 @@ export declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -5979,13 +6332,12 @@ export declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -6078,7 +6430,88 @@ export declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - cacheUid: string; + cachedUid: string; + } + /** + * Represents types of #N/A! errors. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NotAvailableErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unknown = "Unknown", + /** + * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + vlookupValueNotFound = "VlookupValueNotFound", + /** + * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + hlookupValueNotFound = "HlookupValueNotFound", + /** + * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + stockHistoryInvalidProperty = "StockHistoryInvalidProperty", + /** + * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + stockHistoryNoData = "StockHistoryNoData", + /** + * An error caused by an external code service returning an unknown object. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonObjectUnknown = "PythonObjectUnknown", + /** + * No match was found for the pattern in the text provided. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexMatchNoResult = "ERegexMatchNoResult", + /** + * Occurrence is greater than the total number of matches. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexReplaceOccurrenceNoResult = "ERegexReplaceOccurrenceNoResult", + /** + * No capture groups were matched. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexMatchNoCapture = "ERegexMatchNoCapture" } /** * Represents the value of a cell containing a #N/A! error. @@ -6117,6 +6550,39 @@ export declare namespace Excel { * [Api set: ExcelApi 1.16] */ errorType?: ErrorCellValueType.notAvailable | "NotAvailable"; + /** + * Represents the type of `NotAvailableErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + errorSubType?: NotAvailableErrorCellValueSubType | "Unknown" | "VlookupValueNotFound" | "HlookupValueNotFound" | "StockHistoryInvalidProperty" | "StockHistoryNoData" | "PythonObjectUnknown" | "ERegexMatchNoResult" | "ERegexReplaceOccurrenceNoResult" | "ERegexMatchNoCapture"; + } + /** + * Represents types of #NAME? errors. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NameErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #NAME? in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unknown = "Unknown", + /** + * An error caused by a formula containing an unsupported function. Displays as error type #NAME? in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedFunction = "UnsupportedFunction" } /** * Represents the value of a cell containing a #NAME? error. @@ -6155,6 +6621,14 @@ export declare namespace Excel { * [Api set: ExcelApi 1.16] */ errorType?: ErrorCellValueType.name | "Name"; + /** + * Represents the type of `NameErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + errorSubType?: NameErrorCellValueSubType | "Unknown" | "UnsupportedFunction"; } /** * Represents the value of a cell containing a #NULL! error. @@ -6295,7 +6769,15 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - externalLinksCalculatedRef = "ExternalLinksCalculatedRef" + externalLinksCalculatedRef = "ExternalLinksCalculatedRef", + /** + * An error caused by a corrupt formula. Displays as error type #REF! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + corruptCellRef = "CorruptCellRef" } /** * Represents the value of a cell containing a #REF! error. @@ -6340,7 +6822,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef"; + errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef" | "CorruptCellRef"; } /** * Represents types of #SPILL! errors. @@ -6709,7 +7191,777 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - lambdaWrongParamCount = "LambdaWrongParamCount" + lambdaWrongParamCount = "LambdaWrongParamCount", + /** + * An error caused by passing too many arguments to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaTooManyArgs = "ImageFormulaTooManyArgs", + /** + * An error caused by an unsupported image formula. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidImageFormat = "ImageFormulaInvalidImageFormat", + /** + * An error caused by a non-string `source` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidSource = "ImageFormulaInvalidSource", + /** + * An error caused by a non-string `alt_text` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidAltText = "ImageFormulaInvalidAltText", + /** + * An error caused by invalid size parameters to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidSizing = "ImageFormulaInvalidSizing", + /** + * An error caused by too few arguments passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaNotEnoughArgs = "ImageFormulaNotEnoughArgs", + /** + * An error caused by a non-numerical or invalid `height` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidHeight = "ImageFormulaInvalidHeight", + /** + * An error caused by a non-numerical or invalid `width` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidWidth = "ImageFormulaInvalidWidth", + /** + * An error caused by an argument with the wrong data type passed to a custom function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + invalidCellValueTypeCoercion = "InvalidCellValueTypeCoercion", + /** + * An error in the regex `pattern`. An unknown compile error has occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexErrorGeneric = "CRegexErrorGeneric", + /** + * An error in the regex `pattern`. \ at end of pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEndBackslash = "CRegexEndBackslash", + /** + * An error in the regex `pattern`. \c at end of pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEndBackslashC = "CRegexEndBackslashC", + /** + * An error in the regex `pattern`. Unrecognized character follows \. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownEscape = "CRegexUnknownEscape", + /** + * An error in the regex `pattern`. Number out of order in {} quantifier. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierOutOfOrder = "CRegexQuantifierOutOfOrder", + /** + * An error in the regex `pattern`. Number too big in quantifier {}. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierTooBig = "CRegexQuantifierTooBig", + /** + * An error in the regex `pattern`. Missing terminating ] for character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingSquareBracket = "CRegexMissingSquareBracket", + /** + * An error in the regex `pattern`. Escape sequence is invalid in character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEscapeInvalidInClass = "CRegexEscapeInvalidInClass", + /** + * An error in the regex `pattern`. Quantifier does not follow a repeatable item. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierInvalid = "CRegexQuantifierInvalid", + /** + * An error in the regex `pattern`. Unrecognized character after (? or (?-. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidAfterParensQuery = "CRegexInvalidAfterParensQuery", + /** + * An error in the regex `pattern`. POSIX named classes are supported only within a class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPosixClassNotInClass = "CRegexPosixClassNotInClass", + /** + * An error in the regex `pattern`. POSIX collating elements are not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPosixNoSupportCollating = "CRegexPosixNoSupportCollating", + /** + * An error in the regex `pattern`. Missing closing parenthesis. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingClosingParenthesis = "CRegexMissingClosingParenthesis", + /** + * An error in the regex `pattern`. Reference to nonexistent subpattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBadSubpatternReference = "CRegexBadSubpatternReference", + /** + * An error in the regex `pattern`. Missing ) after (?# comment. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingCommentClosing = "CRegexMissingCommentClosing", + /** + * An error in the regex `pattern`. Parentheses are too deeply nested. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexParenthesesNestTooDeep = "CRegexParenthesesNestTooDeep", + /** + * An error in the regex `pattern`. Regular expression is too large. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternTooLarge = "CRegexPatternTooLarge", + /** + * An error in the regex `pattern`. Unmatched closing parenthesis. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnmatchedClosingParenthesis = "CRegexUnmatchedClosingParenthesis", + /** + * An error in the regex `pattern`. Missing closing parenthesis for condition. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingConditionClosing = "CRegexMissingConditionClosing", + /** + * An error in the regex `pattern`. Length of `lookbehind` assertion is not limited. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindNotFixedLength = "CRegexLookbehindNotFixedLength", + /** + * An error in the regex `pattern`. A relative value of zero is not allowed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexZeroRelativeReference = "CRegexZeroRelativeReference", + /** + * An error in the regex `pattern`. Conditional subpattern contains more than two branches. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyConditionBranches = "CRegexTooManyConditionBranches", + /** + * An error in the regex `pattern`. Digit expected after (?+ or (?-. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBadRelativeReference = "CRegexBadRelativeReference", + /** + * An error in the regex `pattern`. Unknown POSIX class name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownPosixClass = "CRegexUnknownPosixClass", + /** + * An error in the regex `pattern`. Character code point value in \x{} or \o{} is too large. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCodePointTooBig = "CRegexCodePointTooBig", + /** + * An error in the regex `pattern`. `lookbehind` is too complicated. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindTooComplicated = "CRegexLookbehindTooComplicated", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnsupportedEscapeSequence = "CRegexUnsupportedEscapeSequence", + /** + * An error in the regex `pattern`. Number after (?C is greater than 255. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutNumberTooBig = "CRegexCalloutNumberTooBig", + /** + * An error in the regex `pattern`. Closing parenthesis for (?C expected. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingCalloutClosing = "CRegexMissingCalloutClosing", + /** + * An error in the regex `pattern`. Invalid escape sequence in (*VERB) name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEscapeInvalidInVerb = "CRegexEscapeInvalidInVerb", + /** + * An error in the regex `pattern`. Unrecongnized character after (?P. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnrecognizedAfterQueryP = "CRegexUnrecognizedAfterQueryP", + /** + * An error in the regex `pattern`. Syntax error in subpattern name (missing terminator?). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingNameTerminator = "CRegexMissingNameTerminator", + /** + * An error in the regex `pattern`. Two named subpatterns have the same name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexDuplicateSubpatternName = "CRegexDuplicateSubpatternName", + /** + * An error in the regex `pattern`. Subpattern name must start with a non-digit. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidSubpatternName = "CRegexInvalidSubpatternName", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnicodePropertiesUnavailable = "CRegexUnicodePropertiesUnavailable", + /** + * An error in the regex `pattern`. Malformed \P or \p sequence. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMalformedUnicodeProperty = "CRegexMalformedUnicodeProperty", + /** + * An error in the regex `pattern`. Unknown property after \P or \p. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownUnicodeProperty = "CRegexUnknownUnicodeProperty", + /** + * An error in the regex `pattern`. Subpattern name is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNameTooLong = "CRegexSubpatternNameTooLong", + /** + * An error in the regex `pattern`. Too many named subpatterns. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyNamedSubpatterns = "CRegexTooManyNamedSubpatterns", + /** + * An error in the regex `pattern`. Invalid range in character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexClassInvalidRange = "CRegexClassInvalidRange", + /** + * An error in the regex `pattern`. `DEFINE` subpattern contains more than one branch. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexDefineTooManyBranches = "CRegexDefineTooManyBranches", + /** + * An error in the regex `pattern`. Missing opening brace after \o. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashOMissingBrace = "CRegexBackslashOMissingBrace", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashGSyntax = "CRegexBackslashGSyntax", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexParensQueryRMissingClosing = "CRegexParensQueryRMissingClosing", + /** + * An error in the regex `pattern`. The (*VERB) is not recognized or is malformed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVerbUnknown = "CRegexVerbUnknown", + /** + * An error in the regex `pattern`. The subpattern number exceeds the limit of 65,535. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNumberTooBig = "CRegexSubpatternNumberTooBig", + /** + * An error in the regex `pattern`. Subpattern name expected. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNameExpected = "CRegexSubpatternNameExpected", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidOctal = "CRegexInvalidOctal", + /** + * An error in the regex `pattern`. Different names for subpatterns of the same number are not allowed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNamesMismatch = "CRegexSubpatternNamesMismatch", + /** + * An error in the regex `pattern`. The (*MARK) must have an argument. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMarkMissingArgument = "CRegexMarkMissingArgument", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidHexadecimal = "CRegexInvalidHexadecimal", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashCSyntax = "CRegexBackslashCSyntax", + /** + * An error in the regex `pattern`. \N is not supported in class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashNInClass = "CRegexBackslashNInClass", + /** + * An error in the regex `pattern`. The callout string is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutStringTooLong = "CRegexCalloutStringTooLong", + /** + * An error in the regex `pattern`. Disallowed Unicode point (>= 0xD800 && <= 0xDFFF). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnicodeDisallowedCodePoint = "CRegexUnicodeDisallowedCodePoint", + /** + * An error in the regex `pattern`. A name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVerbNameTooLong = "CRegexVerbNameTooLong", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashUCodePointTooBig = "CRegexBackslashUCodePointTooBig", + /** + * An error in the regex `pattern`. Digits are missing in \x{}, \o{}, or \N{U+}. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingOctalOrHexDigits = "CRegexMissingOctalOrHexDigits", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVersionConditionSyntax = "CRegexVersionConditionSyntax", + /** + * An error in the regex `pattern`. Missing terminating delimiter for callout with string argument. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutNoStringDelimiter = "CRegexCalloutNoStringDelimiter", + /** + * An error in the regex `pattern`. Unrecognized string delimiter follows (?C. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutBadStringDelimiter = "CRegexCalloutBadStringDelimiter", + /** + * An error in the regex `pattern`. The (?|, (?J:, or (?x: parentheses are too deeply nested. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQueryBarjxNestTooDeep = "CRegexQueryBarjxNestTooDeep", + /** + * An error in the regex `pattern`. Regular expression is too complicated. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternTooComplicated = "CRegexPatternTooComplicated", + /** + * An error in the regex `pattern`. `lookbehind` assertion is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindTooLong = "CRegexLookbehindTooLong", + /** + * An error in the regex `pattern`. Pattern string is longer than the limit set by the application. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternStringTooLong = "CRegexPatternStringTooLong", + /** + * An error in the regex `pattern`. Invalid hyphen in option setting. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidHyphenInOptions = "CRegexInvalidHyphenInOptions", + /** + * An error in the regex `pattern`. The (*alpha_assertion) isn't recognized. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexAlphaAssertionUnknown = "CRegexAlphaAssertionUnknown", + /** + * An error in the regex `pattern`. Too many capturing groups (maximum 65535). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyCaptures = "CRegexTooManyCaptures", + /** + * An error in the regex `pattern`. Atomic assertion expected after (?( or (?(?C). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexConditionAtomicAssertionExpected = "CRegexConditionAtomicAssertionExpected", + /** + * An error in the regex `pattern`. \K is not allowed in `lookarounds=`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashKInLookaround = "CRegexBackslashKInLookaround", + /** + * An error in regex match. An unknown match error has occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexErrorGeneric = "MRegexErrorGeneric", + /** + * An error in regex match. Invalid replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadreplacement = "MRegexBadreplacement", + /** + * An error in regex match. Match limit exceeded. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexMatchlimit = "MRegexMatchlimit", + /** + * An error in regex match. Unknown substring. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexNosubstring = "MRegexNosubstring", + /** + * An error in regex match. Nonunique substring name. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexNouniquesubstring = "MRegexNouniquesubstring", + /** + * An error in regex match. Matching depth limit exceeded. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexDepthlimit = "MRegexDepthlimit", + /** + * An error in regex match. There's an incorrect escape sequence in the replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadrepescape = "MRegexBadrepescape", + /** + * An error in regex match. Expected closing curly bracket in replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexRepmissingbrace = "MRegexRepmissingbrace", + /** + * An error in regex match. There's an incorrect substitution in the replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadsubstitution = "MRegexBadsubstitution", + /** + * An error in regex match. Match with end before start or start moved backwards is not supported. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadsubspattern = "MRegexBadsubspattern", + /** + * An error in regex match. Recursive loop. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexRecurseLoop = "MRegexRecurseLoop", + /** + * An unknown regex error occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexErrorGeneric = "ERegexErrorGeneric", + /** + * No capture groups were found in the regex pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexNoCaptureGroups = "ERegexNoCaptureGroups", + /** + * An error caused by the `text` parameter to `TRANSLATE` being too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateStringTooLong = "TranslateStringTooLong", + /** + * An error caused because the `source_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateUnsupportedSrcLanguage = "TranslateUnsupportedSrcLanguage", + /** + * An error caused because the `target_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateUnsupportedTargetLanguage = "TranslateUnsupportedTargetLanguage" } /** * Represents the value of a cell containing a #VALUE! error. @@ -6754,7 +8006,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount"; + 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"; } /** * Represents the value of a cell containing a type of value which cannot be serialized. @@ -14918,7 +16170,7 @@ export declare namespace Excel { */ getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -26955,7 +28207,7 @@ export declare namespace Excel { */ category: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -37804,6 +39056,13 @@ export declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] */ annotationAdded = "AnnotationAdded", + /** + * TableQueryRefreshCompleted represents the type of event registered when a table query refresh is completed. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + queryQueryRefreshCompleted = "QueryQueryRefreshCompleted" } /** * @remarks @@ -47876,7 +49135,7 @@ export declare namespace Excel { */ category?: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -54400,7 +55659,7 @@ export declare namespace Excel { */ category?: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -64179,7 +65438,7 @@ export declare namespace Excel { */ category?: boolean; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index cd8a74c655..2471de7c43 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -26850,7 +26850,7 @@ declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -27140,7 +27140,7 @@ declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -27172,7 +27172,7 @@ declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -27309,13 +27309,12 @@ declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -34000,7 +33999,7 @@ declare namespace Excel { */ getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -45867,7 +45866,7 @@ declare namespace Excel { */ category: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -66165,7 +66164,7 @@ declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -72408,7 +72407,7 @@ declare namespace Excel { */ category?: string; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -81596,7 +81595,7 @@ declare namespace Excel { */ category?: boolean; /** - * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 40eeead49e..4bc2cfb619 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -22129,7 +22129,7 @@ declare namespace Excel { referencedValues?: ReferencedValue[]; } /** - * The base64 encoding type and data of an image. + * The Base64-encoded type and data of an image. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -22137,15 +22137,15 @@ declare namespace Excel { */ interface Base64EncodedImage { /** - * The file type of the encoded image. + * The file type of the Base64-encoded image. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - type: Base64EncodingType | "JPG" | "PNG"; + type: Base64EncodingType | "BMP" | "GIF" | "ICO" | "JPG" | "PNG" | "TIF" | "WEBP"; /** - * The base64 string encoding. + * The Base64-encoded string. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -22154,7 +22154,7 @@ declare namespace Excel { data: string; } /** - * The file type represented by the base64 encoding. + * The file type represented by the Base64 encoding. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -22162,7 +22162,31 @@ declare namespace Excel { */ enum Base64EncodingType { /** - * The JPG file type. + * The BMP file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + BMP = "BMP", + /** + * The GIF file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + GIF = "GIF", + /** + * The ICO file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + ICO = "ICO", + /** + * The JPG (or JPEG) file type. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -22176,7 +22200,23 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - PNG = "PNG" + PNG = "PNG", + /** + * The TIFF file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + TIF = "TIF", + /** + * The WEBP file type. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + WEBP = "WEBP" } /** * Represents a card layout that is best used for an array. @@ -22297,7 +22337,159 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - noLicense = "NoLicense" + noLicense = "NoLicense", + /** + * An error caused by Excel 4.0 macros being disabled in Trust Center. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + xlmDisabledInTrustCenter = "XlmDisabledInTrustCenter", + /** + * An error caused by Excel 4.0 macros not being supported on the platform. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + xlmNotSupportedOnPlatform = "XlmNotSupportedOnPlatform", + /** + * An error caused by the image download coming from an untrusted URL. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageDownloadBlocked = "ImageDownloadBlocked", + /** + * An error caused by the image URL not being HTTPS. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageInvalidUrlNonHttps = "ImageInvalidUrlNonHttps", + /** + * An error caused by the image exceeding the size limit set in ExcelServerSettings.CacheBackedAsyncImageDownloaderMaxFileSizeInKBytes. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageExceedsSizeLimit = "ImageExceedsSizeLimit", + /** + * An error caused by the image exceeding the size limit for an entire workbook set in `ExcelWorkbookSizeMax`. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageExceedsTotalSizeLimit = "ImageExceedsTotalSizeLimit", + /** + * An error caused by the user exceeding their quota of concurrently active external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuota = "EnvironmentExceedsQuota", + /** + * An error caused by the user exceeding their daily quota of external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuotaDaily = "EnvironmentExceedsQuotaDaily", + /** + * An error caused by the user exceeding their monthly quota of external code service execution environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsQuotaMonthly = "EnvironmentExceedsQuotaMonthly", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsTakerQuotaMonthly = "EnvironmentExceedsTakerQuotaMonthly", + /** + * An error caused by using an unsupported identity provider. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + wrongAccountType = "WrongAccountType", + /** + * An error caused by an external code service execution environment exceeding its lifetime resource use. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsComputeResourceEver = "EnvironmentExceedsComputeResourceEver", + /** + * An error caused by a user exceeding their daily quota of compute. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentExceedsComputeResourceCountDaily = "EnvironmentExceedsComputeResourceCountDaily", + /** + * An error caused by Python not being supported in Excel on a platform. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonUnsupportedOnThisPlatform = "PythonUnsupportedOnThisPlatform", + /** + * An error caused by Excel not meeting the requirements to use a feature. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unmetRequirements = "UnmetRequirements", + /** + * An error caused by the PY function being disabled. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonFunction = "PythonFunction", + /** + * An error caused by the user exceeding their quota of concurrent connections to external code service environments. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + environmentConnectionExceedQuota = "EnvironmentConnectionExceedQuota", + /** + * An error caused by an environment definition not being supported by an external code service. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedEnvironment = "UnsupportedEnvironment", + /** + * An error caused by function being unavailable in Partial or Manual calculation modes. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedInCalculationMode = "UnsupportedInCalculationMode" } /** * Represents the value of a cell containing a #BLOCKED! error. @@ -22342,7 +22534,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense"; + 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"; } /** * Represents the value of a cell containing a boolean. @@ -22400,7 +22592,15 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - loadingImage = "LoadingImage" + loadingImage = "LoadingImage", + /** + * An error caused by a function being unable to process a placeholder value. Displays as error type #BUSY! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderInFormula = "PlaceholderInFormula" } /** * Represents the value of a cell containing a #BUSY! error. @@ -22445,7 +22645,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage"; + errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage" | "PlaceholderInFormula"; } /** * Represents types of #CALC! errors. @@ -22524,7 +22724,87 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - textOverflow = "TextOverflow" + textOverflow = "TextOverflow", + /** + * An error caused by a formula generating too large a request for an external code service. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + requestTooLarge = "RequestTooLarge", + /** + * An error caused by a Power Query query referencing data in a sheet. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonGridQuery = "PythonGridQuery", + /** + * An error caused by a Power Query query ID change. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadEtagChanged = "PythonPowerQueryDataUploadEtagChanged", + /** + * An error caused by Power Query exceeding the limit for data uploaded to an external code service. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadSizeLimitExceeded = "PythonPowerQueryDataUploadSizeLimitExceeded", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + invalidPythonObject = "InvalidPythonObject", + /** + * An error caused by a formula returning a reference to a Power Query query. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + queryInCell = "QueryInCell", + /** + * An error caused by an uninitialized Python Object. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + uninitializedPythonObject = "UninitializedPythonObject", + /** + * An error caused by a reference to a Power Query query in a different workbook. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalQueryRef = "ExternalQueryRef", + /** + * An error caused by text that is longer than 65,535 characters. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexReplaceCharLimit = "ERegexReplaceCharLimit", + /** + * An error caused by an external code service returning an unexpected result. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unexpectedReturnValue = "UnexpectedReturnValue" } /** * Represents the value of a cell containing a #CALC! error. @@ -22569,7 +22849,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow"; + errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow" | "RequestTooLarge" | "PythonGridQuery" | "PythonPowerQueryDataUploadEtagChanged" | "PythonPowerQueryDataUploadSizeLimitExceeded" | "InvalidPythonObject" | "QueryInCell" | "UninitializedPythonObject" | "ExternalQueryRef" | "ERegexReplaceCharLimit" | "UnexpectedReturnValue"; /** * Represents the name of the function causing the error. * @@ -27209,7 +27489,71 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - genericServerError = "GenericServerError" + genericServerError = "GenericServerError", + /** + * An error caused by an image download receiving an HTTP response code between 300 and 499. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageUnableToRetrieve = "ImageUnableToRetrieve", + /** + * An error caused by not being able to find an external code service execution environment. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceEnvironmentNotFound = "ExternalCodeServiceEnvironmentNotFound", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceRuntimeNotFound = "ExternalCodeServiceRuntimeNotFound", + /** + * An error caused by an external code service execution environment being in an inoperative state. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceEnvironmentBadState = "ExternalCodeServiceEnvironmentBadState", + /** + * An error caused by an external code service runtime being in an inoperative state. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceRuntimeBadState = "ExternalCodeServiceRuntimeBadState", + /** + * An error caused by an external code service compute resource not being available. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + externalCodeServiceComputeResourceNotAvailable = "ExternalCodeServiceComputeResourceNotAvailable", + /** + * An error caused by Power Query not having started upload of data to an external code service. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonPowerQueryDataUploadHasNotStarted = "PythonPowerQueryDataUploadHasNotStarted", + /** + * An error caused by Excel being incorrectly configured for connection to an external code service. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + excelClientMisconfigurationError = "ExcelClientMisconfigurationError" } /** * Represents the value of a cell containing a #CONNECT! error. @@ -27254,7 +27598,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError"; + 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"; } /** * Represents the value of a cell containing a #DIV/0! error. @@ -27467,7 +27811,7 @@ declare namespace Excel { compact?: CompactLayout; } /** - * Represents a card layout that is best used for an array. + * Represents a card layout that is best used for an entity. * * @remarks * [Api set: ExcelApi 1.16] @@ -27756,6 +28100,15 @@ declare namespace Excel { * @beta */ Python_str: string; + /** + * Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`. + * This field is not writable. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + provider?: CellValueProviderAttributes; } /** * Represents types of #FIELD! errors. @@ -27846,7 +28199,7 @@ declare namespace Excel { fieldName?: string; } /** - * 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/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * 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}. * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. * * @remarks @@ -27878,7 +28231,7 @@ declare namespace Excel { * Returns the number format string that is used to display this value. * 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. * Number format strings must conform to Excel guidelines. - * To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. * * @remarks * [Api set: ExcelApi 1.16] @@ -28015,13 +28368,12 @@ declare namespace Excel { }; }; /** - * Represents the layout of this linked entity in card view. - * If the `CardLayout` object doesn't have a layout property, it default value is "Entity". + * Represents layout information for views of this linked entity. * * @remarks * [Api set: ExcelApi 1.16] */ - cardLayout?: CardLayout; + layouts?: EntityViewLayouts; /** * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. * This information can be used for branding in entity cards. @@ -28114,7 +28466,88 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta */ - cacheUid: string; + cachedUid: string; + } + /** + * Represents types of #N/A! errors. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NotAvailableErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unknown = "Unknown", + /** + * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + vlookupValueNotFound = "VlookupValueNotFound", + /** + * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + hlookupValueNotFound = "HlookupValueNotFound", + /** + * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + stockHistoryInvalidProperty = "StockHistoryInvalidProperty", + /** + * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + stockHistoryNoData = "StockHistoryNoData", + /** + * An error caused by an external code service returning an unknown object. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + pythonObjectUnknown = "PythonObjectUnknown", + /** + * No match was found for the pattern in the text provided. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexMatchNoResult = "ERegexMatchNoResult", + /** + * Occurrence is greater than the total number of matches. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexReplaceOccurrenceNoResult = "ERegexReplaceOccurrenceNoResult", + /** + * No capture groups were matched. Displays as error type #N/A! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexMatchNoCapture = "ERegexMatchNoCapture" } /** * Represents the value of a cell containing a #N/A! error. @@ -28153,6 +28586,39 @@ declare namespace Excel { * [Api set: ExcelApi 1.16] */ errorType?: ErrorCellValueType.notAvailable | "NotAvailable"; + /** + * Represents the type of `NotAvailableErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + errorSubType?: NotAvailableErrorCellValueSubType | "Unknown" | "VlookupValueNotFound" | "HlookupValueNotFound" | "StockHistoryInvalidProperty" | "StockHistoryNoData" | "PythonObjectUnknown" | "ERegexMatchNoResult" | "ERegexReplaceOccurrenceNoResult" | "ERegexMatchNoCapture"; + } + /** + * Represents types of #NAME? errors. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NameErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #NAME? in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unknown = "Unknown", + /** + * An error caused by a formula containing an unsupported function. Displays as error type #NAME? in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedFunction = "UnsupportedFunction" } /** * Represents the value of a cell containing a #NAME? error. @@ -28191,6 +28657,14 @@ declare namespace Excel { * [Api set: ExcelApi 1.16] */ errorType?: ErrorCellValueType.name | "Name"; + /** + * Represents the type of `NameErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + errorSubType?: NameErrorCellValueSubType | "Unknown" | "UnsupportedFunction"; } /** * Represents the value of a cell containing a #NULL! error. @@ -28331,7 +28805,15 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - externalLinksCalculatedRef = "ExternalLinksCalculatedRef" + externalLinksCalculatedRef = "ExternalLinksCalculatedRef", + /** + * An error caused by a corrupt formula. Displays as error type #REF! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + corruptCellRef = "CorruptCellRef" } /** * Represents the value of a cell containing a #REF! error. @@ -28376,7 +28858,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef"; + errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef" | "CorruptCellRef"; } /** * Represents types of #SPILL! errors. @@ -28745,7 +29227,777 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - lambdaWrongParamCount = "LambdaWrongParamCount" + lambdaWrongParamCount = "LambdaWrongParamCount", + /** + * An error caused by passing too many arguments to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaTooManyArgs = "ImageFormulaTooManyArgs", + /** + * An error caused by an unsupported image formula. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidImageFormat = "ImageFormulaInvalidImageFormat", + /** + * An error caused by a non-string `source` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidSource = "ImageFormulaInvalidSource", + /** + * An error caused by a non-string `alt_text` parameter to an `IMAGE` function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidAltText = "ImageFormulaInvalidAltText", + /** + * An error caused by invalid size parameters to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidSizing = "ImageFormulaInvalidSizing", + /** + * An error caused by too few arguments passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaNotEnoughArgs = "ImageFormulaNotEnoughArgs", + /** + * An error caused by a non-numerical or invalid `height` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidHeight = "ImageFormulaInvalidHeight", + /** + * An error caused by a non-numerical or invalid `width` argument passed to `IMAGE`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + imageFormulaInvalidWidth = "ImageFormulaInvalidWidth", + /** + * An error caused by an argument with the wrong data type passed to a custom function. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + invalidCellValueTypeCoercion = "InvalidCellValueTypeCoercion", + /** + * An error in the regex `pattern`. An unknown compile error has occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexErrorGeneric = "CRegexErrorGeneric", + /** + * An error in the regex `pattern`. \ at end of pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEndBackslash = "CRegexEndBackslash", + /** + * An error in the regex `pattern`. \c at end of pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEndBackslashC = "CRegexEndBackslashC", + /** + * An error in the regex `pattern`. Unrecognized character follows \. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownEscape = "CRegexUnknownEscape", + /** + * An error in the regex `pattern`. Number out of order in {} quantifier. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierOutOfOrder = "CRegexQuantifierOutOfOrder", + /** + * An error in the regex `pattern`. Number too big in quantifier {}. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierTooBig = "CRegexQuantifierTooBig", + /** + * An error in the regex `pattern`. Missing terminating ] for character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingSquareBracket = "CRegexMissingSquareBracket", + /** + * An error in the regex `pattern`. Escape sequence is invalid in character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEscapeInvalidInClass = "CRegexEscapeInvalidInClass", + /** + * An error in the regex `pattern`. Quantifier does not follow a repeatable item. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQuantifierInvalid = "CRegexQuantifierInvalid", + /** + * An error in the regex `pattern`. Unrecognized character after (? or (?-. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidAfterParensQuery = "CRegexInvalidAfterParensQuery", + /** + * An error in the regex `pattern`. POSIX named classes are supported only within a class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPosixClassNotInClass = "CRegexPosixClassNotInClass", + /** + * An error in the regex `pattern`. POSIX collating elements are not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPosixNoSupportCollating = "CRegexPosixNoSupportCollating", + /** + * An error in the regex `pattern`. Missing closing parenthesis. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingClosingParenthesis = "CRegexMissingClosingParenthesis", + /** + * An error in the regex `pattern`. Reference to nonexistent subpattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBadSubpatternReference = "CRegexBadSubpatternReference", + /** + * An error in the regex `pattern`. Missing ) after (?# comment. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingCommentClosing = "CRegexMissingCommentClosing", + /** + * An error in the regex `pattern`. Parentheses are too deeply nested. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexParenthesesNestTooDeep = "CRegexParenthesesNestTooDeep", + /** + * An error in the regex `pattern`. Regular expression is too large. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternTooLarge = "CRegexPatternTooLarge", + /** + * An error in the regex `pattern`. Unmatched closing parenthesis. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnmatchedClosingParenthesis = "CRegexUnmatchedClosingParenthesis", + /** + * An error in the regex `pattern`. Missing closing parenthesis for condition. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingConditionClosing = "CRegexMissingConditionClosing", + /** + * An error in the regex `pattern`. Length of `lookbehind` assertion is not limited. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindNotFixedLength = "CRegexLookbehindNotFixedLength", + /** + * An error in the regex `pattern`. A relative value of zero is not allowed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexZeroRelativeReference = "CRegexZeroRelativeReference", + /** + * An error in the regex `pattern`. Conditional subpattern contains more than two branches. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyConditionBranches = "CRegexTooManyConditionBranches", + /** + * An error in the regex `pattern`. Digit expected after (?+ or (?-. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBadRelativeReference = "CRegexBadRelativeReference", + /** + * An error in the regex `pattern`. Unknown POSIX class name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownPosixClass = "CRegexUnknownPosixClass", + /** + * An error in the regex `pattern`. Character code point value in \x{} or \o{} is too large. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCodePointTooBig = "CRegexCodePointTooBig", + /** + * An error in the regex `pattern`. `lookbehind` is too complicated. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindTooComplicated = "CRegexLookbehindTooComplicated", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnsupportedEscapeSequence = "CRegexUnsupportedEscapeSequence", + /** + * An error in the regex `pattern`. Number after (?C is greater than 255. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutNumberTooBig = "CRegexCalloutNumberTooBig", + /** + * An error in the regex `pattern`. Closing parenthesis for (?C expected. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingCalloutClosing = "CRegexMissingCalloutClosing", + /** + * An error in the regex `pattern`. Invalid escape sequence in (*VERB) name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexEscapeInvalidInVerb = "CRegexEscapeInvalidInVerb", + /** + * An error in the regex `pattern`. Unrecongnized character after (?P. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnrecognizedAfterQueryP = "CRegexUnrecognizedAfterQueryP", + /** + * An error in the regex `pattern`. Syntax error in subpattern name (missing terminator?). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingNameTerminator = "CRegexMissingNameTerminator", + /** + * An error in the regex `pattern`. Two named subpatterns have the same name. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexDuplicateSubpatternName = "CRegexDuplicateSubpatternName", + /** + * An error in the regex `pattern`. Subpattern name must start with a non-digit. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidSubpatternName = "CRegexInvalidSubpatternName", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnicodePropertiesUnavailable = "CRegexUnicodePropertiesUnavailable", + /** + * An error in the regex `pattern`. Malformed \P or \p sequence. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMalformedUnicodeProperty = "CRegexMalformedUnicodeProperty", + /** + * An error in the regex `pattern`. Unknown property after \P or \p. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnknownUnicodeProperty = "CRegexUnknownUnicodeProperty", + /** + * An error in the regex `pattern`. Subpattern name is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNameTooLong = "CRegexSubpatternNameTooLong", + /** + * An error in the regex `pattern`. Too many named subpatterns. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyNamedSubpatterns = "CRegexTooManyNamedSubpatterns", + /** + * An error in the regex `pattern`. Invalid range in character class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexClassInvalidRange = "CRegexClassInvalidRange", + /** + * An error in the regex `pattern`. `DEFINE` subpattern contains more than one branch. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexDefineTooManyBranches = "CRegexDefineTooManyBranches", + /** + * An error in the regex `pattern`. Missing opening brace after \o. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashOMissingBrace = "CRegexBackslashOMissingBrace", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashGSyntax = "CRegexBackslashGSyntax", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexParensQueryRMissingClosing = "CRegexParensQueryRMissingClosing", + /** + * An error in the regex `pattern`. The (*VERB) is not recognized or is malformed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVerbUnknown = "CRegexVerbUnknown", + /** + * An error in the regex `pattern`. The subpattern number exceeds the limit of 65,535. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNumberTooBig = "CRegexSubpatternNumberTooBig", + /** + * An error in the regex `pattern`. Subpattern name expected. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNameExpected = "CRegexSubpatternNameExpected", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidOctal = "CRegexInvalidOctal", + /** + * An error in the regex `pattern`. Different names for subpatterns of the same number are not allowed. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexSubpatternNamesMismatch = "CRegexSubpatternNamesMismatch", + /** + * An error in the regex `pattern`. The (*MARK) must have an argument. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMarkMissingArgument = "CRegexMarkMissingArgument", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidHexadecimal = "CRegexInvalidHexadecimal", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashCSyntax = "CRegexBackslashCSyntax", + /** + * An error in the regex `pattern`. \N is not supported in class. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashNInClass = "CRegexBackslashNInClass", + /** + * An error in the regex `pattern`. The callout string is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutStringTooLong = "CRegexCalloutStringTooLong", + /** + * An error in the regex `pattern`. Disallowed Unicode point (>= 0xD800 && <= 0xDFFF). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexUnicodeDisallowedCodePoint = "CRegexUnicodeDisallowedCodePoint", + /** + * An error in the regex `pattern`. A name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVerbNameTooLong = "CRegexVerbNameTooLong", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashUCodePointTooBig = "CRegexBackslashUCodePointTooBig", + /** + * An error in the regex `pattern`. Digits are missing in \x{}, \o{}, or \N{U+}. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexMissingOctalOrHexDigits = "CRegexMissingOctalOrHexDigits", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexVersionConditionSyntax = "CRegexVersionConditionSyntax", + /** + * An error in the regex `pattern`. Missing terminating delimiter for callout with string argument. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutNoStringDelimiter = "CRegexCalloutNoStringDelimiter", + /** + * An error in the regex `pattern`. Unrecognized string delimiter follows (?C. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexCalloutBadStringDelimiter = "CRegexCalloutBadStringDelimiter", + /** + * An error in the regex `pattern`. The (?|, (?J:, or (?x: parentheses are too deeply nested. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexQueryBarjxNestTooDeep = "CRegexQueryBarjxNestTooDeep", + /** + * An error in the regex `pattern`. Regular expression is too complicated. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternTooComplicated = "CRegexPatternTooComplicated", + /** + * An error in the regex `pattern`. `lookbehind` assertion is too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexLookbehindTooLong = "CRegexLookbehindTooLong", + /** + * An error in the regex `pattern`. Pattern string is longer than the limit set by the application. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexPatternStringTooLong = "CRegexPatternStringTooLong", + /** + * An error in the regex `pattern`. Invalid hyphen in option setting. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexInvalidHyphenInOptions = "CRegexInvalidHyphenInOptions", + /** + * An error in the regex `pattern`. The (*alpha_assertion) isn't recognized. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexAlphaAssertionUnknown = "CRegexAlphaAssertionUnknown", + /** + * An error in the regex `pattern`. Too many capturing groups (maximum 65535). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexTooManyCaptures = "CRegexTooManyCaptures", + /** + * An error in the regex `pattern`. Atomic assertion expected after (?( or (?(?C). Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexConditionAtomicAssertionExpected = "CRegexConditionAtomicAssertionExpected", + /** + * An error in the regex `pattern`. \K is not allowed in `lookarounds=`. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cRegexBackslashKInLookaround = "CRegexBackslashKInLookaround", + /** + * An error in regex match. An unknown match error has occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexErrorGeneric = "MRegexErrorGeneric", + /** + * An error in regex match. Invalid replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadreplacement = "MRegexBadreplacement", + /** + * An error in regex match. Match limit exceeded. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexMatchlimit = "MRegexMatchlimit", + /** + * An error in regex match. Unknown substring. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexNosubstring = "MRegexNosubstring", + /** + * An error in regex match. Nonunique substring name. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexNouniquesubstring = "MRegexNouniquesubstring", + /** + * An error in regex match. Matching depth limit exceeded. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexDepthlimit = "MRegexDepthlimit", + /** + * An error in regex match. There's an incorrect escape sequence in the replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadrepescape = "MRegexBadrepescape", + /** + * An error in regex match. Expected closing curly bracket in replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexRepmissingbrace = "MRegexRepmissingbrace", + /** + * An error in regex match. There's an incorrect substitution in the replacement string. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadsubstitution = "MRegexBadsubstitution", + /** + * An error in regex match. Match with end before start or start moved backwards is not supported. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexBadsubspattern = "MRegexBadsubspattern", + /** + * An error in regex match. Recursive loop. Displays as error type #VALUE! in Excel. + * Note: The name of this API is likely to change in the near future. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + mRegexRecurseLoop = "MRegexRecurseLoop", + /** + * An unknown regex error occurred. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexErrorGeneric = "ERegexErrorGeneric", + /** + * No capture groups were found in the regex pattern. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + eRegexNoCaptureGroups = "ERegexNoCaptureGroups", + /** + * An error caused by the `text` parameter to `TRANSLATE` being too long. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateStringTooLong = "TranslateStringTooLong", + /** + * An error caused because the `source_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateUnsupportedSrcLanguage = "TranslateUnsupportedSrcLanguage", + /** + * An error caused because the `target_language` parameter to `TRANSLATE` is not supported. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + translateUnsupportedTargetLanguage = "TranslateUnsupportedTargetLanguage" } /** * Represents the value of a cell containing a #VALUE! error. @@ -28790,7 +30042,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount"; + 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"; } /** * Represents the value of a cell containing a type of value which cannot be serialized. @@ -36932,7 +38184,7 @@ declare namespace Excel { */ getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; /** - * Renders the range as a Base64-encoded png image. + * Renders the range as a Base64-encoded PNG image. **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. * * @remarks @@ -48969,7 +50221,7 @@ declare namespace Excel { */ category: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -59818,6 +61070,13 @@ declare namespace Excel { * [Api set: ExcelApi BETA (PREVIEW ONLY)] */ annotationAdded = "AnnotationAdded", + /** + * TableQueryRefreshCompleted represents the type of event registered when a table query refresh is completed. + * @remarks + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + queryQueryRefreshCompleted = "QueryQueryRefreshCompleted" } /** * @remarks @@ -69890,7 +71149,7 @@ declare namespace Excel { */ category?: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -76414,7 +77673,7 @@ declare namespace Excel { */ category?: string; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] @@ -86193,7 +87452,7 @@ declare namespace Excel { */ category?: boolean; /** - * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbork. + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. * * @remarks * [Api set: ExcelApi 1.7] From a9714f0f473a0feb28c522fce10bc5f3ebb38c70 Mon Sep 17 00:00:00 2001 From: Rick Kirkham Date: Thu, 7 Nov 2024 12:23:45 -0800 Subject: [PATCH 3/3] [All Hosts] (req sets) simplify support info for DialogApi 1.2 (#2128) --- .../common/dialog-api-requirement-sets.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/requirement-sets/common/dialog-api-requirement-sets.md b/docs/requirement-sets/common/dialog-api-requirement-sets.md index 64d796b5aa..9733c54dcf 100644 --- a/docs/requirement-sets/common/dialog-api-requirement-sets.md +++ b/docs/requirement-sets/common/dialog-api-requirement-sets.md @@ -1,7 +1,7 @@ --- title: Dialog API requirement sets description: Learn more about the Dialog API requirement sets. -ms.date: 10/17/2024 +ms.date: 11/07/2024 ms.topic: overview ms.localizationpriority: medium --- @@ -14,7 +14,7 @@ Office Add-ins run across multiple versions of Office. The following table lists | Requirement set | Office on the web | Office on Windows
(Microsoft 365 subscription) | Office on Windows1
(retail perpetual) | Office on Windows1
(volume-licensed perpetual) | Office on Mac | Office on iPad | Office Online Server | |:-----|:-----|:-----|:-----|:-----|:-----|:-----|:-----| -| DialogApi 1.2 | Supported | See [support](#office-on-windows-microsoft-365-subscription-support)
[section](#office-on-windows-microsoft-365-subscription-support) | Version 2005 (Build 12827.20268) | Office 2021: Version 2005 (Build 12827.20268) | Version 16.37 (20051002) | Version 16.37 | Not supported | +| DialogApi 1.2 | Supported | Version 2005 (Build 12827.20268) | Version 2005 (Build 12827.20268) | Office 2021: Version 2005 (Build 12827.20268) | Version 16.37 (20051002) | Version 16.37 | Not supported | | DialogApi 1.1 | Supported | Version 1602 (Build 6741.0000) | Version 1602 (Build 6741.0000) | Office 20162 | Version 15.20 | Version 1.22 | Version 1608 (Build 7601.6800) | > [!NOTE] @@ -22,16 +22,6 @@ Office Add-ins run across multiple versions of Office. The following table lists > > 2 DialogApi 1.1 isn't supported in Outlook 2016 (volume-licensed perpetual). -## Office on Windows (Microsoft 365 subscription) support - -The DialogApi 1.2 requirement set is supported in the Consumer Channel from Version 2005 (Build 12827.20268). That requirement set is also supported in the Semi-Annual Channel and Monthly Enterprise Channel builds available since June 9, 2020. The **minimum** supported builds for each channel are as follows: - -| Channel | Minimum version | Minimum build | -|:-----|:-----|:-----| -| Current Channel | 2005 | 12827.20160 | -| Monthly Enterprise Channel | 2004 | 12730.20430 | -| Semi-Annual Enterprise Channel | 2002 | 12527.20720 | - ## Outlook support In Outlook, dialog features and their APIs were introduced in the following Mailbox requirement sets.