@types/office-js 1.0.440 → 1.0.442

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +710 -568
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -106610,6 +106610,7 @@ declare namespace OneNote {
106610
106610
  * [Api set: OneNoteApi 1.1]
106611
106611
  */
106612
106612
  getActiveSectionOrNull(): OneNote.Section;
106613
+ getDecimalSeparator(): OfficeExtension.ClientResult<string>;
106613
106614
  /**
106614
106615
  * Gets the currently selected ink strokes.
106615
106616
  *
@@ -106618,6 +106619,7 @@ declare namespace OneNote {
106618
106619
  */
106619
106620
  getSelectedInkStrokes(): OneNote.InkStrokeCollection;
106620
106621
  getWindowSize(): OfficeExtension.ClientResult<number[]>;
106622
+ insertAndEmbedLinkAtCurrentPosition(url: string): void;
106621
106623
  insertHtmlAtCurrentPosition(html: string): void;
106622
106624
  isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;
106623
106625
  /**
@@ -106661,9 +106663,9 @@ declare namespace OneNote {
106661
106663
  expand?: string;
106662
106664
  }): OneNote.Application;
106663
106665
  /**
106664
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106665
- * 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.
106666
- */
106666
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106667
+ * 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.
106668
+ */
106667
106669
  toJSON(): OneNote.Interfaces.ApplicationData;
106668
106670
  }
106669
106671
  /**
@@ -106676,14 +106678,14 @@ declare namespace OneNote {
106676
106678
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
106677
106679
  context: RequestContext;
106678
106680
  /**
106679
- * Gets the parent page object. Read-only.
106681
+ * Gets the parent page object.
106680
106682
  *
106681
106683
  * @remarks
106682
106684
  * [Api set: OneNoteApi 1.1]
106683
106685
  */
106684
106686
  readonly page: OneNote.Page;
106685
106687
  /**
106686
- * Gets the ID of the InkAnalysis object. Read-only.
106688
+ * Gets the ID of the InkAnalysis object.
106687
106689
  *
106688
106690
  * @remarks
106689
106691
  * [Api set: OneNoteApi 1.1]
@@ -106719,17 +106721,17 @@ declare namespace OneNote {
106719
106721
  expand?: string;
106720
106722
  }): OneNote.InkAnalysis;
106721
106723
  /**
106722
- * 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.
106724
+ * 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.
106723
106725
  */
106724
106726
  track(): OneNote.InkAnalysis;
106725
106727
  /**
106726
- * 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.
106728
+ * 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.
106727
106729
  */
106728
106730
  untrack(): OneNote.InkAnalysis;
106729
106731
  /**
106730
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106731
- * 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.
106732
- */
106732
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106733
+ * 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.
106734
+ */
106733
106735
  toJSON(): OneNote.Interfaces.InkAnalysisData;
106734
106736
  }
106735
106737
  /**
@@ -106742,21 +106744,21 @@ declare namespace OneNote {
106742
106744
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
106743
106745
  context: RequestContext;
106744
106746
  /**
106745
- * Reference to the parent InkAnalysisPage. Read-only.
106747
+ * Reference to the parent InkAnalysisPage.
106746
106748
  *
106747
106749
  * @remarks
106748
106750
  * [Api set: OneNoteApi 1.1]
106749
106751
  */
106750
106752
  readonly inkAnalysis: OneNote.InkAnalysis;
106751
106753
  /**
106752
- * Gets the ink analysis lines in this ink analysis paragraph. Read-only.
106754
+ * Gets the ink analysis lines in this ink analysis paragraph.
106753
106755
  *
106754
106756
  * @remarks
106755
106757
  * [Api set: OneNoteApi 1.1]
106756
106758
  */
106757
106759
  readonly lines: OneNote.InkAnalysisLineCollection;
106758
106760
  /**
106759
- * Gets the ID of the InkAnalysisParagraph object. Read-only.
106761
+ * Gets the ID of the InkAnalysisParagraph object.
106760
106762
  *
106761
106763
  * @remarks
106762
106764
  * [Api set: OneNoteApi 1.1]
@@ -106792,17 +106794,17 @@ declare namespace OneNote {
106792
106794
  expand?: string;
106793
106795
  }): OneNote.InkAnalysisParagraph;
106794
106796
  /**
106795
- * 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.
106797
+ * 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.
106796
106798
  */
106797
106799
  track(): OneNote.InkAnalysisParagraph;
106798
106800
  /**
106799
- * 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.
106801
+ * 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.
106800
106802
  */
106801
106803
  untrack(): OneNote.InkAnalysisParagraph;
106802
106804
  /**
106803
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106804
- * 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.
106805
- */
106805
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106806
+ * 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.
106807
+ */
106806
106808
  toJSON(): OneNote.Interfaces.InkAnalysisParagraphData;
106807
106809
  }
106808
106810
  /**
@@ -106817,14 +106819,14 @@ declare namespace OneNote {
106817
106819
  /** Gets the loaded child items in this collection. */
106818
106820
  readonly items: OneNote.InkAnalysisParagraph[];
106819
106821
  /**
106820
- * Returns the number of InkAnalysisParagraphs in the page. Read-only.
106822
+ * Returns the number of InkAnalysisParagraphs in the page.
106821
106823
  *
106822
106824
  * @remarks
106823
106825
  * [Api set: OneNoteApi 1.1]
106824
106826
  */
106825
106827
  readonly count: number;
106826
106828
  /**
106827
- * Gets a InkAnalysisParagraph object by ID or by its index in the collection. Read-only.
106829
+ * Gets a InkAnalysisParagraph object by ID or by its index in the collection.
106828
106830
  *
106829
106831
  * @remarks
106830
106832
  * [Api set: OneNoteApi 1.1]
@@ -106860,17 +106862,17 @@ declare namespace OneNote {
106860
106862
  */
106861
106863
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection;
106862
106864
  /**
106863
- * 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.
106865
+ * 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.
106864
106866
  */
106865
106867
  track(): OneNote.InkAnalysisParagraphCollection;
106866
106868
  /**
106867
- * 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.
106869
+ * 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.
106868
106870
  */
106869
106871
  untrack(): OneNote.InkAnalysisParagraphCollection;
106870
106872
  /**
106871
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106872
- * 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.
106873
- */
106873
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106874
+ * 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.
106875
+ */
106874
106876
  toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData;
106875
106877
  }
106876
106878
  /**
@@ -106883,21 +106885,21 @@ declare namespace OneNote {
106883
106885
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
106884
106886
  context: RequestContext;
106885
106887
  /**
106886
- * Reference to the parent InkAnalysisParagraph. Read-only.
106888
+ * Reference to the parent InkAnalysisParagraph.
106887
106889
  *
106888
106890
  * @remarks
106889
106891
  * [Api set: OneNoteApi 1.1]
106890
106892
  */
106891
106893
  readonly paragraph: OneNote.InkAnalysisParagraph;
106892
106894
  /**
106893
- * Gets the ink analysis words in this ink analysis line. Read-only.
106895
+ * Gets the ink analysis words in this ink analysis line.
106894
106896
  *
106895
106897
  * @remarks
106896
106898
  * [Api set: OneNoteApi 1.1]
106897
106899
  */
106898
106900
  readonly words: OneNote.InkAnalysisWordCollection;
106899
106901
  /**
106900
- * Gets the ID of the InkAnalysisLine object. Read-only.
106902
+ * Gets the ID of the InkAnalysisLine object.
106901
106903
  *
106902
106904
  * @remarks
106903
106905
  * [Api set: OneNoteApi 1.1]
@@ -106933,17 +106935,17 @@ declare namespace OneNote {
106933
106935
  expand?: string;
106934
106936
  }): OneNote.InkAnalysisLine;
106935
106937
  /**
106936
- * 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.
106938
+ * 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.
106937
106939
  */
106938
106940
  track(): OneNote.InkAnalysisLine;
106939
106941
  /**
106940
- * 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.
106942
+ * 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.
106941
106943
  */
106942
106944
  untrack(): OneNote.InkAnalysisLine;
106943
106945
  /**
106944
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106945
- * 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.
106946
- */
106946
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
106947
+ * 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.
106948
+ */
106947
106949
  toJSON(): OneNote.Interfaces.InkAnalysisLineData;
106948
106950
  }
106949
106951
  /**
@@ -106958,7 +106960,7 @@ declare namespace OneNote {
106958
106960
  /** Gets the loaded child items in this collection. */
106959
106961
  readonly items: OneNote.InkAnalysisLine[];
106960
106962
  /**
106961
- * Returns the number of InkAnalysisLines in the page. Read-only.
106963
+ * Returns the number of InkAnalysisLines in the page.
106962
106964
  *
106963
106965
  * @remarks
106964
106966
  * [Api set: OneNoteApi 1.1]
@@ -107001,17 +107003,17 @@ declare namespace OneNote {
107001
107003
  */
107002
107004
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisLineCollection;
107003
107005
  /**
107004
- * 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.
107006
+ * 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.
107005
107007
  */
107006
107008
  track(): OneNote.InkAnalysisLineCollection;
107007
107009
  /**
107008
- * 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.
107010
+ * 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.
107009
107011
  */
107010
107012
  untrack(): OneNote.InkAnalysisLineCollection;
107011
107013
  /**
107012
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107013
- * 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.
107014
- */
107014
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107015
+ * 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.
107016
+ */
107015
107017
  toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData;
107016
107018
  }
107017
107019
  /**
@@ -107024,35 +107026,35 @@ declare namespace OneNote {
107024
107026
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107025
107027
  context: RequestContext;
107026
107028
  /**
107027
- * Reference to the parent InkAnalysisLine. Read-only.
107029
+ * Reference to the parent InkAnalysisLine.
107028
107030
  *
107029
107031
  * @remarks
107030
107032
  * [Api set: OneNoteApi 1.1]
107031
107033
  */
107032
107034
  readonly line: OneNote.InkAnalysisLine;
107033
107035
  /**
107034
- * Gets the ID of the InkAnalysisWord object. Read-only.
107036
+ * Gets the ID of the InkAnalysisWord object.
107035
107037
  *
107036
107038
  * @remarks
107037
107039
  * [Api set: OneNoteApi 1.1]
107038
107040
  */
107039
107041
  readonly id: string;
107040
107042
  /**
107041
- * The id of the recognized language in this inkAnalysisWord. Read-only.
107043
+ * The ID of the recognized language in this inkAnalysisWord.
107042
107044
  *
107043
107045
  * @remarks
107044
107046
  * [Api set: OneNoteApi 1.1]
107045
107047
  */
107046
107048
  readonly languageId: string;
107047
107049
  /**
107048
- * Weak references to the ink strokes that were recognized as part of this ink analysis word. Read-only.
107050
+ * Weak references to the ink strokes that were recognized as part of this ink analysis word.
107049
107051
  *
107050
107052
  * @remarks
107051
107053
  * [Api set: OneNoteApi 1.1]
107052
107054
  */
107053
107055
  readonly strokePointers: OneNote.InkStrokePointer[];
107054
107056
  /**
107055
- * The words that were recognized in this ink word, in order of likelihood. Read-only.
107057
+ * The words that were recognized in this ink word, in order of likelihood.
107056
107058
  *
107057
107059
  * @remarks
107058
107060
  * [Api set: OneNoteApi 1.1]
@@ -107088,17 +107090,17 @@ declare namespace OneNote {
107088
107090
  expand?: string;
107089
107091
  }): OneNote.InkAnalysisWord;
107090
107092
  /**
107091
- * 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.
107093
+ * 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.
107092
107094
  */
107093
107095
  track(): OneNote.InkAnalysisWord;
107094
107096
  /**
107095
- * 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.
107097
+ * 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.
107096
107098
  */
107097
107099
  untrack(): OneNote.InkAnalysisWord;
107098
107100
  /**
107099
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107100
- * 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.
107101
- */
107101
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107102
+ * 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.
107103
+ */
107102
107104
  toJSON(): OneNote.Interfaces.InkAnalysisWordData;
107103
107105
  }
107104
107106
  /**
@@ -107113,7 +107115,7 @@ declare namespace OneNote {
107113
107115
  /** Gets the loaded child items in this collection. */
107114
107116
  readonly items: OneNote.InkAnalysisWord[];
107115
107117
  /**
107116
- * Returns the number of InkAnalysisWords in the page. Read-only.
107118
+ * Returns the number of InkAnalysisWords in the page.
107117
107119
  *
107118
107120
  * @remarks
107119
107121
  * [Api set: OneNoteApi 1.1]
@@ -107156,17 +107158,18 @@ declare namespace OneNote {
107156
107158
  */
107157
107159
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisWordCollection;
107158
107160
  /**
107159
- * 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.
107161
+ * 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.
107160
107162
  */
107161
107163
  track(): OneNote.InkAnalysisWordCollection;
107162
107164
  /**
107165
+ * 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.
107163
107166
  * 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.
107164
107167
  */
107165
107168
  untrack(): OneNote.InkAnalysisWordCollection;
107166
107169
  /**
107167
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107168
- * 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.
107169
- */
107170
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107171
+ * 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.
107172
+ */
107170
107173
  toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData;
107171
107174
  }
107172
107175
  /**
@@ -107179,21 +107182,21 @@ declare namespace OneNote {
107179
107182
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107180
107183
  context: RequestContext;
107181
107184
  /**
107182
- * Gets the strokes of the FloatingInk object. Read-only.
107185
+ * Gets the strokes of the FloatingInk object.
107183
107186
  *
107184
107187
  * @remarks
107185
107188
  * [Api set: OneNoteApi 1.1]
107186
107189
  */
107187
107190
  readonly inkStrokes: OneNote.InkStrokeCollection;
107188
107191
  /**
107189
- * Gets the PageContent parent of the FloatingInk object. Read-only.
107192
+ * Gets the PageContent parent of the FloatingInk object.
107190
107193
  *
107191
107194
  * @remarks
107192
107195
  * [Api set: OneNoteApi 1.1]
107193
107196
  */
107194
107197
  readonly pageContent: OneNote.PageContent;
107195
107198
  /**
107196
- * Gets the ID of the FloatingInk object. Read-only.
107199
+ * Gets the ID of the FloatingInk object.
107197
107200
  *
107198
107201
  * @remarks
107199
107202
  * [Api set: OneNoteApi 1.1]
@@ -107221,17 +107224,17 @@ declare namespace OneNote {
107221
107224
  expand?: string;
107222
107225
  }): OneNote.FloatingInk;
107223
107226
  /**
107224
- * 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.
107227
+ * 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.
107225
107228
  */
107226
107229
  track(): OneNote.FloatingInk;
107227
107230
  /**
107228
- * 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.
107231
+ * 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.
107229
107232
  */
107230
107233
  untrack(): OneNote.FloatingInk;
107231
107234
  /**
107232
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107233
- * 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.
107234
- */
107235
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107236
+ * 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.
107237
+ */
107235
107238
  toJSON(): OneNote.Interfaces.FloatingInkData;
107236
107239
  }
107237
107240
  /**
@@ -107251,7 +107254,7 @@ declare namespace OneNote {
107251
107254
  */
107252
107255
  readonly floatingInk: OneNote.FloatingInk;
107253
107256
  /**
107254
- * Gets the ID of the InkStroke object. Read-only.
107257
+ * Gets the ID of the InkStroke object.
107255
107258
  *
107256
107259
  * @remarks
107257
107260
  * [Api set: OneNoteApi 1.1]
@@ -107279,17 +107282,17 @@ declare namespace OneNote {
107279
107282
  expand?: string;
107280
107283
  }): OneNote.InkStroke;
107281
107284
  /**
107282
- * 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.
107285
+ * 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.
107283
107286
  */
107284
107287
  track(): OneNote.InkStroke;
107285
107288
  /**
107286
- * 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.
107289
+ * 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.
107287
107290
  */
107288
107291
  untrack(): OneNote.InkStroke;
107289
107292
  /**
107290
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107291
- * 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.
107292
- */
107293
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107294
+ * 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.
107295
+ */
107293
107296
  toJSON(): OneNote.Interfaces.InkStrokeData;
107294
107297
  }
107295
107298
  /**
@@ -107304,7 +107307,7 @@ declare namespace OneNote {
107304
107307
  /** Gets the loaded child items in this collection. */
107305
107308
  readonly items: OneNote.InkStroke[];
107306
107309
  /**
107307
- * Returns the number of InkStrokes in the page. Read-only.
107310
+ * Returns the number of InkStrokes in the page.
107308
107311
  *
107309
107312
  * @remarks
107310
107313
  * [Api set: OneNoteApi 1.1]
@@ -107347,17 +107350,17 @@ declare namespace OneNote {
107347
107350
  */
107348
107351
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkStrokeCollection;
107349
107352
  /**
107350
- * 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.
107353
+ * 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.
107351
107354
  */
107352
107355
  track(): OneNote.InkStrokeCollection;
107353
107356
  /**
107354
- * 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.
107357
+ * 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.
107355
107358
  */
107356
107359
  untrack(): OneNote.InkStrokeCollection;
107357
107360
  /**
107358
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107359
- * 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.
107360
- */
107361
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107362
+ * 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.
107363
+ */
107361
107364
  toJSON(): OneNote.Interfaces.InkStrokeCollectionData;
107362
107365
  }
107363
107366
  /**
@@ -107370,7 +107373,7 @@ declare namespace OneNote {
107370
107373
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107371
107374
  context: RequestContext;
107372
107375
  /**
107373
- * Gets the ID of the Point object. Read-only.
107376
+ * Gets the ID of the Point object.
107374
107377
  *
107375
107378
  * @remarks
107376
107379
  * [Api set: OneNoteApi 1.9]
@@ -107400,17 +107403,17 @@ declare namespace OneNote {
107400
107403
  expand?: string;
107401
107404
  }): OneNote.Point;
107402
107405
  /**
107403
- * 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.
107406
+ * 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.
107404
107407
  */
107405
107408
  track(): OneNote.Point;
107406
107409
  /**
107407
- * 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.
107410
+ * 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.
107408
107411
  */
