From b2a596fdee5e741237b0faf454a0c638d2a29ade Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Wed, 6 Nov 2024 08:02:59 -0800 Subject: [PATCH] [office-js] [office-js-preview] (OneNote, Visio) Updates from CDN (#71104) --- types/office-js-preview/index.d.ts | 862 +++++++++++----------- types/office-js/index.d.ts | 1074 +++++++++++++--------------- 2 files changed, 917 insertions(+), 1019 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 28c78a6181af50..40eeead49ea988 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.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; } /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 77c79f454ab6d4..cd8a74c65522a5 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.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; }