107409
107412
  untrack(): OneNote.Point;
107410
107413
  /**
107411
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107412
- * 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.
107413
- */
107414
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107415
+ * 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.
107416
+ */
107414
107417
  toJSON(): OneNote.Interfaces.PointData;
107415
107418
  }
107416
107419
  /**
@@ -107425,7 +107428,7 @@ declare namespace OneNote {
107425
107428
  /** Gets the loaded child items in this collection. */
107426
107429
  readonly items: OneNote.Point[];
107427
107430
  /**
107428
- * Returns the number of Point in the stroke. Read-only.
107431
+ * Returns the number of Point in the stroke.
107429
107432
  *
107430
107433
  * @remarks
107431
107434
  * [Api set: OneNoteApi 1.9]
@@ -107468,17 +107471,17 @@ declare namespace OneNote {
107468
107471
  */
107469
107472
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PointCollection;
107470
107473
  /**
107471
- * 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.
107474
+ * 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.
107472
107475
  */
107473
107476
  track(): OneNote.PointCollection;
107474
107477
  /**
107475
- * 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.
107478
+ * 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.
107476
107479
  */
107477
107480
  untrack(): OneNote.PointCollection;
107478
107481
  /**
107479
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107480
- * 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.
107481
- */
107482
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107483
+ * 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.
107484
+ */
107482
107485
  toJSON(): OneNote.Interfaces.PointCollectionData;
107483
107486
  }
107484
107487
  /**
@@ -107491,28 +107494,28 @@ declare namespace OneNote {
107491
107494
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107492
107495
  context: RequestContext;
107493
107496
  /**
107494
- * The parent paragraph containing the ink word. Read-only.
107497
+ * The parent paragraph containing the ink word.
107495
107498
  *
107496
107499
  * @remarks
107497
107500
  * [Api set: OneNoteApi 1.1]
107498
107501
  */
107499
107502
  readonly paragraph: OneNote.Paragraph;
107500
107503
  /**
107501
- * Gets the ID of the InkWord object. Read-only.
107504
+ * Gets the ID of the InkWord object.
107502
107505
  *
107503
107506
  * @remarks
107504
107507
  * [Api set: OneNoteApi 1.1]
107505
107508
  */
107506
107509
  readonly id: string;
107507
107510
  /**
107508
- * The id of the recognized language in this ink word. Read-only.
107511
+ * The ID of the recognized language in this ink word.
107509
107512
  *
107510
107513
  * @remarks
107511
107514
  * [Api set: OneNoteApi 1.1]
107512
107515
  */
107513
107516
  readonly languageId: string;
107514
107517
  /**
107515
- * The words that were recognized in this ink word, in order of likelihood. Read-only.
107518
+ * The words that were recognized in this ink word, in order of likelihood.
107516
107519
  *
107517
107520
  * @remarks
107518
107521
  * [Api set: OneNoteApi 1.1]
@@ -107540,17 +107543,17 @@ declare namespace OneNote {
107540
107543
  expand?: string;
107541
107544
  }): OneNote.InkWord;
107542
107545
  /**
107543
- * 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.
107546
+ * 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.
107544
107547
  */
107545
107548
  track(): OneNote.InkWord;
107546
107549
  /**
107547
- * 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.
107550
+ * 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.
107548
107551
  */
107549
107552
  untrack(): OneNote.InkWord;
107550
107553
  /**
107551
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107552
- * 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.
107553
- */
107554
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107555
+ * 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.
107556
+ */
107554
107557
  toJSON(): OneNote.Interfaces.InkWordData;
107555
107558
  }
107556
107559
  /**
@@ -107565,7 +107568,7 @@ declare namespace OneNote {
107565
107568
  /** Gets the loaded child items in this collection. */
107566
107569
  readonly items: OneNote.InkWord[];
107567
107570
  /**
107568
- * Returns the number of InkWords in the page. Read-only.
107571
+ * Returns the number of InkWords in the page.
107569
107572
  *
107570
107573
  * @remarks
107571
107574
  * [Api set: OneNoteApi 1.1]
@@ -107608,17 +107611,17 @@ declare namespace OneNote {
107608
107611
  */
107609
107612
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkWordCollection;
107610
107613
  /**
107611
- * 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.
107614
+ * 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.
107612
107615
  */
107613
107616
  track(): OneNote.InkWordCollection;
107614
107617
  /**
107615
- * 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.
107618
+ * 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.
107616
107619
  */
107617
107620
  untrack(): OneNote.InkWordCollection;
107618
107621
  /**
107619
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107620
- * 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.
107621
- */
107622
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107623
+ * 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.
107624
+ */
107622
107625
  toJSON(): OneNote.Interfaces.InkWordCollectionData;
107623
107626
  }
107624
107627
  /**
@@ -107631,28 +107634,28 @@ declare namespace OneNote {
107631
107634
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107632
107635
  context: RequestContext;
107633
107636
  /**
107634
- * The section groups in the notebook. Read only
107637
+ * The section groups in the notebook.
107635
107638
  *
107636
107639
  * @remarks
107637
107640
  * [Api set: OneNoteApi 1.1]
107638
107641
  */
107639
107642
  readonly sectionGroups: OneNote.SectionGroupCollection;
107640
107643
  /**
107641
- * The sections of the notebook. Read only
107644
+ * The sections of the notebook.
107642
107645
  *
107643
107646
  * @remarks
107644
107647
  * [Api set: OneNoteApi 1.1]
107645
107648
  */
107646
107649
  readonly sections: OneNote.SectionCollection;
107647
107650
  /**
107648
- * The url of the site where this notebook is located. Read only
107651
+ * The url of the site where this notebook is located. Read-only.
107649
107652
  *
107650
107653
  * @remarks
107651
107654
  * [Api set: OneNoteApi 1.1]
107652
107655
  */
107653
107656
  readonly baseUrl: string;
107654
107657
  /**
107655
- * The client url of the notebook. Read only
107658
+ * The client url of the notebook. Read-only.
107656
107659
  *
107657
107660
  * @remarks
107658
107661
  * [Api set: OneNoteApi 1.1]
@@ -107666,14 +107669,14 @@ declare namespace OneNote {
107666
107669
  */
107667
107670
  readonly id: string;
107668
107671
  /**
107669
- * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
107672
+ * True if the notebook isn't created by the user (i.e., 'Misplaced Sections').
107670
107673
  *
107671
107674
  * @remarks
107672
107675
  * [Api set: OneNoteApi 1.2]
107673
107676
  */
107674
107677
  readonly isVirtual: boolean;
107675
107678
  /**
107676
- * Gets the name of the notebook. Read-only.
107679
+ * Gets the name of the notebook.
107677
107680
  *
107678
107681
  * @remarks
107679
107682
  * [Api set: OneNoteApi 1.1]
@@ -107726,17 +107729,17 @@ declare namespace OneNote {
107726
107729
  expand?: string;
107727
107730
  }): OneNote.Notebook;
107728
107731
  /**
107729
- * 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.
107732
+ * 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.
107730
107733
  */
107731
107734
  track(): OneNote.Notebook;
107732
107735
  /**
107733
- * 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.
107736
+ * 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.
107734
107737
  */
107735
107738
  untrack(): OneNote.Notebook;
107736
107739
  /**
107737
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107738
- * 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.
107739
- */
107740
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107741
+ * 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.
107742
+ */
107740
107743
  toJSON(): OneNote.Interfaces.NotebookData;
107741
107744
  }
107742
107745
  /**
@@ -107751,7 +107754,7 @@ declare namespace OneNote {
107751
107754
  /** Gets the loaded child items in this collection. */
107752
107755
  readonly items: OneNote.Notebook[];
107753
107756
  /**
107754
- * Returns the number of notebooks in the collection. Read-only.
107757
+ * Returns the number of notebooks in the collection.
107755
107758
  *
107756
107759
  * @remarks
107757
107760
  * [Api set: OneNoteApi 1.1]
@@ -107803,17 +107806,17 @@ declare namespace OneNote {
107803
107806
  */
107804
107807
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.NotebookCollection;
107805
107808
  /**
107806
- * 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.
107809
+ * 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.
107807
107810
  */
107808
107811
  track(): OneNote.NotebookCollection;
107809
107812
  /**
107810
- * 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.
107813
+ * 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.
107811
107814
  */
107812
107815
  untrack(): OneNote.NotebookCollection;
107813
107816
  /**
107814
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107815
- * 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.
107816
- */
107817
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107818
+ * 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.
107819
+ */
107817
107820
  toJSON(): OneNote.Interfaces.NotebookCollectionData;
107818
107821
  }
107819
107822
  /**
@@ -107826,56 +107829,56 @@ declare namespace OneNote {
107826
107829
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
107827
107830
  context: RequestContext;
107828
107831
  /**
107829
- * Gets the notebook that contains the section group. Read-only.
107832
+ * Gets the notebook that contains the section group.
107830
107833
  *
107831
107834
  * @remarks
107832
107835
  * [Api set: OneNoteApi 1.1]
107833
107836
  */
107834
107837
  readonly notebook: OneNote.Notebook;
107835
107838
  /**
107836
- * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. Read-only.
107839
+ * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook.
107837
107840
  *
107838
107841
  * @remarks
107839
107842
  * [Api set: OneNoteApi 1.1]
107840
107843
  */
107841
107844
  readonly parentSectionGroup: OneNote.SectionGroup;
107842
107845
  /**
107843
- * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. Read-only.
107846
+ * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook.
107844
107847
  *
107845
107848
  * @remarks
107846
107849
  * [Api set: OneNoteApi 1.1]
107847
107850
  */
107848
107851
  readonly parentSectionGroupOrNull: OneNote.SectionGroup;
107849
107852
  /**
107850
- * The collection of section groups in the section group. Read only
107853
+ * The collection of section groups in the section group.
107851
107854
  *
107852
107855
  * @remarks
107853
107856
  * [Api set: OneNoteApi 1.1]
107854
107857
  */
107855
107858
  readonly sectionGroups: OneNote.SectionGroupCollection;
107856
107859
  /**
107857
- * The collection of sections in the section group. Read only
107860
+ * The collection of sections in the section group.
107858
107861
  *
107859
107862
  * @remarks
107860
107863
  * [Api set: OneNoteApi 1.1]
107861
107864
  */
107862
107865
  readonly sections: OneNote.SectionCollection;
107863
107866
  /**
107864
- * The client url of the section group. Read only
107867
+ * The client URL of the section group.
107865
107868
  *
107866
107869
  * @remarks
107867
107870
  * [Api set: OneNoteApi 1.1]
107868
107871
  */
107869
107872
  readonly clientUrl: string;
107870
107873
  /**
107871
- * Gets the ID of the section group. Read-only.
107874
+ * Gets the ID of the section group.
107872
107875
  *
107873
107876
  * @remarks
107874
107877
  * [Api set: OneNoteApi 1.1]
107875
107878
  */
107876
107879
  readonly id: string;
107877
107880
  /**
107878
- * Gets the name of the section group. Read-only.
107881
+ * Gets the name of the section group.
107879
107882
  *
107880
107883
  * @remarks
107881
107884
  * [Api set: OneNoteApi 1.1]
@@ -107928,17 +107931,17 @@ declare namespace OneNote {
107928
107931
  expand?: string;
107929
107932
  }): OneNote.SectionGroup;
107930
107933
  /**
107931
- * 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.
107934
+ * 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.
107932
107935
  */
107933
107936
  track(): OneNote.SectionGroup;
107934
107937
  /**
107935
- * 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.
107938
+ * 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.
107936
107939
  */
107937
107940
  untrack(): OneNote.SectionGroup;
107938
107941
  /**
107939
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107940
- * 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.
107941
- */
107942
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
107943
+ * 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.
107944
+ */
107942
107945
  toJSON(): OneNote.Interfaces.SectionGroupData;
107943
107946
  }
107944
107947
  /**
@@ -107953,7 +107956,7 @@ declare namespace OneNote {
107953
107956
  /** Gets the loaded child items in this collection. */
107954
107957
  readonly items: OneNote.SectionGroup[];
107955
107958
  /**
107956
- * Returns the number of section groups in the collection. Read-only.
107959
+ * Returns the number of section groups in the collection.
107957
107960
  *
107958
107961
  * @remarks
107959
107962
  * [Api set: OneNoteApi 1.1]
@@ -108005,17 +108008,17 @@ declare namespace OneNote {
108005
108008
  */
108006
108009
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection;
108007
108010
  /**
108008
- * 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.
108011
+ * 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.
108009
108012
  */
108010
108013
  track(): OneNote.SectionGroupCollection;
108011
108014
  /**
108012
- * 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.
108015
+ * 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.
108013
108016
  */
108014
108017
  untrack(): OneNote.SectionGroupCollection;
108015
108018
  /**
108016
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108017
- * 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.
108018
- */
108019
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108020
+ * 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.
108021
+ */
108019
108022
  toJSON(): OneNote.Interfaces.SectionGroupCollectionData;
108020
108023
  }
108021
108024
  /**
@@ -108028,21 +108031,21 @@ declare namespace OneNote {
108028
108031
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
108029
108032
  context: RequestContext;
108030
108033
  /**
108031
- * Gets the notebook that contains the section. Read-only.
108034
+ * Gets the notebook that contains the section.
108032
108035
  *
108033
108036
  * @remarks
108034
108037
  * [Api set: OneNoteApi 1.1]
108035
108038
  */
108036
108039
  readonly notebook: OneNote.Notebook;
108037
108040
  /**
108038
- * The collection of pages in the section. Read only
108041
+ * The collection of pages in the section.
108039
108042
  *
108040
108043
  * @remarks
108041
108044
  * [Api set: OneNoteApi 1.1]
108042
108045
  */
108043
108046
  readonly pages: OneNote.PageCollection;
108044
108047
  /**
108045
- * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. Read-only.
108048
+ * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook.
108046
108049
  *
108047
108050
  * @remarks
108048
108051
  * [Api set: OneNoteApi 1.1]
@@ -108056,42 +108059,42 @@ declare namespace OneNote {
108056
108059
  */
108057
108060
  readonly parentSectionGroupOrNull: OneNote.SectionGroup;
108058
108061
  /**
108059
- * The client url of the section. Read only
108062
+ * The client url of the section.
108060
108063
  *
108061
108064
  * @remarks
108062
108065
  * [Api set: OneNoteApi 1.1]
108063
108066
  */
108064
108067
  readonly clientUrl: string;
108065
108068
  /**
108066
- * Gets the ID of the section. Read-only.
108069
+ * Gets the ID of the section.
108067
108070
  *
108068
108071
  * @remarks
108069
108072
  * [Api set: OneNoteApi 1.1]
108070
108073
  */
108071
108074
  readonly id: string;
108072
108075
  /**
108073
- * True if this section is encrypted with a password. Read only
108076
+ * True if this section is encrypted with a password.
108074
108077
  *
108075
108078
  * @remarks
108076
108079
  * [Api set: OneNoteApi 1.2]
108077
108080
  */
108078
108081
  readonly isEncrypted: boolean;
108079
108082
  /**
108080
- * True if this section is locked. Read only
108083
+ * True if this section is locked.
108081
108084
  *
108082
108085
  * @remarks
108083
108086
  * [Api set: OneNoteApi 1.2]
108084
108087
  */
108085
108088
  readonly isLocked: boolean;
108086
108089
  /**
108087
- * Gets the name of the section. Read-only.
108090
+ * Gets the name of the section.
108088
108091
  *
108089
108092
  * @remarks
108090
108093
  * [Api set: OneNoteApi 1.1]
108091
108094
  */
108092
108095
  readonly name: string;
108093
108096
  /**
108094
- * The web url of the page. Read only
108097
+ * The web URL of the page.
108095
108098
  *
108096
108099
  * @remarks
108097
108100
  * [Api set: OneNoteApi 1.1]
@@ -108173,17 +108176,17 @@ declare namespace OneNote {
108173
108176
  expand?: string;
108174
108177
  }): OneNote.Section;
108175
108178
  /**
108176
- * 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.
108179
+ * 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.
108177
108180
  */
108178
108181
  track(): OneNote.Section;
108179
108182
  /**
108180
- * 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.
108183
+ * 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.
108181
108184
  */
108182
108185
  untrack(): OneNote.Section;
108183
108186
  /**
108184
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108185
- * 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.
108186
- */
108187
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108188
+ * 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.
108189
+ */
108187
108190
  toJSON(): OneNote.Interfaces.SectionData;
108188
108191
  }
108189
108192
  /**
@@ -108198,7 +108201,7 @@ declare namespace OneNote {
108198
108201
  /** Gets the loaded child items in this collection. */
108199
108202
  readonly items: OneNote.Section[];
108200
108203
  /**
108201
- * Returns the number of sections in the collection. Read-only.
108204
+ * Returns the number of sections in the collection.
108202
108205
  *
108203
108206
  * @remarks
108204
108207
  * [Api set: OneNoteApi 1.1]
@@ -108250,17 +108253,17 @@ declare namespace OneNote {
108250
108253
  */
108251
108254
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionCollection;
108252
108255
  /**
108253
- * 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.
108256
+ * 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.
108254
108257
  */
108255
108258
  track(): OneNote.SectionCollection;
108256
108259
  /**
108257
- * 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.
108260
+ * 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.
108258
108261
  */
108259
108262
  untrack(): OneNote.SectionCollection;
108260
108263
  /**
108261
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108262
- * 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.
108263
- */
108264
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108265
+ * 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.
108266
+ */
108264
108267
  toJSON(): OneNote.Interfaces.SectionCollectionData;
108265
108268
  }
108266
108269
  /**
@@ -108287,7 +108290,7 @@ declare namespace OneNote {
108287
108290
  */
108288
108291
  readonly inkAnalysisOrNull: OneNote.InkAnalysis;
108289
108292
  /**
108290
- * Gets the section that contains the page. Read-only.
108293
+ * Gets the section that contains the page.
108291
108294
  *
108292
108295
  * @remarks
108293
108296
  * [Api set: OneNoteApi 1.1]
@@ -108301,14 +108304,14 @@ declare namespace OneNote {
108301
108304
  */
108302
108305
  readonly classNotebookPageSource: string;
108303
108306
  /**
108304
- * The client url of the page. Read only
108307
+ * The client url of the page.
108305
108308
  *
108306
108309
  * @remarks
108307
108310
  * [Api set: OneNoteApi 1.1]
108308
108311
  */
108309
108312
  readonly clientUrl: string;
108310
108313
  /**
108311
- * Gets the ID of the page. Read-only.
108314
+ * Gets the ID of the page.
108312
108315
  *
108313
108316
  * @remarks
108314
108317
  * [Api set: OneNoteApi 1.1]
@@ -108329,7 +108332,7 @@ declare namespace OneNote {
108329
108332
  */
108330
108333
  title: string;
108331
108334
  /**
108332
- * The web url of the page. Read only
108335
+ * The web url of the page.
108333
108336
  *
108334
108337
  * @remarks
108335
108338
  * [Api set: OneNoteApi 1.1]
@@ -108351,11 +108354,11 @@ declare namespace OneNote {
108351
108354
  *
108352
108355
  * @param left The left position of the top, left corner of the Outline.
108353
108356
  * @param top The top position of the top, left corner of the Outline.
108354
- * @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.
108357
+ * @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.
108355
108358
  */
108356
108359
  addOutline(left: number, top: number, html: string): OneNote.Outline;
108357
108360
  /**
108358
- * Return a json string with node id and content in html format.
108361
+ * Return a JSON string with node ID and content in HTML format.
108359
108362
  *
108360
108363
  * @remarks
108361
108364
  * [Api set: OneNoteApi 1.1]
@@ -108367,7 +108370,7 @@ declare namespace OneNote {
108367
108370
  * @remarks
108368
108371
  * [Api set: OneNoteApi 1.1]
108369
108372
  *
108370
- * @param translatedContent Translated content of the page
108373
+ * @param translatedContent Translated content of the page.
108371
108374
  */
108372
108375
  applyTranslation(translatedContent: string): void;
108373
108376
  /**
@@ -108442,17 +108445,17 @@ declare namespace OneNote {
108442
108445
  expand?: string;
108443
108446
  }): OneNote.Page;
108444
108447
  /**
108445
- * 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.
108448
+ * 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.
108446
108449
  */
108447
108450
  track(): OneNote.Page;
108448
108451
  /**
108449
- * 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.
108452
+ * 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.
108450
108453
  */
108451
108454
  untrack(): OneNote.Page;
108452
108455
  /**
108453
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108454
- * 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.
108455
- */
108456
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108457
+ * 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.
108458
+ */
108456
108459
  toJSON(): OneNote.Interfaces.PageData;
108457
108460
  }
108458
108461
  /**
@@ -108467,7 +108470,7 @@ declare namespace OneNote {
108467
108470
  /** Gets the loaded child items in this collection. */
108468
108471
  readonly items: OneNote.Page[];
108469
108472
  /**
108470
- * Returns the number of pages in the collection. Read-only.
108473
+ * Returns the number of pages in the collection.
108471
108474
  *
108472
108475
  * @remarks
108473
108476
  * [Api set: OneNoteApi 1.1]
@@ -108519,17 +108522,17 @@ declare namespace OneNote {
108519
108522
  */
108520
108523
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection;
108521
108524
  /**
108522
- * 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.
108525
+ * 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.
108523
108526
  */
108524
108527
  track(): OneNote.PageCollection;
108525
108528
  /**
108526
- * 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.
108529
+ * 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.
108527
108530
  */
108528
108531
  untrack(): OneNote.PageCollection;
108529
108532
  /**
108530
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108531
- * 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.
108532
- */
108533
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108534
+ * 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.
108535
+ */
108533
108536
  toJSON(): OneNote.Interfaces.PageCollectionData;
108534
108537
  }
108535
108538
  /**
@@ -108563,14 +108566,14 @@ declare namespace OneNote {
108563
108566
  */
108564
108567
  readonly outline: OneNote.Outline;
108565
108568
  /**
108566
- * Gets the page that contains the PageContent object. Read-only.
108569
+ * Gets the page that contains the PageContent object.
108567
108570
  *
108568
108571
  * @remarks
108569
108572
  * [Api set: OneNoteApi 1.1]
108570
108573
  */
108571
108574
  readonly parentPage: OneNote.Page;
108572
108575
  /**
108573
- * Gets the ID of the PageContent object. Read-only.
108576
+ * Gets the ID of the PageContent object.
108574
108577
  *
108575
108578
  * @remarks
108576
108579
  * [Api set: OneNoteApi 1.1]
@@ -108591,7 +108594,7 @@ declare namespace OneNote {
108591
108594
  */
108592
108595
  top: number;
108593
108596
  /**
108594
- * Gets the type of the PageContent object. Read-only.
108597
+ * Gets the type of the PageContent object.
108595
108598
  *
108596
108599
  * @remarks
108597
108600
  * [Api set: OneNoteApi 1.1]
@@ -108634,17 +108637,17 @@ declare namespace OneNote {
108634
108637
  expand?: string;
108635
108638
  }): OneNote.PageContent;
108636
108639
  /**
108637
- * 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.
108640
+ * 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.
108638
108641
  */
108639
108642
  track(): OneNote.PageContent;
108640
108643
  /**
108641
- * 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.
108644
+ * 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.
108642
108645
  */
108643
108646
  untrack(): OneNote.PageContent;
108644
108647
  /**
108645
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108646
- * 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.
108647
- */
108648
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108649
+ * 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.
108650
+ */
108648
108651
  toJSON(): OneNote.Interfaces.PageContentData;
108649
108652
  }
108650
108653
  /**
@@ -108659,7 +108662,7 @@ declare namespace OneNote {
108659
108662
  /** Gets the loaded child items in this collection. */
108660
108663
  readonly items: OneNote.PageContent[];
108661
108664
  /**
108662
- * Returns the number of page contents in the collection. Read-only.
108665
+ * Returns the number of page contents in the collection.
108663
108666
  *
108664
108667
  * @remarks
108665
108668
  * [Api set: OneNoteApi 1.1]
@@ -108702,17 +108705,17 @@ declare namespace OneNote {
108702
108705
  */
108703
108706
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageContentCollection;
108704
108707
  /**
108705
- * 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.
108708
+ * 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.
108706
108709
  */
108707
108710
  track(): OneNote.PageContentCollection;
108708
108711
  /**
108709
- * 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.
108712
+ * 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.
108710
108713
  */
108711
108714
  untrack(): OneNote.PageContentCollection;
108712
108715
  /**
108713
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108714
- * 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.
108715
- */
108716
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108717
+ * 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.
108718
+ */
108716
108719
  toJSON(): OneNote.Interfaces.PageContentCollectionData;
108717
108720
  }
108718
108721
  /**
@@ -108725,21 +108728,21 @@ declare namespace OneNote {
108725
108728
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
108726
108729
  context: RequestContext;
108727
108730
  /**
108728
- * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only.
108731
+ * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page.
108729
108732
  *
108730
108733
  * @remarks
108731
108734
  * [Api set: OneNoteApi 1.1]
108732
108735
  */
108733
108736
  readonly pageContent: OneNote.PageContent;
108734
108737
  /**
108735
- * Gets the collection of Paragraph objects in the Outline. Read-only.
108738
+ * Gets the collection of Paragraph objects in the Outline.
108736
108739
  *
108737
108740
  * @remarks
108738
108741
  * [Api set: OneNoteApi 1.1]
108739
108742
  */
108740
108743
  readonly paragraphs: OneNote.ParagraphCollection;
108741
108744
  /**
108742
- * Gets the ID of the Outline object. Read-only.
108745
+ * Gets the ID of the Outline object.
108743
108746
  *
108744
108747
  * @remarks
108745
108748
  * [Api set: OneNoteApi 1.1]
@@ -108751,7 +108754,7 @@ declare namespace OneNote {
108751
108754
  * @remarks
108752
108755
  * [Api set: OneNoteApi 1.1]
108753
108756
  *
108754
- * @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.
108757
+ * @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.
108755
108758
  */
108756
108759
  appendHtml(html: string): void;
108757
108760
  /**
@@ -108814,17 +108817,17 @@ declare namespace OneNote {
108814
108817
  expand?: string;
108815
108818
  }): OneNote.Outline;
108816
108819
  /**
108817
- * 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.
108820
+ * 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.
108818
108821
  */
108819
108822
  track(): OneNote.Outline;
108820
108823
  /**
108821
- * 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.
108824
+ * 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.
108822
108825
  */
108823
108826
  untrack(): OneNote.Outline;
108824
108827
  /**
108825
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108826
- * 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.
108827
- */
108828
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
108829
+ * 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.
108830
+ */
108828
108831
  toJSON(): OneNote.Interfaces.OutlineData;
108829
108832
  }
108830
108833
  /**
@@ -108837,56 +108840,56 @@ declare namespace OneNote {
108837
108840
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
108838
108841
  context: RequestContext;
108839
108842
  /**
108840
- * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only.
108843
+ * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
108841
108844
  *
108842
108845
  * @remarks
108843
108846
  * [Api set: OneNoteApi 1.1]
108844
108847
  */
108845
108848
  readonly image: OneNote.Image;
108846
108849
  /**
108847
- * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only.
108850
+ * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.
108848
108851
  *
108849
108852
  * @remarks
108850
108853
  * [Api set: OneNoteApi 1.1]
108851
108854
  */
108852
108855
  readonly inkWords: OneNote.InkWordCollection;
108853
108856
  /**
108854
- * Gets the Outline object that contains the Paragraph. Read-only.
108857
+ * Gets the Outline object that contains the Paragraph.
108855
108858
  *
108856
108859
  * @remarks
108857
108860
  * [Api set: OneNoteApi 1.1]
108858
108861
  */
108859
108862
  readonly outline: OneNote.Outline;
108860
108863
  /**
108861
- * The collection of paragraphs under this paragraph. Read only
108864
+ * The collection of paragraphs under this paragraph.
108862
108865
  *
108863
108866
  * @remarks
108864
108867
  * [Api set: OneNoteApi 1.1]
108865
108868
  */
108866
108869
  readonly paragraphs: OneNote.ParagraphCollection;
108867
108870
  /**
108868
- * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only.
108871
+ * Gets the parent paragraph object. Throws if a parent paragraph does not exist.
108869
108872
  *
108870
108873
  * @remarks
108871
108874
  * [Api set: OneNoteApi 1.1]
108872
108875
  */
108873
108876
  readonly parentParagraph: OneNote.Paragraph;
108874
108877
  /**
108875
- * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only.
108878
+ * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
108876
108879
  *
108877
108880
  * @remarks
108878
108881
  * [Api set: OneNoteApi 1.1]
108879
108882
  */
108880
108883
  readonly parentParagraphOrNull: OneNote.Paragraph;
108881
108884
  /**
108882
- * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only.
108885
+ * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
108883
108886
  *
108884
108887
  * @remarks
108885
108888
  * [Api set: OneNoteApi 1.1]
108886
108889
  */
108887
108890
  readonly parentTableCell: OneNote.TableCell;
108888
108891
  /**
108889
- * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only.
108892
+ * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, returns null.
108890
108893
  *
108891
108894
  * @remarks
108892
108895
  * [Api set: OneNoteApi 1.1]
@@ -108900,21 +108903,21 @@ declare namespace OneNote {
108900
108903
  */
108901
108904
  readonly richText: OneNote.RichText;
108902
108905
  /**
108903
- * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table. Read-only.
108906
+ * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
108904
108907
  *
108905
108908
  * @remarks
108906
108909
  * [Api set: OneNoteApi 1.1]
108907
108910
  */
108908
108911
  readonly table: OneNote.Table;
108909
108912
  /**
108910
- * Gets the ID of the Paragraph object. Read-only.
108913
+ * Gets the ID of the Paragraph object.
108911
108914
  *
108912
108915
  * @remarks
108913
108916
  * [Api set: OneNoteApi 1.1]
108914
108917
  */
108915
108918
  readonly id: string;
108916
108919
  /**
108917
- * Gets the type of the Paragraph object. Read-only.
108920
+ * Gets the type of the Paragraph object.
108918
108921
  *
108919
108922
  * @remarks
108920
108923
  * [Api set: OneNoteApi 1.1]
@@ -108969,7 +108972,7 @@ declare namespace OneNote {
108969
108972
  * [Api set: OneNoteApi 1.1]
108970
108973
  *
108971
108974
  * @param insertLocation The location of new contents relative to the current Paragraph.
108972
- * @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.
108975
+ * @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.
108973
108976
  */
108974
108977
  insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void;
108975
108978
  /**
@@ -108995,7 +108998,7 @@ declare namespace OneNote {
108995
108998
  */
108996
108999
  insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image;
108997
109000
  /**
108998
- * Inserts the image at the specified insert location..
109001
+ * Inserts the image at the specified insert location.
108999
109002
  *
109000
109003
  * @remarks
109001
109004
  * [Api set: OneNoteApi 1.1]
@@ -109072,17 +109075,17 @@ declare namespace OneNote {
109072
109075
  expand?: string;
109073
109076
  }): OneNote.Paragraph;
109074
109077
  /**
109075
- * 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.
109078
+ * 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.
109076
109079
  */
109077
109080
  track(): OneNote.Paragraph;
109078
109081
  /**
109079
- * 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.
109082
+ * 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.
109080
109083
  */
109081
109084
  untrack(): OneNote.Paragraph;
109082
109085
  /**
109083
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109084
- * 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.
109085
- */
109086
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109087
+ * 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.
109088
+ */
109086
109089
  toJSON(): OneNote.Interfaces.ParagraphData;
109087
109090
  }
109088
109091
  /**
@@ -109097,7 +109100,7 @@ declare namespace OneNote {
109097
109100
  /** Gets the loaded child items in this collection. */
109098
109101
  readonly items: OneNote.Paragraph[];
109099
109102
  /**
109100
- * Returns the number of paragraphs in the page. Read-only.
109103
+ * Returns the number of paragraphs in the page.
109101
109104
  *
109102
109105
  * @remarks
109103
109106
  * [Api set: OneNoteApi 1.1]
@@ -109140,17 +109143,17 @@ declare namespace OneNote {
109140
109143
  */
109141
109144
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection;
109142
109145
  /**
109143
- * 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.
109146
+ * 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.
109144
109147
  */
109145
109148
  track(): OneNote.ParagraphCollection;
109146
109149
  /**
109147
- * 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.
109150
+ * 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.
109148
109151
  */
109149
109152
  untrack(): OneNote.ParagraphCollection;
109150
109153
  /**
109151
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109152
- * 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.
109153
- */
109154
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109155
+ * 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.
109156
+ */
109154
109157
  toJSON(): OneNote.Interfaces.ParagraphCollectionData;
109155
109158
  }
109156
109159
  /**
@@ -109163,21 +109166,21 @@ declare namespace OneNote {
109163
109166
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109164
109167
  context: RequestContext;
109165
109168
  /**
109166
- * Gets the Id of the NoteTag object. Read-only.
109169
+ * Gets the Id of the NoteTag object.
109167
109170
  *
109168
109171
  * @remarks
109169
109172
  * [Api set: OneNoteApi 1.1]
109170
109173
  */
109171
109174
  readonly id: string;
109172
109175
  /**
109173
- * Gets the status of the NoteTag object. Read-only.
109176
+ * Gets the status of the NoteTag object.
109174
109177
  *
109175
109178
  * @remarks
109176
109179
  * [Api set: OneNoteApi 1.1]
109177
109180
  */
109178
109181
  readonly status: OneNote.NoteTagStatus | "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved";
109179
109182
  /**
109180
- * Gets the type of the NoteTag object. Read-only.
109183
+ * Gets the type of the NoteTag object.
109181
109184
  *
109182
109185
  * @remarks
109183
109186
  * [Api set: OneNoteApi 1.1]
@@ -109205,17 +109208,17 @@ declare namespace OneNote {
109205
109208
  expand?: string;
109206
109209
  }): OneNote.NoteTag;
109207
109210
  /**
109208
- * 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.
109211
+ * 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.
109209
109212
  */
109210
109213
  track(): OneNote.NoteTag;
109211
109214
  /**
109212
- * 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.
109215
+ * 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.
109213
109216
  */
109214
109217
  untrack(): OneNote.NoteTag;
109215
109218
  /**
109216
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109217
- * 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.
109218
- */
109219
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109220
+ * 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.
109221
+ */
109219
109222
  toJSON(): OneNote.Interfaces.NoteTagData;
109220
109223
  }
109221
109224
  /**
@@ -109228,21 +109231,21 @@ declare namespace OneNote {
109228
109231
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109229
109232
  context: RequestContext;
109230
109233
  /**
109231
- * Gets the Paragraph object that contains the RichText object. Read-only.
109234
+ * Gets the Paragraph object that contains the RichText object.
109232
109235
  *
109233
109236
  * @remarks
109234
109237
  * [Api set: OneNoteApi 1.1]
109235
109238
  */
109236
109239
  readonly paragraph: OneNote.Paragraph;
109237
109240
  /**
109238
- * Gets the ID of the RichText object. Read-only.
109241
+ * Gets the ID of the RichText object.
109239
109242
  *
109240
109243
  * @remarks
109241
109244
  * [Api set: OneNoteApi 1.1]
109242
109245
  */
109243
109246
  readonly id: string;
109244
109247
  /**
109245
- * The language id of the text. Read-only.
109248
+ * The language id of the text.
109246
109249
  *
109247
109250
  * @remarks
109248
109251
  * [Api set: OneNoteApi 1.1]
@@ -109263,7 +109266,7 @@ declare namespace OneNote {
109263
109266
  */
109264
109267
  readonly text: string;
109265
109268
  /**
109266
- * Get the HTML of the rich text
109269
+ * Gets the HTML of the rich text.
109267
109270
  *
109268
109271
  * @remarks
109269
109272
  * [Api set: OneNoteApi 1.1]
@@ -109292,17 +109295,17 @@ declare namespace OneNote {
109292
109295
  expand?: string;
109293
109296
  }): OneNote.RichText;
109294
109297
  /**
109295
- * 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.
109298
+ * 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.
109296
109299
  */
109297
109300
  track(): OneNote.RichText;
109298
109301
  /**
109299
- * 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.
109302
+ * 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.
109300
109303
  */
109301
109304
  untrack(): OneNote.RichText;
109302
109305
  /**
109303
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109304
- * 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.
109305
- */
109306
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109307
+ * 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.
109308
+ */
109306
109309
  toJSON(): OneNote.Interfaces.RichTextData;
109307
109310
  }
109308
109311
  /**
@@ -109315,14 +109318,14 @@ declare namespace OneNote {
109315
109318
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109316
109319
  context: RequestContext;
109317
109320
  /**
109318
- * 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.
109321
+ * 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.
109319
109322
  *
109320
109323
  * @remarks
109321
109324
  * [Api set: OneNoteApi 1.1]
109322
109325
  */
109323
109326
  readonly pageContent: OneNote.PageContent;
109324
109327
  /**
109325
- * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. Read-only.
109328
+ * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph.
109326
109329
  *
109327
109330
  * @remarks
109328
109331
  * [Api set: OneNoteApi 1.1]
@@ -109350,7 +109353,7 @@ declare namespace OneNote {
109350
109353
  */
109351
109354
  hyperlink: string;
109352
109355
  /**
109353
- * Gets the ID of the Image object. Read-only.
109356
+ * Gets the ID of the Image object.
109354
109357
  *
109355
109358
  * @remarks
109356
109359
  * [Api set: OneNoteApi 1.1]
@@ -109408,17 +109411,17 @@ declare namespace OneNote {
109408
109411
  expand?: string;
109409
109412
  }): OneNote.Image;
109410
109413
  /**
109411
- * 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.
109414
+ * 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.
109412
109415
  */
109413
109416
  track(): OneNote.Image;
109414
109417
  /**
109415
- * 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.
109418
+ * 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.
109416
109419
  */
109417
109420
  untrack(): OneNote.Image;
109418
109421
  /**
109419
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109420
- * 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.
109421
- */
109422
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109423
+ * 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.
109424
+ */
109422
109425
  toJSON(): OneNote.Interfaces.ImageData;
109423
109426
  }
109424
109427
  /**
@@ -109431,14 +109434,14 @@ declare namespace OneNote {
109431
109434
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109432
109435
  context: RequestContext;
109433
109436
  /**
109434
- * Gets the Paragraph object that contains the Table object. Read-only.
109437
+ * Gets the Paragraph object that contains the Table object.
109435
109438
  *
109436
109439
  * @remarks
109437
109440
  * [Api set: OneNoteApi 1.1]
109438
109441
  */
109439
109442
  readonly paragraph: OneNote.Paragraph;
109440
109443
  /**
109441
- * Gets all of the table rows. Read-only.
109444
+ * Gets all of the table rows.
109442
109445
  *
109443
109446
  * @remarks
109444
109447
  * [Api set: OneNoteApi 1.1]
@@ -109459,7 +109462,7 @@ declare namespace OneNote {
109459
109462
  */
109460
109463
  readonly columnCount: number;
109461
109464
  /**
109462
- * Gets the ID of the table. Read-only.
109465
+ * Gets the ID of the table.
109463
109466
  *
109464
109467
  * @remarks
109465
109468
  * [Api set: OneNoteApi 1.1]
@@ -109565,17 +109568,17 @@ declare namespace OneNote {
109565
109568
  expand?: string;
109566
109569
  }): OneNote.Table;
109567
109570
  /**
109568
- * 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.
109571
+ * 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.
109569
109572
  */
109570
109573
  track(): OneNote.Table;
109571
109574
  /**
109572
- * 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.
109575
+ * 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.
109573
109576
  */
109574
109577
  untrack(): OneNote.Table;
109575
109578
  /**
109576
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109577
- * 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.
109578
- */
109579
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109580
+ * 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.
109581
+ */
109579
109582
  toJSON(): OneNote.Interfaces.TableData;
109580
109583
  }
109581
109584
  /**
@@ -109588,35 +109591,35 @@ declare namespace OneNote {
109588
109591
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109589
109592
  context: RequestContext;
109590
109593
  /**
109591
- * Gets the cells in the row. Read-only.
109594
+ * Gets the cells in the row.
109592
109595
  *
109593
109596
  * @remarks
109594
109597
  * [Api set: OneNoteApi 1.1]
109595
109598
  */
109596
109599
  readonly cells: OneNote.TableCellCollection;
109597
109600
  /**
109598
- * Gets the parent table. Read-only.
109601
+ * Gets the parent table.
109599
109602
  *
109600
109603
  * @remarks
109601
109604
  * [Api set: OneNoteApi 1.1]
109602
109605
  */
109603
109606
  readonly parentTable: OneNote.Table;
109604
109607
  /**
109605
- * Gets the number of cells in the row. Read-only.
109608
+ * Gets the number of cells in the row.
109606
109609
  *
109607
109610
  * @remarks
109608
109611
  * [Api set: OneNoteApi 1.1]
109609
109612
  */
109610
109613
  readonly cellCount: number;
109611
109614
  /**
109612
- * Gets the ID of the row. Read-only.
109615
+ * Gets the ID of the row.
109613
109616
  *
109614
109617
  * @remarks
109615
109618
  * [Api set: OneNoteApi 1.1]
109616
109619
  */
109617
109620
  readonly id: string;
109618
109621
  /**
109619
- * Gets the index of the row in its parent table. Read-only.
109622
+ * Gets the index of the row in its parent table.
109620
109623
  *
109621
109624
  * @remarks
109622
109625
  * [Api set: OneNoteApi 1.1]
@@ -109679,17 +109682,17 @@ declare namespace OneNote {
109679
109682
  expand?: string;
109680
109683
  }): OneNote.TableRow;
109681
109684
  /**
109682
- * 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.
109685
+ * 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.
109683
109686
  */
109684
109687
  track(): OneNote.TableRow;
109685
109688
  /**
109686
- * 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.
109689
+ * 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.
109687
109690
  */
109688
109691
  untrack(): OneNote.TableRow;
109689
109692
  /**
109690
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109691
- * 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.
109692
- */
109693
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109694
+ * 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.
109695
+ */
109693
109696
  toJSON(): OneNote.Interfaces.TableRowData;
109694
109697
  }
109695
109698
  /**
@@ -109704,7 +109707,7 @@ declare namespace OneNote {
109704
109707
  /** Gets the loaded child items in this collection. */
109705
109708
  readonly items: OneNote.TableRow[];
109706
109709
  /**
109707
- * Returns the number of table rows in this collection. Read-only.
109710
+ * Returns the number of table rows in this collection.
109708
109711
  *
109709
109712
  * @remarks
109710
109713
  * [Api set: OneNoteApi 1.1]
@@ -109747,17 +109750,17 @@ declare namespace OneNote {
109747
109750
  */
109748
109751
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableRowCollection;
109749
109752
  /**
109750
- * 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.
109753
+ * 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.
109751
109754
  */
109752
109755
  track(): OneNote.TableRowCollection;
109753
109756
  /**
109754
- * 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.
109757
+ * 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.
109755
109758
  */
109756
109759
  untrack(): OneNote.TableRowCollection;
109757
109760
  /**
109758
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109759
- * 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.
109760
- */
109761
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109762
+ * 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.
109763
+ */
109761
109764
  toJSON(): OneNote.Interfaces.TableRowCollectionData;
109762
109765
  }
109763
109766
  /**
@@ -109770,42 +109773,42 @@ declare namespace OneNote {
109770
109773
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
109771
109774
  context: RequestContext;
109772
109775
  /**
109773
- * Gets the collection of Paragraph objects in the TableCell. Read-only.
109776
+ * Gets the collection of Paragraph objects in the TableCell.
109774
109777
  *
109775
109778
  * @remarks
109776
109779
  * [Api set: OneNoteApi 1.1]
109777
109780
  */
109778
109781
  readonly paragraphs: OneNote.ParagraphCollection;
109779
109782
  /**
109780
- * Gets the parent row of the cell. Read-only.
109783
+ * Gets the parent row of the cell.
109781
109784
  *
109782
109785
  * @remarks
109783
109786
  * [Api set: OneNoteApi 1.1]
109784
109787
  */
109785
109788
  readonly parentRow: OneNote.TableRow;
109786
109789
  /**
109787
- * Gets the index of the cell in its row. Read-only.
109790
+ * Gets the index of the cell in its row.
109788
109791
  *
109789
109792
  * @remarks
109790
109793
  * [Api set: OneNoteApi 1.1]
109791
109794
  */
109792
109795
  readonly cellIndex: number;
109793
109796
  /**
109794
- * Gets the ID of the cell. Read-only.
109797
+ * Gets the ID of the cell.
109795
109798
  *
109796
109799
  * @remarks
109797
109800
  * [Api set: OneNoteApi 1.1]
109798
109801
  */
109799
109802
  readonly id: string;
109800
109803
  /**
109801
- * Gets the index of the cell's row in the table. Read-only.
109804
+ * Gets the index of the cell's row in the table.
109802
109805
  *
109803
109806
  * @remarks
109804
109807
  * [Api set: OneNoteApi 1.1]
109805
109808
  */
109806
109809
  readonly rowIndex: number;
109807
109810
  /**
109808
- * Gets and sets the shading color of the cell
109811
+ * Gets and sets the shading color of the cell.
109809
109812
  *
109810
109813
  * @remarks
109811
109814
  * [Api set: OneNoteApi 1.1]
@@ -109825,7 +109828,7 @@ declare namespace OneNote {
109825
109828
  * @remarks
109826
109829
  * [Api set: OneNoteApi 1.1]
109827
109830
  *
109828
- * @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.
109831
+ * @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.
109829
109832
  */
109830
109833
  appendHtml(html: string): void;
109831
109834
  /**
@@ -109888,17 +109891,17 @@ declare namespace OneNote {
109888
109891
  expand?: string;
109889
109892
  }): OneNote.TableCell;
109890
109893
  /**
109891
- * 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.
109894
+ * 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.
109892
109895
  */
109893
109896
  track(): OneNote.TableCell;
109894
109897
  /**
109895
- * 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.
109898
+ * 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.
109896
109899
  */
109897
109900
  untrack(): OneNote.TableCell;
109898
109901
  /**
109899
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109900
- * 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.
109901
- */
109902
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109903
+ * 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.
109904
+ */
109902
109905
  toJSON(): OneNote.Interfaces.TableCellData;
109903
109906
  }
109904
109907
  /**
@@ -109913,7 +109916,7 @@ declare namespace OneNote {
109913
109916
  /** Gets the loaded child items in this collection. */
109914
109917
  readonly items: OneNote.TableCell[];
109915
109918
  /**
109916
- * Returns the number of tablecells in this collection. Read-only.
109919
+ * Returns the number of tablecells in this collection.
109917
109920
  *
109918
109921
  * @remarks
109919
109922
  * [Api set: OneNoteApi 1.1]
@@ -109956,17 +109959,17 @@ declare namespace OneNote {
109956
109959
  */
109957
109960
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.TableCellCollection;
109958
109961
  /**
109959
- * 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.
109962
+ * 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.
109960
109963
  */
109961
109964
  track(): OneNote.TableCellCollection;
109962
109965
  /**
109963
- * 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.
109966
+ * 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.
109964
109967
  */
109965
109968
  untrack(): OneNote.TableCellCollection;
109966
109969
  /**
109967
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109968
- * 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.
109969
- */
109970
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
109971
+ * 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.
109972
+ */
109970
109973
  toJSON(): OneNote.Interfaces.TableCellCollectionData;
109971
109974
  }
109972
109975
  /**
@@ -109977,14 +109980,14 @@ declare namespace OneNote {
109977
109980
  */
109978
109981
  interface ImageOcrData {
109979
109982
  /**
109980
- * Represents the OCR language, with values such as EN-US
109983
+ * Represents the OCR language, with values such as EN-US.
109981
109984
  *
109982
109985
  * @remarks
109983
109986
  * [Api set: OneNoteApi 1.1]
109984
109987
  */
109985
109988
  ocrLanguageId: string;
109986
109989
  /**
109987
- * Represents the text obtained by OCR of the image
109990
+ * Represents the text obtained by OCR of the image.
109988
109991
  *
109989
109992
  * @remarks
109990
109993
  * [Api set: OneNoteApi 1.1]
@@ -109999,14 +110002,14 @@ declare namespace OneNote {
109999
110002
  */
110000
110003
  interface InkStrokePointer {
110001
110004
  /**
110002
- * Represents the id of the page content object corresponding to this stroke
110005
+ * Represents the ID of the page content object corresponding to this stroke.
110003
110006
  *
110004
110007
  * @remarks
110005
110008
  * [Api set: OneNoteApi 1.1]
110006
110009
  */
110007
110010
  contentId: string;
110008
110011
  /**
110009
- * Represents the id of the ink stroke
110012
+ * Represents the ID of the ink stroke.
110010
110013
  *
110011
110014
  * @remarks
110012
110015
  * [Api set: OneNoteApi 1.1]
@@ -110021,40 +110024,35 @@ declare namespace OneNote {
110021
110024
  */
110022
110025
  interface ParagraphInfo {
110023
110026
  /**
110024
- * //
110025
- Bullet list type of paragraph
110027
+ * Bullet list type of paragraph.
110026
110028
  *
110027
110029
  * @remarks
110028
110030
  * [Api set: OneNoteApi 1.1]
110029
110031
  */
110030
110032
  bulletType: string;
110031
110033
  /**
110032
- * //
110033
- Level of indentation of the paragraph
110034
+ * Level of indentation of the paragraph.
110034
110035
  *
110035
110036
  * @remarks
110036
110037
  * [Api set: OneNoteApi 1.8]
110037
110038
  */
110038
110039
  indentationLevel: number;
110039
110040
  /**
110040
- * //
110041
- Index of paragraph in a list
110041
+ * Index of paragraph in a list.
110042
110042
  *
110043
110043
  * @remarks
110044
110044
  * [Api set: OneNoteApi 1.1]
110045
110045
  */
110046
110046
  index: number;
110047
110047
  /**
110048
- * //
110049
- Type of list in paragraph
110048
+ * Type of list in paragraph.
110050
110049
  *
110051
110050
  * @remarks
110052
110051
  * [Api set: OneNoteApi 1.1]
110053
110052
  */
110054
110053
  listType: OneNote.ListType | "None" | "Number" | "Bullet";
110055
110054
  /**
110056
- * //
110057
- Numbered list type of paragraph
110055
+ * Numbered list type of paragraph.
110058
110056
  *
110059
110057
  * @remarks
110060
110058
  * [Api set: OneNoteApi 1.1]
@@ -110700,10 +110698,10 @@ declare namespace OneNote {
110700
110698
  */
110701
110699
  $skip?: number;
110702
110700
  }
110703
- /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
110701
+ /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */
110704
110702
  interface ApplicationUpdateData {
110705
110703
  }
110706
- /** An interface for updating data on the InkAnalysis object, for use in `inkAnalysis.set({ ... })`. */
110704
+ /** An interface for updating data on the `InkAnalysis` object, for use in `inkAnalysis.set({ ... })`. */
110707
110705
  interface InkAnalysisUpdateData {
110708
110706
  /**
110709
110707
  * Gets the parent page object.
@@ -110713,7 +110711,7 @@ declare namespace OneNote {
110713
110711
  */
110714
110712
  page?: OneNote.Interfaces.PageUpdateData;
110715
110713
  }
110716
- /** An interface for updating data on the InkAnalysisParagraph object, for use in `inkAnalysisParagraph.set({ ... })`. */
110714
+ /** An interface for updating data on the `InkAnalysisParagraph` object, for use in `inkAnalysisParagraph.set({ ... })`. */
110717
110715
  interface InkAnalysisParagraphUpdateData {
110718
110716
  /**
110719
110717
  * Reference to the parent InkAnalysisPage.
@@ -110723,11 +110721,11 @@ declare namespace OneNote {
110723
110721
  */
110724
110722
  inkAnalysis?: OneNote.Interfaces.InkAnalysisUpdateData;
110725
110723
  }
110726
- /** An interface for updating data on the InkAnalysisParagraphCollection object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */
110724
+ /** An interface for updating data on the `InkAnalysisParagraphCollection` object, for use in `inkAnalysisParagraphCollection.set({ ... })`. */
110727
110725
  interface InkAnalysisParagraphCollectionUpdateData {
110728
110726
  items?: OneNote.Interfaces.InkAnalysisParagraphData[];
110729
110727
  }
110730
- /** An interface for updating data on the InkAnalysisLine object, for use in `inkAnalysisLine.set({ ... })`. */
110728
+ /** An interface for updating data on the `InkAnalysisLine` object, for use in `inkAnalysisLine.set({ ... })`. */
110731
110729
  interface InkAnalysisLineUpdateData {
110732
110730
  /**
110733
110731
  * Reference to the parent InkAnalysisParagraph.
@@ -110737,11 +110735,11 @@ declare namespace OneNote {
110737
110735
  */
110738
110736
  paragraph?: OneNote.Interfaces.InkAnalysisParagraphUpdateData;
110739
110737
  }
110740
- /** An interface for updating data on the InkAnalysisLineCollection object, for use in `inkAnalysisLineCollection.set({ ... })`. */
110738
+ /** An interface for updating data on the `InkAnalysisLineCollection` object, for use in `inkAnalysisLineCollection.set({ ... })`. */
110741
110739
  interface InkAnalysisLineCollectionUpdateData {
110742
110740
  items?: OneNote.Interfaces.InkAnalysisLineData[];
110743
110741
  }
110744
- /** An interface for updating data on the InkAnalysisWord object, for use in `inkAnalysisWord.set({ ... })`. */
110742
+ /** An interface for updating data on the `InkAnalysisWord` object, for use in `inkAnalysisWord.set({ ... })`. */
110745
110743
  interface InkAnalysisWordUpdateData {
110746
110744
  /**
110747
110745
  * Reference to the parent InkAnalysisLine.
@@ -110751,38 +110749,38 @@ declare namespace OneNote {
110751
110749
  */
110752
110750
  line?: OneNote.Interfaces.InkAnalysisLineUpdateData;
110753
110751
  }
110754
- /** An interface for updating data on the InkAnalysisWordCollection object, for use in `inkAnalysisWordCollection.set({ ... })`. */
110752
+ /** An interface for updating data on the `InkAnalysisWordCollection` object, for use in `inkAnalysisWordCollection.set({ ... })`. */
110755
110753
  interface InkAnalysisWordCollectionUpdateData {
110756
110754
  items?: OneNote.Interfaces.InkAnalysisWordData[];
110757
110755
  }
110758
- /** An interface for updating data on the InkStrokeCollection object, for use in `inkStrokeCollection.set({ ... })`. */
110756
+ /** An interface for updating data on the `InkStrokeCollection` object, for use in `inkStrokeCollection.set({ ... })`. */
110759
110757
  interface InkStrokeCollectionUpdateData {
110760
110758
  items?: OneNote.Interfaces.InkStrokeData[];
110761
110759
  }
110762
- /** An interface for updating data on the PointCollection object, for use in `pointCollection.set({ ... })`. */
110760
+ /** An interface for updating data on the `PointCollection` object, for use in `pointCollection.set({ ... })`. */
110763
110761
  interface PointCollectionUpdateData {
110764
110762
  items?: OneNote.Interfaces.PointData[];
110765
110763
  }
110766
- /** An interface for updating data on the InkWordCollection object, for use in `inkWordCollection.set({ ... })`. */
110764
+ /** An interface for updating data on the `InkWordCollection` object, for use in `inkWordCollection.set({ ... })`. */
110767
110765
  interface InkWordCollectionUpdateData {
110768
110766
  items?: OneNote.Interfaces.InkWordData[];
110769
110767
  }
110770
- /** An interface for updating data on the NotebookCollection object, for use in `notebookCollection.set({ ... })`. */
110768
+ /** An interface for updating data on the `NotebookCollection` object, for use in `notebookCollection.set({ ... })`. */
110771
110769
  interface NotebookCollectionUpdateData {
110772
110770
  items?: OneNote.Interfaces.NotebookData[];
110773
110771
  }
110774
- /** An interface for updating data on the SectionGroupCollection object, for use in `sectionGroupCollection.set({ ... })`. */
110772
+ /** An interface for updating data on the `SectionGroupCollection` object, for use in `sectionGroupCollection.set({ ... })`. */
110775
110773
  interface SectionGroupCollectionUpdateData {
110776
110774
  items?: OneNote.Interfaces.SectionGroupData[];
110777
110775
  }
110778
- /** An interface for updating data on the SectionCollection object, for use in `sectionCollection.set({ ... })`. */
110776
+ /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */
110779
110777
  interface SectionCollectionUpdateData {
110780
110778
  items?: OneNote.Interfaces.SectionData[];
110781
110779
  }
110782
- /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
110780
+ /** An interface for updating data on the `Page` object, for use in `page.set({ ... })`. */
110783
110781
  interface PageUpdateData {
110784
110782
  /**
110785
- * Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
110783
+ * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only.
110786
110784
  *
110787
110785
  * @remarks
110788
110786
  * [Api set: OneNoteApi 1.1]
@@ -110803,14 +110801,14 @@ declare namespace OneNote {
110803
110801
  */
110804
110802
  title?: string;
110805
110803
  }
110806
- /** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */
110804
+ /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */
110807
110805
  interface PageCollectionUpdateData {
110808
110806
  items?: OneNote.Interfaces.PageData[];
110809
110807
  }
110810
- /** An interface for updating data on the PageContent object, for use in `pageContent.set({ ... })`. */
110808
+ /** An interface for updating data on the `PageContent` object, for use in `pageContent.set({ ... })`. */
110811
110809
  interface PageContentUpdateData {
110812
110810
  /**
110813
- * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
110811
+ * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
110814
110812
  *
110815
110813
  * @remarks
110816
110814
  * [Api set: OneNoteApi 1.1]
@@ -110831,11 +110829,11 @@ declare namespace OneNote {
110831
110829
  */
110832
110830
  top?: number;
110833
110831
  }
110834
- /** An interface for updating data on the PageContentCollection object, for use in `pageContentCollection.set({ ... })`. */
110832
+ /** An interface for updating data on the `PageContentCollection` object, for use in `pageContentCollection.set({ ... })`. */
110835
110833
  interface PageContentCollectionUpdateData {
110836
110834
  items?: OneNote.Interfaces.PageContentData[];
110837
110835
  }
110838
- /** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
110836
+ /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */
110839
110837
  interface ParagraphUpdateData {
110840
110838
  /**
110841
110839
  * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
@@ -110856,7 +110854,7 @@ declare namespace OneNote {
110856
110854
  interface ParagraphCollectionUpdateData {
110857
110855
  items?: OneNote.Interfaces.ParagraphData[];
110858
110856
  }
110859
- /** An interface for updating data on the Image object, for use in `image.set({ ... })`. */
110857
+ /** An interface for updating data on the `Image` object, for use in `image.set({ ... })`. */
110860
110858
  interface ImageUpdateData {
110861
110859
  /**
110862
110860
  * Gets or sets the description of the Image.
@@ -110887,7 +110885,7 @@ declare namespace OneNote {
110887
110885
  */
110888
110886
  width?: number;
110889
110887
  }
110890
- /** An interface for updating data on the Table object, for use in `table.set({ ... })`. */
110888
+ /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
110891
110889
  interface TableUpdateData {
110892
110890
  /**
110893
110891
  * 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 {
110897
110895
  */
110898
110896
  borderVisible?: boolean;
110899
110897
  }
110900
- /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */
110898
+ /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */
110901
110899
  interface TableRowCollectionUpdateData {
110902
110900
  items?: OneNote.Interfaces.TableRowData[];
110903
110901
  }
110904
- /** An interface for updating data on the TableCell object, for use in `tableCell.set({ ... })`. */
110902
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
110905
110903
  interface TableCellUpdateData {
110906
110904
  /**
110907
110905
  * Gets and sets the shading color of the cell
@@ -110911,7 +110909,7 @@ declare namespace OneNote {
110911
110909
  */
110912
110910
  shadingColor?: string;
110913
110911
  }
110914
- /** An interface for updating data on the TableCellCollection object, for use in `tableCellCollection.set({ ... })`. */
110912
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
110915
110913
  interface TableCellCollectionUpdateData {
110916
110914
  items?: OneNote.Interfaces.TableCellData[];
110917
110915
  }
@@ -111132,21 +111130,21 @@ declare namespace OneNote {
111132
111130
  */
111133
111131
  sectionGroups?: OneNote.Interfaces.SectionGroupData[];
111134
111132
  /**
111135
- * The sections of the notebook. Read only
111133
+ * The sections of the notebook. Read-only.
111136
111134
  *
111137
111135
  * @remarks
111138
111136
  * [Api set: OneNoteApi 1.1]
111139
111137
  */
111140
111138
  sections?: OneNote.Interfaces.SectionData[];
111141
111139
  /**
111142
- * The url of the site where this notebook is located. Read only
111140
+ * The URL of the site where this notebook is located. Read-only.
111143
111141
  *
111144
111142
  * @remarks
111145
111143
  * [Api set: OneNoteApi 1.1]
111146
111144
  */
111147
111145
  baseUrl?: string;
111148
111146
  /**
111149
- * The client url of the notebook. Read only
111147
+ * The client URL of the notebook. Read-only.
111150
111148
  *
111151
111149
  * @remarks
111152
111150
  * [Api set: OneNoteApi 1.1]
@@ -111160,7 +111158,7 @@ declare namespace OneNote {
111160
111158
  */
111161
111159
  id?: string;
111162
111160
  /**
111163
- * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
111161
+ '* True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
111164
111162
  *
111165
111163
  * @remarks
111166
111164
  * [Api set: OneNoteApi 1.2]
@@ -111181,21 +111179,21 @@ declare namespace OneNote {
111181
111179
  /** An interface describing the data returned by calling `sectionGroup.toJSON()`. */
111182
111180
  interface SectionGroupData {
111183
111181
  /**
111184
- * The collection of section groups in the section group. Read only
111182
+ * The collection of section groups in the section group. Read-only.
111185
111183
  *
111186
111184
  * @remarks
111187
111185
  * [Api set: OneNoteApi 1.1]
111188
111186
  */
111189
111187
  sectionGroups?: OneNote.Interfaces.SectionGroupData[];
111190
111188
  /**
111191
- * The collection of sections in the section group. Read only
111189
+ * The collection of sections in the section group. Read-only.
111192
111190
  *
111193
111191
  * @remarks
111194
111192
  * [Api set: OneNoteApi 1.1]
111195
111193
  */
111196
111194
  sections?: OneNote.Interfaces.SectionData[];
111197
111195
  /**
111198
- * The client url of the section group. Read only
111196
+ * The client url of the section group. Read-only.
111199
111197
  *
111200
111198
  * @remarks
111201
111199
  * [Api set: OneNoteApi 1.1]
@@ -111223,14 +111221,14 @@ declare namespace OneNote {
111223
111221
  /** An interface describing the data returned by calling `section.toJSON()`. */
111224
111222
  interface SectionData {
111225
111223
  /**
111226
- * The collection of pages in the section. Read only
111224
+ * The collection of pages in the section. Read-only.
111227
111225
  *
111228
111226
  * @remarks
111229
111227
  * [Api set: OneNoteApi 1.1]
111230
111228
  */
111231
111229
  pages?: OneNote.Interfaces.PageData[];
111232
111230
  /**
111233
- * The client url of the section. Read only
111231
+ * The client URL of the section. Read-only.
111234
111232
  *
111235
111233
  * @remarks
111236
111234
  * [Api set: OneNoteApi 1.1]
@@ -111244,14 +111242,14 @@ declare namespace OneNote {
111244
111242
  */
111245
111243
  id?: string;
111246
111244
  /**
111247
- * True if this section is encrypted with a password. Read only
111245
+ * True if this section is encrypted with a password. Read-only.
111248
111246
  *
111249
111247
  * @remarks
111250
111248
  * [Api set: OneNoteApi 1.2]
111251
111249
  */
111252
111250
  isEncrypted?: boolean;
111253
111251
  /**
111254
- * True if this section is locked. Read only
111252
+ * True if this section is locked. Read-only.
111255
111253
  *
111256
111254
  * @remarks
111257
111255
  * [Api set: OneNoteApi 1.2]
@@ -111265,7 +111263,7 @@ declare namespace OneNote {
111265
111263
  */
111266
111264
  name?: string;
111267
111265
  /**
111268
- * The web url of the page. Read only
111266
+ * The web URL of the page. Read-only.
111269
111267
  *
111270
111268
  * @remarks
111271
111269
  * [Api set: OneNoteApi 1.1]
@@ -111279,18 +111277,18 @@ declare namespace OneNote {
111279
111277
  /** An interface describing the data returned by calling `page.toJSON()`. */
111280
111278
  interface PageData {
111281
111279
  /**
111282
- * The collection of PageContent objects on the page. Read only
111283
- *
111284
- * @remarks
111285
- * [Api set: OneNoteApi 1.1]
111286
- */
111280
+ * The collection of PageContent objects on the page. Read only
111281
+ *
111282
+ * @remarks
111283
+ * [Api set: OneNoteApi 1.1]
111284
+ */
111287
111285
  contents?: OneNote.Interfaces.PageContentData[];
111288
111286
  /**
111289
- * Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
111290
- *
111291
- * @remarks
111292
- * [Api set: OneNoteApi 1.1]
111293
- */
111287
+ * Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only.
111288
+ *
111289
+ * @remarks
111290
+ * [Api set: OneNoteApi 1.1]
111291
+ */
111294
111292
  inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisData;
111295
111293
  /**
111296
111294
  * Gets the ClassNotebookPageSource to the page.
@@ -111328,7 +111326,7 @@ declare namespace OneNote {
111328
111326
  */
111329
111327
  title?: string;
111330
111328
  /**
111331
- * The web url of the page. Read only
111329
+ * The web URL of the page. Read-only.
111332
111330
  *
111333
111331
  * @remarks
111334
111332
  * [Api set: OneNoteApi 1.1]
@@ -111342,21 +111340,21 @@ declare namespace OneNote {
111342
111340
  /** An interface describing the data returned by calling `pageContent.toJSON()`. */
111343
111341
  interface PageContentData {
111344
111342
  /**
111345
- * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
111343
+ * Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
111346
111344
  *
111347
111345
  * @remarks
111348
111346
  * [Api set: OneNoteApi 1.1]
111349
111347
  */
111350
111348
  image?: OneNote.Interfaces.ImageData;
111351
111349
  /**
111352
- * Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink.
111350
+ * Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
111353
111351
  *
111354
111352
  * @remarks
111355
111353
  * [Api set: OneNoteApi 1.1]
111356
111354
  */
111357
111355
  ink?: OneNote.Interfaces.FloatingInkData;
111358
111356
  /**
111359
- * Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline.
111357
+ * Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.
111360
111358
  *
111361
111359
  * @remarks
111362
111360
  * [Api set: OneNoteApi 1.1]
@@ -111415,14 +111413,14 @@ declare namespace OneNote {
111415
111413
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
111416
111414
  interface ParagraphData {
111417
111415
  /**
111418
- * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only.
111416
+ * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image. Read-only.
111419
111417
  *
111420
111418
  * @remarks
111421
111419
  * [Api set: OneNoteApi 1.1]
111422
111420
  */
111423
111421
  image?: OneNote.Interfaces.ImageData;
111424
111422
  /**
111425
- * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink. Read-only.
111423
+ * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink. Read-only.
111426
111424
  *
111427
111425
  * @remarks
111428
111426
  * [Api set: OneNoteApi 1.1]
@@ -111502,7 +111500,7 @@ declare namespace OneNote {
111502
111500
  */
111503
111501
  id?: string;
111504
111502
  /**
111505
- * The language id of the text. Read-only.
111503
+ * The language ID of the text. Read-only.
111506
111504
  *
111507
111505
  * @remarks
111508
111506
  * [Api set: OneNoteApi 1.1]
@@ -111672,7 +111670,7 @@ declare namespace OneNote {
111672
111670
  */
111673
111671
  rowIndex?: number;
111674
111672
  /**
111675
- * Gets and sets the shading color of the cell
111673
+ * Gets and sets the shading color of the cell.
111676
111674
  *
111677
111675
  * @remarks
111678
111676
  * [Api set: OneNoteApi 1.1]
@@ -111691,15 +111689,15 @@ declare namespace OneNote {
111691
111689
  */
111692
111690
  interface ApplicationLoadOptions {
111693
111691
  /**
111694
- 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`).
111692
+ 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`).
111695
111693
  */
111696
111694
  $all?: boolean;
111697
111695
  /**
111698
- * 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.
111699
- *
111700
- * @remarks
111701
- * [Api set: OneNoteApi 1.1]
111702
- */
111696
+ * 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.
111697
+ *
111698
+ * @remarks
111699
+ * [Api set: OneNoteApi 1.1]
111700
+ */
111703
111701
  notebooks?: OneNote.Interfaces.NotebookCollectionLoadOptions;
111704
111702
  }
111705
111703
  /**
@@ -111736,7 +111734,7 @@ declare namespace OneNote {
111736
111734
  */
111737
111735
  interface InkAnalysisParagraphLoadOptions {
111738
111736
  /**
111739
- 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`).
111737
+ 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`).
111740
111738
  */
111741
111739
  $all?: boolean;
111742
111740
  /**
@@ -111769,7 +111767,7 @@ declare namespace OneNote {
111769
111767
  */
111770
111768
  interface InkAnalysisParagraphCollectionLoadOptions {
111771
111769
  /**
111772
- 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`).
111770
+ 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`).
111773
111771
  */
111774
111772
  $all?: boolean;
111775
111773
  /**
@@ -111802,7 +111800,7 @@ declare namespace OneNote {
111802
111800
  */
111803
111801
  interface InkAnalysisLineLoadOptions {
111804
111802
  /**
111805
- 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`).
111803
+ 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`).
111806
111804
  */
111807
111805
  $all?: boolean;
111808
111806
  /**
@@ -111835,7 +111833,7 @@ declare namespace OneNote {
111835
111833
  */
111836
111834
  interface InkAnalysisLineCollectionLoadOptions {
111837
111835
  /**
111838
- 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`).
111836
+ 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`).
111839
111837
  */
111840
111838
  $all?: boolean;
111841
111839
  /**
@@ -111868,7 +111866,7 @@ declare namespace OneNote {
111868
111866
  */
111869
111867
  interface InkAnalysisWordLoadOptions {
111870
111868
  /**
111871
- 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`).
111869
+ 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`).
111872
111870
  */
111873
111871
  $all?: boolean;
111874
111872
  /**
@@ -111915,7 +111913,7 @@ declare namespace OneNote {
111915
111913
  */
111916
111914
  interface InkAnalysisWordCollectionLoadOptions {
111917
111915
  /**
111918
- 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`).
111916
+ 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`).
111919
111917
  */
111920
111918
  $all?: boolean;
111921
111919
  /**
@@ -111962,7 +111960,7 @@ declare namespace OneNote {
111962
111960
  */
111963
111961
  interface FloatingInkLoadOptions {
111964
111962
  /**
111965
- 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`).
111963
+ 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`).
111966
111964
  */
111967
111965
  $all?: boolean;
111968
111966
  /**
@@ -111995,7 +111993,7 @@ declare namespace OneNote {
111995
111993
  */
111996
111994
  interface InkStrokeLoadOptions {
111997
111995
  /**
111998
- 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`).
111996
+ 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`).
111999
111997
  */
112000
111998
  $all?: boolean;
112001
111999
  /**
@@ -112021,7 +112019,7 @@ declare namespace OneNote {
112021
112019
  */
112022
112020
  interface InkStrokeCollectionLoadOptions {
112023
112021
  /**
112024
- 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`).
112022
+ 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`).
112025
112023
  */
112026
112024
  $all?: boolean;
112027
112025
  /**
@@ -112047,7 +112045,7 @@ declare namespace OneNote {
112047
112045
  */
112048
112046
  interface PointLoadOptions {
112049
112047
  /**
112050
- 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`).
112048
+ 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`).
112051
112049
  */
112052
112050
  $all?: boolean;
112053
112051
  /**
@@ -112068,7 +112066,7 @@ declare namespace OneNote {
112068
112066
  */
112069
112067
  interface PointCollectionLoadOptions {
112070
112068
  /**
112071
- 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`).
112069
+ 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`).
112072
112070
  */
112073
112071
  $all?: boolean;
112074
112072
  /**
@@ -112095,7 +112093,7 @@ declare namespace OneNote {
112095
112093
  */
112096
112094
  interface InkWordLoadOptions {
112097
112095
  /**
112098
- 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`).
112096
+ 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`).
112099
112097
  */
112100
112098
  $all?: boolean;
112101
112099
  /**
@@ -112113,7 +112111,7 @@ declare namespace OneNote {
112113
112111
  */
112114
112112
  id?: boolean;
112115
112113
  /**
112116
- * The id of the recognized language in this ink word. Read-only.
112114
+ * The ID of the recognized language in this ink word. Read-only.
112117
112115
  *
112118
112116
  * @remarks
112119
112117
  * [Api set: OneNoteApi 1.1]
@@ -112135,7 +112133,7 @@ declare namespace OneNote {
112135
112133
  */
112136
112134
  interface InkWordCollectionLoadOptions {
112137
112135
  /**
112138
- 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`).
112136
+ 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`).
112139
112137
  */
112140
112138
  $all?: boolean;
112141
112139
  /**
@@ -112153,7 +112151,7 @@ declare namespace OneNote {
112153
112151
  */
112154
112152
  id?: boolean;
112155
112153
  /**
112156
- * For EACH ITEM in the collection: The id of the recognized language in this ink word. Read-only.
112154
+ * For EACH ITEM in the collection: The ID of the recognized language in this ink word. Read-only.
112157
112155
  *
112158
112156
  * @remarks
112159
112157
  * [Api set: OneNoteApi 1.1]
@@ -112175,32 +112173,32 @@ declare namespace OneNote {
112175
112173
  */
112176
112174
  interface NotebookLoadOptions {
112177
112175
  /**
112178
- 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`).
112176
+ 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`).
112179
112177
  */
112180
112178
  $all?: boolean;
112181
112179
  /**
112182
- * The section groups in the notebook. Read only
112180
+ * The section groups in the notebook. Read-only.
112183
112181
  *
112184
112182
  * @remarks
112185
112183
  * [Api set: OneNoteApi 1.1]
112186
112184
  */
112187
112185
  sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
112188
112186
  /**
112189
- * The sections of the notebook. Read only
112187
+ * The sections of the notebook. Read-only.
112190
112188
  *
112191
112189
  * @remarks
112192
112190
  * [Api set: OneNoteApi 1.1]
112193
112191
  */
112194
112192
  sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
112195
112193
  /**
112196
- * The url of the site where this notebook is located. Read only
112194
+ * The URL of the site where this notebook is located. Read-only.
112197
112195
  *
112198
112196
  * @remarks
112199
112197
  * [Api set: OneNoteApi 1.1]
112200
112198
  */
112201
112199
  baseUrl?: boolean;
112202
112200
  /**
112203
- * The client url of the notebook. Read only
112201
+ * The client URL of the notebook. Read-only.
112204
112202
  *
112205
112203
  * @remarks
112206
112204
  * [Api set: OneNoteApi 1.1]
@@ -112214,7 +112212,7 @@ declare namespace OneNote {
112214
112212
  */
112215
112213
  id?: boolean;
112216
112214
  /**
112217
- * True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
112215
+ * True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
112218
112216
  *
112219
112217
  * @remarks
112220
112218
  * [Api set: OneNoteApi 1.2]
@@ -112236,7 +112234,7 @@ declare namespace OneNote {
112236
112234
  */
112237
112235
  interface NotebookCollectionLoadOptions {
112238
112236
  /**
112239
- 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`).
112237
+ 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`).
112240
112238
  */
112241
112239
  $all?: boolean;
112242
112240
  /**
@@ -112247,21 +112245,21 @@ declare namespace OneNote {
112247
112245
  */
112248
112246
  sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
112249
112247
  /**
112250
- * For EACH ITEM in the collection: The sections of the notebook. Read only
112248
+ * For EACH ITEM in the collection: The sections of the notebook. Read-only.
112251
112249
  *
112252
112250
  * @remarks
112253
112251
  * [Api set: OneNoteApi 1.1]
112254
112252
  */
112255
112253
  sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
112256
112254
  /**
112257
- * For EACH ITEM in the collection: The url of the site where this notebook is located. Read only
112255
+ * For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only.
112258
112256
  *
112259
112257
  * @remarks
112260
112258
  * [Api set: OneNoteApi 1.1]
112261
112259
  */
112262
112260
  baseUrl?: boolean;
112263
112261
  /**
112264
- * For EACH ITEM in the collection: The client url of the notebook. Read only
112262
+ * For EACH ITEM in the collection: The client URL of the notebook. Read-only.
112265
112263
  *
112266
112264
  * @remarks
112267
112265
  * [Api set: OneNoteApi 1.1]
@@ -112275,7 +112273,7 @@ declare namespace OneNote {
112275
112273
  */
112276
112274
  id?: boolean;
112277
112275
  /**
112278
- * For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
112276
+ * For EACH ITEM in the collection: True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
112279
112277
  *
112280
112278
  * @remarks
112281
112279
  * [Api set: OneNoteApi 1.2]
@@ -112297,7 +112295,7 @@ declare namespace OneNote {
112297
112295
  */
112298
112296
  interface SectionGroupLoadOptions {
112299
112297
  /**
112300
- 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`).
112298
+ 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`).
112301
112299
  */
112302
112300
  $all?: boolean;
112303
112301
  /**
@@ -112322,21 +112320,21 @@ declare namespace OneNote {
112322
112320
  */
112323
112321
  parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;
112324
112322
  /**
112325
- * The collection of section groups in the section group. Read only
112323
+ * The collection of section groups in the section group. Read-only.
112326
112324
  *
112327
112325
  * @remarks
112328
112326
  * [Api set: OneNoteApi 1.1]
112329
112327
  */
112330
112328
  sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
112331
112329
  /**
112332
- * The collection of sections in the section group. Read only
112330
+ * The collection of sections in the section group. Read-only.
112333
112331
  *
112334
112332
  * @remarks
112335
112333
  * [Api set: OneNoteApi 1.1]
112336
112334
  */
112337
112335
  sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
112338
112336
  /**
112339
- * The client url of the section group. Read only
112337
+ * The client URL of the section group. Read.only.
112340
112338
  *
112341
112339
  * @remarks
112342
112340
  * [Api set: OneNoteApi 1.1]
@@ -112365,7 +112363,7 @@ declare namespace OneNote {
112365
112363
  */
112366
112364
  interface SectionGroupCollectionLoadOptions {
112367
112365
  /**
112368
- 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`).
112366
+ 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`).
112369
112367
  */
112370
112368
  $all?: boolean;
112371
112369
  /**
@@ -112390,14 +112388,14 @@ declare namespace OneNote {
112390
112388
  */
112391
112389
  parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;
112392
112390
  /**
112393
- * For EACH ITEM in the collection: The collection of section groups in the section group. Read only
112391
+ * For EACH ITEM in the collection: The collection of section groups in the section group. Read-only.
112394
112392
  *
112395
112393
  * @remarks
112396
112394
  * [Api set: OneNoteApi 1.1]
112397
112395
  */
112398
112396
  sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
112399
112397
  /**
112400
- * For EACH ITEM in the collection: The collection of sections in the section group. Read only
112398
+ * For EACH ITEM in the collection: The collection of sections in the section group. Read-only.
112401
112399
  *
112402
112400
  * @remarks
112403
112401
  * [Api set: OneNoteApi 1.1]
@@ -112433,7 +112431,7 @@ declare namespace OneNote {
112433
112431
  */
112434
112432
  interface SectionLoadOptions {
112435
112433
  /**
112436
- 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`).
112434
+ 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`).
112437
112435
  */
112438
112436
  $all?: boolean;
112439
112437
  /**
@@ -112444,7 +112442,7 @@ declare namespace OneNote {
112444
112442
  */
112445
112443
  notebook?: OneNote.Interfaces.NotebookLoadOptions;
112446
112444
  /**
112447
- * The collection of pages in the section. Read only
112445
+ * The collection of pages in the section. Read-only.
112448
112446
  *
112449
112447
  * @remarks
112450
112448
  * [Api set: OneNoteApi 1.1]
@@ -112465,7 +112463,7 @@ declare namespace OneNote {
112465
112463
  */
112466
112464
  parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;
112467
112465
  /**
112468
- * The client url of the section. Read only
112466
+ * The client URL of the section. Read-only.
112469
112467
  *
112470
112468
  * @remarks
112471
112469
  * [Api set: OneNoteApi 1.1]
@@ -112486,7 +112484,7 @@ declare namespace OneNote {
112486
112484
  */
112487
112485
  isEncrypted?: boolean;
112488
112486
  /**
112489
- * True if this section is locked. Read only
112487
+ * True if this section is locked. Read-only.
112490
112488
  *
112491
112489
  * @remarks
112492
112490
  * [Api set: OneNoteApi 1.2]
@@ -112500,7 +112498,7 @@ declare namespace OneNote {
112500
112498
  */
112501
112499
  name?: boolean;
112502
112500
  /**
112503
- * The web url of the page. Read only
112501
+ * The web URL of the page. Read-only.
112504
112502
  *
112505
112503
  * @remarks
112506
112504
  * [Api set: OneNoteApi 1.1]
@@ -112515,7 +112513,7 @@ declare namespace OneNote {
112515
112513
  */
112516
112514
  interface SectionCollectionLoadOptions {
112517
112515
  /**
112518
- 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`).
112516
+ 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`).
112519
112517
  */
112520
112518
  $all?: boolean;
112521
112519
  /**
@@ -112568,7 +112566,7 @@ declare namespace OneNote {
112568
112566
  */
112569
112567
  isEncrypted?: boolean;
112570
112568
  /**
112571
- * For EACH ITEM in the collection: True if this section is locked. Read only
112569
+ * For EACH ITEM in the collection: True if this section is locked. Read-only.
112572
112570
  *
112573
112571
  * @remarks
112574
112572
  * [Api set: OneNoteApi 1.2]
@@ -112582,7 +112580,7 @@ declare namespace OneNote {
112582
112580
  */
112583
112581
  name?: boolean;
112584
112582
  /**
112585
- * For EACH ITEM in the collection: The web url of the page. Read only
112583
+ * For EACH ITEM in the collection: The web URL of the page. Read-only.
112586
112584
  *
112587
112585
  * @remarks
112588
112586
  * [Api set: OneNoteApi 1.1]
@@ -112597,11 +112595,11 @@ declare namespace OneNote {
112597
112595
  */
112598
112596
  interface PageLoadOptions {
112599
112597
  /**
112600
- 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`).
112598
+ 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`).
112601
112599
  */
112602
112600
  $all?: boolean;
112603
112601
  /**
112604
- * The collection of PageContent objects on the page. Read only
112602
+ * The collection of PageContent objects on the page. Read-only.
112605
112603
  *
112606
112604
  * @remarks
112607
112605
  * [Api set: OneNoteApi 1.1]
@@ -112629,7 +112627,7 @@ declare namespace OneNote {
112629
112627
  */
112630
112628
  classNotebookPageSource?: boolean;
112631
112629
  /**
112632
- * The client url of the page. Read only
112630
+ * The client URL of the page. Read-only.
112633
112631
  *
112634
112632
  * @remarks
112635
112633
  * [Api set: OneNoteApi 1.1]
@@ -112657,7 +112655,7 @@ declare namespace OneNote {
112657
112655
  */
112658
112656
  title?: boolean;
112659
112657
  /**
112660
- * The web url of the page. Read only
112658
+ * The web URL of the page. Read-only.
112661
112659
  *
112662
112660
  * @remarks
112663
112661
  * [Api set: OneNoteApi 1.1]
@@ -112672,7 +112670,7 @@ declare namespace OneNote {
112672
112670
  */
112673
112671
  interface PageCollectionLoadOptions {
112674
112672
  /**
112675
- 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`).
112673
+ 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`).
112676
112674
  */
112677
112675
  $all?: boolean;
112678
112676
  /**
@@ -112683,7 +112681,7 @@ declare namespace OneNote {
112683
112681
  */
112684
112682
  contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
112685
112683
  /**
112686
- * For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information.
112684
+ * 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.
112687
112685
  *
112688
112686
  * @remarks
112689
112687
  * [Api set: OneNoteApi 1.1]
@@ -112704,7 +112702,7 @@ declare namespace OneNote {
112704
112702
  */
112705
112703
  classNotebookPageSource?: boolean;
112706
112704
  /**
112707
- * For EACH ITEM in the collection: The client url of the page. Read only
112705
+ * For EACH ITEM in the collection: The client URL of the page. Read-only.
112708
112706
  *
112709
112707
  * @remarks
112710
112708
  * [Api set: OneNoteApi 1.1]
@@ -112747,7 +112745,7 @@ declare namespace OneNote {
112747
112745
  */
112748
112746
  interface PageContentLoadOptions {
112749
112747
  /**
112750
- 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`).
112748
+ 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`).
112751
112749
  */
112752
112750
  $all?: boolean;
112753
112751
  /**
@@ -112815,25 +112813,25 @@ declare namespace OneNote {
112815
112813
  */
112816
112814
  interface PageContentCollectionLoadOptions {
112817
112815
  /**
112818
- 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`).
112816
+ 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`).
112819
112817
  */
112820
112818
  $all?: boolean;
112821
112819
  /**
112822
- * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
112820
+ * For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
112823
112821
  *
112824
112822
  * @remarks
112825
112823
  * [Api set: OneNoteApi 1.1]
112826
112824
  */
112827
112825
  image?: OneNote.Interfaces.ImageLoadOptions;
112828
112826
  /**
112829
- * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink.
112827
+ * For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
112830
112828
  *
112831
112829
  * @remarks
112832
112830
  * [Api set: OneNoteApi 1.1]
112833
112831
  */
112834
112832
  ink?: OneNote.Interfaces.FloatingInkLoadOptions;
112835
112833
  /**
112836
- * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline.
112834
+ * For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.
112837
112835
  *
112838
112836
  * @remarks
112839
112837
  * [Api set: OneNoteApi 1.1]
@@ -112883,7 +112881,7 @@ declare namespace OneNote {
112883
112881
  */
112884
112882
  interface OutlineLoadOptions {
112885
112883
  /**
112886
- 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`).
112884
+ 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`).
112887
112885
  */
112888
112886
  $all?: boolean;
112889
112887
  /**
@@ -112894,11 +112892,11 @@ declare namespace OneNote {
112894
112892
  */
112895
112893
  pageContent?: OneNote.Interfaces.PageContentLoadOptions;
112896
112894
  /**
112897
- * Gets the collection of Paragraph objects in the Outline.
112898
- *
112899
- * @remarks
112900
- * [Api set: OneNoteApi 1.1]
112901
- */
112895
+ * Gets the collection of Paragraph objects in the Outline.
112896
+ *
112897
+ * @remarks
112898
+ * [Api set: OneNoteApi 1.1]
112899
+ */
112902
112900
  paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
112903
112901
  /**
112904
112902
  * Gets the ID of the Outline object. Read-only.
@@ -112916,22 +112914,22 @@ declare namespace OneNote {
112916
112914
  */
112917
112915
  interface ParagraphLoadOptions {
112918
112916
  /**
112919
- 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`).
112917
+ 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`).
112920
112918
  */
112921
112919
  $all?: boolean;
112922
112920
  /**
112923
- * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
112924
- *
112925
- * @remarks
112926
- * [Api set: OneNoteApi 1.1]
112927
- */
112921
+ * Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
112922
+ *
112923
+ * @remarks
112924
+ * [Api set: OneNoteApi 1.1]
112925
+ */
112928
112926
  image?: OneNote.Interfaces.ImageLoadOptions;
112929
112927
  /**
112930
- * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.
112931
- *
112932
- * @remarks
112933
- * [Api set: OneNoteApi 1.1]
112934
- */
112928
+ * Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
112929
+ *
112930
+ * @remarks
112931
+ * [Api set: OneNoteApi 1.1]
112932
+ */
112935
112933
  inkWords?: OneNote.Interfaces.InkWordCollectionLoadOptions;
112936
112934
  /**
112937
112935
  * Gets the Outline object that contains the Paragraph.
@@ -112941,28 +112939,28 @@ declare namespace OneNote {
112941
112939
  */
112942
112940
  outline?: OneNote.Interfaces.OutlineLoadOptions;
112943
112941
  /**
112944
- * The collection of paragraphs under this paragraph. Read only
112942
+ * The collection of paragraphs under this paragraph. Read -nly.
112945
112943
  *
112946
112944
  * @remarks
112947
112945
  * [Api set: OneNoteApi 1.1]
112948
112946
  */
112949
112947
  paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
112950
112948
  /**
112951
- * Gets the parent paragraph object. Throws if a parent paragraph does not exist.
112949
+ * Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
112952
112950
  *
112953
112951
  * @remarks
112954
112952
  * [Api set: OneNoteApi 1.1]
112955
112953
  */
112956
112954
  parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;
112957
112955
  /**
112958
- * Gets the parent paragraph object. Returns null if a parent paragraph does not exist.
112956
+ * Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
112959
112957
  *
112960
112958
  * @remarks
112961
112959
  * [Api set: OneNoteApi 1.1]
112962
112960
  */
112963
112961
  parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;
112964
112962
  /**
112965
- * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound.
112963
+ * Gets the TableCell object that contains the Paragraph if one exists. If parent isn't a TableCell, throws ItemNotFound.
112966
112964
  *
112967
112965
  * @remarks
112968
112966
  * [Api set: OneNoteApi 1.1]
@@ -112976,14 +112974,14 @@ declare namespace OneNote {
112976
112974
  */
112977
112975
  parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions;
112978
112976
  /**
112979
- * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
112977
+ * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText.
112980
112978
  *
112981
112979
  * @remarks
112982
112980
  * [Api set: OneNoteApi 1.1]
112983
112981
  */
112984
112982
  richText?: OneNote.Interfaces.RichTextLoadOptions;
112985
112983
  /**
112986
- * Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.
112984
+ * Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
112987
112985
  *
112988
112986
  * @remarks
112989
112987
  * [Api set: OneNoteApi 1.1]
@@ -113012,18 +113010,18 @@ declare namespace OneNote {
113012
113010
  */
113013
113011
  interface ParagraphCollectionLoadOptions {
113014
113012
  /**
113015
- 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`).
113013
+ 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`).
113016
113014
  */
113017
113015
  $all?: boolean;
113018
113016
  /**
113019
- * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image.
113017
+ * For EACH ITEM in the collection: Gets the Image object in the Paragraph. Throws an exception if ParagraphType isn't Image.
113020
113018
  *
113021
113019
  * @remarks
113022
113020
  * [Api set: OneNoteApi 1.1]
113023
113021
  */
113024
113022
  image?: OneNote.Interfaces.ImageLoadOptions;
113025
113023
  /**
113026
- * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType is not Ink.
113024
+ * For EACH ITEM in the collection: Gets the Ink collection in the Paragraph. Throws an exception if ParagraphType isn't Ink.
113027
113025
  *
113028
113026
  * @remarks
113029
113027
  * [Api set: OneNoteApi 1.1]
@@ -113037,28 +113035,28 @@ declare namespace OneNote {
113037
113035
  */
113038
113036
  outline?: OneNote.Interfaces.OutlineLoadOptions;
113039
113037
  /**
113040
- * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read only
113038
+ * For EACH ITEM in the collection: The collection of paragraphs under this paragraph. Read-only.
113041
113039
  *
113042
113040
  * @remarks
113043
113041
  * [Api set: OneNoteApi 1.1]
113044
113042
  */
113045
113043
  paragraphs?: OneNote.Interfaces.ParagraphCollectionLoadOptions;
113046
113044
  /**
113047
- * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph does not exist.
113045
+ * For EACH ITEM in the collection: Gets the parent paragraph object. Throws if a parent paragraph doesn't exist.
113048
113046
  *
113049
113047
  * @remarks
113050
113048
  * [Api set: OneNoteApi 1.1]
113051
113049
  */
113052
113050
  parentParagraph?: OneNote.Interfaces.ParagraphLoadOptions;
113053
113051
  /**
113054
- * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph does not exist.
113052
+ * For EACH ITEM in the collection: Gets the parent paragraph object. Returns null if a parent paragraph doesn't exist.
113055
113053
  *
113056
113054
  * @remarks
113057
113055
  * [Api set: OneNoteApi 1.1]
113058
113056
  */
113059
113057
  parentParagraphOrNull?: OneNote.Interfaces.ParagraphLoadOptions;
113060
113058
  /**
113061
- * 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.
113059
+ * 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.
113062
113060
  *
113063
113061
  * @remarks
113064
113062
  * [Api set: OneNoteApi 1.1]
@@ -113072,14 +113070,14 @@ declare namespace OneNote {
113072
113070
  */
113073
113071
  parentTableCellOrNull?: OneNote.Interfaces.TableCellLoadOptions;
113074
113072
  /**
113075
- * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText.
113073
+ * For EACH ITEM in the collection: Gets the RichText object in the Paragraph. Throws an exception if ParagraphType isn't RichText.
113076
113074
  *
113077
113075
  * @remarks
113078
113076
  * [Api set: OneNoteApi 1.1]
113079
113077
  */
113080
113078
  richText?: OneNote.Interfaces.RichTextLoadOptions;
113081
113079
  /**
113082
- * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType is not Table.
113080
+ * For EACH ITEM in the collection: Gets the Table object in the Paragraph. Throws an exception if ParagraphType isn't Table.
113083
113081
  *
113084
113082
  * @remarks
113085
113083
  * [Api set: OneNoteApi 1.1]
@@ -113108,7 +113106,7 @@ declare namespace OneNote {
113108
113106
  */
113109
113107
  interface NoteTagLoadOptions {
113110
113108
  /**
113111
- 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`).
113109
+ 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`).
113112
113110
  */
113113
113111
  $all?: boolean;
113114
113112
  /**
@@ -113141,7 +113139,7 @@ declare namespace OneNote {
113141
113139
  */
113142
113140
  interface RichTextLoadOptions {
113143
113141
  /**
113144
- 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`).
113142
+ 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`).
113145
113143
  */
113146
113144
  $all?: boolean;
113147
113145
  /**
@@ -113159,7 +113157,7 @@ declare namespace OneNote {
113159
113157
  */
113160
113158
  id?: boolean;
113161
113159
  /**
113162
- * The language id of the text. Read-only.
113160
+ * The language ID of the text. Read-only.
113163
113161
  *
113164
113162
  * @remarks
113165
113163
  * [Api set: OneNoteApi 1.1]
@@ -113188,18 +113186,18 @@ declare namespace OneNote {
113188
113186
  */
113189
113187
  interface ImageLoadOptions {
113190
113188
  /**
113191
- 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`).
113189
+ 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`).
113192
113190
  */
113193
113191
  $all?: boolean;
113194
113192
  /**
113195
- * 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.
113193
+ * 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.
113196
113194
  *
113197
113195
  * @remarks
113198
113196
  * [Api set: OneNoteApi 1.1]
113199
113197
  */
113200
113198
  pageContent?: OneNote.Interfaces.PageContentLoadOptions;
113201
113199
  /**
113202
- * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph.
113200
+ * Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph.
113203
113201
  *
113204
113202
  * @remarks
113205
113203
  * [Api set: OneNoteApi 1.1]
@@ -113256,7 +113254,7 @@ declare namespace OneNote {
113256
113254
  */
113257
113255
  interface TableLoadOptions {
113258
113256
  /**
113259
- 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`).
113257
+ 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`).
113260
113258
  */
113261
113259
  $all?: boolean;
113262
113260
  /**
@@ -113310,7 +113308,7 @@ declare namespace OneNote {
113310
113308
  */
113311
113309
  interface TableRowLoadOptions {
113312
113310
  /**
113313
- 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`).
113311
+ 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`).
113314
113312
  */
113315
113313
  $all?: boolean;
113316
113314
  /**
@@ -113357,7 +113355,7 @@ declare namespace OneNote {
113357
113355
  */
113358
113356
  interface TableRowCollectionLoadOptions {
113359
113357
  /**
113360
- 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`).
113358
+ 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`).
113361
113359
  */
113362
113360
  $all?: boolean;
113363
113361
  /**
@@ -113404,7 +113402,7 @@ declare namespace OneNote {
113404
113402
  */
113405
113403
  interface TableCellLoadOptions {
113406
113404
  /**
113407
- 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`).
113405
+ 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`).
113408
113406
  */
113409
113407
  $all?: boolean;
113410
113408
  /**
@@ -113458,7 +113456,7 @@ declare namespace OneNote {
113458
113456
  */
113459
113457
  interface TableCellCollectionLoadOptions {
113460
113458
  /**
113461
- 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`).
113459
+ 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`).
113462
113460
  */
113463
113461
  $all?: boolean;
113464
113462
  /**
@@ -113821,10 +113819,6 @@ declare namespace Visio {
113821
113819
  * 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.
113822
113820
  */
113823
113821
  toJSON(): Visio.Interfaces.ApplicationData;
113824
- /**
113825
- * Set mock data
113826
- */
113827
- setMockData(data: Visio.Interfaces.ApplicationData): void;
113828
113822
  }
113829
113823
  /**
113830
113824
  * Represents the Document class.
@@ -113901,7 +113895,7 @@ declare namespace Visio {
113901
113895
  *
113902
113896
  * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
113903
113897
  * @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.
113904
- * @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
113898
+ * @param show Optional Parameter. If it's set to false, it will hide the specified task pane.
113905
113899
  */
113906
113900
  showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
113907
113901
  /**
@@ -114009,10 +114003,6 @@ declare namespace Visio {
114009
114003
  * 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.
114010
114004
  */
114011
114005
  toJSON(): Visio.Interfaces.DocumentData;
114012
- /**
114013
- * Set mock data
114014
- */
114015
- setMockData(data: Visio.Interfaces.DocumentData): void;
114016
114006
  }
114017
114007
  /**
114018
114008
  * Represents the DocumentView class.
@@ -114092,10 +114082,6 @@ declare namespace Visio {
114092
114082
  * 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.
114093
114083
  */
114094
114084
  toJSON(): Visio.Interfaces.DocumentViewData;
114095
- /**
114096
- * Set mock data
114097
- */
114098
- setMockData(data: Visio.Interfaces.DocumentViewData): void;
114099
114085
  }
114100
114086
  /**
114101
114087
  * Represents the Page class.
@@ -114210,10 +114196,6 @@ declare namespace Visio {
114210
114196
  * 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.
114211
114197
  */
114212
114198
  toJSON(): Visio.Interfaces.PageData;
114213
- /**
114214
- * Set mock data
114215
- */
114216
- setMockData(data: Visio.Interfaces.PageData): void;
114217
114199
  }
114218
114200
  /**
114219
114201
  * Represents the PageView class.
@@ -114313,10 +114295,6 @@ declare namespace Visio {
114313
114295
  * 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.
114314
114296
  */
114315
114297
  toJSON(): Visio.Interfaces.PageViewData;
114316
- /**
114317
- * Set mock data
114318
- */
114319
- setMockData(data: Visio.Interfaces.PageViewData): void;
114320
114298
  }
114321
114299
  /**
114322
114300
  * Represents a collection of Page objects that are part of the document.
@@ -114368,10 +114346,6 @@ declare namespace Visio {
114368
114346
  * 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.
114369
114347
  */
114370
114348
  toJSON(): Visio.Interfaces.PageCollectionData;
114371
- /**
114372
- * Set mock data
114373
- */
114374
- setMockData(data: Visio.Interfaces.PageCollectionData): void;
114375
114349
  }
114376
114350
  /**
114377
114351
  * Represents the Shape Collection.
@@ -114423,10 +114397,6 @@ declare namespace Visio {
114423
114397
  * 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.
114424
114398
  */
114425
114399
  toJSON(): Visio.Interfaces.ShapeCollectionData;
114426
- /**
114427
- * Set mock data
114428
- */
114429
- setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
114430
114400
  }
114431
114401
  /**
114432
114402
  * Represents the Shape class.
@@ -114548,10 +114518,6 @@ declare namespace Visio {
114548
114518
  * 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.
114549
114519
  */
114550
114520
  toJSON(): Visio.Interfaces.ShapeData;
114551
- /**
114552
- * Set mock data
114553
- */
114554
- setMockData(data: Visio.Interfaces.ShapeData): void;
114555
114521
  }
114556
114522
  /**
114557
114523
  * Represents the ShapeView class.
@@ -114659,10 +114625,6 @@ declare namespace Visio {
114659
114625
  * 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.
114660
114626
  */
114661
114627
  toJSON(): Visio.Interfaces.ShapeViewData;
114662
- /**
114663
- * Set mock data
114664
- */
114665
- setMockData(data: Visio.Interfaces.ShapeViewData): void;
114666
114628
  }
114667
114629
  /**
114668
114630
  * Represents the Position of the object in the view.
@@ -114794,10 +114756,6 @@ declare namespace Visio {
114794
114756
  * 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.
114795
114757
  */
114796
114758
  toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;
114797
- /**
114798
- * Set mock data
114799
- */
114800
- setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
114801
114759
  }
114802
114760
  /**
114803
114761
  * Represents the ShapeDataItem.
@@ -114862,10 +114820,6 @@ declare namespace Visio {
114862
114820
  * 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.
114863
114821
  */
114864
114822
  toJSON(): Visio.Interfaces.ShapeDataItemData;
114865
- /**
114866
- * Set mock data
114867
- */
114868
- setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
114869
114823
  }
114870
114824
  /**
114871
114825
  * Represents the Hyperlink Collection.
@@ -114917,10 +114871,6 @@ declare namespace Visio {
114917
114871
  * 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.
114918
114872
  */
114919
114873
  toJSON(): Visio.Interfaces.HyperlinkCollectionData;
114920
- /**
114921
- * Set mock data
114922
- */
114923
- setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
114924
114874
  }
114925
114875
  /**
114926
114876
  * Represents the Hyperlink.
@@ -114985,10 +114935,6 @@ declare namespace Visio {
114985
114935
  * 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.
114986
114936
  */
114987
114937
  toJSON(): Visio.Interfaces.HyperlinkData;
114988
- /**
114989
- * Set mock data
114990
- */
114991
- setMockData(data: Visio.Interfaces.HyperlinkData): void;
114992
114938
  }
114993
114939
  /**
114994
114940
  * Represents the CommentCollection for a given Shape.
@@ -115040,10 +114986,6 @@ declare namespace Visio {
115040
114986
  * 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.
115041
114987
  */
115042
114988
  toJSON(): Visio.Interfaces.CommentCollectionData;
115043
- /**
115044
- * Set mock data
115045
- */
115046
- setMockData(data: Visio.Interfaces.CommentCollectionData): void;
115047
114989
  }
115048
114990
  /**
115049
114991
  * Represents the Comment.
@@ -115109,10 +115051,6 @@ declare namespace Visio {
115109
115051
  * 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.
115110
115052
  */
115111
115053
  toJSON(): Visio.Interfaces.CommentData;
115112
- /**
115113
- * Set mock data
115114
- */
115115
- setMockData(data: Visio.Interfaces.CommentData): void;
115116
115054
  }
115117
115055
  /**
115118
115056
  * Represents the Selection in the page.
@@ -116082,28 +116020,28 @@ declare namespace Visio {
116082
116020
  /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
116083
116021
  interface ShapeDataItemData {
116084
116022
  /**
116085
- * A string that specifies the format of the shape data item.
116023
+ * A string that specifies the format of the shape data item. Read-only.
116086
116024
  *
116087
116025
  * @remarks
116088
116026
  * [Api set: 1.1]
116089
116027
  */
116090
116028
  format?: string;
116091
116029
  /**
116092
- * A string that specifies the formatted value of the shape data item.
116030
+ * A string that specifies the formatted value of the shape data item. Read-only.
116093
116031
  *
116094
116032
  * @remarks
116095
116033
  * [Api set: 1.1]
116096
116034
  */
116097
116035
  formattedValue?: string;
116098
116036
  /**
116099
- * A string that specifies the label of the shape data item.
116037
+ * A string that specifies the label of the shape data item. Read-only.
116100
116038
  *
116101
116039
  * @remarks
116102
116040
  * [Api set: 1.1]
116103
116041
  */
116104
116042
  label?: string;
116105
116043
  /**
116106
- * A string that specifies the value of the shape data item.
116044
+ * A string that specifies the value of the shape data item. Read-only.
116107
116045
  *
116108
116046
  * @remarks
116109
116047
  * [Api set: 1.1]
@@ -116117,28 +116055,28 @@ declare namespace Visio {
116117
116055
  /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
116118
116056
  interface HyperlinkData {
116119
116057
  /**
116120
- * Gets the address of the Hyperlink object.
116058
+ * Gets the address of the Hyperlink object. Read-only.
116121
116059
  *
116122
116060
  * @remarks
116123
116061
  * [Api set: 1.1]
116124
116062
  */
116125
116063
  address?: string;
116126
116064
  /**
116127
- * Gets the description of a hyperlink.
116065
+ * Gets the description of a hyperlink. Read-only.
116128
116066
  *
116129
116067
  * @remarks
116130
116068
  * [Api set: 1.1]
116131
116069
  */
116132
116070
  description?: string;
116133
116071
  /**
116134
- * Gets the extra URL request information used to resolve the hyperlink's URL.
116072
+ * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
116135
116073
  *
116136
116074
  * @remarks
116137
116075
  * [Api set: 1.1]
116138
116076
  */
116139
116077
  extraInfo?: string;
116140
116078
  /**
116141
- * Gets the sub-address of the Hyperlink object.
116079
+ * Gets the sub-address of the Hyperlink object. Read-only.
116142
116080
  *
116143
116081
  * @remarks
116144
116082
  * [Api set: 1.1]
@@ -116176,7 +116114,7 @@ declare namespace Visio {
116176
116114
  /** An interface describing the data returned by calling `selection.toJSON()`. */
116177
116115
  interface SelectionData {
116178
116116
  /**
116179
- * Gets the Shapes of the Selection.
116117
+ * Gets the Shapes of the Selection. Read-only.
116180
116118
  *
116181
116119
  * @remarks
116182
116120
  * [Api set: 1.1]
@@ -116301,35 +116239,35 @@ declare namespace Visio {
116301
116239
  */
116302
116240
  view?: Visio.Interfaces.PageViewLoadOptions;
116303
116241
  /**
116304
- * Returns the height of the page.
116242
+ * Returns the height of the page. Read-only.
116305
116243
  *
116306
116244
  * @remarks
116307
116245
  * [Api set: 1.1]
116308
116246
  */
116309
116247
  height?: boolean;
116310
116248
  /**
116311
- * Index of the Page.
116249
+ * Index of the Page. Read-only.
116312
116250
  *
116313
116251
  * @remarks
116314
116252
  * [Api set: 1.1]
116315
116253
  */
116316
116254
  index?: boolean;
116317
116255
  /**
116318
- * Whether the page is a background page or not.
116256
+ * Whether the page is a background page or not. Read-only.
116319
116257
  *
116320
116258
  * @remarks
116321
116259
  * [Api set: 1.1]
116322
116260
  */
116323
116261
  isBackground?: boolean;
116324
116262
  /**
116325
- * Page name.
116263
+ * Page name. Read-only.
116326
116264
  *
116327
116265
  * @remarks
116328
116266
  * [Api set: 1.1]
116329
116267
  */
116330
116268
  name?: boolean;
116331
116269
  /**
116332
- * Returns the width of the page.
116270
+ * Returns the width of the page. Read-only.
116333
116271
  *
116334
116272
  * @remarks
116335
116273
  * [Api set: 1.1]
@@ -116374,35 +116312,35 @@ declare namespace Visio {
116374
116312
  */
116375
116313
  view?: Visio.Interfaces.PageViewLoadOptions;
116376
116314
  /**
116377
- * For EACH ITEM in the collection: Returns the height of the page.
116315
+ * For EACH ITEM in the collection: Returns the height of the page. Read-only.
116378
116316
  *
116379
116317
  * @remarks
116380
116318
  * [Api set: 1.1]
116381
116319
  */
116382
116320
  height?: boolean;
116383
116321
  /**
116384
- * For EACH ITEM in the collection: Index of the Page.
116322
+ * For EACH ITEM in the collection: Index of the Page. Read-only.
116385
116323
  *
116386
116324
  * @remarks
116387
116325
  * [Api set: 1.1]
116388
116326
  */
116389
116327
  index?: boolean;
116390
116328
  /**
116391
- * For EACH ITEM in the collection: Whether the page is a background page or not.
116329
+ * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
116392
116330
  *
116393
116331
  * @remarks
116394
116332
  * [Api set: 1.1]
116395
116333
  */
116396
116334
  isBackground?: boolean;
116397
116335
  /**
116398
- * For EACH ITEM in the collection: Page name.
116336
+ * For EACH ITEM in the collection: Page name. Read-only.
116399
116337
  *
116400
116338
  * @remarks
116401
116339
  * [Api set: 1.1]
116402
116340
  */
116403
116341
  name?: boolean;
116404
116342
  /**
116405
- * For EACH ITEM in the collection: Returns the width of the page.
116343
+ * For EACH ITEM in the collection: Returns the width of the page. Read-only.
116406
116344
  *
116407
116345
  * @remarks
116408
116346
  * [Api set: 1.1]
@@ -116428,14 +116366,14 @@ declare namespace Visio {
116428
116366
  */
116429
116367
  view?: Visio.Interfaces.ShapeViewLoadOptions;
116430
116368
  /**
116431
- * For EACH ITEM in the collection: Shape's identifier.
116369
+ * For EACH ITEM in the collection: Shape's identifier. Read-only.
116432
116370
  *
116433
116371
  * @remarks
116434
116372
  * [Api set: 1.1]
116435
116373
  */
116436
116374
  id?: boolean;
116437
116375
  /**
116438
- * For EACH ITEM in the collection: Shape's name.
116376
+ * For EACH ITEM in the collection: Shape's name. Read-only.
116439
116377
  *
116440
116378
  * @remarks
116441
116379
  * [Api set: 1.1]
@@ -116449,7 +116387,7 @@ declare namespace Visio {
116449
116387
  */
116450
116388
  select?: boolean;
116451
116389
  /**
116452
- * For EACH ITEM in the collection: Shape's text.
116390
+ * For EACH ITEM in the collection: Shape's text. Read-only.
116453
116391
  *
116454
116392
  * @remarks
116455
116393
  * [Api set: 1.1]
@@ -116475,14 +116413,14 @@ declare namespace Visio {
116475
116413
  */
116476
116414
  view?: Visio.Interfaces.ShapeViewLoadOptions;
116477
116415
  /**
116478
- * Shape's identifier.
116416
+ * Shape's identifier. Read-only.
116479
116417
  *
116480
116418
  * @remarks
116481
116419
  * [Api set: 1.1]
116482
116420
  */
116483
116421
  id?: boolean;
116484
116422
  /**
116485
- * Shape's name.
116423
+ * Shape's name. Read-only.
116486
116424
  *
116487
116425
  * @remarks
116488
116426
  * [Api set: 1.1]
@@ -116496,7 +116434,7 @@ declare namespace Visio {
116496
116434
  */
116497
116435
  select?: boolean;
116498
116436
  /**
116499
- * Shape's text.
116437
+ * Shape's text. Read-only.
116500
116438
  *
116501
116439
  * @remarks
116502
116440
  * [Api set: 1.1]
@@ -116534,21 +116472,21 @@ declare namespace Visio {
116534
116472
  */
116535
116473
  $all?: boolean;
116536
116474
  /**
116537
- * For EACH ITEM in the collection: A string that specifies the format of the shape data item.
116475
+ * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.
116538
116476
  *
116539
116477
  * @remarks
116540
116478
  * [Api set: 1.1]
116541
116479
  */
116542
116480
  format?: boolean;
116543
116481
  /**
116544
- * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.
116482
+ * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.
116545
116483
  *
116546
116484
  * @remarks
116547
116485
  * [Api set: 1.1]
116548
116486
  */
116549
116487
  formattedValue?: boolean;
116550
116488
  /**
116551
- * For EACH ITEM in the collection: A string that specifies the label of the shape data item.
116489
+ * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.
116552
116490
  *
116553
116491
  * @remarks
116554
116492
  * [Api set: 1.1]
@@ -116574,28 +116512,28 @@ declare namespace Visio {
116574
116512
  */
116575
116513
  $all?: boolean;
116576
116514
  /**
116577
- * A string that specifies the format of the shape data item.
116515
+ * A string that specifies the format of the shape data item. Read-only.
116578
116516
  *
116579
116517
  * @remarks
116580
116518
  * [Api set: 1.1]
116581
116519
  */
116582
116520
  format?: boolean;
116583
116521
  /**
116584
- * A string that specifies the formatted value of the shape data item.
116522
+ * A string that specifies the formatted value of the shape data item. Read-only.
116585
116523
  *
116586
116524
  * @remarks
116587
116525
  * [Api set: 1.1]
116588
116526
  */
116589
116527
  formattedValue?: boolean;
116590
116528
  /**
116591
- * A string that specifies the label of the shape data item.
116529
+ * A string that specifies the label of the shape data item. Read-only.
116592
116530
  *
116593
116531
  * @remarks
116594
116532
  * [Api set: 1.1]
116595
116533
  */
116596
116534
  label?: boolean;
116597
116535
  /**
116598
- * A string that specifies the value of the shape data item.
116536
+ * A string that specifies the value of the shape data item. Read-only.
116599
116537
  *
116600
116538
  * @remarks
116601
116539
  * [Api set: 1.1]
@@ -116614,28 +116552,28 @@ declare namespace Visio {
116614
116552
  */
116615
116553
  $all?: boolean;
116616
116554
  /**
116617
- * For EACH ITEM in the collection: Gets the address of the Hyperlink object.
116555
+ * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.
116618
116556
  *
116619
116557
  * @remarks
116620
116558
  * [Api set: 1.1]
116621
116559
  */
116622
116560
  address?: boolean;
116623
116561
  /**
116624
- * For EACH ITEM in the collection: Gets the description of a hyperlink.
116562
+ * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.
116625
116563
  *
116626
116564
  * @remarks
116627
116565
  * [Api set: 1.1]
116628
116566
  */
116629
116567
  description?: boolean;
116630
116568
  /**
116631
- * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL.
116569
+ * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
116632
116570
  *
116633
116571
  * @remarks
116634
116572
  * [Api set: 1.1]
116635
116573
  */
116636
116574
  extraInfo?: boolean;
116637
116575
  /**
116638
- * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.
116576
+ * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.
116639
116577
  *
116640
116578
  * @remarks
116641
116579
  * [Api set: 1.1]
@@ -116654,28 +116592,28 @@ declare namespace Visio {
116654
116592
  */
116655
116593
  $all?: boolean;
116656
116594
  /**
116657
- * Gets the address of the Hyperlink object.
116595
+ * Gets the address of the Hyperlink object. Read-only.
116658
116596
  *
116659
116597
  * @remarks
116660
116598
  * [Api set: 1.1]
116661
116599
  */
116662
116600
  address?: boolean;
116663
116601
  /**
116664
- * Gets the description of a hyperlink.
116602
+ * Gets the description of a hyperlink. Read-only.
116665
116603
  *
116666
116604
  * @remarks
116667
116605
  * [Api set: 1.1]
116668
116606
  */
116669
116607
  description?: boolean;
116670
116608
  /**
116671
- * Gets the extra URL request information used to resolve the hyperlink's URL.
116609
+ * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
116672
116610
  *
116673
116611
  * @remarks
116674
116612
  * [Api set: 1.1]
116675
116613
  */
116676
116614
  extraInfo?: boolean;
116677
116615
  /**
116678
- * Gets the sub-address of the Hyperlink object.
116616
+ * Gets the sub-address of the Hyperlink object. Read-only.
116679
116617
  *
116680
116618
  * @remarks
116681
116619
  * [Api set: 1.1]
@@ -116760,25 +116698,25 @@ declare namespace Visio {
116760
116698
  }
116761
116699
  /**
116762
116700
  * 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.
116763
- * @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.
116701
+ * @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.
116764
116702
  */
116765
116703
  function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
116766
116704
  /**
116767
116705
  * Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object.
116768
- * @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()".
116769
- * @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.
116706
+ * @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()`.
116707
+ * @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.
116770
116708
  */
116771
116709
  function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
116772
116710
  /**
116773
116711
  * Executes a batch script that performs actions on the Visio object model, using the request context of previously-created API objects.
116774
- * @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()".
116775
- * @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.
116712
+ * @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()`.
116713
+ * @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.
116776
116714
  */
116777
116715
  function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
116778
116716
  /**
116779
116717
  * 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.
116780
116718
  * @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.
116781
- * @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.
116719
+ * @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.
116782
116720
  */
116783
116721
  function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
116784
116722
  }
@@ -116963,6 +116901,109 @@ declare namespace PowerPoint {
116963
116901
  */
116964
116902
  slideMasterId?: string;
116965
116903
  }
116904
+ /**
116905
+ * Represents a single hyperlink.
116906
+ *
116907
+ * @remarks
116908
+ * [Api set: PowerPointApi 1.6]
116909
+ */
116910
+ class Hyperlink extends OfficeExtension.ClientObject {
116911
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
116912
+ context: RequestContext;
116913
+ /**
116914
+ * Specifies the URL target of the hyperlink.
116915
+ *
116916
+ * @remarks
116917
+ * [Api set: PowerPointApi 1.6]
116918
+ */
116919
+ address: string;
116920
+ /**
116921
+ * Specifies the string displayed when hovering over the hyperlink.
116922
+ *
116923
+ * @remarks
116924
+ * [Api set: PowerPointApi 1.6]
116925
+ */
116926
+ screenTip: string;
116927
+ /**
116928
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116929
+ *
116930
+ * @param options Provides options for which properties of the object to load.
116931
+ */
116932
+ load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
116933
+ /**
116934
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116935
+ *
116936
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
116937
+ */
116938
+ load(propertyNames?: string | string[]): PowerPoint.Hyperlink;
116939
+ /**
116940
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116941
+ *
116942
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
116943
+ */
116944
+ load(propertyNamesAndPaths?: {
116945
+ select?: string;
116946
+ expand?: string;
116947
+ }): PowerPoint.Hyperlink;
116948
+ /**
116949
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
116950
+ * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
116951
+ */
116952
+ toJSON(): PowerPoint.Interfaces.HyperlinkData;
116953
+ }
116954
+ /**
116955
+ * Represents a collection of hyperlinks.
116956
+ *
116957
+ * @remarks
116958
+ * [Api set: PowerPointApi 1.6]
116959
+ */
116960
+ class HyperlinkCollection extends OfficeExtension.ClientObject {
116961
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
116962
+ context: RequestContext;
116963
+ /** Gets the loaded child items in this collection. */
116964
+ readonly items: PowerPoint.Hyperlink[];
116965
+ /**
116966
+ * Gets the number of hyperlinks in the collection.
116967
+ *
116968
+ * @remarks
116969
+ * [Api set: PowerPointApi 1.6]
116970
+ * @returns The number of hyperlinks in the collection.
116971
+ */
116972
+ getCount(): OfficeExtension.ClientResult<number>;
116973
+ /**
116974
+ * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range.
116975
+ *
116976
+ * @remarks
116977
+ * [Api set: PowerPointApi 1.6]
116978
+ *
116979
+ * @param index The index of the hyperlink in the collection.
116980
+ * @returns The hyperlink at the given index. An error is thrown if index is out of range.
116981
+ */
116982
+ getItemAt(index: number): PowerPoint.Hyperlink;
116983
+ /**
116984
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116985
+ *
116986
+ * @param options Provides options for which properties of the object to load.
116987
+ */
116988
+ load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;
116989
+ /**
116990
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116991
+ *
116992
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
116993
+ */
116994
+ load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;
116995
+ /**
116996
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
116997
+ *
116998
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
116999
+ */
117000
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
117001
+ /**
117002
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
117003
+ * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
117004
+ */
117005
+ toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;
117006
+ }
116966
117007
  /**
116967
117008
  * Specifies the connector type for line shapes.
116968
117009
  *
@@ -118861,6 +118902,13 @@ declare namespace PowerPoint {
118861
118902
  class Slide extends OfficeExtension.ClientObject {
118862
118903
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118863
118904
  context: RequestContext;
118905
+ /**
118906
+ * Returns a collection of hyperlinks in the slide.
118907
+ *
118908
+ * @remarks
118909
+ * [Api set: PowerPointApi 1.6]
118910
+ */
118911
+ readonly hyperlinks: PowerPoint.HyperlinkCollection;
118864
118912
  /**
118865
118913
  * Gets the layout of the slide.
118866
118914
  *
@@ -120162,6 +120210,27 @@ declare namespace PowerPoint {
120162
120210
  */
120163
120211
  $skip?: number;
120164
120212
  }
120213
+ /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */
120214
+ interface HyperlinkUpdateData {
120215
+ /**
120216
+ * Specifies the URL target of the hyperlink.
120217
+ *
120218
+ * @remarks
120219
+ * [Api set: PowerPointApi 1.6]
120220
+ */
120221
+ address?: string;
120222
+ /**
120223
+ * Specifies the string displayed when hovering over the hyperlink.
120224
+ *
120225
+ * @remarks
120226
+ * [Api set: PowerPointApi 1.6]
120227
+ */
120228
+ screenTip?: string;
120229
+ }
120230
+ /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */
120231
+ interface HyperlinkCollectionUpdateData {
120232
+ items?: PowerPoint.Interfaces.HyperlinkData[];
120233
+ }
120165
120234
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
120166
120235
  interface ShapeCollectionUpdateData {
120167
120236
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -120454,6 +120523,27 @@ declare namespace PowerPoint {
120454
120523
  id?: string;
120455
120524
  title?: string;
120456
120525
  }
120526
+ /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
120527
+ interface HyperlinkData {
120528
+ /**
120529
+ * Specifies the URL target of the hyperlink.
120530
+ *
120531
+ * @remarks
120532
+ * [Api set: PowerPointApi 1.6]
120533
+ */
120534
+ address?: string;
120535
+ /**
120536
+ * Specifies the string displayed when hovering over the hyperlink.
120537
+ *
120538
+ * @remarks
120539
+ * [Api set: PowerPointApi 1.6]
120540
+ */
120541
+ screenTip?: string;
120542
+ }
120543
+ /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
120544
+ interface HyperlinkCollectionData {
120545
+ items?: PowerPoint.Interfaces.HyperlinkData[];
120546
+ }
120457
120547
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
120458
120548
  interface ShapeCollectionData {
120459
120549
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -120832,6 +120922,58 @@ declare namespace PowerPoint {
120832
120922
  id?: boolean;
120833
120923
  title?: boolean;
120834
120924
  }
120925
+ /**
120926
+ * Represents a single hyperlink.
120927
+ *
120928
+ * @remarks
120929
+ * [Api set: PowerPointApi 1.6]
120930
+ */
120931
+ interface HyperlinkLoadOptions {
120932
+ /**
120933
+ 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`).
120934
+ */
120935
+ $all?: boolean;
120936
+ /**
120937
+ * Specifies the URL target of the hyperlink.
120938
+ *
120939
+ * @remarks
120940
+ * [Api set: PowerPointApi 1.6]
120941
+ */
120942
+ address?: boolean;
120943
+ /**
120944
+ * Specifies the string displayed when hovering over the hyperlink.
120945
+ *
120946
+ * @remarks
120947
+ * [Api set: PowerPointApi 1.6]
120948
+ */
120949
+ screenTip?: boolean;
120950
+ }
120951
+ /**
120952
+ * Represents a collection of hyperlinks.
120953
+ *
120954
+ * @remarks
120955
+ * [Api set: PowerPointApi 1.6]
120956
+ */
120957
+ interface HyperlinkCollectionLoadOptions {
120958
+ /**
120959
+ 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`).
120960
+ */
120961
+ $all?: boolean;
120962
+ /**
120963
+ * For EACH ITEM in the collection: Specifies the URL target of the hyperlink.
120964
+ *
120965
+ * @remarks
120966
+ * [Api set: PowerPointApi 1.6]
120967
+ */
120968
+ address?: boolean;
120969
+ /**
120970
+ * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
120971
+ *
120972
+ * @remarks
120973
+ * [Api set: PowerPointApi 1.6]
120974
+ */
120975
+ screenTip?: boolean;
120976
+ }
120835
120977
  /**
120836
120978
  * Represents the collection of shapes.
120837
120979
  *